openstates 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54bc4b599a448cce3390ad41081fa947d9fc1ea7
+  data.tar.gz: 2abd48ee2bd954dc8de98abebe8f1bcfd08ae680
+SHA512:
+  metadata.gz: e8589886070d20f45029466d77e45de96b09a3020a2aa6d27e16be36ea17d102aaa0ad5987b5fd52106853cc36be155775f6fcbfb9a0bf35511a8dad4fcd38f5
+  data.tar.gz: 419adea1911286dc3fc60a1d171eafd0380eeba57f55f9b15061696f1317c174776208f0e4a3f084440ade7bdef16a8dff6aa0e72468a7358e305aaee192f6b8

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/README.md

@@ -1,6 +1,6 @@
-# Ruby::Openstates
+# Openstates
 
-Ruby gem to interact with the OpenStates API.
+Ruby gem to interact with the Sunlight Labs OpenStates API.
 
 ## Installation
 
@@ -16,8 +16,136 @@ Or install it yourself as:
 
     $ gem install openstates
 
+## Configuration
+
+You will need to register for an API key with [Sunlight
+Labs](http://services.sunlightlabs.com/api/register/).
+
+If you intend to use this gem in a rails project, you should add the
+following in `config/initializers/openstates.rb`
+
+```rb
+OpenStates.configure do |config|
+  config.api_key ='yourkeyhere'
+  config.logger = Rails.logger
+end
+```
+
+If your project is not rails based, you just need to include the above
+configuration somewhere in your ruby environment with single change.
+
+```rb
+OpenStates.configure do |config|
+  config.api_key ='yourkeyhere'
+  config.logger = ::Logger.new(STDOUT)
+  config.logger.level = ::Logger::DEBUG
+end
+```
+
 ## Usage
 
+### OpenStates::Bill
+
+You can search for bills using the `where` class method on
+OpenStates::Bill.
+
+```rb
+bills = OpenStates::Bill.where(state: 'tx', q: 'taxi')
+```
+
+You can also search for a specific bill by it's bill_id.
+
+```rb
+bill = OpenStates::Bill.find("12345")
+```
+
+And lastly, you can get bill details by using the `bill_details` class
+method on OpenStates::Bill.
+
+```rb
+bill = OpenStates::Bill.bill_details('fl', '2013', '12345')
+```
+
+You can find a list of all query parameters for Bills
+[here](http://sunlightlabs.github.io/openstates-api/bills.html).
+
+### OpenStates::Committee
+
+You can search for committees using the `where` class method on
+OpenStates::Committee.
+
+```rb
+committees = OpenStates::Committee.where(state: 'ny')
+```
+
+You can also search for a specific committee by it's id.
+
+```rb
+committee = OpenStates::Committee.find("NYC000099")
+```
+
+You can find a list of all query parameters for Committees
+[here](http://sunlightlabs.github.io/openstates-api/committees.html)
+
+### OpenStates::District
+
+You can search for districts using the `where` class method on
+OpenStates::District.
+
+```rb
+districts = OpenStates::District.where(state: 'nj')
+```
+
+You can also search for a specific district by it's boundary_id.
+
+```rb
+district = OpenStates::District.find('12345')
+```
+
+You can find a list of all query parameters for Districts
+[here](http://sunlightlabs.github.io/openstates-api/districts.html)
+
+### OpenStates::Event
+
+You can search for events using the `where` class method on
+OpenStates::Event.
+
+```rb
+events = OpenStates::Event.where(state: 'ok')
+```
+
+You can also search for a specific event by it's event_id.
+
+```rb
+event = OpenStates::Event.find('1234567')
+```
+
+You can find a list of all query parameters for Events
+[here](http://sunlightlabs.github.io/openstates-api/events.html)
+
+### OpenStates::Legislator
+
+You can search for legislators using the `where` class method on
+OpenStates::Legislator.
+
+```rb
+legislators = OpenStates::Legislator.where(state: 'ga')
+```
+
+You can also search for a specific legislator by their leg_id.
+
+```rb
+legislator = OpenStates::Legislator.find('12345')
+```
+
+And lastly, you can search for legislators by geolocation details.
+
+```rb
+legislators = OpenStates::Legislator.by_location(45.13, -85.10)
+```
+
+You can find a list of all query parameters for Legislators
+[here](http://sunlightlabs.github.io/openstates-api/legislators.html)
 
 ## Contributing
 

data/lib/openstates/connection.rb

@@ -1,6 +1,6 @@
 module OpenStates
   module Connection
-    BASE_URL = 'http://openstates.org/api/v1/'
+    BASE_URL = 'https://openstates.org/api/v1/'
     def connection
       @connection ||= begin
         conn = Faraday.new(BASE_URL) do |b|

data/lib/openstates/models/district.rb

@@ -9,6 +9,7 @@ module OpenStates
                        :chamber,
                        :id,
                        :lat_delta,
+                       :legislators,
                        :lon_delta,
                        :name,
                        :num_seats,

data/lib/openstates/version.rb

@@ -1,3 +1,3 @@
 module OpenStates
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/openstates.gemspec

@@ -23,9 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-remote"
-  spec.add_development_dependency "pry-debugger"
+  spec.add_development_dependency "pry-byebug"
 end

metadata

@@ -1,174 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: openstates
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Chris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-01 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-remote
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-debugger
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby gem to interact with the OpenStates API.
@@ -178,8 +129,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -210,33 +162,26 @@ files:
 homepage: https://github.com/WideEyeLabs
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4304350490256027937
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4304350490256027937
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby gem to interact with the OpenStates API.
 test_files:
 - spec/openstates/api_spec.rb