vworkapp_ruby 0.1.0 → 0.7.0

data/lib/vworkapp_ruby/location.rb

@@ -1,34 +1,18 @@
 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
+  class Location < Base
+    hattr_accessor :formatted_address, :lat, :lng
+    self.include_root_in_json = false
     
     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"])
+      self.new(:formmated_address => address, :lat => loc.lat, :lng => loc.lng)
     end
 
     def ==(other)
-      attributes_eql?(other, [:lat, :lng])
+      attributes_eql?(other, :lat, :lng)
     end
     
-    private
+  private
 
     def self.geocode(address, region)
       @gecoder ||= GCoder.connect(:storage => :heap)
@@ -36,5 +20,4 @@ module VWorkApp
     end
 
   end
-
 end

data/lib/vworkapp_ruby/step.rb

@@ -0,0 +1,11 @@
+module VWorkApp
+  class Step < Base
+    hattr_accessor :name, {:location => VWorkApp::Location}, :completed_at
+    self.include_root_in_json = false
+
+    def ==(other)
+      attributes_eql?(other, :name, :location, :completed_at)
+    end
+  
+  end
+end

data/lib/vworkapp_ruby/telemetry.rb

@@ -0,0 +1,6 @@
+module VWorkApp
+  class Telemetry < Base
+    hattr_accessor :lat, :lng, :recorded_at, :heading, :speed
+    self.include_root_in_json = false
+  end
+end

data/lib/vworkapp_ruby/worker.rb

@@ -1,88 +1,11 @@
 module VWorkApp
+  class Worker < Resource
+    hattr_accessor :id, :name, :email, :third_party_id
+    hattr_reader :latest_telemetry => VWorkApp::Telemetry
 
-  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 ==(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
-      self.perform(:get, "/workers.xml") do |res|
-        res["workers"].map { |h| Worker.from_hash(h) }
-      end
+      attributes_eql?(other, :id, :name, :email, :third_party_id)
     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)
-      Telemetry.new(attributes["lat"], attributes["lng"], attributes["recorded_at"], attributes["heading"], attributes["speed"])
-    end
-    
-  end
-
-
 end

data/spec/base_spec.rb

@@ -0,0 +1,174 @@
+require "vworkapp_ruby"
+
+describe VW::Base do
+
+  before(:all) do
+  end
+
+  describe "#New" do
+
+    it "Creates a base object from a given hash" do
+      t = B1.new( 
+        :a => "a",
+        :b => "b",
+        :c => {
+          :one => "one",
+          :two => "two"
+        }
+      )
+      t.a.should == "a"
+      t.b.should == "b"
+      t.c.should be_instance_of B2
+      t.c.one.should == "one"
+      t.c.two.should == "two"
+      t.d.should be_nil
+    end
+
+    it "Doesn't create setters for readonly attributes" do
+      t = B1.new(:d => 'd')
+      t.d.should == "d"
+      lambda { t.d = 'ahem' }.should raise_error(NoMethodError)
+    end
+
+    it "Works with string keys too" do
+      t = B1.new(:a => "a", "b" => "b")
+      t.a.should == "a"
+      t.b.should == "b"
+    end
+
+    it "Populates readonly attributes too" do
+      t = B1.new(:d => "d")
+      t.d.should == "d"
+    end
+        
+    it "Works with array's of nested items" do
+      t = B1.new(:es => [
+        {:one => "one", :two => "two"},
+        {:one => "three", :two => "four"}
+      ])
+      t.es.should be_instance_of Array
+      t.es.size.should == 2
+      t.es.first.should be_instance_of B2
+      t.es.first.one.should == "one"
+    end
+    
+  end
+
+  describe "#Attributes" do
+
+    it "Retuns the resources's attributes" do
+      t = B1.new(:a => "a", :b => "b", :c => {:one => "one", :two => "two" })
+      t.attributes.should == {
+        "a" => "a",
+        "b" => "b",
+        "c" => B2.new(:one => "one", :two => "two"),
+        "d" => nil,
+        "es" => nil
+      }
+    end
+
+    it "Retuns the resources's readable attributes" do
+      t = B1.new(:a => "a", :b => "b", :d => 'd')
+      t.read_attributes.should == {"a" => "a", "b" => "b", "c" => nil, "es" => nil, "d" => "d"}
+    end
+
+    it "Retuns the resources's writeable attributes" do
+      t = B1.new(:a => "a", :b => "b", :d => 'd')
+      t.write_attributes.should == {"a" => "a", "b" => "b", "c" => nil, "es" => nil}
+    end
+
+    it "Overwritten hattr setters get called" do
+      t = B1.new
+      class << t
+        attr_reader :test
+        def a=(value)
+          @test = value
+        end
+      end
+      t.attributes = {:a => "a"}
+      t.test.should == "a"
+    end
+
+  end
+
+  describe "#Equals" do
+    it "Is == if key attributes match" do
+      t1 = B1.new(:a => "a", :b => "b", :es => [{:one => "one", :two => "two"}, {:one => "three", :two => "four"}])
+      t2 = B1.new(:a => "a", :b => "b", :es => [{:one => "one", :two => "two"}, {:one => "three", :two => "four"}])
+      t1.should == t2
+    end
+  end
+
+  describe "#Valdiations" do
+    it "Has error(s) if required fields are missing" do
+      @job = B1.new
+      @job.valid?.should be_false
+      @job.errors.keys.should == [:a]
+    end
+  end
+
+  describe "Serialization" do
+
+    # XXX fails intermittently because of hash ordering.
+    it "Serializes into json" do
+      t = B1.new(:a => "a", :b => "b", :es => [{:one => "one", :two => "two"}, {:one => "three", :two => "four"}])
+      t.to_json.should == '{"b1":{"a":"a","b":"b","c":null,"es":[{"two":"two","one":"one"},{"two":"four","one":"three"}]}}'
+    end
+
+    # XXX fails intermittently because of hash ordering.
+    it "Serializes into xml" do
+      t = B1.new(:a => "a", :b => "b", :es => [{:one => "one", :two => "two"}, {:one => "three", :two => "four"}], :d => nil)
+      t.to_xml.should == <<-eol
+<?xml version="1.0" encoding="UTF-8"?>
+<b1>
+  <a>a</a>
+  <b>b</b>
+  <es type="array">
+    <e>
+      <two>two</two>
+      <one>one</one>
+    </e>
+    <e>
+      <two>four</two>
+      <one>three</one>
+    </e>
+  </es>
+  <c nil="true"></c>
+</b1>
+eol
+    end
+
+    it "Serializes into xml but doesn't include readonly items" do
+      t = B1.new(:a => "a", :b => "b", :d => "d")
+      t.to_xml.should_not include "<d>d</d>"
+    end
+
+    it "Serializes into json but doesn't include readonly items" do
+      t = B1.new(:a => "a", :b => "b", :d => "d")
+      t.to_json.should_not include '"d":"d"'
+    end
+
+  end
+
+end
+
+class B2 < VW::Base
+  hattr_accessor :one, :two
+  self.include_root_in_json = false
+  
+  def ==(other)
+    attributes_eql?(other, :one, :two)
+  end
+end
+
+class B1 < VW::Base
+  hattr_accessor :a, :b, {:c => B2}, {:es => Array(B2)}
+  hattr_reader :d
+
+  validates_presence_of :a
+  
+  def ==(other)
+    attributes_eql?(other, :a, :b, :c, :es)
+  end
+  
+end

data/spec/customer_spec.rb

@@ -3,67 +3,51 @@ require "vworkapp_ruby"
 describe VW::Customer do
 
   before(:all) do
-    VW::Customer.base_uri 'api.staging.vworkapp.com/api/2.0'
+    VW::Customer.base_uri 'https://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 = VW::Customer.new(:name => "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 = VW::Customer.new(:name => "Joe's Baked Goods", :third_party_id => "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 = VW::Customer.new(
+          :name => "Joe's Baked Goods", 
+          :third_party_id => "My ID", 
+          :delivery_contact => {
+            :first_name => "Joe",
+            :last_name => "Fisher",
+            :phone => "415-465-8888",
+            :mobile => "415-465-9999",
+            :email => "joe@bakary.com"
+          },
+          :billing_contact => {
+            :first_name => "Felix", 
+            :last_name => "Smith"
+          }
+        )
         @customer = @customer.create
       
         r_cust = VW::Customer.show(@customer.id)
         
-        r_cust.site_contact.should == site_contact        
-        r_cust.billing_contact.should == billing_contact
+        r_cust.delivery_contact.should == @customer.delivery_contact
+        r_cust.billing_contact.should == @customer.billing_contact
       end
 
       it "Creates a customer with a contact location" do
@@ -73,7 +57,7 @@ describe VW::Customer do
         @customer = @customer.create
       
         r_cust = VW::Customer.show(@customer.id)
-        r_cust.site_contact.location.should == site    
+        r_cust.delivery_contact.location.should == site    
       end
       
     end
@@ -86,7 +70,7 @@ describe VW::Customer do
 
   context "With a known customer" do
     before(:each) do
-      @customer = VW::Customer.new("Joe's Baked Goods")
+      @customer = VW::Customer.new(:name => "Joe's Baked Goods")
       @customer = @customer.create
     end
   
@@ -117,20 +101,20 @@ describe VW::Customer do
         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
+      it "Updates a customers delivery and billing contacts" do
+        delivery_contact = VW::Contact.new(:first_name => "Joe", :last_name => "Fisher", :phone => "415-465-8888", :mobile => "415-465-9999", :email => "joe@bakary.com")
+        billing_contact = VW::Contact.new(:first_name => "Felix", :last_name => "Smith")
+        @customer.delivery_contact = delivery_contact
         @customer.billing_contact = billing_contact
         @customer.update
 
         r_cust = VW::Customer.show(@customer.id)
-        r_cust.site_contact.should == site_contact
+        r_cust.delivery_contact.should == delivery_contact
         r_cust.billing_contact.should == billing_contact
       end
 
     end
-      
+
     describe "#Delete" do
       it "Deletes the customer" do
         @customer.delete
@@ -138,7 +122,7 @@ describe VW::Customer do
         r_customer.should be_nil
       end
     end
-      
+
     describe "#Find" do
       it "Finds all customers" do
         results = VW::Customer.find