pdfire 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d3727f14b8734acd147be9b85d18a9c10f34ed34ee1766a607f91f813de491e
+  data.tar.gz: db688ae02085f6360a0108711ebf6e7111ba01f7fcb5b258092f19827ca5071d
+SHA512:
+  metadata.gz: 477908a745b6629d6dde7df73752771ec02f775aa2ec5b1d57ec8fd501d2437b7f805a85e71262cd0b2c03e63686ee37cd89f98dabea776a40ace1930d005a9a
+  data.tar.gz: 0d2707b3e7a6c9be8141c5ccf8da79111a4f252ce0b757ecdad575146115c12e887dde62ba698138ea737229084d921ddbec4c35ad59c25d73682c74eb4a187b

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 modernice Ltd.
+
+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 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/README.md

@@ -0,0 +1,32 @@
+# PDFire Ruby
+
+![GitHub](https://img.shields.io/github/license/modernice/pdfire-ruby?style=flat-square)
+
+This PHP package provides a client for the [PDFire.io](https://pdfire.io) API. Read the [Documentation](https://docs.pdfire.io) for a list of available options.
+
+## Installation
+
+```sh
+gem install pdfire
+```
+
+## Basic usage
+
+```ruby
+require 'pdfire'
+
+client = PDFire::Client.new('YOUR-API-KEY')
+
+params = PDFire::ConversionParams.new
+params.url = 'https://google.com'
+params.margin = 0
+params.format = 'A4'
+
+pdf = client.convert(params)
+
+pdf.save_to('/path/on/disk.pdf')
+```
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

data/lib/bytes_result.rb

@@ -0,0 +1,15 @@
+require_relative 'result'
+
+module PDFire
+  class BytesResult < Result
+    attr_reader :bytes
+
+    def initialize(bytes)
+      @bytes = bytes
+    end
+
+    def bytes()
+      return @bytes
+    end
+  end
+end

data/lib/client.rb

@@ -0,0 +1,104 @@
+require 'json'
+require 'date'
+require 'net/http'
+require_relative 'conversion_params'
+require_relative 'merge_params'
+require_relative 'errors'
+require_relative 'bytes_result'
+require_relative 'conversion'
+
+module PDFire
+  class Client
+    attr_reader :api_key
+    attr_accessor :base_url
+    attr_accessor :http
+
+    # @param api_key [String] the PDFire API key.
+    def initialize(api_key)
+      @api_key = api_key
+      @base_url = "https://api.pdfire.io"
+      uri = URI.parse(@base_url)
+      @http = Net::HTTP.new(uri.host, uri.port)
+      @http.use_ssl = true
+    end
+
+    # @param params [ConversionParams, MergeParams] the conversion/merge parameters.
+    # @return [Result] the conversion result.
+    def convert(params)
+      map = params.to_map
+
+      request = Net::HTTP::Post.new(@base_url + "/v1/conversions", initheader = {
+        'Authorization': "Bearer #{@api_key}",
+        'Content-Type': 'application/json',
+      })
+
+      request.body = map.to_json
+      res = @http.request(request)
+      status = res.code.to_i
+
+      if status == 401
+        raise AuthenticationError
+      end
+
+      if status != 201
+        content_type = res.header['content-type']
+
+        if not content_type.include? 'application/json'
+          raise UnknownResponseError
+        end
+
+        raise APIError.new JSON.parse(res.body)["errors"]
+      end
+
+      self.result(res)
+    end
+
+    # @param params [ConversionParams, MergeParams] the conversion/merge parameters.
+    # @return [BytesResult] the conversion result.
+    def convert_to_bytes_result(params)
+      params.cdn = false
+      self.convert params
+    end
+
+    # @param params [ConversionParams, MergeParams] the conversion/merge parameters.
+    # @return [Array<byte>] the PDF bytes.
+    def convert_to_bytes(params)
+      self.convert_to_bytes_result(params).bytes()
+    end
+
+    # @param params [ConversionParams, MergeParams] the conversion/merge parameters.
+    # @return [Conversion] the conversion.
+    def convert_using_cdn(params)
+      params.cdn = true
+      self.convert params
+    end
+
+    def result(response)
+      content_type = response.header['content-type']
+
+      if content_type.include? 'application/json'
+        return self.cdn_result(response)
+      end
+
+      BytesResult.new(response.body.bytes)
+    end
+
+    def cdn_result(response)
+      body = JSON.parse(response.body)
+      created_at = Date.iso8601 body['createdAt']
+      converted_at = nil
+
+      if body['converted_at']
+        converted_at = Date.iso8601 body['convertedAt']
+      end
+
+      result = nil
+
+      if body['result']
+        result = Conversion::Result.new (Date.iso8601 body['result']['expiresAt']), body['result']['size'], body['result']['url']
+      end
+
+      conversion = Conversion.new created_at, converted_at, body['status'], body['error'], result
+    end
+  end
+end

data/lib/conversion.rb

@@ -0,0 +1,30 @@
+require 'httparty'
+require_relative 'result'
+
+module PDFire
+  class Conversion < Result
+    attr_reader :created_at, :converted_at, :status, :error, :result
+
+    def initialize(created_at, converted_at, status, error, result)
+      @created_at = created_at
+      @converted_at = converted_at
+      @status = status
+      @error = error
+      @result = result
+    end
+
+    def bytes()
+      HTTParty.get(self.result.url).body.bytes
+    end
+  end
+
+  class Conversion::Result
+    attr_reader :expires_at, :size, :url
+
+    def initialize(expires_at, size, url)
+      @expires_at = expires_at
+      @size = size
+      @url = url
+    end
+  end
+end

data/lib/conversion_params.rb

@@ -0,0 +1,115 @@
+module PDFire
+  class ConversionParams
+    # @return [String]
+    attr_accessor :html
+    # @return [String]
+    attr_accessor :url
+    # @return [Boolean]
+    attr_accessor :cdn
+    # @return [Boolean]
+    attr_accessor :landscape
+    # @return [Boolean]
+    attr_accessor :print_background
+    # @return [Boolean]
+    attr_accessor :scale
+    # @return [Float]
+    attr_accessor :format
+    # @return [Integer, String]
+    attr_accessor :paper_width
+    # @return [Integer, String]
+    attr_accessor :paper_height
+    # @return [Integer, String]
+    attr_accessor :margin
+    # @return [Integer, String]
+    attr_accessor :margin_top
+    # @return [Integer, String]
+    attr_accessor :margin_right
+    # @return [Integer, String]
+    attr_accessor :margin_bottom
+    # @return [Integer, String]
+    attr_accessor :margin_left
+    # @return [String]
+    attr_accessor :page_ranges
+    # @return [String]
+    attr_accessor :header_template
+    # @return [String]
+    attr_accessor :footer_template
+    # @return [Boolean]
+    attr_accessor :prefer_css_page_size
+    # @return [Integer, String]
+    attr_accessor :viewport_width
+    # @return [Integer, String]
+    attr_accessor :viewport_height
+    # @return [Boolean]
+    attr_accessor :block_ads
+    # @return [String]
+    attr_accessor :selector
+    # @return [String]
+    attr_accessor :wait_for_selector
+    # @return [Integer]
+    attr_accessor :wait_for_selector_timeout
+    # @return [String]
+    attr_accessor :wait_until
+    # @return [Integer]
+    attr_accessor :wait_until_timeout
+    # @return [Integer]
+    attr_accessor :delay
+    # @return [Integer]
+    attr_accessor :timeout
+    # @return [Hash]
+    attr_accessor :headers
+    # @return [String]
+    attr_accessor :emulate_media
+    # @return [String]
+    attr_accessor :owner_password
+    # @return [String]
+    attr_accessor :user_password
+
+    # Set the page ranges of the PDF.
+    # @param ranges [Array<Integer, String>]
+    # @return [PDFire::ConversionParams]
+    def page_ranges(*ranges)
+      @page_ranges = ranges.join(',')
+      return self
+    end
+
+    def to_map
+      map = {}
+
+      map['html'] = @html if @html != nil
+      map['url'] = @url if @url != nil
+      map['cdn'] = @cdn if @cdn != nil
+      map['landscape'] = @landscape if @landscape != nil
+      map['printBackground'] = @print_background if @print_background != nil
+      map['scale'] = @scale if @scale != nil
+      map['format'] = @format if @format != nil
+      map['paperWidth'] = @paper_width if @paper_width != nil
+      map['paperHeight'] = @paper_height if @paper_height != nil
+      map['margin'] = @margin if @margin != nil
+      map['marginTop'] = @margin_top if @margin_top != nil
+      map['marginRight'] = @margin_right if @margin_right != nil
+      map['marginBottom'] = @margin_bottom if @margin_bottom != nil
+      map['marginLeft'] = @margin_left if @margin_left != nil
+      map['pageRanges'] = @page_ranges if @page_ranges != nil
+      map['headerTemplate'] = @header_template if @header_template != nil
+      map['footerTemplate'] = @footer_template if @footer_template != nil
+      map['preferCSSPageSize'] = @prefer_css_page_size if @prefer_css_page_size != nil
+      map['viewportWidth'] = @viewport_width if @viewport_width != nil
+      map['viewportHeight'] = @viewport_height if @viewport_height != nil
+      map['blockAds'] = @block_ads if @block_ads != nil
+      map['selector'] = @selector if @selector != nil
+      map['waitForSelector'] = @wait_for_selector if @wait_for_selector != nil
+      map['waitForSelectorTimeout'] = @wait_for_selector_timeout if @wait_for_selector_timeout != nil
+      map['waitUntil'] = @wait_until if @wait_until != nil
+      map['waitUntilTimeout'] = @wait_until_timeout if @wait_until_timeout != nil
+      map['delay'] = @delay if @delay != nil
+      map['timeout'] = @timeout if @timeout != nil
+      map['headers'] = @headers if @headers != nil
+      map['emulateMedia'] = @emulate_media if @emulate_media != nil
+      map['ownerPassword'] = @owner_password if @owner_password != nil
+      map['userPassword'] = @user_password if @user_password != nil
+
+      return map
+    end
+  end
+end

data/lib/errors.rb

@@ -0,0 +1,45 @@
+module PDFire
+  class ApiError
+    attr_reader :message
+  end
+
+  class RequestError < StandardError
+    attr_reader :errors
+    attr_reader :message
+
+    def initialize(errors, default = 'Request error.')
+      @errors = errors
+      @message = errors.length == 0 ? errors[0].message : default
+    end
+  end
+
+  class InvalidRequestError < RequestError
+    def initialize(errors)
+      super(errors, 'Invalid request.')
+    end
+  end
+
+  class AuthenticationError < RequestError
+    def initialize(errors)
+      super(errors, 'Unauthenticated.')
+    end
+  end
+
+  class QuotaExceededError < RequestError
+    def initialize(errors)
+      super(errors, 'Quota exceeded.')
+    end
+  end
+
+  class ForbiddenActionError < RequestError
+    def initialize(errors)
+      super(errors, 'Forbidden action.')
+    end
+  end
+
+  class ConversionError < RequestError
+    def initialize(errors)
+      super(errors, 'Conversion failed.')
+    end
+  end
+end

data/lib/merge_params.rb

@@ -0,0 +1,29 @@
+module PDFire
+  class MergeParams
+    # @return [Array<PDFire::ConversionParams>]
+    attr_accessor :documents
+    # @return [Boolean]
+    attr_accessor :cdn
+    # @return [String]
+    attr_accessor :owner_password
+    # @return [String]
+    attr_accessor :user_password
+
+    def initialize(documents = [], cdn = nil, owner_password = nil, user_password = nil)
+      @documents = documents
+      @cdn = cdn
+      @owner_password = owner_password
+      @user_password = user_password
+    end
+
+    def to_map
+      map = {}
+      map['documents'] = @documents.map { |doc| doc.to_map } if @documents.length > 0
+      map['cdn'] = @cdn if @cdn != nil
+      map['ownerPassword'] = @owner_password if @owner_password != nil
+      map['userPassword'] = @user_password if @user_password != nil
+
+      return map
+    end
+  end
+end

data/lib/result.rb

@@ -0,0 +1,7 @@
+module PDFire
+  class Result
+    def save_to(filepath)
+      File.open(filepath, 'wb') { |file| file.write(self.bytes().pack 'C*') }
+    end
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: pdfire
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- modernice Ltd.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-22 00:00:00.000000000 Z
+dependencies: []
+description: PDFire API client for ruby. Get an API key at https://pdfire.io
+email: info@modernice.ltd
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/bytes_result.rb
+- lib/client.rb
+- lib/conversion.rb
+- lib/conversion_params.rb
+- lib/errors.rb
+- lib/merge_params.rb
+- lib/result.rb
+homepage: https://pdfire.io
+licenses:
+- MIT
+metadata:
+  source-code-uri: https://github.com/modernice/pdfire-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: PDFire API client.
+test_files: []