open_fec_api 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 124251aad3027ab11a34736940eadde4bc61ed1a
-  data.tar.gz: efd3d0bbad721efb73c40f33862ee35b964c03bd
+  metadata.gz: f6b7e9d0218b14ebc38cd51976b5449d58e06c3a
+  data.tar.gz: f428c2254ab332bf979d988637be4622c0a12757
 SHA512:
-  metadata.gz: b30b9116a9d873685d781228d73c292d43014b397063061c210e4a0f6581aaeb22d6956571348e3eb95d09553f89b17a3859960503583ccde2fe53a1805764d5
-  data.tar.gz: 18e3e371fe7c2fb84039196cb6bda871cb22398f84c1f104d19a7771a0f37954fe8beed943405656eb484f84a99d47e3d514c23146d73ab5f682fd16a48655cb
+  metadata.gz: d8c64d72556ec3c475055dd403dc8f0a28f404b56a2ea5161fb60ae8dee9de152abd9321e5bc1348eefe7c41d304c300d1d7cb3fa6023c87e0c7b008dbed28f6
+  data.tar.gz: 89306135e2e84f82237c807bfdb8e7997e89cb2deee4031f8e25416b4b0d0795b7aefd3166359bb5d4b7900065e4a353bbe303a5da40b1fd7679c4926a45629b

data/README.md

@@ -18,8 +18,15 @@ Obtain an [API key](https://api.data.gov/signup/).
 
 ```` rb
 client = OpenFecApi::Client.new("api_key_123")
+
 candidates_response = client.candidates
+
+candidate_response = client.candidate("P00003392")
+
 committees_response = client.committees
+
+committees_response = client.committee("C00571372")
+
 ````
 ### Configuration Options
 
@@ -45,7 +52,7 @@ response = client.candidates(options)
 
 ## Contributing
 
-Help wrap all the [endpoints](ENDPOINTS.md)!
+Help establish and maintain full API endpoint coverage.
 
 Browse existing issues or create a new issue to communicate bugs, desired features, etc.
 

data/lib/open_fec_api.rb

@@ -1,7 +1,9 @@
 require "open_fec_api/version"
 require "open_fec_api/client"
 require "open_fec_api/response"
+require "open_fec_api/responses/candidate_response"
 require "open_fec_api/responses/candidates_response"
+require "open_fec_api/responses/committee_response"
 require "open_fec_api/responses/committees_response"
 
 module OpenFecApi

data/lib/open_fec_api/client.rb

@@ -43,7 +43,7 @@ module OpenFecApi
     #   option options Integer :per_page The number of results returned per page. Defaults to 20.
     #
     def get_response(endpoint, options = {})
-      endpoint_name = endpoint.gsub("/","")
+      endpoint_name = (endpoint.split("/") - [""]).first
       request_options = options.select{|k,v| request_params.include?(k.to_s)}
 
       # Parse/compile query params.
@@ -62,25 +62,104 @@ module OpenFecApi
       response_class_name = endpoint_name.capitalize.concat("Response")
       return OpenFecApi.const_get(response_class_name).new(response) # response_class_name.constantize.new(response)
     end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
     # Candidates Endpoint
     #
     # https://api.open.fec.gov/developers#!/candidate/get_candidates
     #
     # @example
-    #   OpenFecApi::Client.new(:api_key => API_KEY).candidates(:page => 1, :per_page => 100)
+    #   OpenFecApi::Client.new(:api_key => API_KEY).candidates({:page => 1, :per_page => 100})
     def candidates(options = {})
       get_response("/candidates", options)
     end
 
+    # Candidate Endpoint
+    #
+    # https://api.open.fec.gov/developers/#!/candidate/get_candidate_candidate_id
+    #
+    # @param [String] candidate_id
+    #
+    # @example
+    #   OpenFecApi::Client.new(:api_key => API_KEY).candidate("P00003392", {:page => 1, :per_page => 100})
+    def candidate(candidate_id, options = {})
+      get_response("/candidate/#{candidate_id}", options)
+    end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     # Committees Endpoint
     #
     # https://api.open.fec.gov/developers#!/committee/get_committees
     #
     # @example
-    #   OpenFecApi::Client.new(:api_key => API_KEY).committees(:page => 1, :per_page => 100)
+    #   OpenFecApi::Client.new(:api_key => API_KEY).committees({:page => 1, :per_page => 100})
     def committees(options = {})
       get_response("/committees", options)
     end
+
+
+
+
+
+
+
+
+
+
+
+
+    # Committee Endpoint
+    #
+    # https://api.open.fec.gov/developers#!/committee/get_committees
+    #
+    # @param [String] committee_id
+    #
+    # @example
+    #   OpenFecApi::Client.new(:api_key => API_KEY).committee("C00571372", {:page => 1, :per_page => 100})
+    def committee(committee_id, options = {})
+      get_response("/committee/#{committee_id}", options)
+    end
+
+
+
+
+
+
+
+
+
+
   end
 end

data/lib/open_fec_api/responses/candidate_response.rb

@@ -0,0 +1,4 @@
+module OpenFecApi
+  class CandidateResponse < Response
+  end
+end

data/lib/open_fec_api/responses/committee_response.rb

@@ -0,0 +1,4 @@
+module OpenFecApi
+  class CommitteeResponse < Response
+  end
+end

data/lib/open_fec_api/version.rb

@@ -1,3 +1,3 @@
 module OpenFecApi
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/mock/responses/candidate.json

@@ -0,0 +1,48 @@
+{
+  "pagination": {
+    "pages": 1,
+    "page": 1,
+    "per_page": 20,
+    "count": 1
+  },
+  "api_version": "1.0",
+  "results": [
+    {
+      "incumbent_challenge_full": "Open seat",
+      "election_districts": [
+        "00",
+        "00"
+      ],
+      "address_zip": "101855256",
+      "name": "CLINTON, HILLARY RODHAM",
+      "address_state": "NY",
+      "candidate_id": "P00003392",
+      "district_number": 0,
+      "district": "00",
+      "office_full": "President",
+      "office": "P",
+      "load_date": "2015-11-02",
+      "address_street_2": null,
+      "active_through": 2016,
+      "address_city": "NEW YORK",
+      "party_full": "Democratic Party",
+      "candidate_inactive": false,
+      "address_street_1": "P.O. BOX 5256",
+      "election_years": [
+        2008,
+        2016
+      ],
+      "party": "DEM",
+      "cycles": [
+        2008,
+        2010,
+        2012,
+        2014,
+        2016
+      ],
+      "state": "US",
+      "incumbent_challenge": "O",
+      "candidate_status": "C"
+    }
+  ]
+}

data/mock/responses/candidate.rb

@@ -0,0 +1,23 @@
+[{"incumbent_challenge_full"=>"Open seat",
+    "election_districts"=>["00", "00"],
+    "address_zip"=>"101855256",
+    "name"=>"CLINTON, HILLARY RODHAM",
+    "address_state"=>"NY",
+    "candidate_id"=>"P00003392",
+    "district_number"=>0,
+    "district"=>"00",
+    "office_full"=>"President",
+    "office"=>"P",
+    "load_date"=>"2015-11-02",
+    "address_street_2"=>nil,
+    "active_through"=>2016,
+    "address_city"=>"NEW YORK",
+    "party_full"=>"Democratic Party",
+    "candidate_inactive"=>false,
+    "address_street_1"=>"P.O. BOX 5256",
+    "election_years"=>[2008, 2016],
+    "party"=>"DEM",
+    "cycles"=>[2008, 2010, 2012, 2014, 2016],
+    "state"=>"US",
+    "incumbent_challenge"=>"O",
+    "candidate_status"=>"C"}]

data/mock/responses/candidates.json

@@ -0,0 +1,79 @@
+{
+  "pagination": {
+    "pages": 1,
+    "page": 1,
+    "per_page": 20,
+    "count": 2
+  },
+  "api_version": "1.0",
+  "results": [
+    {
+      "incumbent_challenge_full": "Open seat",
+      "election_districts": [
+        "00",
+        "00"
+      ],
+      "office_full": "President",
+      "party_full": "Democratic Party",
+      "name": "CLINTON, HILLARY RODHAM",
+      "office": "P",
+      "election_years": [
+        2008,
+        2016
+      ],
+      "party": "DEM",
+      "active_through": 2016,
+      "cycles": [
+        2008,
+        2010,
+        2012,
+        2014,
+        2016
+      ],
+      "district_number": 0,
+      "district": "00",
+      "state": "US",
+      "incumbent_challenge": "O",
+      "candidate_status": "C",
+      "load_date": "2015-11-02",
+      "candidate_id": "P00003392"
+    },
+    {
+      "incumbent_challenge_full": "Challenger",
+      "election_districts": [
+        "00",
+        "00",
+        "00"
+      ],
+      "office_full": "Senate",
+      "party_full": "Democratic Party",
+      "name": "CLINTON, HILLARY RODHAM",
+      "office": "S",
+      "election_years": [
+        2000,
+        2006,
+        2012
+      ],
+      "party": "DEM",
+      "active_through": 2012,
+      "cycles": [
+        2000,
+        2002,
+        2004,
+        2006,
+        2008,
+        2010,
+        2012,
+        2014,
+        2016
+      ],
+      "district_number": 0,
+      "district": "00",
+      "state": "NY",
+      "incumbent_challenge": "C",
+      "candidate_status": "P",
+      "load_date": "2013-04-26",
+      "candidate_id": "S0NY00188"
+    }
+  ]
+}

data/mock/responses/committee.json

@@ -0,0 +1,72 @@
+{
+  "pagination": {
+    "pages": 1,
+    "page": 1,
+    "per_page": 20,
+    "count": 1
+  },
+  "api_version": "1.0",
+  "results": [
+    {
+      "state_full": "California    ",
+      "expire_date": null,
+      "name": "10 ^ 9+",
+      "custodian_city": null,
+      "custodian_state": null,
+      "form_type": "F1Z",
+      "organization_type": null,
+      "treasurer_name_title": null,
+      "zip": "94085",
+      "treasurer_name_suffix": null,
+      "custodian_name_suffix": null,
+      "designation_full": "Unauthorized",
+      "treasurer_name_prefix": null,
+      "first_file_date": "2014-05-12",
+      "custodian_name_2": null,
+      "custodian_zip": null,
+      "treasurer_name_1": null,
+      "city": "SUNNYVALE",
+      "custodian_street_2": null,
+      "party_type_full": null,
+      "treasurer_name": "RANDI M WILLIS",
+      "custodian_street_1": null,
+      "last_file_date": "2014-06-10",
+      "organization_type_full": null,
+      "email": "RANDI.M.WILLIS@GMAIL.COM",
+      "treasurer_state": null,
+      "state": "CA",
+      "treasurer_city": null,
+      "street_2": null,
+      "custodian_name_title": null,
+      "lobbyist_registrant_pac": null,
+      "candidate_ids": [],
+      "committee_id": "C00563023",
+      "treasurer_street_2": null,
+      "treasurer_name_2": null,
+      "custodian_name_full": null,
+      "custodian_name_1": null,
+      "website": null,
+      "filing_frequency": "T",
+      "committee_type_full": "Super PAC (Independent Expenditure-Only)",
+      "treasurer_phone": null,
+      "custodian_name_prefix": null,
+      "committee_type": "O",
+      "fax": null,
+      "designation": "U",
+      "party_type": null,
+      "party_full": null,
+      "treasurer_zip": null,
+      "treasurer_street_1": null,
+      "leadership_pac": null,
+      "party": null,
+      "cycles": [
+        2014
+      ],
+      "qualifying_date": null,
+      "custodian_phone": null,
+      "custodian_name_middle": null,
+      "street_1": "165 W DUANE AVE",
+      "treasurer_name_middle": null
+    }
+  ]
+}

data/mock/responses/committee_history.json

@@ -0,0 +1,35 @@
+{
+  "pagination": {
+    "pages": 1,
+    "page": 1,
+    "per_page": 20,
+    "count": 1
+  },
+  "api_version": "1.0",
+  "results": [
+    {
+      "street_2": null,
+      "cycle": 2014,
+      "committee_type": "O",
+      "committee_type_full": "Super PAC (Independent Expenditure-Only)",
+      "state_full": "California    ",
+      "expire_date": null,
+      "designation": "U",
+      "name": "10 ^ 9+",
+      "city": "SUNNYVALE",
+      "party_full": null,
+      "treasurer_name": "RANDI M WILLIS",
+      "committee_id": "C00563023",
+      "organization_type_full": null,
+      "organization_type": null,
+      "cycles": [
+        2014
+      ],
+      "party": null,
+      "state": "CA",
+      "zip": "94085",
+      "street_1": "165 W DUANE AVE",
+      "designation_full": "Unauthorized"
+    }
+  ]
+}

data/mock/responses/committees.json

@@ -0,0 +1,53 @@
+{
+  "pagination": {
+    "pages": 1,
+    "page": 1,
+    "per_page": 20,
+    "count": 2
+  },
+  "api_version": "1.0",
+  "results": [
+    {
+      "first_file_date": "2015-01-06",
+      "candidate_ids": [],
+      "committee_type": "Q",
+      "committee_type_full": "PAC - Qualified",
+      "expire_date": "2015-08-27T00:16:54+00:00",
+      "designation": "U",
+      "last_file_date": "2015-09-10",
+      "party_full": null,
+      "treasurer_name": "ROBINSON, JAMES P.",
+      "name": "RIGHT TO RISE PAC, INC.",
+      "organization_type_full": null,
+      "organization_type": null,
+      "cycles": [
+        2016
+      ],
+      "party": null,
+      "state": "FL",
+      "committee_id": "C00571380",
+      "designation_full": "Unauthorized"
+    },
+    {
+      "first_file_date": "2015-01-06",
+      "candidate_ids": [],
+      "committee_type": "O",
+      "committee_type_full": "Super PAC (Independent Expenditure-Only)",
+      "expire_date": null,
+      "designation": "B",
+      "last_file_date": "2015-06-12",
+      "party_full": null,
+      "treasurer_name": "SPIES, CHARLES R.",
+      "name": "RIGHT TO RISE USA",
+      "organization_type_full": null,
+      "organization_type": null,
+      "cycles": [
+        2016
+      ],
+      "party": null,
+      "state": "CA",
+      "committee_id": "C00571372",
+      "designation_full": "Lobbyist/Registrant PAC"
+    }
+  ]
+}

data/spec/client_spec.rb

@@ -55,6 +55,50 @@ module OpenFecApi
       end
     end
 
+    #
+    # Candidate Endpoint
+    #
+
+    describe '#candidate' do
+      context "when configured" do
+        let(:candidate_id){"P00003392"}
+        before do
+          @client = OpenFecApi::Client.new(ENV["OPEN_FEC_API_KEY"])
+        end
+
+        def request_and_print(candidate_id, options)
+          response = @client.candidate(candidate_id, options)
+          pp response.summary
+          return response
+        end #todo: maybe return mock response instead
+
+        it "returns data about the specified candidate" do
+          options = {:page => 1, :per_page => 100}
+          response = request_and_print(candidate_id, options)
+          candidate_name = response.results.map{|c| c["name"]}.uniq
+          expect(candidate_name).to eql(["CLINTON, HILLARY RODHAM"])
+        end
+      end
+    end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     #
     # Committees Endpoint
     #
@@ -81,5 +125,34 @@ module OpenFecApi
         end
       end
     end
+
+
+
+    #
+    # Committee Endpoint
+    #
+
+    describe '#committee' do
+      context "when configured" do
+        let(:committee_id){"C00571372"}
+        before do
+          @client = OpenFecApi::Client.new(ENV["OPEN_FEC_API_KEY"])
+        end
+
+        def request_and_print(committee_id, options)
+          response = @client.committee(committee_id, options)
+          pp response.summary
+          return response
+        end #todo: maybe return mock response instead
+
+        it "returns data about the specified committee" do
+          options = {:page => 1, :per_page => 100}
+          response = request_and_print(committee_id, options)
+          committee_name = response.results.map{|c| c["name"]}.uniq
+          expect(committee_name).to eql(["RIGHT TO RISE USA"])
+        end
+      end
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_fec_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - MJ Rossetti (@s2t2)
@@ -108,7 +108,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - CREDITS.md
-- ENDPOINTS.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -119,12 +118,20 @@ files:
 - lib/open_fec_api/client.rb
 - lib/open_fec_api/endpoint.rb
 - lib/open_fec_api/response.rb
+- lib/open_fec_api/responses/candidate_response.rb
 - lib/open_fec_api/responses/candidates_response.rb
+- lib/open_fec_api/responses/committee_response.rb
 - lib/open_fec_api/responses/committees_response.rb
 - lib/open_fec_api/version.rb
-- mock_responses/mock_candidates_response.rb
-- mock_responses/mock_committees_response.rb
-- mock_responses/over_rate_limit_response.rb
+- mock/responses/candidate.json
+- mock/responses/candidate.rb
+- mock/responses/candidates.json
+- mock/responses/candidates.rb
+- mock/responses/committee.json
+- mock/responses/committee_history.json
+- mock/responses/committees.json
+- mock/responses/committees.rb
+- mock/responses/over_rate_limit.rb
 - open_fec_api.gemspec
 - spec/client_spec.rb
 - spec/spec_helper.rb

data/ENDPOINTS.md

@@ -1,36 +0,0 @@
-## Endpoints
-
-Endpoint | Operation | Wrapper Method
---- | --- | ---
-Candidates | `GET /candidate/{candidate_id}` | `Candidate#find`
-Candidates | `GET /candidate/{candidate_id}/history` | N/A
-Candidates | `GET /candidate/{candidate_id}/history/{cycle}` | N/A
-Candidates | `GET /candidates` | `Candidate#all`
-Candidates | `GET /candidates/search` | N/A
-Candidates | `GET /candidate/{candidate_id}/committees` | N/A
-Candidates | `GET /candidate/{candidate_id}/committees/history` | N/A
-Candidates | `GET /candidate/{candidate_id}/committees/history/{cycle}` | N/A
-Committees | `GET /committee/{committee_id}/candidates` | N/A
-Committees | `GET /committee/{committee_id}/candidates/history` | N/A
-Committees | `GET /committee/{committee_id}/candidates/history/{cycle}` | N/A
-Committees | `GET /committee/{committee_id}` | N/A
-Committees | `GET /committee/{committee_id}/history` | N/A
-Committees | `GET /committee/{committee_id}/history/{cycle}` | N/A
-Committees | `GET /committees` | N/A
-Filings | `GET /committee/{committee_id}/filings` | N/A
-Filings | `GET /filings` | N/A
-Financial | `GET /committee/{committee_id}/reports` | N/A
-Financial | `GET /committee/{committee_id}/totals` | N/A
-Financial | `GET /reports/{committee_type}` | N/A
-Schedules | `GET /committee/{committee_id}/schedules/schedule_a/by_contributor` | N/A
-Schedules | `GET /committee/{committee_id}/schedules/schedule_a/by_size` | N/A
-Schedules | `GET /committee/{committee_id}/schedules/schedule_a/by_state` | N/A
-Schedules | `GET /committee/{committee_id}/schedules/schedule_a/by_zip` | N/A
-Schedules | `GET /schedules/schedule_a` | N/A
-Schedules | `GET /schedules/schedule_a/by_contributor` | N/A
-Schedules | `GET /schedules/schedule_a/by_size` | N/A
-Schedules | `GET /schedules/schedule_a/by_state` | N/A
-Schedules | `GET /schedules/schedule_a/by_zip` | N/A
-Schedules | `GET /schedules/schedule_b` | N/A
-Search | `GET /names/candidates` | `Candidate#where`
-Search | `GET /names/committees` | N/A