quickbooks-ruby-base 1.1.0 → 1.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmEwMDFiYjNjMmVhZDcxMzAwOGU4Y2RjZDc5ZmY3YmExNTMyODI0Nw==
+    YTgzZjdjZGZjODEyMmMyNjk4MjM0ZmNmNjZhM2Q0YmJlN2U3NDI1Yw==
   data.tar.gz: !binary |-
-    ZWMwM2IyMTEwZjliZWI4OTUxYmE1NDY3OTJjYjk3MzlkYjk2MjlmNA==
+    MThiMzIwNmQ2NjQ3NTEzMTdhZTQwNzZmZDU0ZDA2NmQ0ZmExNjdiNQ==
 SHA512:
   metadata.gz: !binary |-
-    Yzg4ZDE3MDNiMTJlYWM2ZTNlMmIyYTA1YjdkOTRlYjNjNDg0NTlhMzM5M2Ex
-    ZjExZmYxZDJlMDEyNjIwZWYxOGRjMDZhYTBhZDcxMmE0OTMyMWI0MjJjZTYz
-    ZjM5NWY0NWE0YzQ4NTdhMTA3MzIyZGE4MGMwNjlmYzkyNjg3ODU=
+    YTE4MTkxNjU4M2M3NmVkNjY1OTRmMTNjMDQyNTAxOGJiYWJhMTdhYzNlYzYz
+    YTcyMDJlMjM2YjI2NzZmNWJhYzgzZmZmZWE5YWIwZTc2ZTU2NDExZjdjZWY2
+    MWNiYTYzMTYwMDc2N2ZhNTkyMTViNWYwZWIyZDEwNDc0N2YyZDU=
   data.tar.gz: !binary |-
-    ZmU5ODk0ZGE5ZTMwZGJiODY4NDQ3MjNmMTY4NTJiOTIwZDNmODlkMTAwZjEz
-    ZWVkMGM5ZDJiMmMyZDRiNjQxMzUwMTlhYTc5MWVlODA2M2MzYzMxYThkZmE3
-    Y2VmYjJlNTAzMzcxNzhiOTljMzFhODk1M2Y3YjY2NmRmYmNjZWM=
+    YjMwYWQ0ZTUzYWMxOTc2YjhjYzRjNjU0Y2EwZWIyYjdmNGIyMjc1NWQ5ZmY4
+    ZThhZTlkY2JhMmZmZTk5MWQ4YWJiZjc3NTZkMmZlM2I5ZGY4NGUyMGJhNmE3
+    NmVkODMyM2NjYjVjZjY4YTk1Nzc4MmFkMjc2YzJlMTFjODhiYTM=

data/README.md

@@ -72,6 +72,23 @@ base = Quickbooks::Base.new(account, :payment_method)
 
 ```
 
+### id()
+Convenience method to fetch an entity by its reference id
+```
+base = Quickbooks::Base.new(account, :customer)
+>> base.id(1)
+```
+  
+### 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')
+# Generates a query based on the following SQL
+# "Select Id, DisplayName From Customer WHERE DisplayName = 'Chuck Russell' LIMIT 1"
+```
+
 ## Configuration
 
 As the first argument, the `Quickbooks::Base` class expects a persistent object that holds OAuth connection information.

data/lib/quickbooks/base/finders.rb

@@ -0,0 +1,28 @@
+module Quickbooks
+  class Base
+    module Finders
+      def qbuilder
+        Quickbooks::Util::QueryBuilder.new
+      end
+
+      def sql_builder(where, options = {})
+        options[:entity] ||= @entity
+        options[:select] ||= '*'
+        options[:limit] ||= 1
+        "Select #{options[:select]} From #{options[:entity]} WHERE #{where} LIMIT #{options[:limit]}"
+      end
+
+      def display_name_sql(display_name, options = {})
+        options[:select] ||= 'Id, DisplayName'
+        where = qbuilder.clause("DisplayName", "=", display_name)
+        sql_builder(where, options)
+      end
+
+      def display_name(display_name, options = {})
+        sql = display_name_sql(display_name, options)
+        @service.query(sql)
+      end
+    end
+  end
+end
+

data/lib/quickbooks/base.rb

@@ -1,9 +1,11 @@
 require 'quickbooks-ruby'
 require_relative 'base/configuration'
+require_relative 'base/finders'
 
 module Quickbooks
   class Base
-    attr_reader :service
+    attr_reader :service, :entity
+    include Finders
     extend Configuration
 
     def initialize(account, type = nil)
@@ -11,18 +13,18 @@ module Quickbooks
       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}"
+    def generate_quickbooks_ruby_namespace(entity, type = 'Model')
+      @entity = entity.is_a?(Symbol) ? entity.to_s.camelcase : entity
+      "Quickbooks::#{type}::#{@entity}"
     end
 
-    def quickbooks_ruby_model(which, *args)
-      generate_quickbooks_ruby_namespace(which, 'Model').constantize.new(*args)
+    def quickbooks_ruby_model(entity, *args)
+      generate_quickbooks_ruby_namespace(entity, '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
+    def quickbooks_ruby_service(entity)
+      generate_quickbooks_ruby_namespace(entity, 'Service').constantize.new
     end
     alias_method :qr_service, :quickbooks_ruby_service
 

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.1.0'
+  spec.version       = '1.2.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

@@ -29,7 +29,7 @@ describe Quickbooks::Base do
 
   describe ".show" do
 
-    it "description should display using the dispay_name for vendor" do
+    it "description should display using the display_name for vendor" do
       xml = read_fixture('vendors')
       stub_response(xml)
       qr = Quickbooks::Base.new(full_account, :vendor)
@@ -108,8 +108,7 @@ describe Quickbooks::Base do
     end
   end
 
-  describe ".get" do
-
+  describe ".id" do
     it 'grabs a object by id' do
       xml = read_fixture('invoice') 
       stub_response(xml)
@@ -119,6 +118,19 @@ describe Quickbooks::Base do
     end
   end
 
+  describe ".display_name_sql" do
+    it 'for basic usage' do
+      qr = Quickbooks::Base.new(full_account, :customer)
+      expect(qr.display_name_sql('Chuck Russell')).to eq "Select Id, DisplayName From Customer WHERE DisplayName = 'Chuck Russell' LIMIT 1"
+    end
+
+    it 'for custom usage' do
+      qr = Quickbooks::Base.new(full_account, :customer)
+      sql = qr.display_name_sql('Chuck Russell', entity: 'Vendor', select: '*', limit: 5)
+      expect(sql).to eq "Select * From Vendor WHERE DisplayName = 'Chuck Russell' LIMIT 5"
+    end
+  end
+
   def read_fixture(filename)
     File.read(File.join('spec', 'fixtures', "#{filename}.xml"))
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickbooks-ruby-base
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Christian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: quickbooks-ruby
@@ -81,6 +81,7 @@ files:
 - lib/quickbooks-ruby-base.rb
 - lib/quickbooks/base.rb
 - lib/quickbooks/base/configuration.rb
+- lib/quickbooks/base/finders.rb
 - quickbooks-ruby-base.gemspec
 - spec/fixtures/dummy.xml
 - spec/fixtures/invoice.xml
@@ -110,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Base class to provide common methods for the quickbooks-ruby gem
@@ -123,4 +124,3 @@ test_files:
 - spec/fixtures/vendors.xml
 - spec/quickbooks_ruby_base_spec.rb
 - spec/spec_helper.rb
-has_rdoc: