pdfmonkey 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f29d523ed6bb4e6c17d42092bd8962761e2379b98627b09c04b6dd13c4c65e4a
-  data.tar.gz: 0d167f19f5640220aadd5bae73760bb00b864e977e3a720b921b9b1d04ab6e73
+  metadata.gz: ff117f74d9d9afa3c9085624a3187a1f88a47770be2ce9b6ef08c70ad89b8f1f
+  data.tar.gz: eb0cace007db56e9030470cf45c9a20f6b539738be1d22903edca1e5542a66c3
 SHA512:
-  metadata.gz: cd81871ef526fa6f3b30349984726bda426873a741206cd1dccc48a921ab3d6bad6278d48d80ea6ba292de49c9fb99ce0ad6cd450f04a1e83e90d01c1d0f9bb9
-  data.tar.gz: 349aab6b0ba114c260e72538e030e201489b15836d13b0abb8fc6fd9d577895b34f8c055f182d8c329ed3578ca40b1b9517b491bdcf2ad5b46bc139cd40ecc5e
+  metadata.gz: 6a210f72119b84c43407aa8c42ccb29dd73280c159902651b4fb6f57122a4060f673d2e240f1d729c60dca8052efe62224250f8e9334de8bd5afc76cd8d8c807
+  data.tar.gz: d146ca183867e0274b9b75be76116de40c9ef9fc985d8cf816c7196ee85f90604115c4745cb531551bc28fb23cd84c1a2a49be266c2f2d68d775de1a29233cbe

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,10 @@
 # Changelog
 
+# 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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pdfmonkey (0.4.0)
+    pdfmonkey (0.5.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)
@@ -63,7 +63,7 @@ DEPENDENCIES
   bundler (~> 1.17)
   coveralls (~> 0.8)
   pdfmonkey!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.8)
   rubocop (~> 0.60.0)
 

data/README.md

@@ -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\"}",
@@ -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
@@ -45,7 +49,8 @@ module Pdfmonkey
     private def headers
       {
         'Authorization' => "Bearer #{config.private_key}",
-        'Content-Type' => 'application/json'
+        'Content-Type' => 'application/json',
+        'User-Agent' => 'Ruby'
       }
     end
 

data/lib/pdfmonkey/document.rb

@@ -15,6 +15,7 @@ module Pdfmonkey
       document_template_id
       download_url
       errors
+      filename
       id
       meta
       payload
@@ -30,6 +31,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 +61,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.5.0'
 end

data/pdfmonkey.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.17'
   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.5.0
 platform: ruby
 authors:
 - Simon Courtois
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-01 00:00:00.000000000 Z
+date: 2020-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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: []