qbo_api 1.5.5 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e41c520594f554f538f3a9e563fb52b8026b02f9
-  data.tar.gz: c1c10fcedcbebe57bf84a9382188b45b0ff50706
+  metadata.gz: dff9404c6a83b4e8f6fc33fd52af54b5ab006b55
+  data.tar.gz: 59f355486c69b4ac7c1455983eda7d7569452de3
 SHA512:
-  metadata.gz: a6796818e8e3e45e12054f1eb8c702165c4fe053b63e3137e2efeca14b902221105f3bdb5f23963f7e9a1e307a5d25bd6564deba9b99b2612060cba697edfcbe
-  data.tar.gz: 900c1cd621a945fa0c6758f2e48cd57e57a96b347bd4cbc3efff6634082e642da6b86393b623eabef4374cfc2707178543a3cb302582fe581e501682f233e1a1
+  metadata.gz: dc49185da33d9cbede625b6cb90983e934d6bc3610204e95cd88403edea686ad27673dc4e243004ac391021e8eb4690ef9071d1983344806e933c66e3bee6f07
+  data.tar.gz: 2ff9700fcdfd87be23955fd5dd4d4ac970e62f9b1758dc1af3f26f74111789f56abeed92904aa0601e40fd87989dc73950ab5adcad1411cf0949b3ed31e5f7b1

data/README.md

@@ -167,9 +167,42 @@ QboApi.minor_version = 8
   p response['DisplayName'] # => "Dukes Basketball Camp"
 ```
 
+### Uploading an attachment
+```ruby
+  payload = {"AttachableRef":
+              [
+                {"EntityRef": 
+                  {
+                    "type": "Invoice", 
+                    "value": "111"
+                  }
+                }
+              ],
+             "FileName": "test.txt",
+             "ContentType": "text/plain"
+            }
+  # `attachment` can be either an IO stream or string path to a local file
+  response = qbo_api.upload_attachment(payload: payload, attachment: '/tmp/test.txt')
+  p response['Id'] # => 5000000000000091308
+```
+
+Be aware that any errors will not raise a `QboApi::Error`, but will be returned in the following format:
+```ruby
+  {"AttachableResponse"=>
+    [{"Fault"=>
+       {"Error"=>
+         [{"Message"=>"Object Not Found",
+           "Detail"=>
+            "Object Not Found : Something you're trying to use has been made inactive. Check the fields with accounts, customers, items, vendors or employees.",
+           "code"=>"610",
+           "element"=>""}],
+        "type"=>"ValidationFault"}}],
+   "time"=>"2018-01-03T13:06:31.406-08:00"}
+```
+
 ### Change data capture (CDC) query
 ```ruby
-  response = api.cdc(entities: 'estimate', changed_since: '2011-10-10T09:00:00-07:00')
+  response = qbo_api.cdc(entities: 'estimate', changed_since: '2011-10-10T09:00:00-07:00')
   # You can also send in a Time object e.g. changed_since: Time.now 
   expect(response['CDCResponse'].size).to eq 1
   ids = response['CDCResponse'][0]['QueryResponse'][0]['Estimate'].collect{ |e| e['Id'] }

data/lib/qbo_api.rb

@@ -42,13 +42,13 @@ class QboApi
   def connection(url: get_endpoint)
     @connection ||= Faraday.new(url: url) do |faraday|
       faraday.headers['Content-Type'] = 'application/json;charset=UTF-8'
-      faraday.headers['Accept'] = "application/json"
+      faraday.headers['Accept'] = 'application/json'
       if @token != nil
         faraday.request :oauth, oauth_data
       elsif @access_token != nil
         faraday.request :oauth2, @access_token, token_type: 'bearer'
       else
-        raise QboApi::Error.new error_body: "Must set either the token or access_token"
+        raise QboApi::Error.new error_body: 'Must set either the token or access_token'
       end
       faraday.request :url_encoded
       faraday.use FaradayMiddleware::RaiseHttpException
@@ -140,8 +140,32 @@ class QboApi
     data
   end
 
+  def upload_attachment(payload:, attachment:)
+    content_type = payload['ContentType'] || payload[:ContentType]
+    file_name = payload['FileName'] || payload[:FileName]
+    raw_response = attachment_connection.post do |request|
+      request.url "#{realm_id}/upload"
+      request.body = {
+          'file_metadata_01':
+              Faraday::UploadIO.new(StringIO.new(JSON.generate(payload)), 'application/json', 'attachment.json'),
+          'file_content_01':
+              Faraday::UploadIO.new(attachment, content_type, file_name)
+      }
+    end
+    response(raw_response, entity: :attachable)
+  end
+
   private
 
+  def attachment_connection
+    return @attachment_connection if @attachment_connection
+    multipart_connection = connection.dup
+    multipart_connection.headers['Content-Type'] = 'multipart/form-data'
+    multipart_middleware_index = multipart_connection.builder.handlers.index(Faraday::Request::UrlEncoded) || 1
+    multipart_connection.builder.insert(multipart_middleware_index, Faraday::Request::Multipart)
+    @attachment_connection = multipart_connection
+  end
+
   def create_all_enumerator(entity, max: 1000, select: nil, inactive: false)
     Enumerator.new do |enum_yielder|
       select = build_all_query(entity, select: select, inactive: inactive)
@@ -159,6 +183,8 @@ class QboApi
   def entity_response(data, entity)
     if qr = data['QueryResponse']
       qr.empty? ? nil : qr.fetch(singular(entity))
+    elsif ar = data['AttachableResponse']
+      ar.first.fetch(singular(entity))
     else
       data.fetch(singular(entity))
     end

data/lib/qbo_api/version.rb

@@ -1,3 +1,3 @@
 class QboApi
-  VERSION = "1.5.5"
+  VERSION = "1.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qbo_api
 version: !ruby/object:Gem::Version
-  version: 1.5.5
+  version: 1.6.0
 platform: ruby
 authors:
 - Christian Pelczarski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-03 00:00:00.000000000 Z
+date: 2018-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler