pdfmonkey 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64be5f191201c74accbf5eb0c747fac13d4573717b7d1650a88a2d8ac7f7c763
-  data.tar.gz: 160ddcfec092f8417f1e65f453c77bd754e9f81b9c7ef07f0dda9fb96a2bf706
+  metadata.gz: b12f7afdcc1eefd026e54906aed36c86d17b467ea000e8e0b7379b567c34c5d4
+  data.tar.gz: f953fd4a0568f46d8aec981b72cf94eb86c6c8c9fe5d42ecfc0eddbf8cb57c38
 SHA512:
-  metadata.gz: f9ad7a42896a544d776df651008b617d674c1f14104c663d98a25a22cfc3e85dd2764e6f3f334bd1cff7dab097a0005dce61532bbf05a5b37c0fe715298be8aa
-  data.tar.gz: 55925f2faa3d549bc2412194ba9412d56ff3ebcea99ebf686b8f7dec471e169bc86929552e29d0d3a45aca2fe09a15986c8e43db41206c4733947158ab7f1d2e
+  metadata.gz: 98348f398fffbabc5ea8b480cbfe6906a1e7eb252f04eb695483688fa36ae0352731498d6eddbe23d81ed38195f82237d11f5fe5ecdfac2bd67dad5a36c8aed1
+  data.tar.gz: 5e123b0f7e8f645f0ba96fed50d1aa5bfa4a1e76a8827d673f701d4c065bcc2252ce8f330d8bb719c87f6b6626a59c377265a519d691fa8acdccb4eb08d19992

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 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.1.0)
+    pdfmonkey (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -104,6 +104,28 @@ curl <url of your app> \
       }'
 ```
 
+#### 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
+# Using an unknown template
+
+tempalte_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"]
+
+# If the network is down
+document = Pdfmonkey::Document.generate(template_id, data)
+
+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

@@ -10,7 +10,14 @@ module Pdfmonkey
 
     def call(method, resource)
       response = send_request(method, resource)
-      extract_attributes(response, resource)
+
+      if response.is_a?(Net::HTTPSuccess)
+        extract_attributes(response, resource)
+      else
+        extract_errors(response)
+      end
+    rescue StandardError => e
+      { errors: [e.message], status: 'error' }
     end
 
     private def build_get_request(uri, _resource)
@@ -28,6 +35,11 @@ module Pdfmonkey
       JSON.parse(response.body).fetch(member)
     end
 
+    private def extract_errors(response)
+      payload = JSON.parse(response.body)
+      { errors: payload['errors'], status: 'error' }
+    end
+
     private def headers
       {
         'Authorization' => "Bearer #{config.private_key}",

data/lib/pdfmonkey/document.rb

@@ -14,6 +14,7 @@ module Pdfmonkey
       created_at
       document_template_id
       download_url
+      errors
       id
       meta
       payload
@@ -22,7 +23,7 @@ module Pdfmonkey
       updated_at
     ].freeze
 
-    COMPLETE_STATUSES = %w[failure success].freeze
+    COMPLETE_STATUSES = %w[error failure success].freeze
     COLLECTION = 'documents'
     MEMBER = 'document'
 
@@ -57,7 +58,10 @@ module Pdfmonkey
     end
 
     def to_json
-      { document: attributes.to_h }.to_json
+      attrs = attributes.to_h
+      attrs.delete(:errors)
+
+      { document: attrs }.to_json
     end
 
     private def save

data/lib/pdfmonkey/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfmonkey
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Simon Courtois
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-11 00:00:00.000000000 Z
+date: 2019-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,6 +91,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock