vworkapp_ruby 0.0.1 → 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.bundle
+.gem

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    vworkapp_ruby (0.0.1)
+      gcoder
+      httparty
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    gcoder (0.12.1)
+      hashie
+      ruby-hmac
+      yajl-ruby
+    hashie (1.2.0)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
+    multi_json (1.0.4)
+    multi_xml (0.4.1)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    ruby-hmac (0.4.0)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  vworkapp_ruby!

data/README.md

@@ -11,5 +11,8 @@ This is a wrapper around vWorkApp's API. Go on! Use it!
 
 - Broken API bits:
     * What's find(:search) for??. 
-    * customer_name broken? 
-    * Why can't I filter by template? 
+    * Why can't I filter by template?
+    
+- Missing job.actual_duration, job.actual_start_at
+
+- Should have connivence method to lookup a customer from a job

data/examples/create_job.rb

@@ -31,4 +31,4 @@ job = VWorkApp::Job.new(
     VWorkApp::CustomField.new("Note", "Hi There!"),
   ]
 )
-p job.create
+puts "Created Job, id is: #{job.create.id}"

data/examples/print_jobs.rb

@@ -21,14 +21,11 @@ EOL
 workers = VWorkApp::Worker.all
 
 workers.each do |worker|
-  puts "Worker: #{worker.name}"
+  puts "Worker: #{worker.id}-#{worker.name}"
   jobs = VWorkApp::Job.find(:worker_id => worker.id, :state => "not_started")
   jobs.each do |job|
     puts "\t #{job.third_party_id || job.id}, #{job.customer_name}, #{job.template_name}"
+    # p job
   end
   puts ""
 end
-
-# p jobs = VWorkApp::Job.find(:worker_id => 4228)["cars"]
-
-# p job = VWorkApp::Job.show(180022)

data/lib/vworkapp_ruby.rb

@@ -1,4 +1,5 @@
 require 'vworkapp_ruby/base'
+require 'vworkapp_ruby/location'
 require 'vworkapp_ruby/job'
 require 'vworkapp_ruby/worker'
 require 'vworkapp_ruby/customer'
@@ -6,3 +7,5 @@ require 'vworkapp_ruby/response_error'
 # require 'vworkapp/proof_of_delivery'
 
 require 'vworkapp_ruby/httparty_monkey_patch'
+
+VW = VWorkApp

data/lib/vworkapp_ruby/base.rb

@@ -1,4 +1,5 @@
 require 'httparty'
+require 'active_support/core_ext/hash'
 
 module VWorkApp
   
@@ -8,33 +9,64 @@ module VWorkApp
     def api_key=(key)
       @api_key = key
     end
+    
     def api_key
       @api_key
     end
+    
   end
       
-  class Base
+  module AttributeEquality
+    def attributes_eql?(other, attributes)
+      attributes.each do |attribute|
+        return false unless self.send(attribute.to_sym) == other.send(attribute.to_sym)
+      end
+      true
+    end
+  end
 
+  class Base
     include HTTParty
+    include AttributeEquality
 
     base_uri 'api.vworkapp.com/api/2.0'
     # http_proxy 'localhost', 8888
-    # format :xml
 
     headers({
+      "Content-Type" => "text/xml",
       "User-Agent" => "Ruby.vWorkApp.API"
     })
 
-    # Examines a bad response and raises an approriate exception
-    #
-    # @param [HTTParty::Response] response
-    def self.bad_response(response)
-      if response.class == HTTParty::Response
-        raise ResponseError, response
+    def self.perform(action, url, query = {}, body = nil)
+      options = {}
+      options[:query] = { :api_key => VWorkApp.api_key }.merge(query)
+
+      if body 
+        root = body.keys.first
+        body_str = body[root].to_xml(:root => root)
+        options[:body] = body_str 
+      end
+      
+      raw = self.send(action, url, options)
+            
+      case raw.response
+      when Net::HTTPOK, Net::HTTPCreated
+        yield(raw) if block_given?
+      when Net::HTTPNotFound
+         nil
+      else
+        bad_response(raw.response)
       end
-      raise StandardError, "Unkown error"
+    end
+    
+    def perform(action, url, query = {}, body = nil, &block)
+      self.class.perform(action, url, query, body, &block)
     end
 
+    def self.bad_response(response)
+      raise "#{response.code} - #{response.msg}: #{response.body}"
+    end
+    
   end
 
 end

data/lib/vworkapp_ruby/customer.rb

@@ -0,0 +1,106 @@
+module VWorkApp
+
+  class Customer < Base  
+    attr_accessor :id, :third_party_id, :name, :site_contact, :billing_contact
+  
+    #---------------
+    # Object Methods
+    #---------------
+
+    def initialize(name, id = nil, third_party_id = nil, site_contact = nil, billing_contact = nil)
+      @name = name
+      @id = id
+      @third_party_id = third_party_id
+      @site_contact = site_contact
+      @billing_contact = billing_contact
+    end
+    
+    def self.from_hash(attributes)
+      customer = Customer.new(attributes["name"], attributes["id"], attributes["third_party_id"])
+      customer.site_contact = Contact.from_hash(attributes["delivery_contact"])
+      customer.billing_contact = Contact.from_hash(attributes["billing_contact"])
+      customer
+    end
+
+    def to_hash
+      cust_hash = { :customer => { :name  => self.name } }
+      cust_hash[:customer][:third_party_id] = self.third_party_id if third_party_id
+      cust_hash[:customer][:delivery_contact] = self.site_contact.to_hash if site_contact
+      cust_hash[:customer][:billing_contact] = self.billing_contact.to_hash if billing_contact
+      cust_hash
+    end
+
+    def ==(other)
+      attributes_eql?(other, [:id, :name, :third_party_id, :site_contact, :billing_contact])
+    end
+    
+    #---------------
+    # REST Methods
+    #---------------
+
+    def create
+      perform(:post, "/customers.xml", {}, self.to_hash) do |res|
+        Customer.from_hash(res["customer"])
+      end
+    end
+
+    def update(use_third_party_id = false)
+      perform(:put, "/customers/#{id}.xml", { :use_third_party_id => use_third_party_id }, self.to_hash)
+    end
+
+    def delete(use_third_party_id = false)
+      perform(:delete, "/customers/#{id}.xml", { :use_third_party_id => use_third_party_id })
+    end
+
+    def self.show(id, use_third_party_id = false)
+      perform(:get, "/customers/#{id}.xml", :use_third_party_id => use_third_party_id) do |res|
+        Customer.from_hash(res["customer"])
+      end
+    end    
+
+    def self.find      
+      self.perform(:get, "/customers.xml") do |res|
+        res["customers"].map { |h| Customer.from_hash(h) }
+      end
+    end
+      
+  end
+
+  class Contact < Base
+    include AttributeEquality
+    attr_accessor :first_name, :last_name, :phone, :mobile, :email, :location
+    
+    def initialize(first_name = nil, last_name = nil, phone = nil, mobile = nil, email = nil, location = nil)
+      @first_name = first_name 
+      @last_name = last_name
+      @phone = phone
+      @mobile = mobile
+      @email = email
+      @location = location
+    end
+
+    def self.from_hash(attributes)
+      contact = Contact.new(attributes["first_name"], attributes["last_name"], attributes["phone"], attributes["mobile"], attributes["email"])
+      contact.location = Location.from_hash(attributes["location"])
+      contact
+    end
+
+    def to_hash
+      contact_hash = { 
+        :first_name  => self.first_name,
+        :last_name  => self.last_name,
+        :phone  => self.phone,
+        :mobile  => self.mobile,
+        :email => self.email
+      }
+      contact_hash[:location] = self.location.to_hash if location
+      contact_hash
+    end
+    
+    def ==(other)
+      attributes_eql?(other, [:first_name, :last_name, :phone, :mobile, :email, :location])
+    end
+    
+  end
+
+end

data/lib/vworkapp_ruby/job.rb

@@ -2,98 +2,26 @@ require 'gcoder'
 
 module VWorkApp
 
-  class Location
-    attr_accessor :formatted_address, :lat, :lng
-    def initialize(formatted_address, lat, lng)
-      @formatted_address = formatted_address
-      @lat = lat
-      @lng = lng
-    end
-    
-    def self.from_address(address, region = :us)
-      loc = Location.geocode(address, region).first.geometry.location
-      self.new(address, loc.lat, loc.lng)
-    end
-    
-    def to_hash
-      { :formatted_address => formatted_address, :lat => lat, :lng => lng }
-    end
-    
-    def self.from_hash(attributes)
-      return nil unless attributes
-      Location.new(attributes["formatted_address"], attributes["lat"], attributes["lng"])
-    end
-    
-  private
-
-    def self.geocode(address, region)
-      @gecoder ||= GCoder.connect(:storage => :heap)
-      @gecoder[address, { :region => region }]
-    end
-
-  end
-
-  class Step
-    attr_accessor :name, :location
-    def initialize(name, location = nil)
-      @name = name
-      @location = location
-    end
-
-    def to_hash
-      h = { :name => name }
-      h.merge!({ :location => location.to_hash }) if location  
-      h
-    end
-    
-    def self.from_hash(attributes)
-      Step.new(attributes["name"], Location.from_hash(attributes["location"]))
-    end
-    
-  end
+  class Job < Base
+    attr_accessor :id, :customer_name, :template_name, :planned_duration, :steps, :custom_fields, :third_party_id
+    attr_accessor :assigned_to_id, :planned_start_at, :progress_state
 
-  class CustomField
-    attr_accessor :name, :value
-    def initialize(name, value)
-      @name = name
-      @value = value
-    end
+    #---------------
+    # Object Methods
+    #---------------
 
-    def to_hash
-      { :name => name.to_s, :value => value.to_s }
-    end
-    
-    def self.from_hash(attributes)
-      CustomField.new(attributes["name"], attributes["value"])
-    end
-    
-  end
-
-  class Job < Base
-    
-    attr_accessor :id, :customer_name, :template_name, :planned_duration, :steps, :custom_fields, :third_party_id, :assigned_to, :planned_start_at
-
-    ##
-    # Creates a new jobs in vWorkApp.
-    # 
-    # Steps and Custom_Fields takes an array of these.
-    # 
-    def initialize(customer_name, template_name, planned_duration, steps, custom_fields = nil, id = nil, third_party_id = nil, assigned_to = nil, planned_start_at = nil)
+    def initialize(customer_name, template_name, planned_duration, steps, custom_fields = nil, id = nil, third_party_id = nil, assigned_to_id = nil, planned_start_at = nil)
       @id = id
       @customer_name = customer_name
-      @template_name = template_name 
+      @template_name = template_name
       @planned_duration = planned_duration 
       @steps = steps
       @custom_fields = custom_fields 
       @third_party_id = third_party_id
-      @assigned_to = assigned_to
+      @assigned_to_id = assigned_to_id
       @planned_start_at = planned_start_at
     end
-        
-    def is_new?
-      self.id == nil
-    end
-    
+            
     def to_hash
       job_hash = {
         :job => {
@@ -109,14 +37,49 @@ module VWorkApp
     end
 
     def self.from_hash(attributes)
-      j = Job.new(attributes["customer_name"], attributes["template_name"], attributes["planned_duration"], attributes["steps"].map { |h| Step.from_hash(h) }, nil, attributes["id"], attributes["third_party_id"])
-      j.custom_fields = attributes["custom_fields"].map { |h| CustomField.from_hash(h) } if attributes["custom_fields"]
-      j
+      job = Job.new(attributes["customer_name"], attributes["template_name"], attributes["planned_duration"], 
+                  attributes["steps"].map { |h| Step.from_hash(h) }, nil, attributes["id"], attributes["third_party_id"])      
+      job.custom_fields = attributes["custom_fields"].map { |h| CustomField.from_hash(h) } if attributes["custom_fields"]
+      
+      job.assigned_to_id = attributes["worker_id"]
+      job.planned_start_at = attributes["planned_start_at"]
+      job.progress_state = attributes["progress_state"]
+      
+      job
     end
     
+    def is_new?
+      self.id == nil
+    end
+
+    def assigned_to
+      return nil if @assigned_to_id.nil?
+      @assigned_to ||= Worker.show(self.assigned_to_id)
+    end
+
+    def ==(other)
+      attributes_eql?(other, [
+        :id, :third_party_id, :customer_name, :template_name, :planned_duration, :planned_start_at, 
+        :assigned_to_id, :steps, :custom_fields
+      ])
+    end
+
+    #---------------
+    # REST Methods
+    #---------------
+
     def create
-      res = self.class.post("/jobs", :body => self.to_hash, :query => { :api_key => VWorkApp.api_key })
-      res.success? ? res : self.class.bad_response(res)
+      perform(:post, "/jobs.xml", {}, self.to_hash) do |res|
+        Job.from_hash(res["job"])
+      end
+
+      # res = self.class.post("/jobs", :body => self.to_hash, :query => { :api_key => VWorkApp.api_key })
+      # if res.success?
+      #   self.id = res["job"]["id"]
+      #   self 
+      # else
+      #   self.class.bad_response(res)
+      # end
     end
 
     def update(id, attributes)
@@ -124,39 +87,82 @@ module VWorkApp
       res.success? ? res : bad_response(res)
     end
 
-    def self.all
-      find
+    def delete(use_third_party_id = false)
+      perform(:delete, "/jobs/#{id}.xml", { :use_third_party_id => use_third_party_id })
+    end
+
+    def self.show(id, use_third_party_id = false)
+      perform(:get, "/jobs/#{id}.xml", :use_third_party_id => use_third_party_id) do |res|
+        Job.from_hash(res["job"])
+      end
+      # raw = get("/jobs/#{id}.xml", :query => { :api_key => VWorkApp.api_key, :use_third_party_id => use_third_party_id })
+      # case res
+      # when Net::HTTPOK
+      #   Job.from_hash(raw["job"])
+      # when Net::HTTPNotFound
+      #    nil
+      # else
+      #   bad_response(res)
+      # end
     end
 
-    ##
-    # Returns jobs that match the given query options. Valid options are:
-    #   - :state — Filter by state. Possible values: unallocated, allocated, assigned, not_started, started, completed.
-    #   - :start_at — Filter by planned_start_at/last_action_time (must also give end_at).
-    #   - :end_at — Filter by planned_start_at/last_action_time (must also give start_at).
-    #   - :customer_name — Filter by customer name.
-    #   - :worker_id — Filter by assigned worker.
-    #   - :worker_third_party_id — Filter by assigned worker third party id.
-    #   - :per_page — The number of records to return per page.
-    #   - :page — The page of records to return.
-    #   - :third_party_id — The third_party_id associated with the job.
     def self.find(options={})
-      p options
       third_party_id = options.delete(:third_party_id)
-      options[:search] = "@third_party_id=#{third_party_id}" if (third_party_id)
+      options[:search] = "@third_party_id=#{third_party_id.to_s}" if (third_party_id)
       options[:api_key] = VWorkApp.api_key
       
       raw = get("/jobs.xml", :query => options)
       raw["jobs"].map { |h| Job.from_hash(h) }
     end
+            
+  end
+
+  class Step
+    include AttributeEquality
+    attr_accessor :name, :location
+    
+    def initialize(name, location = nil)
+      @name = name
+      @location = location
+    end
+
+    def to_hash
+      h = { :name => name }
+      h.merge!({ :location => location.to_hash }) if location  
+      h
+    end
+    
+    def self.from_hash(attributes)
+      Step.new(attributes["name"], Location.from_hash(attributes["location"]))
+    end
 
-    def self.show(id)
-      get("/jobs/#{id}.xml", :query => { :api_key => VWorkApp.api_key })
+    def ==(other)
+      attributes_eql?(other, [:name, :location])
     end
     
-    def self.delete(id)
-      
+  end
+
+  class CustomField
+    include AttributeEquality
+    attr_accessor :name, :value
+
+    def initialize(name, value)
+      @name = name
+      @value = value
     end
-        
+
+    def to_hash
+      { :name => name.to_s, :value => value.to_s }
+    end
+    
+    def self.from_hash(attributes)
+      CustomField.new(attributes["name"], attributes["value"])
+    end
+    
+    def ==(other)
+      attributes_eql?(other, [:name, :value])
+    end
+
   end
 
 end

data/lib/vworkapp_ruby/location.rb

@@ -0,0 +1,40 @@
+module VWorkApp
+
+  class Location
+    include AttributeEquality
+    attr_accessor :formatted_address, :lat, :lng
+    
+    def initialize(formatted_address, lat, lng)
+      @formatted_address = formatted_address
+      @lat = lat
+      @lng = lng
+    end
+    
+    def self.from_address(address, region = :us)
+      loc = Location.geocode(address, region).first.geometry.location
+      self.new(address, loc.lat, loc.lng)
+    end
+    
+    def to_hash
+      { :formatted_address => formatted_address, :lat => lat, :lng => lng }
+    end
+    
+    def self.from_hash(attributes)
+      return nil unless attributes
+      Location.new(attributes["formatted_address"], attributes["lat"], attributes["lng"])
+    end
+
+    def ==(other)
+      attributes_eql?(other, [:lat, :lng])
+    end
+    
+    private
+
+    def self.geocode(address, region)
+      @gecoder ||= GCoder.connect(:storage => :heap)
+      @gecoder[address, { :region => region }]
+    end
+
+  end
+
+end

data/lib/vworkapp_ruby/worker.rb

@@ -1,51 +1,88 @@
 module VWorkApp
 
-  class Telemetry
-    attr_accessor :lat, :lng, :recorded_at, :heading, :speed
-    def initialize (lat, lng, recorded_at, heading, speed)
-      @lat = lat
-      @lng = lng
-      @recorded_at = recorded_at
-      @heading = heading
-      @speed = speed
-    end
-    
-    def self.from_hash(attributes)
-      @lat = attributes["lat"]
-      @lng = attributes["lng"]
-      @recorded_at = attributes["recorded_at"]
-      @heading = attributes["heading"]
-      @speed = attributes["speed"]
-    end
-    
-  end
-
-  class Worker < Base
-    
+  class Worker < Base    
     attr_accessor :id, :name, :email, :latest_telemetry, :third_party_id
     
+    #---------------
+    # Object Methods
+    #---------------
+    
     def initialize(name, email, id = nil, third_party_id = nil)
       @name = name
       @email = email
       @id = id
       @third_party_id = third_party_id
     end
+        
+    def self.from_hash(attributes)
+      worker = Worker.new(attributes["name"], attributes["email"], attributes["id"], attributes["third_party_id"])
+      worker.latest_telemetry = Telemetry.from_hash(attributes["latest_telemetry"]) if attributes["latest_telemetry"]
+      worker
+    end
+
+    def to_hash
+      worker_hash = {
+        :worker => {
+          :name => self.name,
+          :email => self.email
+        }
+      }
+      worker_hash[:worker][:third_party_id] = self.third_party_id if third_party_id
+      worker_hash
+    end
     
-    def self.all
-      find
+    def ==(other)
+      attributes_eql?(other, [:id, :name, :email, :third_party_id])
     end
+    
+    #---------------
+    # REST Methods
+    #---------------
+
+    def create
+      perform(:post, "/workers", {}, self.to_hash) do |res|
+        Worker.from_hash(res["worker"])
+      end
+    end
+
+    def update(use_third_party_id = false)
+      perform(:put, "/workers/#{id}.xml", { :use_third_party_id => use_third_party_id }, self.to_hash)
+    end
+
+    def delete(use_third_party_id = false)
+      perform(:delete, "/workers/#{id}.xml", { :use_third_party_id => use_third_party_id })
+    end
+
+    def self.show(id, use_third_party_id = false)
+      perform(:get, "/workers/#{id}.xml", :use_third_party_id => use_third_party_id) do |res|
+        Worker.from_hash(res["worker"])
+      end
+    end    
 
     def self.find
-      raw = get("/workers.xml", :query => { :api_key => VWorkApp.api_key })["workers"]
-      raw.map { |h| Worker.from_hash(h) }
+      self.perform(:get, "/workers.xml") do |res|
+        res["workers"].map { |h| Worker.from_hash(h) }
+      end
+    end
+    
+  end
+
+  class Telemetry
+    attr_accessor :lat, :lng, :recorded_at, :heading, :speed
+    
+    def initialize (lat, lng, recorded_at, heading, speed)
+      @lat = lat
+      @lng = lng
+      @recorded_at = recorded_at
+      @heading = heading
+      @speed = speed
     end
     
     def self.from_hash(attributes)
-      w = Worker.new(attributes["name"], attributes["email"], attributes["id"], attributes["third_party_id"])
-      w.latest_telemetry = Telemetry.from_hash(attributes["latest_telemetry"]) if attributes["latest_telemetry"]
-      w
+      Telemetry.new(attributes["lat"], attributes["lng"], attributes["recorded_at"], attributes["heading"], attributes["speed"])
     end
     
   end
 
+
 end

data/spec/customer_spec.rb

@@ -0,0 +1,152 @@
+require "vworkapp_ruby"
+
+describe VW::Customer do
+
+  before(:all) do
+    VW::Customer.base_uri 'api.staging.vworkapp.com/api/2.0'
+    VW.api_key = "AtuogECLCV2R7uT-fkPg"
+  end
+
+  context "Without a known customer" do
+
+    describe "#Equals" do
+
+      it "Is equal to another customer if it has the same key attributes" do
+        customer_1 = VW::Customer.new("Joe's Baked Goods", 100, 200, 
+          VW::Contact.new("Joe", "Fisher", "415-465-8888", "415-465-9999", "joe@bakary.com"),
+          VW::Contact.new("Bob", "Jones", "021-465-2342", "233-233-1242", "bob.jones@jones.com")
+        )
+        customer_2 = VW::Customer.new("Joe's Baked Goods", 100, 200, 
+          VW::Contact.new("Joe", "Fisher", "415-465-8888", "415-465-9999", "joe@bakary.com"),
+          VW::Contact.new("Bob", "Jones", "021-465-2342", "233-233-1242", "bob.jones@jones.com")
+        )
+        customer_1.should == customer_2
+      end
+
+      it "Isn't equal to another worker if doesn't share the key attributes" do
+        customer_1 = VW::Customer.new("Joe's Baked Goods", 100, 200, 
+          VW::Contact.new("Joe", "Fisher", "415-465-8888", "415-465-9999", "joe@bakary.com"),
+          VW::Contact.new("Bob", "Jones", "021-465-2342", "233-233-1242", "bob.jones@jones.com")
+        )
+        customer_2 = VW::Customer.new("Joe's Baked Goods", 100, 200, 
+          VW::Contact.new("Joe", "Fisher", "415-465-8888", "415-465-9999", "joe@bakary.com"),
+          VW::Contact.new("Jeff", "Jones", "021-465-2342", "233-233-1242", "bob.jones@jones.com")
+        )
+        customer_1.should_not == customer_2
+      end
+
+    end
+
+    describe "#Create" do
+      
+      it "Assigns the new customer an id" do
+        @customer = VW::Customer.new("Joe's Baked Goods")
+        @customer = @customer.create
+        @customer.id.should_not be_nil
+      end
+
+      it "Creates a customer" do
+        @customer = VW::Customer.new("Joe's Baked Goods", nil, "My ID")
+        @customer = @customer.create
+      
+        r_cust = VW::Customer.show(@customer.id)
+        r_cust.name.should == @customer.name
+        r_cust.third_party_id.should == @customer.third_party_id
+      end
+
+      it "Creates a customer with a billing and delivery contact" do
+        site_contact = VW::Contact.new("Joe", "Fisher", "415-465-8888", "415-465-9999", "joe@bakary.com")
+        billing_contact = VW::Contact.new("Felix", "Smith")
+        @customer = VW::Customer.new("Joe's Baked Goods", nil, "My ID", site_contact, billing_contact)
+        @customer = @customer.create
+      
+        r_cust = VW::Customer.show(@customer.id)
+        
+        r_cust.site_contact.should == site_contact        
+        r_cust.billing_contact.should == billing_contact
+      end
+
+      it "Creates a customer with a contact location" do
+        pending "Can't pass a location object in yet. API should support this"
+        site = VW::Location.from_address("880 Harrison St, SF, USA")
+        @customer = VW::Customer.new("Joe's Baked Goods", nil, "My ID", VW::Contact.new("Joe", "Fisher", nil, nil, nil, site))
+        @customer = @customer.create
+      
+        r_cust = VW::Customer.show(@customer.id)
+        r_cust.site_contact.location.should == site    
+      end
+      
+    end
+
+    after(:each) do
+      @customer.delete if @customer
+    end
+
+  end
+
+  context "With a known customer" do
+    before(:each) do
+      @customer = VW::Customer.new("Joe's Baked Goods")
+      @customer = @customer.create
+    end
+  
+    after(:each) do
+      @customer.delete
+    end
+  
+    describe "#Show" do 
+      it "Returns the customer" do
+        r_cust = VW::Customer.show(@customer.id)
+        r_cust.name.should == "Joe's Baked Goods"
+      end
+  
+      it "Returns nil if not found" do
+        r_customer = VW::Customer.show(-1)
+        r_customer.should be_nil
+      end
+    end
+  
+    describe "#Update" do
+      
+      it "Updates a customer's primary details" do
+        @customer.name = "Jeff's Canned Beans"
+        @customer.third_party_id = "My Other ID"
+        @customer.update
+        r_cust = VW::Customer.show(@customer.id)
+        r_cust.name.should == "Jeff's Canned Beans"
+        r_cust.third_party_id.should == "My Other ID"
+      end
+
+      it "Updates a customers site and billing contacts" do
+        site_contact = VW::Contact.new("Joe", "Fisher", "415-465-8888", "415-465-9999", "joe@bakary.com")
+        billing_contact = VW::Contact.new("Felix", "Smith")
+        @customer.site_contact = site_contact
+        @customer.billing_contact = billing_contact
+        @customer.update
+
+        r_cust = VW::Customer.show(@customer.id)
+        r_cust.site_contact.should == site_contact
+        r_cust.billing_contact.should == billing_contact
+      end
+
+    end
+      
+    describe "#Delete" do
+      it "Deletes the customer" do
+        @customer.delete
+        r_customer = VW::Customer.show(@customer.id)
+        r_customer.should be_nil
+      end
+    end
+      
+    describe "#Find" do
+      it "Finds all customers" do
+        results = VW::Customer.find
+        results.should be_instance_of(Array)
+        results.should include(@customer)
+      end
+    end
+    
+  end
+
+end

data/spec/job_spec.rb

@@ -0,0 +1,199 @@
+require "vworkapp_ruby"
+
+describe VW::Job do
+
+  before(:all) do
+    VW::Job.base_uri 'api.staging.vworkapp.com/api/2.0'
+    VW.api_key = "AtuogECLCV2R7uT-fkPg"
+  end
+
+  context "Without a known job" do
+
+    describe "#Equals" do
+
+      it "Is equal to another job if it has the same attributes, steps, and custom_fields" do
+        job_1 = VW::Job.new("Joe", "Std Delivery", 60, 
+          [
+            VW::Step.new("Start", VWorkApp::Location.new("880 Harrison St", 37.779536, -122.401503)),
+            VW::Step.new("End",   VWorkApp::Location.new("Other Street", 38.779536, -123.401503))
+          ],
+          [
+            VW::CustomField.new("Note", "Hi There!")
+          ],
+          100, 202, 101, Date.new(2001,2,3)
+        )
+        job_2 = VW::Job.new("Joe", "Std Delivery", 60, 
+          [
+            VW::Step.new("Start", VWorkApp::Location.new("880 Harrison St!", 37.779536, -122.401503)),
+            VW::Step.new("End",   VWorkApp::Location.new("Other Street", 38.779536, -123.401503))
+          ],
+          [
+            VW::CustomField.new("Note", "Hi There!")
+          ],
+          100, 202, 101, Date.new(2001,2,3)
+        )
+        job_1.should == job_2
+      end
+
+      it "Isn't equal to another job if doesn't share the key attributes" do
+        job_1 = VW::Job.new("Joe", "Std Delivery", 60, nil, nil, 100, 202, 101, Date.new(2001,2,3))
+        job_2 = VW::Job.new("Joe", "Std Delivery", 60, nil, nil, 100, 202, 101, Date.new(2001,4,3))
+        job_1.should_not == job_2
+      end
+
+      it "Isn't equal to another job if doesn't share the same steps" do
+        job_1 = VW::Job.new("Joe", "Std Delivery", 60, [
+            VW::Step.new("Start", VWorkApp::Location.new("880 Harrison St", 37.779536, -122.401503)),
+            VW::Step.new("End",   VWorkApp::Location.new("Other Street", 38.779536, -122.401503))
+        ])
+        job_2 = VW::Job.new("Joe", "Std Delivery", 60, [
+            VW::Step.new("Start", VWorkApp::Location.new("880 Harrison St", 37.779536, -122.401503)),
+            VW::Step.new("End",   VWorkApp::Location.new("DIFFERENT", 38.779536, 100))
+        ])
+        job_1.should_not == job_2
+      end
+
+      it "Isn't equal to another job if doesn't share the same custom fields" do
+        job_1 = VW::Job.new("Joe", "Std Delivery", 60, nil, [
+            VW::CustomField.new("Note1", "Value1"),
+            VW::CustomField.new("Note2", "Value2"),
+        ])
+        job_2 = VW::Job.new("Joe", "Std Delivery", 60, nil, [
+            VW::CustomField.new("Note1", "Value1"),
+            VW::CustomField.new("Note2", "DIFFERENT"),
+        ])
+        job_1.should_not == job_2
+      end
+
+    end
+
+    describe "#Create" do
+      
+      it "Assigns the new job an id" do
+        @job = VW::Job.new("Joe", "Std Delivery", 60, 
+          [
+            VW::Step.new("Start", VWorkApp::Location.new("880 Harrison St", 37.779536, -122.401503)),
+            VW::Step.new("End",   VWorkApp::Location.new("Other Street", 38.779536, -123.401503))
+          ],
+          [
+            VW::CustomField.new("Note", "Hi There!")
+          ],
+          100, 202, 101, Date.new(2001,2,3)
+        )
+        
+        @job = @job.create
+        @job.id.should_not be_nil
+      end
+    
+      it "Creates an unassigned job" do
+        @job = VW::Job.new("Joe", "Std Delivery", 60,
+        [
+          VW::Step.new("Start", VWorkApp::Location.new("880 Harrison St", 37.779536, -122.401503)),
+          VW::Step.new("End",   VWorkApp::Location.new("Other Street", 38.779536, -123.401503))
+        ])
+        @job = @job.create
+        r_job = VW::Job.show(@job.id)
+        r_job.customer_name.should == @job.customer_name
+        r_job.template_name.should == @job.template_name
+        r_job.planned_duration.should == @job.planned_duration
+        r_job.steps.should == @job.steps
+      end
+
+      it "Creates an unassigned job with Custom Fields" do
+        @job = VW::Job.new("Joe", "Std Delivery", 60,
+          [
+            VW::Step.new("Start", VWorkApp::Location.new("880 Harrison St", 37.779536, -122.401503)),
+            VW::Step.new("End",   VWorkApp::Location.new("Other Street", 38.779536, -123.401503))
+          ],
+          [
+            VW::CustomField.new("Note1", "Value1"),
+            VW::CustomField.new("Note2", "Value2"),
+          ]
+        )
+        @job = @job.create
+        r_job = VW::Job.show(@job.id)
+        r_job.custom_fields.should == @job.custom_fields
+      end
+
+      it "Creates and assigns a job" do
+        @worker = VW::Worker.new("Joe", "joe@example.com")
+        @worker = @worker.create
+        
+        @job = VW::Job.new("Joe", "Std Delivery", 60,
+        [
+          VW::Step.new("Start", VWorkApp::Location.new("880 Harrison St", 37.779536, -122.401503)),
+          VW::Step.new("End",   VWorkApp::Location.new("Other Street", 38.779536, -123.401503))
+        ], nil, nil, @worker.id, DateTime.parse("2012-12-25 16:30"))
+        @job = @job.create
+        r_job = VW::Job.show(@job.id)
+
+        r_job.worker_id.should == @worker.id
+        r_job.planned_start_time.should == DateTime.parse("2012-12-25 16:30")
+      end
+      
+    end
+
+    after(:each) do
+      @job.delete if @job
+      @worker.delete if @worker
+    end
+
+  end
+
+  # context "With a known job" do
+  #   before(:each) do
+  #     @worker = VW::Worker.new("Joe", "joe@example.com")
+  #     @worker = @worker.create
+  #   end
+  # 
+  #   after(:each) do
+  #     @worker.delete
+  #   end
+  # 
+  #   describe "#show" do 
+  #     it "Returns the worker" do
+  #       r_worker = VW::Worker.show(@worker.id)
+  #       r_worker.name.should == "Joe"
+  #       r_worker.email.should == "joe@example.com"
+  #     end
+  # 
+  #     it "Returns nil if not found" do
+  #       pending("Bug in vWorkApp. Should be returning a 404 but isn't")
+  #       r_worker = VW::Worker.show(-1)
+  #       r_worker.should be_nil
+  #     end
+  #   end
+  # 
+  #   describe "#update" do
+  #     it "Updates the worker" do
+  #       @worker.name = "Joe2"
+  #       @worker.email = "joe2@example.com"
+  #       @worker.update
+  #       r_worker = VW::Worker.show(@worker.id)
+  #       r_worker.name.should == "Joe2"
+  #       r_worker.email.should == "joe2@example.com"
+  #     end
+  #   end
+  # 
+  #   describe "#delete" do
+  #     it "Deletes the worker" do
+  #       @worker.delete
+  #       # XXX Can't verify until #show is fixed
+  #       # r_worker = VW::Worker.show(@worker.id)
+  #       # r_worker.should be_nil
+  #     end
+  #   end
+  # 
+  #   describe "#find" do
+  #     it "Finds all workers" do
+  #       results = VW::Worker.find
+  #       results.should be_instance_of(Array)
+  #       results.should include(@worker)
+  #     end
+  #   end
+  #   
+  # end
+
+
+
+end

data/spec/worker_spec.rb

@@ -0,0 +1,108 @@
+require "vworkapp_ruby"
+
+describe VW::Worker do
+
+  before(:all) do
+    VW::Worker.base_uri 'api.staging.vworkapp.com/api/2.0'
+    VW.api_key = "AtuogECLCV2R7uT-fkPg"
+  end
+
+  context "Without a known worker" do
+
+    describe "#Equal" do
+
+      it "Is equal to another worker if it has the same key attributes" do
+        worker_1 = VW::Worker.new("Joe", "joe@example.com", 100, 200)
+        worker_2 = VW::Worker.new("Joe", "joe@example.com", 100, 200)
+        worker_1.should == worker_2
+      end
+
+      it "Isn't equal to another worker if doesn't share the key attributes" do
+        worker_1 = VW::Worker.new("Joe", "joe@example.com", 100, 200)
+        worker_2 = VW::Worker.new("Joe", "joe@example.com", 100, 202)
+        worker_1.should_not == worker_2
+      end
+
+    end
+
+    describe "#Create" do
+      
+      it "Assigns the new worker an id" do
+        @worker = VW::Worker.new("Joe", "joe@example.com")
+        @worker = @worker.create
+        @worker.id.should_not be_nil
+      end
+
+      it "Creates a worker" do
+        @worker = VW::Worker.new("Joe", "joe@example.com")
+        @worker = @worker.create
+        r_worker = VW::Worker.show(@worker.id)
+        r_worker.name.should == @worker.name
+        r_worker.email.should == @worker.email
+      end
+      
+    end
+
+    after(:each) do
+      @worker.delete if @worker
+    end
+
+  end
+
+  context "With a known worker" do
+    before(:each) do
+      @worker = VW::Worker.new("Joe", "joe@example.com")
+      @worker = @worker.create
+    end
+  
+    after(:each) do
+      @worker.delete
+    end
+  
+    describe "#Show" do 
+      it "Returns the worker" do
+        r_worker = VW::Worker.show(@worker.id)
+        r_worker.name.should == "Joe"
+        r_worker.email.should == "joe@example.com"
+      end
+  
+      it "Returns nil if not found" do
+        pending("Bug in vWorkApp. Should be returning a 404 but isn't")
+        r_worker = VW::Worker.show(-1)
+        r_worker.should be_nil
+      end
+    end
+  
+    describe "#Update" do
+      it "Updates the worker" do
+        @worker.name = "Joe2"
+        @worker.email = "joe2@example.com"
+        @worker.update
+        r_worker = VW::Worker.show(@worker.id)
+        r_worker.name.should == "Joe2"
+        r_worker.email.should == "joe2@example.com"
+      end
+    end
+
+    describe "#Delete" do
+      it "Deletes the worker" do
+        @worker.delete
+        # XXX Can't verify until #show is fixed
+        # r_worker = VW::Worker.show(@worker.id)
+        # r_worker.should be_nil
+      end
+    end
+
+    describe "#Find" do
+      it "Finds all workers" do
+        results = VW::Worker.find
+        results.should be_instance_of(Array)
+        results.should include(@worker)
+      end
+    end
+    
+  end
+
+
+
+end

data/vworkapp_ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "vworkapp_ruby"
-  s.version     = "0.0.1"
+  s.version     = "0.1.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["vWorkApp Inc.", "Aish Fenton"]
   s.email       = ["info@vworkapp.com"]
@@ -12,6 +12,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "httparty"
   s.add_dependency "gcoder"
+
   s.add_development_dependency "rspec"
 
   s.files              = `git ls-files`.split("\n") rescue ''

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: vworkapp_ruby
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - vWorkApp Inc.
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-03 00:00:00 Z
+date: 2012-01-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
@@ -70,18 +70,23 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
 - Gemfile
+- Gemfile.lock
 - README.md
 - examples/create_job.rb
 - examples/print_jobs.rb
 - lib/vworkapp_ruby.rb
 - lib/vworkapp_ruby/base.rb
-- lib/vworkapp_ruby/cli/job.rb
 - lib/vworkapp_ruby/customer.rb
 - lib/vworkapp_ruby/httparty_monkey_patch.rb
 - lib/vworkapp_ruby/job.rb
+- lib/vworkapp_ruby/location.rb
 - lib/vworkapp_ruby/response_error.rb
 - lib/vworkapp_ruby/worker.rb
+- spec/customer_spec.rb
+- spec/job_spec.rb
+- spec/worker_spec.rb
 - vworkapp_ruby.gemspec
 homepage: http://api.vworkapp.com/api/
 licenses: []
@@ -114,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Simple interface to vWorkApp's api

data/lib/vworkapp_ruby/cli/job.rb

@@ -1,5 +0,0 @@
-vwk-job find -w 12 -c Bob
-vwk-job show -w 12 -c Bob
-vwk-job create -worker 12 --customer Bob --template Delivery --start-time --duration 12 --cf name1:value1,name1:value1
-vwk-job list -w 12 -c Bob
-vwk-job delete -w 12 -c Bob