sunlight-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56f8123b9b8d42b35e0b22031b693ec15100c00c
+  data.tar.gz: 20db42fec5c5cbe1d01ca65416f28a390a9097a7
+SHA512:
+  metadata.gz: 1f0e60b00a35da1c664aff76371064b8a8ea1feed0deb21023e87d5732860206a920cd2b646e5052a54530689540d19c22c647d1a5d96114ba2c6a6f9346d173
+  data.tar.gz: b3a02752ab6cc2aab829ef4fd7221f8fe02fe49fb831c370bc1d7778a3881be02ec95cc02078defba984783b27234f5ca6c83a9dfb9109ee1df491a433fdb09e

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kyle Moore
+
+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,66 @@
+# Sunlight Api
+
+The [Sunlight Foundation](http://sunlightfoundation.com/about/) is a nonprofit, nonpartisan group that "advocates for open government globally and uses technology to make government more accountable to all." They provide multiple great APIs for political data, and this gem provides a **clean, simple wrapper for the Sunlight Foundation APIs**. It's currently a work in progress, and will be updated frequently to support more of their APIs.
+
+## Usage
+
+#### Congress API
+##### Legislators
+
+To find the representatives for a certain location
+```ruby
+Sunlight::Congress::Legislator.locate_by_zip(23219)
+Sunlight::Congress::Legislator.locate(zip: 23219)
+Sunlight::Congress::Legislator.locate(latitude: 37.538821, longitude: -77.433574)
+Sunlight::Congress::Legislator.locate(address: '1000 Bank St, Richmond, VA')
+Sunlight::Congress::Legislator.locate('37.538821, -77.433574') # Not recommended
+Sunlight::Congress::Legislator.locate('1000 Bank St, Richmond, VA')
+```
+A zip code may intersect with multiple congressional districts, so to find all the legislators in a certain zip code, use the ```locate_by_zip``` method. The ```locate``` method can take parameters as either a string or hash of options (recommended for latitude/longitude or zip codes). All string queries will be geocoded into lat/long pairs.
+
+To find a specific representative, you have multiple options for searching
+```ruby
+Sunlight::Congress::Legislator.find('Warner') # Searches on the first, middle, last, and nickname fields
+Sunlight::Congress::Legislator.find(gender: 'F', party: 'R') # All current female, republican legislators
+Sunlight::Congress::Legislator.find(gender: 'F', party: 'R', all_legislators: true) # All past and present female, republican legislators
+Sunlight::Congress::Legislator.find_by_state_rank('senior') # All legislators with a senior rank
+```
+The ```find``` method accepts either a string or hash of parameters. Strings will only query the first, middle, last, and nicknames of legislators. You can also ```find_by_``` certain attributes. To see a list of accepted attributes (also applies to parameters passed into the ```find``` method), [look here](https://sunlightlabs.github.io/congress/legislators.html)
+
+Legislator location and searching methods return an array of ```Legislator``` objects
+```ruby
+legislators = Sunlight::Congress::Legislator.find(gender: 'F', party: 'R')
+legislators #=> [#<Sunlight::Congress::Legislator:0x007f8fb7834b88 @bioguide_id="E000295", @birthday="1970-07-01", @chamber="senate"...>, #<Sunlight::Congress::Legislator:0x007f8fb58b15e0 @bioguide_id="C001105", @birthday="1959-06-30", @chamber="house"...>, ...]
+legislators[0].office #=> "825 B&c Hart Senate Office Building"
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sunlight-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sunlight-api
+
+Get [your API key](http://sunlightfoundation.com/api/accounts/register/) and run:
+
+```ruby
+Sunlight::Base.api_key = 'your_api_key'
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/kylerm42/sunlight-api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/sunlight-api.rb

@@ -0,0 +1,3 @@
+require 'sunlight/base'
+require 'sunlight/congress'
+require 'sunlight/congress/legislator'

data/lib/sunlight/base.rb

@@ -0,0 +1,7 @@
+module Sunlight
+  class Base
+    class << self
+      attr_accessor :api_key
+    end
+  end
+end

data/lib/sunlight/congress.rb

@@ -0,0 +1,7 @@
+require 'net/http'
+
+module Sunlight
+  class Congress
+    BASE_URI = 'https://congress.api.sunlightfoundation.com'
+  end
+end

data/lib/sunlight/congress/legislator.rb

@@ -0,0 +1,90 @@
+require 'geocoder'
+
+module Sunlight
+  class Congress
+    class Legislator
+
+      SEARCH_ATTRIBUTES = [:first_name, :middle_name, :last_name, :name_suffix,
+                          :nickname, :state, :state_name, :state_rank, :party,
+                          :chamber, :title, :senate_class, :district, :term_start,
+                          :term_end, :birthday, :fax, :in_office, :bioguide_id,
+                          :crp_id, :govtrack_id, :icpsr_id, :fec_ids, :lis_id,
+                          :ocd_id, :thomas_id, :votesmart_id, :oc_email]
+
+      attr_accessor *SEARCH_ATTRIBUTES.concat([:phone, :website, :office, :contact_form,
+                                              :fax, :twitter_id, :youtube_id, :facebook_id])
+
+      def initialize(options = {})
+        options.each do |attribute, value|
+          instance_variable_set("@#{attribute}", value)
+        end
+      end
+
+      class << self
+        def locate_by_zip(zip)
+          response = Net::HTTP.get_response(locate_uri(zip: zip))
+
+          JSON.parse(response.body)['results'].map do |legislator_attrs|
+            self.new(legislator_attrs)
+          end
+        end
+
+        def locate(options)
+          if options.is_a?(String) || options[:address]
+            coords = Geocoder.coordinates(options)
+            response = Net::HTTP.get_response(locate_uri(latitude: coords[0], longitude: coords[1]))
+          else
+            response = Net::HTTP.get_response(locate_uri(options))
+          end
+
+          create_from_response(response)
+        end
+
+        def locate_uri(options = {})
+          encode_uri('legislators/locate', options)
+        end
+
+        def find(query)
+          if query.is_a?(String)
+            response = Net::HTTP.get_response(find_uri(query: query))
+          else
+            response = Net::HTTP.get_response(find_uri(query))
+          end
+
+          create_from_response(response)
+        end
+
+        SEARCH_ATTRIBUTES.each do |param|
+          define_method("find_by_#{param}") do |query|
+            response = Net::HTTP.get_response(find_uri("#{param}" => query))
+
+            create_from_response(response)
+          end
+        end
+
+        def find_uri(options = {})
+          encode_uri('legislators', options)
+        end
+
+        def encode_uri(location, options)
+          uri = URI("#{BASE_URI}/#{location}")
+          uri.query = URI.encode_www_form(options.merge(apikey: '6d4acf5a753c40e1824857bb12679d89'))
+
+          uri
+        end
+
+        def create_from_response(response)
+          json = JSON.parse(response.body)
+
+          if results = json['results']
+            results.map do |legislator_attrs|
+              self.new(legislator_attrs)
+            end
+          elsif errors = json['error']
+            json
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sunlight/version.rb

@@ -0,0 +1,3 @@
+module Sunlight
+  VERSION = '0.0.1'
+end

data/sunlight-api.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sunlight/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sunlight-api"
+  spec.version       = Sunlight::VERSION
+  spec.authors       = ["Kyle Moore"]
+  spec.email         = ["kylerm42@gmail.com"]
+  spec.summary       = %q{Gem for interacting with various Sunlight Foundation APIs}
+  spec.homepage      = "https://github.com/kylerm42/sunlight-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_runtime_dependency 'geocoder'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: sunlight-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kyle Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-09 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: geocoder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- kylerm42@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sunlight-api.rb
+- lib/sunlight/base.rb
+- lib/sunlight/congress.rb
+- lib/sunlight/congress/legislator.rb
+- lib/sunlight/version.rb
+- sunlight-api.gemspec
+homepage: https://github.com/kylerm42/sunlight-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.2.2
+signing_key: 
+specification_version: 4
+summary: Gem for interacting with various Sunlight Foundation APIs
+test_files: []