quickbooks-ruby-base 1.2.0 → 1.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTgzZjdjZGZjODEyMmMyNjk4MjM0ZmNmNjZhM2Q0YmJlN2U3NDI1Yw==
+    YTc3MTNmZDU5Yjc1N2U0ODM1YTI0NzI4ZGE2ZDc0ZTYwYTEzYmVjMA==
   data.tar.gz: !binary |-
-    MThiMzIwNmQ2NjQ3NTEzMTdhZTQwNzZmZDU0ZDA2NmQ0ZmExNjdiNQ==
+    YjhkMTZlYzMyNGVmYmMzODA2MGQ0ZDUzNjI0MWNmMmUyZDAyMzlhMw==
 SHA512:
   metadata.gz: !binary |-
-    YTE4MTkxNjU4M2M3NmVkNjY1OTRmMTNjMDQyNTAxOGJiYWJhMTdhYzNlYzYz
-    YTcyMDJlMjM2YjI2NzZmNWJhYzgzZmZmZWE5YWIwZTc2ZTU2NDExZjdjZWY2
-    MWNiYTYzMTYwMDc2N2ZhNTkyMTViNWYwZWIyZDEwNDc0N2YyZDU=
+    NzkxNTRhMDUwMzRlN2E0Y2ViODdkYTlhY2JlYTlkZTJhNTcyYWYzYjlmMjIx
+    MWM1NDE5ODk4NmZiNTQ4ZGJiOWU4ZTA4NmUwYzcwNjQxZjFjNDc1ZTJjYWI4
+    Mzc5ODAyNGZlMTcyNWJhZmU3Y2M1MzI1ZGJkYmU3YmYwYjI1NTA=
   data.tar.gz: !binary |-
-    YjMwYWQ0ZTUzYWMxOTc2YjhjYzRjNjU0Y2EwZWIyYjdmNGIyMjc1NWQ5ZmY4
-    ZThhZTlkY2JhMmZmZTk5MWQ4YWJiZjc3NTZkMmZlM2I5ZGY4NGUyMGJhNmE3
-    NmVkODMyM2NjYjVjZjY4YTk1Nzc4MmFkMjc2YzJlMTFjODhiYTM=
+    OTcwMmE1MTJhY2Y0NzcwNmIxMTA4YTI1Yjk0NmNhNDE3YzVhNjRjZjY1Nzdm
+    N2YwZTA2ZDg3ODljODE5ZGU0ZTI1MTA3YTlkNzZiNjE1ODEwMzVjYjlkNjhk
+    ZWE4OWRkODJjZDQzMDEyNWUyZGM2NWFmM2Q3YzBlMDYyMGViZDk=

data/README.md

@@ -59,32 +59,31 @@ Returns `quickbooks-ruby` service.
 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
+>> base.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
+>> base.show page:1, per_page: 3
 => ["QBID: 5 DESC: American Express", "QBID: 1 DESC: Cash", "QBID: 2 DESC: Check"]
 
 ```
 
-### id()
+### find_by_id()
 Convenience method to fetch an entity by its reference id
 ```
 base = Quickbooks::Base.new(account, :customer)
->> base.id(1)
+>> base.find_by_id(1)
 ```
   
-### display_name()
+### find_by_display_name()
 Convenience method to search for a name entity by DisplayName.
 Note: Leverages proper escaping via the [Quickbooks::Util::QueryBuilder](https://github.com/ruckus/quickbooks-ruby/blob/master/lib/quickbooks/util/query_builder.rb) module.
 ```
 base = Quickbooks::Base.new(account, :customer)
->> base.display_name('Chuck Russell')
+>> base.find_by_display_name('Chuck Russell')
 # Generates a query based on the following SQL
 # "Select Id, DisplayName From Customer WHERE DisplayName = 'Chuck Russell' LIMIT 1"
 ```

data/lib/quickbooks/base.rb

@@ -39,10 +39,6 @@ module Quickbooks
       end
     end
 
-    def id(id)
-      @service.fetch_by_id(id)
-    end
-
     def description(e)
       desc = (method = describing_method) =~ /(total)/ ? e.send(method).to_f : e.send(method)
     rescue => e

data/lib/quickbooks/base/finders.rb

@@ -1,6 +1,11 @@
 module Quickbooks
   class Base
     module Finders
+
+      def find_by_id(id)
+        @service.fetch_by_id(id)
+      end
+
       def qbuilder
         Quickbooks::Util::QueryBuilder.new
       end
@@ -18,7 +23,7 @@ module Quickbooks
         sql_builder(where, options)
       end
 
-      def display_name(display_name, options = {})
+      def find_by_display_name(display_name, options = {})
         sql = display_name_sql(display_name, options)
         @service.query(sql)
       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.2.0'
+  spec.version       = '1.3.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/quickbooks_ruby_base_spec.rb

@@ -108,12 +108,12 @@ describe Quickbooks::Base do
     end
   end
 
-  describe ".id" do
+  describe ".find_by_id" do
     it 'grabs a object by id' do
       xml = read_fixture('invoice') 
       stub_response(xml)
       qr = Quickbooks::Base.new(full_account, :invoice)
-      result = qr.id(28)
+      result = qr.find_by_id(28)
       expect(result.id).to eq 156
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickbooks-ruby-base
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Christian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-30 00:00:00.000000000 Z
+date: 2015-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: quickbooks-ruby