pdfmonkey 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f949266c25fee699e6a0a3bde90256f2240e0b866a873034f54b9e31b7e6fa88
-  data.tar.gz: dde8fa07bba2aa84869fd8945183b9cc82eb9b6439054eca030e541503a7e7e4
+  metadata.gz: f29d523ed6bb4e6c17d42092bd8962761e2379b98627b09c04b6dd13c4c65e4a
+  data.tar.gz: 0d167f19f5640220aadd5bae73760bb00b864e977e3a720b921b9b1d04ab6e73
 SHA512:
-  metadata.gz: 9ef0addfc109cb571ac602b3acf2c783afd61013114e424133c6144c9f375741056421db9ccdaf8a536b6aa87a5257deca76c0152b32892add868a7c57a55752
-  data.tar.gz: 55a890ebe8f847c8cbc0e483d55dcc72a1f7f355cb7a4b3ec66f3488376199887cf0f55ec29894880af2f77f81c2044fda67b7f66909b1d2ac73673719a39648
+  metadata.gz: cd81871ef526fa6f3b30349984726bda426873a741206cd1dccc48a921ab3d6bad6278d48d80ea6ba292de49c9fb99ce0ad6cd450f04a1e83e90d01c1d0f9bb9
+  data.tar.gz: 349aab6b0ba114c260e72538e030e201489b15836d13b0abb8fc6fd9d577895b34f8c055f182d8c329ed3578ca40b1b9517b491bdcf2ad5b46bc139cd40ecc5e

data/.travis.yml

@@ -3,9 +3,11 @@ language: ruby
 before_install:
   - gem install bundler --version '~> 1.17'
 
+dist: trusty
+
 rvm:
   - 2.6
   - 2.5
   - 2.4
-  - rbx-3
+  - rbx-4
   - truffleruby

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.4.0
+
+* Adding meta to `Document.generate!` and `Document.generate`
+* Fixing the errors extraction to conform to the current API format
+* Adding `Document.fetch` to retrieve a document
+
 ## 0.3.0
 
 * Adding `Document#done?` to check if a document is complete

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pdfmonkey (0.3.0)
+    pdfmonkey (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -104,6 +104,27 @@ curl <url of your app> \
       }'
 ```
 
+#### Attaching meta data to the document
+
+In addition to the Document’s payload you can add meta data when generating a Document.
+
+This can be done by passing a third argument to the `generate!` and `generate` methods:
+
+```ruby
+meta = {
+  _filename: 'john-doe-contract.pdf',
+  client_id: '123xxx123'
+}
+
+document = Pdfmonkey::Document.generate!(template_id, payload, meta)
+document.meta
+# => '{"_filename":"john-doe-contract.pdf","client_id":"123xxx123"}'
+
+document = Pdfmonkey::Document.generate(template_id, payload, meta)
+document.meta
+# => '{"_filename":"john-doe-contract.pdf","client_id":"123xxx123"}'
+```
+
 #### Error handling
 
 In case of error, be it an HTTP layer error or an API error, `document.status` will be set to `'error'` and `document.error` will contain the error message.
@@ -117,7 +138,7 @@ data = { name: 'John Doe' }
 document = Pdfmonkey::Document.generate(template_id, data)
 
 document.status # => 'error'
-document.errors # => ["Couldn't find DocumentTemplate with 'id'=unknown"]
+document.errors # => ["Document template must exist"]
 
 # If the network is down
 document = Pdfmonkey::Document.generate(template_id, data)
@@ -126,6 +147,31 @@ document.status # => 'error'
 document.errors # => ["Failed to open TCP connection to api.pdfmonkey.io:443 (getaddrinfo: nodename nor servname provided, or not known)"]
 ```
 
+### Fetching a document
+
+You can fetch an existing document using the `.fetch` method:
+
+```ruby
+document = Pdfmonkey::Document.fetch('76bebeb9-9eb1-481a-bc3c-faf43dc3ac81')
+```
+
+#### Error handling
+
+In case of error, be it an HTTP layer error or an API error, `document.status` will be set to `'error'` and `document.error` will contain the error message.
+
+```ruby
+document = Pdfmonkey::Document.fetch('unknown')
+
+document.status # => 'error'
+document.errors # => ["We couldn't find any Document with ID \"unknown\"..."]
+
+# If the network is down
+document = Pdfmonkey::Document.fetch('95eb0b6e-090b-4195-9b7c-cc3d50099867')
+
+document.status # => 'error'
+document.errors # => ["Failed to open TCP connection to api.pdfmonkey.io:443 (getaddrinfo: nodename nor servname provided, or not known)"]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/pdfmonkey/adapter.rb

@@ -37,7 +37,9 @@ module Pdfmonkey
 
     private def extract_errors(response)
       payload = JSON.parse(response.body)
-      { errors: payload['errors'], status: 'error' }
+      errors = payload['errors'].to_a.map { |error| error['detail'] }
+
+      { errors: errors, status: 'error' }
     end
 
     private def headers

data/lib/pdfmonkey/document.rb

@@ -30,15 +30,20 @@ module Pdfmonkey
     attr_reader :attributes
     def_delegators :attributes, *ATTRIBUTES
 
-    def self.generate!(document_template_id, payload)
-      document = generate(document_template_id, payload)
+    def self.fetch(document_id)
+      new(id: document_id).reload!
+    end
+
+    def self.generate!(document_template_id, payload, meta = {})
+      document = generate(document_template_id, payload, meta)
       document.reload! until document.done?
       document
     end
 
-    def self.generate(template_id, payload)
+    def self.generate(template_id, payload, meta = {})
       document = new(
         document_template_id: template_id,
+        meta: meta.to_json,
         payload: payload.to_json,
         status: 'pending')
 

data/lib/pdfmonkey/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pdfmonkey
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfmonkey
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Simon Courtois
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-07 00:00:00.000000000 Z
+date: 2019-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler