quickbooks-ruby-base 1.5.0 → 1.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmVlZjM5YjNkN2ZiMjQ4YzcwN2I2YTY4YTZlNTkxYThmM2E5ZDVlZA==
+    ZDViYzQyNTdmNDE1NGQ5MDNiYWI0NzAzZGZiZTA2YmZkZjRiZmI5YQ==
   data.tar.gz: !binary |-
-    OTI4MzMzN2IxYWZjNDBiZGFkZmFlNmJhODJiYzg1ZDMxNDU0YzVjZg==
+    MWVjMmE3ODlmMDZhZWUyMzUyMWNjZDNjYjgyZDYzMjY4MGViY2RjYg==
 SHA512:
   metadata.gz: !binary |-
-    OWU1NmU0YmFjMmRkYjkyNzg2ZWM1ZGFjMWVjZGJlNjcwNzljMTg0MDc0OTZh
-    MmZjOGU0YWVhZTc3Nzk3MzA0ODYwZjNkZDFhZGFkYzI0ODBjOGYwZjUxYjY5
-    YmQ2NTQyNTliN2ZmMzE4NWE0Y2FkOGNiNDgyODhhNzE1NmIyZGY=
+    MGFlMjgyNTI3OTk5MzMzYjBjMzVhNmRhZTZkM2EzNGZmNTZkOWMwYmQwYTUw
+    ZGM4OGY4ZjIzYjg4MjIwZmVlZDY3OWVlZWU1MmFiMWYzMTA4M2Y4NjEzMDA1
+    ZmJlZWE0NmJlMTYyYTRlZGE2NGU2NmMyNWFhNzhhOWQ0OTdiM2E=
   data.tar.gz: !binary |-
-    N2VjZWY0OWJiYjQ3NGYyYzYyN2ZmMDRkOGJlYTE2NTEwZTdkNjIxMmU5YzM0
-    NTk0MzcyZTgyZWI1ZGRmM2JhYmQ5NWNhMzVlMTc0NjgxMDE4ZTY3N2ZiMTEz
-    MDNhMjQ1YTQxNGFlZDc0OWNhOTA4M2MxY2FkZDU0NzQzMGFmZTE=
+    NTc3NDI0NmUyNjkxZjM1MTA1ODE5OTdmNzQ3NzA0MzU1Nzc5MWVlZDAwYmQw
+    OTJiNWQ1YjEyNmYxMThkYjljY2U3MmVkY2FiZjBiZWUxMDEyM2I1ZTdhZDAw
+    ZDBlZTJhM2U5YTg2Nzg4N2E4NmQ0MDFiZTRhMGFhOWM0YTY4Njc=

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-version
+*.sess

data/README.md

@@ -68,6 +68,9 @@ base = Quickbooks::Base.new(account, :payment_method)
 # With options
 >> base.show page:1, per_page: 3
 => ["QBID: 5 DESC: American Express", "QBID: 1 DESC: Cash", "QBID: 2 DESC: Check"]
+# Show another entity
+>> base.show(entity: :vendor)
+=> ["QBID: 5 DESC: Hampton's Car Parts", "QBID: 6 DESC: Good Eats", "QBID: 7 DESC: The Flower Shoppe"]
 
 ```
 
@@ -76,6 +79,8 @@ Convenience method to fetch an entity by its reference id
 ```
 base = Quickbooks::Base.new(account, :customer)
 >> base.find_by_id(1)
+# Second argument to find Employee with id = 55
+>> base.find_by_id(55, :employee)
 ```
   
 ### find_by_display_name()
@@ -87,6 +92,13 @@ base = Quickbooks::Base.new(account, :customer)
 # Generates a query based on the following SQL
 # "SELECT Id, DisplayName FROM Customer WHERE DisplayName = 'Chuck Russell'"
 ```
+#### with options
+```
+base = Quickbooks::Base.new(account)
+>> base.find_by_display_name("Jonnie O'Meara", entity: :vendor, select: '*')
+# Generates a query based on the following SQL
+# "SELECT * FROM Vendor WHERE DisplayName = 'Jonnie O\\'Meara'"
+```
 
 ## Configuration
 

data/lib/quickbooks/base.rb

@@ -13,8 +13,12 @@ module Quickbooks
       create_service_for(type) if type
     end
 
+    def qbo_case(type)
+      type.is_a?(Symbol) ? type.to_s.camelcase : type
+    end
+
     def generate_quickbooks_ruby_namespace(type, variety = 'Model')
-      type = type.is_a?(Symbol) ? type.to_s.camelcase : type
+      type = qbo_case(type)
       "Quickbooks::#{variety}::#{type}"
     end
 
@@ -34,23 +38,25 @@ module Quickbooks
 
     def show(options = {})
       options = { per_page: 20, page: 1 }.merge(options)
-      @service.query(nil, options).entries.collect do |e|
+      service = determine_service(options[:entity])
+      service.query(nil, options).entries.collect do |e|
         "QBID: #{e.id} DESC: #{description(e)}"
       end
     end
 
     def description(e)
-      desc = (method = describing_method) =~ /(total)/ ? e.send(method).to_f : e.send(method)
+      desc = (method = describing_method(e)) =~ /(total)/ ? e.send(method).to_f : e.send(method)
     rescue => e
       'nil'
     end
 
-    def entity
-      @service.class.name.split('::').last
+    def entity(obj = nil)
+      obj ||= @service
+      obj.class.name.split('::').last
     end
 
-    def describing_method
-      case entity
+    def describing_method(e)
+      case entity(e)
       when /(Item|TaxCode|PaymentMethod|Account)/
         'name'
       when /(Invoice|CreditMemo)/
@@ -82,15 +88,23 @@ module Quickbooks
       send_chain(arr)
     end
 
+    def service_for(type)
+      service = quickbooks_ruby_service(type)
+      service.access_token = oauth_client
+      service.company_id = company_id
+      service
+    end
+
     def create_service_for(type)
-      @service = quickbooks_ruby_service(type)
-      @service.access_token = oauth_client
-      @service.company_id = company_id
-      @service
+      @service = service_for(type)
     end
 
     private
 
+    def determine_service(entity)
+      entity ? service_for(entity) : @service
+    end
+
     def send_chain(arr)
       arr.inject(@account) {|o, a| o.send(a) }
     end

data/lib/quickbooks/base/finders.rb

@@ -2,8 +2,13 @@ module Quickbooks
   class Base
     module Finders
 
-      def find_by_id(id)
-        @service.fetch_by_id(id)
+      def find_by_id(id, model = nil)
+        if model
+          new_service = service_for(model)
+          new_service.fetch_by_id(id)
+        else
+          @service.fetch_by_id(id)
+        end
       end
 
       def qbuilder
@@ -13,7 +18,7 @@ module Quickbooks
       def sql_builder(where, options = {})
         options[:entity] ||= entity
         options[:select] ||= '*'
-        "SELECT #{options[:select]} FROM #{options[:entity]} WHERE #{where}"
+        "SELECT #{options[:select]} FROM #{qbo_case(options[:entity])} WHERE #{where}"
       end
 
       def display_name_sql(display_name, options = {})
@@ -24,7 +29,8 @@ module Quickbooks
 
       def find_by_display_name(display_name, options = {})
         sql = display_name_sql(display_name, options)
-        @service.query(sql)
+        service = determine_service(options[:entity])
+        service.query(sql)
       end
     end
   end

data/quickbooks-ruby-base.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'quickbooks-ruby-base'
-  spec.version       = '1.5.0'
+  spec.version       = '1.6.0'
   spec.authors       = ["Christian"]
   spec.email         = ["christian@minimul.com"]
   spec.summary       = %q{Base class to provide common methods for the quickbooks-ruby gem}

data/spec/fixtures/customer_2.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<IntuitResponse xmlns="http://schema.intuit.com/finance/v3" time="2015-08-12T12:29:53.867-07:00">
+  <Customer domain="QBO" sparse="false">
+    <Id>2</Id>
+    <SyncToken>0</SyncToken>
+    <MetaData>
+      <CreateTime>2015-06-24T16:49:28-07:00</CreateTime>
+      <LastUpdatedTime>2015-07-01T12:56:01-07:00</LastUpdatedTime>
+    </MetaData>
+    <GivenName>Bill</GivenName>
+    <FamilyName>Lucchini</FamilyName>
+    <FullyQualifiedName>Bill's Windsurf Shop</FullyQualifiedName>
+    <CompanyName>Bill's Windsurf Shop</CompanyName>
+    <DisplayName>Bill's Windsurf Shop</DisplayName>
+    <PrintOnCheckName>Bill's Windsurf Shop</PrintOnCheckName>
+    <Active>true</Active>
+    <PrimaryPhone>
+      <FreeFormNumber>(415) 444-6538</FreeFormNumber>
+    </PrimaryPhone>
+    <PrimaryEmailAddr>
+      <Address>Surf@Intuit.com</Address>
+    </PrimaryEmailAddr>
+    <Taxable>false</Taxable>
+    <BillAddr>
+      <Id>3</Id>
+      <Line1>12 Ocean Dr.</Line1>
+      <City>Half Moon Bay</City>
+      <CountrySubDivisionCode>CA</CountrySubDivisionCode>
+      <PostalCode>94213</PostalCode>
+      <Lat>37.4307072</Lat>
+      <Long>-122.4295234</Long>
+    </BillAddr>
+    <Job>false</Job>
+    <BillWithParent>false</BillWithParent>
+    <Balance>85.00</Balance>
+    <BalanceWithJobs>85.00</BalanceWithJobs>
+    <PreferredDeliveryMethod>Print</PreferredDeliveryMethod>
+  </Customer>
+</IntuitResponse>

data/spec/fixtures/employee_55.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<IntuitResponse xmlns="http://schema.intuit.com/finance/v3" time="2015-08-12T12:45:49.202-07:00">
+  <Employee domain="QBO" sparse="false">
+    <Id>55</Id>
+    <SyncToken>0</SyncToken>
+    <MetaData>
+      <CreateTime>2015-06-30T11:21:48-07:00</CreateTime>
+      <LastUpdatedTime>2015-06-30T11:21:48-07:00</LastUpdatedTime>
+    </MetaData>
+    <GivenName>Emily</GivenName>
+    <FamilyName>Platt</FamilyName>
+    <DisplayName>Emily Platt</DisplayName>
+    <PrintOnCheckName>Emily Platt</PrintOnCheckName>
+    <Active>true</Active>
+    <BillableTime>false</BillableTime>
+  </Employee>
+</IntuitResponse>

data/spec/fixtures/item_5.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<IntuitResponse xmlns="http://schema.intuit.com/finance/v3" time="2015-08-12T08:05:03.899-07:00">
+<Item domain="QBO" sparse="false">
+  <Id>5</Id>
+  <SyncToken>2</SyncToken>
+  <MetaData>
+    <CreateTime>2015-06-29T10:42:19-07:00</CreateTime>
+    <LastUpdatedTime>2015-07-02T13:16:17-07:00</LastUpdatedTime>
+  </MetaData>
+  <Name>Rock Fountain</Name>
+  <Description>Rock Fountain</Description>
+  <Active>true</Active>
+  <FullyQualifiedName>Rock Fountain</FullyQualifiedName>
+  <Taxable>true</Taxable>
+  <UnitPrice>275</UnitPrice>
+  <Type>Inventory</Type>
+  <IncomeAccountRef name="Sales of Product Income">79</IncomeAccountRef>
+  <PurchaseDesc>Rock Fountain</PurchaseDesc>
+  <PurchaseCost>125</PurchaseCost>
+  <ExpenseAccountRef name="Cost of Goods Sold">80</ExpenseAccountRef>
+  <AssetAccountRef name="Inventory Asset">81</AssetAccountRef>
+  <TrackQtyOnHand>true</TrackQtyOnHand>
+  <QtyOnHand>2</QtyOnHand>
+  <InvStartDate>2015-07-02</InvStartDate>
+</Item>
+</IntuitResponse>

data/spec/quickbooks_ruby_base_spec.rb

@@ -57,6 +57,14 @@ describe Quickbooks::Base do
       expect(qr.show.last).to match /100\.0/
     end
 
+    it "display another entity using the entity options" do
+      xml = read_fixture('payments')
+      stub_response(xml)
+      qr = Quickbooks::Base.new(full_account, :invoice)
+      expect(qr.show).to be_empty
+      expect(qr.show(entity: :payment).last).to match /100\.0/
+    end
+
     it "description should display 'nil' as no description fits" do
       pending 'Need to find a transaction or name entity that does not match txn_date'
       xml = read_fixture('dummy')
@@ -103,8 +111,8 @@ describe Quickbooks::Base do
   describe ".create_service_for" do
     it "creates a access_token service" do
       qb = Quickbooks::Base.new(full_account)
-      service = qb.create_service_for :access_token
-      expect(service.class.name).to match /Service::AccessToken/
+      qb.create_service_for :access_token
+      expect(qb.service.class.name).to match /Service::AccessToken/
     end
   end
 
@@ -116,6 +124,14 @@ describe Quickbooks::Base do
       result = qr.find_by_id(28)
       expect(result.id).to eq 156
     end
+
+    it 'grabs object from different entity' do
+      xml = read_fixture('item_5') 
+      stub_response(xml)
+      qr = Quickbooks::Base.new(full_account)
+      result = qr.find_by_id(5, :item)
+      expect(result.id).to eq 5
+    end
   end
 
   describe ".display_name_sql" do
@@ -125,9 +141,27 @@ describe Quickbooks::Base do
     end
 
     it 'for custom usage' do
-      qr = Quickbooks::Base.new(full_account, :customer)
-      sql = qr.display_name_sql('Chuck Russell', entity: 'Vendor', select: '*')
-      expect(sql).to eq "SELECT * FROM Vendor WHERE DisplayName = 'Chuck Russell'"
+      qr = Quickbooks::Base.new(full_account)
+      sql = qr.display_name_sql("Jonnie O'Meara", entity: :vendor, select: '*')
+      expect(sql).to eq "SELECT * FROM Vendor WHERE DisplayName = 'Jonnie O\\'Meara'"
+    end
+  end
+
+  describe ".find_by_display_name" do
+    it 'use entity on initialization' do
+      xml = read_fixture('employee_55') 
+      stub_response(xml)
+      qr = Quickbooks::Base.new(full_account, :employee)
+      result = qr.find_by_display_name("Emily Platt")
+      expect(result.first.id).to eq 55
+    end
+
+    it 'passing in the entity' do
+      xml = read_fixture('customer_2') 
+      stub_response(xml)
+      qr = Quickbooks::Base.new(full_account)
+      result = qr.find_by_display_name("Bill's Windsurf Shop", entity: :customer)
+      expect(result.first.id).to eq 2
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickbooks-ruby-base
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Christian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-04 00:00:00.000000000 Z
+date: 2015-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: quickbooks-ruby
@@ -83,9 +83,12 @@ files:
 - lib/quickbooks/base/configuration.rb
 - lib/quickbooks/base/finders.rb
 - quickbooks-ruby-base.gemspec
+- spec/fixtures/customer_2.xml
 - spec/fixtures/dummy.xml
+- spec/fixtures/employee_55.xml
 - spec/fixtures/invoice.xml
 - spec/fixtures/invoices.xml
+- spec/fixtures/item_5.xml
 - spec/fixtures/payments.xml
 - spec/fixtures/tax_codes.xml
 - spec/fixtures/vendors.xml
@@ -116,9 +119,12 @@ signing_key:
 specification_version: 4
 summary: Base class to provide common methods for the quickbooks-ruby gem
 test_files:
+- spec/fixtures/customer_2.xml
 - spec/fixtures/dummy.xml
+- spec/fixtures/employee_55.xml
 - spec/fixtures/invoice.xml
 - spec/fixtures/invoices.xml
+- spec/fixtures/item_5.xml
 - spec/fixtures/payments.xml
 - spec/fixtures/tax_codes.xml
 - spec/fixtures/vendors.xml