pdfmonkey 0.4.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f29d523ed6bb4e6c17d42092bd8962761e2379b98627b09c04b6dd13c4c65e4a
-  data.tar.gz: 0d167f19f5640220aadd5bae73760bb00b864e977e3a720b921b9b1d04ab6e73
+  metadata.gz: 7b013f0822a5527e71c4cdc59db5db57db55f99a211385794edee27cc7d80136
+  data.tar.gz: 2bd5e46799f7f211bfc113108c5a6bdcf8e6149c9d8584f7c7af907f168348cb
 SHA512:
-  metadata.gz: cd81871ef526fa6f3b30349984726bda426873a741206cd1dccc48a921ab3d6bad6278d48d80ea6ba292de49c9fb99ce0ad6cd450f04a1e83e90d01c1d0f9bb9
-  data.tar.gz: 349aab6b0ba114c260e72538e030e201489b15836d13b0abb8fc6fd9d577895b34f8c055f182d8c329ed3578ca40b1b9517b491bdcf2ad5b46bc139cd40ecc5e
+  metadata.gz: be01b68099f078ab891f171abcdb8ad4f87db248235fe4cc1a93d5fc382a99dc097e9d72d06a3dc687be399ddd58713d01d1467fbc3c255e6ddcececc39aa517
+  data.tar.gz: d4f5cab8cebf933b09860df3b60829bd3b4d8a43cb316c5058125881ac46f85b5ed84cde22ed9766df71e659d84d0521df1201fa7b1dd9d55181c0122ce641b7

data/.travis.yml

@@ -1,13 +1,23 @@
 language: ruby
 
-before_install:
-  - gem install bundler --version '~> 1.17'
+before_install: gem install bundler --version '~> 1.17'
+cache: bundler
+dist: bionic
 
-dist: trusty
+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-4
-  - truffleruby
+- ruby-head
+- 2.6
+- 2.5
+- 2.4
+- jruby-head

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 0.8.0
+
+* Adding support for single error responses
+
+## 0.7.0
+
+* Updating bundler to v2.2
+* Adding `failure_cause`, `generation_logs` and `public_share_link` to the `Document` class
+
+## 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`

data/Gemfile.lock

@@ -1,41 +1,41 @@
 PATH
   remote: .
   specs:
-    pdfmonkey (0.4.0)
+    pdfmonkey (0.8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    coveralls (0.8.22)
+    ast (2.4.2)
+    coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
       term-ansicolor (~> 1.3)
-      thor (~> 0.19.4)
+      thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    jaro_winkler (1.5.2)
-    json (2.1.0)
-    parallel (1.12.1)
-    parser (2.5.3.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    jaro_winkler (1.5.4)
+    json (2.6.1)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    powerpack (0.1.3)
     rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
     rubocop (0.60.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -44,28 +44,30 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
+    ruby-progressbar (1.11.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    term-ansicolor (1.7.0)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
       tins (~> 1.0)
-    thor (0.19.4)
-    tins (1.20.2)
+    thor (1.1.0)
+    tins (1.29.1)
+      sync
     unicode-display_width (1.4.1)
 
 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.3
+   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\"}",
@@ -132,7 +133,7 @@ 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)
@@ -172,6 +173,44 @@ 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,7 +41,12 @@ module Pdfmonkey
 
     private def extract_errors(response)
       payload = JSON.parse(response.body)
-      errors = payload['errors'].to_a.map { |error| error['detail'] }
+      errors =
+        if payload['error']
+          [payload['error']]
+        else
+          payload['errors'].to_a.map { |error| error['detail'] }
+        end
 
       { errors: errors, status: 'error' }
     end
@@ -45,7 +54,8 @@ module Pdfmonkey
     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,10 +15,14 @@ module Pdfmonkey
       document_template_id
       download_url
       errors
+      failure_cause
+      filename
+      generation_logs
       id
       meta
       payload
       preview_url
+      public_share_link
       status
       updated_at
     ].freeze
@@ -30,6 +34,10 @@ module Pdfmonkey
     attr_reader :attributes
     def_delegators :attributes, *ATTRIBUTES
 
+    def self.delete(document_id)
+      new(id: document_id).delete!
+    end
+
     def self.fetch(document_id)
       new(id: document_id).reload!
     end
@@ -56,6 +64,10 @@ module Pdfmonkey
       update(attributes)
     end
 
+    def delete!
+      adapter.call(:delete, self)
+    end
+
     def done?
       COMPLETE_STATUSES.include?(status)
     end

data/lib/pdfmonkey/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pdfmonkey
-  VERSION = '0.4.0'
+  VERSION = '0.8.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.4.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Simon Courtois
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-01 00:00:00.000000000 Z
+date: 2021-11-04 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,8 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Connect to the PDFMonkey API
 test_files: []