abbyy-cloud 0.0.5 → 0.0.6

data/lib/abbyy/cloud/models/file_reference.rb

@@ -0,0 +1,11 @@
+class ABBYY::Cloud
+  module Models
+    class FileReference < Struct
+      attribute :id,    Types::Strict::String
+      attribute :token, Types::Strict::String
+    end
+
+    # Registers type Types::FileReference
+    Types.register_type FileReference
+  end
+end

data/lib/abbyy/cloud/models/full_order.rb

@@ -0,0 +1,46 @@
+require_relative "currency"
+require_relative "order_statistics"
+require_relative "label"
+require_relative "locale"
+require_relative "payment_type"
+require_relative "status"
+require_relative "translation_link"
+require_relative "translation_type"
+require_relative "unit_type"
+
+class ABBYY::Cloud
+  module Models
+    class FullOrder < Struct
+      attribute :amount, Types::Coercible::Float
+      attribute :approval_required, Types::Form::Bool
+      attribute :created, Types::Form::Time
+      attribute :currency, Types::Currency
+      attribute :deadline, Types::Form::Time.optional
+      attribute :deleted, Types::Form::Time.optional
+      attribute :delivered, Types::Form::Time.optional
+      attribute :email, Types::Strict::String
+      attribute :from, Types::Locale
+      attribute :id, Types::Strict::String
+      attribute :is_deleted, Types::Form::Bool
+      attribute :is_layout_required, Types::Form::Bool
+      attribute :is_manual_estimation, Types::Form::Bool
+      attribute :label, Types::Label.optional
+      attribute :number, Types::Coercible::Int
+      attribute :payment_provider, Types::Strict::String
+      attribute :payment_type, Types::PaymentType
+      attribute :progress, Types::Coercible::Int
+      attribute :started, Types::Form::Time.optional
+      attribute :statistics, Types::OrderStatistics
+      attribute :status, Types::Status
+      attribute :to, Types::FilledArray.member(Types::Locale)
+      attribute :translations, Types::Array.member(Types::TranslationLink)
+      attribute :type, Types::TranslationType
+      attribute :unit_count, Types::Coercible::Int
+      attribute :unit_type, Types::UnitType
+      attribute :units_count, Types::Hash
+    end
+
+    # Registers type Types::FullOrder
+    Types.register_type FullOrder
+  end
+end

data/lib/abbyy/cloud/models/label.rb

@@ -0,0 +1,14 @@
+class ABBYY::Cloud
+  module Models
+    class Label < ::String
+      FORMAT = /\A.{1,80}\z/
+
+      def self.new(string)
+        super Types::Strict::String.constrained(format: FORMAT)[string]
+      end
+    end
+
+    # Registers type Types::Label
+    Types.register_type Label
+  end
+end

data/lib/abbyy/cloud/models/ocr_mode.rb

@@ -0,0 +1,19 @@
+class ABBYY::Cloud
+  module Models
+    class OcrMode < ::String
+      VALUES = %w(
+        EditableCopy
+        ExactCopy
+        FormattedText
+        PlainText
+      ).freeze
+
+      def self.new(string)
+        super Types::Strict::String.constrained(included_in: VALUES)[string]
+      end
+    end
+
+    # Registers type Types::OcrMode
+    Types.register_type OcrMode
+  end
+end

data/lib/abbyy/cloud/models/ocr_quality.rb

@@ -0,0 +1,18 @@
+class ABBYY::Cloud
+  module Models
+    class OcrQuality < ::String
+      VALUES = %w(
+        Fast
+        Balanced
+        Thorough
+      ).freeze
+
+      def self.new(string)
+        super Types::Strict::String.constrained(included_in: VALUES)[string]
+      end
+    end
+
+    # Registers type Types::OcrQuality
+    Types.register_type OcrQuality
+  end
+end

data/lib/abbyy/cloud/models/ocr_settings.rb

@@ -0,0 +1,16 @@
+require_relative "file_format"
+require_relative "ocr_mode"
+require_relative "ocr_quality"
+
+class ABBYY::Cloud
+  module Models
+    class OcrSettings < Struct
+      attribute :format,  Types::FileFormat
+      attribute :mode,    Types::OcrMode
+      attribute :quality, Types::OcrQuality
+    end
+
+    # Registers type Types::OcrSettings
+    Types.register_type OcrSettings
+  end
+end

data/lib/abbyy/cloud/models/ocr_statistics.rb

@@ -0,0 +1,13 @@
+class ABBYY::Cloud
+  module Models
+    class OcrStatistics < Struct
+      attribute :exported_pages,       Types::Coercible::Int
+      attribute :total_characters,     Types::Coercible::Int
+      attribute :uncertain_characters, Types::Coercible::Int
+      attribute :success_part,         Types::Coercible::Float
+    end
+
+    # Registers type Types::OcrStatistics
+    Types.register_type OcrStatistics
+  end
+end

data/lib/abbyy/cloud/models/ocr_warning.rb

@@ -0,0 +1,16 @@
+require_relative "ocr_warning_type"
+
+class ABBYY::Cloud
+  module Models
+    class OcrWarning < Struct
+      attribute :warning_type,         Types::OcrWarningType
+      attribute :page_number,          Types::Coercible::Int
+      attribute :dpi,                  Types::Coercible::Int.optional
+      attribute :language_count,       Types::Coercible::Int.optional
+      attribute :full_warning_message, Types::Strict::String.optional
+    end
+
+    # Registers type Types::OcrWarning
+    Types.register_type OcrWarning
+  end
+end

data/lib/abbyy/cloud/models/ocr_warning_type.rb

@@ -0,0 +1,29 @@
+class ABBYY::Cloud
+  module Models
+    class OcrWarningType < ::String
+      VALUES = %w(
+        BrightnessIsTooHigh
+        BrightnessIsTooLow
+        ErrorWhenUsingDocumentAuxData
+        NoRecognizableBlocksFound
+        ProbablyLanguageIsIncorrect
+        ResolutionIsLowForTinyTextPhoto
+        ResolutionIsLowForTinyTextScanned
+        ResolutionIsTooHigh
+        ResolutionIsTooLow
+        SuspiciousResolution
+        TooManyBaseLanguages
+        TooManyBaseLanguagesForDetection
+        TooManyLanguagesDetected
+        UnknownWarning
+      ).freeze
+
+      def self.new(string)
+        super Types::Strict::String.constrained(included_in: VALUES)[string]
+      end
+    end
+
+    # Registers type Types::OcrWarningType
+    Types.register_type OcrWarningType
+  end
+end

data/lib/abbyy/cloud/models/order_statistics.rb

@@ -0,0 +1,15 @@
+require_relative "source_tag"
+
+class ABBYY::Cloud
+  module Models
+    class OrderStatistics < Struct
+      attribute :documents_count, Types::Coercible::Int
+      attribute :pages_count,     Types::Coercible::Int
+      attribute :words_count,     Types::Coercible::Int
+      attribute :chars_count,     Types::Coercible::Int
+    end
+
+    # Registers type Types::OrderStatistics
+    Types.register_type OrderStatistics
+  end
+end

data/lib/abbyy/cloud/models/payment_type.rb

@@ -0,0 +1,14 @@
+class ABBYY::Cloud
+  module Models
+    class PaymentType < ::String
+      VALUES = %w(Manual Balance External).freeze
+
+      def self.new(string)
+        super Types::Strict::String.constrained(included_in: VALUES)[string]
+      end
+    end
+
+    # Registers type Types::PaymentType
+    Types.register_type PaymentType
+  end
+end

data/lib/abbyy/cloud/models/price.rb

@@ -7,7 +7,7 @@ class ABBYY::Cloud
     # Price details
     class Price < Struct
       attribute :id,          Types::Strict::String
-      attribute :account_id,  Types::Strict::String
+      attribute :account_id,  Types::Strict::String.optional
       attribute :type,        Types::Strict::String
       attribute :from,        Types::Locale
       attribute :to,          Types::Locale

data/lib/abbyy/cloud/models/reading_status.rb

@@ -0,0 +1,20 @@
+class ABBYY::Cloud
+  module Models
+    class ReadingStatus < ::String
+      VALUES = %w(
+        New
+        Submitted
+        InProgress
+        Done
+        Error
+      ).freeze
+
+      def self.new(string)
+        super Types::Strict::String.constrained(included_in: VALUES)[string]
+      end
+    end
+
+    # Registers type Types::ReadingStatus
+    Types.register_type ReadingStatus
+  end
+end

data/lib/abbyy/cloud/models/source_segment.rb

@@ -2,7 +2,6 @@ require_relative "source_tag"
 
 class ABBYY::Cloud
   module Models
-    # A segment for the translation
     class SourceSegment < Struct
       attribute :text, Types::Strict::String
       attribute :tags, Types::Array.member(Types::SourceTag).default([])

data/lib/abbyy/cloud/models/source_tag.rb

@@ -2,7 +2,6 @@ class ABBYY::Cloud
   module Models
     TYPES = %w(Start End Placeholder).freeze
 
-    # Tag for translation source/target
     class SourceTag < Struct
       attribute :number, Types::Strict::Int
       attribute :position, Types::Strict::Int

data/lib/abbyy/cloud/models/status.rb

@@ -0,0 +1,25 @@
+class ABBYY::Cloud
+  module Models
+    class Status < ::String
+      VALUES = %w(
+        New
+        Submitted
+        PaymentRequired
+        Paid
+        InProgress
+        Done
+        Failed
+        Accepted
+        ReworkRequired
+        Canceled
+      ).freeze
+
+      def self.new(string)
+        super Types::Strict::String.constrained(included_in: VALUES)[string]
+      end
+    end
+
+    # Registers type Types::Status
+    Types.register_type Status
+  end
+end

data/lib/abbyy/cloud/models/text_statistics.rb

@@ -0,0 +1,15 @@
+require_relative "source_tag"
+
+class ABBYY::Cloud
+  module Models
+    class TextStatistics < Struct
+      attribute :language,    Types::Locale
+      attribute :pages_count, Types::Coercible::Int
+      attribute :words_count, Types::Coercible::Int
+      attribute :chars_count, Types::Coercible::Int
+    end
+
+    # Registers type Types::TextStatistics
+    Types.register_type TextStatistics
+  end
+end

data/lib/abbyy/cloud/models/transfer_data.rb

@@ -1,8 +1,5 @@
 class ABBYY::Cloud
   module Models
-    TYPES = %w(Start End Placeholder).freeze
-
-    # Tag for translation source/target
     class TransferData < Struct
       attribute :position, Types::Strict::Int
       attribute :order,    Types::Strict::Int

data/lib/abbyy/cloud/models/translation.rb

@@ -1,7 +1,5 @@
 class ABBYY::Cloud
-  # Collection of models returned in requests
   module Models
-    # Result of the order translation
     class Translation < Struct
       attribute :id,          Types::Strict::String
       attribute :translation, Types::Strict::String

data/lib/abbyy/cloud/models/translation_link.rb

@@ -0,0 +1,18 @@
+require_relative "status"
+require_relative "file_link"
+
+class ABBYY::Cloud
+  module Models
+    class TranslationLink < Struct
+      attribute :delivered, Types::Form::Time
+      attribute :started, Types::Form::Time
+      attribute :progress, Types::Coercible::Int
+      attribute :status, Types::Status
+      attribute :source_file, Types::FileLink
+      attribute :target_file, Types::FileLink
+    end
+
+    # Registers type Types::TranslationLink
+    Types.register_type TranslationLink
+  end
+end

data/lib/abbyy/cloud/models/translation_segment.rb

@@ -2,7 +2,6 @@ require_relative "transfer_data"
 
 class ABBYY::Cloud
   module Models
-    # A segment of the translation
     class TranslationSegment < Struct
       attribute :id,   Types::Strict::String
       attribute :text, Types::Strict::String

data/lib/abbyy/cloud/models/translation_type.rb

@@ -0,0 +1,14 @@
+class ABBYY::Cloud
+  module Models
+    class TranslationType < ::String
+      VALUES = %w(mt ht_express ht_professional ht_expert).freeze
+
+      def self.new(string)
+        super Types::Strict::String.constrained(included_in: VALUES)[string]
+      end
+    end
+
+    # Registers type Types::TranslationType
+    Types.register_type TranslationType
+  end
+end

data/lib/abbyy/cloud/models/unit_price.rb

@@ -1,3 +1,6 @@
+require_relative "currency"
+require_relative "unit_type"
+
 class ABBYY::Cloud
   module Models
     # Price details

data/lib/abbyy/cloud/models/unit_type.rb

@@ -0,0 +1,14 @@
+class ABBYY::Cloud
+  module Models
+    class UnitType < ::String
+      VALUES = %w(Chars Words Pages Documents).freeze
+
+      def self.new(string)
+        super Types::Strict::String.constrained(included_in: VALUES)[string]
+      end
+    end
+
+    # Registers type Types::UnitType
+    Types.register_type UnitType
+  end
+end

data/lib/abbyy/cloud/namespaces/files.rb

@@ -0,0 +1,19 @@
+require_relative "base"
+
+class ABBYY::Cloud
+  module Namespaces
+    # Namespace for operations with orders
+    # @see [https://api.abbyy.cloud/swagger/ui/index#!/File] ABBYY Cloud API
+    class Files < Base
+      def upload(file, export_format: nil, synthesis_mode: nil, **options)
+        options[:exportFormat]  = export_format  if export_format
+        options[:synthesisMode] = synthesis_mode if synthesis_mode
+        Operations::UploadFile.new(settings).call(file, **options)
+      end
+
+      def download(id:, token:)
+        Operations::DownloadFile.new(settings).call(id: id, token: token)
+      end
+    end
+  end
+end

data/lib/abbyy/cloud/namespaces/orders.rb

@@ -0,0 +1,17 @@
+require_relative "base"
+
+class ABBYY::Cloud
+  module Namespaces
+    # Namespace for operations with orders
+    # @see [https://api.abbyy.cloud/swagger/ui/index#!/Orders] ABBYY Cloud API
+    class Orders < Base
+      def create(options)
+        Operations::SubmitOrder.new(settings).call(options)
+      end
+
+      def find(id)
+        Operations::FindOrder.new(settings).call(id: id)
+      end
+    end
+  end
+end