html_to_pdf_conversion 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce7ca2406bf947a20244c2fc372ab12d0e7ecc4c
-  data.tar.gz: aa4402a955a0578d76025cd4cf7c01c221c3c3ff
+  metadata.gz: 596ad2143fb6680f5423a499fba355ed0cf0e635
+  data.tar.gz: 694c0f2710f4c51b321d4dbb28e544628a5dfbf2
 SHA512:
-  metadata.gz: d641a9ad69c4173dcb7987d62d79e908af726754fe2c5d388d0b06ec534dfa8016d288d27f45b3bd74897cd3896a8f77d312c41b793d70a54570892b7839cf33
-  data.tar.gz: 7a07a07385b87714cc9ec37d5f53373c5ad30663026d82403a724d8279465354d85cdc56882d7d1d23619898c8b70cbddf8c4e165cfedbf6fef59c4983dea582
+  metadata.gz: 103bc53b2404c5854e37decc5abe126aae103812c372779e87d056d7f281f1684f240af93ab64ca0545984e987fb943b00e6565c4af0d4a681de38c155fb91d9
+  data.tar.gz: ae19dfb75c45008ba8aef994f48c3accf55bb01aed190bc7b3b26775f2c1337c9c3e5096e29adb35249082a110a26809145a653ee681151fa6b425c602317263

data/example/example.rb

@@ -1,7 +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'])
-response = @client.convert('http://apilayer.net', { export: File.join('tmp', SecureRandom.uuid() +'.pdf') })
+
+# 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...'
+end

data/html_to_pdf_conversion.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "httparty"
+  spec.add_runtime_dependency "hashable"
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

data/html_to_pdf_conversion.iml

@@ -18,6 +18,7 @@
     <orderEntry type="library" scope="PROVIDED" name="bundler (v1.11.2, ruby-2.0.0-p645) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.2.5, ruby-2.0.0-p645) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="dotenv (v2.1.0, ruby-2.0.0-p645) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="hashable (v0.1.2, ruby-2.0.0-p645) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="httparty (v0.13.7, ruby-2.0.0-p645) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="json (v1.8.3, ruby-2.0.0-p645) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="multi_xml (v0.5.5, ruby-2.0.0-p645) [gem]" level="application" />

data/lib/html_to_pdf_conversion.rb

@@ -1,6 +1,8 @@
 require 'digest'
 require "httparty"
+require "hashable"
 require "html_to_pdf_conversion/version"
+require "html_to_pdf_conversion/missing_argument_exception"
 
 module PDFlayer
 
@@ -11,48 +13,153 @@ module PDFlayer
     base_uri 'api.pdflayer.com/api'
 
     def initialize(access_key, secret_key)
+
+      if access_key.nil?
+        raise PDFlayer::MissingArgumentException.new 'access_key'
+      end
+
+      if secret_key.nil?
+        raise PDFlayer::MissingArgumentException.new 'secret_key'
+      end
+
       @access_key = access_key
       @secret_key = secret_key
+
     end
 
+
     def convert(document_url, options = {})
 
+      # Create a shallow copy so we don't manipulate the original reference
+      query = options.dup
+
+      # Generate the SecretKey for the request
       md5 = Digest::MD5.new
       md5.update document_url + @secret_key
+      secret_key = md5.hexdigest
+
+      # Populate the Query
+      query.access_key = @access_key
+      query.secret_key = secret_key
+      query.document_url = document_url
+
+      # We then create the Request
+      req = ConvertRequest.new(query)
 
-      @options = {
-          query: {
-              access_key: @access_key,
-              document_url: document_url,
-              secret_key: md5.hexdigest
-          },
-          export: options[:export]
-      }
+      #  We create a Hash of the request so we can send it via HTTP
+      req_dto = req.to_dh
 
       begin
 
-        res = self.class.get('/convert', @options)
+        # We make the actual request
+        res = self.class.get('/convert', req_dto)
+
+        # We ensure that we tap the response so we can use the results
         res.inspect
 
-        if @options[:export]
-          filename = @options[:export]
+        # If we have an export option passed in, we save it to local file system
+        if !options.export.nil?
           begin
-            File.open(filename, 'a+') do |file|
+            File.open(options.export, 'a+') do |file|
               file.write(res.body)
             end
           end
         end
 
+        # Finally we return the parsed binary response
         return res.parsed_response
 
       rescue => e
         puts e.inspect
+        return
 
       ensure
-
-        @options = nil
+        # Clean Up
 
       end
     end
   end
+
+
+  class ConvertRequest
+
+    include Hashable
+
+    attr_accessor :query
+
+    def initialize(query = {})
+      self.query = query;
+    end
+
+  end
+
+
+  class ConvertOptions
+
+    include Hashable
+
+    attr_accessor :access_key
+    attr_accessor :secret_key
+
+    attr_accessor :document_url
+    attr_accessor :document_html
+
+    attr_accessor :document_name
+    attr_accessor :export
+    attr_accessor :document_unit
+    attr_accessor :user_agent
+    attr_accessor :text_encoding
+    attr_accessor :ttl
+    attr_accessor :force
+    attr_accessor :inline
+    attr_accessor :auth_user
+    attr_accessor :auth_password
+    attr_accessor :encryption
+    attr_accessor :no_images
+    attr_accessor :no_hyperlinks
+    attr_accessor :accept_lang
+    attr_accessor :no_backgrounds
+    attr_accessor :no_javascript
+    attr_accessor :use_print_media
+    attr_accessor :grayscale
+    attr_accessor :low_quality
+    attr_accessor :forms
+    attr_accessor :no_print
+    attr_accessor :no_modify
+    attr_accessor :no_copy
+    attr_accessor :page_size
+    attr_accessor :page_width
+    attr_accessor :page_height
+    attr_accessor :orientation
+    attr_accessor :header_text
+    attr_accessor :header_align
+    attr_accessor :header_url
+    attr_accessor :header_html
+    attr_accessor :header_spacing
+    attr_accessor :footer_text
+    attr_accessor :footer_align
+    attr_accessor :footer_url
+    attr_accessor :footer_html
+    attr_accessor :footer_spacing
+    attr_accessor :css_url
+    attr_accessor :delay
+    attr_accessor :dpi
+    attr_accessor :zoom
+    attr_accessor :page_numbering_offset
+    attr_accessor :watermark_url
+    attr_accessor :watermark_opacity
+    attr_accessor :watermark_offset_x
+    attr_accessor :watermark_offset_y
+    attr_accessor :watermark_in_background
+    attr_accessor :title
+    attr_accessor :subject
+    attr_accessor :creator
+    attr_accessor :author
+
+    def initialize()
+      @query = nil
+    end
+
+  end
+
 end

data/lib/html_to_pdf_conversion/missing_argument_exception.rb

@@ -0,0 +1,13 @@
+module PDFlayer
+
+  class MissingArgumentException < Exception
+
+    attr_accessor :argument
+
+    def initialize(argument)
+      self.argument = argument
+    end
+
+  end
+
+end

data/lib/html_to_pdf_conversion/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html_to_pdf_conversion
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Peter Andreas Moelgaard
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-14 00:00:00.000000000 Z
+date: 2016-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +128,7 @@ files:
 - html_to_pdf_conversion.gemspec
 - html_to_pdf_conversion.iml
 - lib/html_to_pdf_conversion.rb
+- lib/html_to_pdf_conversion/missing_argument_exception.rb
 - lib/html_to_pdf_conversion/version.rb
 homepage: https://github.com/pmoelgaard/html_to_pdf_conversion
 licenses: