qbo_api 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5332ce0a487a0012e3cb020426155b5d8a1775497e32e3f43883c8da46417684
-  data.tar.gz: 4bc7672f4a4e5b3ef937cd1ba23940da15343da38401243b2665b8b9bf910455
+  metadata.gz: d091daea142ea8b5f0637e93068ebec256c6ed5027b03725b576e003fa1997b3
+  data.tar.gz: d44cdfc123b586c2ee4a228f06ffa0d6c602e8897c18cfb656fd68aa7a7401c3
 SHA512:
-  metadata.gz: 93b46a7ec5c979914e5e7046304bea8df3504e1c60e0168acf4ba8b3f756f7816b292ccc92fd57cce03629febfa6ac957124dfd2da3cc9854e8fa8e90c20d534
-  data.tar.gz: '04531594e0155c2cec1306e4c19ce53eb0f7b15f25e56ba860702ae773afcffa9942e0d26fdfc538b5ed831e4a1007e99b718437f9e15096bb95a9a597aeb6c1'
+  metadata.gz: 61177b17927c994c049cc7975f0673b9893f04c39d7f0b61ec5af4d2a15d13ad0cfbf0fac5302b33ffedeeda43f5af474d22112a8ca1b22d7cf5fa31097fbae8
+  data.tar.gz: de16113918a2d51488654197f585d60f480e40aa107d51e5de471ae418cabf7c01c0691a57d8acbe4bf732610d1f1b6c049317cb2c7a9d08ce09fa21ab876a81

data/.gitignore

@@ -19,4 +19,4 @@ todo.txt
 spec/temp/spec_status.txt
 *.swp
 scrap.txt
-.tool-versions
+.tool-versions

data/README.md

@@ -335,6 +335,38 @@ See [docs](https://developer.intuit.com/docs/0100_quickbooks_online/0100_essenti
   p qbo_api.is_transaction_entity?(:customer) # => false
   p qbo_api.is_name_list_entity?(:vendors) # => true
 ```
+
+### Download Quickbooks PDF
+A quickbooks supplied PDF can be downloaded for api endpoints which offer a PDF.
+```ruby
+qbo_api.get_pdf(:invoice, 121) # produces a pdf stream.
+```
+The PDF stream can then be saved using your preferred method.
+```ruby
+# example using Ruby on Rails with ActiveStorage
+class Invoice
+  has_one_attached :pdf_file
+end
+invoice_number = 121
+pdf_data = qbo_api.get_pdf(:invoice, invoice_numer) # returns raw pdf stream
+pdf_io = StringIO.new(pdf_data) # convert to a StringIO object
+filename = "invoice_no_#{invoice_number}"
+
+invoice.pdf_file.attach(
+    io: pdf_io,
+    filename: filename,
+    content_type: 'application/pdf'
+)
+```
+
+```ruby
+# plain ruby example
+invoice_number = 121
+pdf_data = qbo_api.get_pdf(:invoice, invoice_numer) # returns raw pdf stream
+filename = "invoice_no_#{invoice_number}.pdf"
+
+File.write(filename, pdf_data)
+```
 ## Spin up an example
 - <a href="http://minimul.com/access-the-quickbooks-online-api-with-oauth2.html" target="_blank">Check out this article on spinning up the example</a>.
 

data/lib/qbo_api/api_methods.rb

@@ -34,6 +34,11 @@ class QboApi
       end
     end
 
+    def get_pdf(entity, id)
+      path = "#{entity_path(entity)}/#{id}/pdf"
+      request(:get, entity: entity, path: path, headers: { 'Accept' => 'application/pdf' })
+    end
+
     def create(entity, payload:, params: nil)
       request(:post, entity: entity, path: entity_path(entity), payload: payload, params: params)
     end

data/lib/qbo_api/connection.rb

@@ -43,7 +43,7 @@ class QboApi
 
     def request(method, path:, entity: nil, payload: nil, params: nil, headers: nil)
       raw_response = raw_request(method, conn: connection, path: path, params: params, payload: payload, headers: headers)
-      response(raw_response, entity: entity)
+      response(raw_response, entity: entity, headers: headers)
     end
 
     def raw_request(method, conn:, path:, payload: nil, params: nil, headers: nil)
@@ -63,8 +63,14 @@ class QboApi
       end
     end
 
-    def response(resp, entity: nil)
+    def response(resp, entity: nil, headers: false)
       data = resp.body
+
+      if headers
+        content_type = headers['Accept'] || headers['Content-Type']
+        return data if content_type&.include?('application/pdf')
+      end
+
       entity ? entity_response(data, entity) : data
     rescue => e
       QboApi.logger.debug { "#{LOG_TAG} response parsing error: entity=#{entity.inspect} body=#{resp.body.inspect} exception=#{e.inspect}" }

data/lib/qbo_api/version.rb

@@ -1,3 +1,3 @@
 class QboApi
-  VERSION = "3.0.2"
+  VERSION = "3.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qbo_api
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Christian Pelczarski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler