congress 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc99e0d62cf703391f40a4ed7616465dec13ce5c
+  data.tar.gz: 20dac4fda3dc21e5e9cf1dc4689d22c9aee6e525
+SHA512:
+  metadata.gz: 42cdb0f6d8350b143efb903cd6e499ce3641736d9df0ab5e068f37d077d3854e76bea8f728f86853fb9515162dfc6f311c974c638492870a0e9bae025befe67f
+  data.tar.gz: 5475793e4c807877e443a64fb719582f6c4e507009414276bde67e79a050fc3b8387a337d3ad8ea72f42eba3670faa0bf95399c515ecf1c1272ac61184752b63

data/.gitignore

@@ -1,41 +1,11 @@
-!.gitignore
 *.gem
-*.rbc
-*.sw[a-p]
-*.tmproj
-*.tmproject
-*.un~
 *~
-.DS_Store
-.Spotlight-V100
-.Trashes
-._*
 .bundle
-.config
-.directory
-.elc
-.redcar
+.rvmrc
 .yardoc
-/.emacs.desktop
-/.emacs.desktop.lock
-Desktop.ini
 Gemfile.lock
-Icon?
-InstalledFiles
-Session.vim
-Thumbs.db
-\#*\#
-_yardoc
-auto-save-list
-coverage
-doc/
-lib/bundler/man
-pkg
+coverage/*
+doc/*
+log/*
+measurement/*
 pkg/*
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-tmtags
-tramp

data/.rspec

@@ -1,3 +1,2 @@
 --color
---format=nested
---backtrace
+--order random

data/.rubocop.yml

@@ -0,0 +1,81 @@
+AllCops:
+  Includes:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'congress.gemspec'
+
+# Avoid long parameter lists
+ParameterLists:
+  Max: 4
+  CountKeywordArgs: true
+
+MethodLength:
+  CountComments: false
+  Max: 15
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+
+# Do not force public/protected/private keyword to be indented at the same
+# level as the def keyword. My personal preference is to outdent these keywords
+# because I think when scanning code it makes it easier to identify the
+# sections of code and visually separate them. When the keyword is at the same
+# level I think it sort of blends in with the def keywords and makes it harder
+# to scan the code and see where the sections are.
+AccessModifierIndentation:
+  Enabled: false
+
+# Limit line length
+LineLength:
+  Enabled: false
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Enforce Ruby 1.8-compatible hash syntax
+HashSyntax:
+  EnforcedStyle: hash_rockets
+
+# No spaces inside hash literals
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# Allow dots at the end of lines
+DotPosition:
+  Enabled: false
+
+# Don't require magic comment at the top of every file
+Encoding:
+  Enabled: false
+
+# Enforce outdenting of access modifiers (i.e. public, private, protected)
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+EmptyLinesAroundAccessModifier:
+  Enabled: true
+
+# Align ends correctly
+EndAlignment:
+  AlignWith: variable
+
+# Indentation of when/else
+CaseIndentation:
+  IndentWhenRelativeTo: end
+  IndentOneStep: false
+
+Lambda:
+  Enabled: false
+
+NumericLiterals:
+  Enabled: false

data/.travis.yml

@@ -1,10 +1,28 @@
+before_install:
+  - gem update bundler
+  - bundle --version
+  - gem update --system 2.1.11
+  - gem --version
+bundler_args: --without development
 language: ruby
 rvm:
-  - jruby-18mode
-  - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
   - 1.8.7
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.0
+  - rbx
+  - ruby-head
+matrix:
+  include:
+    - rvm: jruby-18mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: jruby-19mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: jruby-head
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: rbx
+    - rvm: ruby-head
+  fast_finish: true

data/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+## Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project. Here are some ways *you* can contribute:
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+* Use alpha, beta, and pre-release versions.
+* Report bugs.
+* Suggest new features.
+* Write or edit documentation.
+* Write specifications.
+* Write code (**no patch is too small**: fix typos, add comments, clean up
+  inconsistent whitespace).
+* Refactor code.
+* Fix [issues][].
+* Review patches.
+* Financially pledge using [gittip][].
+
+[issues]: https://github.com/sferik/congress/issues
+[gittip]: https://www.gittip.com/sferik/
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake`. If your specs fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+   by your tests, return to step 3.
+8. Add documentation for your feature or bug fix.
+9. Run `bundle exec rake verify_measurements`. If your changes are not 100%
+   documented, go back to step 8.
+10. Commit and push your changes.
+11. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/Gemfile

@@ -1,21 +1,35 @@
 source 'https://rubygems.org'
 
+gem 'jruby-openssl', :platforms => :jruby
 gem 'rake'
-
-platforms :jruby do
-  gem 'jruby-openssl', '~> 0.7'
-end
+gem 'yard'
+gem 'geocoder'
 
 group :development do
   gem 'kramdown'
-  gem 'yard'
+  gem 'pry'
+  gem 'pry-rescue'
+  platforms :ruby_19, :ruby_20 do
+    gem 'pry-debugger'
+    gem 'pry-stack_explorer'
+  end
 end
 
 group :test do
+  gem 'backports'
   gem 'coveralls', :require => false
-  gem 'rspec'
+  gem 'mime-types', '~> 1.25', :platforms => [:jruby, :ruby_18]
+  gem 'rspec', '>= 2.14'
+  gem 'rubocop', '>= 0.16', :platforms => [:ruby_19, :ruby_20, :ruby_21]
   gem 'simplecov', :require => false
   gem 'webmock'
+  gem 'yardstick'
+end
+
+platforms :rbx do
+  gem 'racc'
+  gem 'rubinius-coverage', '~> 2.0'
+  gem 'rubysl', '~> 2.0'
 end
 
 gemspec

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2013, Code for America
+Copyright (c) 2011-2014, Code for America
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

data/README.md

@@ -17,16 +17,6 @@ Congress, provided by the Sunlight Foundation.
 ## Installation
     gem install congress
 
-To ensure the code you're installing hasn't been tampered with, it's
-recommended that you verify the signature. To do this, you need to add my
-public key as a trusted certificate (you only need to do this once):
-
-    gem cert --add <(curl -Ls https://raw.github.com/codeforamerica/congress/master/certs/sferik.pem)
-
-Then, install the gem with the high security trust policy:
-
-    gem install congress -P HighSecurity
-
 ## Documentation
 [http://rdoc.info/gems/congress][documentation]
 [documentation]: http://rdoc.info/gems/congress
@@ -98,55 +88,7 @@ Congress.hearings
 Congress.upcoming_bills
 ```
 
-## Contributing
-In the spirit of [free software][free-sw], **everyone** is encouraged to help improve
-this project.
-
-[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
-
-Here are some ways *you* can contribute:
-
-* by using alpha, beta, and prerelease versions
-* by reporting bugs
-* by suggesting new features
-* by writing or editing documentation
-* by writing specifications
-* by writing code (**no patch is too small**: fix typos, add comments, clean up
-  inconsistent whitespace)
-* by refactoring code
-* by fixing [issues][]
-* by reviewing patches
-
-[issues]: https://github.com/codeforamerica/congress/issues
-
-## Submitting an Issue
-We use the [GitHub issue tracker][issues] to track bugs and features. Before
-submitting a bug report or feature request, check to make sure it hasn't
-already been submitted. When submitting a bug report, please include a [Gist][]
-that includes a stack trace and any details that may be necessary to reproduce
-the bug, including your gem version, Ruby version, and operating system.
-Ideally, a bug report should include a pull request with failing specs.
-
-## Submitting a Pull Request
-1. [Fork the repository.][fork]
-2. [Create a topic branch.][branch]
-3. Add specs for your unimplemented feature or bug fix.
-4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
-5. Implement your feature or bug fix.
-6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
-7. Run `open coverage/index.html`. If your changes are not completely covered
-   by your tests, return to step 3.
-8. Add documentation for your feature or bug fix.
-9. Run `bundle exec rake yard`. If your changes are not 100% documented, go
-   back to step 8.
-10. Add, commit, and push your changes.
-11. [Submit a pull request.][pr]
-
-[fork]: http://help.github.com/fork-a-repo/
-[branch]: http://learn.github.com/p/branching.html
-[pr]: http://help.github.com/send-pull-requests/
-
-## Supported Rubies
+## Supported Ruby Versions
 This library aims to support and is [tested against][travis] the following Ruby
 implementations:
 
@@ -154,6 +96,7 @@ implementations:
 * Ruby 1.9.2
 * Ruby 1.9.3
 * Ruby 2.0.0
+* Ruby 2.1.0
 * [JRuby][]
 * [Rubinius][]
 
@@ -175,6 +118,6 @@ 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.
 
 ## Copyright
-Copyright (c) 2011-2013, Code for America. See [LICENSE][] for details.
+Copyright (c) 2011-2014, Code for America. See [LICENSE][] for details.
 
 [license]: https://github.com/codeforamerica/congress/blob/master/LICENSE.md

data/Rakefile

@@ -4,13 +4,33 @@ Bundler::GemHelper.install_tasks
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
 task :test => :spec
 
+begin
+  require 'rubocop/rake_task'
+  Rubocop::RakeTask.new
+rescue LoadError
+  task :rubocop do
+    $stderr.puts 'Rubocop is disabled'
+  end
+end
+
 require 'yard'
 namespace :doc do
   YARD::Rake::YardocTask.new do |task|
-    task.files   = ['lib/**/*.rb']
-    task.options = ['--markup', 'markdown']
+    task.files   = %w[lib/**/*.rb]
+    task.options = %w[--markup markdown]
   end
 end
+
+require 'yardstick/rake/measurement'
+Yardstick::Rake::Measurement.new do |measurement|
+  measurement.output = 'measurement/report.txt'
+end
+
+require 'yardstick/rake/verify'
+Yardstick::Rake::Verify.new do |verify|
+  verify.threshold = 60.0
+end
+
+task :default => [:spec, :rubocop, :verify_measurements]

data/congress.gemspec

@@ -7,8 +7,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'hashie', '~> 2.0'
   spec.add_dependency 'json', '~> 1.8'
   spec.add_dependency 'rash', '~> 0.4'
+  spec.add_dependency 'geocoder', '~> 1.1.9'
   spec.add_development_dependency 'bundler', '~> 1.0'
-  spec.author        = "Erik Michaels-Ober"
+  spec.author        = 'Erik Michaels-Ober'
   spec.cert_chain    = ['certs/sferik.pem']
   spec.description   = %q{Ruby wrapper for the Sunlight Congress API, a live JSON API for the people and work of Congress, provided by the Sunlight Foundation.}
   spec.email         = 'sferik@gmail.com'
@@ -17,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.licenses      = ['MIT']
   spec.name          = 'congress'
   spec.require_paths = ['lib']
-  spec.signing_key   = File.expand_path("~/.gem/private_key.pem") if $0 =~ /gem\z/
+  spec.signing_key   = File.expand_path('~/.gem/private_key.pem') if $PROGRAM_NAME =~ /gem\z/
   spec.summary       = %q{Ruby wrapper for the Sunlight Congress API}
   spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   spec.version       = Congress::VERSION

data/lib/congress/client.rb

@@ -1,10 +1,17 @@
 require 'congress/connection'
 require 'congress/request'
+require 'geocoder'
 
 module Congress
   class Client
     include Connection
     include Request
+    attr_reader :key
+
+    def initialize(key)
+      fail ArgumentError, 'API key required' if key.nil?
+      @key = key
+    end
 
     # Current legislators' names, IDs, biography, and social media.
     #
@@ -12,32 +19,32 @@ module Congress
     # @example
     #   Congress.key = YOUR_SUNLIGHT_API_KEY
     #   Congress.legislators
-    def legislators(options={})
-      get('/legislators', options.merge(api_key))
+    def legislators(options = {})
+      get('/legislators', options)
     end
 
-    # Find representatives and senators for a latitude/longitude or zip.
+    # Find representatives and senators for a latitude/longitude, zip, or address.
     #
     # @return [Hashie::Rash]
     # @example
     #   Congress.key = YOUR_SUNLIGHT_API_KEY
     #   Congress.legislators_locate(94107)
     #   Congress.legislators_locate(37.775, -122.418)
+    #   Congress.legislators_locate('2169 Mission Street, San Francisco, CA 94110')
     def legislators_locate(*args)
-      options = extract_location(args)
-      get('/legislators/locate', options.merge(api_key))
+      get('/legislators/locate', extract_location(args))
     end
 
-    # Find congressional districts for a latitude/longitude or zip.
+    # Find congressional districts for a latitude/longitude, zip, or address.
     #
     # @return [Hashie::Rash]
     # @example
     #   Congress.key = YOUR_SUNLIGHT_API_KEY
     #   Congress.districts_locate(94107)
     #   Congress.districts_locate(37.775, -122.418)
+    #   Congress.districts_locate('2169 Mission Street, San Francisco, CA 94110')
     def districts_locate(*args)
-      options = extract_location(args)
-      get('/districts/locate', options.merge(api_key))
+      get('/districts/locate', extract_location(args))
     end
 
     # Current committees, subcommittees, and their membership.
@@ -46,8 +53,8 @@ module Congress
     # @example
     #   Congress.key = YOUR_SUNLIGHT_API_KEY
     #   Congress.committees
-    def committees(options={})
-      get('/committees', options.merge(api_key))
+    def committees(options = {})
+      get('/committees', options)
     end
 
     # Legislation in the House and Senate, back to 2009. Updated daily.
@@ -56,8 +63,8 @@ module Congress
     # @example
     #   Congress.key = YOUR_SUNLIGHT_API_KEY
     #   Congress.bills
-    def bills(options={})
-      get('/bills', options.merge(api_key))
+    def bills(options = {})
+      get('/bills', options)
     end
 
     # ull text search over legislation.
@@ -66,8 +73,8 @@ module Congress
     # @example
     #   Congress.key = YOUR_SUNLIGHT_API_KEY
     #   Congress.bills_search
-    def bills_search(options={})
-      get('/bills/search', options.merge(api_key))
+    def bills_search(options = {})
+      get('/bills/search', options)
     end
 
     # Roll call votes in Congress, back to 2009. Updated within minutes of votes.
@@ -76,8 +83,8 @@ module Congress
     # @example
     #   Congress.key = YOUR_SUNLIGHT_API_KEY
     #   Congress.votes
-    def votes(options={})
-      get('/votes', options.merge(api_key))
+    def votes(options = {})
+      get('/votes', options)
     end
 
     # To-the-minute updates from the floor of the House and Senate.
@@ -86,8 +93,8 @@ module Congress
     # @example
     #   Congress.key = YOUR_SUNLIGHT_API_KEY
     #   Congress.floor_updates
-    def floor_updates(options={})
-      get('/floor_updates', options.merge(api_key))
+    def floor_updates(options = {})
+      get('/floor_updates', options)
     end
 
     # Committee hearings in Congress. Updated as hearings are announced.
@@ -96,8 +103,8 @@ module Congress
     # @example
     #   Congress.key = YOUR_SUNLIGHT_API_KEY
     #   Congress.hearings
-    def hearings(options={})
-      get('/hearings', options.merge(api_key))
+    def hearings(options = {})
+      get('/hearings', options)
     end
 
     # Bills scheduled for debate in the future, as announced by party leadership.
@@ -106,29 +113,25 @@ module Congress
     # @example
     #   Congress.key = YOUR_SUNLIGHT_API_KEY
     #   Congress.upcoming_bills
-    def upcoming_bills(options={})
-      get('/upcoming_bills', options.merge(api_key))
+    def upcoming_bills(options = {})
+      get('/upcoming_bills', options)
     end
 
   private
 
-    def api_key
-      {:apikey => Congress.key}
-    end
-
     def extract_location(args)
       options = args.last.is_a?(::Hash) ? args.pop : {}
-      case args.size
-      when 1
-        options[:zip] = args.pop
-      when 2
-        options[:longitude] = args.pop
-        options[:latitude] = args.pop
+      case [args.size, args.first.class]
+      when [1, Fixnum]
+        options.merge(:zip => args.pop)
+      when [1, String]
+        placemark = Geocoder.search(args.pop).first
+        options.merge(:longitude => placemark.longitude, :latitude => placemark.latitude)
+      when [2, Float]
+        options.merge(:longitude => args.pop, :latitude => args.pop)
       else
-        raise ArgumentError, "Must pass a latitude/longitude or zip"
+        fail ArgumentError, 'Must pass a latitude/longitude, zip or address'
       end
-      options
     end
-
   end
 end

data/lib/congress/connection.rb

@@ -2,16 +2,26 @@ require 'faraday_middleware'
 
 module Congress
   module Connection
-    private
+    ENDPOINT = 'https://congress.api.sunlightfoundation.com'.freeze
+
+  private
 
     def connection
-      Faraday.new(:url => 'http://congress.api.sunlightfoundation.com') do |connection|
-        connection.use Faraday::Request::UrlEncoded
-        connection.use Faraday::Response::RaiseError
-        connection.use Faraday::Response::Rashify
-        connection.use Faraday::Response::ParseJson
+      @connection ||= create_connection
+    end
+
+    def create_connection
+      Faraday.new(:url => ENDPOINT) do |connection|
+        middlewares.each { |middleware| connection.use(middleware) }
         connection.adapter(Faraday.default_adapter)
       end
     end
+
+    def middlewares
+      [Faraday::Request::UrlEncoded,
+       Faraday::Response::RaiseError,
+       Faraday::Response::Rashify,
+       Faraday::Response::ParseJson]
+    end
   end
 end

data/lib/congress/request.rb

@@ -1,13 +1,14 @@
 module Congress
   module Request
-    def get(path, options={})
+    def get(path, options = {})
       request(:get, path, options)
     end
 
-    private
+  private
 
     def request(method, path, options)
       response = connection.send(method) do |request|
+        request.headers['X-APIKEY'] = key
         request.url(path, options)
       end
       response.body

data/lib/congress/version.rb

@@ -1,3 +1,3 @@
 module Congress
-  VERSION = "0.1.1"
+  VERSION = '0.2.0'
 end