ilovepdf 1.0.0

data/lib/ilovepdf/tool/unlock.rb

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

data/lib/ilovepdf/tool/watermark.rb

@@ -0,0 +1,49 @@
+module Ilovepdf
+  module Tool
+    class Watermark < ::Ilovepdf::Task
+      API_PARAMS = [
+        :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
+      ]
+
+      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'
+                                    ]
+
+      LAYER_VALUES = ['above', 'below']
+
+      def initialize(public_key, secret_key)
+        self.tool = :watermark
+        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
+
+      def layer=(new_val)
+        raise Errors::ArgumentEnumError.new(LAYER_VALUES) unless LAYER_VALUES.include? new_val
+        @layer = new_val
+      end
+
+    end
+  end
+end

data/lib/ilovepdf/version.rb

@@ -0,0 +1,3 @@
+module Ilovepdf
+  VERSION = "1.0.0"
+end

data/samples/compress_advanced.rb

@@ -0,0 +1,25 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# You can call task class directly
+my_task = Ilovepdf::Tool::Compress.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'
+
+# We can rotate a file
+file.rotate = 90
+
+# Set compression level
+my_task.compression_level = 'extreme'
+
+# and set name for output file.
+# the task will set the correct file extension for you
+my_task.output_filename = 'lowlow_compression'
+
+# Finally is time to process the files. i.e We'll send them to Ilovepdf servers :)
+response = my_task.execute
+puts "Time spent doing processing the task: #{response.body['timer']}" # You can check the time spent processing the task
+
+# and finally download the file. If no path is set, it will be downloaded on your current working directory
+my_task.download 'path/to/download'

data/samples/compress_basic.rb

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# You can call task class directly
+my_task = Ilovepdf::Tool::Compress.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'
+
+# Process files
+response = my_task.execute
+
+# and finally download the file. If no path is set, it will be downloaded on your current working directory
+my_task.download

data/samples/merge_advanced.rb

@@ -0,0 +1,22 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# Start the manager class
+ilovepdf = Ilovepdf::Ilovepdf.new("PUBLIC_KEY", "SECRET_KEY");
+
+# and get the task tool
+my_task = ilovepdf.new_task :merge
+
+# File object keeps information about its server_filename and the properties you can set
+fileA = my_task.add_file '/path/to/file/document_a.pdf'
+fileB = my_task.add_file '/path/to/file/document_b.pdf'
+
+# and set name for output file.
+# the task will set the correct file extension for you.
+my_task.output_filename = 'merged_filename'
+
+# Process files
+response = my_task.execute
+
+# and finally download the file. If no path is set, it will be downloaded on your current working directory
+my_task.download 'path/to/download'

data/samples/merge_basic.rb

@@ -0,0 +1,18 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# Start the manager class
+ilovepdf = Ilovepdf::Ilovepdf.new("PUBLIC_KEY", "SECRET_KEY");
+
+# and get the task tool
+my_task = ilovepdf.new_task :merge
+
+# File object keeps information about its server_filename and the properties you can set
+fileA = my_task.add_file '/path/to/file/document_a.pdf'
+fileB = my_task.add_file '/path/to/file/document_b.pdf'
+
+# Process files
+response = my_task.execute
+
+# and finally download the file. If no path is set, it will be downloaded on your current working directory
+my_task.download 'path/to/download'

data/samples/pdfa_advanced.rb

@@ -0,0 +1,21 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# You can call task class directly
+my_task = Ilovepdf::Tool::Pdfa.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'
+
+# Set conformance
+file.conformance = 'pdfa-1b'
+
+# and set name for output file.
+# the task will set the correct file extension for you.
+my_task.output_filename = 'merged_filename'
+
+# Finally is time to process the files. i.e We'll send them to Ilovepdf servers :)
+my_task.execute
+
+# and finally download the file. If no path is set, it will be downloaded on your current working directory
+my_task.download('path/to/download')

data/samples/pdfa_basic.rb

@@ -0,0 +1,17 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# You can call task class directly
+my_task = Ilovepdf::Tool::Pdfa.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'
+
+# Set conformance
+file.conformance = 'pdfa-1b'
+
+# Finally is time to process the files. i.e We'll send them to Ilovepdf servers :)
+response = my_task.execute
+
+# and finally download the file. If no path is set, it will be downloaded on your current working directory
+my_task.download('path/to/download')

data/samples/repair_advanced.rb

@@ -0,0 +1,21 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# Start the manager class
+ilovepdf = Ilovepdf::Ilovepdf.new("PUBLIC_KEY", "SECRET_KEY");
+
+# and get the task tool
+my_task = ilovepdf.new_task :repair
+
+# File object keeps information about its server_filename and the properties you can set
+file = my_task.add_file '/path/to/file/document_a.pdf'
+
+# and set name for output file.
+# the task will set the correct file extension for you.
+my_task.output_filename = 'repaired_filename'
+
+# Process files
+response = my_task.execute
+
+# and finally download the file. If no path is set, it will be downloaded on your current working directory
+my_task.download 'path/to/download'

data/samples/repair_basic.rb

@@ -0,0 +1,17 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# Start the manager class
+ilovepdf = Ilovepdf::Ilovepdf.new("PUBLIC_KEY", "SECRET_KEY");
+
+# and get the task tool
+my_task = ilovepdf.new_task :repair
+
+# File object keeps information about its server_filename and the properties you can set
+file = my_task.add_file '/path/to/file/document_a.pdf'
+
+# Process files
+response = my_task.execute
+
+# and finally download the file. If no path is set, it will be downloaded on your current working directory
+my_task.download 'path/to/download'

data/samples/rotate_advanced.rb

@@ -0,0 +1,21 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# You can call task class directly
+my_task = Ilovepdf::Tool::Rotate.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'
+
+# We can rotate a file
+file.rotate = 90;
+
+# and set name for output file.
+# the task will set the correct file extension for you
+my_task.output_filename = 'rotated_file'
+
+# Finally is time to process the files. i.e We'll send them to Ilovepdf servers :)
+response = my_task.execute
+
+# and finally download the file. If no path is set, it will be downloaded on your current working directory
+my_task.download('path/to/download')

data/samples/rotate_basic.rb

@@ -0,0 +1,17 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# You can call task class directly
+my_task = Ilovepdf::Tool::Rotate.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'
+
+# We can rotate a file
+file.rotate = 90;
+
+# Finally is time to process the files. i.e We'll send them to Ilovepdf servers :)
+response = my_task.execute
+
+# and finally download the file. If no path is set, it will be downloaded on your current working directory
+my_task.download('path/to/download')

data/samples/split_advanced.rb

@@ -0,0 +1,32 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# Start the manager class
+ilovepdf = Ilovepdf::Ilovepdf.new("PUBLIC_KEY", "SECRET_KEY");
+
+# and get the task tool
+my_task = ilovepdf.new_task :split
+
+# or you can call task class directly, this set the same tool as before
+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'
+
+# set ranges to split the document
+my_task.ranges = "2-4,6-8"
+
+# and set name for output file.
+# the task will set the correct file extension for you
+my_task.packaged_filename = 'split_documents'
+
+# and name for splitted document (inside the zip file)
+my_task.output_filename = 'split'
+
+# Finally is time to process the files. i.e We'll send them to Ilovepdf servers :)
+response = my_task.execute
+puts "Time spent doing processing the task: #{response.body['timer']}" # You can check the time spent processing the task
+
+# and finally download the file. If no path is set, it will be downloaded on your current working directory
+my_task.download 'path/to/download'

data/samples/split_advanced_merge.rb

@@ -0,0 +1,30 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# Start the manager class
+ilovepdf = Ilovepdf::Ilovepdf.new("PUBLIC_KEY", "SECRET_KEY");
+
+# and get the task tool
+my_task = ilovepdf.new_task :split
+
+# or you can call task class directly, this set the same tool as before
+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'
+
+# Set ranges to split the document
+my_task.ranges = "2-4,6-8"
+
+# We want the splitted files to be merged into a single one
+my_task.merge_after = true
+
+# and name for merged document
+my_task.output_filename = 'split'
+
+# Finally is time to process the files. i.e We'll send them to Ilovepdf servers :)
+my_task.execute
+
+# and finally download the file. If no path is set, it will be downloaded on your current working directory
+my_task.download 'path/to/download'

data/samples/split_basic.rb

@@ -0,0 +1,17 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# or you can call task class directly, this set the same tool as before
+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'
+
+# set ranges to split the document
+my_task.ranges = "2-4,6-8"
+
+# Finally is time to process the files. i.e We'll send them to Ilovepdf servers :)
+response = my_task.execute
+
+# and finally download the file. If no path is set, it will be downloaded on your current working directory
+my_task.download 'path/to/download'

data/samples/try_catch_errors.rb

@@ -0,0 +1,46 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+begin
+  # Get an instance of the task tool Split
+  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'
+  file = my_task.add_file ::Ilovepdf.root.join("uploads/sample_pdf.pdf")
+  # set ranges to split the document
+  my_task.ranges = '2-4,6-8'
+
+  # and set name for output file.
+  # the task will set the correct file extension for you
+  my_task.packaged_filename = 'split_documents'
+
+  # and name for splitted document (inside the zip file)
+  my_task.output_filename = 'split'
+  my_task.execute
+  my_task.download
+rescue Ilovepdf::Errors::AuthError => e # Catch Auth errors
+  puts "An error occurred on Auth: " + e.message
+  # To examine more in depth what the server returned:
+  # puts e.http_response.body
+rescue Ilovepdf::Errors::StartError => e    # Catch API errors from Start endpoint
+  puts "An error occurred on Start: " + e.message
+  # To examine more in depth what the server returned:
+  # puts e.http_response.body
+rescue Ilovepdf::Errors::UploadError => e   # Catch API errors from Upload endpoint
+  puts "An error occurred on Upload: " + e.message
+  # To examine more in depth what the server returned:
+  # puts e.http_response.body
+rescue Ilovepdf::Errors::ProcessError => e  # Catch API errors from Process endpoint
+  puts "An error occurred on Process: " + e.message
+  # To examine more in depth what the server returned:
+  # puts e.http_response.body
+rescue Ilovepdf::ApiError => e
+  puts "An error occurred on an API call to Ilovepdf: " + e.message
+  # To examine more in depth what the server returned:
+  # puts e.http_response.body
+rescue Ilovepdf::Error => e # Catch library errors
+  puts "An error occurred on the lib: " + e.message
+rescue StandardError => e # Catch all errors
+  puts "Something went wrong: #{e.message}"
+end

data/samples/unlock_advanced.rb

@@ -0,0 +1,21 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# You can call task class directly
+my_task = Ilovepdf::Tool::Unlock.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'
+
+# set the current password of the locked PDF you want to unlock
+file.password = 'test'
+
+# and set name for output file.
+# the task will set the correct file extension for you
+my_task.output_filename = 'unlocked'
+
+# Finally is time to process the files. i.e We'll send them to Ilovepdf servers :)
+my_task.execute
+
+# and finally download the file. If no path is set, it will be downloaded on your current working directory
+my_task.download 'path/to/download'

data/samples/unlock_basic.rb

@@ -0,0 +1,17 @@
+require "bundler/setup"
+require 'ilovepdf'
+
+# You can call task class directly
+my_task = Ilovepdf::Tool::Unlock.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'
+
+# set the current password of the locked PDF you want to unlock
+file.password = 'test'
+
+# Finally is time to process the files. i.e We'll send them to Ilovepdf servers :)
+my_task.execute
+
+# and finally download the file. If no path is set, it will be downloaded on your current working directory
+my_task.download 'path/to/download'