govkit 0.0.0.pre → 0.0.1

data/VERSION

@@ -1 +1 @@
-0.0.0.pre
+0.0.1

data/generators/{govkit_generator.rb → govkit/govkit_generator.rb}

@@ -10,7 +10,7 @@ class GovkitGenerator < Rails::Generator::Base
       m.template 'govkit.rb',   File.join('config', 'initializers', 'govkit.rb')
     end
   end
-    
+
   protected
   
   def banner

data/generators/govkit/templates/govkit.rb

@@ -0,0 +1,9 @@
+if defined? Govkit
+  
+  Govkit.configure do |config|
+    # Get an API key for Sunlight's Fifty States project here:
+    # http://services.sunlightlabs.com/accounts/register/
+    config.fiftystates_apikey = 'YOUR_FIFTYSTATES_API_KEY'
+  end
+
+end

data/govkit.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{govkit}
-  s.version = "0.0.0.pre"
+  s.version = "0.0.1"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  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-04-28}
+  s.date = %q{2010-05-10}
   s.description = %q{Govkit lets you quickly get encapsulated Ruby objects for common open government APIs. We're starting with Sunlight's Fifty States API and the Project Vote Smart API.}
   s.email = %q{carl@ppolitics.org}
   s.extra_rdoc_files = [
@@ -24,18 +24,26 @@ Gem::Specification.new do |s|
      "Rakefile",
      "USAGE",
      "VERSION",
-     "generators/govkit_generator.rb",
-     "generators/templates/govkit.rb",
+     "generators/govkit/govkit_generator.rb",
+     "generators/govkit/templates/govkit.rb",
      "govkit.gemspec",
      "lib/govkit.rb",
+     "lib/govkit/configuration.rb",
      "lib/govkit/fifty_states.rb",
-     "rails/init.rb"
+     "rails/init.rb",
+     "spec/fifty_states_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/opengovernment/govkit}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{Simple access to open government APIs around the web}
+  s.test_files = [
+    "spec/fifty_states_spec.rb",
+     "spec/spec_helper.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/govkit/configuration.rb

@@ -0,0 +1,25 @@
+module Govkit
+  class Configuration
+    attr_accessor :fiftystates_apikey, :fiftystates_base_url
+
+    def initialize
+      @fiftystates_apikey = ''
+      @fiftystates_base_url = 'fiftystates-dev.sunlightlabs.com/api'
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Configure Govkit in config/initializers/govkit.rb
+  #
+  # @example
+  #   Govkit.configure do |config|
+  #     config.fiftystates_apikey = ''
+  #   end
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/govkit/fifty_states.rb

@@ -35,8 +35,8 @@ module Govkit::FiftyStates
   class Base
     include HTTParty
     format :json
-    default_params :output => 'json'
-    base_uri 'fiftystates-dev.sunlightlabs.com/api'
+    default_params :output => 'json', :apikey => Govkit::configuration.fiftystates_apikey
+    base_uri Govkit::configuration.fiftystates_base_url
 
     attr_accessor :attributes
 
@@ -53,6 +53,10 @@ module Govkit::FiftyStates
       def instantiate_collection(collection)
         collection.collect! { |record| instantiate_record(record) }
       end
+      
+      def parse(json)
+        instantiate_record(json)
+      end
     end
 
     def unload(attributes)
@@ -167,7 +171,14 @@ module Govkit::FiftyStates
 
   class Action < Base; end
 
-  class Vote < Base; end
+  class Vote < Base
+    def self.find(vote_id)
+      response = get("/votes/#{vote_id}")
+      instantiate_record(response)
+    end
+  end
+
+  class Roll < Base; end
 
   class Sponsor < Base; end
 

data/lib/govkit.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
 
 require 'active_support'
+require 'govkit/configuration'
 
 module Govkit
   autoload :FiftyStates, 'govkit/fifty_states'

data/spec/fifty_states_spec.rb

@@ -0,0 +1,90 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+#TODO: Mock http requests, rather than making an actual call to the api
+
+module Govkit::FiftyStates
+  describe Govkit::FiftyStates do
+    it "should have the base uri set properly" do
+      [State, Bill, Legislator].each do |klass|
+        klass.base_uri.should == "http://fiftystates-dev.sunlightlabs.com/api"
+      end
+    end
+  end
+
+  describe State do
+    context "#find_by_abbreviation" do
+      before do
+        #TODO: Mock request for State
+      end
+      it "should find a state by abbreviation" do
+        lambda do
+          @state = State.find_by_abbreviation('ca')
+        end.should_not raise_error
+
+        @state.should_not be_nil
+        @state.name.should == "California"
+      end
+    end
+  end
+
+  describe Bill do
+    context "#find" do
+      before do
+        #TODO: Mock request for Bill
+      end
+
+      it "should find a bill by stat abbreviation, session, chamber, bill_id" do
+        lambda do
+          @bill = Bill.find('ca', 20092010, 'lower', 'AB667')
+        end.should_not raise_error
+
+        @bill.should_not be_nil
+        @bill.title.should include("An act to amend Section 1750.1 of the Business and Professions Code, and to amend Section 104830 of")
+      end
+    end
+
+    context "#search" do
+      it "should find bills by given criteria" do
+        @bills = Bill.search('agriculture')
+
+        @bills.should_not be_nil
+        @bills.collect(&:bill_id).should include("S 0438")
+      end
+    end
+
+    context "#latest" do
+      it "should get the latest bills by given criteria" do
+        lambda do
+          @latest = Bill.latest('2010-01-01','sd')
+        end.should_not raise_error
+
+        @latest.collect(&:bill_id).should include("SB 7")
+      end
+    end
+  end
+
+  describe Legislator do
+    before do
+      #TODO: Mock request for legislator
+    end
+    context "#find" do
+      it "should get the latest bill" do
+        lambda do
+          @legislator = Legislator.find(2462)
+        end.should_not raise_error
+
+        @legislator.first_name.should == "Dave"
+        @legislator.last_name.should == "Cox"
+      end
+    end
+    context "#search" do
+      it "should get legislators by given criteria" do
+        lambda do
+          @legislators = Legislator.search(:state => 'ca')
+        end.should_not raise_error
+
+        @legislators.should_not be_nil
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format nested
+--loadby
+mtime
+--reverse
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'spec'
+require File.dirname(__FILE__) + '/../lib/govkit'
+
+# prevent the use of `` in tests
+Spec::Runner.configure do |configuration|
+end
+
+# When running specs in TextMate, provide an rputs method to cleanly print objects into HTML display
+# From http://talklikeaduck.denhaven2.com/2009/09/23/rspec-textmate-pro-tip
+module Kernel
+  if ENV.keys.find {|env_var| env_var.index("TM_")}
+    def rputs(*args)
+      require 'cgi'
+      puts( *["<pre>", args.collect {|a| CGI.escapeHTML(a.to_s)}, "</pre>"])
+    end
+    def rp(*args)
+      require 'cgi'
+      puts( *["<pre>", args.collect {|a| CGI.escapeHTML(a.inspect)}, "</pre>"])
+    end
+  else
+    alias_method :rputs, :puts
+    alias_method :rp, :p
+  end
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: govkit
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 0
   - 0
-  - 0
-  - pre
-  version: 0.0.0.pre
+  - 1
+  version: 0.0.1
 platform: ruby
 authors: 
 - Participatory Politics Foundation
@@ -17,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-28 00:00:00 -07:00
+date: 2010-05-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,12 +64,16 @@ files:
 - Rakefile
 - USAGE
 - VERSION
-- generators/govkit_generator.rb
-- generators/templates/govkit.rb
+- generators/govkit/govkit_generator.rb
+- generators/govkit/templates/govkit.rb
 - govkit.gemspec
 - lib/govkit.rb
+- lib/govkit/configuration.rb
 - lib/govkit/fifty_states.rb
 - rails/init.rb
+- spec/fifty_states_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/opengovernment/govkit
 licenses: []
@@ -89,13 +92,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
@@ -103,5 +104,6 @@ rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Simple access to open government APIs around the web
-test_files: []
-
+test_files: 
+- spec/fifty_states_spec.rb
+- spec/spec_helper.rb

data/generators/templates/govkit.rb

@@ -1,12 +0,0 @@
-if defined? Govkit
-
-  # Get an API key for Sunlight's Fifty States project here:
-  # http://services.sunlightlabs.com/accounts/register/
-  Govkit::FiftyStates::apikey = 'YOUR_FIFTYSTATES_API_KEY'
-  
-  # Get a key for the VoteSmart API here:
-  # http://votesmart.org/services_api.php
-  Govkit::Votesmart::apikey = 'YOUR_VOTESMART_API_KEY'
-
-
-end