mindee 4.12.0 → 5.0.0.beta1

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

@@ -1,163 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-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_items'
-
-module Mindee
-  module Product
-    module BillOfLading
-      # Bill of Lading API version 1.1 document data.
-      class BillOfLadingV1Document < Mindee::Parsing::Common::Prediction
-        include Mindee::Parsing::Standard
-        # A unique identifier assigned to a Bill of Lading document.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :bill_of_lading_number
-        # The shipping company responsible for transporting the goods.
-        # @return [Mindee::Product::BillOfLading::BillOfLadingV1Carrier]
-        attr_reader :carrier
-        # The goods being shipped.
-        # @return [Mindee::Product::BillOfLading::BillOfLadingV1CarrierItems]
-        attr_reader :carrier_items
-        # The party to whom the goods are being shipped.
-        # @return [Mindee::Product::BillOfLading::BillOfLadingV1Consignee]
-        attr_reader :consignee
-        # The date when the bill of lading is issued.
-        # @return [Mindee::Parsing::Standard::DateField]
-        attr_reader :date_of_issue
-        # The date when the vessel departs from the port of loading.
-        # @return [Mindee::Parsing::Standard::DateField]
-        attr_reader :departure_date
-        # The party to be notified of the arrival of the goods.
-        # @return [Mindee::Product::BillOfLading::BillOfLadingV1NotifyParty]
-        attr_reader :notify_party
-        # The place where the goods are to be delivered.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :place_of_delivery
-        # The port where the goods are unloaded from the vessel.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :port_of_discharge
-        # The port where the goods are loaded onto the vessel.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :port_of_loading
-        # The party responsible for shipping the goods.
-        # @return [Mindee::Product::BillOfLading::BillOfLadingV1Shipper]
-        attr_reader :shipper
-
-        # @param prediction [Hash]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          super
-          @bill_of_lading_number = Parsing::Standard::StringField.new(
-            prediction['bill_of_lading_number'],
-            page_id
-          )
-          @carrier = Product::BillOfLading::BillOfLadingV1Carrier.new(
-            prediction['carrier'],
-            page_id
-          )
-          @carrier_items = Product::BillOfLading::BillOfLadingV1CarrierItems.new(prediction['carrier_items'], page_id)
-          @consignee = Product::BillOfLading::BillOfLadingV1Consignee.new(
-            prediction['consignee'],
-            page_id
-          )
-          @date_of_issue = Parsing::Standard::DateField.new(
-            prediction['date_of_issue'],
-            page_id
-          )
-          @departure_date = Parsing::Standard::DateField.new(
-            prediction['departure_date'],
-            page_id
-          )
-          @notify_party = Product::BillOfLading::BillOfLadingV1NotifyParty.new(
-            prediction['notify_party'],
-            page_id
-          )
-          @place_of_delivery = Parsing::Standard::StringField.new(
-            prediction['place_of_delivery'],
-            page_id
-          )
-          @port_of_discharge = Parsing::Standard::StringField.new(
-            prediction['port_of_discharge'],
-            page_id
-          )
-          @port_of_loading = Parsing::Standard::StringField.new(
-            prediction['port_of_loading'],
-            page_id
-          )
-          @shipper = Product::BillOfLading::BillOfLadingV1Shipper.new(
-            prediction['shipper'],
-            page_id
-          )
-        end
-
-        # @return [String]
-        def to_s
-          shipper = @shipper.to_s
-          consignee = @consignee.to_s
-          notify_party = @notify_party.to_s
-          carrier = @carrier.to_s
-          carrier_items = carrier_items_to_s
-          out_str = String.new
-          out_str << "\n:Bill of Lading Number: #{@bill_of_lading_number}".rstrip
-          out_str << "\n:Shipper:"
-          out_str << shipper
-          out_str << "\n:Consignee:"
-          out_str << consignee
-          out_str << "\n:Notify Party:"
-          out_str << notify_party
-          out_str << "\n:Carrier:"
-          out_str << carrier
-          out_str << "\n:Items:"
-          out_str << carrier_items
-          out_str << "\n:Port of Loading: #{@port_of_loading}".rstrip
-          out_str << "\n:Port of Discharge: #{@port_of_discharge}".rstrip
-          out_str << "\n:Place of Delivery: #{@place_of_delivery}".rstrip
-          out_str << "\n:Date of issue: #{@date_of_issue}".rstrip
-          out_str << "\n:Departure Date: #{@departure_date}".rstrip
-          out_str[1..].to_s
-        end
-
-        private
-
-        # @param char [String]
-        # @return [String]
-        def carrier_items_separator(char)
-          out_str = String.new
-          out_str << '  '
-          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 << '+'
-          out_str
-        end
-
-        # @return [String]
-        def carrier_items_to_s
-          return '' if @carrier_items.empty?
-
-          line_items = @carrier_items.map(&:to_table_line).join("\n#{carrier_items_separator('-')}\n  ")
-          out_str = String.new
-          out_str << "\n#{carrier_items_separator('-')}"
-          out_str << "\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#{carrier_items_separator('=')}"
-          out_str << "\n  #{line_items}"
-          out_str << "\n#{carrier_items_separator('-')}"
-          out_str
-        end
-      end
-    end
-  end
-end

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

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-
-module Mindee
-  module Product
-    module BillOfLading
-      # The party to be notified of the arrival of the goods.
-      class BillOfLadingV1NotifyParty < Mindee::Parsing::Standard::FeatureField
-        include Mindee::Parsing::Standard
-        # The address of the notify party.
-        # @return [String]
-        attr_reader :address
-        # The  email of the shipper.
-        # @return [String]
-        attr_reader :email
-        # The name of the notify party.
-        # @return [String]
-        attr_reader :name
-        # The phone number of the notify party.
-        # @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

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

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'bill_of_lading_v1_document'
-
-module Mindee
-  module Product
-    module BillOfLading
-      # Bill of Lading API version 1.1 page data.
-      class BillOfLadingV1Page < Mindee::Parsing::Common::Page
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = if prediction['prediction'].empty?
-                          nil
-                        else
-                          BillOfLadingV1PagePrediction.new(
-                            prediction['prediction'],
-                            prediction['id']
-                          )
-                        end
-        end
-      end
-
-      # Bill of Lading V1 page prediction.
-      class BillOfLadingV1PagePrediction < BillOfLadingV1Document
-        # @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_shipper.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-
-module Mindee
-  module Product
-    module BillOfLading
-      # The party responsible for shipping the goods.
-      class BillOfLadingV1Shipper < Mindee::Parsing::Standard::FeatureField
-        include Mindee::Parsing::Standard
-        # The address of the shipper.
-        # @return [String]
-        attr_reader :address
-        # The  email of the shipper.
-        # @return [String]
-        attr_reader :email
-        # The name of the shipper.
-        # @return [String]
-        attr_reader :name
-        # The phone number of the shipper.
-        # @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

data/lib/mindee/product/business_card/business_card_v1.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'business_card_v1_document'
-require_relative 'business_card_v1_page'
-
-module Mindee
-  module Product
-    # Business Card module.
-    module BusinessCard
-      # Business Card API version 1 inference prediction.
-      class BusinessCardV1 < Mindee::Parsing::Common::Inference
-        @endpoint_name = 'business_card'
-        @endpoint_version = '1'
-        @has_async = true
-        @has_sync = false
-
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = BusinessCardV1Document.new(prediction['prediction'], nil)
-          @pages = []
-          prediction['pages'].each do |page|
-            @pages.push(BusinessCardV1Page.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/business_card/business_card_v1_document.rb

@@ -1,112 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-
-module Mindee
-  module Product
-    module BusinessCard
-      # Business Card API version 1.0 document data.
-      class BusinessCardV1Document < Mindee::Parsing::Common::Prediction
-        include Mindee::Parsing::Standard
-        # The address of the person.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :address
-        # The company the person works for.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :company
-        # The email address of the person.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :email
-        # The Fax number of the person.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :fax_number
-        # The given name of the person.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :firstname
-        # The job title of the person.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :job_title
-        # The lastname of the person.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :lastname
-        # The mobile number of the person.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :mobile_number
-        # The phone number of the person.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :phone_number
-        # The social media profiles of the person or company.
-        # @return [Array<Mindee::Parsing::Standard::StringField>]
-        attr_reader :social_media
-        # The website of the person or company.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :website
-
-        # @param prediction [Hash]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          super
-          @address = Parsing::Standard::StringField.new(
-            prediction['address'],
-            page_id
-          )
-          @company = Parsing::Standard::StringField.new(
-            prediction['company'],
-            page_id
-          )
-          @email = Parsing::Standard::StringField.new(prediction['email'], page_id)
-          @fax_number = Parsing::Standard::StringField.new(
-            prediction['fax_number'],
-            page_id
-          )
-          @firstname = Parsing::Standard::StringField.new(
-            prediction['firstname'],
-            page_id
-          )
-          @job_title = Parsing::Standard::StringField.new(
-            prediction['job_title'],
-            page_id
-          )
-          @lastname = Parsing::Standard::StringField.new(
-            prediction['lastname'],
-            page_id
-          )
-          @mobile_number = Parsing::Standard::StringField.new(
-            prediction['mobile_number'],
-            page_id
-          )
-          @phone_number = Parsing::Standard::StringField.new(
-            prediction['phone_number'],
-            page_id
-          )
-          @social_media = [] # : Array[Parsing::Standard::StringField]
-          prediction['social_media'].each do |item|
-            @social_media.push(Parsing::Standard::StringField.new(item, page_id))
-          end
-          @website = Parsing::Standard::StringField.new(
-            prediction['website'],
-            page_id
-          )
-        end
-
-        # @return [String]
-        def to_s
-          social_media = @social_media.join("\n #{' ' * 14}")
-          out_str = String.new
-          out_str << "\n:Firstname: #{@firstname}".rstrip
-          out_str << "\n:Lastname: #{@lastname}".rstrip
-          out_str << "\n:Job Title: #{@job_title}".rstrip
-          out_str << "\n:Company: #{@company}".rstrip
-          out_str << "\n:Email: #{@email}".rstrip
-          out_str << "\n:Phone Number: #{@phone_number}".rstrip
-          out_str << "\n:Mobile Number: #{@mobile_number}".rstrip
-          out_str << "\n:Fax Number: #{@fax_number}".rstrip
-          out_str << "\n:Address: #{@address}".rstrip
-          out_str << "\n:Website: #{@website}".rstrip
-          out_str << "\n:Social Media: #{social_media}".rstrip
-          out_str[1..].to_s
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/business_card/business_card_v1_page.rb

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

data/lib/mindee/product/cropper/cropper_v1.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'cropper_v1_document'
-require_relative 'cropper_v1_page'
-
-module Mindee
-  module Product
-    # Cropper module.
-    module Cropper
-      # Cropper API version 1 inference prediction.
-      class CropperV1 < Mindee::Parsing::Common::Inference
-        @endpoint_name = 'cropper'
-        @endpoint_version = '1'
-        @has_async = false
-        @has_sync = true
-
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = CropperV1Document.new(prediction['prediction'], nil)
-          @pages = []
-          prediction['pages'].each do |page|
-            @pages.push(CropperV1Page.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/cropper/cropper_v1_document.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-
-module Mindee
-  module Product
-    module Cropper
-      # Cropper API version 1.1 document data.
-      class CropperV1Document < Mindee::Parsing::Common::Prediction
-      end
-    end
-  end
-end

data/lib/mindee/product/cropper/cropper_v1_page.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'cropper_v1_document'
-
-module Mindee
-  module Product
-    module Cropper
-      # Cropper API version 1.1 page data.
-      class CropperV1Page < Mindee::Parsing::Common::Page
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = if prediction['prediction'].empty?
-                          nil
-                        else
-                          CropperV1PagePrediction.new(
-                            prediction['prediction'],
-                            prediction['id']
-                          )
-                        end
-        end
-      end
-
-      # Cropper V1 page prediction.
-      class CropperV1PagePrediction < CropperV1Document
-        include Mindee::Parsing::Standard
-
-        # List of documents found in the image.
-        # @return [Array<Mindee::Parsing::Standard::PositionField>]
-        attr_reader :cropping
-
-        # @param prediction [Hash]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          @cropping = []
-          prediction['cropping'].each do |item|
-            @cropping.push(Parsing::Standard::PositionField.new(item, page_id))
-          end
-          super
-        end
-
-        # @return [String]
-        def to_s
-          cropping = @cropping.join("\n #{' ' * 18}")
-          out_str = String.new
-          out_str << "\n:Document Cropper: #{cropping}".rstrip
-          out_str
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/delivery_note/delivery_note_v1.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'delivery_note_v1_document'
-require_relative 'delivery_note_v1_page'
-
-module Mindee
-  module Product
-    # Delivery note module.
-    module DeliveryNote
-      # Delivery note API version 1 inference prediction.
-      class DeliveryNoteV1 < Mindee::Parsing::Common::Inference
-        @endpoint_name = 'delivery_notes'
-        @endpoint_version = '1'
-        @has_async = true
-        @has_sync = false
-
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = DeliveryNoteV1Document.new(prediction['prediction'], nil)
-          @pages = []
-          prediction['pages'].each do |page|
-            @pages.push(DeliveryNoteV1Page.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