Introducing new endpoint for getting amendments.

It appears either the contract from ProPublica either changed recently or it was just always documented incorrectly. Amendments are not returned from the specific bill endpoint like subjects and related bills are.
babelshift · Aug 11, 2017 · 474d895 · 474d895
1 parent 2f0f4aa
commit 474d895
Show file tree

Hide file tree

Showing 11 changed files with 149 additions and 36 deletions.
diff --git a/ProPublicaCongressAPI.Contracts/Amendment.cs b/ProPublicaCongressAPI.Contracts/Amendment.cs
@@ -0,0 +1,34 @@
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace ProPublicaCongressAPI.Contracts
+{
+    public class Amendment
+    {
+        public string Number { get; set; }
+
+        public string Slug { get; set; }
+
+        public string SponsorTitle { get; set; }
+
+        public string Sponsor { get; set; }
+
+        public string SponsorId { get; set; }
+
+        public string SponsorUrl { get; set; }
+
+        public string SponsorParty { get; set; }
+
+        public string SponsorState { get; set; }
+
+        public DateTime DateIntroduced { get; set; }
+
+        public string Title { get; set; }
+
+        public DateTime DateLatestMajorAction { get; set; }
+
+        public string LatestMajorAction { get; set; }
+    }
+}
diff --git a/ProPublicaCongressAPI.Contracts/AmendmentsContainer.cs b/ProPublicaCongressAPI.Contracts/AmendmentsContainer.cs
@@ -0,0 +1,18 @@
+using Newtonsoft.Json;
+using System.Collections.Generic;
+
+namespace ProPublicaCongressAPI.Contracts
+{
+    public class AmendmentsContainer
+    {
+        public int Congress { get; set; }
+
+        public string BillId { get; set; }
+
+        public int NumberOfResults { get; set; }
+
+        public int Offset { get; set; }
+
+        public IReadOnlyCollection<Amendment> Amendments { get; set; }
+    }
+}
diff --git a/ProPublicaCongressAPI.Contracts/SpecificBillDetail.cs b/ProPublicaCongressAPI.Contracts/SpecificBillDetail.cs
@@ -19,7 +19,6 @@ public class SpecificBillDetail
         public DateTime? DateHousePassageVote { get; set; }
         public DateTime? DateSenatePassageVote { get; set; }
         public IReadOnlyCollection<SpecificBillDetailSubject> Subjects { get; set; }
-        public IReadOnlyCollection<SpecificBillDetailAmendment> Amendments { get; set; }
         public IReadOnlyCollection<SpecificBillDetailRelated> RelatedBills { get; set; }
     }
 }
diff --git a/ProPublicaCongressAPI.Contracts/SpecificBillDetailType.cs b/ProPublicaCongressAPI.Contracts/SpecificBillDetailType.cs
@@ -4,7 +4,6 @@ public enum SpecificBillDetailType
     {
         Unknown,
         Subjects,
-        Amendments,
         Related
     }
 }
diff --git a/ProPublicaCongressAPI/AutoMapperConfiguration.cs b/ProPublicaCongressAPI/AutoMapperConfiguration.cs
@@ -142,11 +142,6 @@ public static void Initialize()
                         .ForMember(dest => dest.DateLatestMajorAction,
                             opts => opts.ResolveUsing<DateTimeResolver, string>(s => s.DateLatestMajorAction));
                     x.CreateMap<InternalModels.SpecificBillDetailSubject, Contracts.SpecificBillDetailSubject>();
-                    x.CreateMap<InternalModels.SpecificBillDetailAmendment, Contracts.SpecificBillDetailAmendment>()
-                        .ForMember(dest => dest.DateIntroduced,
-                            opts => opts.ResolveUsing<DateTimeResolver, string>(s => s.DateIntroduced))
-                        .ForMember(dest => dest.DateLatestMajorAction,
-                            opts => opts.ResolveUsing<DateTimeResolver, string>(s => s.DateLatestMajorAction));
                     x.CreateMap<InternalModels.SpecificBillDetail, Contracts.SpecificBillDetail>()
                         .ForMember(dest => dest.DateIntroduced,
                             opts => opts.ResolveUsing<DateTimeResolver, string>(s => s.DateIntroduced))
@@ -157,6 +152,13 @@ public static void Initialize()
                         .ForMember(dest => dest.DateSenatePassageVote,
                             opts => opts.ResolveUsing<NullableDateTimeResolver, string>(s => s.DateSenatePassageVote));
 
+                    x.CreateMap<InternalModels.AmendmentsContainer, Contracts.AmendmentsContainer>();
+                    x.CreateMap<InternalModels.Amendment, Contracts.Amendment>()
+                        .ForMember(dest => dest.DateIntroduced,
+                            opts => opts.ResolveUsing<DateTimeResolver, string>(s => s.DateIntroduced))
+                        .ForMember(dest => dest.DateLatestMajorAction,
+                            opts => opts.ResolveUsing<DateTimeResolver, string>(s => s.DateLatestMajorAction));
+
                     x.CreateMap<InternalModels.BillCosponsor, Contracts.BillCosponsor>()
                         .ForMember(dest => dest.DateCosponsored,
                             opts => opts.ResolveUsing<DateTimeResolver, string>(s => s.DateCosponsored));

diff --git a/ProPublicaCongressAPI/IProPublicaCongressApiClient.cs b/ProPublicaCongressAPI/IProPublicaCongressApiClient.cs
@@ -8,6 +8,7 @@ public interface IProPublicaCongressApiClient
     {
         Task<MemberBillSponsorshipComparisonContainer> CompareMemberBillSponsorships(string firstMemberId, string secondMemberId, int congress, Chamber chamber);
         Task<IReadOnlyCollection<MemberVoteComparison>> CompareMemberVotes(string firstMemberId, string secondMemberId, int congress, Chamber chamber);
+        Task<Contracts.AmendmentsContainer> GetAmendments(int congress, string billId, int? offset);
         Task<BillCosponsorContainer> GetBillCosponsors(int congress, string billId);
         Task<MemberBillsCosponsoredContainer> GetBillsCosponsoredByMember(string memberId, CosponsorBillType type);
         Task<CommitteesContainer> GetCommitttees(int congress, Chamber chamber);

diff --git a/ProPublicaCongressAPI/InternalModels/Amendment.cs b/ProPublicaCongressAPI/InternalModels/Amendment.cs
@@ -0,0 +1,46 @@
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace ProPublicaCongressAPI.InternalModels
+{
+    internal class Amendment
+    {
+        [JsonProperty("amendment_number")]
+        public string Number { get; set; }
+
+        [JsonProperty("slug")]
+        public string Slug { get; set; }
+
+        [JsonProperty("sponsor_title")]
+        public string SponsorTitle { get; set; }
+
+        [JsonProperty("sponsor")]
+        public string Sponsor { get; set; }
+
+        [JsonProperty("sponsor_id")]
+        public string SponsorId { get; set; }
+
+        [JsonProperty("sponsor_uri")]
+        public string SponsorUrl { get; set; }
+
+        [JsonProperty("sponsor_party")]
+        public string SponsorParty { get; set; }
+
+        [JsonProperty("sponsor_state")]
+        public string SponsorState { get; set; }
+
+        [JsonProperty("introduced_date")]
+        public string DateIntroduced { get; set; }
+
+        [JsonProperty("title")]
+        public string Title { get; set; }
+
+        [JsonProperty("latest_major_action_date")]
+        public string DateLatestMajorAction { get; set; }
+
+        [JsonProperty("latest_major_action")]
+        public string LatestMajorAction { get; set; }
+    }
+}
diff --git a/ProPublicaCongressAPI/InternalModels/AmendmentsContainer.cs b/ProPublicaCongressAPI/InternalModels/AmendmentsContainer.cs
@@ -0,0 +1,23 @@
+using Newtonsoft.Json;
+using System.Collections.Generic;
+
+namespace ProPublicaCongressAPI.InternalModels
+{
+    internal class AmendmentsContainer
+    {
+        [JsonProperty("congress")]
+        public int Congress { get; set; }
+
+        [JsonProperty("bill_id")]
+        public string BillId { get; set; }
+
+        [JsonProperty("num_results")]
+        public int NumberOfResults { get; set; }
+
+        [JsonProperty("offset")]
+        public int Offset { get; set; }
+
+        [JsonProperty("amendments")]
+        public IReadOnlyCollection<Amendment> Amendments { get; set; }
+    }
+}
diff --git a/ProPublicaCongressAPI/InternalModels/SpecificBillDetail.cs b/ProPublicaCongressAPI/InternalModels/SpecificBillDetail.cs
@@ -47,9 +47,6 @@ internal class SpecificBillDetail
         [JsonProperty("subjects")]
         public IReadOnlyCollection<SpecificBillDetailSubject> Subjects { get; set; }
 
-        [JsonProperty("amendments")]
-        public IReadOnlyCollection<SpecificBillDetailAmendment> Amendments { get; set; }
-
         [JsonProperty("related_bills")]
         public IReadOnlyCollection<SpecificBillDetailRelated> RelatedBills { get; set; }
     }

diff --git a/ProPublicaCongressAPI/InternalModels/SpecificBillDetailAmendment.cs b/ProPublicaCongressAPI/InternalModels/SpecificBillDetailAmendment.cs
diff --git a/ProPublicaCongressAPI/ProPublicaCongressApiClient.cs b/ProPublicaCongressAPI/ProPublicaCongressApiClient.cs
@@ -30,7 +30,8 @@ public class ProPublicaCongressApiClient : IProPublicaCongressApiClient
         private const string recentBillsUrl = "v1/{0}/{1}/bills/{2}.json"; // 0 = congress, 1 = chamber, 2 = bill-type
         private const string recentBillsByMemberUrl = "v1/members/{0}/bills/{1}.json"; // 0 = member-id, 1 = bill-type
         private const string specificBillUrl = "v1/{0}/bills/{1}.json"; // 0 = congress, 1 = bill-id
-        private const string specificBillDetailsUrl = "v1/{0}/bills/{1}/{2}.json"; // 0 = congress, 1 = details-type
+        private const string specificBillDetailsUrl = "v1/{0}/bills/{1}/{2}.json"; // 0 = congress, 1 = details-type, 2 = details-type
+        private const string amendmentsUrl = "v1/{0}/bills/{1}/amendments.json"; // 0 = congress, 1 = details-type
         private const string billCosponsorsUrl = "v1/{0}/bills/{1}/cosponsors.json"; // 0 = congress, 1 = bill-id
         private const string recentNominationsByTypeUrl = "v1/{0}/nominees/{1}.json"; // 0 = congress, 1 = nomination-type
         private const string specificNominationUrl = "v1/{0}/nominees/{1}.json"; // 0 = congress, 1 = nominee-id
@@ -118,6 +119,24 @@ public ProPublicaCongressApiClient(string apiKey)
             return contract;
         }
 
+        public async Task<Contracts.AmendmentsContainer> GetAmendments(int congress, string billId, int? offset)
+        {
+            string url = apiBaseUrl + String.Format(amendmentsUrl, congress, billId);
+
+            // we can offset the results to page through them since this endpoint only returns 20 at a time
+            if (offset.HasValue && offset.Value > 0)
+            {
+                url += String.Format(offsetParameter, offset.Value);
+            }
+
+            var internalModel = await GetMultipleResultDataAsync<InternalModels.AmendmentsContainer>(url);
+            var contract = AutoMapperConfiguration.Mapper.Map<
+                InternalModels.AmendmentsContainer,
+                Contracts.AmendmentsContainer>(internalModel.Results.ElementAt(0));
+
+            return contract;
+        }
+
         public async Task<Contracts.SpecificBillDetail> GetSpecificBillDetail(int congress, string billId, SpecificBillDetailType billDetailType)
         {
             string url = apiBaseUrl + String.Format(specificBillDetailsUrl, congress, billId, billDetailType.ToString().ToLower());