open_civic_data 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bb95989575453bc018f0019271ad66bad07f70f
-  data.tar.gz: 359eeabd885b3f57e9938bd80ad1b4792b0a9e63
+  metadata.gz: 02afd451738c2eb01eb278856f0d930ed2768115
+  data.tar.gz: d27092afc718d564c6222ebabe946dc32b5592ef
 SHA512:
-  metadata.gz: b29a0eff891f4ee80172e8e8479ab6bd42ca49f554903abf85f4910c0b415ba6b6f968163cc2315a1fba323754959fc6f7b168387dd43aab7f20c0db85c5987e
-  data.tar.gz: cbf522dbd5e03d454b3c15c1c721f6887fe2cfaa043b9799fab75cadb45b033597a631a78699a0dcfd185f1525de9c12d4ee7bdc76eda9b9239a13ba2b2f1937
+  metadata.gz: c8c7d71d51c0c1b507cea00fdada8c535ef4147faf3389394c6c0d78e2bb591d7635f2998848621853decb5a3d49e243f886d6f7c2ccc3472e065a16abdb550d
+  data.tar.gz: 193021ea77469b93cdac34ae485c1d7b30942d9f42bce1101be0f2f266c825e85708b0ac8482c1a2735c6a2d414d3d922a165abcff65db2e630cf0af7e535fb8

data/README.md

@@ -1,24 +1,20 @@
 # Ruby wrapper for the Open Civic Data API
 
-[![Build Status](https://travis-ci.org/whatasunnyday/open_civic_data.png?branch=master)](https://travis-ci.org/whatasunnyday/open_civic_data)
+[![Build Status](https://travis-ci.org/whatasunnyday/open_civic_data.png?branch=master)][travis]
 [travis]: https://travis-ci.org/whatasunnyday/open_civic_data
 
 The Open Civic Data API is a JSON API that provides search and lookup across government organizations, people, legislation, and events, provided by the Sunlight Foundation.
 
-For more information, check the [API documentation][apidocs]
-[apidocs]: http://docs.opencivicdata.org/en/latest/index.html
+For more information, check the [API documentation](http://docs.opencivicdata.org/en/latest/index.html).
 
 ## Installation
     gem install open_civic_data
 
-## Documentation
-[http://rdoc.info/github/whatasunnyday/open_civic_data/][documentation]
-[documentation]: http://rdoc.info/github/whatasunnyday/open_civic_data/
-
 ## Authentication
 
 All requests to the Open Civic Data API require a Sunlight API key. An API key is
 [free to register][register] and has no usage limits.
+
 [register]: http://services.sunlightlabs.com/accounts/register/
 
 ## Usage Examples
@@ -29,57 +25,6 @@ require 'open_civic_data'
 OpenCivicData.key = YOUR_SUNLIGHT_API_KEY
 ```
 
-###### Fetches governing bodies in a division.
-```ruby
-OpenCivicData.jurisdictions
-```
-
-###### Fetches political geographies such as a state, county or congressional district.
-```ruby
-OpenCivicData.divisions
-```
-
-###### Fetches people, typically politicians or gov officials.
-```ruby
-OpenCivicData.people
-```
-
-###### Fetches groups of people, such as a city council, state senate or committee.
-```ruby
-OpenCivicData.organizations
-```
-
-###### Fetches legislative event, such as a meeting or hearing.
-```ruby
-OpenCivicData.events
-```
-
-###### Fetches legislative documents, resolutions, appointments, or contracts and its history.
-```ruby
-OpenCivicData.bills
-```
-
-###### Fetches the record of vote taken on motions. May contain individual legilsator's yay/nay or outcome.
-```ruby
-OpenCivicData.votes
-```
-
-###### All methods include an optional parameter to set search end points
-```ruby
-# Returns legislators named 'Obama'
-OpenCivicData.people({'name' => 'Obama'})
-
-# Returns second page of results (results are paginated && 0 indexed)
-OpenCivicData.votes({'page' => 1 })
-```
-
-###### Use with Other APIs
-```ruby
-# You can change the end point and disable key if necessary.
-OpenCivicData.key_required = false
-OpenCivicData.endpoint = 'http://imago-ca.herokuapp.com/'
-```
-
 ## Supported Ruby Versions
 This library aims to support and is [tested against][travis] the following Ruby
 implementations:
@@ -106,10 +51,9 @@ timely fashion. If critical issues for a particular implementation exist at the
 time of a major release, support for that Ruby version may be dropped.
 
 ## Special Thanks to
-The [contributors][] of the [Congress gem][congress] where the ideas behind this gem were largely lifted from.
-[contributors]: https://github.com/codeforamerica/congress/graphs/contributors
-[congress]: https://github.com/codeforamerica/congress
+The (contributors)[https://github.com/codeforamerica/congress/graphs/contributors] of the (Congress gem)[https://github.com/codeforamerica/congress] where the ideas behind this gem largely lifted from.
 
 ## Copyright
 Copyright (c) 2014, Sunny Juneja. See [LICENSE][] for details.
+
 [license]: https://github.com/whatasunnyday/open_civic_data/blob/master/LICENSE.md

data/Rakefile

@@ -30,7 +30,7 @@ end
 
 require 'yardstick/rake/verify'
 Yardstick::Rake::Verify.new do |verify|
-  verify.threshold = 72.6
+  verify.threshold = 60.0
 end
 
 task default: [:spec, :rubocop, :verify_measurements]

data/lib/open_civic_data.rb

@@ -5,9 +5,7 @@ module OpenCivicData
   attr_accessor :key
 
   # Alias for OpenCivicData::Client.new
-  # @api public
-  # @example
-  #   OpenCivicData.new(SUNLIGHT_KEY)
+  #
   # @return [OpenCivicData::Client]
   def new(key = key)
     yield self if block_given?
@@ -16,17 +14,9 @@ module OpenCivicData
   end
 
   # Delegate to OpenCivicData::Client
-  # @api public
-  # @example
-  #   OpenCivicData.jurisdictions
   def method_missing(method, *args, &block)
-    if OpenCivicData::Client.respond_to?(method)
-      OpenCivicData::Client.send(method, *args, &block)
-    elsif new.respond_to?(method)
-      new.send(method, *args, &block)
-    else
-      super
-    end
+    return super unless new.respond_to?(method)
+    new.send(method, *args, &block)
   end
 
   # return [Boolean]

data/lib/open_civic_data/client.rb

@@ -8,112 +8,86 @@ module OpenCivicData
 
     attr_reader :key
 
-    @@key_required = true # rubocop:disable ClassVars
-    @@endpoint = 'http://api.opencivicdata.org' # rubocop:disable ClassVars
-
     def initialize(key)
-      fail ArgumentError, 'API key required' if key.nil? && @@key_required
+      warn 'Warning: Your API key may not be set.' if key.nil?
       @key = key
     end
 
-    # Fetches governing bodies that exist within a division
-    # @return [Hashie::Rash] Jurisdiction's name, url, chambers, terms, and session details.
+    # Jurisdictions are governing bodies that exists within a division.
+    # Jurisdiction's name, url, chambers, terms, and session details.
+    #
+    # return [Hashie::Rash]
     # @example
     #   OpenCivicData.key = YOUR_SUNLIGHT_API_KEY
     #   OpenCivicData.jurisdictions
-    # @api public
     def jurisdictions(options = {})
       get('/jurisdictions/', options)
     end
 
-    # Fetches political geographies such as a state, county or congressional district
-    # @return [Hashie::Rash] Division's geometries and list of child jurisdiction ids.
+    # Divisions are political geographies such as a state, county, or congressional district.
+    # Division's geometries and list of child jurisdiction ids.
+    #
+    # @return [Hashie::Rash]
     # @example
     #   OpenCivicData.key = YOUR_SUNLIGHT_API_KEY
     #   OpenCivicData.divisions
-    # @api public
     def divisions(options = {})
       get('/divisions/', options)
     end
 
-    # Fetches people, typically politicians or gov officials
-    # @return [Hashie::Rash] Person's name, image, contact details, and links.
+    # People, typically a politician or gov official.
+    # Person's name, image, contact details, and links.
+    #
+    # @return [Hashie::Rash]
     # @example
     #   OpenCivicData.key = YOUR_SUNLIGHT_API_KEY
     #   OpenCivicData.people
-    # @api public
     def people(options = {})
       get('/people/', options)
     end
 
-    # Fetches groups of people, such as a city council, state senate or committee
-    # @return [Hashie::Rash] Organization's name, classification, parent id, contact details, links and posts.
+    # A group of people, such as a city council, state senate, or committee.
+    # Organization's name, classification, parent id, contact details, links and posts.
+    #
+    # @return [Hashie::Rash]
     # @example
     #   OpenCivicData.key = YOUR_SUNLIGHT_API_KEY
     #   OpenCivicData.organizations
-    # @api public
     def organizations(options = {})
       get('/organizations/', options)
     end
 
-    # Fetches legislative event, such as a meeting or hearing
-    # @return [Hashie::Rash] Event's type, name, description, when, end, status, location, and linked entities.
+    # A legislative event, such as a meeting or hearing.
+    # Event's type, name, description, when, end, status, location, and linked entities.
+    #
+    # @return [Hashie::Rash]
     # @example
     #   OpenCivicData.key = YOUR_SUNLIGHT_API_KEY
     #   OpenCivicData.events
-    # @api public
     def events(options = {})
       get('/events/', options)
     end
 
-    # Fetches legislative documents and their history
-    # @return [Hashie::Rash] Bill's type, legislative body, session, name, chamber, title, type, subject and summary.
+    # Legislative documents, resolutions, appointments or contract and its history,
+    # Bill's type, legislative body, session, name, chamber, title, type, subject and summary.
+    #
+    # @return [Hashie::Rash]
     # @example
     #   OpenCivicData.key = YOUR_SUNLIGHT_API_KEY
     #   OpenCivicData.bills
-    # @api public
     def bills(options = {})
       get('/bills/', options)
     end
 
-    # Fetches the record of vote taken on motions
-    # @return [Hashie::Rash] Vote's organization, session, chamber, date, motion, type and passed or not.
+    # The record of a vote taken on a motion. May contain individual legilsator's yay/nay or outcome.
+    # Vote's organization, session, chamber, date, motion, type and passed or not.
+    #
+    # @return [Hashie::Rash]
     # @example
     #   OpenCivicData.key = YOUR_SUNLIGHT_API_KEY
     #   OpenCivicData.votes
-    # @api public
     def votes(options = {})
       get('/votes/', options)
     end
-
-    class << self
-      # Disable ArgumentError if no api key is provided. Useful for using different endpoints.
-      # @param [Boolean]
-      # @api public
-      # @example
-      #   OpenCivicData.key_required(false)
-      #   OpenCivicData.jurisdictions
-      def key_required=(bool)
-        @@key_required = bool # rubocop:disable ClassVars
-      end
-
-      # Check if key is required.
-      # @return [Boolean]
-      # @api public
-      # @example
-      #   if OpenCivicData.key_required
-      #     OpenCivicData.key = SUNLIGHT_KEY
-      def key_required
-        @@key_required
-      end
-
-      def endpoint=(endpoint)
-        @@endpoint = endpoint
-      end
-
-      def endpoint
-        @@endpoint
-      end
-    end
   end
 end

data/lib/open_civic_data/connection.rb

@@ -2,7 +2,7 @@ require 'faraday_middleware'
 
 module OpenCivicData
   module Connection
-# rubocop:disable EmptyLinesAroundBody
+    ENDPOINT = 'http://api.opencivicdata.org'.freeze
 
   private
 
@@ -11,7 +11,7 @@ module OpenCivicData
     end
 
     def create_connection
-      Faraday.new(url: OpenCivicData.endpoint) do |connection|
+      Faraday.new(url: ENDPOINT) do |connection|
         middlewares.each { |middleware| connection.use(middleware) }
         connection.adapter(Faraday.default_adapter)
       end

data/lib/open_civic_data/request.rb

@@ -8,7 +8,7 @@ module OpenCivicData
 
     def request(method, path, options)
       response = connection.send(method) do  |request|
-        request.params['apikey'] = @key if Client.key_required
+        request.params['apikey'] = @key
         request.url(path, options)
       end
       response.body

data/lib/open_civic_data/version.rb

@@ -1,3 +1,3 @@
 module OpenCivicData
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/helper.rb

@@ -6,7 +6,7 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 
 SimpleCov.start do
   add_filter '/spec/'
-  minimum_coverage(98)
+  minimum_coverage(100)
 end
 
 require 'open_civic_data'
@@ -20,11 +20,11 @@ RSpec.configure do |config|
 end
 
 def a_get(path)
-  a_request(:get, OpenCivicData.endpoint + path)
+  a_request(:get, OpenCivicData::Client::ENDPOINT + path)
 end
 
 def stub_get(path, options)
-  stub_request(:get, OpenCivicData.endpoint + path).with(query: options)
+  stub_request(:get, OpenCivicData::Client::ENDPOINT + path).with(query: options)
 end
 
 def fixture_path

data/spec/open_civic_data/client_spec.rb

@@ -2,8 +2,9 @@ require 'helper'
 
 describe OpenCivicData::Client do
   before do
-    @client = OpenCivicData::Client.new('abcd1234')
-    @options = {'apikey' => 'abcd1234'}
+    apikey = 'abcd1234'
+    @client = OpenCivicData::Client.new(apikey)
+    @options = {'apikey' => apikey}
   end
 
   describe '#jurisdictions' do

data/spec/open_civic_data_spec.rb

@@ -1,12 +1,14 @@
 require 'helper'
 
 describe OpenCivicData do
+  before do
+    OpenCivicData.key = 'abcd1234'
+  end
+
   describe '.new' do
     it 'returns a OpenCivicData::Client' do
-      OpenCivicData.key = 'abcd1234'
       expect(OpenCivicData.new).to be_a OpenCivicData::Client
     end
-    # This test should fail even though it doesn't always
     it 'sets key with a block' do
       OpenCivicData.new do |ocd|
         ocd.key = '1234abcd'
@@ -15,49 +17,12 @@ describe OpenCivicData do
     end
     context 'with no api key' do
       it 'raises an arguement error' do
-        expect(OpenCivicData.key_required).to eql(true)
-        expect { OpenCivicData.new(nil) }.to raise_error
-      end
-      describe 'api key is disabled' do
-        before do
-          OpenCivicData.key_required = false
-        end
-        after do
-          OpenCivicData.key_required = true
-        end
-        it 'does not raise an arguement error' do
-          expect(OpenCivicData.key_required).to eql(false)
-          expect { OpenCivicData.new(nil) }.not_to raise_error
-        end
+        expect { OpenCivicData.new(nil) }.to raise_error ArgumentError
       end
     end
-    describe '.endpoint' do
-      it 'has a default endpoint' do
-        expect(OpenCivicData.endpoint).to eq('http://api.opencivicdata.org')
-      end
 
-      describe 'setting a new endpoint' do
-        before do
-          OpenCivicData.key = 'ghapi'
-          OpenCivicData.endpoint = 'http://github.com'
-          stub_request(:get, 'http://github.com/jurisdictions/').
-            with(query: {'apikey' => 'ghapi'}).
-            to_return(status: 200, body: fixture('jurisdictions.json'))
-        end
-        after do
-          OpenCivicData.endpoint = 'http://api.opencivicdata.org'
-          OpenCivicData.key = 'abcd1234'
-        end
-        it 'changes the url queried' do
-          OpenCivicData.jurisdictions
-          expect(a_request(:get, 'http://github.com/jurisdictions/')
-                 .with(query: {'apikey' => 'ghapi'})).to have_been_made
-        end
-      end
-    end
     describe '.method_missing' do
       before do
-        OpenCivicData.key = 'abcd1234'
         stub_get('/jurisdictions/', 'apikey' => 'abcd1234').
           to_return(status: 200, body: fixture('jurisdictions.json'))
       end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: open_civic_data
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Sunny Juneja
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-03 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rash
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 description: Ruby wrapper for the Sunlight Open Civic Data API, is an collaborative
@@ -102,12 +102,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gemtest"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- ".yardopts"
+- .gemtest
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- .yardopts
 - Gemfile
 - LICENSE.md
 - README.md
@@ -138,17 +138,17 @@ 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.2.1
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the Sunlight Open Civic Data API