quickeebooks 0.1.6 → 0.1.7

data/lib/quickeebooks/online/model/time_activity.rb

@@ -0,0 +1,48 @@
+require "quickeebooks"
+require "quickeebooks/online/model/id"
+require "quickeebooks/online/model/meta_data"
+require "quickeebooks/online/model/time_activity_employee"
+require "quickeebooks/online/model/time_activity_vendor"
+
+module Quickeebooks
+  module Online
+    module Model
+      class TimeActivity < Quickeebooks::Online::Model::IntuitType
+        include ActiveModel::Validations
+        include OnlineEntityModel
+
+        XML_NODE = "TimeActivity"
+        REST_RESOURCE = "time_activity"
+
+        xml_accessor :txn_date, :from => 'TxnDate'
+        xml_accessor :name_of, :from => 'NameOf'
+
+        xml_accessor :employee, :from => 'Employee', :as => Quickeebooks::Online::Model::TimeActivityEmployee
+        xml_accessor :vendor, :from => 'Vendor', :as => Quickeebooks::Online::Model::TimeActivityVendor
+
+        xml_accessor :customer_id, :from => 'CustomerId'
+        xml_accessor :customer_name, :from => 'CustomerName'
+        xml_accessor :item_id, :from => 'ItemId', :as => Quickeebooks::Online::Model::Id
+        xml_accessor :class_id, :from => 'ClassId', :as => Quickeebooks::Online::Model::Id
+        xml_accessor :billable_status, :from => 'BillableStatus'
+        xml_accessor :taxable, :from => 'Taxable'
+        xml_accessor :hourly_rate, :from => 'HourlyRate'
+        xml_accessor :hours, :from => 'Hours', :as => Integer
+        xml_accessor :minutes, :from => 'Minutes', :as => Integer
+        xml_accessor :seconds, :from => 'Seconds', :as => Integer
+        xml_accessor :break_hours, :from => 'BreakHours', :as => Integer
+        xml_accessor :break_minutes, :from => 'BreakMinutes', :as => Integer
+        xml_accessor :start_time, :from => 'StartTime', :as => DateTime
+        xml_accessor :end_time, :from => 'EndTime', :as => DateTime
+        xml_accessor :description, :from => 'Description'
+
+        validates_presence_of :name_of, :customer_id, :hourly_rate
+
+
+        def self.resource_for_collection
+          'time-activities'
+        end
+      end
+    end
+  end
+end

data/lib/quickeebooks/online/model/time_activity_employee.rb

@@ -0,0 +1,12 @@
+require "quickeebooks"
+
+module Quickeebooks
+  module Online
+    module Model
+      class TimeActivityEmployee < Quickeebooks::Online::Model::IntuitType
+        xml_accessor :employee_id, :from => 'EmployeeId', :as => Quickeebooks::Online::Model::Id
+        xml_accessor :employee_name, :from => 'EmployeeName'
+      end
+    end
+  end
+end

data/lib/quickeebooks/online/model/time_activity_vendor.rb

@@ -0,0 +1,12 @@
+require "quickeebooks"
+
+module Quickeebooks
+  module Online
+    module Model
+      class TimeActivityVendor < Quickeebooks::Online::Model::IntuitType
+        xml_accessor :vendor_id, :from => 'VendorId', :as => Quickeebooks::Online::Model::Id
+        xml_accessor :vendor_name, :from => 'VendorName'
+      end
+    end
+  end
+end

data/lib/quickeebooks/online/model/vendor.rb

@@ -20,6 +20,7 @@ module Quickeebooks
         REST_RESOURCE = "vendor"
 
         xml_accessor :is_1099?, :from => 'Vendor1099'
+        validates_length_of :name, :minimum => 1
 
       end
     end

data/lib/quickeebooks/online/service/employee.rb

@@ -0,0 +1,15 @@
+require 'quickeebooks/online/service/service_base'
+require 'quickeebooks/online/model/employee'
+require 'quickeebooks/common/service_crud'
+require 'nokogiri'
+
+module Quickeebooks
+  module Online
+    module Service
+      class Employee < ServiceBase
+        include ServiceCRUD
+      end
+    end
+  end
+end
+

data/lib/quickeebooks/online/service/service_base.rb

@@ -75,6 +75,13 @@ module Quickeebooks
           Nokogiri::XML(xml)
         end
 
+        def escape_filter(str)
+          # Ampersand needs to double encoded within an Oath request.
+          # CGI.escape will take the #26 and properly turn it into #2526
+          str.gsub!('&','%26')
+          CGI.escape(str)
+        end
+
         def valid_xml_document(xml)
           %Q{<?xml version="1.0" encoding="utf-8"?>\n#{xml.strip}}
         end
@@ -86,7 +93,7 @@ module Quickeebooks
 
           if filters.is_a?(Array) && filters.length > 0
             filter_string = filters.collect { |f| f.to_s }
-            post_body_lines << "Filter=#{CGI.escape(filter_string.join(" :AND: "))}"
+            post_body_lines << "Filter=#{escape_filter(filter_string.join(" :AND: "))}"
           end
 
           post_body_lines << "PageNum=#{page}"

data/lib/quickeebooks/online/service/time_activity.rb

@@ -0,0 +1,15 @@
+require 'quickeebooks/online/service/service_base'
+require 'quickeebooks/online/model/time_activity'
+require 'quickeebooks/common/service_crud'
+require 'nokogiri'
+
+module Quickeebooks
+  module Online
+    module Service
+      class TimeActivity < ServiceBase
+        include ServiceCRUD
+      end
+    end
+  end
+end
+

data/lib/quickeebooks/version.rb

@@ -1,5 +1,5 @@
 module Quickeebooks
 
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 
 end

data/spec/quickeebooks/online/customer_spec.rb

@@ -45,4 +45,4 @@ describe "Quickeebooks::Online::Model::Customer" do
     customer.errors.keys.include?(:sync_token).should == true
   end
 
-end
+end

data/spec/quickeebooks/online/employee_spec.rb

@@ -0,0 +1,31 @@
+describe "Quickeebooks::Online::Model::Employee" do
+
+  describe "parse employee from XML" do
+    xml = onlineFixture("employee.xml")
+    employee = Quickeebooks::Online::Model::Employee.from_xml(xml)
+    employee.sync_token.should == 0
+    employee.name.should == "John Simpson"
+    employee.meta_data.create_time.year.should == Date.civil(2010, 9, 10).year
+    employee.addresses.count.should == 1
+    employee.addresses.first.line1.should == "21215 Burbank Boulevard, Ste. 100"
+    employee.phones.size.should == 2
+    employee.phones.first.free_form_number.should == "(818) 936-7800"
+    employee.email.address.should == "john.simpson@mint.com"
+  end
+
+  it "can assign an email address" do
+    employee = Quickeebooks::Online::Model::Employee.new
+    the_email = "foo@example.org"
+    employee.email_address = the_email
+    employee.email.is_a?(Quickeebooks::Online::Model::Email).should == true
+    employee.email.address.should == the_email
+  end
+
+  it "cannot update an invalid model" do
+    employee = Quickeebooks::Online::Model::Employee.new
+    employee.to_xml_ns.should match('Employee')
+    employee.valid_for_update?.should == false
+    employee.errors.keys.include?(:sync_token).should == true
+  end
+
+end

data/spec/quickeebooks/online/services/employee_spec.rb

@@ -0,0 +1,83 @@
+describe "Quickeebooks::Online::Service::Employee" do
+  before(:all) do
+    construct_oauth_service :employee
+  end
+
+  it "can fetch a list of employees" do
+    xml = onlineFixture("employees.xml")
+    url = @service.url_for_resource(Quickeebooks::Online::Model::Employee.resource_for_collection)
+    FakeWeb.register_uri(:post, url, :status => ["200", "OK"], :body => xml)
+    employees = @service.list
+    employees.current_page.should == 1
+    employees.entries.count.should == 1
+    employees.entries.first.name.should == "John Simpson"
+  end
+
+  it "can create a employee" do
+    xml = onlineFixture("employee.xml")
+    url = @service.url_for_resource(Quickeebooks::Online::Model::Employee.resource_for_singular)
+    FakeWeb.register_uri(:post, url, :status => ["200", "OK"], :body => xml)
+    employee = Quickeebooks::Online::Model::Employee.new
+    employee.name = "John Doe"
+    result = @service.create(employee)
+    result.id.value.to_i.should > 0
+  end
+
+  it "can delete a employee" do
+    url = "#{@service.url_for_resource(Quickeebooks::Online::Model::Employee.resource_for_singular)}/11?methodx=delete"
+    FakeWeb.register_uri(:post, url, :status => ["200", "OK"])
+    employee = Quickeebooks::Online::Model::Employee.new
+    employee.id = Quickeebooks::Online::Model::Id.new("11")
+    employee.sync_token = 0
+    result = @service.delete(employee)
+    result.should == true
+  end
+
+  it "cannot delete a employee with missing required fields for deletion" do
+    employee = Quickeebooks::Online::Model::Employee.new
+    expect { @service.delete(employee) }.to raise_exception(InvalidModelException, "Missing required parameters for delete")
+  end
+
+  it "exception is raised when we try to create an invalid account" do
+    employee = Quickeebooks::Online::Model::Employee.new
+    expect { @service.create(employee) }.to raise_exception InvalidModelException
+  end
+
+  it "cannot update an invalid employee" do
+    employee = Quickeebooks::Online::Model::Employee.new
+    employee.name = "John Bilby"
+    expect { @service.update(employee) }.to raise_exception InvalidModelException
+  end
+
+  it "can fetch a employee by id" do
+    xml = onlineFixture("employee.xml")
+    url = "#{@service.url_for_resource(Quickeebooks::Online::Model::Employee.resource_for_singular)}/11"
+    FakeWeb.register_uri(:get, url, :status => ["200", "OK"], :body => xml)
+    employee = @service.fetch_by_id(11)
+    employee.name.should == "John Simpson"
+  end
+
+  it "can update a employee" do
+    xml2 = onlineFixture("employee2.xml")
+    employee = Quickeebooks::Online::Model::Employee.new
+    employee.name = "John Doe"
+    employee.id = Quickeebooks::Online::Model::Id.new("1")
+    employee.sync_token = 2
+
+    url = "#{@service.url_for_resource(Quickeebooks::Online::Model::Employee.resource_for_singular)}/#{employee.id.value}"
+    FakeWeb.register_uri(:post, url, :status => ["200", "OK"], :body => xml2)
+    updated = @service.update(employee)
+    updated.name.should == "John Doe"
+  end
+
+  it 'Can update a fetched employee' do
+    xml = onlineFixture("employee.xml")
+    url = "#{@service.url_for_resource(Quickeebooks::Online::Model::Employee.resource_for_singular)}/11"
+    FakeWeb.register_uri(:get, url, :status => ["200", "OK"], :body => xml)
+    employee = @service.fetch_by_id(11)
+    url = "#{@service.url_for_resource(Quickeebooks::Online::Model::Employee.resource_for_singular)}/#{employee.id.value}"
+    FakeWeb.register_uri(:post, url, :status => ["200", "OK"], :body => xml)
+    updated = @service.update(employee)
+  end
+
+end

data/spec/quickeebooks/online/services/service_base_spec.rb

@@ -106,6 +106,18 @@ describe "Quickeebooks::Online::Service::ServiceBase" do
       @service.send(:fetch_collection, @model, [filter])
     end
 
+    it "with an ampersand in filter value" do
+
+      filter = Quickeebooks::Online::Service::Filter.new(:text, :field => "Name", :value => "Smith & Gentry")
+
+      @service.should_receive(:do_http_post).with(@url,
+        "Filter=Name+%3AEQUALS%3A+Smith+%2526+Gentry&PageNum=1&ResultsPerPage=20",
+        {},
+        {"Content-Type"=>"application/x-www-form-urlencoded"})
+
+      @service.send(:fetch_collection, @model, [filter])
+    end
+
     it "paginates" do
       @service.should_receive(:do_http_post).with(@url,
         "PageNum=2&ResultsPerPage=20",

data/spec/quickeebooks/online/services/time_activity_spec.rb

@@ -0,0 +1,89 @@
+describe "Quickeebooks::Online::Service::TimeActivity" do
+  before(:all) do
+    construct_oauth_service :time_activity
+  end
+
+  it "can fetch a list of time activities" do
+    xml = onlineFixture("time_activities.xml")
+    url = @service.url_for_resource(Quickeebooks::Online::Model::TimeActivity.resource_for_collection)
+    FakeWeb.register_uri(:post, url, :status => ["200", "OK"], :body => xml)
+    time_activities = @service.list
+    time_activities.current_page.should == 1
+    time_activities.entries.count.should == 1
+    time_activities.entries.first.vendor.vendor_id.value.should == "3793"
+  end
+
+  it "can create a time activity" do
+    xml = onlineFixture("time_activity.xml")
+    url = @service.url_for_resource(Quickeebooks::Online::Model::TimeActivity.resource_for_singular)
+    FakeWeb.register_uri(:post, url, :status => ["200", "OK"], :body => xml)
+    time_activity = Quickeebooks::Online::Model::TimeActivity.new
+    time_activity.description = "here is my description"
+    time_activity.hourly_rate = "10.5"
+    time_activity.name_of = "Vendor"
+    time_activity.hours = 10
+    time_activity.customer_id = "3794"
+    time_activity.minutes = 5
+    result = @service.create(time_activity)
+    result.id.value.to_i.should > 0
+    result.vendor.is_a?(Quickeebooks::Online::Model::TimeActivityVendor)
+  end
+
+  it "can delete a time_activity" do
+    url = "#{@service.url_for_resource(Quickeebooks::Online::Model::TimeActivity.resource_for_singular)}/11?methodx=delete"
+    FakeWeb.register_uri(:post, url, :status => ["200", "OK"])
+    time_activity = Quickeebooks::Online::Model::TimeActivity.new
+    time_activity.id = Quickeebooks::Online::Model::Id.new("11")
+    time_activity.sync_token = 0
+    result = @service.delete(time_activity)
+    result.should == true
+  end
+
+  it "cannot delete a time_activity with missing required fields for deletion" do
+    time_activity = Quickeebooks::Online::Model::TimeActivity.new
+    expect { @service.delete(time_activity) }.to raise_exception(InvalidModelException, "Missing required parameters for delete")
+  end
+
+  it "exception is raised when we try to create an invalid time_activity" do
+    time_activity = Quickeebooks::Online::Model::TimeActivity.new
+    expect { @service.create(time_activity) }.to raise_exception InvalidModelException
+  end
+
+  it "cannot update an invalid time_activity" do
+    time_activity = Quickeebooks::Online::Model::TimeActivity.new
+    time_activity.name = "John Bilby"
+    expect { @service.update(time_activity) }.to raise_exception InvalidModelException
+  end
+
+  it "can fetch a time_activity by id" do
+    xml = onlineFixture("time_activity.xml")
+    url = "#{@service.url_for_resource(Quickeebooks::Online::Model::TimeActivity.resource_for_singular)}/11"
+    FakeWeb.register_uri(:get, url, :status => ["200", "OK"], :body => xml)
+    time_activity = @service.fetch_by_id(11)
+    time_activity.vendor.vendor_id.value.should == "3793"
+  end
+
+  it "can update a time_activity" do
+    xml2 = onlineFixture("time_activity2.xml")
+    time_activity = Quickeebooks::Online::Model::TimeActivity.new
+    time_activity.id = Quickeebooks::Online::Model::Id.new("1")
+    time_activity.sync_token = 2
+
+    url = "#{@service.url_for_resource(Quickeebooks::Online::Model::TimeActivity.resource_for_singular)}/#{time_activity.id.value}"
+    FakeWeb.register_uri(:post, url, :status => ["200", "OK"], :body => xml2)
+    updated = @service.update(time_activity)
+    updated.hours.should == 12
+    updated.minutes.should == 15
+  end
+
+  it 'Can update a fetched time_activity' do
+    xml = onlineFixture("time_activity.xml")
+    url = "#{@service.url_for_resource(Quickeebooks::Online::Model::TimeActivity.resource_for_singular)}/11"
+    FakeWeb.register_uri(:get, url, :status => ["200", "OK"], :body => xml)
+    time_activity = @service.fetch_by_id(11)
+    url = "#{@service.url_for_resource(Quickeebooks::Online::Model::TimeActivity.resource_for_singular)}/#{time_activity.id.value}"
+    FakeWeb.register_uri(:post, url, :status => ["200", "OK"], :body => xml)
+    updated = @service.update(time_activity)
+  end
+
+end

data/spec/quickeebooks/online/time_activity_spec.rb

@@ -0,0 +1,18 @@
+describe "Quickeebooks::Online::Model::TimeActivity" do
+
+  describe "parse time_activity from XML" do
+    xml = onlineFixture("time_activity.xml")
+    time_activity = Quickeebooks::Online::Model::TimeActivity.from_xml(xml)
+    time_activity.sync_token.should == 0
+    time_activity.hours.should == 10
+    time_activity.minutes.should == 5
+    time_activity.billable_status.should == "Billable"
+    time_activity.meta_data.create_time.year.should == Date.civil(2010, 9, 13).year
+    time_activity.name_of.is_a?(Quickeebooks::Online::Model::TimeActivityVendor)
+    time_activity.customer_id.should == "3794"
+    time_activity.vendor.vendor_id.value.should == "3793"
+
+  end
+
+
+end

data/spec/xml/online/employee.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<Employee xmlns="http://www.intuit.com/sb/cdm/v2" xmlns:ns2="http://www.intuit.com/sb/cdm/qbo">
+<Id>13</Id>
+<SyncToken>0</SyncToken>
+<MetaData>
+<CreateTime>2010-09-10T00:55:25-07:00</CreateTime>
+<LastUpdatedTime>2010-09-10T00:55:25-07:00</LastUpdatedTime>
+</MetaData>
+<Name>John Simpson</Name>
+<Address>
+<Line1>21215 Burbank Boulevard, Ste. 100</Line1>
+<Line2></Line2>
+<City>Woodland Hills</City>
+<CountrySubDivisionCode>CA</CountrySubDivisionCode>
+<PostalCode>91367</PostalCode>
+</Address>
+<Phone>
+<FreeFormNumber>(818) 936-7800</FreeFormNumber>
+</Phone>
+<Phone>
+<DeviceType>Mobile</DeviceType>
+<FreeFormNumber>(818) 436-8225</FreeFormNumber>
+</Phone>
+<Email>
+<Address>john.simpson@mint.com</Address>
+</Email>
+<GivenName>John</GivenName>
+<FamilyName>Simpson</FamilyName>
+<BillableTime>false</BillableTime>
+<HiredDate>9999-12-31-08:00</HiredDate>
+</Employee>

data/spec/xml/online/employee2.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<Employee xmlns="http://www.intuit.com/sb/cdm/v2" xmlns:ns2="http://www.intuit.com/sb/cdm/qbo">
+<Id>13</Id>
+<SyncToken>0</SyncToken>
+<MetaData>
+<CreateTime>2010-09-10T00:55:25-07:00</CreateTime>
+<LastUpdatedTime>2010-09-10T00:55:25-07:00</LastUpdatedTime>
+</MetaData>
+<Name>John Doe</Name>
+<Address>
+<Line1>21215 Burbank Boulevard, Ste. 100</Line1>
+<Line2></Line2>
+<City>Woodland Hills</City>
+<CountrySubDivisionCode>CA</CountrySubDivisionCode>
+<PostalCode>91367</PostalCode>
+</Address>
+<Phone>
+<FreeFormNumber>(818) 936-7800</FreeFormNumber>
+</Phone>
+<Phone>
+<DeviceType>Mobile</DeviceType>
+<FreeFormNumber>(818) 436-8225</FreeFormNumber>
+</Phone>
+<Email>
+<Address>john.simpson@mint.com</Address>
+</Email>
+<GivenName>John</GivenName>
+<FamilyName>Simpson</FamilyName>
+<BillableTime>false</BillableTime>
+<HiredDate>9999-12-31-08:00</HiredDate>
+</Employee>