open_fec_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 818b705a49bd80cf98215fef54f4b5eda20769da
+  data.tar.gz: 4ab0d6b6a6075df42cdc644ebb577244531d98a8
+SHA512:
+  metadata.gz: 1e2b362f084c2dcef094944a678e411b337bf2815c1b4ba833b437561f444278163c98c99430ec7e36d82a4c203e32276b5613203dee2618747f9ae3ea26e373
+  data.tar.gz: 8aad09cc00374547cbd3621f462eaaf77ee26efda67b4c82e34f8d7c7cd8fc9864f64c19b3460e3ab7d570f960adafc5b4304593595c8efc3d1af077d9b1f1df

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CREDITS.md

@@ -0,0 +1,14 @@
+# Credits, Notes, and Reference
+ + http://sunlightfoundation.com/blog/2015/07/08/openfec-makes-campaign-finance-data-more-accessible-with-new-api-heres-how-to-get-started/
+ + http://brandonhilkert.com/blog/ruby-gem-configuration-patterns/
+ + https://robots.thoughtbot.com/mygem-configure-block
+ + http://stackoverflow.com/questions/10584638/setting-up-configuration-settings-when-writing-a-gem
+ + http://sunlightfoundation.com/blog/2015/07/08/openfec-makes-campaign-finance-data-more-accessible-with-new-api-heres-how-to-get-started/
+ + http://betterspecs.org/
+ + https://github.com/jnunemaker/httparty
+ + https://github.com/jnunemaker/httparty/tree/master/examples
+ + http://s2t2.info/process-documentation/2015/07/03/how-to-make-a-ruby-gem.html
+ + https://gorails.com/episodes/consuming-an-api-using-httparty-and-creating-a-gem
+ + 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

data/ENDPOINTS.md

@@ -0,0 +1,36 @@
+## 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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in open_fec_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 MJ Rossetti (@s2t2)
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# OpenFecApi
+
+A ruby wrapper for 18F's [Open FEC (Federal Elections Commission) API](https://api.open.fec.gov/).
+
+## 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
+
+Configure a client with your [API key](https://api.data.gov/signup/) before making requests.
+
+```` rb
+client = OpenFecApi::Client.new("api_key_123")
+````
+
+## Usage
+
+Make a request.
+
+```` rb
+response = client.candidates
+````
+
+Request different pages by setting the `:page` request parameter. Avoid rate-limits by increasing the `:per_page` request parameter to 100.
+
+```` 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.
+
+```` rb
+options = {:party => "DEM"}
+response = client.candidates(options)
+````
+
+## Contributing
+
+Help wrap all the [endpoints](ENDPOINTS.md)!
+
+Browse existing issues or create a new issue to communicate bugs, desired features, etc.
+
+After forking the repo and pushing your changes, create a pull request referencing the applicable issue(s).
+
+### Installation
+
+Check out the repo with `git clone git@github.com:debate-watch/open-fec-api-ruby.git`, and `cd open-fec-api-ruby`.
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+### 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Releasing
+
+Update the version number in `version.rb`, then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "open_fec_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/open_fec_api.rb

@@ -0,0 +1,81 @@
+require "open_fec_api/version"
+require "open_fec_api/client"
+require "open_fec_api/response"
+
+module OpenFecApi
+=begin
+
+  #
+  # CANDIDATE
+  #
+
+  GET /candidate/{candidate_id}
+  GET /candidate/{candidate_id}/history
+  GET /candidate/{candidate_id}/history/{cycle}
+
+  #
+  # CANDIDATES
+  #
+
+  GET /candidates
+  GET /candidates/search
+
+  GET /committee/{committee_id}/candidates
+  GET /committee/{committee_id}/candidates/history
+  GET /committee/{committee_id}/candidates/history/{cycle}
+
+  #
+  # COMMITTEE
+  #
+
+  GET /committee/{committee_id}
+  GET /committee/{committee_id}/filings
+  GET /committee/{committee_id}/reports
+  GET /committee/{committee_id}/totals
+  GET /committee/{committee_id}/history
+  GET /committee/{committee_id}/history/{cycle}
+
+  #
+  # COMMITTEES
+  #
+
+  GET /committees
+
+  GET /candidate/{candidate_id}/committees
+  GET /candidate/{candidate_id}/committees/history
+  GET /candidate/{candidate_id}/committees/history/{cycle}
+
+  #
+  # SCHEDULES
+  #
+
+  GET /schedules/schedule_a
+  GET /schedules/schedule_a/by_contributor
+  GET /schedules/schedule_a/by_size
+  GET /schedules/schedule_a/by_state
+  GET /schedules/schedule_a/by_zip
+  GET /schedules/schedule_b
+
+  GET /committee/{committee_id}/schedules/schedule_a/by_contributor
+  GET /committee/{committee_id}/schedules/schedule_a/by_size
+  GET /committee/{committee_id}/schedules/schedule_a/by_state
+  GET /committee/{committee_id}/schedules/schedule_a/by_zip
+
+  # NAMES
+
+  GET /names/candidates
+  GET /names/committees
+
+  HTTParty.get("http://api.open.fec.gov/v1/names/candidates?api_key=#{@api_key}")
+  HTTParty.get("http://api.open.fec.gov/v1/names/committees?api_key=#{@api_key}")
+
+  # FILINGS
+
+  GET /filings
+
+  # REPORTS
+
+  GET /reports/{committee_type}
+
+=end
+end

data/lib/open_fec_api/client.rb

@@ -0,0 +1,51 @@
+require 'httparty'
+
+module OpenFecApi
+  class Client
+    attr_reader :api_key
+    include HTTParty
+    base_uri 'https://api.open.fec.gov/v1'
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def configured?
+      !self.api_key.nil?
+    end
+
+    # Candidates Endpoint
+    #
+    # https://api.open.fec.gov/developers#!/candidate/get_candidates
+    #
+    # @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).
+    #   option options String :year See records pertaining to a particular year.
+    #   option options Array[string] :office Governmental office candidate runs for: House (H), Senate (S) or President (P).
+    #   option options Array[string] :candidate_status One letter code explaining if the candidate is: present (C), future (F), not yet (N), or prior (P).
+    #   option options Array[string] :party Three letter code for the party under which a candidate ran for office.
+    #   option options Array[string] :state U.S. State candidate or territory where a candidate runs for office.
+    #   option options Array[integer] :cycle Two-year election cycle in which a candidate runs for office. Calculated from FEC form 2.
+    #   option options Array[string] :district Two digit district number.
+    #   option options Array[string] :incumbent_challenge One letter code explaining if the candidate is an incumbent (I), a challenger (C), or if the seat is open (O).
+    #   option options String :q Text to search all fields for.
+    #   option options String :name Candidate's name (full or partial).
+    #   option options Array[string] :candidate_id A unique identifier assigned to each candidate registered with the FEC. If a person runs for several offices, that person will have separate candidate IDs for each office.
+    #   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"]
+      request_options = options.select{|k,v| request_params.include?(k.to_s)}
+      request_options.each do |k,v|
+        query.merge!({k.to_s => v})
+      end
+      response = self.class.get("/candidates", query: query)
+      return Response.new(response)
+    end
+  end
+end

data/lib/open_fec_api/response.rb

@@ -0,0 +1,49 @@
+module OpenFecApi
+  class Response
+    attr_reader :request, :headers, :api_version, :pagination, :results
+
+    def initialize(response)
+      @request = response.request
+      @headers = response.headers
+      @api_version = response["api_version"]
+      @pagination = response["pagination"]
+      @results = response["results"]
+    end
+
+    def request_query
+      request.options[:query]
+    end
+
+    def limit
+      headers["x-ratelimit-limit"].to_i
+    end
+
+    def remaining
+      headers["x-ratelimit-remaining"].to_i
+    end
+
+    def page
+      pagination["page"].to_i
+    end
+
+    def pages
+      pagination["pages"].to_i
+    end
+
+    def results_count
+      results.count
+    end
+
+    def first_result_name
+      results.first["name"]
+    end
+
+    def last_result_name
+      results.last["name"]
+    end
+
+    def summary
+      "PAGE #{page}/#{pages} -- RATE #{remaining}/#{limit} -- #{first_result_name} ... #{last_result_name}"
+    end
+  end
+end

data/lib/open_fec_api/version.rb

@@ -0,0 +1,3 @@
+module OpenFecApi
+  VERSION = "0.0.1"
+end

data/open_fec_api.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'open_fec_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "open_fec_api"
+  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.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_dependency "httparty", "~> 0.13"
+end

data/reponse_examples/candidates.rb

@@ -0,0 +1,303 @@
+{"pagination"=>{"pages"=>1020, "count"=>20393, "per_page"=>20, "page"=>1},
+ "api_version"=>"1.0",
+ "results"=>
+  [{"candidate_status"=>"N",
+    "active_through"=>2004,
+    "incumbent_challenge_full"=>"Unknown",
+    "district"=>nil,
+    "election_years"=>[2004],
+    "party"=>"IND",
+    "office"=>"P",
+    "candidate_status_full"=>"Not yet a statutory candidate",
+    "state"=>"US",
+    "incumbent_challenge"=>nil,
+    "party_full"=>"Independent",
+    "office_full"=>"President",
+    "candidate_id"=>"P40002172",
+    "name"=>"AABBATTE, MICHAEL THOMAS WITORT",
+    "cycles"=>[2004]},
+   {"candidate_status"=>"C",
+    "active_through"=>2012,
+    "incumbent_challenge_full"=>"Challenger",
+    "district"=>nil,
+    "election_years"=>[2012],
+    "party"=>"REP",
+    "office"=>"S",
+    "candidate_status_full"=>"Statutory candidate",
+    "state"=>"UT",
+    "incumbent_challenge"=>"C",
+    "party_full"=>"Republican Party",
+    "office_full"=>"Senate",
+    "candidate_id"=>"S2UT00229",
+    "name"=>"AALDERS, TIMOTHY NOEL",
+    "cycles"=>[2012]},
+   {"candidate_status"=>"C",
+    "active_through"=>2012,
+    "incumbent_challenge_full"=>"Challenger",
+    "district"=>"01",
+    "election_years"=>[2012],
+    "party"=>"REP",
+    "office"=>"H",
+    "candidate_status_full"=>"Statutory candidate",
+    "state"=>"CA",
+    "incumbent_challenge"=>"C",
+    "party_full"=>"Republican Party",
+    "office_full"=>"House",
+    "candidate_id"=>"H2CA01110",
+    "name"=>"AANESTAD, SAMUEL",
+    "cycles"=>[2012]},
+   {"candidate_status"=>"N",
+    "active_through"=>2008,
+    "incumbent_challenge_full"=>"Open seat",
+    "district"=>nil,
+    "election_years"=>[2008],
+    "party"=>"DEM",
+    "office"=>"P",
+    "candidate_status_full"=>"Not yet a statutory candidate",
+    "state"=>"US",
+    "incumbent_challenge"=>"O",
+    "party_full"=>"Democratic Party",
+    "office_full"=>"President",
+    "candidate_id"=>"P80002926",
+    "name"=>"AARON, LAURA DAVIS",
+    "cycles"=>[2008]},
+   {"candidate_status"=>"P",
+    "active_through"=>2000,
+    "incumbent_challenge_full"=>"Unknown",
+    "district"=>"01",
+    "election_years"=>[2000],
+    "party"=>"REP",
+    "office"=>"H",
+    "candidate_status_full"=>"Statutory candidate in a prior cycle",
+    "state"=>"MA",
+    "incumbent_challenge"=>nil,
+    "party_full"=>"Republican Party",
+    "office_full"=>"House",
+    "candidate_id"=>"H0MA01024",
+    "name"=>"ABAIR, PETER JON",
+    "cycles"=>[2000]},
+   {"candidate_status"=>"N",
+    "active_through"=>2012,
+    "incumbent_challenge_full"=>"Open seat",
+    "district"=>"00",
+    "election_years"=>[2012],
+    "party"=>"DEM",
+    "office"=>"H",
+    "candidate_status_full"=>"Not yet a statutory candidate",
+    "state"=>"MT",
+    "incumbent_challenge"=>"O",
+    "party_full"=>"Democratic Party",
+    "office_full"=>"House",
+    "candidate_id"=>"H2MT00039",
+    "name"=>"ABARR, JOHN ALLEN",
+    "cycles"=>[2012]},
+   {"candidate_status"=>"C",
+    "active_through"=>2008,
+    "incumbent_challenge_full"=>"Unknown",
+    "district"=>"05",
+    "election_years"=>[2006, 2008],
+    "party"=>"DEM",
+    "office"=>"H",
+    "candidate_status_full"=>"Statutory candidate",
+    "state"=>"NJ",
+    "incumbent_challenge"=>nil,
+    "party_full"=>"Democratic Party",
+    "office_full"=>"House",
+    "candidate_id"=>"H6NJ05155",
+    "name"=>"ABATE, CAMILLE M",
+    "cycles"=>[2006, 2008]},
+   {"candidate_status"=>"P",
+    "active_through"=>1992,
+    "incumbent_challenge_full"=>"Unknown",
+    "district"=>"12",
+    "election_years"=>[1992],
+    "party"=>"DEM",
+    "office"=>"H",
+    "candidate_status_full"=>"Statutory candidate in a prior cycle",
+    "state"=>"NJ",
+    "incumbent_challenge"=>nil,
+    "party_full"=>"Democratic Party",
+    "office_full"=>"House",
+    "candidate_id"=>"H2NJ12036",
+    "name"=>"ABATE, FRANK G",
+    "cycles"=>[1992]},
+   {"candidate_status"=>"C",
+    "active_through"=>1990,
+    "incumbent_challenge_full"=>"Unknown",
+    "district"=>"03",
+    "election_years"=>[1990],
+    "party"=>"REP",
+    "office"=>"H",
+    "candidate_status_full"=>"Statutory candidate",
+    "state"=>"IA",
+    "incumbent_challenge"=>nil,
+    "party_full"=>"Republican Party",
+    "office_full"=>"House",
+    "candidate_id"=>"H0IA03071",
+    "name"=>"ABBAS, JEFFREY LYN",
+    "cycles"=>[1990]},
+   {"candidate_status"=>"C",
+    "active_through"=>1994,
+    "incumbent_challenge_full"=>"Unknown",
+    "district"=>"15",
+    "election_years"=>[1994],
+    "party"=>"REP",
+    "office"=>"H",
+    "candidate_status_full"=>"Statutory candidate",
+    "state"=>"TX",
+    "incumbent_challenge"=>nil,
+    "party_full"=>"Republican Party",
+    "office_full"=>"House",
+    "candidate_id"=>"H4TX15043",
+    "name"=>"ABBOTT, BONNIE",
+    "cycles"=>[1994]},
+   {"candidate_status"=>"N",
+    "active_through"=>2016,
+    "incumbent_challenge_full"=>"Open seat",
+    "district"=>nil,
+    "election_years"=>[2016],
+    "party"=>"IND",
+    "office"=>"P",
+    "candidate_status_full"=>"Not yet a statutory candidate",
+    "state"=>"US",
+    "incumbent_challenge"=>"O",
+    "party_full"=>"Independent",
+    "office_full"=>"President",
+    "candidate_id"=>"P60005840",
+    "name"=>"ABBOTT, GIFFORD WHEELER JR",
+    "cycles"=>[2016]},
+   {"candidate_status"=>"P",
+    "active_through"=>1996,
+    "incumbent_challenge_full"=>"Challenger",
+    "district"=>"00",
+    "election_years"=>[1996],
+    "party"=>"DEM",
+    "office"=>"H",
+    "candidate_status_full"=>"Statutory candidate in a prior cycle",
+    "state"=>"SD",
+    "incumbent_challenge"=>"C",
+    "party_full"=>"Democratic Party",
+    "office_full"=>"House",
+    "candidate_id"=>"H6SD00077",
+    "name"=>"ABBOTT, JAMES W",
+    "cycles"=>[1996]},
+   {"candidate_status"=>"P",
+    "active_through"=>1992,
+    "incumbent_challenge_full"=>"Unknown",
+    "district"=>nil,
+    "election_years"=>[1988, 1992],
+    "party"=>"DEM",
+    "office"=>"P",
+    "candidate_status_full"=>"Statutory candidate in a prior cycle",
+    "state"=>"US",
+    "incumbent_challenge"=>nil,
+    "party_full"=>"Democratic Party",
+    "office_full"=>"President",
+    "candidate_id"=>"P80002579",
+    "name"=>"ABBOTT, JOHN HANCOCK",
+    "cycles"=>[1992]},
+   {"candidate_status"=>"N",
+    "active_through"=>1988,
+    "incumbent_challenge_full"=>"Unknown",
+    "district"=>nil,
+    "election_years"=>[1986, 1988],
+    "party"=>"DEM",
+    "office"=>"S",
+    "candidate_status_full"=>"Not yet a statutory candidate",
+    "state"=>"CA",
+    "incumbent_challenge"=>nil,
+    "party_full"=>"Democratic Party",
+    "office_full"=>"Senate",
+    "candidate_id"=>"S6CA00345",
+    "name"=>"ABBOTT, JOHN HANCOCK",
+    "cycles"=>[1986]},
+   {"candidate_status"=>"T",
+    "active_through"=>2004,
+    "incumbent_challenge_full"=>"Unknown",
+    "district"=>"18",
+    "election_years"=>[2002, 2004],
+    "party"=>"REP",
+    "office"=>"H",
+    "candidate_status_full"=>"Obsolete",
+    "state"=>"TX",
+    "incumbent_challenge"=>nil,
+    "party_full"=>"Republican Party",
+    "office_full"=>"House",
+    "candidate_id"=>"H2TX18082",
+    "name"=>"ABBOTT, PHILLIP J.",
+    "cycles"=>[2002, 2004]},
+   {"candidate_status"=>"P",
+    "active_through"=>2000,
+    "incumbent_challenge_full"=>"Unknown",
+    "district"=>"03",
+    "election_years"=>[1994, 1996, 2000],
+    "party"=>"DEM",
+    "office"=>"H",
+    "candidate_status_full"=>"Statutory candidate in a prior cycle",
+    "state"=>"KY",
+    "incumbent_challenge"=>nil,
+    "party_full"=>"Democratic Party",
+    "office_full"=>"House",
+    "candidate_id"=>"H4KY03095",
+    "name"=>"ABBOTT, RAYMOND H",
+    "cycles"=>[1994, 1996, 1998, 2000]},
+   {"candidate_status"=>"N",
+    "active_through"=>2014,
+    "incumbent_challenge_full"=>"Challenger",
+    "district"=>"03",
+    "election_years"=>[2014],
+    "party"=>"DEM",
+    "office"=>"H",
+    "candidate_status_full"=>"Not yet a statutory candidate",
+    "state"=>"MI",
+    "incumbent_challenge"=>"C",
+    "party_full"=>"Democratic Party",
+    "office_full"=>"House",
+    "candidate_id"=>"H4MI03201",
+    "name"=>"ABBOTT, RICHARD ALLEN IV",
+    "cycles"=>[2014]},
+   {"candidate_status"=>"P",
+    "active_through"=>2004,
+    "incumbent_challenge_full"=>"Unknown",
+    "district"=>"04",
+    "election_years"=>[2002, 2004],
+    "party"=>"DEM",
+    "office"=>"H",
+    "candidate_status_full"=>"Statutory candidate in a prior cycle",
+    "state"=>"IN",
+    "incumbent_challenge"=>nil,
+    "party_full"=>"Democratic Party",
+    "office_full"=>"House",
+    "candidate_id"=>"H2IN04101",
+    "name"=>"ABBOTT, WILLIAM ANTHONY",
+    "cycles"=>[2002, 2004]},
+   {"candidate_status"=>"P",
+    "active_through"=>1988,
+    "incumbent_challenge_full"=>"Challenger",
+    "district"=>"02",
+    "election_years"=>[1988],
+    "party"=>"REP",
+    "office"=>"H",
+    "candidate_status_full"=>"Statutory candidate in a prior cycle",
+    "state"=>"NE",
+    "incumbent_challenge"=>"C",
+    "party_full"=>"Republican Party",
+    "office_full"=>"House",
+    "candidate_id"=>"H8NE02089",
+    "name"=>"ABBOUD, CHRIS",
+    "cycles"=>[1988]},
+   {"candidate_status"=>"C",
+    "active_through"=>2008,
+    "incumbent_challenge_full"=>"Challenger",
+    "district"=>"16",
+    "election_years"=>[2008],
+    "party"=>"DEM",
+    "office"=>"H",
+    "candidate_status_full"=>"Statutory candidate",
+    "state"=>"IL",
+    "incumbent_challenge"=>"C",
+    "party_full"=>"Democratic Party",
+    "office_full"=>"House",
+    "candidate_id"=>"H8IL16062",
+    "name"=>"ABBOUD, ROBERT",
+    "cycles"=>[2008]}]}

data/reponse_examples/over_rate_limit.rb

@@ -0,0 +1,3 @@
+{"error"=>
+  {"code"=>"OVER_RATE_LIMIT",
+   "message"=>"You have exceeded your rate limit. Try again later or contact us at https://api.open.fec.gov/contact for assistance"}}

data/spec/client_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+module OpenFecApi
+  RSpec.describe Client do
+    describe '#candidates' do
+      context 'when configured' do
+        before do
+          @client = OpenFecApi::Client.new(ENV["OPEN_FEC_API_KEY"])
+        end
+
+        def request_and_print(options)
+          response = @client.candidates(options)
+          pp response.summary
+          return response
+        end
+
+        it "is configured" do
+          expect(@client.configured?)
+        end
+
+        it "returns responses" do
+          response = @client.candidates
+          expect(response).to be_kind_of(OpenFecApi::Response)
+        end
+
+        it "accepts pagination options and avoids rate limits" do
+          options = {:page => 1, :per_page => 100}
+          response = request_and_print(options)
+          expect(response.results_count).to eql(100)
+          while response.page < response.pages && response.page < 5 do
+            options.merge!({:page => response.page + 1})
+            response = request_and_print(options)
+          end
+          success = true
+          expect(success)
+        end
+
+        it "accepts endpoint-specific options" do
+          options = {:party => "DEM"}
+          response = request_and_print(options)
+          expect(response.results.map{|c| c["party"]}.uniq).to eql(["DEM"])
+        end
+
+        it "prevents unrecognized params from being requested" do
+          unrecognized_params = {:hair_color => "brown"}
+          response = request_and_print(unrecognized_params)
+          recognized_params = response.request_query
+          expect(!recognized_params.keys.include?("hair_color"))
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'open_fec_api'
+require 'pry'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: open_fec_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- MJ Rossetti (@s2t2)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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/).
+email:
+- s2t2mail@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CREDITS.md
+- ENDPOINTS.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/open_fec_api.rb
+- lib/open_fec_api/client.rb
+- lib/open_fec_api/response.rb
+- lib/open_fec_api/version.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/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+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/).
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb