html_to_pdf_conversion 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 596ad2143fb6680f5423a499fba355ed0cf0e635
-  data.tar.gz: 694c0f2710f4c51b321d4dbb28e544628a5dfbf2
+  metadata.gz: 86cc9418aec320a48946509abff35e245afdcd2b
+  data.tar.gz: 44e0fcccc79bac6d5bf2d60cddfd41e1f3a84542
 SHA512:
-  metadata.gz: 103bc53b2404c5854e37decc5abe126aae103812c372779e87d056d7f281f1684f240af93ab64ca0545984e987fb943b00e6565c4af0d4a681de38c155fb91d9
-  data.tar.gz: ae19dfb75c45008ba8aef994f48c3accf55bb01aed190bc7b3b26775f2c1337c9c3e5096e29adb35249082a110a26809145a653ee681151fa6b425c602317263
+  metadata.gz: 5620367347222840b48836b337809b068908fa0bdc53e03911d93089013c9b4b3076edb88e4b29f852744bff7efe0f7afc5125fd5aed96b1be16119e6d79d996
+  data.tar.gz: c3cc1e4f9d4733164cd7fa47d712cab72c86075e2bde425372b9a367e8dcd0a6973d8c25eba8cac0218750eeec27e28e6d45bddf61cbb9adedb95fe884446502

data/README.md

@@ -1,41 +1,192 @@
-# html_to_pdf_conversion
+[![Travis](https://travis-ci.org/pmoelgaard/html_to_pdf_conversion.svg)](Travis)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/html_to_pdf_conversion`. To experiment with that code, run `bin/console` for an interactive prompt.
+# html_to_pdf_conversion
+Node JavaScript wrapper for [the pdflayer API](https://pdflayer.com/).   
+Conversion API for Developers. Create highly customizable PDFs from URLs & HTML
 
-TODO: Delete this and the text above, and describe your gem
+---
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
+```
 gem 'html_to_pdf_conversion'
+
 ```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+
+```
 
 Or install it yourself as:
 
-    $ gem install html_to_pdf_conversion
+```
+$ gem install html_to_pdf_conversion
+
+```
+
+---
+
+## Configuration
+
+Before using the pdflayer API client you have to setup your account and obtain your API Access Key.  
+You can get it by signing up at [https://pdflayer.com/product](https://pdflayer.com/product).
+
+---
+
+## API Overview
+All endpoints in the public API is available through this library.
+
+- convert
+
+---
 
 ## Usage
 
-TODO: Write usage instructions here
+The general API is documented here: [https://pdflayer.com/documentation](https://pdflayer.com/documentation).  
+You can find parameters, result set definitions and status codes documented here as well.
+
+In the examples directory you can find demos and samples of general usage of all the API functions.
+
+### Setup
+
+```
+@client = PDFlayer::Client.new( [access_key], [secret_key] )
+
+```
+
+#### Required Parameters
+
+###### access_key
+Your unique key that you can find on the dashboard of your account under the pdflayer account.
+
+###### secret_key
+A userdefined private key that you can find on the dashboard of your account under the pdflayer account, it's used to encrypt parameters to prevent unauthorised usage of your account.
+
+#### Optional Parameters
+
+###### Secure (only available for Basic, Pro and Enterprise accounts)
+Boolean value to indicate if the calls to the API should use a secure protocol or insecure (HTTP/HTTPS). Defaults to false (HTTP, insecure).
+
+---
+
+## Convert (simple case)
+Takes a URL and returns the captured image.
+
+###### Define Query
+Second we define an options object.
+All the options are documented here: [https://pdflayer.com/documentation](https://pdflayer.com/documentation)
+
+```
+options = PDFlayer::ConvertOptions.new()
+
+```
+
+###### Call Client
+We then place the actual call to the API, passing in the URL we wish to capture as PDF and the options we defined above.
+
+```
+response = @client.convert(document_url, options)
+
+``` 
+
+###### Response
 
-## Development
+```
+[The binary content of the PDF file]
+
+```
+
+---
+
+## Convert (w. export)
+Takes a URL, saves the PDF to a local file defined by the export argument and returns a response object.
+
+###### Define Query
+
+We define an options object, and sets the ```export``` option.
+This option is specific to the RubyGem and not documented in the API found on pdflayer.
+
+```
+options = PDFlayer::ConvertOptions.new()
+options.export = '[local_file_system]/some_directory]/my_file.pdf'
+
+```
+
+###### Simple Request (using Callback)
+
+```
+response = @client.convert(document_url, options)
+
+```
+
+###### Response
+```
+{
+	"success": true,
+    "info": "The PDF file has been saved to your local file system",
+    "file_name": "path_to_local_file.pdf"
+}
+```
+
+---
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Example Application
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+In the [rootdir]/example directory there is a fully functional application which runs all requests against all the endpoints in the API, the examples above can be seen there as source code.
 
-## Contributing
+The example application uses a process.env variable to hold the access key.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/html_to_pdf_conversion. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+---
 
+## Tests
+
+The tests are written for any NodeJS testing library, but has been run and targeted at the [https://mochajs.org/](https://mochajs.org/) testing library.
+
+In order to run the tests, the following environment variables needs to be set:
+
+```
+ACCESS_KEY = [access_key]
+SECRET_KEY = [secret_key]
+```
+
+
+---
+
+## Customer Support
+
+Need any assistance? [Get in touch with Customer Support](mailto:support@apilayer.net?subject=%pdflayer%5D).
+
+---
+
+## Updates
+Stay up to date by following [@apilayernet](https://twitter.com/apilayernet) on Twitter.
+
+---
+
+## Legal
+
+All usage of the languagelayer website, API, and services is subject to the [pdflayer Terms & Conditions](https://pdflayer.com/terms) and all annexed legal documents and agreements.
+
+---
+
+## Author
+Peter Andreas Moelgaard ([GitHub](https://github.com/pmoelgaard), [Twitter](https://twitter.com/petermoelgaard))
+
+---
 
 ## License
+Licensed under the The MIT License (MIT)
+
+Copyright (©) 2016 Peter Andreas Moelgaard & apilayer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 

data/example/example.rb

@@ -12,12 +12,11 @@ document_url = 'https://en.wikipedia.org/wiki/Special:Random'
 
 # We declare the options
 options = PDFlayer::ConvertOptions.new()
-options.export = File.join('tmp', SecureRandom.uuid() +'.pdf')
 
 # We make the call to convert
 response = @client.convert(document_url, options)
 
 # If its a success, we print a message to the user
 if ! response.nil?
-  puts 'SUCCESS : PDF fetched...'
+  puts 'SUCCESS : PDF fetched...'+ response.length
 end

data/example/example_w_export.rb

@@ -0,0 +1,23 @@
+require 'html_to_pdf_conversion'
+require 'dotenv'
+
+# Load Environment Variables
+Dotenv.load
+
+# Declare the Client instance passing in the authentication parameters
+@client = PDFlayer::Client.new(ENV['ACCESS_KEY'], ENV['SECRET_KEY'])
+
+# Set the URL to get as PDF, we take a random URL from Wikipedia
+document_url = 'https://en.wikipedia.org/wiki/Special:Random'
+
+# We declare the options
+options = PDFlayer::ConvertOptions.new()
+options.export = File.join('tmp', SecureRandom.uuid() +'.pdf')
+
+# We make the call to convert
+response = @client.convert(document_url, options)
+
+# If its a success, we print a message to the user
+if ! response.nil?
+  puts 'SUCCESS : PDF fetched...'+ JSON(response)
+end

data/lib/html_to_pdf_conversion/version.rb

@@ -1,3 +1,3 @@
 module PDFlayer
-  VERSION = "0.1.3"
+  VERSION = "0.2.1"
 end

data/lib/html_to_pdf_conversion.rb

@@ -30,6 +30,11 @@ module PDFlayer
 
     def convert(document_url, options = {})
 
+      if document_url.nil?
+        raise PDFlayer::MissingArgumentException.new 'document_url'
+        return
+      end
+
       # Create a shallow copy so we don't manipulate the original reference
       query = options.dup
 
@@ -58,16 +63,31 @@ module PDFlayer
         res.inspect
 
         # If we have an export option passed in, we save it to local file system
-        if !options.export.nil?
+        if options.export.nil?
+
+          # We just return the parsed binary response
+          return res.parsed_response
+
+        else
+
           begin
+
             File.open(options.export, 'a+') do |file|
+
               file.write(res.body)
+
+              result = {
+                  success: true,
+                  info: "The PDF file has been saved to your local file system",
+                  file_name: options.export
+              }
+              return result
+
             end
+
           end
         end
 
-        # Finally we return the parsed binary response
-        return res.parsed_response
 
       rescue => e
         puts e.inspect

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html_to_pdf_conversion
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Peter Andreas Moelgaard
@@ -125,6 +125,7 @@ files:
 - bin/console
 - bin/setup
 - example/example.rb
+- example/example_w_export.rb
 - html_to_pdf_conversion.gemspec
 - html_to_pdf_conversion.iml
 - lib/html_to_pdf_conversion.rb