dynamicpdf_api 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0680c136fd344450e1b3f772c0ec4094781342bdee3114037fc27de04c036a8a'
-  data.tar.gz: 4b5541b2b8d47dabc56c894857d1bf2fad98b53c770023d080ef7ac096fa4306
+  metadata.gz: a7ac0d6c7b3af40747eebd62d4bbe5312c47f7df899eeeace9e62baafd607f19
+  data.tar.gz: 6f3448f2d9daa4d345109bb187797ad2f4f385b5225c6217159868e4d4e79bee
 SHA512:
-  metadata.gz: 1b8c8d62491859abfbb0bc5718fd9594b969e0689b5abd369fc283afca882186370e0bbe1e6edc311a98370e259d01443016fbd6e048e6e4ca6b544069af856e
-  data.tar.gz: 9b104c7ea32e0a9f35cf3468eae12fb395d8f8a42ffa04b0894253d0e52b81323ada51db32ce83602a04d21482238572ca42cf3d81dc732795cb3fc0a68f0a29
+  metadata.gz: 5666463e8fdfa35d273f72b1e13cced90e661054cfb772329869f77069303c28fe7bdfb802ff9dbe5db68aaab7b1b114377d78e0ad15f85e1350287a57f646c1
+  data.tar.gz: 8536196f5815157f71fe925c4cd7879a1b09dc5e8ea1f8723d3e94207fbe927ab55b19a38cd9bb80c66a76b3bd4d17c9f6db3bfb4bb5543827fec8bbb59a12a1

data/lib/ruby_client/EncryptionType.rb

@@ -0,0 +1,31 @@
+module DynamicPDFApi
+  #
+  # Specifies Encryption Type.
+  #
+  class EncryptionType
+    #
+    # RC4 40 bit security.
+    #
+    RC440 = 'rc440'.freeze
+
+    #
+    # RC4 128 bit security.
+    #
+    RC4128 = 'rc4128'.freeze
+
+    #
+    # AES 128 bit security with CBC cipher mode.
+    #
+    AES128CBC = 'aes128cbc'.freeze
+
+    #
+    # AES 256 bit security with CBC cipher mode.
+    #
+    AES256CBC = 'aes256cbc'.freeze
+
+    #
+    # No security.
+    #
+    NONE = 'none'.freeze
+  end
+end

data/lib/ruby_client/PdfSecurityInfo.rb

@@ -0,0 +1,102 @@
+module DynamicPDFApi
+  require_relative 'EncryptionType'
+
+  # Represents the PDF security info endpoint.
+  class PdfSecurityInfo
+    def initialize(data = {})
+      @encryption_type_string       = data["encryptionType"]
+      @allow_edit                   = data["allowEdit"]
+      @allow_print                  = data["allowPrint"]
+      @allow_update_annots_and_fields = data["allowUpdateAnnotsAndFields"]
+      @allow_copy                   = data["allowCopy"]
+      @allow_high_resolution_printing = data["allowHighResolutionPrinting"]
+      @allow_document_assembly      = data["allowDocumentAssembly"]
+      @allow_form_filling           = data["allowFormFilling"]
+      @allow_accessibility          = data["allowAccessibility"]
+      @encrypt_all_except_metadata  = data["encryptAllExceptMetadata"]
+      @encrypt_only_file_attachments = data["encryptOnlyFileAttachments"]
+      @has_owner_password           = data["hasOwnerPassword"]
+      @has_user_password            = data["hasUserPassword"]
+      @encryption_type = encryption_type()
+    end
+
+    #
+    # Gets or sets if the document can be edited by the user.
+    #
+    attr_accessor :allow_edit
+
+    #
+    # Gets or sets if the document can be printed by the user.
+    #
+    attr_accessor :allow_print
+
+    #
+    # Gets or sets if annotations and form fields can be added, edited and modified by the user.
+    #
+    attr_accessor :allow_update_annots_and_fields
+
+    #
+    # Gets or sets if text and images can be copied to the clipboard by the user.
+    #
+    attr_accessor :allow_copy
+
+    #
+    # Gets or sets if the document can be printed at a high resolution by the user.
+    #
+    attr_accessor :allow_high_resolution_printing
+
+    #
+    # Gets or sets if the document can be assembled and manipulated by the user.
+    #
+    attr_accessor :allow_document_assembly
+
+    #
+    # Gets or sets if form filling should be allowed by the user.
+    #
+    attr_accessor :allow_form_filling
+
+    #
+    # Gets or sets if accessibility programs should be able to read the documents text and images for the user.
+    #
+    attr_accessor :allow_accessibility
+
+    #
+    # Gets or sets a value indicating whether all data should be encrypted except for metadata.
+    #
+    attr_accessor :encrypt_all_except_metadata
+
+    #
+    # Gets or sets a value indicating whether only file attachments should be encrypted.
+    #
+    attr_accessor :encrypt_only_file_attachments
+
+    #
+    # Gets or sets a value indicating whether the PDF document has an owner password set.
+    #
+    attr_accessor :has_owner_password
+
+    #
+    # Gets or sets a value indicating whether the PDF document has an user password set.
+    #
+    attr_accessor :has_user_password
+
+
+    # Gets or sets the encryption type.
+    attr_accessor :encryption_type_string
+
+    def encryption_type
+      case (@encryption_type_string).downcase
+      when "rc4-40"
+        EncryptionType::RC440
+      when "rc4-128"
+        EncryptionType::RC4128
+      when "aes-128-cbc"
+        EncryptionType::AES128CBC
+      when "aes-256-cbc"
+        EncryptionType::AES256CBC
+      else
+        EncryptionType::NONE
+      end
+    end
+  end
+end

data/lib/ruby_client/PdfSecurityInfoEndpoint.rb

@@ -0,0 +1,71 @@
+module DynamicPDFApi
+  require_relative 'Endpoint'
+  require_relative 'PdfSecurityInfoResponse'
+
+  #
+  # Represents the pdf security info endpoint.
+  #
+  class PdfSecurityInfoEndpoint < Endpoint
+    #
+    # Initializes a new instance of the PdfSecurityInfoEndpoint class.
+    #
+    # @param resource [PdfResource] The resource of type PdfResource.
+    #
+    def initialize(resource)
+      super()
+      @resource = resource
+      @_endpoint_name = 'pdf-security-info'
+    end
+
+    #
+    # Process the pdf resource to get pdf's security information.
+    # @return PdfInfoResponse Returns collection of PdfSecurityInfoResponse.
+    #
+    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 = PdfSecurityInfoResponse.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
+        if ret_object.status_code == '401'
+          raise "Invalid api key specified."
+        end
+        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/PdfSecurityInfoResponse.rb

@@ -0,0 +1,28 @@
+module DynamicPDFApi
+  require_relative 'JsonResponse'
+  require_relative 'PdfSecurityInfo'
+
+  #
+  # Represents the pdf security info response.
+  #
+  class PdfSecurityInfoResponse < JsonResponse
+    #
+    # Initializes a new instance of the PdfSecurityInfoResponse class.
+    #
+    # @param json_content [String] The json content
+    #
+    def initialize(json_content = nil)
+      @content = nil
+      super(json_content) unless json_content.nil?
+      @content = PdfSecurityInfo.new(JSON.parse(json_content))
+
+    end
+    #   # @content.instance_variable_set(:@encryption_type, @content.encryption_type)
+    # end
+
+    #
+    # Gets the collection of PdfContent.
+    #
+    attr_accessor :content
+  end
+end

data/lib/ruby_client/SecurityType.rb

@@ -18,6 +18,6 @@ module DynamicPDFApi
     #
     # RC4 128 bit security.
     #
-    RC_4128 = 'aC4128'.freeze
+    RC_4128 = 'rc4128'.freeze
   end
 end

data/lib/ruby_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyClient
-VERSION = "1.2.1" 
+VERSION = "1.3.0" 
 end

data/lib/ruby_client.rb

@@ -16,6 +16,7 @@ require_relative "ruby_client/DlexInput.rb"
 require_relative "ruby_client/DlexLayout.rb"
 require_relative "ruby_client/DlexResource.rb"
 require_relative "ruby_client/EncryptDocumentComponents.rb"
+require_relative "ruby_client/EncryptionType.rb"
 require_relative "ruby_client/Endpoint.rb"
 require_relative "ruby_client/EndPointException.rb"
 require_relative "ruby_client/EndpointResource.rb"
@@ -59,6 +60,9 @@ require_relative "ruby_client/PdfInput.rb"
 require_relative "ruby_client/PdfInstructions.rb"
 require_relative "ruby_client/PdfResource.rb"
 require_relative "ruby_client/PdfResponse.rb"
+require_relative "ruby_client/PdfSecurityInfo.rb"
+require_relative "ruby_client/PdfSecurityInfoEndpoint.rb"
+require_relative "ruby_client/PdfSecurityInfoResponse.rb"
 require_relative "ruby_client/PdfText.rb"
 require_relative "ruby_client/PdfTextResponse.rb"
 require_relative "ruby_client/PdfXmp.rb"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamicpdf_api
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Dynamicpdf
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-29 00:00:00.000000000 Z
+date: 2025-11-14 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby Client API that uses the DynamicPDF API to create, merge, split,
   form fill, stamp, secure/encrypt PDF documents and convert word/Excel files to PDF.
@@ -72,6 +72,7 @@ files:
 - lib/ruby_client/Elements/TextElement.rb
 - lib/ruby_client/Elements/ValueType.rb
 - lib/ruby_client/EncryptDocumentComponents.rb
+- lib/ruby_client/EncryptionType.rb
 - lib/ruby_client/EndPointException.rb
 - lib/ruby_client/Endpoint.rb
 - lib/ruby_client/EndpointResource.rb
@@ -146,6 +147,9 @@ files:
 - lib/ruby_client/PdfInstructions.rb
 - lib/ruby_client/PdfResource.rb
 - lib/ruby_client/PdfResponse.rb
+- lib/ruby_client/PdfSecurityInfo.rb
+- lib/ruby_client/PdfSecurityInfoEndpoint.rb
+- lib/ruby_client/PdfSecurityInfoResponse.rb
 - lib/ruby_client/PdfText.rb
 - lib/ruby_client/PdfTextResponse.rb
 - lib/ruby_client/PdfXmp.rb