ilovepdf 1.3.1 → 1.3.4

data/lib/ilovepdf/signature/text_element.rb

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

data/lib/ilovepdf/signature.rb

@@ -0,0 +1,5 @@
+module Ilovepdf
+  module Signature
+
+  end
+end

data/lib/ilovepdf/signature_file.rb

@@ -0,0 +1,10 @@
+require 'ilovepdf/file'
+module Ilovepdf
+    class SignatureFile < File
+      attr_accessor :recipients
+      def recipients
+        @recipients ||= []
+      end
+    end
+  end
+end

data/lib/ilovepdf/task.rb

@@ -8,16 +8,50 @@ module Ilovepdf
     API_PARAMS    = []
     DOWNLOAD_INFO = [:output_filename, :output_file, :output_filetype]
 
-    def initialize(public_key, secret_key)
+    def initialize(public_key, secret_key, make_start=false)
       super(public_key, secret_key)
-      response = perform_create_request
-      self.worker_server = 'https://' + response.body['server']
-      self.task_id       = response.body['task']
-
       # Assign default values
       self.ignore_errors    = true
       self.ignore_password  = true
       self.try_pdf_repair   = true
+
+      @chained_task = (make_start == false)
+      if make_start
+        response = perform_start_request
+        self.worker_server = "#{Servers::PROTOCOL}://" + response.body['server']
+        self.task_id       = response.body['task']
+      end
+    end
+
+    def chained_task?
+      @chained_task
+    end
+
+    def next(next_tool)
+      body = {
+        v: API_VERSION,
+        task: self.task_id,
+        tool: next_tool,
+      }
+      extracted_body = RequestPayload::FormUrlEncoded.new(body).extract_to_s
+
+      begin
+        response = send_request('post', "task/next", body: extracted_body)
+        no_task_present = !response.body.key?('task') || response.body['task'].to_s.empty?
+        raise StartError.new(response, custom_msg: "No task assigned on chained start") if no_task_present
+      rescue ApiError => e
+        raise StartError.new(e, custom_msg: "Error on start chained task")
+      end
+
+      next_task = self.new_task(next_tool)
+      next_task.send(:"worker_server=", worker_server)
+      next_task.send(:"task_id=", response.body['task'])
+
+      response.body['files'].each do |server_filename, filename|
+        next_task.files << File.new(server_filename, filename)
+      end
+
+      next_task
     end
 
     def assign_meta_value(key, value)
@@ -116,7 +150,7 @@ module Ilovepdf
       content_disposition = response.headers[:content_disposition]
 
       if match_data = /filename\*\=utf-8\'\'([\W\w]+)/.match(content_disposition)
-        filename = URI.unescape(match_data[1].gsub('"', ''))
+        filename = URI.decode_www_form_component(match_data[1].gsub('"', ''))
       else
         match_data  = / .*filename=\"([\W\w]+)\"/.match(content_disposition)
         filename =  match_data[1].gsub('"', '')
@@ -135,7 +169,7 @@ module Ilovepdf
         server_filename: file.server_filename,
         v: API_VERSION
       }
-      response = send_request('post', 'upload/delete', body: body)
+      response = send_request('delete', "upload/#{self.task_id}/#{file.server_filename}", body: body)
     end
 
     def perform_filedownload_request
@@ -156,15 +190,23 @@ module Ilovepdf
       }.merge(file_submit_params)
       .merge(extract_api_params)
 
+
+      extracted_body = RequestPayload::FormUrlEncoded.new(body).extract_to_s
+
       response = send_request('post', 'process', body: body)
       response
     end
 
-    def perform_create_request
-      request_opts = {
-        body: {v: API_VERSION}
+    def perform_start_request
+      body = {
+        v: API_VERSION
       }
-      response = send_request('get', 'start/' + self.tool.to_s, request_opts)
+      extracted_body = RequestPayload::FormUrlEncoded.new(body).extract_to_s
+      response = send_request('get', "start/#{self.tool}", body: extracted_body)
+      is_server_defined = response.body.key?('server') && !response.body['server'].to_s.empty?
+      raise ::Ilovepdf::Errors::StartError.new("No server assigned on start") if !is_server_defined
+      
+      response
     end
 
     def perform_upload_request filepath
@@ -202,11 +244,14 @@ module Ilovepdf
       h
     end
 
+    def extract_api_param_value(param_name)
+      send(param_name)
+    end
+
     def extract_api_params
-      {}.tap do |h|
-        self.class::API_PARAMS.each{ |param_name|
-          h[param_name] = send(param_name)
-        }
+      self.class::API_PARAMS.inject({}) do |result,param_name|
+        result[param_name] = extract_api_param_value(param_name)
+        result
       end
     end
   end

data/lib/ilovepdf/tool/compress.rb

@@ -6,9 +6,9 @@ module Ilovepdf
 
       COMPRESSION_LEVEL_VALUES = ["extreme", "recommended", "low"]
 
-      def initialize(public_key, secret_key)
+      def initialize(public_key, secret_key, make_start=true)
         self.tool = :compress
-        super(public_key, secret_key)
+        super(public_key, secret_key, make_start)
       end
 
       def compression_level= level

data/lib/ilovepdf/tool/extract.rb

@@ -4,9 +4,9 @@ module Ilovepdf
       API_PARAMS = [:detailed]
       attr_accessor *API_PARAMS
 
-      def initialize(public_key, secret_key)
+      def initialize(public_key, secret_key, make_start=true)
         self.tool = :extract
-        super(public_key, secret_key)
+        super(public_key, secret_key, make_start)
       end
 
       def detailed

data/lib/ilovepdf/tool/imagepdf.rb

@@ -7,10 +7,10 @@ module Ilovepdf
       ORIENTATION_VALUES  = ['portrait', 'landscape']
       PAGESIZE_VALUES     = ['fit', 'A4', 'letter']
 
-      def initialize(public_key, secret_key)
+      def initialize(public_key, secret_key, make_start=true)
         self.tool = :imagepdf
         self.merge_after = true
-        super(public_key, secret_key)
+        super(public_key, secret_key, make_start)
       end
 
       def orientation=(new_val)

data/lib/ilovepdf/tool/merge.rb

@@ -4,9 +4,9 @@ module Ilovepdf
       API_PARAMS = []
       attr_accessor *API_PARAMS
 
-      def initialize(public_key, secret_key)
+      def initialize(public_key, secret_key, make_start=true)
         self.tool = :merge
-        super(public_key, secret_key)
+        super(public_key, secret_key, make_start)
       end
     end
   end

data/lib/ilovepdf/tool/officepdf.rb

@@ -4,9 +4,9 @@ module Ilovepdf
       API_PARAMS = []
       attr_accessor *API_PARAMS
 
-      def initialize(public_key, secret_key)
+      def initialize(public_key, secret_key, make_start=true)
         self.tool = :officepdf
-        super(public_key, secret_key)
+        super(public_key, secret_key, make_start)
       end
     end
   end

data/lib/ilovepdf/tool/pagenumber.rb

@@ -16,9 +16,9 @@ module Ilovepdf
                                       'WenQuanYi Zen Hei', 'Lohit Marathi'
                                     ]
 
-      def initialize(public_key, secret_key)
+      def initialize(public_key, secret_key, make_start=true)
         self.tool = :pagenumber
-        super(public_key, secret_key)
+        super(public_key, secret_key, make_start)
       end
 
       def vertical_position=(new_val)

data/lib/ilovepdf/tool/pdfa.rb

@@ -8,9 +8,9 @@ module Ilovepdf
                             'pdfa-2a', 'pdfa-3b', 'pdfa-3u', 'pdfa-3a'
                            ]
 
-      def initialize(public_key, secret_key)
+      def initialize(public_key, secret_key, make_start=true)
         self.tool = :pdfa
-        super(public_key, secret_key)
+        super(public_key, secret_key, make_start)
         self.allow_downgrade = true
       end
 

data/lib/ilovepdf/tool/pdfjpg.rb

@@ -1,22 +1,44 @@
 module Ilovepdf
   module Tool
     class Pdfjpg < ::Ilovepdf::Task
-      API_PARAMS = [:mode]
+      API_PARAMS = [
+        :view_width, :view_height, :navigation_timeout, :delay,
+        :page_size, :page_orientation, :page_margin, :remove_popups,
+        :single_page
+      ]
+      attr_accessor *API_PARAMS
 
-      MODE_VALUES = ['pages', 'extract']
+      PAGE_SIZE_VALUES        = ['A3', 'A4', 'A5', 'A6', 'Letter']
+      PAGE_ORIENTATION_VALUES = ['portrait', 'landscape']
 
-      def initialize(public_key, secret_key)
+      def initialize(public_key, secret_key, make_start=true)
         self.tool = :pdfjpg
-        super(public_key, secret_key)
+        super(public_key, secret_key, make_start)
+
+        # Assign default values
+        self.view_width = 1920
+        self.navigation_timeout = 10
+        self.delay = 2
+        self.page_margin = 0
+        # raise Errors::ArgumentEnumError.new(CONFORMANCE_VALUES) unless CONFORMANCE_VALUES.include? new_val 
       end
 
-      def mode=(new_val)
-        raise Errors::ArgumentEnumError.new(MODE_VALUES) unless MODE_VALUES.include?(new_val)
-        @mode = new_val
+      def navigation_timeout=(new_val)
       end
-      def mode
-        @mode
+
+      def delay=(new_val)
       end
+
+      def page_size=(new_val)
+      end
+
+      def page_orientation=(new_val)
+      end
+
+      def addUrl(file_url)
+        add_file_from_url(file_url)
+      end
+
     end
   end
 end

data/lib/ilovepdf/tool/protect.rb

@@ -4,9 +4,9 @@ module Ilovepdf
       API_PARAMS = [:password]
       attr_accessor *API_PARAMS
 
-      def initialize(public_key, secret_key)
+      def initialize(public_key, secret_key, make_start=true)
         self.tool = :protect
-        super(public_key, secret_key)
+        super(public_key, secret_key, make_start)
       end
     end
   end

data/lib/ilovepdf/tool/repair.rb

@@ -3,9 +3,9 @@ module Ilovepdf
     class Repair < ::Ilovepdf::Task
       API_PARAMS = []
 
-      def initialize(public_key, secret_key)
+      def initialize(public_key, secret_key, make_start=true)
         self.tool = :repair
-        super(public_key, secret_key)
+        super(public_key, secret_key, make_start)
       end
     end
   end

data/lib/ilovepdf/tool/rotate.rb

@@ -3,9 +3,9 @@ module Ilovepdf
     class Rotate < ::Ilovepdf::Task
       API_PARAMS = []
 
-      def initialize(public_key, secret_key)
+      def initialize(public_key, secret_key, make_start=true)
         self.tool = :rotate
-        super(public_key, secret_key)
+        super(public_key, secret_key, make_start)
       end
     end
   end

data/lib/ilovepdf/tool/signature.rb

@@ -0,0 +1,134 @@
+module Ilovepdf
+  module Tool
+    class Signature < ::Ilovepdf::Task
+      using ::Ilovepdf::Refinements::Crush
+
+      undef_method :next,:chained_task?,:enable_file_encryption,:download,
+                      :delete!,:perform_filedownload_request, :assign_meta_value,
+                      :perform_process_request, :ignore_password, :ignore_errors,
+                      :try_pdf_repair, :packaged_filename, :output_filename
+
+      API_PARAMS = [:brand_name,:brand_logo,
+                      :language,:lock_order,
+                      :message_signer,:subject_signer,:uuid_visible,:expiration_days,
+                      :signer_reminders,:signer_reminder_days_cycle,:verify_enabled ]
+
+      attr_accessor *API_PARAMS
+
+      def initialize(public_key, secret_key, make_start=true)
+        self.tool = :sign
+        super(public_key, secret_key, make_start)
+      end
+
+      def execute
+        @result = perform_process_request
+      end
+
+      def uuid_visible=(value)
+        @uuid_visible = !!value
+      end
+
+      def brand_name=(value)
+        raise ::Ilovepdf::Errors::UnsupportedFunctionalityError.new("Method not implemented")
+      end
+
+      def brand_logo=(value)
+        raise ::Ilovepdf::Errors::UnsupportedFunctionalityError.new("Method not implemented")
+      end
+
+      def add_receiver(receiver)
+        raise ::Ilovepdf::Errors::ArgumentError.new("value is not receiver") unless receiver.is_a?(Ilovepdf::Signature::Receiver)
+        @signers << receiver
+      end
+
+      def language=(value)
+        raise ::Ilovepdf::Errors::ArgumentError.new("value is not a string") unless value.is_a?(String)
+        @language = value
+      end
+
+      def lock_order=(value)
+        @lock_order = !!value ? "1" : "0"
+      end
+
+      def email_content(subject:,body:)
+        @subject_signer = subject
+        @message_signer = body
+        {subject: @subject_signer,body: @message_signer}
+      end
+
+      def expiration_days=(value)
+        raise ::Ilovepdf::Errors::ArgumentError.new("value is not an Integer") unless value.is_a?(Integer)
+        @expiration_days = value
+      end
+
+      def reminders=(value)
+        raise ::Ilovepdf::Errors::ArgumentError.new("value is not an Integer") unless value.is_a?(Integer)
+        if(value <= 0)
+          @signer_reminders = false
+          @signer_reminder_days_cycle = nil
+        else
+          @signer_reminders = true
+          @signer_reminder_days_cycle = value
+        end
+        value
+      end
+
+
+      def add_brand(name:,logo:)
+        brand_logo_file = perform_upload_request(logo)
+        @brand_logo = brand_logo_file.server_filename
+        @brand_name = name
+      end
+
+      def verify_enabled=(value)
+        @verify_enabled = !!value
+      end
+
+      def signers
+        @signers ||= []
+      end
+
+      def <<(receiver)
+        raise ::Ilovepdf::Errors::ArgumentError.new("value is not an Ilovepdf::Signature::Receive") unless receiver.is_a?(::Ilovepdf::Signature::Receiver)
+        @signers ||= []
+        @signers << receiver
+      end
+
+      def extract_api_params
+        params = super
+        params[:task] = task_id
+        params[:files] = files.map do |file|
+          {server_filename: file.server_filename,filename: file.filename}
+        end
+        params[:signers] = signers.map do |signer|
+          {
+            name: signer.name,
+            email: signer.email,
+            phone: signer.phone,
+            files: signer.elements.group_by do |element|
+              element.file.server_filename
+            end.inject([]) do |result,(server_filename,elements)|
+              result << {
+                server_filename: server_filename,
+                elements: elements.map(&:to_h)
+              }
+              result
+            end,
+            type: signer.type,
+            access_code: signer.access_code,
+            force_signature_type: signer.force_signature_type
+          }
+        end
+        params.crush
+      end
+
+      def send_to_sign
+        body = extract_api_params
+        extracted_body = RequestPayload::FormUrlEncoded.new(body).extract_to_s
+        response = send_request('post', 'signature', body: extracted_body)
+        response
+      end
+
+    end
+  end
+end

data/lib/ilovepdf/tool/split.rb

@@ -4,9 +4,9 @@ module Ilovepdf
       API_PARAMS = [:ranges, :split_mode, :fixed_range, :remove_pages, :merge_after]
       attr_accessor *API_PARAMS
 
-      def initialize(public_key, secret_key)
+      def initialize(public_key, secret_key, make_start=true)
         self.tool = :split
-        super(public_key, secret_key)
+        super(public_key, secret_key, make_start)
       end
 
       def fixed_range=(range=1)

data/lib/ilovepdf/tool/unlock.rb

@@ -3,9 +3,9 @@ module Ilovepdf
     class Unlock < ::Ilovepdf::Task
       API_PARAMS = []
 
-      def initialize(public_key, secret_key)
+      def initialize(public_key, secret_key, make_start=true)
         self.tool = :unlock
-        super(public_key, secret_key)
+        super(public_key, secret_key, make_start)
       end
     end
   end

data/lib/ilovepdf/tool/validate_pdfa.rb

@@ -8,9 +8,9 @@ module Ilovepdf
                             'pdfa-2a', 'pdfa-3b', 'pdfa-3u', 'pdfa-3a'
                            ]
 
-      def initialize(public_key, secret_key)
+      def initialize(public_key, secret_key, make_start=true)
         self.tool = :validatepdfa
-        super(public_key, secret_key)
+        super(public_key, secret_key, make_start)
       end
 
       def conformance= new_val

data/lib/ilovepdf/tool/watermark.rb

@@ -5,45 +5,63 @@ module Ilovepdf
         :mode, :text, :image, :pages, :vertical_position, :horizontal_position,
         :vertical_position_adjustment, :horizontal_position_adjustment, :mosaic,
         :rotate, :font_family, :font_style, :font_size, :font_color, :transparency,
-        :layer
+        :layer, :elements
       ]
 
+      MODE_VALUES = ['image', 'text', 'multi']
+
       attr_accessor *API_PARAMS
 
-      VERTICAL_POSITION_VALUES    = ['bottom', 'center' ,'top']
-      HORIZONTAL_POSITION_VALUES  = ['left', 'middle', 'right']
-      FONT_FAMILY_VALUES          = ['Arial', 'Arial Unicode MS', 'Verdana', 'Courier',
-                                     'Times New Roman', 'Comic Sans MS', 'WenQuanYi Zen Hei',
-                                     'Lohit Marathi'
-                                    ]
+      def initialize(public_key, secret_key, make_start=true)
+        self.tool = :watermark
+        super(public_key, secret_key, make_start)
+      end
 
-      LAYER_VALUES = ['above', 'below']
+      def add_element(element)
+        raise Errors::ArgumentError.new("Element must be of type 'Ilovepdf::Element'") unless element.instance_of?(::Ilovepdf::Element)
+        elements << element
+      end
 
-      def initialize(public_key, secret_key)
-        self.tool = :watermark
-        super(public_key, secret_key)
+      def elements
+        @elements ||= []
+      end
+
+      def mode=(new_val)
+        raise Errors::ArgumentEnumError.new(MODE_VALUES) unless MODE_VALUES.include? new_val
+        @mode = new_val
       end
 
       def vertical_position=(new_val)
-        raise Errors::ArgumentEnumError.new(VERTICAL_POSITION_VALUES) unless VERTICAL_POSITION_VALUES.include? new_val
+        raise Errors::ArgumentEnumError.new(::Ilovepdf::Element::VERTICAL_POSITION_VALUES) unless ::Ilovepdf::Element::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
+        raise Errors::ArgumentEnumError.new(::Ilovepdf::Element::HORIZONTAL_POSITION_VALUES) unless ::Ilovepdf::Element::HORIZONTAL_POSITION_VALUES.include? new_val
         @horizontal_position = new_val
       end
 
       def font_family=(new_val)
-        raise Errors::ArgumentEnumError.new(FONT_FAMILY_VALUES) unless FONT_FAMILY_VALUES.include? new_val
+        raise Errors::ArgumentEnumError.new(::Ilovepdf::Element::FONT_FAMILY_VALUES) unless ::Ilovepdf::Element::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
+        raise Errors::ArgumentEnumError.new(::Ilovepdf::Element::LAYER_VALUES) unless ::Ilovepdf::Element::LAYER_VALUES.include? new_val
         @layer = new_val
       end
 
+      private
+
+      # Do nothing; Use 'add_element' method to alter the elements array
+      def elements=(val)
+      end
+
+      def extract_api_param_value(param_name)
+        return self.elements.map{|elem| elem.to_api_hash } if param_name == :elements 
+        super
+      end # /extract_api_param_value
+
     end
   end
 end

data/lib/ilovepdf/version.rb

@@ -1,3 +1,3 @@
 module Ilovepdf
-  VERSION = "1.3.1"
+  VERSION = "1.3.4"
 end

data/lib/ilovepdf.rb

@@ -6,13 +6,18 @@ require 'securerandom'
 require 'jwt'
 require 'rest-client'
 
+
 # Base classes
+require "ilovepdf/refinements"
+require "ilovepdf/servers"
 require "ilovepdf/errors"
 require "ilovepdf/response"
 require "ilovepdf/helper"
 require "ilovepdf/ilovepdf"
 require "ilovepdf/file"
 require "ilovepdf/task"
+require 'ilovepdf/element'
+require 'ilovepdf/request_payload/form_url_encoded'
 
 # Load tool classes
 require 'ilovepdf/tool/compress'
@@ -30,6 +35,20 @@ require 'ilovepdf/tool/unlock'
 require 'ilovepdf/tool/watermark'
 require 'ilovepdf/tool/protect'
 require 'ilovepdf/tool/extract'
+require 'ilovepdf/tool/signature'
+
+# Load signature classes
+require 'ilovepdf/signature'
+require 'ilovepdf/signature/file_element'
+require 'ilovepdf/signature/signature_element'
+require 'ilovepdf/signature/initials_element'
+require 'ilovepdf/signature/input_element'
+require 'ilovepdf/signature/name_element'
+require 'ilovepdf/signature/date_element'
+require 'ilovepdf/signature/text_element'
+require 'ilovepdf/signature/receiver'
+require 'ilovepdf/signature/management'
+require 'ilovepdf/tool/signature'
 
 module Ilovepdf
   class << self

data/samples/chained_task.rb

@@ -0,0 +1,20 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# You can call task class directly
+my_task = Ilovepdf::Tool::Split.new("PUBLIC_KEY", "SECRET_KEY");
+
+# File object keeps information about its server_filename and the properties you can set
+file = my_task.add_file '/path/to/file/document.pdf'
+
+# get the 2nd page
+$splitTask.ranges = "2";
+
+# Process files
+response = my_task.execute
+
+# and create a new task from last action
+chained_task = my_task.next(:pdfjpg)
+
+chained_task.execute
+chained_task.download