mindee 4.12.0 → 5.0.0.beta1

data/lib/mindee/parsing/v2/raw_text.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Mindee
-  module Parsing
-    module V2
-      # Raw text extracted from all pages in the document.
-      class RawText
-        # @return [Array[Mindee::Parsing::V2::RawTextPage]] List of pages with their extracted text content.
-        attr_reader :pages
-
-        # @param server_response [Hash] Raw JSON parsed into a Hash.
-        def initialize(server_response)
-          @pages = []
-          server_response.fetch('pages', []).each do |page|
-            @pages.push RawTextPage.new(page)
-          end
-        end
-
-        def to_s
-          "#{@pages.map(&:to_s).join("\n\n")}\n"
-        end
-      end
-    end
-  end
-end

data/lib/mindee/parsing/v2/raw_text_page.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Mindee
-  module Parsing
-    module V2
-      # Raw text extracted from a single page.
-      class RawTextPage
-        # @return [String] Text content of the page as a single string. '\n' is used to separate lines.
-        attr_reader :content
-
-        # @param server_response [Hash] Raw JSON parsed into a Hash.
-        def initialize(server_response)
-          @content = server_response['content']
-        end
-
-        def to_s
-          @content
-        end
-      end
-    end
-  end
-end

data/lib/mindee/parsing/v2.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'v2/common_response'
-require_relative 'v2/error_response'
-require_relative 'v2/field'
-require_relative 'v2/inference'
-require_relative 'v2/inference_file'
-require_relative 'v2/inference_model'
-require_relative 'v2/inference_response'
-require_relative 'v2/inference_result'
-require_relative 'v2/inference_active_options'
-require_relative 'v2/job'
-require_relative 'v2/job_response'
-require_relative 'v2/job_webhook'
-require_relative 'v2/raw_text'
-require_relative 'v2/raw_text_page'

data/lib/mindee/product/.rubocop.yml

@@ -1,13 +0,0 @@
-inherit_from: ../../../.rubocop.yml
-
-Metrics/AbcSize:
-  Enabled: false
-Metrics/ClassLength:
-  Enabled: false
-Metrics/CyclomaticComplexity:
-  Enabled: false
-Metrics/PerceivedComplexity:
-  Enabled: false
-Metrics/MethodLength:
-  Enabled: false
-

data/lib/mindee/product/barcode_reader/barcode_reader_v1.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'barcode_reader_v1_document'
-require_relative 'barcode_reader_v1_page'
-
-module Mindee
-  module Product
-    # Barcode Reader module.
-    module BarcodeReader
-      # Barcode Reader API version 1 inference prediction.
-      class BarcodeReaderV1 < Mindee::Parsing::Common::Inference
-        @endpoint_name = 'barcode_reader'
-        @endpoint_version = '1'
-        @has_async = false
-        @has_sync = true
-
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = BarcodeReaderV1Document.new(prediction['prediction'], nil)
-          @pages = []
-          prediction['pages'].each do |page|
-            @pages.push(BarcodeReaderV1Page.new(page))
-          end
-        end
-
-        class << self
-          # Name of the endpoint for this product.
-          # @return [String]
-          attr_reader :endpoint_name
-          # Version for this product.
-          # @return [String]
-          attr_reader :endpoint_version
-          # Whether this product has access to an asynchronous endpoint.
-          # @return [bool]
-          attr_reader :has_async
-          # Whether this product has access to synchronous endpoint.
-          # @return [bool]
-          attr_reader :has_sync
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/barcode_reader/barcode_reader_v1_document.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-
-module Mindee
-  module Product
-    module BarcodeReader
-      # Barcode Reader API version 1.0 document data.
-      class BarcodeReaderV1Document < Mindee::Parsing::Common::Prediction
-        include Mindee::Parsing::Standard
-        # List of decoded 1D barcodes.
-        # @return [Array<Mindee::Parsing::Standard::StringField>]
-        attr_reader :codes_1d
-        # List of decoded 2D barcodes.
-        # @return [Array<Mindee::Parsing::Standard::StringField>]
-        attr_reader :codes_2d
-
-        # @param prediction [Hash]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          super
-          @codes_1d = [] # : Array[Parsing::Standard::StringField]
-          prediction['codes_1d'].each do |item|
-            @codes_1d.push(Parsing::Standard::StringField.new(item, page_id))
-          end
-          @codes_2d = [] # : Array[Parsing::Standard::StringField]
-          prediction['codes_2d'].each do |item|
-            @codes_2d.push(Parsing::Standard::StringField.new(item, page_id))
-          end
-        end
-
-        # @return [String]
-        def to_s
-          codes_1d = @codes_1d.join("\n #{' ' * 13}")
-          codes_2d = @codes_2d.join("\n #{' ' * 13}")
-          out_str = String.new
-          out_str << "\n:Barcodes 1D: #{codes_1d}".rstrip
-          out_str << "\n:Barcodes 2D: #{codes_2d}".rstrip
-          out_str[1..].to_s
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/barcode_reader/barcode_reader_v1_page.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'barcode_reader_v1_document'
-
-module Mindee
-  module Product
-    module BarcodeReader
-      # Barcode Reader API version 1.0 page data.
-      class BarcodeReaderV1Page < Mindee::Parsing::Common::Page
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = if prediction['prediction'].empty?
-                          nil
-                        else
-                          BarcodeReaderV1PagePrediction.new(
-                            prediction['prediction'],
-                            prediction['id']
-                          )
-                        end
-        end
-      end
-
-      # Barcode Reader V1 page prediction.
-      class BarcodeReaderV1PagePrediction < BarcodeReaderV1Document
-        # @return [String]
-        def to_s
-          out_str = String.new
-          out_str << "\n#{super}"
-          out_str
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'bill_of_lading_v1_document'
-require_relative 'bill_of_lading_v1_page'
-
-module Mindee
-  module Product
-    # Bill of Lading module.
-    module BillOfLading
-      # Bill of Lading API version 1 inference prediction.
-      class BillOfLadingV1 < Mindee::Parsing::Common::Inference
-        @endpoint_name = 'bill_of_lading'
-        @endpoint_version = '1'
-        @has_async = true
-        @has_sync = false
-
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = BillOfLadingV1Document.new(prediction['prediction'], nil)
-          @pages = []
-          prediction['pages'].each do |page|
-            @pages.push(BillOfLadingV1Page.new(page))
-          end
-        end
-
-        class << self
-          # Name of the endpoint for this product.
-          # @return [String]
-          attr_reader :endpoint_name
-          # Version for this product.
-          # @return [String]
-          attr_reader :endpoint_version
-          # Whether this product has access to an asynchronous endpoint.
-          # @return [bool]
-          attr_reader :has_async
-          # Whether this product has access to synchronous endpoint.
-          # @return [bool]
-          attr_reader :has_sync
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_carrier.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-
-module Mindee
-  module Product
-    module BillOfLading
-      # The shipping company responsible for transporting the goods.
-      class BillOfLadingV1Carrier < Mindee::Parsing::Standard::FeatureField
-        include Mindee::Parsing::Standard
-        # The name of the carrier.
-        # @return [String]
-        attr_reader :name
-        # The professional number of the carrier.
-        # @return [String]
-        attr_reader :professional_number
-        # The Standard Carrier Alpha Code (SCAC) of the carrier.
-        # @return [String]
-        attr_reader :scac
-
-        # @param prediction [Hash]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          super
-          @name = prediction['name']
-          @professional_number = prediction['professional_number']
-          @scac = prediction['scac']
-          @page_id = page_id
-        end
-
-        # @return [Hash]
-        def printable_values
-          printable = {}
-          printable[:name] = format_for_display(@name)
-          printable[:professional_number] = format_for_display(@professional_number)
-          printable[:scac] = format_for_display(@scac)
-          printable
-        end
-
-        # @return [String]
-        def to_s
-          printable = printable_values
-          out_str = String.new
-          out_str << "\n  :Name: #{printable[:name]}"
-          out_str << "\n  :Professional Number: #{printable[:professional_number]}"
-          out_str << "\n  :SCAC: #{printable[:scac]}"
-          out_str
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_carrier_item.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-
-module Mindee
-  module Product
-    module BillOfLading
-      # The goods being shipped.
-      class BillOfLadingV1CarrierItem < Mindee::Parsing::Standard::FeatureField
-        include Mindee::Parsing::Standard
-        # A description of the item.
-        # @return [String]
-        attr_reader :description
-        # The gross weight of the item.
-        # @return [Float]
-        attr_reader :gross_weight
-        # The measurement of the item.
-        # @return [Float]
-        attr_reader :measurement
-        # The unit of measurement for the measurement.
-        # @return [String]
-        attr_reader :measurement_unit
-        # The quantity of the item being shipped.
-        # @return [Float]
-        attr_reader :quantity
-        # The unit of measurement for weights.
-        # @return [String]
-        attr_reader :weight_unit
-
-        # @param prediction [Hash]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          super
-          @description = prediction['description']
-          @gross_weight = prediction['gross_weight']
-          @measurement = prediction['measurement']
-          @measurement_unit = prediction['measurement_unit']
-          @quantity = prediction['quantity']
-          @weight_unit = prediction['weight_unit']
-          @page_id = page_id
-        end
-
-        # @return [Hash]
-        def printable_values
-          printable = {}
-          printable[:description] = format_for_display(@description)
-          printable[:gross_weight] =
-            @gross_weight.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@gross_weight)
-          printable[:measurement] =
-            @measurement.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@measurement)
-          printable[:measurement_unit] = format_for_display(@measurement_unit)
-          printable[:quantity] =
-            @quantity.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@quantity)
-          printable[:weight_unit] = format_for_display(@weight_unit)
-          printable
-        end
-
-        # @return [Hash]
-        def table_printable_values
-          printable = {}
-          printable[:description] = format_for_display(@description, 36)
-          printable[:gross_weight] =
-            @gross_weight.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@gross_weight)
-          printable[:measurement] =
-            @measurement.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@measurement)
-          printable[:measurement_unit] = format_for_display(@measurement_unit, nil)
-          printable[:quantity] =
-            @quantity.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@quantity)
-          printable[:weight_unit] = format_for_display(@weight_unit, nil)
-          printable
-        end
-
-        # @return [String]
-        def to_table_line
-          printable = table_printable_values
-          out_str = String.new
-          out_str << format('| %- 37s', printable[:description])
-          out_str << format('| %- 13s', printable[:gross_weight])
-          out_str << format('| %- 12s', printable[:measurement])
-          out_str << format('| %- 17s', printable[:measurement_unit])
-          out_str << format('| %- 9s', printable[:quantity])
-          out_str << format('| %- 12s', printable[:weight_unit])
-          out_str << '|'
-        end
-
-        # @return [String]
-        def to_s
-          printable = printable_values
-          out_str = String.new
-          out_str << "\n  :Description: #{printable[:description]}"
-          out_str << "\n  :Gross Weight: #{printable[:gross_weight]}"
-          out_str << "\n  :Measurement: #{printable[:measurement]}"
-          out_str << "\n  :Measurement Unit: #{printable[:measurement_unit]}"
-          out_str << "\n  :Quantity: #{printable[:quantity]}"
-          out_str << "\n  :Weight Unit: #{printable[:weight_unit]}"
-          out_str
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_carrier_items.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'bill_of_lading_v1_shipper'
-require_relative 'bill_of_lading_v1_consignee'
-require_relative 'bill_of_lading_v1_notify_party'
-require_relative 'bill_of_lading_v1_carrier'
-require_relative 'bill_of_lading_v1_carrier_item'
-
-module Mindee
-  module Product
-    module BillOfLading
-      # The goods being shipped.
-      class BillOfLadingV1CarrierItems < Array
-        # Entries.
-        # @return [Array<BillOfLadingV1CarrierItem>]
-        attr_reader :entries
-
-        # @param prediction [Array]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          entries = prediction.map do |entry|
-            BillOfLading::BillOfLadingV1CarrierItem.new(entry, page_id)
-          end
-          super(entries)
-        end
-
-        # Creates a line of rST table-compliant string separators.
-        # @param char [String] Character to use as a separator.
-        # @return [String]
-        def self.line_items_separator(char)
-          out_str = String.new
-          out_str << "+#{char * 38}"
-          out_str << "+#{char * 14}"
-          out_str << "+#{char * 13}"
-          out_str << "+#{char * 18}"
-          out_str << "+#{char * 10}"
-          out_str << "+#{char * 13}"
-          out_str
-        end
-
-        # @return [String]
-        def to_s
-          return '' if empty?
-
-          lines = map do |entry|
-            "\n  #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
-          end.join
-          out_str = String.new
-          out_str << "\n#{self.class.line_items_separator('-')}\n "
-          out_str << ' | Description                         '
-          out_str << ' | Gross Weight'
-          out_str << ' | Measurement'
-          out_str << ' | Measurement Unit'
-          out_str << ' | Quantity'
-          out_str << ' | Weight Unit'
-          out_str << " |\n#{self.class.line_items_separator('=')}"
-          out_str + lines
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_consignee.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-
-module Mindee
-  module Product
-    module BillOfLading
-      # The party to whom the goods are being shipped.
-      class BillOfLadingV1Consignee < Mindee::Parsing::Standard::FeatureField
-        include Mindee::Parsing::Standard
-        # The address of the consignee.
-        # @return [String]
-        attr_reader :address
-        # The  email of the shipper.
-        # @return [String]
-        attr_reader :email
-        # The name of the consignee.
-        # @return [String]
-        attr_reader :name
-        # The phone number of the consignee.
-        # @return [String]
-        attr_reader :phone
-
-        # @param prediction [Hash]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          super
-          @address = prediction['address']
-          @email = prediction['email']
-          @name = prediction['name']
-          @phone = prediction['phone']
-          @page_id = page_id
-        end
-
-        # @return [Hash]
-        def printable_values
-          printable = {}
-          printable[:address] = format_for_display(@address)
-          printable[:email] = format_for_display(@email)
-          printable[:name] = format_for_display(@name)
-          printable[:phone] = format_for_display(@phone)
-          printable
-        end
-
-        # @return [String]
-        def to_s
-          printable = printable_values
-          out_str = String.new
-          out_str << "\n  :Address: #{printable[:address]}"
-          out_str << "\n  :Email: #{printable[:email]}"
-          out_str << "\n  :Name: #{printable[:name]}"
-          out_str << "\n  :Phone: #{printable[:phone]}"
-          out_str
-        end
-      end
-    end
-  end
-end