dynamicpdf_api 1.0.0.pre.beta

data/lib/ruby_client/PdfInstructions.rb

@@ -0,0 +1,97 @@
+module DynamicPDFApi
+  require_relative 'Security'
+  require_relative 'FormField'
+  require_relative 'Font'
+
+  class PdfInstructions
+    attr_accessor :_form_fields, :_templates, :_fonts, :_out_lines, :_inputs, :_author, :_title, :_subject, :_creator, :_producer, :_tag,
+                  :_keywords, :_security, :_flatten_all_form_fields, :_retain_signature_form_fields
+
+    def initialize
+      @_author = ''
+      @_title = ''
+      @_subject = ''
+      @_creator = ''
+      @_producer = ''
+      @_tag = nil
+      @_keywords = ''
+      @_form_fields = []
+      @_templates = {}
+      @_fonts = {}
+      @_outlines = []
+      @_inputs = []
+      @_security = nil
+      @_flatten_all_form_fields = nil
+      @_retain_signature_form_fields = nil
+    end
+
+    def to_json( indented = false)
+      # @inputJsonArray = []
+
+      # @_Inputs.each do |input|
+      #   if(input != nil)
+      #   @inputJsonArray << input
+      #   end
+      # end
+
+      fonts_json = []
+      @_fonts.each_value do |font|
+        fonts_json << font
+      end
+
+      templates_json = []
+      @_templates.each_value do |template|
+        templates_json << template unless template.nil?
+      end
+
+      json_array = {}
+
+      if(templates_json.length > 0)
+        json_array['templates'] = templates_json
+      end
+
+      if(fonts_json.length > 0)
+        json_array['fonts'] = fonts_json
+      end
+
+      if(@_author != nil)
+        json_array['author'] = @_author
+      end
+
+      if(@_title != nil)
+        json_array['title'] = @_title
+      end
+
+      json_array['subject'] = @_subject unless @_subject.nil?
+
+      json_array['creator'] = @_creator unless @_creator.nil?
+
+      json_array['producer'] = @_producer unless @_producer.nil?
+
+      json_array['tag'] = @_tag unless @_tag.nil?
+
+      json_array['keywords'] = @_keywords unless @_keywords.nil?
+
+      json_array['security'] = @_security unless @_security.nil?
+
+      json_array['flattenAllFormFields'] = @_flatten_all_form_fields unless @_flatten_all_form_fields.nil?
+
+      json_array['retainSignatureFormFields'] = @_retain_signature_form_fields unless @_retain_signature_form_fields.nil?
+
+      json_array['inputs'] = @_inputs
+
+      if(@_form_fields.length > 0)
+        json_array['formFields'] = @_form_fields
+      end
+
+      if(@_outlines.length > 0)
+        json_array['outlines'] = @_outlines
+      end
+      if(indented)
+        JSON.pretty_generate(json_array)
+      else
+        JSON.generate(json_array)
+      end
+    end
+  end
+end

data/lib/ruby_client/PdfResource.rb

@@ -0,0 +1,36 @@
+module DynamicPDFApi
+  require_relative "Resource"
+  require_relative "ResourceType"
+
+  #
+  # Represents a pdf resource.
+  #
+  class PdfResource < Resource
+    #
+    # Initializes a new instance of the PdfResource class.
+    #
+    # @param file [String]|[Array]|[Stream] The pdf file path or the byte array of the pdf file or the stream of the pdf file.
+    # @param resource_name [String] The name of the resource.
+    #
+    def initialize(file, resource_name = nil)
+      super(file, resource_name)
+      @_mime_type = "application/pdf"
+    end
+
+    @_type = ResourceType::PDF
+
+    def _file_extension
+      ".pdf"
+    end
+
+    # ?string ResourcePath
+
+    def to_json(_options = {})
+      @input_json = {}
+      @input_json["type"] = @_type
+
+      @input_json["resourceName"] = @resource_name
+      JSON.pretty_generate(@input_json)
+    end
+  end
+end

data/lib/ruby_client/PdfResponse.rb

@@ -0,0 +1,23 @@
+module DynamicPDFApi
+  require_relative 'Response'
+
+  #
+  # Represents the pdf response.
+  #
+  class PdfResponse < Response
+    #
+    # Gets the content od pdf.
+    #
+    attr_accessor :content
+
+    #
+    # Initializes a new instance of the PdfResponse class.
+    #
+    # @param pdf_content [String] The byte array of pdf content.
+    #
+    def initialize(pdf_content = nil)
+      super()
+      @content = pdf_content
+    end
+  end
+end

data/lib/ruby_client/PdfText.rb

@@ -0,0 +1,85 @@
+module DynamicPDFApi
+  require_relative 'Endpoint'
+  require_relative 'PdfTextResponse'
+
+  #
+  # Represents the pdf text endpoint.
+  #
+  class PdfText < Endpoint
+    #
+    # Initializes a new instance of the PdfText class.
+    #
+    # @param resource [PdfResource] The image resource of type PdfResource.
+    # @param start_page [int] The start page.
+    # @param page_count [int] The page count.
+    #
+    def initialize(resource, start_page = 1, page_count = 0)
+      @_endpoint_name = 'pdf-text'
+      @start_page = 1
+      @page_count = 0
+      super()
+      @resource = resource
+      @start_page = start_page
+      @page_count = page_count
+    end
+
+    #
+    # Gets or sets the start page.
+    #
+    attr_accessor :start_page
+
+    #
+    # Gets or sets the page count.
+    #
+    attr_accessor :page_count
+
+    #
+    # Process the pdf resource to get pdf's text.
+    # @return PdfTextResponse Returns collection of PdfTextResponse.
+    #
+    def process
+      header = {
+        'Authorization': "Bearer #{@api_key}",
+        'Content-Length': @resource.data.length.to_s,
+        'Expect': '100-continue',
+        'Content-Type': 'application/pdf'
+      }
+      uri = URI.parse("#{@base_url}/v1.0/#{@_endpoint_name}")
+      params = { 'startPage' => @start_page, 'pageCount' => @page_count }
+      uri.query = URI.encode_www_form(params)
+
+      request = Net::HTTP::Post.new(uri.request_uri, header)
+      request.set_form_data(params)
+      req_options = {
+        use_ssl: uri.scheme == 'https',
+        verify_mode: OpenSSL::SSL::VERIFY_NONE
+
+      }
+
+      request.content_type = 'application/pdf'
+      request.body = @resource.data
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+      out_data = response.body
+      ret_object = PdfTextResponse.new(out_data)
+      ret_object.is_successful = false
+      ret_object.status_code = response.code
+      if ret_object.status_code == '200'
+        ret_object.is_successful = true
+      else
+        out_data_json = JSON.parse(out_data)
+        ret_object.error_json = out_data
+        ret_object.error_message = if !out_data_json['message'].nil?
+                                     out_data_json['message']
+                                   else
+                                     "status_code : #{Net::HTTPResponse::CODE_TO_OBJ[ret_object.status_code]}"
+                                   end
+        ret_object.error_id = out_data_json['id']
+      end
+
+      ret_object
+    end
+  end
+end

data/lib/ruby_client/PdfTextResponse.rb

@@ -0,0 +1,27 @@
+module DynamicPDFApi
+  require_relative 'JsonResponse'
+
+  #
+  # Represents the pdf text response.
+  #
+  class PdfTextResponse < JsonResponse
+    #
+    # Initializes a new instance of the PdfResponse class.
+    #
+    # @param json_content [String] The json content
+    #
+    def initialize(json_content)
+      @content = JSON.pretty_generate(json_content).gsub('\\\\', '\\').gsub('\"', '"').gsub('\\\r', '\r').gsub('\\\n', '\n').gsub(
+        '\\\t', '\t'
+      )
+      @content = @content[1..@content.length - 2]
+
+      super(json_content)
+    end
+
+    #
+    # Gets the collection of PdfContent.
+    #
+    attr_accessor :content
+  end
+end

data/lib/ruby_client/PdfXmp.rb

@@ -0,0 +1,67 @@
+module DynamicPDFApi
+  require_relative 'PdfResource'
+  require_relative 'Endpoint'
+  require_relative 'XmlResponse'
+
+  class PdfXmp < Endpoint
+    #
+    # Initializes a new instance of the PdfInfo class.
+    #
+    # @param resource [PdfResource] The resource of type PdfResource.
+    #
+    def initialize(resource)
+      super()
+      @resource = resource
+      @_endpoint_name = 'pdf-xmp'
+    end
+
+    #
+    # Process the pdf resource to get  pdf's xmp data.
+    #
+    # @return XmlResponse Returns collection of XmlResponse.
+    #
+    def process
+      header = {
+        'Authorization': "Bearer #{@api_key}",
+        'Content-Length': @resource.data.length.to_s,
+        'Expect': '100-continue',
+        'Content-Type': 'application/pdf'
+      }
+      uri = URI.parse("#{@base_url}/v1.0/#{@_endpoint_name}")
+
+      request = Net::HTTP::Post.new(uri.request_uri, header)
+
+      req_options = {
+        use_ssl: uri.scheme == 'https',
+        verify_mode: OpenSSL::SSL::VERIFY_NONE
+
+      }
+
+      request.content_type = 'application/pdf'
+
+      request.body = @resource.data
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+      out_data = response.body
+      ret_object = XmlResponse.new(out_data)
+      ret_object.is_successful = false
+      ret_object.status_code = response.code
+      if ret_object.status_code == '200'
+        ret_object.is_successful = true
+      else
+        out_data_json = JSON.parse(out_data)
+        ret_object.error_json = out_data
+        ret_object.error_message = if !out_data_json['message'].nil?
+                                     out_data_json['message']
+                                   else
+                                     "status_code : #{Net::HTTPResponse::CODE_TO_OBJ[ret_object.status_code]}"
+                                   end
+        ret_object.error_id = out_data_json['id']
+      end
+
+      ret_object
+    end
+  end
+end

data/lib/ruby_client/PushButtonInformation.rb

@@ -0,0 +1,21 @@
+module DynamicPDFApi
+  #
+  # Represents information of a PushButton field.
+  #
+  class PushButtonInformation
+    def initialize
+      @name = nil
+      @label = nil
+    end
+
+    #
+    # Gets or Sets the name of a PushButton field.
+    #
+    attr_accessor :name
+
+    #
+    # Gets or Sets the label of a PushButton field.
+    #
+    attr_accessor :label
+  end
+end

data/lib/ruby_client/RC4128Security.rb

@@ -0,0 +1,62 @@
+module DynamicPDFApi
+  require_relative 'Security'
+  require_relative 'SecurityType'
+
+  #
+  # Represents RC4 128 bit PDF document security.
+  #
+  # RC4 128 bit PDF security, with UseCryptFilter property set to false is compatible with PDF version 1.4
+  # or higher and can be read with Adobe Acrobat Reader version 5 or higher. By default UseCryptFilter property
+  # is false. RC4 128 bit PDF security with crypt filter is compatible with PDF version 1.5 or higher and
+  # can be read with Adobe Acrobat Reader version 6 and higher. Older readers will not be able to read document
+  # encrypted with this security.
+  #
+  class RC4128Security < Security
+    #
+    # Initializes a new instance of the RC4128Security class.
+    #
+    # @param owner_password [String] The owner password to open the document.
+    # @param user_password [String] The user password to open the document.
+    #
+    def initialize(user_password, owner_password)
+      @_type = SecurityType::RC_4128
+      super(user_password, owner_password)
+      @encrypt_metadata = nil
+    end
+
+    #
+    # Gets or sets the documents components to be encrypted.
+    #
+    attr_accessor :encrypt_metadata
+
+    def to_json(_options = {})
+      json_array = {}
+      json_array['type'] = 'rc4128'
+
+      json_array['encryptMetadata'] = @encrypt_metadata unless @encrypt_metadata.nil?
+
+      #-------------------------------------------
+      json_array['allowCopy'] = @allow_copy unless @allow_copy.nil?
+
+      json_array['allowEdit'] = @allow_edit unless @allow_edit.nil?
+
+      json_array['allowPrint'] = @allow_print unless @allow_print.nil?
+
+      json_array['allowUpdateAnnotsAndFields'] = @allow_update_annots_and_fields unless @allow_update_annots_and_fields.nil?
+
+      json_array['ownerPassword'] = @owner_password unless @owner_password.nil?
+
+      json_array['userPassword'] = @user_password unless @user_password.nil?
+
+      json_array['allowAccessibility'] = @allow_accessibility unless @allow_accessibility.nil?
+
+      json_array['allowFormFilling'] = @allow_form_filling unless @allow_form_filling.nil?
+
+      json_array['allowHighResolutionPrinting'] = @allow_high_resolution_printing unless @allow_high_resolution_printing.nil?
+
+      json_array['allowDocumentAssembly'] = @allow_document_assembly unless @allow_document_assembly.nil?
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Resource.rb

@@ -0,0 +1,51 @@
+module DynamicPDFApi
+  require 'securerandom'
+  require_relative 'ResourceType'
+  require_relative 'EndPointException'
+
+  class Resource
+    def initialize(file = nil, resource_name = nil)
+      @_name = nil
+      @_type = nil
+      @_file_path = nil
+      @_mime_type = ''
+      unless file.nil?
+        if (file.is_a?(Array)) == true
+          @data = file.pack('c*')
+        elsif file.is_a?(String)
+          if File.exist?(file)
+            @_file_path = file
+            @data = Resource._get_file_data(file)
+          else
+            raise "#{file} : File does not exist."
+          end
+        else
+          @data = file.read
+        end
+
+        @resource_name = if resource_name.nil?
+                           SecureRandom.uuid + _file_extension
+                         else
+                           resource_name
+                         end
+
+        @_mime_type = ''
+      end
+    end
+
+    attr_accessor :data, :_mime_type, :_file_path
+
+    #
+    # Gets or sets the resource name.
+    #
+    attr_accessor :resource_name
+
+    def _file_extension
+      File.extname(@_file_path) unless @_file_path.nil?
+    end
+
+    def self._get_file_data(file_path)
+      File.binread(file_path)
+    end
+  end
+end

data/lib/ruby_client/ResourceType.rb

@@ -0,0 +1,48 @@
+module DynamicPDFApi
+  #
+  #
+  # Specifies resource type.
+  #
+  #
+  class ResourceType
+    #
+    # Image resource.
+    #
+    IMAGE = "Image".freeze
+
+    #
+    # Pdf resource.
+    #
+    PDF = "Pdf".freeze
+
+    #
+    # LayoutData resource.
+    #
+    LAYOUT_DATA = "LayoutData".freeze
+
+    #
+    # Dlex resource.
+    #
+    DLEX = "Dlex".freeze
+
+    #
+    # Font resource.
+    #
+    FONT = "Font".freeze
+
+    #
+    # Html resource.
+    #
+    HTML = "Html".freeze
+
+    #
+    # Word resource.
+    #
+    WORD = "Word".freeze
+
+    #
+    # Excel resource.
+    #
+    EXCEL = "Excel".freeze
+  end
+end

data/lib/ruby_client/Response.rb

@@ -0,0 +1,39 @@
+module DynamicPDFApi
+  #
+  # Represents the base class for response.
+  #
+  class Response
+    def initialize
+      @_is_successful = false
+      @_error_message = nil
+      @_error_id = nil
+      @_status_code = nil
+      @_error_json = nil
+    end
+
+    #
+    # Gets the boolean, indicating the response's status.
+    #
+    attr_accessor :is_successful
+
+    #
+    # Gets the error message.
+    #
+    attr_accessor :error_message
+
+    #
+    # Gets the error id.
+    #
+    attr_accessor :error_id
+
+    #
+    # Gets the status code.
+    #
+    attr_accessor :status_code
+
+    #
+    # Gets the error json.
+    #
+    attr_accessor :error_json
+  end
+end