vcs_client 0.4.6

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## BUNDLER
+.bundle/
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use default@vcs_client > /dev/null

data/Gemfile

@@ -0,0 +1,14 @@
+source 'http://rubygems.org'
+
+gem 'httparty', '0.6.0'
+
+group :test do
+  gem 'jeweler'
+  gem 'rspec', '1.3.0'
+  gem 'activesupport'
+  gem 'shoulda', '2.11.1'
+  gem 'bourne', '1.0'
+  gem 'ruby-debug'
+  gem 'webmock'
+  gem 'cucumber'
+end

data/Gemfile.lock

@@ -0,0 +1,61 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (2.3.8)
+    addressable (2.1.2)
+    bourne (1.0)
+      mocha (= 0.9.8)
+    builder (2.1.2)
+    columnize (0.3.1)
+    crack (0.1.7)
+    cucumber (0.8.3)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.0.2)
+      json_pure (~> 1.4.3)
+      term-ansicolor (~> 1.0.4)
+    diff-lcs (1.1.2)
+    gemcutter (0.5.0)
+      json_pure
+    gherkin (2.0.2)
+      trollop (~> 1.16.2)
+    git (1.2.5)
+    httparty (0.6.0)
+      crack (= 0.1.7)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.3)
+    linecache (0.43)
+    mocha (0.9.8)
+      rake
+    rake (0.8.7)
+    rspec (1.3.0)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    shoulda (2.11.1)
+    term-ansicolor (1.0.5)
+    trollop (1.16.2)
+    webmock (1.3.0)
+      addressable (>= 2.1.1)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bourne (= 1.0)
+  cucumber
+  httparty (= 0.6.0)
+  jeweler
+  rspec (= 1.3.0)
+  ruby-debug
+  shoulda (= 2.11.1)
+  webmock

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 gill
+
+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.rdoc

@@ -0,0 +1,17 @@
+= vcs_client
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 gill. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,143 @@
+APP_NAME = 'vcs_client'
+
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "vcs_client"
+    gem.summary = %Q{This gem wraps the Voter Checkout Service API}
+    gem.description = %Q{This gem provides all the plumbing to interact with the Voter Checkout Service}
+    gem.email = "gilltots@gmail.com"
+    gem.homepage = "http://github.com/gilltots/vcs_client"
+    gem.authors = ["gill"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_dependency "httparty", ">= 0.5.2"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+task :default => :spec
+
+task :test => :check_dependencies
+
+require 'spec/rake/spectask'
+
+desc "Run all examples"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  #  t.spec_opts = ['--debugger']
+end
+
+desc "Cruise Control task"
+task :cruise do
+  gem 'activesupport', '2.3.8'
+  require 'metric_fu'
+  MetricFu::Configuration.run do |config|
+    # Define which metrics you want to use
+    config.metrics  = [:rcov]
+    config.graphs   = [:rcov]
+    config.rcov  = { 
+      :environment => 'test',
+      :test_files => ['spec/**/*_spec.rb'],
+      :rcov_opts  => ["-Ilib:spec --aggregate rcov_data/rcov.data --sort coverage --no-html --profile --no-color --text-coverage --exclude /gems/,/Library/,/rubygems/,spec,/usr/,script,features/ "]}
+  end
+  
+  path = File.expand_path(File.join(File.dirname(__FILE__)))
+  `mkdir -p #{path}/rcov_data/`
+  `rm #{path}/rcov_data/rcov.data` rescue nil
+  `rm #{path}/rerun.txt` rescue nil
+  # Even though metrics:all runs the specs under rcov, it doesn't report any failures, which is NOT what we want!
+  CruiseControl::invoke_rake_task 'spec'
+  CruiseControl::invoke_rake_task 'features'
+  CruiseControl::invoke_rake_task 'metrics:all'
+  # CruiseControl::invoke_rake_task 'verify_rcov'
+end
+
+task :local_metrics do
+  require 'metric_fu'
+  MetricFu::Configuration.run do |config|
+    # Define which metrics you want to use  
+    config.metrics  = [:rcov]
+    config.graphs   = [:rcov]
+    config.rcov  = { 
+      :test_files => ['spec/**/*_spec.rb'],
+      :rcov_opts => [  
+                      "--sort coverage", 
+                      "--no-html", 
+                      "--text-coverage",
+                      "--no-color",
+                      "--profile",
+                      "--exclude /gems/,Library/,spec/"
+                      ]
+    }
+  end
+
+  Rake::Task['metrics:all'].invoke
+end
+
+
+def get_coverage(file_location)
+  total_coverage = 0
+  File.open(file_location).each_line do |line|
+    if line =~ /Total Coverage: (\d+\.\d+)%\s/
+      total_coverage = $1.to_f
+      break
+    end
+  end
+  return total_coverage
+end
+
+task :verify_rcov do
+  project_root = "/home/deploy/.cruise/projects/#{APP_NAME}"
+  html_location = "output/rcov.html"
+  out = ENV['CC_BUILD_ARTIFACTS']
+
+  # Grab the last rcov level from a successful build (unsuccessful may not have created the file)
+  last_build = Dir.new(project_root).entries.select{|f| f =~ /success/}.sort{|a, b| File.mtime(File.join(project_root, a)) <=> File.mtime(File.join(project_root, b))}.last
+
+  threshold = last_build.nil? ? 0 : get_coverage(File.join(project_root, last_build, html_location))
+  total_coverage = get_coverage(File.join(out, html_location))
+
+  puts "Coverage: #{total_coverage}% (threshold: #{threshold}% from #{last_build})"
+  raise "Coverage must be at least #{threshold}% (from #{last_build}) but was #{total_coverage}%" if total_coverage < threshold
+
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "vcs_client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rcov/rcovtask'
+  Spec::Rake::SpecTask.new('rcov') do |t|
+    t.spec_files = FileList['spec/**/*.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec,/gems/']
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.6

data/features/step_definitions/vcs_client_steps.rb

@@ -0,0 +1,36 @@
+Given /^the vcs uri is set to "([^"]*)"$/ do |uri|
+  @uri              = uri
+  VcsClient.vcs_uri = @uri
+end
+
+When /^I ask for a random voter from the "([^"]*)" campaign$/ do |campaign_id|
+  @client_id    = rand(500)
+  @volunteer_id = rand(500)
+  @campaign_id  = campaign_id
+  @voters       = VcsClient.checkout(@campaign_id, @client_id, @volunteer_id)
+end
+
+Then /^I should get a valid collection of people$/ do
+  @voters.should be_kind_of(Array)
+  @voters.each do |person|
+    person.should be_kind_of(VcsClient::Person)
+  end
+end
+
+When /^I ask for a random voter from the "([^"]*)" campaign at "([^"]*)" and "([^"]*)" withing "([^"]*)" miles$/ do |campaign_id, latitude, longitude, radius|
+  @client_id    = rand(500)
+  @volunteer_id = rand(500)
+  @campaign_id  = campaign_id
+  @voters       = VcsClient.checkout(@campaign_id, @client_id, @volunteer_id, latitude, longitude, radius)
+end
+
+When /^I check the voters in$/ do
+  @voters.each do |person|
+    person.checkin(:disposition => "1", :response => "Something Happened")
+  end
+end
+
+Then /^I should have zero checkouts$/ do
+  response = HTTParty.get("#{@uri}/campaign/#{@campaign_id}/client/#{@client_id}/volunteer/#{@volunteer_id}/checkout", :format => :json)
+  response["campaign_#{@campaign_id}"].should == 0
+end

data/features/support/env.rb

@@ -0,0 +1,6 @@
+require 'ruby-debug'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'vcs_client'
+
+require 'spec/expectations'

data/features/vcs_client.feature

@@ -0,0 +1,17 @@
+Feature: Vcs client
+
+  Background:
+    Given the vcs uri is set to "http://vcsqa.dnc.org:8080"
+
+  Scenario: Getting a random voter
+    When I ask for a random voter from the "perf" campaign
+    Then I should get a valid collection of people
+    
+  Scenario: Getting a random voter in a specific location
+    When I ask for a random voter from the "perf" campaign at "38.85" and "-77.04" withing "5" miles
+    Then I should get a valid collection of people
+    
+  Scenario: Checking in a checked out voter
+    When I ask for a random voter from the "perf" campaign
+    And I check the voters in
+    Then I should have zero checkouts

data/lib/objects/action.rb

@@ -0,0 +1,7 @@
+module VcsClient
+  
+  class Action < Basement
+    attr_accessor :name, :method, :url
+  end
+  
+end

data/lib/objects/address.rb

@@ -0,0 +1,20 @@
+module VcsClient
+  
+  class Address < Basement
+    attr_accessor :zip4, :latitude, :longitude, :zip, :city, :state, :address, :id, :type
+
+    # TODO: Once the Schema is updated for the spelling correction these aliases can be removed
+    alias :zipp4 :zip4
+    alias :zipp4= :zip4=
+    
+    def latitude=(latitude)
+      @latitude = latitude.to_f
+    end
+    
+    def longitude=(longitude)
+      @longitude = longitude.to_f
+    end
+    
+  end
+  
+end

data/lib/objects/basement.rb

@@ -0,0 +1,15 @@
+module VcsClient
+
+  class Basement
+
+    def initialize(attrs = {})
+      attrs.each do |key,value|
+        if self.respond_to?("#{key.to_s}=")
+          self.send("#{key.to_s}=", value)
+        end
+      end
+    end
+
+  end
+
+end

data/lib/objects/person.rb

@@ -0,0 +1,96 @@
+require 'date'
+
+module VcsClient
+
+  class Person < Basement
+
+    attr_accessor :precinct, :cong_dist, :first_name, :last_name, :middle_name, :sex, :date_of_birth, :univ, :party, :actions, :address, :phone, :references
+    
+    def address=(_address)
+      @address = VcsClient::Address.new(_address) if _address
+    end
+    
+    def phone=(_phone)
+      @phone = VcsClient::Phone.new(_phone) if _phone
+    end
+    
+    def token
+      if self.actions && self.actions.key?("checkin")
+        self.actions["checkin"].url.split('/').last
+      end
+    end
+    
+    def references=(references)
+      if references
+        @references = references.inject([]) do |collection, reference|
+          collection << VcsClient::Reference.new(reference)
+        end
+      end
+    end
+    
+    def age
+      if date_of_birth
+        date = Date.today
+        day_diff = date.day - date_of_birth.day
+        month_diff = date.month - date_of_birth.month - (day_diff < 0 ? 1 : 0)
+        date.year - date_of_birth.year - (month_diff < 0 ? 1 : 0)
+      end
+    end
+    
+    def name
+      if @name.nil?
+        @name = [self.first_name, self.middle_name, self.last_name].compact.join(' ')
+      end
+      @name
+    end
+    
+    def date_of_birth=(_date_of_birth)
+      @date_of_birth = case _date_of_birth
+      when /^\d{4}-\d{1,2}-\d{1,2}$/
+        Date.parse(_date_of_birth)
+      when /^\d{4}$/
+        Date.parse("#{_date_of_birth}-01-01")
+      else
+        nil
+      end
+    end
+    
+    # this dynamically creates a method on this object, named after the action name ('checkin')
+    # e.g. if the json has
+    # "actions": {
+    #               "checkin": {
+    #                   "method": "PUT",
+    #                   "url": "/campaign/1234/client/1/volunteer/4321/checkout/4bfd8e5e8a9b8e7987000014"
+    #               }
+    #           },
+    #
+    #  this adds a method called "checkin" to this object, that takes a single parameter for 'disposition' and
+    #  performs a PUT to /campaign/1234/client/1/volunteer/4321/checkout/4bfd8e5e8a9b8e7987000014
+    #
+    # it also adds an Action object to the person, so calling this_person.actions will return a hash of all actions, where the keys
+    # are the action names and the values are Action objects with url and method
+    # 
+    def actions=(actions)
+      @actions = actions.inject({}) do |collection, action|
+        name    = action[0]
+        options = action[1]
+        define_meta_action(name, options)
+        collection.merge!(name => VcsClient::Action.new({:name => name}.merge(options)))
+      end
+    end
+    
+    private
+    
+    def define_meta_action(name, options)
+      # The following defines a metaclass method on the instance
+      method = <<-METHOD
+      def self.#{name}(args = {})
+        VcsClient.send(:#{options["method"].downcase}, '#{options["url"]}', :body => args, :format => :html)
+      end
+      METHOD
+      send(:eval, method)
+    end
+
+  end
+
+end

data/lib/objects/phone.rb

@@ -0,0 +1,7 @@
+module VcsClient
+  
+  class Phone < Basement
+    attr_accessor :number, :type
+  end
+  
+end

data/lib/objects/reference.rb

@@ -0,0 +1,8 @@
+module VcsClient
+  
+  class Reference < Basement
+    attr_accessor :src, :id
+    
+  end
+  
+end

data/lib/vcs_client.rb

@@ -0,0 +1,79 @@
+require 'httparty'
+require 'objects/basement'
+require 'objects/action'
+require 'objects/address'
+require 'objects/phone'
+require 'objects/reference'
+require 'objects/person'
+
+module VcsClient
+
+  include HTTParty
+
+  format :json
+
+  def self.vcs_uri=(uri)
+    base_uri uri
+  end
+
+  def self.checkout(campaign_id, client_id, volunteer_id, lat = nil, long = nil, miles = nil)
+    query_type = 'random'
+    body       = {'queryType' => query_type}
+    if (!lat.nil? && !long.nil?)
+       query_type = 'location'
+       if miles.nil?
+         raise VcsClient::NoRadius.new("When searching by location a radius is necessary")
+       end
+       
+       body       = {'queryType' => query_type, 'latitude' => lat, 'longitude' => long, 'miles' => miles}
+    end
+    result = post("/campaign/#{campaign_id}/client/#{client_id}/volunteer/#{volunteer_id}/checkout", :body => body)
+    filter_for_errors(result)
+    result["people"].inject([]) do |collection, person|
+      collection << Person.new(person)
+    end
+  end
+  
+  def self.checkin(campaign_id, client_id, vol_id, token, disposition)
+    result = put("/campaign/#{campaign_id}/client/#{client_id}/volunteer/#{vol_id}/checkout/#{token}", :body => {'disposition' => disposition}, :format => "html")
+    filter_for_checkin_errors(result)
+    Crack::JSON.parse(result)
+  end
+
+  private
+
+  def self.filter_for_errors(hash)
+    if hash.nil? || hash["people"].blank?
+      raise VcsClient::CheckoutFailed.new(hash)
+    end
+    hash
+  end
+  
+  def self.filter_for_checkin_errors(result)
+    if result == "Could not find an available Person"
+      raise VcsClient::CheckinFailed.new(result)
+    end
+  end
+  
+  class VcsError < StandardError
+    attr_accessor  :response
+    
+    def initialize(val)
+      @response = val
+    end
+    
+    def to_s
+      "#{self.class.to_s}: #{self.response}"
+    end
+    
+    def inspect
+      self.to_s
+    end
+      
+  end
+  
+  class CheckinFailed < VcsError; end
+  class CheckoutFailed < VcsError; end
+  class NoRadius < VcsError; end
+
+end

data/spec/action_spec.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__),'spec_helper')
+
+describe VcsClient::Action do
+  
+  describe 'creating from attrs' do
+    subject do
+      VcsClient::Action.new({'name' => 'checkin', 'method' => 'PUT', 'url' => '/some/thing'})
+    end
+    
+    its(:name) { should == 'checkin' }
+    its(:method) { should == 'PUT' }
+    its(:url) { should == '/some/thing' }
+  end
+  
+end

data/spec/address_spec.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__),'spec_helper')
+
+describe VcsClient::Address do
+
+  describe 'creating from attrs' do
+    subject do
+      VcsClient::Address.new(Crack::JSON.parse(one_person_fixture)['people'].first['address'])
+    end
+    
+    its(:address)   { should == '1234 ADDRESS ST' }
+    its(:city)      { should == 'CITY' }
+    its(:zip)       { should == '00000' }
+    its(:id)        { should == 123456789 }
+    its(:type)      { should == 'r' }
+    its(:zip4)      { should == '0000' }
+    its(:state)     { should == 'TN' }
+    its(:latitude)  { should == 0.0 }
+    its(:longitude) { should == -0.0 }
+  end
+
+end

data/spec/basement_spec.rb

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__),'spec_helper')
+
+describe VcsClient::Basement do
+  
+  describe 'creating from attrs' do
+    
+    subject do
+      VcsClient::Basement.new({:lat => 123, :long => 456})
+    end
+    
+    it 'should not set anything, but also not bomb' do
+      (subject.methods - Object.methods).should be_empty
+    end
+    
+  end
+end

data/spec/fixtures/checkin_response.json

@@ -0,0 +1,7 @@
+{
+    "person": "XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX",
+    "disposition": "1",
+    "campaign": "test",
+    "checkout_id": "abcdef1234567890",
+    "response": "Checkin Successful"
+}

data/spec/fixtures/one_person.json

@@ -0,0 +1,43 @@
+{
+    "people": [
+        {
+            "cong_dist": 1,
+            "party": "I",
+            "precinct": null,
+            "univ": 2,
+            "actions": {
+                "checkin": {
+                    "method": "PUT",
+                    "url": "/campaign/abcd/client/1234/volunteer/5678/checkout/abcdefg12345678"
+                }
+            },
+            "address": {
+                "zipp4": "0000",
+                "state": "TN",
+                "zip": "00000",
+                "city": "CITY",
+                "address": "1234 ADDRESS ST",
+                "id": 123456789,
+                "type": "r",
+                "latitude": "00.000000",
+                "longitude": "-00.000000"
+            },
+            "date_of_birth": "1980-3-20",
+            "first_name": "JOHN",
+            "last_name": "DOE",
+            "middle_name": "Q",
+            "phone": {
+                "type": "L",
+                "number": "5555555555"
+            },
+            "references": [
+                {
+                    "src": "V",
+                    "id": "AA0000000"
+                }
+            ],
+            "sex": "M",
+            "id": "N-00000000-00AA-AAAA-0000-000000000000"
+        }
+    ]
+}

data/spec/fixtures/two_people.json

@@ -0,0 +1,83 @@
+{
+    "people": [
+        {
+            "cong_dist": 1,
+            "party": "I",
+            "precinct": null,
+            "univ": 2,
+            "actions": {
+                "checkin": {
+                    "method": "PUT",
+                    "url": "/campaign/abcd/client/1234/volunteer/5678/checkout/abcdefg12345678"
+                }
+            },
+            "address": {
+                "zipp4": "0000",
+                "state": "TN",
+                "zip": "00000",
+                "city": "CITY",
+                "address": "1234 ADDRESS ST",
+                "id": 123456789,
+                "type": "r",
+                "latitude": "00.000000",
+                "longitude": "00.000000"
+            },
+            "date_of_birth": "1980-3-20",
+            "first_name": "JOHN",
+            "last_name": "DOE",
+            "middle_name": "Q",
+            "phone": {
+                "type": "L",
+                "number": "5555555555"
+            },
+            "references": [
+                {
+                    "src": "V",
+                    "id": "AA0000000"
+                }
+            ],
+            "sex": "M",
+            "id": "N-00000000-00AA-AAAA-0000-000000000000"
+        },
+        {
+            "cong_dist": 1,
+            "party": "I",
+            "precinct": null,
+            "univ": 2,
+            "actions": {
+                "checkin": {
+                    "method": "PUT",
+                    "url": "/campaign/abcd/client/1234/volunteer/5678/checkout/aaaaa99999"
+                }
+            },
+            "address": {
+                "zipp4": "0000",
+                "state": "TN",
+                "zip": "00000",
+                "city": "CITY",
+                "address": "1234 ADDRESS ST",
+                "id": 123456789,
+                "type": "r",
+                "latitude": "00.000000",
+                "longitude": "00.000000"
+            },
+            "date_of_birth": "1981-2-17",
+            "first_name": "JANE",
+            "last_name": "DOE",
+            "middle_name": "P",
+            "phone": {
+                "type": "L",
+                "number": "5555555555"
+            },
+            "references": [
+                {
+                    "src": "V",
+                    "id": "BB0000000"
+                }
+            ],
+            "sex": "F",
+            "id": "N-00000000-00BB-BBBB-0000-000000000000"
+        }
+
+    ]
+}

data/spec/person_spec.rb

@@ -0,0 +1,92 @@
+require File.join(File.dirname(__FILE__),'spec_helper')
+
+describe VcsClient::Person do
+
+  describe 'creating from attrs' do
+
+    subject do
+      VcsClient::Person.new(Crack::JSON.parse(one_person_fixture)['people'].first)
+    end
+    
+    its(:precinct)      { should be_nil }
+    its(:cong_dist)     { should == 1 }
+    its(:first_name)    { should == 'JOHN' }
+    its(:last_name)     { should == 'DOE' }
+    its(:middle_name)   { should == 'Q' }
+    its(:sex)           { should == 'M' }
+    its(:univ)          { should == 2 }
+    its(:party)         { should == 'I' }
+    its(:date_of_birth) { should == Date.parse('1980-3-20') }
+    its(:address)       { should be_instance_of(VcsClient::Address) }
+    its(:phone)         { should be_instance_of(VcsClient::Phone) }
+    its(:token)         { should == 'abcdefg12345678' }
+    
+    it 'should return a nil token if no checkin action exists' do
+      VcsClient::Person.new.token.should be_nil
+    end
+
+    it 'should have an age accessor that uses the date_of_birth' do
+      Date.stubs(:today).returns(Date.parse('2010-3-20'))
+      subject.age.should == 30
+    end
+    
+    it 'should have an array of 1 reference' do
+      subject.references.class.should == Array
+      subject.references.length.should == 1
+      subject.references.first.should be_instance_of(VcsClient::Reference)
+    end
+    
+    it 'should have keyed hash for actions' do
+      subject.actions.class.should == Hash
+      subject.actions['checkin'].class.should == VcsClient::Action
+    end
+
+    it 'should create a dynamic method called "checkin" that does a PUT' do
+      VcsClient.stubs(:put)
+      subject.checkin('')
+      VcsClient.should have_received(:put)
+    end
+    
+  end
+  
+  context 'nil responses' do
+    describe 'phone' do
+      subject { VcsClient::Person.new(:phone => nil, :address => nil, :date_of_birth => nil) }
+      its(:phone)         { should be_nil }
+      its(:address)       { should be_nil }
+      its(:date_of_birth) { should be_nil }
+      its(:age)           { should be_nil }
+    end
+  end
+  
+  context 'nil references' do
+    it 'should not raise an error' do
+      expect {
+        VcsClient::Person.new(:references => nil)
+      }.to_not raise_error
+    end
+  end
+  
+  context 'only getting a year back for the date_of_birth' do
+    subject { VcsClient::Person.new(:date_of_birth => "1980") }
+    its(:date_of_birth) { should == Date.parse("1980-01-01") }
+  end
+  
+  describe 'proper spacing for #name' do
+    it 'should properly display the full name when all 3 are given' do
+      person = VcsClient::Person.new(:first_name => "First", :middle_name => "Middle", :last_name => "Last")
+      person.name.should == "First Middle Last"
+    end
+
+    it 'should properly display the full name when only first and last are given' do
+      person = VcsClient::Person.new(:first_name => "First", :last_name => "Last")
+      person.name.should == "First Last"
+    end
+
+    it 'should properly display the full name when only first is given' do
+      person = VcsClient::Person.new(:first_name => "First")
+      person.name.should == "First"
+    end
+  end
+
+end

data/spec/phone_spec.rb

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__),'spec_helper')
+
+describe VcsClient::Phone do
+
+  describe 'creating from attrs' do
+
+    subject do
+      VcsClient::Phone.new(Crack::JSON.parse(one_person_fixture)['people'].first['phone'])
+    end
+    
+    its(:number) { should == '5555555555' }
+    its(:type) { should == 'L' }
+
+  end
+
+end

data/spec/reference_spec.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__),'spec_helper')
+
+describe VcsClient::Reference do
+
+  describe 'creating from attrs' do
+    subject do
+      VcsClient::Reference.new({:src => 'source', :id => 456})
+    end
+    
+    its(:src) { should == 'source' }
+    its(:id) { should == 456 }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+
+require 'bundler'
+Bundler.setup
+
+require 'spec'
+require 'shoulda'
+require 'bourne'
+require 'spec/autorun'
+require 'ruby-debug'
+require 'webmock/rspec'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+require 'vcs_client'
+
+Spec::Runner.configure do |config|
+  config.mock_with Mocha::API
+  config.include WebMock
+  config.include Fixtures
+end

data/spec/support/fixtures.rb

@@ -0,0 +1,19 @@
+module Fixtures
+  def self.included(base)
+    Dir[File.expand_path(File.join(File.dirname(__FILE__),'../fixtures','**','*.*'))].each do |file|
+      file_name = file.split('/').last
+      method_name = file_name.split('.').first
+      method = <<-METHOD
+      def #{method_name}_fixture
+        unless @#{method_name}_fixture
+          fixture_file            = File.new('#{file}', 'r')
+          @#{method_name}_fixture = fixture_file.read
+          fixture_file.close
+        end
+        @#{method_name}_fixture
+      end
+      METHOD
+      eval(method)
+    end
+  end
+end

data/spec/support/mocha.rb

@@ -0,0 +1,13 @@
+module Mocha
+  module API
+    def setup_mocks_for_rspec
+      mocha_setup
+    end
+    def verify_mocks_for_rspec
+      mocha_verify
+    end
+    def teardown_mocks_for_rspec
+      mocha_teardown
+    end 
+  end
+end

data/spec/vcs_client_spec.rb

@@ -0,0 +1,83 @@
+require File.join(File.dirname(__FILE__),'spec_helper')
+
+describe VcsClient do
+  
+  describe 'setting the base_uri' do
+    before do
+      VcsClient.stubs(:base_uri)
+    end
+    
+    it "should set HTTParty's base_uri" do
+      VcsClient.vcs_uri = 'http://test.uri.com:8080'
+      VcsClient.should have_received(:base_uri).with('http://test.uri.com:8080')
+    end
+  end
+  
+  context 'with a fake VCS URI set' do
+    before do
+      VcsClient.vcs_uri = 'http://test.uri.com:8080'
+    end
+    
+    describe 'checking out, stubbed' do
+      describe 'succesfully' do
+        it 'should work' do
+          stub_request(:post, /.+/).to_return(:body => two_people_fixture)
+          people = VcsClient.checkout('perf', rand(500), rand(500))
+          people.class.should == Array
+          people.length.should == 2
+          people.each do |person|
+            person.respond_to?(:checkin).should == true
+          end
+        end
+      end
+    
+      describe 'successfully with lat/long info' do
+        it 'should also work' do
+          stub_request(:post, /.+/).to_return(:body => two_people_fixture)
+          people = VcsClient.checkout('perf', rand(500), rand(500), 38.883966, -77.008603, 5)
+          people.class.should == Array
+          people.length.should == 2
+          people.each do |person|
+            person.respond_to?(:checkin).should == true
+          end
+        end
+      end
+      
+      describe 'if only lat and lon are given' do
+        it 'should raise an Exception for missing radius' do
+          expect {
+            VcsClient.checkout('perf', rand(500), rand(500), 0.0, -77.0)
+          }.to raise_error(VcsClient::NoRadius) { |exception| exception.inspect.should == 'VcsClient::NoRadius: When searching by location a radius is necessary' }
+        end
+      end
+ 
+      describe 'unsuccessfully' do
+        it 'should bomb' do
+          stub_request(:post, /.+/).to_return(:body => '{}')
+          expect {
+            VcsClient.checkout('perf',2,3)
+          }.to raise_error(VcsClient::CheckoutFailed){|ex| ex.inspect.should == 'VcsClient::CheckoutFailed: '}
+        end
+      end
+    end
+   
+    describe 'checking in, stubbed' do
+      describe 'succesfully' do
+        it 'should work' do
+          stub_request(:put, /.+/).to_return(:body => checkin_response_fixture)
+          VcsClient.checkin(1,2,3,4,5)['response'].should == 'Checkin Successful'
+        end
+      end
+ 
+      describe 'unsuccessfully' do
+        it 'should bomb' do
+          stub_request(:put, /.+/).to_return(:body => 'Could not find an available Person')
+          expect {
+            VcsClient.checkin(1,2,3,4,5)
+          }.to raise_error(VcsClient::CheckinFailed){|ex| ex.inspect.should == 'VcsClient::CheckinFailed: Could not find an available Person' }
+        end
+      end
+    end
+  end
+  
+end

data/vcs_client.gemspec

@@ -0,0 +1,87 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{vcs_client}
+  s.version = "0.4.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["gill"]
+  s.date = %q{2010-07-13}
+  s.description = %q{This gem provides all the plumbing to interact with the Voter Checkout Service}
+  s.email = %q{gilltots@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     ".rvmrc",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "features/step_definitions/vcs_client_steps.rb",
+     "features/support/env.rb",
+     "features/vcs_client.feature",
+     "lib/objects/action.rb",
+     "lib/objects/address.rb",
+     "lib/objects/basement.rb",
+     "lib/objects/person.rb",
+     "lib/objects/phone.rb",
+     "lib/objects/reference.rb",
+     "lib/vcs_client.rb",
+     "spec/action_spec.rb",
+     "spec/address_spec.rb",
+     "spec/basement_spec.rb",
+     "spec/fixtures/checkin_response.json",
+     "spec/fixtures/one_person.json",
+     "spec/fixtures/two_people.json",
+     "spec/person_spec.rb",
+     "spec/phone_spec.rb",
+     "spec/reference_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/support/fixtures.rb",
+     "spec/support/mocha.rb",
+     "spec/vcs_client_spec.rb",
+     "vcs_client.gemspec"
+  ]
+  s.homepage = %q{http://github.com/gilltots/vcs_client}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{This gem wraps the Voter Checkout Service API}
+  s.test_files = [
+    "spec/action_spec.rb",
+     "spec/address_spec.rb",
+     "spec/basement_spec.rb",
+     "spec/person_spec.rb",
+     "spec/phone_spec.rb",
+     "spec/reference_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/support/fixtures.rb",
+     "spec/support/mocha.rb",
+     "spec/vcs_client_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.5.2"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0.5.2"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0.5.2"])
+  end
+end
+

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: vcs_client
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 6
+  version: 0.4.6
+platform: ruby
+authors: 
+- gill
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-13 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :runtime
+  version_requirements: *id002
+description: This gem provides all the plumbing to interact with the Voter Checkout Service
+email: gilltots@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- features/step_definitions/vcs_client_steps.rb
+- features/support/env.rb
+- features/vcs_client.feature
+- lib/objects/action.rb
+- lib/objects/address.rb
+- lib/objects/basement.rb
+- lib/objects/person.rb
+- lib/objects/phone.rb
+- lib/objects/reference.rb
+- lib/vcs_client.rb
+- spec/action_spec.rb
+- spec/address_spec.rb
+- spec/basement_spec.rb
+- spec/fixtures/checkin_response.json
+- spec/fixtures/one_person.json
+- spec/fixtures/two_people.json
+- spec/person_spec.rb
+- spec/phone_spec.rb
+- spec/reference_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures.rb
+- spec/support/mocha.rb
+- spec/vcs_client_spec.rb
+- vcs_client.gemspec
+has_rdoc: true
+homepage: http://github.com/gilltots/vcs_client
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: This gem wraps the Voter Checkout Service API
+test_files: 
+- spec/action_spec.rb
+- spec/address_spec.rb
+- spec/basement_spec.rb
+- spec/person_spec.rb
+- spec/phone_spec.rb
+- spec/reference_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures.rb
+- spec/support/mocha.rb
+- spec/vcs_client_spec.rb