open_fec_api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6a8af8d99c9b3e4a5fce6d0e34dd94f3af1775d
-  data.tar.gz: 5f057b2396cdcbc32338cbbf79de9bb3917f30d9
+  metadata.gz: 124251aad3027ab11a34736940eadde4bc61ed1a
+  data.tar.gz: efd3d0bbad721efb73c40f33862ee35b964c03bd
 SHA512:
-  metadata.gz: fb251bdd6f007da64cae9b0b87166e43eb904e0ab19668b6f4eacb63844a62a312b1462c623a7839ed0e932aff8455d55978adea72e494fd5e97eebb61a423f2
-  data.tar.gz: c9ded79cc265e40f04672aad96b18f33f64540777a1c8d6b18518714fd0feb1bd7031bf3356f9236ac43749efbd5e7eb827e69f724acdb8b007b413c75dd6fd0
+  metadata.gz: b30b9116a9d873685d781228d73c292d43014b397063061c210e4a0f6581aaeb22d6956571348e3eb95d09553f89b17a3859960503583ccde2fe53a1805764d5
+  data.tar.gz: 18e3e371fe7c2fb84039196cb6bda871cb22398f84c1f104d19a7771a0f37954fe8beed943405656eb484f84a99d47e3d514c23146d73ab5f682fd16a48655cb

data/CREDITS.md

@@ -12,3 +12,4 @@
  + https://api.open.fec.gov/
  + http://plumbing.pipelinedeals.com/wrapping-rest-apis-with-ruby/
  + http://stackoverflow.com/questions/2680523/dry-ruby-initialization-with-hash-argument
+ + http://github.com/chriscondon/

data/README.md

@@ -2,43 +2,44 @@
 
 [![Gem Version](https://badge.fury.io/rb/open_fec_api.svg)](http://badge.fury.io/rb/open_fec_api)
 
-A ruby wrapper for 18F's [Open FEC (Federal Elections Commission) API](https://api.open.fec.gov/).
+A ruby interface to the [Open Federal Elections Commission (FEC) API](https://api.open.fec.gov/). Returns data about election candidates and committees. Includes options to customize API requests.
 
 ## Installation
 
-Add `gem 'open_fec_api'` to your application's *Gemfile* and run `bundle install`, or install manually with `gem install open_fec_api`.
-
-## Configuration
+```` sh
+gem install open_fec_api
+````
 
-Configure a client with your [API key](https://api.data.gov/signup/) before making requests.
+## Prerequisites
 
-```` rb
-client = OpenFecApi::Client.new("api_key_123")
-````
+Obtain an [API key](https://api.data.gov/signup/).
 
 ## Usage
 
-Make a request.
-
 ```` rb
-response = client.candidates
+client = OpenFecApi::Client.new("api_key_123")
+candidates_response = client.candidates
+committees_response = client.committees
 ````
+### Configuration Options
 
-Request different pages by setting the `:page` request parameter. Avoid rate-limits by increasing the `:per_page` request parameter to 100.
+Request subsequent pages and avoid rate-limits.
 
 ```` rb
 options = {:page => 1, :per_page => 100}
 response = client.candidates(options)
+
 while response.page < response.pages do
   options.merge!({:page => response.page + 1})
   response = client.candidates(options)
 end
 ````
 
-Make requests using endpoint-specific parameters.
+Specify endpoint-specific parameters.
 
 ```` rb
 options = {:party => "DEM"}
+
 response = client.candidates(options)
 ````
 
@@ -50,19 +51,24 @@ Browse existing issues or create a new issue to communicate bugs, desired featur
 
 After forking the repo and pushing your changes, create a pull request referencing the applicable issue(s).
 
-### Installation
+### Developing
+
+```` sh
+git clone git@github.com:data-creative/open-fec-api-ruby.git
+cd open-fec-api-ruby
+````
 
-Check out the repo with `git clone git@github.com:debate-watch/open-fec-api-ruby.git`, and `cd open-fec-api-ruby`.
+Run `bin/setup` to install dependencies.
 
-After checking out the repo, run `bin/setup` to install dependencies.
+Obtain an API key and assign it to an environment variable called `OPEN_FEC_API_KEY`.
 
 ### Testing
 
 Run `bundle exec rake` or `bundle exec rspec spec/` to run the tests.
 
-You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Run `bin/console` for an interactive prompt to facilitate experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`.
+Run `bundle exec rake install` to install the packaged gem onto your local machine for testing in other local projects.
 
 ### Releasing
 

data/lib/open_fec_api.rb

@@ -1,6 +1,8 @@
 require "open_fec_api/version"
 require "open_fec_api/client"
 require "open_fec_api/response"
+require "open_fec_api/responses/candidates_response"
+require "open_fec_api/responses/committees_response"
 
 module OpenFecApi
 =begin

data/lib/open_fec_api/client.rb

@@ -2,10 +2,12 @@ require 'httparty'
 
 module OpenFecApi
   class Client
-    attr_reader :api_key
     include HTTParty
+
     base_uri 'https://api.open.fec.gov/v1'
 
+    attr_reader :api_key
+
     def initialize(api_key)
       @api_key = api_key
     end
@@ -14,10 +16,15 @@ module OpenFecApi
       !self.api_key.nil?
     end
 
-    # Candidates Endpoint
-    #
-    # https://api.open.fec.gov/developers#!/candidate/get_candidates
-    #
+    def request_params
+      [
+        "page", "per_page", "year", "designation", "committee_type", "organization_type",
+        "cycle", "party", "min_first_file_date", "candidate_id", "state", "committee_id",
+        "name", "q", "max_first_file_date", "sort", "sort_hide_null", "sort_nulls_large"
+      ]
+    end # NOTE: these params don't apply to all available endpoints ...
+
+    # @param [String] endpoint One of: ["candidates/","committees/"]
     # @param [Hash] options
     #   option options Array[string] :sort Provide a field to sort by. Use - for descending order.
     #   option options Boolean :sort_hide_null Hide null values on sorted column(s).
@@ -35,17 +42,45 @@ module OpenFecApi
     #   option options Integer :page For paginating through results, starting at page 1.
     #   option options Integer :per_page The number of results returned per page. Defaults to 20.
     #
-    # @example
-    #   OpenFecApi::Client.new(:api_key => API_KEY).candidates(:page => 1, :per_page => 100)
-    def candidates(options = {})
-      query = {'api_key' => @api_key}
-      request_params = ["sort", "sort_hide_null", "year", "office", "candidate_status", "party", "state", "cycle", "district", "incumbent_challenge", "name", "candidate_id", "page", "per_page"]
+    def get_response(endpoint, options = {})
+      endpoint_name = endpoint.gsub("/","")
       request_options = options.select{|k,v| request_params.include?(k.to_s)}
+
+      # Parse/compile query params.
+
+      query = {'api_key' => @api_key}
       request_options.each do |k,v|
         query.merge!({k.to_s => v})
       end
-      response = self.class.get("/candidates", query: query)
-      return Response.new(response)
+
+      # Make a request.
+
+      response = self.class.get(endpoint, query: query)
+
+      # Return the proper response.
+
+      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)
+    def candidates(options = {})
+      get_response("/candidates", 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)
+    def committees(options = {})
+      get_response("/committees", options)
     end
   end
 end

data/lib/open_fec_api/endpoint.rb

@@ -0,0 +1,28 @@
+=begin
+module OpenFecApi
+  class Endpoint
+    ENDPOINTS = [
+      {
+        :path => "/candidates",
+        :request_params => [
+          "page", "per_page", "year", "designation", "committee_type", "organization_type", "cycle", "party", "min_first_file_date", "candidate_id", "state", "committee_id", "name", "q", "max_first_file_date", "sort", "sort_hide_null", "sort_nulls_large"
+          # TODO: {:name => "page"}, {:name => "per_page"}
+        ]
+      },
+      {
+        :path => "/committees",
+        :request_params => [
+          "page", "per_page", "year", "designation", "committee_type", "organization_type", "cycle", "party", "min_first_file_date", "candidate_id", "state", "committee_id", "name", "q", "max_first_file_date", "sort", "sort_hide_null", "sort_nulls_large"
+          # TODO: {:name => "page"}, {:name => "per_page"}
+        ]
+      }
+    ]
+
+    attr_accessor :request_params
+
+    def initialize(options = {})
+      @request_params = options[:request_params]
+    end
+  end
+end
+=end

data/lib/open_fec_api/response.rb

@@ -2,6 +2,7 @@ module OpenFecApi
   class Response
     attr_reader :request, :headers, :api_version, :pagination, :results
 
+    # @param [HTTParty::Response] response
     def initialize(response)
       @request = response.request
       @headers = response.headers

data/lib/open_fec_api/responses/candidates_response.rb

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

data/lib/open_fec_api/responses/committees_response.rb

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

data/lib/open_fec_api/version.rb

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

data/mock_responses/mock_committees_response.rb

@@ -0,0 +1,20 @@
+{"pagination"=>{"page"=>1, "pages"=>1, "count"=>1, "per_page"=>20},
+ "api_version"=>"1.0",
+ "results"=>
+  [{"last_file_date"=>"2014-06-10",
+    "treasurer_name"=>"RANDI M WILLIS",
+    "organization_type_full"=>nil,
+    "party"=>nil,
+    "designation_full"=>"Unauthorized",
+    "name"=>"10 ^ 9+",
+    "committee_type_full"=>"Super PAC (Independent Expenditure-Only)",
+    "committee_id"=>"C00563023",
+    "first_file_date"=>"2014-05-16",
+    "committee_type"=>"O",
+    "cycles"=>[2014],
+    "expire_date"=>nil,
+    "organization_type"=>nil,
+    "state"=>"CA",
+    "party_full"=>nil,
+    "designation"=>"U",
+    "candidate_ids"=>[]}]}

data/open_fec_api.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = OpenFecApi::VERSION
   spec.authors       = ["MJ Rossetti (@s2t2)"]
   spec.email         = ["s2t2mail@gmail.com"]
-  spec.summary       = %q{A ruby wrapper for 18F's Open FEC (Federal Elections Commission) API - https://api.open.fec.gov/.}
-  spec.description   = %q{A ruby wrapper for 18F's Open FEC (Federal Elections Commission) API - https://api.open.fec.gov/.}
-  spec.homepage      = "https://github.com/debate-watch/open_fec_api/"
+  spec.summary       = %q{A ruby interface to the Open Federal Elections Commission (FEC) API.}
+  spec.description   = %q{A ruby interface to the Open Federal Elections Commission (FEC) API. Returns data about election candidates and committees. Includes options to customize API requests.}
+  spec.homepage      = "https://github.com/data-creative/open-fec-api-ruby/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/spec/client_spec.rb

@@ -2,6 +2,11 @@ require 'spec_helper'
 
 module OpenFecApi
   RSpec.describe Client do
+
+    #
+    # Candidates Endpoint
+    #
+
     describe '#candidates' do
       context 'when configured' do
         before do
@@ -39,7 +44,7 @@ module OpenFecApi
           options = {:party => "DEM"}
           response = request_and_print(options)
           expect(response.results.map{|c| c["party"]}.uniq).to eql(["DEM"])
-        end
+        end #todo: maybe return mock response instead
 
         it "prevents unrecognized params from being requested" do
           unrecognized_params = {:hair_color => "brown"}
@@ -49,5 +54,32 @@ module OpenFecApi
         end
       end
     end
+
+    #
+    # Committees Endpoint
+    #
+
+    describe '#committees' do
+      context 'when configured' do
+        let(:committee_id){"C00563023"}
+
+        before do
+          @client = OpenFecApi::Client.new(ENV["OPEN_FEC_API_KEY"])
+        end
+
+        def request_and_print(options)
+          response = @client.committees(options)
+          pp response.summary
+          return response
+        end #todo: maybe return mock response instead
+
+        it "accepts accepts endpoint-specific options like Committee ID" do
+          options = {:committee_id => committee_id}
+          response = request_and_print(options)
+          committe_treasurer_name = response.results.map{|c| c["treasurer_name"]}.uniq
+          expect(committe_treasurer_name).to eql(["RANDI M WILLIS"])
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_fec_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - MJ Rossetti (@s2t2)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-25 00:00:00.000000000 Z
+date: 2015-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,8 +94,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
-description: A ruby wrapper for 18F's Open FEC (Federal Elections Commission) API
-  - https://api.open.fec.gov/.
+description: A ruby interface to the Open Federal Elections Commission (FEC) API.
+  Returns data about election candidates and committees. Includes options to customize
+  API requests.
 email:
 - s2t2mail@gmail.com
 executables:
@@ -116,14 +117,18 @@ files:
 - bin/setup
 - lib/open_fec_api.rb
 - lib/open_fec_api/client.rb
+- lib/open_fec_api/endpoint.rb
 - lib/open_fec_api/response.rb
+- lib/open_fec_api/responses/candidates_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
 - open_fec_api.gemspec
-- reponse_examples/candidates.rb
-- reponse_examples/over_rate_limit.rb
 - spec/client_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/debate-watch/open_fec_api/
+homepage: https://github.com/data-creative/open-fec-api-ruby/
 licenses:
 - MIT
 metadata: {}
@@ -146,7 +151,7 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: A ruby wrapper for 18F's Open FEC (Federal Elections Commission) API - https://api.open.fec.gov/.
+summary: A ruby interface to the Open Federal Elections Commission (FEC) API.
 test_files:
 - spec/client_spec.rb
 - spec/spec_helper.rb