adobe_pdfservices_ruby 0.1.1

data/lib/pdfservices/operations/ocr/external.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module PdfServices
+  module Ocr
+    class External < Operation
+      EXTERNAL_OPTIONS = %i[input output params download_from_external].freeze
+      INPUT_KEYS = %i[uri storage].freeze
+      OUTPUT_KEYS = %i[uri storage].freeze
+      PARAMS_KEYS = %i[ocr_lang ocr_type].freeze
+      STORAGE_OPTIONS = %i[S3 SHAREPOINT DROPBOX BLOB].freeze
+
+      def initialize(api)
+        super
+        @download_from_external = false
+        @download_uri = nil
+      end
+
+      def execute(url, options = {})
+        @download_from_external = options[:download_from_external] || false
+        options[:input][:uri] = options[:input][:uri] || url
+        validate_options(options)
+
+        @download_uri = options[:output][:uri] if @download_from_external
+
+        response = @api.post(OPERATION_ENDPOINT,
+                             body: request_body(asset.id, options),
+                             headers: request_headers)
+        handle_response(response, asset.id)
+      end
+
+      private
+
+      def request_body(asset_id, options)
+        {
+          assetID: asset_id,
+          input: camelize_keys(options[:input]),
+          output: camelize_keys(options[:output]),
+          params: camelize_keys(options[:params])
+        }
+      end
+
+      def handle_polling_done(_json_response, original_asset)
+        file = @api.get(@download_uri).body if @download_from_external
+        super
+        file || true
+      end
+
+      def validate_options(options)
+        raise ArgumentError, 'Options must be a hash' unless options.is_a?(Hash)
+
+        ocr_lang = options[:params][:ocr_lang]
+        ocr_type = options[:params][:ocr_type]
+
+        validate_required_keys(options)
+        validate_input_options(options[:input])
+        validate_output_options(options[:output])
+        validate_ocr_lang_option(ocr_lang) if ocr_lang
+        validate_ocr_type_option(ocr_type) if ocr_type
+      end
+
+      def validate_required_keys(options)
+        required_keys = EXTERNAL_OPTIONS - %i[download_from_external]
+        required_keys.each do |key|
+          raise ArgumentError, "Missing required key: #{key}" unless options.key?(key)
+        end
+      end
+
+      def validate_input_options(input_options)
+        raise ArgumentError, 'Input options must be a hash' unless input_options.is_a?(Hash)
+
+        required_input_keys = INPUT_KEYS
+        required_input_keys.each do |key|
+          raise ArgumentError, "Missing required input key: #{key}" unless input_options.key?(key)
+        end
+        validate_storage_options(input_options[:storage])
+      end
+
+      def validate_output_options(output_options)
+        raise ArgumentError, 'Output options must be a hash' unless output_options.is_a?(Hash)
+
+        unless output_options.key?(:uri) && @download_from_external
+          raise ArgumentError,
+                'Output options must contain uri when downloading from external storage'
+        end
+
+        required_output_keys = OUTPUT_KEYS - %i[uri]
+        required_output_keys.each do |key|
+          raise ArgumentError, "Missing required output key: #{key}" unless output_options.key?(key)
+        end
+        validate_storage_options(output_options[:storage])
+      end
+
+      def validate_storage_option(storage_option)
+        return if STORAGE_OPTIONS.include?(storage_option)
+
+        raise ArgumentError,
+              "Invalid storage option: #{storage_option}"
+      end
+
+      def validate_params_options(params_options)
+        raise ArgumentError, 'Params options must be a hash' unless params_options.is_a?(Hash)
+
+        params_options.each_key do |key|
+          raise ArgumentError, "Invalid params option: #{key}" unless PARAMS_KEYS.include?(key)
+        end
+      end
+    end
+  end
+end

data/lib/pdfservices/operations/ocr/internal.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module PdfServices
+  module Ocr
+    class Internal < Operation
+      INTERNAL_OPTIONS = %i[ocr_lang ocr_type notifiers].freeze
+
+      def execute(html_file_path, options = {})
+        validate_options(options)
+        asset = upload_asset(html_file_path)
+
+        response = @api.post(OPERATION_ENDPOINT,
+                             body: request_body(asset.id, options),
+                             headers: request_headers)
+
+        handle_response(response, asset.id)
+      end
+
+      private
+
+      def handle_polling_done(json_response, _original_asset_id)
+        asset_id = json_response['asset']['assetID']
+        Asset.new(@api).download(asset_id).body
+      end
+
+      def request_body(asset_id, options)
+        body = {
+          assetID: asset_id
+        }
+        body[:ocrLang] = options[:ocr_lang] if options[:ocr_lang]
+        body[:ocrType] = options[:ocr_type] if options[:ocr_type]
+        body[:notifiers] = options[:notifiers] if options[:notifiers]
+        body
+      end
+
+      def validate_options(options)
+        raise ArgumentError, 'Invalid options' unless options.is_a?(Hash)
+
+        options.each_key do |key|
+          raise ArgumentError, "Invalid option: #{key}" unless INTERNAL_OPTIONS.include?(key)
+        end
+
+        validate_ocr_lang_option(options[:ocr_lang]) if options[:ocr_lang]
+        validate_ocr_type_option(options[:ocr_type]) if options[:ocr_type]
+      end
+    end
+  end
+end

data/lib/pdfservices/operations/ocr.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module PdfServices
+  module Ocr
+    class Operation < InternalExternalOperation::Operation
+      OCR_ENDPOINT = 'https://pdf-services-ue1.adobe.io/operation/ocr'
+      OCR_LANGS = %w[
+        da-DK lt-LT sl-SI el-GR ru-RU en-US zh-HK hu-HU et-EE
+        pt-BR uk-UA nb-NO pl-PL lv-LV fi-FI ja-JP es-ES bg-BG
+        en-GB cs-CZ mt-MT de-DE hr-HR sk-SK sr-SR ca-CA mk-MK
+        ko-KR de-CH nl-NL zh-CN sv-SE it-IT no-NO tr-TR fr-FR
+        ro-RO iw-IL
+      ].freeze
+
+      OCR_TYPES = %w[searchable_image searchable_image_exact].freeze
+
+      private
+
+      def validate_ocr_lang_option(ocr_lang)
+        raise ArgumentError, "Invalid ocr_lang option: #{ocr_lang}" unless OCR_LANGS.include?(ocr_lang)
+      end
+
+      def validate_ocr_type_option(ocr_type)
+        raise ArgumentError, "Invalid ocr_type option: #{ocr_type}" unless OCR_TYPES.include?(ocr_type)
+      end
+    end
+  end
+end

data/lib/pdfservices/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PdfServices
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: adobe_pdfservices_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jimmy Bosse
+- Ben Terova
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+description: An Adobe PDF Services Ruby SDK provides APIs for creating, combining,
+  exporting and manipulating PDFs.
+email:
+- jimmy.bosse@ankura.com
+- ben@benterova.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".vscode/extensions.json"
+- ".vscode/settings.json"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- adobe_pdfservices_ruby.gemspec
+- lib/adobe_pdfservices_ruby.rb
+- lib/pdfservices/api.rb
+- lib/pdfservices/asset.rb
+- lib/pdfservices/client.rb
+- lib/pdfservices/errors.rb
+- lib/pdfservices/operations/base.rb
+- lib/pdfservices/operations/document_generation.rb
+- lib/pdfservices/operations/document_generation/external.rb
+- lib/pdfservices/operations/document_generation/internal.rb
+- lib/pdfservices/operations/extract_pdf.rb
+- lib/pdfservices/operations/html_to_pdf.rb
+- lib/pdfservices/operations/html_to_pdf/external.rb
+- lib/pdfservices/operations/html_to_pdf/internal.rb
+- lib/pdfservices/operations/internal_external_operation.rb
+- lib/pdfservices/operations/ocr.rb
+- lib/pdfservices/operations/ocr/external.rb
+- lib/pdfservices/operations/ocr/internal.rb
+- lib/pdfservices/version.rb
+homepage: https://github.com/benterova/adobe_pdfservices_ruby/blob/main/README.md
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/benterova/adobe_pdfservices_ruby/blob/main/README.md
+  source_code_uri: https://github.com/benterova/adobe_pdfservices_ruby
+  changelog_uri: https://github.com/benterova/adobe_pdfservices_ruby/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Adobe PDF Services Ruby
+test_files: []