govkit 0.3.1 → 0.3.2

data/README.markdown

@@ -17,14 +17,31 @@ From gemcutter:
 
 Add govkit to your environment.rb or Gemfile
 
-Run <code>rails generate govkit</code> to copy a config file into <code>config/initializers/govkit.rb</code>. You will need to add your API keys to this config file.
+Run <code>rails generate govkit</code> (Rails 3.x) or <code>script/generate govkit</code> (Rails 2.x) to copy a config file into <code>config/initializers/govkit.rb</code>. You will need to add your API keys to this config file.
 
-# Examples
+# Usage Examples
 
     >> GovKit::OpenStates::State.find_by_abbreviation('CA')
     >> GovKit::VoteSmart::Address.find(votesmart_candidate_id)
     >> GovKit::OpenCongress::Bill.find(:number => 5479, :type => 'h', :congress => '111')
 
+Objects returned from GovKit will have attributes for each field coming back from the API:
+
+    >> x = GovKit::OpenStates::State.find_by_abbreviation('CA')
+    => #<GovKit::OpenStates::State:0x00000100f6a5a8 @attributes={"lower_chamber_title"=>"Assemblymember", "lower_chamber_name"=>"Assembly", "upper_chamber_title"=>"Senator", "terms"=>[#<GovKit::OpenStates::State::Term:0x00000100f2a8e0 @attributes={"....
+    >> x.name
+    => "California"
+
+GovKit will raise GovKit::ResourceNotFound if a requested item isn't available.
+
+# Testing & Debugging
+
+For debugging purposes, there's a raw_response reader provided for each object, which typically returns an HTTParty::Response object. To see the body of the HTTP response, you might look here:
+
+    (continuing the example from above)
+    >> x.raw_response.response.body
+    => "{\n    \"lower_chamber_title\": \"Assemblymember\", \n    \"lower_chamber_name\": \"Assembly\", \n  ....
+
 # Bugs? Questions?
 
 Please join the [Govkit Google Group](http://groups.google.com/group/govkit), especially if you'd like to talk about a new feature and get announcements.

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/generators/govkit/govkit_generator.rb

@@ -1,4 +1,4 @@
-class GovKitGenerator < Rails::Generator::Base
+class GovkitGenerator < Rails::Generator::Base
 
   def initialize(*runtime_args)
     super

data/govkit.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{govkit}
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Participatory Politics Foundation", "Srinivas Aki", "Carl Tashian"]
-  s.date = %q{2010-09-11}
+  s.date = %q{2010-09-16}
   s.description = %q{Govkit lets you quickly get encapsulated Ruby objects for common open government APIs. We're starting with Sunlight's Open States API and the Project Vote Smart API.}
   s.email = %q{carl@ppolitics.org}
   s.extra_rdoc_files = [

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Participatory Politics Foundation
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-11 00:00:00 -07:00
+date: 2010-09-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency