pdfmonkey 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b12f7afdcc1eefd026e54906aed36c86d17b467ea000e8e0b7379b567c34c5d4
-  data.tar.gz: f953fd4a0568f46d8aec981b72cf94eb86c6c8c9fe5d42ecfc0eddbf8cb57c38
+  metadata.gz: 981628ac067f138aaf0a098ddf561f7537b3838df84d1c7b3410583b5e66fa35
+  data.tar.gz: 168ab9c7819b220d2e26eac8910993d7e62db504ecdae8806d0081962f60754b
 SHA512:
-  metadata.gz: 98348f398fffbabc5ea8b480cbfe6906a1e7eb252f04eb695483688fa36ae0352731498d6eddbe23d81ed38195f82237d11f5fe5ecdfac2bd67dad5a36c8aed1
-  data.tar.gz: 5e123b0f7e8f645f0ba96fed50d1aa5bfa4a1e76a8827d673f701d4c065bcc2252ce8f330d8bb719c87f6b6626a59c377265a519d691fa8acdccb4eb08d19992
+  metadata.gz: 3df5b9ac944318e0e47ba81cbd6aafe865e6eb00117e8646a5ea0f0068808fb24d8f3f6145beb2f7f87d9a3223b3d760f3c7d63dc42c04a5ca7498e24777b358
+  data.tar.gz: 0aee89379452faa4b588c258d54d7b44fb702c14d2ed6fe2efdb478fbe8dd58b6ce5a167bb93de1704fa49c51fff656e9e68a8f3b87184106c88f207425d9259

data/.travis.yml

@@ -1,7 +1,23 @@
 language: ruby
+
+before_install: gem install bundler --version '~> 1.17'
+cache: bundler
+dist: bionic
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  fast_finish: true
+
+notifications:
+  email: false
+  slack:
+    secure: YimzUcOW2fIo+CyYB5sBgUydS49JNtTIEowyinPAfDifAYgRNx/8c5kPk0aLk8klbnNBd8pMene/i4MIfApRuUmzAkGLe/1CCbotGn7zN7R6S46tpkGaHyMya5leiQemT6gIeL5+J4mQwDcTppXYh9kNTSYKh6RNLJxS7XUZZrNqOK6R2e/hX71aqUJTA5laSQ5mR5Hvyl9kUaJW5b77myXiU6VdrHmCl3sZ9hMqe6mroyBbVOAf1eFQMo7QX9HuLTUHJA2KIpnA7cLEXLINtnKjkhRVR0hcuGMETJhrJI/Ylqi1kf3PRPqkD/Q9msBo01OcRSoGwTjQ2IS1gOcYDowgvpJhkvx2v17fk4j1w3zR5KHSYJlrYOnr+ayU9K3LTs62X8ppVHff6pkKjOEF+p1Mayk/DqbaaH0PnCxqBqJOqZ5kFSkz6y4DDQzVuYILi6qUfgZFQJ01LNR7zbJAI6v9xDqREPG/Bfh7QI5z4eETlZWF9CVX6OARYm43to/wLLg2AEEduoMjexMoIxXRgzsTyBnxKYW3P+0oXWtiH68PXEKF9qAEl8lK4tTjbPBiEgXgUMDWQIiG0y6M567Rg8s8CUiw5ZsQTGJE+9zn4OkM/3VTce1mNLoZPyF66S5sXTPFXjieHCnMS3vegc3OJzLI/Xpx/lPDEU+8CYBaA1I=
+
 rvm:
-  - 2.6
-  - 2.5
-  - 2.4
-  - rbx-3
-  - truffleruby
+- ruby-head
+- 2.6
+- 2.5
+- 2.4
+- jruby-head

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## HEAD
+
+* Updating bundler to v2.2
+
+## 0.6.0
+
+* Making the request `User-Agent` header configurable
+
+## 0.5.0
+
+* Adding `Document#filename`
+* Adding `Document.delete` and `Document#delete!`
+
+## 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
+
 ## 0.2.0
 
 * Handling HTTP and API errors and exposing the error messages

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pdfmonkey (0.2.0)
+    pdfmonkey (0.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -16,13 +16,13 @@ GEM
     diff-lcs (1.3)
     docile (1.3.1)
     jaro_winkler (1.5.2)
-    json (2.1.0)
+    json (2.3.1)
     parallel (1.12.1)
     parser (2.5.3.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -60,12 +60,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2.2)
   coveralls (~> 0.8)
   pdfmonkey!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.8)
   rubocop (~> 0.60.0)
 
 BUNDLED WITH
-   1.17.2
+   2.2.30

data/README.md

@@ -50,7 +50,7 @@ Once your App is created in the [PDFMonkey Dashboard](https://dashboard.pdfmonke
 If your want to wait for a Document’s generation before continuing with your workflow, use the `generate!` method, it will request a document generation and wait for it to succeed or fail before giving you any answer.
 
 ```ruby
-tempalte_id = 'b13ebd75-d290-409b-9cac-8f597ae3e785'
+template_id = 'b13ebd75-d290-409b-9cac-8f597ae3e785'
 data = { name: 'John Doe' }
 
 document = Pdfmonkey::Document.generate!(template_id, data)
@@ -72,7 +72,7 @@ PDFMonkey was created with an asynchronous workflow in mind. It provides webhook
 To leverage this behavior and continue working while your Document is generated, use the `generate` method:
 
 ```ruby
-tempalte_id = 'b13ebd75-d290-409b-9cac-8f597ae3e785'
+template_id = 'b13ebd75-d290-409b-9cac-8f597ae3e785'
 data = { name: 'John Doe' }
 
 document = Pdfmonkey::Document.generate(template_id, data)
@@ -94,6 +94,7 @@ curl <url of your app> \
           "created_at": "2020-01-02T03:04:05.000+01:00",
           "document_template_id": "f7fbe2b4-a57c-46ee-8422-5ae8cc37daac",
           "download_url": "https://example.com/76bebeb9-9eb1-481a-bc3c-faf43dc3ac81.pdf",
+          "filename": "76bebeb9-9eb1-481a-bc3c-faf43dc3ac81.pdf",
           "id": "76bebeb9-9eb1-481a-bc3c-faf43dc3ac81",
           "meta": null,
           "payload": "{\"name\": \"John Doe\"}",
@@ -104,6 +105,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.
@@ -111,13 +133,13 @@ In case of error, be it an HTTP layer error or an API error, `document.status` w
 ```ruby
 # Using an unknown template
 
-tempalte_id = 'unknown'
+template_id = 'unknown'
 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 +148,69 @@ 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)"]
+```
+
+### Deleting a document
+
+You can delete an existing document using the `.delete` method:
+
+```ruby
+Pdfmonkey::Document.delete('76bebeb9-9eb1-481a-bc3c-faf43dc3ac81')
+#=> true
+```
+
+Alternatively you can call the `#delete!` method:
+
+```ruby
+document.delete!
+#=> true
+```
+
+#### Error handling
+
+In case of error, be it an HTTP layer error or an API error, an error Hash will be returned.
+
+```ruby
+document.delete!
+#=> true
+
+document.delete!
+# {
+#   errors: ["We couldn't find any Document with ID \"11111111-2222-3333-4444-555555555555\". If ..."],
+#   status: "error"
+# }
+
+# If the network is down
+document.delete!
+# {
+#   errors: ["Failed to open TCP connection to api.pdfmonkey.io:443 (getaddrinfo: nodename nor servname provided, or not known)"],
+#   status: "error"
+# }
+```
+
 ## 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/Rakefile

@@ -1,6 +1,20 @@
-require 'bundler/gem_tasks'
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color --require spec_helper]
+end
 
 task default: :spec

data/lib/pdfmonkey/adapter.rb

@@ -11,15 +11,19 @@ module Pdfmonkey
     def call(method, resource)
       response = send_request(method, resource)
 
-      if response.is_a?(Net::HTTPSuccess)
-        extract_attributes(response, resource)
-      else
-        extract_errors(response)
+      case response
+      when Net::HTTPNoContent then true
+      when Net::HTTPSuccess then extract_attributes(response, resource)
+      else extract_errors(response)
       end
     rescue StandardError => e
       { errors: [e.message], status: 'error' }
     end
 
+    private def build_delete_request(uri, _resource)
+      Net::HTTP::Delete.new(uri, headers)
+    end
+
     private def build_get_request(uri, _resource)
       Net::HTTP::Get.new(uri, headers)
     end
@@ -37,13 +41,16 @@ 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
       {
         'Authorization' => "Bearer #{config.private_key}",
-        'Content-Type' => 'application/json'
+        'Content-Type' => 'application/json',
+        'User-Agent' => config.user_agent
       }
     end
 

data/lib/pdfmonkey/configuration.rb

@@ -5,11 +5,13 @@ module Pdfmonkey
     attr_accessor :host
     attr_accessor :namespace
     attr_accessor :private_key
+    attr_accessor :user_agent
 
     def initialize
       @host = 'https://api.pdfmonkey.io'
       @namespace = 'api/v1'
       @private_key = ENV['PDFMONKEY_PRIVATE_KEY']
+      @user_agent = 'Ruby'
     end
   end
 

data/lib/pdfmonkey/document.rb

@@ -15,6 +15,7 @@ module Pdfmonkey
       document_template_id
       download_url
       errors
+      filename
       id
       meta
       payload
@@ -30,15 +31,24 @@ module Pdfmonkey
     attr_reader :attributes
     def_delegators :attributes, *ATTRIBUTES
 
-    def self.generate!(document_template_id, payload)
-      document = generate(document_template_id, payload)
-      document.reload! until COMPLETE_STATUSES.include?(document.status)
+    def self.delete(document_id)
+      new(id: document_id).delete!
+    end
+
+    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')
 
@@ -51,6 +61,14 @@ module Pdfmonkey
       update(attributes)
     end
 
+    def delete!
+      adapter.call(:delete, self)
+    end
+
+    def done?
+      COMPLETE_STATUSES.include?(status)
+    end
+
     def reload!
       attributes = adapter.call(:get, self)
       update(attributes)

data/lib/pdfmonkey/version.rb

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

data/pdfmonkey.gemspec

@@ -22,9 +22,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler', '~> 2.2'
   spec.add_development_dependency 'coveralls', '~> 0.8'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'rubocop', '~> 0.60.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfmonkey
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Simon Courtois
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-05-12 00:00:00.000000000 Z
+date: 2021-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -110,7 +110,7 @@ homepage: https://github.com/pdfmonkeyio/pdfmonkey-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,9 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Connect to the PDFMonkey API
 test_files: []