quickeebooks 0.1.2 → 0.1.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    quickeebooks (0.1.1)
+    quickeebooks (0.1.2)
       activemodel
       nokogiri
       oauth
@@ -11,21 +11,20 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.2.6)
-      activesupport (= 3.2.6)
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
       builder (~> 3.0.0)
-    activesupport (3.2.6)
+    activesupport (3.2.12)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    builder (3.0.0)
+    builder (3.0.4)
     diff-lcs (1.1.3)
     fakeweb (1.3.0)
-    i18n (0.6.0)
-    multi_json (1.3.6)
-    nokogiri (1.5.5)
-    oauth (0.4.6)
-    rake (0.9.2.2)
-    rcov (0.9.11)
+    i18n (0.6.1)
+    multi_json (1.6.1)
+    nokogiri (1.5.6)
+    oauth (0.4.7)
+    rake (10.0.3)
     roxml (3.3.1)
       activesupport (>= 2.3.0)
       nokogiri (>= 1.3.3)
@@ -34,11 +33,15 @@ GEM
       rspec-core (~> 2.11.0)
       rspec-expectations (~> 2.11.0)
       rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.0)
-    rspec-expectations (2.11.1)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.1)
-    uuidtools (2.1.2)
+    rspec-mocks (2.11.3)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    uuidtools (2.1.3)
 
 PLATFORMS
   ruby
@@ -47,6 +50,6 @@ DEPENDENCIES
   fakeweb
   quickeebooks!
   rake
-  rcov (~> 0.9.8)
   rr (~> 1.0.2)
   rspec (= 2.11.0)
+  simplecov

data/README.md

@@ -9,6 +9,8 @@ This library communicates with the Quickbooks Data Services `v2` API, documented
 When Intuit finalizes the `v3` API I would like to move to that version as it appears to be better structured
 and has `JSON` request/response formats, which should be easier to work with than XML.
 
+[![Build Status](https://travis-ci.org/ruckus/quickeebooks.png)](https://travis-ci.org/ruckus/quickeebooks)
+
 ## Requirements
 
 This is being developed on Ruby 1.9.2. Other versions/VMs are untested but Ruby 1.8 should work in theory.
@@ -89,7 +91,7 @@ oauth_client = OAuth::AccessToken.new($qb_oauth_consumer, access_token, access_s
 
 ## Quickbooks Online vs Windows
 
-IDS provides 2 APIs, one for interacting with Quickbooks Online resources and one for Quickbooks Windows resources. 
+IDS provides 2 APIs, one for interacting with Quickbooks Online resources and one for Quickbooks Windows resources.
 
 See: https://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0050_Data_Services
 
@@ -102,13 +104,13 @@ For example:
 customer_service = Quickeebooks::Online::Service::Customer.new
 customer_service.access_token = oauth_client
 customer_service.realm_id = realm_id
-customer_service.list 
+customer_service.list
 
 # Instantiate a Windows API
 customer_service = Quickeebooks::Windows::Service::Customer.new(oauth_client, realm_id)
 customer_service.access_token = oauth_client
 customer_service.realm_id = realm_id
-customer_service.list 
+customer_service.list
 ```
 
 All of the documentation below is geared towards the Online flavor but unless noted one should be able to replace it with Windows.
@@ -119,8 +121,8 @@ Now we can initialize any of the `Service` clients:
 customer_service = Quickeebooks::Online::Service::Customer.new
 customer_service.access_token = oauth_client
 customer_service.realm_id = realm_id
-customer_service.list 
-customer_service.list 
+customer_service.list
+customer_service.list
 
 # returns a `Collection` object
 ```
@@ -156,7 +158,7 @@ Specify none of these to get the defaults:
 customer_service = Quickeebooks::Online::Service::Customer.new
 customer_service.access_token = oauth_client
 customer_service.realm_id = realm_id
-customer_service.list 
+customer_service.list
 
 # fetch all customers with default parameters (pagination, sorting, filtering)
 customers = customer_service.list
@@ -164,13 +166,17 @@ customers = customer_service.list
 
 Return result: a `Collection` instance with properties: `entries`, `current_page`, `count` which should be self-explanatory.
 
-### Filtering (currently only supported in the Online API)
+### Filtering (full Online API support, partial Windows API support)
+
+For Online, all filters in the Intuit documentation are supported: text, datetime, boolean.
 
-All filters in the Intuit documentation are supported: text, datetime, boolean.
+For Windows, Intuit has a custom API for certain query fields: you cannot search on an arbitrary attributes. See https://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0050_Data_Services/0500_QuickBooks_Windows/0100_Calling_Data_Services/0015_Retrieving_Objects#Filtering for more information, and to see which attributes are queryable, see: https://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0050_Data_Services/0500_QuickBooks_Windows/0600_Object_Reference/Invoice#section_9
 
-Construct an instance of `Quickeebooks::Online::Service::Filter` with the type of filter, one of: `:text`, `:datetime`, `:boolean`.
+Note: you'll get an exception from Intuit if you attempt to query on a non-queryable attribute.
 
-Pass an array of `Quickeebooks::Online::Service::Filter` objects as the first argument to the Services `list` method and all filters will be applied.
+Construct an instance of `Quickeebooks::Shared::Service::Filter` with the type of filter, one of: `:text`, `:datetime`, `:boolean`.
+
+Pass an array of `Quickeebooks::Shared::Service::Filter` objects as the first argument to the Services `list` method and all filters will be applied.
 
 #### Filtering on a text field
 
@@ -179,7 +185,7 @@ Specify a type of `:text` and your desired `:field` and a `:value` clause which
 Note: the Intuit API is case-INSENSITIVE.
 
 ```ruby
-Quickeebooks::Online::Service::Filter.new(:text, :field => 'FamilyName', :value => 'Richards')
+Quickeebooks::Shared::Service::Filter.new(:text, :field => 'FamilyName', :value => 'Richards')
 ```
 
 #### Filtering on a Date/Time
@@ -191,16 +197,16 @@ Examples:
 ```ruby
 # find all customers created after 2/15/2011
 datetime = Time.mktime(2011, 2, 15)
-Quickeebooks::Online::Service::Filter.new(:datetime, :field => 'CreateTime', :after => datetime)
+Quickeebooks::Shared::Service::Filter.new(:datetime, :field => 'CreateTime', :after => datetime)
 
 # find all customers created before 3/28/2011
 datetime = Time.mktime(2011, 2, 28)
-Quickeebooks::Online::Service::Filter.new(:datetime, :field => 'CreateTime', :before => datetime)
+Quickeebooks::Shared::Service::Filter.new(:datetime, :field => 'CreateTime', :before => datetime)
 
 # find all customers created between 1/1/2011 and 2/15/2011
 after = Time.mktime(2011, 1, 1)
 before = Time.mktime(2011, 2, 15
-Quickeebooks::Online::Service::Filter.new(:datetime, :field => 'CreateTime', :after => after, :before => before)
+Quickeebooks::Shared::Service::Filter.new(:datetime, :field => 'CreateTime', :after => after, :before => before)
 ```
 
 #### Filtering on a Boolean field
@@ -209,7 +215,7 @@ Specify a type of `:boolean` and your desired `:field` and a `:value` with eithe
 
 ```ruby
 # find all customers and exclude jobs
-Quickeebooks::Online::Service::Filter.new(:boolean, :field => 'IncludeJobs', :value => false)
+Quickeebooks::Shared::Service::Filter.new(:boolean, :field => 'IncludeJobs', :value => false)
 ```
 
 #### Filtering on a Number
@@ -218,7 +224,7 @@ Specify a type of `:number` and an operator, one of: `:gt`, `:lt`, or `:eq`.
 
 ```ruby
 # find all customers and exclude jobs
-Quickeebooks::Online::Service::Filter.new(:number, :field => 'Amount', :gt => 150)
+Quickeebooks::Shared::Service::Filter.new(:number, :field => 'Amount', :gt => 150)
 ```
 
 Once you have created all of your `Filters` than just pass an array of them to any services `list` method and they will all be applied.
@@ -233,7 +239,7 @@ filters << Quickeebooks::Online::Service::Filter.new(:datetime, :field => 'Creat
 customer_service = Quickeebooks::Online::Service::Customer.new
 customer_service.access_token = oauth_client
 customer_service.realm_id = realm_id
-customer_service.list 
+customer_service.list
 
 customers = customer_service.list(filters)
 ```
@@ -266,19 +272,19 @@ sorter = Quickeebooks::Online::Service::Sort.new('FamilyName', 'AtoZ')
 customer_service = Quickeebooks::Online::Service::Customer.new
 customer_service.access_token = oauth_client
 customer_service.realm_id = realm_id
-customer_service.list 
+customer_service.list
 
 customers = customer_service.list(filters, 1, 30, sort)
 
 # returns
- 
+
 customers.count
 => 67
 
 customers.current_page
 => 1
 
-customers.entries 
+customers.entries
 => [ #<Quickeebooks::Online::Model::Customer:0x007f8e29259770>, #<Quickeebooks::Online::Model::Customer:0x0078768202020>, ... ]
 ```
 
@@ -291,7 +297,7 @@ Use the `Service` instance to fetch an object by its id using the `fetch_by_id`
 customer_service = Quickeebooks::Online::Service::Customer.new
 customer_service.access_token = oauth_client
 customer_service.realm_id = realm_id
-customer_service.list 
+customer_service.list
 
 customer = customer_service.fetch_by_id(100)
 customer.name
@@ -312,7 +318,7 @@ Pass an instance of your object to the `create` method on its related Service:
 customer_service = Quickeebooks::Online::Service::Customer.new
 customer_service.access_token = oauth_client
 customer_service.realm_id = realm_id
-customer_service.list 
+customer_service.list
 
 customer = Quickeebooks::Online::Model::Customer.new
 customer.name = "Richard Parker"
@@ -330,7 +336,7 @@ Pass an instance of your object to the `update` method on its related Service:
 customer_service = Quickeebooks::Online::Service::Customer.new
 customer_service.access_token = oauth_client
 customer_service.realm_id = realm_id
-customer_service.list 
+customer_service.list
 
 customer = customer_service.fetch_by_id(100)
 customer.name = "Richard Parker"