ilovepdf 1.0.0

data/lib/ilovepdf/response.rb

@@ -0,0 +1,36 @@
+module Ilovepdf
+  class Response
+    attr_accessor :response
+
+    def initialize(response)
+      raise ArgumentError.new('Argument must be of type \'RestClient::Response\'') unless response.is_a? ::RestClient::Response
+      self.response = response
+    end
+
+    def headers
+      self.response.headers
+    end
+
+    def body
+      return @body if @body
+      is_json = (/application\/json/i =~ self.response.headers[:content_type]) != nil
+      if is_json
+        @body ||= JSON.parse(self.response.body)
+      else
+        @body = self.response.body
+      end
+    end
+
+    def raw_body
+      self.response.body
+    end
+
+    def code
+      self.response.code
+    end
+
+    def success?
+      self.response.code.to_s[0] == '2'
+    end
+  end
+end

data/lib/ilovepdf/task.rb

@@ -0,0 +1,195 @@
+module Ilovepdf
+  class Task < Ilovepdf
+    attr_accessor :task_id, :tool, :packaged_filename, :output_filename,
+                  :ignore_errors, :ignore_password, :try_pdf_repair
+
+    API_PARAMS = []
+
+    def initialize(public_key, secret_key)
+      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
+    end
+
+    def assign_meta_value(key, value)
+      meta_values[key] = value
+    end
+
+    def files
+      @files ||= []
+    end
+
+    def add_file(filepath)
+      raise ArgumentError.new("No file exists in '#{filepath}'") unless ::File.exist?(filepath)
+      file = perform_upload_request(filepath)
+      files << file
+      files.last
+    end
+
+    def add_file_from_url(url)
+      file = perform_upload_url_request(url)
+      files << file
+      files.last
+    end
+
+    def download(path=nil)
+      download_file(path)
+    end
+
+    # [API Methods] Actions on task
+
+    def status
+      http_response = query_task_status(worker_server,task_id)
+    end
+
+    def execute
+      perform_process_request
+    end
+
+    def delete!
+      send_request('delete', 'task/' + self.task_id)
+    end
+
+    def delete_file(file)
+      raise Error.new("File was already deleted") if file.deleted?
+      file_was_found = files.find{|f| f.server_filename == file.server_filename }
+      raise Error.new("File to delete not found") if !file_was_found
+      response = perform_deletefile_request(file)
+      if response.success?
+        file.mark_as_deleted
+        new_files = files.reject{|f| f.server_filename == file.server_filename }
+        send(:files=, new_files)
+      else
+        raise ApiError.new(response, custom_msg: "No error ocurred but response was not successful when deleting the desired file")
+      end
+      true
+    end
+
+    def enable_file_encryption(enable, new_encrypt_key = nil)
+      raise Error.new("Encryption mode cannot be assigned after uploading the files") if files.size > 0
+      super(enable, new_encrypt_key)
+    end
+
+    private
+
+    # set meta values as http://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/pdf_reference_1-7.pdf (page 844)
+    def meta_values
+      @meta_values ||= {}
+    end
+
+    def files=(new_array_of_files)
+      @files = new_array_of_files
+    end
+
+    def download_file path
+      response = perform_filedownload_request
+      content_disposition = response.headers[:content_disposition]
+
+      if match_data = /filename\*\=utf-8\'\'([\W\w]+)/.match(content_disposition)
+        filename = URI.unescape(match_data[1].gsub('"', ''))
+      else
+        match_data  = / .*filename=\"([\W\w]+)\"/.match(content_disposition)
+        filename =  match_data[1].gsub('"', '')
+      end
+
+      if path
+        path = Pathname.new(path).to_s if path.is_a?(Pathname)
+        path.chop! if path.end_with? '/'
+      else
+        path = '.'
+      end
+      destination = "#{path}/#{filename}"
+      ::File.open(destination, 'wb'){|file| file.write(response.raw_body) }
+      file = response.raw_body
+      true
+    end
+
+    # [HTTP request methods]
+    def perform_deletefile_request(file)
+      body = {
+        task: self.task_id,
+        server_filename: file.server_filename,
+        v: API_VERSION
+      }
+      response = send_request('post', 'upload/delete', body: body)
+    end
+
+    def perform_filedownload_request
+      response = send_request('get', 'download/' + self.task_id, body: {v: API_VERSION})
+    end
+
+    def perform_process_request
+      body = {
+        task: self.task_id,
+        tool: self.tool,
+        packaged_filename: self.packaged_filename,
+        output_filename: self.output_filename,
+        ignore_errors: self.ignore_errors,
+        ignore_password: self.ignore_password,
+        try_pdf_repair: self.try_pdf_repair,
+        meta: meta_values,
+        v: API_VERSION,
+      }.merge(file_submit_params)
+      .merge(extract_api_params)
+
+      response = send_request('post', 'process', body: body)
+      response
+    end
+
+    def perform_create_request
+      request_opts = {
+        body: {v: API_VERSION}
+      }
+      response = send_request('get', 'start/' + self.tool.to_s, request_opts)
+    end
+
+    def perform_upload_request filepath
+      request_opts = {
+        body: {
+          multipart: true,
+          v: API_VERSION,
+          task: self.task_id,
+          file: ::File.new(filepath, 'rb')
+        }
+      }
+      # filepath
+      response = send_request('post', 'upload', request_opts)
+      File.new(response.body['server_filename'], Pathname.new(filepath).basename.to_s)
+    end
+
+    def perform_upload_url_request url
+      request_opts = {
+        body: {
+          multipart: true,
+          v: API_VERSION,
+          task: self.task_id,
+          cloud_file: url
+        }
+      }
+      response = send_request('post', 'upload', request_opts)
+      File.new(response.body['server_filename'], Pathname.new(url).basename.to_s)
+    end
+
+    def file_submit_params
+      h = {files:{}}
+      files.each_with_index do |f, i|
+        h[:files][i.to_s] = f.file_options
+      end
+      h
+    end
+
+    def extract_api_params
+      {}.tap do |h|
+        self.class::API_PARAMS.each{ |param_name|
+          h[param_name] = send(param_name)
+        }
+      end
+    end
+  end
+end

data/lib/ilovepdf/tool/compress.rb

@@ -0,0 +1,20 @@
+module Ilovepdf
+  module Tool
+    class Compress < ::Ilovepdf::Task
+      API_PARAMS = [:compression_level]
+      attr_accessor *API_PARAMS
+
+      COMPRESSION_LEVEL_VALUES = ["extreme", "recommended", "low"]
+
+      def initialize(public_key, secret_key)
+        self.tool = :compress
+        super(public_key, secret_key)
+      end
+
+      def compression_level= level
+        raise Errors::ArgumentEnumError.new(COMPRESSION_LEVEL_VALUES) unless COMPRESSION_LEVEL_VALUES.include? level
+        @compression_level = level
+      end
+    end
+  end
+end

data/lib/ilovepdf/tool/imagepdf.rb

@@ -0,0 +1,27 @@
+module Ilovepdf
+  module Tool
+    class Imagepdf < ::Ilovepdf::Task
+      API_PARAMS = [:orientation, :margin, :pagesize, :merge_after]
+      attr_accessor *API_PARAMS
+
+      ORIENTATION_VALUES  = ['portrait', 'landscape']
+      PAGESIZE_VALUES     = ['fit', 'A4', 'letter']
+
+      def initialize(public_key, secret_key)
+        self.tool = :imagepdf
+        self.merge_after = true
+        super(public_key, secret_key)
+      end
+
+      def orientation=(new_val)
+        raise Errors::ArgumentEnumError.new(ORIENTATION_VALUES) unless ORIENTATION_VALUES.include? new_val
+        @orientation = new_val
+      end
+
+      def pagesize=(new_val)
+        raise Errors::ArgumentEnumError.new(PAGESIZE_VALUES) unless PAGESIZE_VALUES.include? new_val
+        @pagesize = new_val
+      end
+    end
+  end
+end

data/lib/ilovepdf/tool/merge.rb

@@ -0,0 +1,13 @@
+module Ilovepdf
+  module Tool
+    class Merge < ::Ilovepdf::Task
+      API_PARAMS = []
+      attr_accessor *API_PARAMS
+
+      def initialize(public_key, secret_key)
+        self.tool = :merge
+        super(public_key, secret_key)
+      end
+    end
+  end
+end

data/lib/ilovepdf/tool/officepdf.rb

@@ -0,0 +1,13 @@
+module Ilovepdf
+  module Tool
+    class Officepdf < ::Ilovepdf::Task
+      API_PARAMS = []
+      attr_accessor *API_PARAMS
+
+      def initialize(public_key, secret_key)
+        self.tool = :officepdf
+        super(public_key, secret_key)
+      end
+    end
+  end
+end

data/lib/ilovepdf/tool/pagenumber.rb

@@ -0,0 +1,40 @@
+module Ilovepdf
+  module Tool
+    class Pagenumber < ::Ilovepdf::Task
+      API_PARAMS = [
+        :facing_pages, :first_cover, :pages, :starting_number, :vertical_position,
+        :horizontal_position, :vertical_position_adjustment, :horizontal_position_adjustment,
+        :font_family, :font_style, :font_size, :font_color, :text
+      ]
+
+      attr_accessor *API_PARAMS
+
+      VERTICAL_POSITION_VALUES    = ['bottom', '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)
+        self.tool = :pagenumber
+        super(public_key, secret_key)
+      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 font_family=(new_val)
+        raise Errors::ArgumentEnumError.new(FONT_FAMILY_VALUES) unless FONT_FAMILY_VALUES.include? new_val
+        @font_family = new_val
+      end
+    end
+  end
+end

data/lib/ilovepdf/tool/pdfa.rb

@@ -0,0 +1,26 @@
+module Ilovepdf
+  module Tool
+    class Pdfa < ::Ilovepdf::Task
+      API_PARAMS = [:conformance]
+      attr_accessor *API_PARAMS
+
+      CONFORMANCE_VALUES = ['pdfa-1b', 'pdfa-1a', 'pdfa-2b', 'pdfa-2u',
+                            'pdfa-2a', 'pdfa-3b', 'pdfa-3u', 'pdfa-3a'
+                           ]
+
+      def initialize(public_key, secret_key)
+        self.tool = :pdfa
+        super(public_key, secret_key)
+      end
+
+      def conformance= new_val
+        raise Errors::ArgumentEnumError.new(CONFORMANCE_VALUES) unless CONFORMANCE_VALUES.include? new_val
+        @conformance = new_val
+      end
+
+      def conformance
+        @conformance ||= 'default'
+      end
+    end
+  end
+end

data/lib/ilovepdf/tool/pdfjpg.rb

@@ -0,0 +1,22 @@
+module Ilovepdf
+  module Tool
+    class Pdfjpg < ::Ilovepdf::Task
+      API_PARAMS = [:mode]
+
+      MODE_VALUES = ['pages', 'extract']
+
+      def initialize(public_key, secret_key)
+        self.tool = :pdfjpg
+        super(public_key, secret_key)
+      end
+
+      def mode=(new_val)
+        raise Errors::ArgumentEnumError.new(MODE_VALUES) unless MODE_VALUES.include?(new_val)
+        @mode = new_val
+      end
+      def mode
+        @mode
+      end
+    end
+  end
+end

data/lib/ilovepdf/tool/protect.rb

@@ -0,0 +1,13 @@
+module Ilovepdf
+  module Tool
+    class Protect < ::Ilovepdf::Task
+      API_PARAMS = [:password]
+      attr_accessor *API_PARAMS
+
+      def initialize(public_key, secret_key)
+        self.tool = :protect
+        super(public_key, secret_key)
+      end
+    end
+  end
+end

data/lib/ilovepdf/tool/repair.rb

@@ -0,0 +1,12 @@
+module Ilovepdf
+  module Tool
+    class Repair < ::Ilovepdf::Task
+      API_PARAMS = []
+
+      def initialize(public_key, secret_key)
+        self.tool = :repair
+        super(public_key, secret_key)
+      end
+    end
+  end
+end

data/lib/ilovepdf/tool/rotate.rb

@@ -0,0 +1,12 @@
+module Ilovepdf
+  module Tool
+    class Rotate < ::Ilovepdf::Task
+      API_PARAMS = []
+
+      def initialize(public_key, secret_key)
+        self.tool = :rotate
+        super(public_key, secret_key)
+      end
+    end
+  end
+end

data/lib/ilovepdf/tool/split.rb

@@ -0,0 +1,35 @@
+module Ilovepdf
+  module Tool
+    class Split < ::Ilovepdf::Task
+      API_PARAMS = [:ranges, :split_mode, :fixed_range, :remove_pages, :merge_after]
+      attr_accessor *API_PARAMS
+
+      def initialize(public_key, secret_key)
+        self.tool = :split
+        super(public_key, secret_key)
+      end
+
+      def fixed_range=(range=1)
+        @split_mode = 'fixed_range'
+        @fixed_range = range
+      end
+
+      def remove_pages=(pages)
+        @split_mode = 'remove_pages'
+        @remove_pages = pages
+      end
+
+      def ranges=(pages)
+        @split_mode = 'ranges'
+        @ranges = pages
+      end
+
+      def merge_after=(value)
+        @merge_after = value
+      end
+      def merge_after
+        @merge_after ||= false
+      end
+    end
+  end
+end