ilovepdf 1.3.1 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 40f8c75f0001c5018bfe9916546965192e6581d8
-  data.tar.gz: 9ca611361ccd485ea7a84555dec6a9b63879adf2
+SHA256:
+  metadata.gz: ed633b60a4ee0aaa209849e234cadd731bdf40ea64f89738d5ad12599cde9e91
+  data.tar.gz: 0b19f9d1d76b024cb9e382a9cf96fc72e2d94cd92512613ff8b92e850839627f
 SHA512:
-  metadata.gz: 474cde19c9fa02183d3a967e7d2f4ded8e6e008e0a8d05b1f73f8e087618774e996a5d2c59893aad552c4d3d724f542224326668f91f59fbf21d214c230cb33f
-  data.tar.gz: 489a5bf27973204b423ef75ec5039727d54c3073262011d02defddd90924e2255a4834b2a374c9425ec5e5e3efa8f73bc95fa65d547f0eda8f675720c7c5d887
+  metadata.gz: f71245b644289f6e59dcf55cf6c8ac25e218191ee745e0f640c0f8e866d5f70a9ff245c4acd83861fd2a8eb202a198e99a48cac42afceda529c1c96e440f1221
+  data.tar.gz: 2887db879e62bd3d7f04ee8db462d3df9ea978f0ba187e4bb77f9d0a161fc5df0c048b45b987f75c9633a955bd4527a0b3a6c044976be88347f725604c57c16a

data/.travis.yml

@@ -1,7 +1,7 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.5.0
+  - 2.6.6
 branches:
   only:
   - master

data/README.md

@@ -25,11 +25,12 @@ Develop and automate PDF processing tasks like:
 * PDF to PDF/A
 * Validate PDF/A
 * Extract
+* Sign PDF
 
 Each one with several settings to get your desired results.
 
 ## Requirements
-Ruby 2.3 or greater
+Ruby 2.6 or greater
 
 ## Installation
 
@@ -71,6 +72,25 @@ 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.
 
+## Signature Tool
+The usage of this tool is different than the other tools, the following example shows how to create a signature using the iLovePDF API:
+```ruby
+my_task = Ilovepdf::Tool::Signature.new(pub_key, priv_key)
+# File object keeps information about its server_filename and the properties you can set
+file  = my_task.add_file '/path/to/file/sample.pdf'
+
+signer = Ilovepdf::Signature::Receiver.new(:signer,'name','email@email.com')
+
+signature_element = Ilovepdf::Signature::SignatureElement.new(file)
+signature_element.set_position(x: 20, y: -20)
+signature_element.pages = "1"
+signature_element.size = 40
+
+signer << signature_element
+body = my_task.send_to_sign.body
+```
+For a more in-depth usage, refer to all of the signature examples on 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:

data/ilovepdf.gemspec

@@ -6,8 +6,8 @@ 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.authors       = ["Leonardo Collazo", "Guillem Vidal"]
+  spec.email         = ["leonardo.chronicles@gmail.com", "g.vidal.cantavella@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.}
@@ -20,10 +20,11 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = '>= 2.6'
 
   spec.add_runtime_dependency 'rest-client', '~> 2'
   spec.add_runtime_dependency 'jwt', '~> 2'
+  spec.add_runtime_dependency 'json', '~> 2'
 
 
   spec.add_development_dependency "bundler", ">= 1.16"

data/lib/ilovepdf/element.rb

@@ -0,0 +1,79 @@
+module Ilovepdf
+  class Element
+    FONT_FAMILY_VALUES = ['Arial', 'Arial Unicode MS', 'Verdana', 'Courier',
+                            'Times New Roman', 'Comic Sans MS', 'WenQuanYi Zen Hei',
+                            'Lohit Marathi'
+                         ]
+
+    VERTICAL_POSITION_VALUES    = ['bottom', 'middle' ,'top']
+    HORIZONTAL_POSITION_VALUES  = ['left', 'center', 'right']
+
+    LAYER_VALUES = ['above', 'below']
+    
+    ATTR_DEFAULT_VALUES = {
+        type: 'text',
+        mode: 'text',
+        text: nil,
+        image: nil,
+        pages: 'all',
+        vertical_position: 'middle',
+        horizontal_position: 'center',
+        vertical_adjustment: 0,
+        horizontal_adjustment: 0,
+        rotation: 0,
+        transparency: 100,
+        mosaic: false,
+        font_family: nil,
+        font_style: 'Regular',
+        font_color: '#000000',
+        font_size: 14,
+        image_resize: 1,
+        zoom: 1,
+        gravity: 'center',
+        border: nil,
+        layer: nil,
+        bold: false,
+        server_filename: nil
+      }
+
+    attr_accessor *ATTR_DEFAULT_VALUES.keys
+
+    def initialize(params={})
+      init_values = ATTR_DEFAULT_VALUES.merge(params)
+      init_values.delete_if{|k, v| v.nil? }
+      init_values.each_pair do |k, v|
+        public_send(:"#{k}=", v)
+      end # /each_pair
+    end # /initialize
+
+    def font_family=(new_val)
+      raise Errors::ArgumentEnumError.new(FONT_FAMILY_VALUES) unless FONT_FAMILY_VALUES.include? new_val
+      @font_family = new_val
+    end
+
+    def layer=(new_val)
+      raise Errors::ArgumentEnumError.new(LAYER_VALUES) unless LAYER_VALUES.include? new_val
+      @layer = new_val
+    end
+
+    def vertical_position=(new_val)
+      raise Errors::ArgumentEnumError.new(VERTICAL_POSITION_VALUES) unless VERTICAL_POSITION_VALUES.include? new_val
+      @vertical_position = new_val
+    end
+
+    def horizontal_position=(new_val)
+      raise Errors::ArgumentEnumError.new(HORIZONTAL_POSITION_VALUES) unless HORIZONTAL_POSITION_VALUES.include? new_val
+      @horizontal_position = new_val
+    end
+
+    def to_api_hash
+      export_hash = {}
+      ATTR_DEFAULT_VALUES.keys.each do |k|
+        val = send(k)
+        export_hash[k] = val if !val.nil?
+      end
+      export_hash
+    end
+
+  end
+end

data/lib/ilovepdf/errors.rb

@@ -40,9 +40,16 @@ module Ilovepdf
     end
     class UploadError < ::Ilovepdf::ApiError
     end
+    class DownloadError < ::Ilovepdf::ApiError
+    end
+    class StartError < ::Ilovepdf::ApiError
+    end
 
     # Library errors
-    class ArgumentEnumError < ::ArgumentError
+    class ArgumentError < ::ArgumentError
+    end
+    
+    class ArgumentEnumError < ArgumentError
       def initialize(valid_values)
         super("Provided argument is invalid. Valid values: #{valid_values.join(', ')}")
       end

data/lib/ilovepdf/file.rb

@@ -1,6 +1,6 @@
 module Ilovepdf
   class File
-    attr_accessor :server_filename, :filename, :password
+    attr_accessor :server_filename, :filename, :password, :info
     attr_reader :rotate
 
     ROTATION_VALUES = [0, 90, 180, 270]

data/lib/ilovepdf/ilovepdf.rb

@@ -2,7 +2,7 @@ module Ilovepdf
   class Ilovepdf
     attr_accessor :api_version, :token, :encrypt_key, :debug, :timeout, :long_timeout
 
-    START_SERVER        = 'https://api.ilovepdf.com'.freeze
+    START_SERVER        = Servers::START_SERVER
     API_VERSION         = 'ruby.v1'.freeze
     TOKEN_ALGORITHM     = 'HS256'.freeze
     ALL_ENDPOINTS       = [:start, :upload, :process, :download, :task].freeze
@@ -17,13 +17,13 @@ module Ilovepdf
       self.long_timeout = nil
     end
 
-    def new_task(tool_name)
+    def new_task(tool_name, make_start = true)
       camelized_name = Helper.camelize_str(tool_name.to_s)
       task_klass = ::Ilovepdf::Tool.const_get(camelized_name) 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)
+      task_klass.new(@public_key, @secret_key, make_start)
     end
 
     def self.all_tool_names
@@ -64,7 +64,6 @@ module Ilovepdf
 
     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) ? self.long_timeout : self.timeout
       extra_opts[:body]     ||= {}
       extra_opts[:headers]  ||= {}
@@ -77,6 +76,7 @@ module Ilovepdf
       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]
@@ -96,7 +96,11 @@ module Ilovepdf
     end
 
     def klass_error_for(endpoint)
-      error_klass = ::Ilovepdf::Errors.const_get("#{endpoint.to_s.capitalize}Error") rescue false
+      endpoint_base = /^([^\/\?]+)\/?/.match(endpoint)
+      if endpoint_base
+        endpoint_base = endpoint_base[1]
+        error_klass = ::Ilovepdf::Errors.const_get("#{endpoint_base.to_s.capitalize}Error") rescue false
+      end
       error_klass = ::Ilovepdf::ApiError if !error_klass # use generic ApiError
       error_klass
     end

data/lib/ilovepdf/refinements.rb

@@ -0,0 +1,30 @@
+module Ilovepdf
+  module Refinements
+    module Crush
+      refine Object do
+        def crush
+          self
+        end
+      end
+      refine Array do
+        def crush
+          r = map(&:crush).compact
+
+          r.empty? ? nil : r
+        end
+      end
+
+      refine Hash do
+        def crush
+          r = each_with_object({ }) do |(k, v), h|
+            if (_v = v.crush)
+              h[k] = _v
+            end
+          end
+
+          r.empty? ? nil : r
+        end
+      end
+    end
+  end
+end

data/lib/ilovepdf/request_payload/form_url_encoded.rb

@@ -0,0 +1,54 @@
+module Ilovepdf
+  module RequestPayload
+    class FormUrlEncoded
+      def initialize(body)
+        raise ArgumentError.new("Body must be a hash") unless body.is_a?(Hash)
+        @body = body
+      end
+
+      def mime_type
+        'application/x-www-form-urlencoded'
+      end
+
+      def extract_to_s
+        components = []
+
+        @body.each do |key, value|
+          resolved_val = stringify_into_form_format(key, value)
+          components << resolved_val if !resolved_val.nil?
+        end
+
+        components.join("&")
+      end
+
+      private
+
+      def stringify_into_form_format(key, value)
+        components = []
+
+        if value.is_a?(Hash)
+          return nil if value.empty?
+          value.each do|hk, hv|
+            prop_name = URI.encode_www_form_component(hk)
+            resolved_val = stringify_into_form_format("#{key}[#{prop_name}]", hv)
+            components << resolved_val
+          end
+        elsif value.is_a?(Array)
+          return nil if value.empty?
+          value.each_with_index do |array_item, idx|
+            resolved_val = stringify_into_form_format("#{key}[#{idx}]", array_item)
+            next if resolved_val.nil?
+            components << resolved_val
+          end
+        else
+          return nil if value.nil?
+          resolved_val = "#{key}=" + URI.encode_www_form_component(value)
+          components << resolved_val
+        end
+
+        components.join("&")
+      end
+
+    end # /UrlEncoded class
+  end
+end

data/lib/ilovepdf/servers.rb

@@ -0,0 +1,7 @@
+module Ilovepdf
+  module Servers
+    PROTOCOL = 'https'.freeze
+    HOST = 'api'.freeze
+    START_SERVER = "#{PROTOCOL}://#{HOST}.ilovepdf.com".freeze
+  end
+end

data/lib/ilovepdf/signature/date_element.rb

@@ -0,0 +1,16 @@
+module Ilovepdf
+  module Signature
+    class DateElement
+      include FileElement
+      def initialize(file)
+        super(file)
+        @type = :date
+      end
+
+      def date_format=(value)
+        raise ::Ilovepdf::Errors::ArgumentError.new("value must be a String type of object") unless value.is_a?(String)
+        @content = value
+      end
+    end
+  end
+end

data/lib/ilovepdf/signature/file_element.rb

@@ -0,0 +1,60 @@
+module Ilovepdf
+  module Signature
+    module FileElement
+      def self.included(base)
+        base.send(:include,InstanceMethods)
+      end
+
+      module InstanceMethods
+        attr_reader :file,:position,:pages,:size,:info,:type,:content
+        def initialize(file)
+          raise ::Ilovepdf::Errors::ArgumentError.new("Only Ilovepdf::File type of object is allowed") unless file.class.name == "Ilovepdf::File"
+          @file = file
+          @position = "0 0"
+          @pages = "1"
+          @size = 40
+        end
+
+        def set_position(x: 0,y: 0)
+          raise ::Ilovepdf::Errors::ArgumentError.new("x must be an integer or float") unless x.is_a?(Integer) || x.is_a?(Float)
+          raise ::Ilovepdf::Errors::ArgumentError.new("y must be an integer or float") unless y.is_a?(Integer) || y.is_a?(Float)
+          @position = "#{x.abs} #{-y.abs}"
+          position
+        end
+
+        def pages=(value)
+          raise ::Ilovepdf::Errors::ArgumentError.new("value must be string type") unless value.is_a?(String)
+          @pages = value
+        end
+
+        def size=(value)
+          raise ::Ilovepdf::Errors::ArgumentError.new("value must be Integer type") unless value.is_a?(Integer)
+          @size = value
+        end
+
+        def to_h
+          {
+            position: position,
+            pages: pages,
+            size: size,
+            info: info,
+            type: type,
+            content: content
+          }
+        end
+
+        def info
+          @info && @info.to_json
+        end
+
+        protected
+
+        def set_info_parameter(parameter_name,value)
+          @info ||= {}
+          @info[parameter_name] = value
+          @info
+        end
+      end
+    end
+  end
+end

data/lib/ilovepdf/signature/initials_element.rb

@@ -0,0 +1,11 @@
+module Ilovepdf
+  module Signature
+    class InitialsElement
+      include FileElement
+      def initialize(file)
+        super(file)
+        @type = :initials
+      end
+    end
+  end
+end

data/lib/ilovepdf/signature/input_element.rb

@@ -0,0 +1,27 @@
+module Ilovepdf
+  module Signature
+    class InputElement
+      include FileElement
+      def initialize(file, label,description = nil)
+        super(file)
+        self.label=label
+        self.description=description
+        @type = :input
+      end
+
+      def set_info(label: "", description:)
+        @info = {}.to_s
+      end
+
+      def label=(value)
+        raise ::Ilovepdf::Errors::ArgumentError.new("value must be a String type of object") unless value.is_a?(String)
+        self.set_info_parameter(:label,value)
+      end
+
+      def description=(value)
+        raise ::Ilovepdf::Errors::ArgumentError.new("value must be a String type of object") unless value.is_a?(String)
+        self.set_info_parameter(:description,value)
+      end
+    end
+  end
+end

data/lib/ilovepdf/signature/management.rb

@@ -0,0 +1,103 @@
+module Ilovepdf
+  module Signature
+    class Management < ::Ilovepdf::Task
+
+      def initialize(public_key, secret_key, make_start=false)
+        self.tool = :sign
+        super(public_key, secret_key, make_start)
+      end
+
+      def get_status(signature_token)
+        send_request("get", "signature/requesterview/#{signature_token}")
+      end
+
+      def list_signatures(current_page: 0,per_page: 20)
+        send_request("get", "signature/list", body: {page: current_page,per_page: per_page})
+      end
+
+      def download_audit(signature_token, directory = __dir__,create_directory: true,filename:)
+        download_file("signature/#{signature_token}/download-audit",directory,create_directory: create_directory, filename: filename)
+      end
+
+      def download_original(signature_token, directory = __dir__,create_directory: true,filename:)
+        download_file("signature/#{signature_token}/download-original",directory,create_directory: create_directory, filename: filename)
+      end
+
+      def download_signed(signature_token, directory = __dir__,create_directory: true,filename:)
+        download_file("signature/#{signature_token}/download-signed",directory,create_directory: create_directory, filename: filename)
+      end
+
+      def send_reminders(signature_token)
+        send_request("post","signature/sendReminder/#{signature_token}")
+      end
+
+      def void_signature(signature_token)
+        send_request("put","signature/void/#{signature_token}")
+      end
+
+      def increase_expiration_days(signature_token,days_to_increase)
+        body = {days: days_to_increase}
+        extracted_body = RequestPayload::FormUrlEncoded.new(body).extract_to_s
+        send_request("put","signature/increase-expiration-days/#{signature_token}", body: extracted_body)
+      end
+
+      def get_receiver_info(signer_token)
+        send_request("get", "signature/receiver/info/#{signer_token}")
+      end
+
+      def fix_receiver_email(signer_token, new_email)
+        body = {email: new_email}
+        extracted_body = RequestPayload::FormUrlEncoded.new(body).extract_to_s
+        send_request("put","signature/receiver/fix-email/#{signer_token}", body: extracted_body)
+      end
+
+      def fix_receiver_phone(signer_token, new_phone)
+        body = {phone: new_phone}
+        extracted_body = RequestPayload::FormUrlEncoded.new(body).extract_to_s
+      send_request("put","signature/receiver/fix-phone/#{signer_token}", body: extracted_body)
+      end
+
+      private
+
+      def download_file(url,directory,create_directory: true,filename:)
+        if self.worker_server.nil?
+          response = perform_start_request
+          self.worker_server = "#{Servers::PROTOCOL}://" + response.body['server']
+        end
+        
+        response = send_request("get",url)
+        content_disposition = response.headers[:content_disposition]
+        filename_to_set = ::File.basename(filename,::File.extname(filename)) unless filename.nil?
+        external_filename = parse_filename_from_content_disposition(content_disposition)
+
+        if filename_to_set.nil?
+          filename_to_set = external_filename 
+        else
+          filename_to_set << ::File.extname(external_filename)
+        end
+
+        if directory
+          directory = Pathname.new(directory).to_s if directory.is_a?(Pathname)
+          directory.chop! if directory.end_with? '/'
+        else
+          directory = '.'
+        end
+
+        destination = "#{directory}/#{filename_to_set}"
+
+        FileUtils.mkdir_p(directory) if create_directory
+        ::File.open(destination, 'wb'){|file| file.write(response.raw_body) }
+        destination
+      end
+
+      def parse_filename_from_content_disposition(content_disposition)
+        if match_data = /filename\*\=utf-8\'\'([\W\w]+)/.match(content_disposition)
+          filename_to_set = URI.unescape(match_data[1].gsub('"', ''))
+        else
+          match_data  = / .*filename=\"([\W\w]+)\"/.match(content_disposition)
+          filename_to_set =  match_data[1].gsub('"', '')
+        end
+      end
+    end
+  end
+end

data/lib/ilovepdf/signature/name_element.rb

@@ -0,0 +1,11 @@
+module Ilovepdf
+  module Signature
+    class NameElement
+      include FileElement
+      def initialize(file)
+        super(file)
+        @type = :name
+      end
+    end
+  end
+end

data/lib/ilovepdf/signature/receiver.rb

@@ -0,0 +1,87 @@
+module Ilovepdf
+  module Signature
+    class Receiver
+      ALLOWED_TYPES = [:signer,:validator,:viewer]
+
+      attr_reader :type,:name,:email,:phone, :access_code,:force_signature_type
+      def initialize(type,name,email, phone=nil)
+        @type = type
+        @name = name
+        @email = email
+        @phone = phone
+      end
+
+      def name=(value)
+        raise ::Ilovepdf::Errors::ArgumentError.new("Only String type of object is allowed") if !value.is_a?(String) || value.empty?
+        @name = value
+      end
+
+      def email=(value)
+        raise ::Ilovepdf::Errors::ArgumentError.new("Only String type of object is allowed") if !value.is_a?(String) || value.empty?
+        @email = value
+      end
+
+      def type=(value)
+        raise ::Ilovepdf::Errors::ArgumentError.new("type is not valid, valid types are: #{value.join(", ")}") unless ALLOWED_TYPES.include?(value)
+        @type = value
+      end
+
+      def phone=(value)
+        raise ::Ilovepdf::Errors::ArgumentError.new("Only String type of object is allowed") unless value.is_a?(String)
+        @phone = phone
+      end
+
+      def access_code=(value)
+        raise ::Ilovepdf::Errors::ArgumentError.new("Only String type of object is allowed") unless value.is_a?(String)
+        @access_code = value
+      end
+
+      def force_signature_type=(value)
+        raise ::Ilovepdf::Errors::ArgumentError.new("Only String type of object is allowed") unless value.is_a?(String)
+        @force_signature_type = value
+      end
+
+      def elements
+        @elements ||= []
+      end
+
+      def <<(element)
+        raise ::Ilovepdf::Errors::ArgumentError.new("Only Ilovepdf::Signature::FileElement type of object is allowed") unless element.is_a?(::Ilovepdf::Signature::FileElement)
+        @elements ||= []
+        @elements << element
+        elements
+      end
+      alias_method :add_receiver,:<<
+
+      def to_h
+        {
+          name: name,
+          email: email,
+          phone: phone,
+          type: type,
+          access_code: access_code,
+          force_signature_type: force_signature_type,
+          files: files_to_hash
+        }
+      end
+
+      private
+
+      def files_to_hash
+        files_hash = @elements.inject({}) do |result,element|
+          result[file.server_filename] ||= []
+          result[file.server_filename] << element
+          result
+        end
+        files_hash.inject([]) do |result,(server_filename,elements)|
+          {
+            server_filename: server_filename,
+            elements: elements.map do |element|
+              element.to_h
+            end
+          }
+        end
+      end
+    end
+  end
+end

data/lib/ilovepdf/signature/signature_element.rb

@@ -0,0 +1,11 @@
+module Ilovepdf
+  module Signature
+    class SignatureElement
+      include FileElement
+      def initialize(file)
+        super(file)
+        @type = :signature
+      end
+    end
+  end
+end