qbo_api 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa54c3e368cbe905ae5b328cdac7de62ba744f05
-  data.tar.gz: d52eaa3b8dfddc1ecafd1e8860235317f972682c
+  metadata.gz: 03b3f06c76e70aa87331ccf79916407536a54bed
+  data.tar.gz: 79b5441fe6ec65d06153ab200a5fe27a88735d6c
 SHA512:
-  metadata.gz: 5df20a423bea757d0ecdecb67d3c096758ebd381d5e61a6175ef52c5959d5d7d8aa2e558fb7b8c60a38be6f74050b301bbe53f01221ef4572af924d6ab961a16
-  data.tar.gz: 601d278a518e73d0a29844e5d2f9e73a2eb1388b424a3f87b6398955d6c034292a3cdf108fe753ea949e30ae1d90870710f45f94546f8a1c6f265930a368c03d
+  metadata.gz: 800b0c6ccb9a1f1cf70867038cd035b364426b6f83656a6bbc8c3f864cf0b1a6a851f2602a83ccd5ab457ca42223edf432e5dc51d7f33f3b1d12c4acc202cb6c
+  data.tar.gz: 4657a2c0bb876fdd994ff5ebd0abb3bdb616f2be5bec033b51210fe488122148a87b6c6d27e9f08b7431e10e85c1fd2565b8c934b917c4e769917e63d0c7c692

data/.gitignore

@@ -14,3 +14,4 @@
 todo.txt
 *.sess
 *.log
+scrap.txt

data/README.md

@@ -117,6 +117,12 @@ QboApi.request_id = true
   p response['status'] # => "Deleted"
 ```
 
+### Deactivate (only works for name list entities)
+```ruby
+  response = qbo_api.deactivate(:employee, id: 55)
+  p response['Active'] # => false
+```
+
 ### Search with irregular characters
 ```ruby
   name = qbo_api.esc "Amy's Bird Sanctuary"
@@ -206,11 +212,16 @@ See [docs](https://developer.intuit.com/docs/0100_quickbooks_online/0100_essenti
 
 ### Import/retrieve all
 ```ruby
-  # retrieves all customers
+  # retrieves all active customers
   qbo_api.all(:customers) do |c|
     p "#{c['Id']} #{c['DisplayName']}"
   end
 
+  # retrieves all active or inactive employees
+  qbo_api.all(:employees, inactive: true) do |e|
+    p "#{e['Id']} #{e['DisplayName']}"
+  end
+
   # retrieves all vendors by groups of 5
   qbo_api.all(:vendor, max: 5) do |v|
     p v['DisplayName']
@@ -283,9 +294,7 @@ export QBO_API_COMPANY_ID=12345
 
 #### Protip: Once your .env file is completely filled out you can use the console to play around in your sandbox
 ```
-bin/console
->> require_relative 'spec/spec_helper'
->> VCR.configure { |c| c.allow_http_connections_when_no_cassette = true }
+bin/console test
 >> q = QboApi.new(creds.to_h)
 >> q.get :customer, 1
 ```

data/bin/console

@@ -3,6 +3,11 @@
 require "bundler/setup"
 require "qbo_api"
 
+if ARGV[0] == "test"
+  require_relative '../spec/support/credentials'
+  ARGV[0] = nil # needed to avoid irb error
+end
+
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 

data/lib/qbo_api.rb

@@ -71,12 +71,20 @@ class QboApi
   end
 
   def delete(entity, id:)
-    raise QboApi::NotImplementedError unless is_transaction_entity?(entity)
+    err_msg = "Delete is only for transaction entities. Use .deactivate instead"
+    raise QboApi::NotImplementedError.new, err_msg unless is_transaction_entity?(entity)
     path = add_params_to_path(path: entity_path(entity), params: { operation: :delete })
     payload = set_update(entity, id)
     request(:post, entity: entity, path: path, payload: payload)
   end
 
+  def deactivate(entity, id:)
+    err_msg = "Deactivate is only for name list entities. Use .delete instead"
+    raise QboApi::NotImplementedError.new, err_msg unless is_name_list_entity?(entity)
+    payload = set_update(entity, id).merge('sparse': true, 'Active': false)
+    request(:post, entity: entity, path: entity_path(entity), payload: payload)
+  end
+
   # TODO: Need specs for disconnect and reconnect
   # https://developer.intuit.com/docs/0100_quickbooks_online/0100_essentials/0085_develop_quickbooks_apps/0004_authentication_and_authorization/oauth_management_api#/Reconnect
   def disconnect
@@ -89,8 +97,8 @@ class QboApi
     request(:get, path: path)
   end
 
-  def all(entity, max: 1000, select: nil, &block)
-    select ||= "SELECT * FROM #{singular(entity)}"
+  def all(entity, max: 1000, select: nil, inactive: false, &block)
+    select = build_all_query(entity, select: select, inactive: inactive)
     pos = 0
     begin
       pos = pos == 0 ? pos + 1 : pos + max

data/lib/qbo_api/util.rb

@@ -4,7 +4,7 @@ class QboApi
       if time.is_a?(String)
         time
       else
-        time.to_s.sub(' ', 'T').sub(' ', '').insert(-3, ':')
+        time.iso8601
       end
     end
 
@@ -29,6 +29,21 @@ class QboApi
       uri.to_s
     end
 
+    def join_or_start_where_clause!(select:)
+      if select.match(/where/i)
+        str = ' AND '
+      else
+        str = ' WHERE '
+      end
+      str
+    end
+
+    def build_all_query(entity, select: nil, inactive: false)
+      select ||= "SELECT * FROM #{singular(entity)}"
+      select += join_or_start_where_clause!(select: select) + 'Active IN ( true, false )' if inactive
+      select
+    end
+
   end
 end
 

data/lib/qbo_api/version.rb

@@ -1,3 +1,3 @@
 class QboApi
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qbo_api
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Christian Pelczarski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-23 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler