ilovepdf 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63a3af9ac1c6a9c1bdcd15ae6a8710aa6fb407cf
+  data.tar.gz: 37d7898f34c9d1bd1b95849ae9321acf29a2fca5
+SHA512:
+  metadata.gz: 9f2027499fac6671bf9260c9df6198c310623a7fca64abf1aeba6779253d38f640d53a03321bba996061660d144e013edf756c4d4f138ea1eb310da5ab9a66c0
+  data.tar.gz: 8a983ecc5ca1f6cf8433c0ff5c31deb60d27620f4693cc2db2a667246497c8656187ec2d640f755a91eaa3bf806fd5d23c2132da0323ffa970ccd8f767da35a1

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ilovepdf.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 iLovePDF
+
+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,142 @@
+iLovePDF Api - Ruby Library
+--------------------------
+[![GitHub version](https://badge.fury.io/gh/ilovepdf%2Filovepdf-ruby.svg)](https://badge.fury.io/gh/ilovepdf%2Filovepdf-ruby)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A library in ruby for [iLovePDF Api](https://developer.ilovepdf.com)
+
+You can sign up for a iLovePDF account at https://developer.ilovepdf.com
+
+Develop and automate PDF processing tasks like: 
+
+* Compress PDF
+* Merge PDF
+* Split PDF
+* Convert Office to PDF
+* PDF to JPG
+* Images to PDF
+* Add Page Numbers
+* Rotate PDF
+* Unlock PDF
+* Protect PDF
+* Stamp a Watermark
+* Repair PDF
+* PDF to PDF/A
+
+Each one with several settings to get your desired results.
+
+## Requirements
+Ruby 2.0 or greater
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ilovepdf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ilovepdf
+
+## Usage
+
+### Getting started
+The quickest way to get started is to first get a set of [API keys here](https://developer.ilovepdf.com/)
+and run the following code snippet:
+
+```ruby
+public_key  = 'YOUR_PUBLIC_KEY'
+private_key = 'YOUR_PRIVATE_KEY'
+ilovepdf = Ilovepdf::Ilovepdf.new(public_key, private_key)
+# Create a task with the tool you want to use:
+task = ilovepdf.new_task :compress
+# Add the files you want to upload...
+file1 = task.add_file 'my_disk/my_example1.pdf'
+file2 = task.add_file 'my_disk/my_example2.pdf'
+file3 = task.add_file_from_url 'http://URL_TO_PDF'
+# Once you are done uploading your files:
+task.execute
+task.download
+```
+That's it!
+
+For a more in-depth usage, refer to the [sample codes](https://github.com/ilovepdf/ilovepdf-ruby/tree/master/samples) in this repository.
+
+## Documentation
+### HTTP API Calls
+All PDF tools have the following methods that contact with the iLovePDF API:
+
+| Method                  | Description                                               | Notes                         |
+| ------------------------|-----------------------------------------------------------|-------------------------------|
+| add_file(file)          | Uploads a file to iLovepdf servers                        | Returns boolean               |
+| add_file_from_url(url)  | Uploads a file to iLovepdf servers using a URL            | Returns boolean               |
+| delete_file(file)       | Deletes a file from ilovepdf                              | Returns boolean               |
+| download(filepath)      | Downloads the processed file                              | Returns boolean; No need to specify a filepath|
+| status                  | Retrieves the current status of the task being processed  | Returns Ilovepdf::Response    |
+| execute                 | Sends a request to Ilovepdf to begin processing the PDFs  | Returns Ilovepdf::Response    |
+| delete!                 | Deletes the task                                          | Returns Ilovepdf::Response    |
+
+Example:
+```ruby
+imagepdf_task = Ilovepdf::Tool::Imagepdf.new(public_key, secret_key)
+http_response = imagepdf_task.execute
+puts http_response.body
+if imagepdf_task.download.success?
+  puts "Your file was downloaded successfully!"
+end
+```
+
+### Methods common to all tools
+| Method                                | Description                                               | Notes                                       |
+| --------------------------------------|-----------------------------------------------------------|---------------------------------------------|
+| enable_file_encryption(boolean, key)  | The key will be used to decrypt the files before processing and re-encrypt them after processing        | If no key provided, a random key is assigned (default: false) |
+| assign_meta_value(key, value)         | [More info](https://developer.ilovepdf.com/docs/api-reference)      |                                   |
+| ignore_errors                         | [More info](https://developer.ilovepdf.com/docs/api-reference)      | (default: true)                   |
+| ignore_password                       | [More info](https://developer.ilovepdf.com/docs/api-reference)      | (default: true)                   |
+| try_pdf_repair                        | When a PDF to process fails we try to repair it automatically       | (default: true)                   |
+| packaged_filename                     | This allows you to specify the filename of the compressed file in case there is more than 1 file to be downloaded | |
+| output_filename                       | The final name of the processed file                                |                                   |
+
+### Tool attributes
+
+All tools have specific attributes you can access and modify.
+If you need want to know which params are available for a specific tool via the code, you can by looking at the **API_PARAMS** of that particular tool.
+For example for the **Image to PDF** tool:
+```ruby
+puts Ilovepdf::Tool::Imagepdf::API_PARAMS
+# => [:orientation, :margin, :pagesize]
+```
+
+To instantiate a Compress tool task directly do:
+```ruby
+compress_task = Ilovepdf::Tool::Compress.new(public_key, secret_key)
+```
+
+### Handling errors
+
+Whenever there is an API Error in one of the endpoints, you can try to capture it the following way:
+
+```ruby
+begin
+  compress_task = Ilovepdf::Tool::Compress.new(public_key, secret_key)
+  compress_task.execute # Oops, this raises an error! I forgot to upload a file!
+  compress_taks.download
+rescue Ilovepdf::ApiError => e
+  # Let's check what went wrong with the API call:
+  puts e.http_response.body
+end
+```
+
+For a more complete example of error handling check [samples/try_catch_errors.rb](https://github.com/ilovepdf/ilovepdf-ruby/blob/master/samples/try_catch_errors.rb)
+
+Please see https://developer.ilovepdf.com/docs for up-to-date documentation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'byebug'
+require "addressable/uri"
+require "addressable/template"
+require "ilovepdf"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ilovepdf.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ilovepdf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ilovepdf"
+  spec.version       = Ilovepdf::VERSION
+  spec.authors       = ["Leonardo Collazo"]
+  spec.email         = ["leonardo.chronicles@gmail.com"]
+
+  spec.summary       = %q{A library in Ruby for iLovePDF Api}
+  spec.description   = %q{Develop and automate PDF processing tasks like Compress PDF, Merge PDF, Split PDF, convert Office to PDF, PDF to JPG, Images to PDF, add Page Numbers, Rotate PDF, Unlock PDF, stamp a Watermark and Repair PDF. Each one with several settings to get your desired results.}
+  spec.homepage      = "https://github.com/ilovepdf/ilovepdf-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_runtime_dependency 'rest-client', '~> 2'
+  spec.add_runtime_dependency 'jwt', '~> 1.5'
+
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", "~> 9"
+  spec.add_development_dependency "webmock", "~> 3"
+  spec.add_development_dependency "addressable", "~> 2.5"
+end

data/lib/ilovepdf.rb

@@ -0,0 +1,36 @@
+require "ilovepdf/version"
+require 'pathname'
+require 'securerandom'
+
+# 3rd party gems
+require 'jwt'
+require 'rest-client'
+
+# Base classes
+require "ilovepdf/errors"
+require "ilovepdf/response"
+require "ilovepdf/ilovepdf"
+require "ilovepdf/file"
+require "ilovepdf/task"
+
+# Load tool classes
+require 'ilovepdf/tool/compress'
+require 'ilovepdf/tool/imagepdf'
+require 'ilovepdf/tool/merge'
+require 'ilovepdf/tool/officepdf'
+require 'ilovepdf/tool/pagenumber'
+require 'ilovepdf/tool/pdfa'
+require 'ilovepdf/tool/pdfjpg'
+require 'ilovepdf/tool/repair'
+require 'ilovepdf/tool/rotate'
+require 'ilovepdf/tool/split'
+require 'ilovepdf/tool/unlock'
+require 'ilovepdf/tool/watermark'
+
+module Ilovepdf
+  class << self
+    def root
+      @root_path ||= Pathname.new(::File.dirname(::File.expand_path('../', __FILE__)))
+    end
+  end
+end

data/lib/ilovepdf/errors.rb

@@ -0,0 +1,51 @@
+module Ilovepdf
+  # Base error classes
+  class Error < StandardError
+  end
+
+  class ApiError < Error
+    attr_accessor :http_response
+    def initialize(http_response, custom_msg: nil)
+      msg_to_use = custom_msg ? custom_msg : extract_error_text(http_response)
+      super(msg_to_use)
+      self.http_response = http_response
+    end
+
+    private
+    def extract_error_text(http_response)
+      r_body = http_response.body
+      if r_body['name']
+        title = r_body['name']
+        msg   = r_body['message']
+      elsif r_body['error']
+        title = r_body['error']['type']
+        msg   = r_body['error']['message']
+        if r_body['error']['param']
+          msg << " Details: " + r_body['error']['param'].to_s
+        end
+      else
+        title = 'An error ocurred'
+        msg = 'Check the response from the server'
+      end
+      "[#{title}] #{msg}"
+    end
+  end
+  module Errors
+    # Endpoint-specific errors
+    class AuthError < ::Ilovepdf::ApiError
+    end
+    class ProcessError < ::Ilovepdf::ApiError
+    end
+    class StartError < ::Ilovepdf::ApiError
+    end
+    class UploadError < ::Ilovepdf::ApiError
+    end
+
+    # Library errors
+    class ArgumentEnumError < ::ArgumentError
+      def initialize(valid_values)
+        super("Provided argument is invalid. Valid values: #{valid_values.join(', ')}")
+      end
+    end
+  end
+end

data/lib/ilovepdf/file.rb

@@ -0,0 +1,36 @@
+module Ilovepdf
+  class File
+    attr_accessor :server_filename, :filename, :password
+    attr_reader :rotate
+
+    ROTATION_VALUES = [0, 90, 180, 270]
+
+    def initialize(server_filename, filename)
+      self.server_filename  = server_filename
+      self.filename         = filename
+      @deleted = false
+    end
+
+    def file_options
+      {
+        server_filename: self.server_filename,
+        filename: self.filename,
+        rotate: self.rotate,
+        password: self.password
+      }
+    end
+
+    def rotate= degrees
+      raise Errors::ArgumentEnumError.new(ROTATION_VALUES) unless ROTATION_VALUES.include? degrees
+      @rotate = degrees
+    end
+
+    def mark_as_deleted
+      @deleted = true
+    end
+
+    def deleted?
+      @deleted
+    end
+  end
+end

data/lib/ilovepdf/ilovepdf.rb

@@ -0,0 +1,142 @@
+module Ilovepdf
+  class Ilovepdf
+    attr_accessor :api_version, :token, :encrypt_key ,:debug
+
+    START_SERVER        = 'https://api.ilovepdf.com'.freeze
+    API_VERSION         = 'v1'.freeze
+    TOKEN_ALGORITHM     = 'HS256'.freeze
+    ALL_ENDPOINTS       = [:start, :upload, :process, :download, :task].freeze
+    LONG_JOB_ENDPOINTS  = [:process, :upload, :download].freeze
+
+    TIME_DELAY = 5400
+
+    def initialize(public_key=nil, secret_key=nil)
+      set_api_keys(public_key, secret_key)
+      api_version = API_VERSION
+    end
+
+    def new_task(tool_name)
+      task_klass = ::Ilovepdf::Tool.const_get(tool_name.to_s.capitalize) rescue false
+      unless task_klass
+        raise ::Ilovepdf::Error.new("Unknown tool '#{tool_name}'. Available tools: #{self.class.all_tool_names.to_s}")
+      end
+      task_klass.new(@public_key, @secret_key)
+    end
+
+    def self.all_tool_names
+      ::Ilovepdf::Tool.constants.map(&:downcase)
+    end
+
+    def self.raise_exceptions=(value)
+      @raise_exceptions = value
+    end
+
+    def self.raise_exceptions?
+      @raise_exceptions.eql?(true)
+    end
+
+    def set_api_keys(public_key, secret_key)
+      @public_key = public_key
+      @secret_key = secret_key
+    end
+
+    def enable_file_encryption(enable, new_encrypt_key = nil)
+      if enable
+        if new_encrypt_key && ![16, 24, 32].include?(new_encrypt_key.size)
+          raise ArgumentError.new("Encryption key must be 16, 24 or 32 characters long")
+        end
+        self.encrypt_key = new_encrypt_key || SecureRandom.hex(16)
+      else
+        self.encrypt_key = nil
+      end
+      nil
+    end
+
+    private
+
+    def jwt
+      raise Error.new('You must provide a set of API keys') unless api_keys_present?
+      @token = JWT.encode jwt_token_payload, @secret_key, token_algorithm
+    end
+
+    def send_request(http_method, endpoint, extra_opts={})
+      to_server = worker_server ? worker_server : START_SERVER
+
+      timeout_to_use = LONG_JOB_ENDPOINTS.include?(endpoint.to_sym) ? nil : 10
+      extra_opts[:body]     ||= {}
+      extra_opts[:headers]  ||= {}
+
+      extra_opts[:headers].merge!({
+        'Accept' => 'application/json',
+        'Authorization' => "Bearer " + jwt
+      })
+
+      extra_opts[:body][:debug] = true if self.debug
+
+      request_uri = to_server + "/v1/#{endpoint}"
+      begin
+        rest_response = RestClient::Request.execute(  method: http_method.to_sym, url: request_uri, timeout: timeout_to_use,
+                                                      headers: extra_opts[:headers], payload: extra_opts[:body]
+                                                   )
+        response = Response.new(rest_response)
+      rescue RestClient::Unauthorized => e
+        raise Errors::AuthError.new(Response.new(e.response))
+      rescue RestClient::Exception => e
+        raise klass_error_for(endpoint).new(Response.new(e.response))
+      end
+
+      response
+    end
+
+    def api_keys_present?
+      !@public_key.nil? && !@secret_key.nil?
+    end
+
+    def klass_error_for(endpoint)
+      error_klass = ::Ilovepdf::Errors.const_get("#{endpoint.to_s.capitalize}Error") rescue false
+      error_klass = ::Ilovepdf::ApiError if !error_klass # use generic ApiError
+      error_klass
+    end
+
+    def query_task_status(new_server, task_id)
+      old_server     = worker_server
+      worker_server  = new_server
+      begin
+        response = send_request('get', 'task/' + task_id.to_s)
+      ensure
+        worker_server = old_server
+      end
+      response
+    end
+
+    def jwt_token_payload
+      current_time = Time.now.to_i
+      params = {
+        iss: '', # hostInfo
+        aud: '', # hostInfo
+        iat: current_time - TIME_DELAY,         # add some "delay"
+        nbf: current_time - TIME_DELAY,         # add some "delay"
+        exp: current_time + 3600 + TIME_DELAY,  # add some "delay"
+        jti: @public_key
+      }
+
+      params[:file_encryption_key] = self.encrypt_key if is_file_encrypted?
+      params
+    end
+
+    def worker_server; @worker_server; end
+    def worker_server= new_server; @worker_server = new_server; end
+
+    def is_file_encrypted?
+      !self.encrypt_key.nil?
+    end
+
+    def token_algorithm
+      TOKEN_ALGORITHM
+    end
+
+    def token
+      @token
+    end
+  end # Ilovepdf
+end