quickbooks-ruby-base 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTQ4YTRkMzhlOWMyMGZhNWEzNDVhNTY0ZjM1Zjc5ZGU0NTkyZGY3Yg==
+  data.tar.gz: !binary |-
+    MjU3N2RjMDgyNzE5ODEzMjMwNTYzODY3ZWM0NzY4N2UxYjAyZDcwZQ==
+SHA512:
+  metadata.gz: !binary |-
+    MjcxODk1NDAxMzMzMTRlOGJhNzMwZWI4ZDM0NzlkMWM0Yzc4Y2M5YTE2YTdh
+    OWEwZmFlZTRmNjNhMjkzZjNmYzk1NTBjNDQ0YmJhNTIwODFhMGM1Yzg2NGVj
+    YmU5Mzk0ZTdjNjhlOWExMTViMmFlNDljMGZkYTBjNTM0NDg1NDI=
+  data.tar.gz: !binary |-
+    MzllMDg1NGFhOGRkNmE5MjMwZDRjNDE2Mjc4ZjFkMmU4YTY0MGFhMDNjMWVi
+    M2RmMTJiOGM3ODE2MzY4ZTI4NWRmNDJjMzg1ODI0Zjg2ZjM5ZDcxYWJiNWZl
+    ZjYyMDdjZWIwOTQwMTgxMWMxZjhhZjRlMjIzM2UxZmQyMWNlNzU=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in quickbooks-ruby-base.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Christian
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,138 @@
+# Quickbooks::Base
+
+A gem to complement the [`quickbooks-ruby`](https://github.com/ruckus/quickbooks-ruby) gem by providing a base class to handle routine tasks like creating a model, service, and displaying information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'quickbooks-ruby-base'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quickbooks-ruby-base
+
+## Usage
+1. The first argument is required and is a persistent object holding Intuit OAuth information (see Configuration section). 
+2. The second argument is optional but if passed must be a valid `quickbooks-ruby` service type such as Invoice, Customer, Item, PaymentMethod, etc. When passing in a symbol, snake case must be used e.g. `:payment_method`. If a string you must use the explicit name, e.g. 'PaymentMethod'
+```
+def initialize(account, type = nil)      
+  @account = account
+  create_service_for(type) if type
+end
+```
+
+### qr_model(*args)
+Generate a `quickbooks-ruby` model. First argument must be valid `quickbooks-ruby` model.
+```
+>> base = Quickbooks::Base.new(account)
+>> customer = base.qr_model(:customer) 
+
+# Accepts more than 1 argument e.g.
+>> base = Quickbooks::Base.new(account)
+>> qb_invoice = base.qr_model :invoice
+>> qb_invoice.bill_email = base.qr_model(:email_address, invoice.customer.email)
+```
+
+### service()
+Returns `quickbooks-ruby` service.
+```
+>> base = Quickbooks::Base.new(account, :customer)
+>> base.service
+=> #<Quickbooks::Service::Customer:0x007faf7fe3f130 @base_uri="https://qb.sbfinance.intuit.com/v3/company", .etc
+>> customer = base.qr_model(:customer) 
+>> customer.display_name = 'Minimul X'
+# Do a create
+>> base.service.create(customer)
+# Or an update
+>> base.service.update(customer)
+# Execute a query
+>> base.service.query('SELECT * FROM INVOICES')
+```
+
+### show(options = {})
+Returns an array of the QuickBooks' IDs and a "smart" description. Smart, meaning that different services have different identifiers. For a customer, employee, and vendor the `DESC` is `display_name`. For invoice, it is `doc_number`. For item, tax_code, and payment_method it is the `name`. 
+```
+base = Quickbooks::Base.new(account, :invoice)
+>> base.service.create(qb_invoice)
+# Returns an array of payment_methods from QBO account
+base = Quickbooks::Base.new(account, :payment_method)
+>> base.show
+# Returns an array of payment_methods from QBO account
+>> b.show
+=> ["QBID: 5 DESC: American Express", "QBID: 1 DESC: Cash", "QBID: 2 DESC: Check", "QBID: 6 DESC: Diners Club", "QBID: 7 DESC: Discover", "QBID: 4 DESC: MasterCard", "QBID: 3 DESC: Visa"]
+# With options
+>> b.show page:1, per_page: 3
+=> ["QBID: 5 DESC: American Express", "QBID: 1 DESC: Cash", "QBID: 2 DESC: Check"]
+
+```
+
+## Configuration
+
+As the first argument, the `Quickbooks::Base` class expects a persistent object that holds OAuth connection information.
+
+For example, if an account's OAuth information is stored like this:
+```
+account.qb_token
+account.qb_secret
+account.qb_company_id
+```
+
+Your `Quickbooks::Base` configuration would look like this.
+
+```
+
+QB_KEY = ENV['MINIMULCASTS_CONSUMER_KEY']
+QB_SECRET = ENV['MINIMULCASTS_CONSUMER_SECRET']
+
+$qb_oauth_consumer = OAuth::Consumer.new(QB_KEY, QB_SECRET, {
+    :site                 => "https://oauth.intuit.com",
+    :request_token_path   => "/oauth/v1/get_request_token",
+    :authorize_url        => "https://appcenter.intuit.com/Connect/Begin",
+    :access_token_path    => "/oauth/v1/get_access_token"
+})
+
+Quickbooks::Base.configure do |c|
+  c.persistent_token = 'qb_token'
+  c.persistent_secret = 'qb_secret'
+  c.persistent_company_id = 'qb_company_id'
+end
+
+```
+
+### Configuration defaults
+```
+p Quickbooks::Base.persistent_token
+# "settings.qb_token"
+p Quickbooks::Base.persistent_secret
+# "settings.qb_secret"
+p Quickbooks::Base.persistent_company_id
+# "settings.qb_company_id"
+```
+By default `quickbooks-base-ruby` uses the `$qb_oauth_consumer` global var but can be overridden e.g.:
+
+```
+$intuit_oauth_consumer = OAuth::Consumer.new(QB_KEY, QB_SECRET, {
+    :site                 => "https://oauth.intuit.com",
+    :request_token_path   => "/oauth/v1/get_request_token",
+    :authorize_url        => "https://appcenter.intuit.com/Connect/Begin",
+    :access_token_path    => "/oauth/v1/get_access_token"
+})
+
+Quickbooks::Base.configure do |c|
+  c.oauth_consumer = $intuit_oauth_consumer
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/quickbooks-ruby-base/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create a spec to test your feature.
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/quickbooks/base/configuration.rb

@@ -0,0 +1,29 @@
+module Quickbooks
+  class Base
+    module Configuration
+      def configure
+        yield self
+      end
+
+      def oauth_consumer=(var)
+        @oauth_consumer = var
+      end
+
+      def oauth_consumer
+        @oauth_consumer ||= $qb_oauth_consumer
+      end
+
+      %w(token secret company_id).each do |type|
+        class_eval <<-eos
+          def persistent_#{type}=(location)
+            @persistent_#{type} = location
+          end
+
+          def persistent_#{type}
+            @persistent_#{type} ||= 'settings.qb_#{type}'
+          end
+        eos
+      end
+    end
+  end
+end

data/lib/quickbooks/base.rb

@@ -0,0 +1,82 @@
+require 'quickbooks-ruby'
+require_relative 'base/configuration'
+
+module Quickbooks
+  class Base
+    attr_reader :service
+    extend Configuration
+
+    def initialize(account, type = nil)
+      @account = account
+      create_service_for(type) if type
+    end
+
+    def generate_quickbooks_ruby_namespace(which, type = 'Model')
+      which = which.to_s.camelcase if which.is_a?(Symbol)
+      "Quickbooks::#{type}::#{which}"
+    end
+
+    def quickbooks_ruby_model(which, *args)
+      generate_quickbooks_ruby_namespace(which, 'Model').constantize.new(*args)
+    end
+    alias_method :qr_model, :quickbooks_ruby_model
+
+    def quickbooks_ruby_service(which)
+      generate_quickbooks_ruby_namespace(which, 'Service').constantize.new
+    end
+    alias_method :qr_service, :quickbooks_ruby_service
+
+    def oauth_client
+      @oauth_client ||= OAuth::AccessToken.new(Quickbooks::Base.oauth_consumer, token, secret)
+    end
+
+    def show(options = {})
+      options = { per_page: 20, page: 1 }.merge(options)
+      method = describing_method
+      @service.query(nil, options).entries.collect { |e| "QBID: #{e.id} DESC: #{e.send(method) if method}" }
+    end
+
+    def describing_method
+      case @service.class.name
+      when /(Item|TaxCode|PaymentMethod)/
+        'name'
+      when /(Invoice|Payment)/
+        'doc_number'
+      when /(Vendor|Customer|Employee)/
+        'display_name'
+      end
+    end
+
+    def token
+      retrieve(:token)
+    end
+
+    def secret
+      retrieve(:secret)
+    end
+
+    def company_id
+      retrieve(:company_id)
+    end
+
+    def retrieve(type)
+      meth = "persistent_#{type}"
+      arr = Quickbooks::Base.send(meth).split('.')
+      send_chain(arr)
+    end
+
+    def create_service_for(type)
+      @service = quickbooks_ruby_service(type)
+      @service.access_token = oauth_client
+      @service.company_id = company_id
+      @service
+    end
+
+    private
+
+    def send_chain(arr)
+      arr.inject(@account) {|o, a| o.send(a) }
+    end
+
+  end
+end

data/lib/quickbooks-ruby-base.rb

@@ -0,0 +1 @@
+require_relative 'quickbooks/base'

data/quickbooks-ruby-base.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'quickbooks-ruby-base'
+  spec.version       = '1.0.0'
+  spec.authors       = ["Christian"]
+  spec.email         = ["christian@minimul.com"]
+  spec.summary       = %q{Base class to provide common methods for the quickbooks-ruby gem}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/minimul/quickbooks-ruby-base"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep %r{^spec/}
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'quickbooks-ruby'
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+end

data/spec/fixtures/invoices.xml

@@ -0,0 +1,152 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<IntuitResponse xmlns="http://schema.intuit.com/finance/v3" time="2014-04-04T04:52:19.963-07:00">
+  <QueryResponse startPosition="1" maxResults="20" totalCount="20">
+    <Invoice domain="QBO" sparse="false">
+      <Id>29</Id>
+      <SyncToken>0</SyncToken>
+      <MetaData>
+        <CreateTime>2014-04-01T08:19:48-07:00</CreateTime>
+        <LastUpdatedTime>2014-04-01T08:19:48-07:00</LastUpdatedTime>
+      </MetaData>
+      <DocNumber>1234</DocNumber>
+      <TxnDate>2014-04-01</TxnDate>
+      <Line>
+        <Id>1</Id>
+        <LineNum>1</LineNum>
+        <Description>Some big thingy</Description>
+        <Amount>64.99</Amount>
+        <DetailType>SalesItemLineDetail</DetailType>
+        <SalesItemLineDetail>
+          <ItemRef name="Services">1</ItemRef>
+          <UnitPrice>64.99</UnitPrice>
+          <Qty>1</Qty>
+          <TaxCodeRef>TAX</TaxCodeRef>
+        </SalesItemLineDetail>
+      </Line>
+      <Line>
+        <Id>2</Id>
+        <LineNum>2</LineNum>
+        <Description>Some big thingy</Description>
+        <Amount>64.99</Amount>
+        <DetailType>SalesItemLineDetail</DetailType>
+        <SalesItemLineDetail>
+          <ItemRef name="Services">1</ItemRef>
+          <UnitPrice>64.99</UnitPrice>
+          <Qty>1</Qty>
+          <TaxCodeRef>TAX</TaxCodeRef>
+        </SalesItemLineDetail>
+      </Line>
+      <Line>
+        <Amount>129.98</Amount>
+        <DetailType>SubTotalLineDetail</DetailType>
+        <SubTotalLineDetail/>
+      </Line>
+      <TxnTaxDetail>
+        <TxnTaxCodeRef>2</TxnTaxCodeRef>
+        <TotalTax>0</TotalTax>
+        <TaxLine>
+          <Amount>0</Amount>
+          <DetailType>TaxLineDetail</DetailType>
+          <TaxLineDetail>
+            <TaxRateRef>1</TaxRateRef>
+            <PercentBased>true</PercentBased>
+            <TaxPercent>10</TaxPercent>
+            <NetAmountTaxable>129.98</NetAmountTaxable>
+          </TaxLineDetail>
+        </TaxLine>
+      </TxnTaxDetail>
+      <CustomerRef name="(empty)">6</CustomerRef>
+      <BillAddr>
+        <Id>3</Id>
+        <Line1>123 darkwing road</Line1>
+        <Line2>RT 101</Line2>
+        <City>Rockingham</City>
+        <CountrySubDivisionCode>NH</CountrySubDivisionCode>
+        <PostalCode>10002</PostalCode>
+        <Lat>40.7135097</Lat>
+        <Long>-73.9859414</Long>
+      </BillAddr>
+      <DueDate>2014-04-01</DueDate>
+      <TotalAmt>129.98</TotalAmt>
+      <ApplyTaxAfterDiscount>false</ApplyTaxAfterDiscount>
+      <PrintStatus>NeedToPrint</PrintStatus>
+      <EmailStatus>NotSet</EmailStatus>
+      <BillEmail>
+        <Address>john@doe.com</Address>
+      </BillEmail>
+      <Balance>129.98</Balance>
+      <Deposit>0</Deposit>
+      <AllowIPNPayment>false</AllowIPNPayment>
+      <AllowOnlinePayment>false</AllowOnlinePayment>
+      <AllowOnlineCreditCardPayment>false</AllowOnlineCreditCardPayment>
+      <AllowOnlineACHPayment>false</AllowOnlineACHPayment>
+    </Invoice>
+    <Invoice domain="QBO" sparse="false">
+      <Id>28</Id>
+      <SyncToken>0</SyncToken>
+      <MetaData>
+        <CreateTime>2014-04-01T07:04:10-07:00</CreateTime>
+        <LastUpdatedTime>2014-04-01T07:04:10-07:00</LastUpdatedTime>
+      </MetaData>
+      <DocNumber>1234</DocNumber>
+      <TxnDate>2014-04-01</TxnDate>
+      <Line>
+        <Id>1</Id>
+        <LineNum>1</LineNum>
+        <Description>Some big thingy</Description>
+        <Amount>64.99</Amount>
+        <DetailType>SalesItemLineDetail</DetailType>
+        <SalesItemLineDetail>
+          <ItemRef name="Services">1</ItemRef>
+          <UnitPrice>64.99</UnitPrice>
+          <Qty>1</Qty>
+          <TaxCodeRef>TAX</TaxCodeRef>
+        </SalesItemLineDetail>
+      </Line>
+      <Line>
+        <Amount>64.99</Amount>
+        <DetailType>SubTotalLineDetail</DetailType>
+        <SubTotalLineDetail/>
+      </Line>
+      <TxnTaxDetail>
+        <TxnTaxCodeRef>2</TxnTaxCodeRef>
+        <TotalTax>0</TotalTax>
+        <TaxLine>
+          <Amount>0</Amount>
+          <DetailType>TaxLineDetail</DetailType>
+          <TaxLineDetail>
+            <TaxRateRef>1</TaxRateRef>
+            <PercentBased>true</PercentBased>
+            <TaxPercent>10</TaxPercent>
+            <NetAmountTaxable>64.99</NetAmountTaxable>
+          </TaxLineDetail>
+        </TaxLine>
+      </TxnTaxDetail>
+      <CustomerRef name="(empty)">6</CustomerRef>
+      <BillAddr>
+        <Id>3</Id>
+        <Line1>123 darkwing road</Line1>
+        <Line2>RT 101</Line2>
+        <City>Rockingham</City>
+        <CountrySubDivisionCode>NH</CountrySubDivisionCode>
+        <PostalCode>10002</PostalCode>
+        <Lat>40.7135097</Lat>
+        <Long>-73.9859414</Long>
+      </BillAddr>
+      <DueDate>2014-04-01</DueDate>
+      <TotalAmt>64.99</TotalAmt>
+      <ApplyTaxAfterDiscount>false</ApplyTaxAfterDiscount>
+      <PrintStatus>NeedToPrint</PrintStatus>
+      <EmailStatus>NotSet</EmailStatus>
+      <BillEmail>
+        <Address>john@doe.com</Address>
+      </BillEmail>
+      <Balance>64.99</Balance>
+      <Deposit>0</Deposit>
+      <AllowIPNPayment>false</AllowIPNPayment>
+      <AllowOnlinePayment>false</AllowOnlinePayment>
+      <AllowOnlineCreditCardPayment>false</AllowOnlineCreditCardPayment>
+      <AllowOnlineACHPayment>false</AllowOnlineACHPayment>
+    </Invoice>
+  </QueryResponse>
+</IntuitResponse>

data/spec/fixtures/tax_codes.xml

@@ -0,0 +1,58 @@
+<IntuitResponse xmlns="http://schema.intuit.com/finance/v3" time="2014-04-04T04:50:02.406-07:00">
+  <QueryResponse startPosition="1" maxResults="4" totalCount="4">
+    <TaxCode>
+      <Id>TAX</Id>
+      <MetaData>
+        <CreateTime>2013-08-26T12:24:57-07:00</CreateTime>
+        <LastUpdatedTime>2013-08-26T12:24:57-07:00</LastUpdatedTime>
+      </MetaData>
+      <Name>TAX</Name>
+      <Description>TAX</Description>
+      <Taxable>true</Taxable>
+      <TaxGroup>false</TaxGroup>
+    </TaxCode>
+    <TaxCode>
+      <Id>NON</Id>
+      <MetaData>
+        <CreateTime>2013-08-26T12:24:57-07:00</CreateTime>
+        <LastUpdatedTime>2013-08-26T12:24:57-07:00</LastUpdatedTime>
+      </MetaData>
+      <Name>NON</Name>
+      <Description>NON</Description>
+      <Taxable>false</Taxable>
+      <TaxGroup>false</TaxGroup>
+    </TaxCode>
+    <TaxCode>
+      <Id>CustomSalesTax</Id>
+      <MetaData>
+        <CreateTime>2013-08-26T12:24:57-07:00</CreateTime>
+        <LastUpdatedTime>2013-08-26T12:24:57-07:00</LastUpdatedTime>
+      </MetaData>
+      <Name>CustomSalesTax</Name>
+      <Description>CustomSalesTax</Description>
+      <Taxable>true</Taxable>
+      <TaxGroup>true</TaxGroup>
+    </TaxCode>
+    <TaxCode domain="QBO" sparse="false">
+      <Id>2</Id>
+      <SyncToken>0</SyncToken>
+      <MetaData>
+        <CreateTime>2014-03-28T13:52:48-07:00</CreateTime>
+        <LastUpdatedTime>2014-03-28T13:52:48-07:00</LastUpdatedTime>
+      </MetaData>
+      <Name>New York City</Name>
+      <Description>New York City</Description>
+      <Active>true</Active>
+      <Taxable>true</Taxable>
+      <TaxGroup>true</TaxGroup>
+      <SalesTaxRateList>
+        <TaxRateDetail>
+          <TaxRateRef name="New York City">1</TaxRateRef>
+          <TaxTypeApplicable>TaxOnAmount</TaxTypeApplicable>
+          <TaxOrder>0</TaxOrder>
+        </TaxRateDetail>
+      </SalesTaxRateList>
+      <PurchaseTaxRateList/>
+    </TaxCode>
+  </QueryResponse>
+</IntuitResponse>

data/spec/fixtures/vendors.xml

@@ -0,0 +1,95 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<IntuitResponse xmlns="http://schema.intuit.com/finance/v3" time="2014-04-04T06:31:21.480-07:00">
+  <QueryResponse startPosition="1" maxResults="6">
+    <Vendor domain="QBO" sparse="false">
+      <Id>11</Id>
+      <SyncToken>1</SyncToken>
+      <MetaData>
+        <CreateTime>2014-02-04T14:27:38-08:00</CreateTime>
+        <LastUpdatedTime>2014-02-04T14:39:34-08:00</LastUpdatedTime>
+      </MetaData>
+      <GivenName>Bill</GivenName>
+      <FamilyName>Sales</FamilyName>
+      <CompanyName>Catherines Cupcakes</CompanyName>
+      <DisplayName>Catherines Cupcakes</DisplayName>
+      <PrintOnCheckName>Catherines Cupcakes</PrintOnCheckName>
+      <Active>true</Active>
+      <PrimaryPhone>
+        <FreeFormNumber>603-344-5555</FreeFormNumber>
+      </PrimaryPhone>
+      <PrimaryEmailAddr>
+        <Address>cathy@donkey.io</Address>
+      </PrimaryEmailAddr>
+      <BillAddr>
+        <Id>7</Id>
+        <Line1>44 Billings Circle</Line1>
+        <City>Keene</City>
+        <CountrySubDivisionCode>NH</CountrySubDivisionCode>
+        <PostalCode>03455</PostalCode>
+        <Lat>42.9453196</Lat>
+        <Long>-72.31237449999999</Long>
+      </BillAddr>
+      <Balance>0</Balance>
+      <Vendor1099>false</Vendor1099>
+    </Vendor>
+    <Vendor domain="QBO" sparse="false">
+      <Id>3</Id>
+      <SyncToken>2</SyncToken>
+      <MetaData>
+        <CreateTime>2013-12-16T07:07:30-08:00</CreateTime>
+        <LastUpdatedTime>2013-12-16T07:15:32-08:00</LastUpdatedTime>
+      </MetaData>
+      <GivenName>Christian</GivenName>
+      <DisplayName>Christian</DisplayName>
+      <PrintOnCheckName>Christian</PrintOnCheckName>
+      <Active>true</Active>
+      <PrimaryEmailAddr>
+        <Address>christian@minimul.io</Address>
+      </PrimaryEmailAddr>
+      <Balance>0</Balance>
+      <Vendor1099>false</Vendor1099>
+    </Vendor>
+    <Vendor domain="QBO" sparse="false">
+      <Id>1</Id>
+      <SyncToken>0</SyncToken>
+      <MetaData>
+        <CreateTime>2013-10-29T02:59:05-07:00</CreateTime>
+        <LastUpdatedTime>2013-10-29T02:59:05-07:00</LastUpdatedTime>
+      </MetaData>
+      <DisplayName>John Doe</DisplayName>
+      <PrintOnCheckName>John Doe</PrintOnCheckName>
+      <Active>true</Active>
+      <Balance>0</Balance>
+      <Vendor1099>false</Vendor1099>
+    </Vendor>
+    <Vendor domain="QBO" sparse="false">
+      <Id>2</Id>
+      <SyncToken>1</SyncToken>
+      <MetaData>
+        <CreateTime>2013-11-02T05:17:06-07:00</CreateTime>
+        <LastUpdatedTime>2013-11-02T07:16:45-07:00</LastUpdatedTime>
+      </MetaData>
+      <DisplayName>Minimul</DisplayName>
+      <PrintOnCheckName>Minimul</PrintOnCheckName>
+      <Active>true</Active>
+      <PrimaryEmailAddr>
+        <Address>christian@minimul.io</Address>
+      </PrimaryEmailAddr>
+      <Balance>0</Balance>
+      <Vendor1099>false</Vendor1099>
+    </Vendor>
+    <Vendor domain="QBO" sparse="false">
+      <Id>13</Id>
+      <SyncToken>0</SyncToken>
+      <MetaData>
+        <CreateTime>2014-04-01T06:17:50-07:00</CreateTime>
+        <LastUpdatedTime>2014-04-01T06:17:50-07:00</LastUpdatedTime>
+      </MetaData>
+      <DisplayName>Musty Musketts</DisplayName>
+      <PrintOnCheckName>Musty Musketts</PrintOnCheckName>
+      <Active>true</Active>
+      <Balance>0</Balance>
+      <Vendor1099>false</Vendor1099>
+    </Vendor>
+  </QueryResponse>
+</IntuitResponse>

data/spec/quickbooks_ruby_base_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe Quickbooks::Base do
+  let(:account) { double }
+  let(:qr_base) { Quickbooks::Base.new(account) }
+
+  describe ".quickbooks_ruby_namespace" do
+    it "should generate quickbooks ruby model namespace given a symbol" do
+     expect(qr_base.generate_quickbooks_ruby_namespace(:access_token)).to eq "Quickbooks::Model::AccessToken"
+    end
+
+    it "should generate quickbooks ruby service namespace given a string" do
+      expect(qr_base.generate_quickbooks_ruby_namespace('AccessToken', 'Service')).to eq "Quickbooks::Service::AccessToken"
+    end
+  end
+
+  describe ".qr_model" do
+
+    it "should create a new instance of a quickbooks-ruby model" do
+      expect(qr_base.qr_model(:invoice).class.name).to eq 'Quickbooks::Model::Invoice'
+    end
+
+    it "should create a new instance of a quickbooks-ruby model that take more than 1 argument" do
+      result = qr_base.qr_model(:email_address, 'test@email.com')
+      expect(result.address).to eq 'test@email.com'
+    end
+  end
+
+  describe ".show" do
+    let(:account) { account = double(settings: double( qb_token: 'tttttttttt', qb_secret: 'ssssssss', qb_company_id: '1234567')) }
+
+    it "should display using the name as the given name" do
+      xml = File.read(File.join('spec', 'fixtures', 'vendors.xml'))
+      response = Struct.new(:plain_body, :code).new(xml, 200)
+      allow_any_instance_of(OAuth::AccessToken).to receive(:get).and_return(response)
+      qr = Quickbooks::Base.new(account, :vendor)
+      expect(qr.show.first).to match /Catherines Cupcakes/
+    end
+
+    it "should display using the name and not doc_number" do
+      xml = File.read(File.join('spec', 'fixtures', 'tax_codes.xml'))
+      response = Struct.new(:plain_body, :code).new(xml, 200)
+      allow_any_instance_of(OAuth::AccessToken).to receive(:get).and_return(response)
+      qr = Quickbooks::Base.new(account, :tax_code)
+      expect(qr.show.last).to match /New York City/
+    end
+
+    it "should display using the doc_number and not name" do
+      xml = File.read(File.join('spec', 'fixtures', 'invoices.xml'))
+      response = Struct.new(:plain_body, :code).new(xml, 200)
+      allow_any_instance_of(OAuth::AccessToken).to receive(:get).and_return(response)
+      qr = Quickbooks::Base.new(account, :invoice)
+      expect(qr.show.last).to match /1234/
+    end
+  end
+
+  describe ".retrieve" do
+    after do
+     Quickbooks::Base.configure { |c| c.persistent_token = nil; c.persistent_secret = nil; c.persistent_company_id = nil }
+    end
+
+    it "should set the persistence token location" do
+      Quickbooks::Base.configure do |c|
+        c.persistent_token = 'quickbooks_token'
+        c.persistent_company_id = 'quickbooks_company_id' 
+      end
+      expect(Quickbooks::Base.persistent_token).to eq 'quickbooks_token'
+      expect(Quickbooks::Base.persistent_company_id).to eq 'quickbooks_company_id'
+    end
+
+    it "should retrieve token configuration that is 2 levels deep, which is the default" do
+      token = 'xxxxxxxxxxxxxx'
+      account = double(settings: double( qb_token: token ))
+      qr_base = Quickbooks::Base.new(account)
+      expect(qr_base.retrieve(:token)).to eq token
+    end
+
+    it "should retrieve token configuration that is 1 level deep" do
+      token = 'xxxxxxxxxxxxxx'
+      Quickbooks::Base.configure do |c|
+        c.persistent_token = 'quickbooks_token'
+      end
+      account = double( quickbooks_token: token )
+      qr_base = Quickbooks::Base.new(account)
+      expect(qr_base.retrieve(:token)).to eq token
+    end
+  end
+
+  describe ".create_service_for" do
+    it "creates a access_token service" do
+      account = double(settings: double( qb_token: 'tttttttttt', qb_secret: 'ssssssss', qb_company_id: '1234567'))
+      qb = Quickbooks::Base.new(account)
+      service = qb.create_service_for :access_token
+      expect(service.class.name).to match /Service::AccessToken/
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'quickbooks/base'
+require 'quickbooks-ruby'
+
+RSpec.configure do |c|
+  c.color_enabled = true
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: quickbooks-ruby-base
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: quickbooks-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- christian@minimul.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/quickbooks-ruby-base.rb
+- lib/quickbooks/base.rb
+- lib/quickbooks/base/configuration.rb
+- quickbooks-ruby-base.gemspec
+- spec/fixtures/invoices.xml
+- spec/fixtures/tax_codes.xml
+- spec/fixtures/vendors.xml
+- spec/quickbooks_ruby_base_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/minimul/quickbooks-ruby-base
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Base class to provide common methods for the quickbooks-ruby gem
+test_files:
+- spec/fixtures/invoices.xml
+- spec/fixtures/tax_codes.xml
+- spec/fixtures/vendors.xml
+- spec/quickbooks_ruby_base_spec.rb
+- spec/spec_helper.rb
+has_rdoc: