dynamicpdf_api 1.0.0.pre.beta

data/lib/ruby_client/Pdf.rb

@@ -0,0 +1,417 @@
+module DynamicPDFApi
+  require "net/http"
+  require "net/https"
+  require "uri"
+  require "json"
+  require "openssl"
+
+  require_relative "Endpoint"
+  require_relative "PdfInstructions"
+  require_relative "Input"
+  require_relative "PdfInput"
+  require_relative "Resource"
+  require_relative "PdfResource"
+  require_relative "PdfResponse"
+  require_relative "PageInput"
+  require_relative "OutlineList"
+
+  #
+  # Represents a pdf endpoint.
+  #
+  class Pdf < Endpoint
+    #
+    # Initializes a new instance of the Pdf class.
+    #
+    def initialize
+      super
+      @_endpoint_name = "pdf"
+      @out_lines = OutlineList.new
+      @instructions = PdfInstructions.new
+      @author = nil
+      @resources = {}
+      @title = nil
+      @subject = nil
+      @creator = ""
+      @producer = ""
+      @tag = nil
+      @keywords = nil
+      @security = nil
+      @flatten_all_form_fields = nil
+      @retain_signature_form_fields = nil
+      @inputs = []
+      @templates = {}
+      @fonts = {}
+      @form_fields = []
+    end
+
+    #
+    # Adds additional resource to the endpoint.
+    #
+    # <param name="resourcePath">The resource file path.
+    # <param name="resourceName">The name of the resource.
+    def add_additional_resource(resourcePath, resourceName = nil)
+      if (resourceName == nil)
+        resourceName = Path.GetFileName(resourcePath)
+      end
+
+      resource = AdditionalResource.new(resourcePath, resourceName)
+      @resources.Add(resource)
+    end
+
+    attr_accessor :instructions
+
+    #
+    # Gets or sets the collection of resource.
+    #
+    attr_accessor :resources
+
+    #
+    # Gets or sets the author.
+    #
+    attr_accessor :author
+
+    #
+    # Gets or sets the title.
+    #
+    attr_accessor :title
+
+    #
+    # Gets or sets the subject.
+    #
+    attr_accessor :subject
+
+    #
+    # Gets or sets the creator.
+    #
+    attr_accessor :creator
+
+    #
+    # Gets or sets the PDF producer.
+    #
+    attr_accessor :producer
+
+    #
+    # Gets or sets the Tag property.
+    #
+    attr_accessor :tag
+
+    #
+    # Gets or sets the keywords.
+    #
+    attr_accessor :keywords
+
+    #
+    # Gets or sets the security.
+    #
+    attr_accessor :security
+
+    #
+    # Gets or sets the value indicating whether to flatten all form fields.
+    #
+    attr_accessor :flatten_all_form_fields
+
+    #
+    # Gets or sets the value indicating whether to retain signature form field.
+    #
+    attr_accessor :retain_signature_form_fields
+
+    #
+    # Returns a PdfInput object containing the input pdf.
+    #
+    # @param resource [String]|[PdfResource] The resource path in cloud resource manager or the resource of type PdfResource.
+    # @param options [MergeOptions] The merge options for the pdf.
+    #
+    # @return PdfInput PdfInput object.
+    #
+    def add_pdf(resource, options = nil)
+      input = PdfInput.new(resource, options)
+      @inputs << input
+      input
+    end
+
+    #
+    # Returns an ImageInput object containing the input pdf.
+    #
+    # @param resource [String]|[ImageResource] The resource path in cloud resource manager or the resource of type ImageResource.
+    #
+    # @return ImageInput ImageInput object.
+    #
+    def add_image(resource)
+      input = ImageInput.new(resource)
+      @inputs << input
+      input
+    end
+
+    #
+    # Returns an HtmlInput object containing the input pdf.
+    #
+    # @param resource [String]|[HtmlResource] The resource of type HtmlResource.
+    #
+    # @return HtmlInput HtmlInput object.
+    #
+    def add_html(html, basepath = null, size = PageSize.A4, orientation = PageOrientation.PORTRAIT, margins = nil)
+      input = nil
+      if file.is_a?(String)
+        input = HtmlInput.new(HtmlResource.new(html), basepath, size, orientation, margins)
+      else
+        input = HtmlInput.new(resource, basepath, size, orientation, margins)
+      end
+
+      @inputs << input
+      input
+    end
+
+    #
+    # Returns a WordInput object containing the input pdf.
+    #
+    # @param resource [WordResource] The resource of type WordResource.
+    #
+    # @return WordInput WordInput object.
+    #
+    def add_word(resource, size = PageSize.A4, orientation = PageOrientation.PORTRAIT, margins = nil)
+      input = WordInput.new(resource, size, orientation, margins)
+      @inputs << input
+      input
+    end
+
+    #
+    # Returns a ExcelInput object containing the input pdf.
+    #
+    # @param resource [ExcelResource] The resource of type ExcelResource.
+    #
+    # @return ExcelInput ExcelInput object.
+    #
+    def add_excel(resource, size = PageSize.A4, orientation = PageOrientation.PORTRAIT, margins = nil)
+      input = ExcelInput.new(resource, size, orientation, margins)
+      @inputs << input
+      input
+    end
+
+    #
+    # Returns a DlexInput object containing the input pdf.
+    #
+    # @param dlex [String]|[DlexResource] The resource path in cloud resource manager or the dlex resource of type DlexResource.
+    # @param layout_data [String]|[Layout_dataResource] The layout data resource path in cloud resource manager or the layout data resource of type Layout_dataResource.
+    #
+    # @return DlexInput DlexInput object.
+    #
+    def add_dlex(dlex, layout)
+      input = DlexInput.new(dlex, layout)
+      @inputs << input
+      input
+    end
+
+    #
+    # Returns a page_input object containing the input pdf.
+    #
+    # @param page_width [float] The width of the page.
+    # @param page_height [float] The height of the page.
+    #
+    # @return page_input page_input object.
+    #
+    def add_page(page_width = nil, page_height = nil)
+      input = if !page_width.nil? && !page_height.nil?
+          PageInput.new(page_width, page_height)
+        else
+          PageInput.new
+        end
+      @inputs << input
+      input
+    end
+
+    #
+    # Gets the inputs.
+    #
+    attr_reader :inputs
+
+    def inputs=(_value)
+      @inputs = {}
+    end
+
+    #
+    # Gets the templates.
+    #
+    attr_accessor :templates
+
+    #
+    # Gets the fonts.
+    #
+    attr_accessor :fonts
+
+    #
+    # Gets the formFields.
+    #
+    attr_accessor :form_fields
+
+    #
+    # Gets the outlines.
+    #
+    attr_accessor :out_lines
+
+    #
+    # Process to create pdf.
+    #
+    # @return PdfResponse Returns collection of PdfResponse.
+    #
+    def process
+      @instructions._author = @author
+      @instructions._title = @title
+      @instructions._subject = @subject
+      @instructions._creator = @creator
+      @instructions._producer = @producer
+      @instructions._tag = @tag
+      @instructions._keywords = @keywords
+      @instructions._security = @security
+      @instructions._flatten_all_form_fields = @flatten_all_form_fields
+      @instructions._retain_signature_form_fields = @retain_signature_form_fields
+      @instructions._inputs = @inputs
+
+      @instructions._templates = @templates
+      @instructions._fonts = @fonts
+      @instructions._form_fields = @form_fields
+      @instructions._out_lines = @out_lines
+      # @Instructions.form_fields = @form_fields
+
+      @instructions._inputs.each do |input|
+        if input._type == InputType::PAGE
+          page_input = input
+          page_input.elements.each do |element|
+            @resources[element._resource.resource_name] = element._resource unless element._resource.nil?
+            if !element._text_font.nil?
+              font_serialized_array = element._text_font
+              @instructions._fonts[element._text_font._name] = font_serialized_array
+            end
+          end
+        end
+
+        input._resources.each do |resource|
+          @resources[resource.resource_name] = resource unless resource.nil?
+        end
+
+        if !input.get_template.nil?
+          template = input.get_template
+          @instructions._templates[template.id] = template
+          if !input.get_template.elements.nil? && !input.get_template.elements.empty?
+            input.get_template.elements.each do |element|
+              @resources[element._resource.resource_name] = element._resource unless element._resource.nil?
+              if !element._text_font.nil?
+                font_serialized_array = element._text_font
+
+                @instructions._fonts[element._text_font._name] = font_serialized_array
+              end
+            end
+          end
+        end
+      end
+
+      data_string = @instructions.to_json
+
+      header = {
+        'authorization': "Bearer #{@api_key}",
+        'Expect': "100-continue",
+      }
+      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,
+
+      }
+
+      resource_array = []
+      resource_array << ["Instructions", data_string,
+                         { content_type: "application/octet-stream", filename: "Instructions.json" }]
+      @resources.each_value do |field|
+        data = if !field._file_path.nil?
+            File.binread(field._file_path)
+          else
+            field.data
+          end
+
+        resource_array << ["Resource", data,
+                           { content_type: "application/octet-stream", filename: field.resource_name }]
+      end
+      request.set_form(resource_array, "multipart/form-data")
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      ret_object = PdfResponse.new
+      ret_object.is_successful = false
+      ret_object.status_code = response.code
+      out_data = response.body
+
+      if !ret_object.nil? && ret_object.status_code == "200" && out_data[0, 4].eql?("%PDF") == true
+        ret_object = PdfResponse.new(out_data)
+        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
+
+    def get_instructions_json(indented = false)
+      @tembInstructions = PdfInstructions.new
+      @tembInstructions._author = @author
+      @tembInstructions._title = @title
+      @tembInstructions._subject = @subject
+      @tembInstructions._creator = @creator
+      @tembInstructions._producer = @producer
+      @tembInstructions._tag = @tag
+      @tembInstructions._keywords = @keywords
+      @tembInstructions._security = @security
+      @tembInstructions._flatten_all_form_fields = @flatten_all_form_fields
+      @tembInstructions._retain_signature_form_fields = @retain_signature_form_fields
+      @tembInstructions._inputs = @inputs
+      @tembInstructions._templates = @templates
+      @tembInstructions._fonts = @fonts
+      @tembInstructions._form_fields = @form_fields
+      @tembInstructions._out_lines = @out_lines
+      # @tembInstructions.form_fields = @form_fields
+
+      @tembInstructions._inputs.each do |input|
+        if input._type == InputType::PAGE
+          page_input = input
+          page_input.elements.each do |element|
+            @resources[element._resource.resource_name] = element._resource unless element._resource.nil?
+            if !element._text_font.nil?
+              font_serialized_array = element._text_font
+              @tembInstructions._fonts[element._text_font._name] = font_serialized_array
+            end
+          end
+        end
+
+        input._resources.each do |resource|
+          @resources[resource.resource_name] = resource unless resource.nil?
+        end
+
+        if !input.get_template.nil?
+          template = input.get_template
+          @tembInstructions._templates[template.id] = template
+          if !input.get_template.elements.nil? && !input.get_template.elements.empty?
+            input.get_template.elements.each do |element|
+              @resources[element._resource.resource_name] = element._resource unless element._resource.nil?
+              if !element._text_font.nil?
+                font_serialized_array = element._text_font
+
+                @tembInstructions._fonts[element._text_font._name] = font_serialized_array
+              end
+            end
+          end
+        end
+      end
+      #data_string = @instructions.to_json
+      @tembInstructions.to_json
+    end
+  end
+end

data/lib/ruby_client/PdfContent.rb

@@ -0,0 +1,21 @@
+module DynamicPDFApi
+  #
+  # Represents the pdf content
+  #
+  class PdfContent
+    def initialize
+      @page_number = nil
+      @text = nil
+    end
+
+    #
+    # Gets or sets the page number.
+    #
+    attr_accessor :page_number
+
+    #
+    # Gets the text in the pdf.
+    #
+    attr_accessor :text
+  end
+end

data/lib/ruby_client/PdfInfo.rb

@@ -0,0 +1,68 @@
+module DynamicPDFApi
+  require_relative 'Endpoint'
+  require_relative 'PdfInfoResponse'
+
+  #
+  # Represents the pdf info endpoint.
+  #
+  class PdfInfo < 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-info'
+    end
+
+    #
+    # Process the pdf resource to get pdf's information.
+    # @return PdfInfoResponse Returns collection of PdfInfoResponse.
+    #
+    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 = PdfInfoResponse.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/PdfInfoResponse.rb

@@ -0,0 +1,27 @@
+module DynamicPDFApi
+  require_relative 'JsonResponse'
+
+  #
+  # Represents the pdf information response.
+  #
+  class PdfInfoResponse < JsonResponse
+    #
+    # Initializes a new instance of the PdfInfoResponse class.
+    #
+    # @param json_content [String] The json of pdf information.
+    #
+    def initialize(json_content = nil)
+      @content = []
+      return if json_content.nil?
+
+      super(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]
+    end
+
+    #
+    # Gets the pdf information content.
+    #
+    attr_accessor :content
+  end
+end

data/lib/ruby_client/PdfInformation.rb

@@ -0,0 +1,81 @@
+module DynamicPDFApi
+  #
+  # Represents the pdf information.
+  #
+  class PdfInformation
+    def initialize
+      @author = nil
+      @subject = nil
+      @keywords = nil
+      @creator = nil
+      @producer = nil
+      @title = nil
+      @pages = {}
+      @form_fields = nil
+      @custom_properties = nil
+      @xmp_meta_data = nil
+      @signed = nil
+      @tagged = nil
+    end
+
+    #
+    # Gets the author.
+    #
+    attr_accessor :author
+
+    #
+    # Gets the subject.
+    #
+    attr_accessor :subject
+
+    #
+    # Gets the keywords.
+    #
+    attr_accessor :keywords
+
+    #
+    # Gets the creator.
+    #
+    attr_accessor :creator
+
+    #
+    # Gets the producer.
+    #
+    attr_accessor :producer
+
+    #
+    # Gets the title.
+    #
+    attr_accessor :title
+
+    #
+    # Gets the collection of PageInformation.
+    #
+    attr_accessor :pages
+
+    #
+    # Gets the form fields.
+    #
+    attr_accessor :form_fields
+
+    #
+    # Gets the custom properties.
+    #
+    attr_accessor :custom_properties
+
+    #
+    # Gets the boolean representing xmp meta data.
+    #
+    attr_accessor :xmp_meta_data
+
+    #
+    # Gets the boolean, indicating whether the pdf is signed.
+    #
+    attr_accessor :signed
+
+    #
+    # Gets the boolean, indicating whether the pdf is tagged.
+    #
+    attr_accessor :tagged
+  end
+end

data/lib/ruby_client/PdfInput.rb

@@ -0,0 +1,66 @@
+module DynamicPDFApi
+  require_relative 'Input'
+  require_relative 'InputType'
+  require_relative 'MergeOptions'
+  require_relative 'PdfResource'
+
+  #
+  # Represents a pdf input.
+  #
+  class PdfInput < Input
+    #
+    # Initializes a new instance of the PdfInput class.
+    #
+    # @param resource [String]|[PdfResource] The resource path in cloud resource manager or the resource of type PdfResource.
+    # @param options [MergeOptions] The merge options for the pdf.
+    #
+    def initialize(resource, options = nil)
+      @id = nil
+      @_type = InputType::PDF
+      @start_page = nil
+      @page_count = nil
+      @merge_options = options
+      super(resource)
+    end
+
+    attr_accessor :_type
+
+    #
+    # Gets or sets the merge options MergeOptions.
+    #
+    attr_accessor :merge_options
+
+    #
+    # Gets or sets the start page.
+    #
+    attr_accessor :start_page
+
+    #
+    # Gets or sets the page count.
+    #
+    attr_accessor :page_count
+
+    def to_json(_options = {})
+      @template = get_template
+      json_array = {}
+
+      json_array['type'] = 'pdf'
+
+      json_array['mergeOptions'] = @merge_options unless @merge_options.nil?
+
+      json_array['startPage'] = @start_page unless @start_page.nil?
+
+      json_array['pageCount'] = @page_count unless @page_count.nil?
+
+      #---------------------------------------------------
+
+      json_array['templateId'] = @_template_id
+
+      json_array['resourceName'] = @resource_name
+
+      json_array['id'] = @id
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end