abbyy-cloud 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a52f7f789832f6f81c8b3e5dc41fcef0abdd29c
-  data.tar.gz: 83bec335d92f5c4fe7768decbd276d4b742c6d07
+  metadata.gz: e315b9643988d2d779dbbe0e22deca6552111e47
+  data.tar.gz: 1255379a0e408cdba1c524395d8c2a3a653bf7f9
 SHA512:
-  metadata.gz: 70b33579612619b85d5bd822f491539cde7e0e19f83b68c2d34eb96fe6bee344f46c688bce6b950404b32736fa9cd3d4780ed2526968e2552595e2867ff5b15f
-  data.tar.gz: bbfca1cbaf178990630606f6d9646b977761b12e2dedeeb9ec42e877f946cbada95d42829660183ae97ef9a5fa44facd0012436197e3ae3a8eab4a8d206fe45a
+  metadata.gz: 71b4414e1f7f9aba1058e7bac40dc5fa38c0f14079c593ba5426b89f1b015b492a626472debad76e2282c4cf3f1ad543ab7b9f5005f7446034b8a0e831ce0153
+  data.tar.gz: 8fe5ec65636e196b1a9e2e1da3cd539a279b89891929414256bdc91c79d0620dee8906a0329c0756af60186b724b315fe16afb1fa82ecb87ca3a4e04a62b2877

data/.rubocop.yml

@@ -1,4 +1,4 @@
-require: rubocop-rspec
+require: rubocop
 
 AllCops:
   Include:
@@ -12,12 +12,6 @@ AllCops:
     - vendor/**/*
   TargetRubyVersion: 2.3
 
-RSpec/NamedSubject:
-  Enabled: false
-
-RSpec/DescribeClass:
-  Enabled: false
-
 Documentation:
   Enabled: false
 
@@ -41,21 +35,21 @@ Style/AccessorMethodName:
 Style/Alias:
   Enabled: false # `alias_method` and `alias` have diferent behaviour
 
-Style/FileName:
+Style/ClassAndModuleChildren:
   Enabled: false
 
-Style/Lambda:
+Style/FileName:
   Enabled: false
 
-Style/ClassAndModuleChildren:
+Style/FrozenStringLiteralComment:
+  Enabled: false # not to be used before migration to Ruby 3+
+
+Style/Lambda:
   Enabled: false
 
 Style/NumericLiterals:
   Enabled: false
 
-Style/FrozenStringLiteralComment:
-  Enabled: false # not to be used before migration to Ruby 3+
-
 Style/RaiseArgs:
   Enabled: false
 

data/.travis.yml

@@ -8,7 +8,7 @@ script:
 rvm:
   - '2.3.0'
   - ruby-head
-  - jruby-9
+  - jruby-9.1.0.0 # The first MRI-2.3 compatible version
   - jruby-head
 before_install: gem install bundler -v 1.12.5
 matrix:

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# Master (to be released)
+
+### Added
+
+* Operation `files.upload` (nepalez)
+* Operation `files.download` (nepalez)
+* Operation `orders.create(options)` (nepalez)
+* Operation `orders.find(id)` (nepalez)
+
+[Compare v0.0.5...HEAD](https://github.com/nepalez/abbyy-cloud/compare/v0.0.5...HEAD)
+
 # [v0.0.5 2016-08-23](https://github.com/nepalez/abbyy-cloud/tree/v0.0.5)
 
 ### Fixed

data/README.md

@@ -108,6 +108,35 @@ result.class       # => ABBYY::Cloud::Models::TranslationSequence
 result.map(&:text) # => ["Быть", "или не быть"]
 ```
 
+### Files
+
+The namespace `files` contains operations with <uploaded> files.
+
+#### upload
+
+Uploads a file
+
+See [the specification](https://api.abbyy.cloud/swagger/ui/index#!/File/File_UploadFile)
+
+```ruby
+file   = File.read("file_to_upload.xml")
+result = CLIENT.files.upload file
+result.id    # => "18323"
+result.token # => "foobarbaz"
+#  ...
+```
+
+#### download
+
+Dowloads a file by id and token
+
+See [the specification](https://api.abbyy.cloud/swagger/ui/index#!/File/File_DownloadFile)
+
+```ruby
+result = CLIENT.files.download(id: "foo", token: "bar")
+# => #<StringIO ...>
+```
+
 ### Prices
 
 The namespace `prices` contains operations with prices details.

data/abbyy-cloud.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "abbyy-cloud"
-  gem.version  = "0.0.5"
+  gem.version  = "0.0.6"
   gem.authors  = ["Andrew Kozin"]
   gem.email    = ["andrew.kozin@gmail.com"]
   gem.summary  = "HTTP client to ABBYY Cloud API"
@@ -16,11 +16,13 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency "dry-initializer", "~> 0.4.0"
   gem.add_runtime_dependency "dry-struct", "~> 0.0.1"
+  gem.add_runtime_dependency "hashie", "~> 3.4"
+  gem.add_runtime_dependency "multipart_body", "~> 0.2"
 
   gem.add_development_dependency "bundler", "~> 1.12"
   gem.add_development_dependency "rake", "~> 10.0"
   gem.add_development_dependency "rspec", "~> 3.0"
   gem.add_development_dependency "rspec-its", "~> 1.2"
-  gem.add_development_dependency "rubocop-rspec", "~> 1.6"
+  gem.add_development_dependency "rubocop", "~> 0.42"
   gem.add_development_dependency "webmock", "~> 2.0"
 end

data/lib/abbyy/cloud.rb

@@ -1,8 +1,10 @@
 require "dry-initializer"
 require "dry-struct"
+require "hashie/mash"
 require "json"
 require "net/http"
 require "net/https"
+require "multipart_body"
 
 module ABBYY
   class Cloud
@@ -11,32 +13,10 @@ module ABBYY
     require_relative "cloud/connection"
     require_relative "cloud/settings"
 
-    require_relative "cloud/exceptions/argument_error"
-    require_relative "cloud/exceptions/response_error"
-    require_relative "cloud/exceptions/type_error"
-
-    require_relative "cloud/models/direction"
-    require_relative "cloud/models/discount"
-    require_relative "cloud/models/engine"
-    require_relative "cloud/models/error"
-    require_relative "cloud/models/locale"
-    require_relative "cloud/models/price"
-    require_relative "cloud/models/source_segment"
-    require_relative "cloud/models/source_tag"
-    require_relative "cloud/models/transfer_data"
-    require_relative "cloud/models/translation"
-    require_relative "cloud/models/translation_segment"
-    require_relative "cloud/models/unit_price"
-
-    require_relative "cloud/operations/base"
-    require_relative "cloud/operations/engines"
-    require_relative "cloud/operations/prices"
-    require_relative "cloud/operations/translate"
-    require_relative "cloud/operations/translate_segments"
-
-    require_relative "cloud/namespaces/base"
-    require_relative "cloud/namespaces/machine_translations"
-    require_relative "cloud/namespaces/prices"
+    %w(exceptions models operations namespaces).each do |dir|
+      path = File.expand_path("lib/abbyy/cloud/#{dir}/**")
+      Dir[path].each { |file| require file }
+    end
 
     attr_reader :settings
 
@@ -44,10 +24,18 @@ module ABBYY
       Namespaces::MachineTranslations.new(settings)
     end
 
+    def orders
+      Namespaces::Orders.new(settings)
+    end
+
     def prices
       Namespaces::Prices.new(settings)
     end
 
+    def files
+      Namespaces::Files.new(settings)
+    end
+
     private
 
     def initialize(*args)

data/lib/abbyy/cloud/connection.rb

@@ -13,11 +13,11 @@ class ABBYY::Cloud
 
     attr_reader :root
 
-    def call(http_method, path, **options)
+    def call(http_method, path, body: nil, **options)
       uri = prepare_uri(path, options)
       req = Net::HTTP.const_get(http_method.capitalize).new(uri)
+      req.body = body
       setup_headers(req, options)
-      setup_body(req, options)
 
       res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
         http.request(req)
@@ -42,19 +42,12 @@ class ABBYY::Cloud
     def setup_headers(req, headers: nil, **)
       req.basic_auth id, token
       req["accept-charset"] = "utf-8"
-      req["accept"]         = "application/json"
-      req["content-type"]   = "application/json"
       headers.to_h.each { |key, value| req[key.to_s] = value }
     end
 
-    def setup_body(req, body: nil, **)
-      return unless req["content-type"] == "application/json"
-      req.body = JSON(body.to_h)
-    end
-
     def handle_response(response)
       raise ResponseError.new(response) unless response.is_a? Net::HTTPSuccess
-      JSON.parse(response.body)
+      response.body
     end
   end
 end

data/lib/abbyy/cloud/exceptions/response_error.rb

@@ -9,7 +9,7 @@ class ABBYY::Cloud
       @status = response.code.to_i
 
       super <<-MESSAGE.gsub(/ +\|/, "")
-        |ABBYY Cloud API responded to the request {data.request_id} with a status #{status}
+        |ABBYY Cloud API responded to the request #{data.request_id} with a status #{status}
         |  error:       #{data.error}
         |  description: #{data.error_description}
         |  model_state: #{data.model_state}

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

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

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

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

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

@@ -2,7 +2,6 @@ require_relative "locale"
 
 class ABBYY::Cloud
   module Models
-    # Description of the translation direction
     class Direction < Struct
       attribute :source, Types::Locale
       attribute :target, Types::Locale

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

@@ -1,6 +1,7 @@
+require_relative "discount_type"
+
 class ABBYY::Cloud
   module Models
-    # Description of the price discount
     class Discount < Struct
       attribute :discount_type, Types::DiscountType
       attribute :discount,      Types::Coercible::Float

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

@@ -0,0 +1,19 @@
+class ABBYY::Cloud
+  module Models
+    class DiscountType < ::String
+      VALUES = %w(
+        TMTextMatch
+        TMTaggedTextMatch
+        TMHalfContextMatch
+        TMFullContextMatch
+      ).freeze
+
+      def self.new(string)
+        super Types::Strict::String.constrained(included_in: VALUES)[string]
+      end
+    end
+
+    # Registers type Types::DiscountType
+    Types.register_type DiscountType
+  end
+end

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

@@ -2,9 +2,7 @@ require_relative "locale"
 require_relative "direction"
 
 class ABBYY::Cloud
-  # Collection of models returned in requests
   module Models
-    # Description of the engine
     class Engine < Struct
       attribute :name,                   Types::Strict::String
       attribute :languages,              Types::Array.member(Types::Locale)

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

@@ -1,7 +1,6 @@
 class ABBYY::Cloud
   # Collection of models returned in requests
   module Models
-    # An error returned by the server in case of wrong response
     class Error < Struct
       attribute :request_id,        Types::Strict::String.optional
       attribute :error,             Types::Strict::String.optional

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

@@ -0,0 +1,19 @@
+class ABBYY::Cloud
+  module Models
+    class FileFormat < ::String
+      VALUES = %w(
+        Doc
+        Docx
+        Rtf
+        Txt
+      ).freeze
+
+      def self.new(string)
+        super Types::Strict::String.constrained(included_in: VALUES)[string]
+      end
+    end
+
+    # Registers type Types::FileFormat
+    Types.register_type FileFormat
+  end
+end

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

@@ -0,0 +1,33 @@
+require_relative "file_reference"
+require_relative "locale"
+require_relative "ocr_settings"
+require_relative "ocr_statistics"
+require_relative "ocr_warning"
+require_relative "reading_status"
+require_relative "text_statistics"
+
+class ABBYY::Cloud
+  module Models
+    class FileInfo < FileReference
+      attribute :name,               Types::Strict::String
+      attribute :mime,               Types::Strict::String
+      attribute :created,            Types::Form::Time
+      attribute :is_recognizable,    Types::Form::Bool
+      attribute :is_deleted,         Types::Form::Bool
+      attribute :reading_status,     Types::Strict::String
+      attribute :reading_progress,   Types::Coercible::Int
+      attribute :expected_languages, Types::Array.member(Types::Locale).optional
+      attribute :processed,          Types::Form::Time.optional
+      attribute :deleted,            Types::Form::Time.optional
+      attribute :error,              Types::Strict::String.optional
+      attribute :statistics,         Types::TextStatistics.optional
+      attribute :ocr_settings,       Types::OcrSettings.optional
+      attribute :ocr_statistics,     Types::OcrStatistics.optional
+      attribute :ocr_warnings,
+                Types::Array.member(Types::OcrWarning).optional
+    end
+
+    # Registers type Types::FileInfo
+    Types.register_type FileInfo
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative "file_reference"
+require_relative "locale"
+
+class ABBYY::Cloud
+  module Models
+    class FileLink < FileReference
+      attribute :name,        Types::Strict::String
+      attribute :language,    Types::Locale
+      attribute :is_deleted,  Types::Form::Bool
+      attribute :chars_count, Types::Coercible::Int.optional
+      attribute :words_count, Types::Coercible::Int.optional
+      attribute :pages_count, Types::Coercible::Int.optional
+    end
+
+    # Registers type Types::FileLink
+    Types.register_type FileLink
+  end
+end

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

@@ -0,0 +1,20 @@
+class ABBYY::Cloud
+  module Models
+    class FileReadError < ::String
+      VALUES = %w(
+        Unsupported
+        FileEmpty
+        FileEncrypted
+        FileFormatError
+        UnknownError
+      ).freeze
+
+      def self.new(string)
+        super Types::Strict::String.constrained(included_in: VALUES)[string]
+      end
+    end
+
+    # Registers type Types::FileReadError
+    Types.register_type FileReadError
+  end
+end

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

@@ -0,0 +1,14 @@
+class ABBYY::Cloud
+  module Models
+    class FileReadStatus < ::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::FileReadStatus
+    Types.register_type FileReadStatus
+  end
+end