abbyy-cloud 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19c1ff610b7210be89b61f821ff6642ce0d149c3
-  data.tar.gz: 896dbcb70a0796ef0445b7184d703bba31c2259e
+  metadata.gz: 86781ecddc4c6d75b7eca75244bb940bf82c0df1
+  data.tar.gz: 4fbafddffeab9bbbbc23d8e951e7f04bf5ece6c0
 SHA512:
-  metadata.gz: ca702183cde764f614c77f26bb5bafa17a2f96614d230efccf97775f7f839fea047c35ea6bdb67b24fb270cada0402f89caefe0fcc8f7264fd295218e43f4a95
-  data.tar.gz: f4ec867431b3eab6e736700831db4f62aaa047289c90ee81847347bdf933331a1c742973c1ed96557a8f5f69fd4206577253a628d3fd4049049ae7f07f35dcb4
+  metadata.gz: 46fdfc138c2b78f7e555ee80dc19c2b971cf12768e10569ee6eda8c6529030e9401d6d35ab50dc08266862b60af5e70f4a725bd6ff9df00c7caea2ff4cb355e0
+  data.tar.gz: ca541399867b4f463ce81f261f2e189afff31b218a7d8532008a78bbc9849ddd6f2d7b10c111396fb4b43245acb88d62b963ba3b8b3d698b3b900f816a6cefed

data/.rubocop.yml

@@ -78,6 +78,9 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
+Style/TernaryParentheses:
+  Enabled: false
+
 Style/TrivialAccessors:
   Exclude:
     - spec/**/*_spec.rb

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+# [v0.0.4 2016-08-23](https://github.com/nepalez/abbyy-cloud/tree/v0.0.4)
+
+### Added
+
+* Operation `mt.engine(name)` (nepalez)
+* Operation `mt.default_engine` (nepalez)
+* Operation `mt.translate` instead of `orders.translate` (nepalez)
+* Operation `mt.translate_segments` (nepalez)
+* Operation `prices.details` (nepalez)
+* Validation of locales following IANA & RFC-5646 (nepalez)
+
+### Deleted
+
+* Namespace `orders` (nepalez)
+* Remove :version settings (nepalez)
+  Every operation has its own version. No global API version is supported.
+  When necessary, a version will be send to the operation.
+
+### Internal
+
+* Added support for query part of a request (nepalez)
+
+[Compare v0.0.3...v0.0.4](https://github.com/nepalez/abbyy-cloud/compare/v0.0.3...v0.0.4)
+
 # [v0.0.3 2016-08-18](https://github.com/nepalez/abbyy-cloud/tree/v0.0.3)
 
 ### Bugs Fixed

data/README.md

@@ -22,20 +22,31 @@ require "abbyy/cloud"
 CLIENT = ABBYY::Cloud.new(id: "foo", token: "bar")
 ```
 
-The only supported API version is `0`. By default the translation engine is set to "Sandbox".
-
 You can set these options explicitly:
 
 ```ruby
 CLIENT = ABBYY::Cloud.new id:      "foo",
                           token:   "bar",
-                          engine:  "Sandbox", # default engine for translations
-                          version: 0          # the only supported version
+                          engine:  "Sandbox" # default engine for translations
+```
+
+And then use the client to provide requests:
+
+```ruby
+res = CLIENT.mt.translate("To be or not to be", from: :en, to: :ru)
+res.translation  # => "Быть или не быть"
+
+res = CLIENT.mt.translate_segments ["To be or not to be", "That is the question"], from: "en", to: "ru"
+res.map(&:text) # => ["Быть или не быть", "Это вопрос"]
 ```
 
+## Namespaces and Operations
+
 ### Machine Translations
 
-#### Engines
+The namespace `mt` contains (synchronous) operations with machine translation.
+
+#### engines
 
 See [the specification](https://api.abbyy.cloud/swagger/ui/index#!/MachineTranslation)
 
@@ -44,7 +55,7 @@ result = CLIENT.mt.engines
 # => [#<ABBYY::Cloud::Models::Engine @name="Sandbox">]
 ```
 
-#### Engine
+#### engine
 
 This operation is built on top of the previous one and simply takes settings for the specified engine:
 
@@ -59,14 +70,24 @@ result.to_h
 # => { name: "Sandbox", languages: ["en", "ru"], translation_directions: [{ source: "en", target: "ru" }] }
 ```
 
-### Orders
+#### default_engine
+
+Returns settings for the engine used in the initializer
+
+```ruby
+CLIENT = ABBYY::Cloud.new(id: "foo", token: "bar", engine: "Bing")
+
+settings_for_bing = CLIENT.mt.default_engine
+```
+
+#### translate
 
-#### Instant Translation
+Translates a string.
 
 See [the specification](https://api.abbyy.cloud/swagger/ui/index#!/Order/Order_Translate).
 
 ```ruby
-result = CLIENT.orders.translate("To be or not to be", from: :en, to: :ru)
+result = CLIENT.mt.translate("To be or not to be", from: :en, to: :ru)
 
 result.class       # => ABBYY::Cloud::Models::Translation
 result.translation # => "Быть или не быть"
@@ -74,42 +95,48 @@ result.id          # => "2832934"
 result.to_h        # => { id: "2832934", translation: "Быть или не быть" }
 ```
 
-You can specify an engine (different from default):
+#### translate_segments
 
-```ruby
-CLIENT.orders.translate("To be or not to be", from: :en, to: :ru, engine: "Bing")
-```
+Translates an array of strings in one request
 
-The method raises an exception in case the cloud responded with error.
+See [the specification](https://api.abbyy.cloud/swagger/ui/index#!/Order/Order_TranslateSegments)
 
 ```ruby
-error = \
-  begin
-    CLIENT.orders.translate("To be or not to be")
-  rescue ABBYY::Cloud::Error => error
-    error
-  end
-
-error.class  # => ABBYY::Cloud::ResponceError
-error.status # => 400
+result = CLIENT.mt.translate_segments(["To be", "or not to be"], from: :en, to: :ru)
+
+result.class       # => ABBYY::Cloud::Models::TranslationSequence
+result.map(&:text) # => ["Быть", "или не быть"]
 ```
 
-The exception carries returned error model in its `#data` attribute:
+### Prices
+
+The namespace `prices` contains operations with prices details.
+
+#### details
+
+See [the specification](https://api.abbyy.cloud/swagger/ui/index#!/Prices/Prices_GetAccountPrices).
 
 ```ruby
-error.data   # => ABBYY::Cloud::Models::Error
-error.data.to_h
-# => {
-#   model_state: {},
-#   requiest_id: "string",
-#   error: "error message",
-#   error_description: "some details"
+list = CLIENT.prices.details
+
+list.first.to_h
+# {
+#   id:          "foo",
+#   account_id:  "bar",
+#   type:        "qux",
+#   from:        "ru",
+#   to:          "en",
+#   unit_prices: [{ unit_type: "Words", currency: "USD", amount: 0.03 }],
+#   discounts:   [{ discount_type: "TMTextMatch", discount: 0.01 }],
+#   created:     Time.now
 # }
 
-error.data.error # => "error message"
-# etc.
 ```
 
+The number of items can be several thousands. You can specify `skip` and `take` options to take necessary items only, otherwise it will return all prices.
+
+Notice, though, that every single request can return no more than 1000 items. If you request more prices, several requests will be made one-by-one. Parsing all the results can be pretty slow.
+
 ## Compatibility
 
 [WIP] Compatible to [ABBYY Cloud API v.0][abbyy-api].

data/abbyy-cloud.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "abbyy-cloud"
-  gem.version  = "0.0.3"
+  gem.version  = "0.0.4"
   gem.authors  = ["Andrew Kozin"]
   gem.email    = ["andrew.kozin@gmail.com"]
   gem.summary  = "HTTP client to ABBYY Cloud API"

data/lib/abbyy/cloud.rb

@@ -11,22 +11,12 @@ module ABBYY
     require_relative "cloud/connection"
     require_relative "cloud/settings"
 
-    require_relative "cloud/exceptions/response_error"
-    require_relative "cloud/exceptions/argument_error"
-    require_relative "cloud/exceptions/type_error"
-
-    require_relative "cloud/models/error"
-    require_relative "cloud/models/translation"
-    require_relative "cloud/models/direction"
-    require_relative "cloud/models/engine"
-
-    require_relative "cloud/operations/base"
-    require_relative "cloud/operations/translate"
-    require_relative "cloud/operations/engines"
-
-    require_relative "cloud/namespaces/base"
-    require_relative "cloud/namespaces/orders"
-    require_relative "cloud/namespaces/machine_translations"
+    Dir[
+      "lib/abbyy/cloud/exceptions/*.rb",
+      "lib/abbyy/cloud/models/*.rb",
+      "lib/abbyy/cloud/operations/*.rb",
+      "lib/abbyy/cloud/namespaces/*.rb"
+    ].each { |f| require File.expand_path(f) }
 
     attr_reader :settings
 
@@ -38,6 +28,10 @@ module ABBYY
       Namespaces::Orders.new(settings)
     end
 
+    def prices
+      Namespaces::Prices.new(settings)
+    end
+
     private
 
     def initialize(*args)

data/lib/abbyy/cloud/connection.rb

@@ -7,35 +7,49 @@
 class ABBYY::Cloud
   class Connection
     include Dry::Initializer.define -> do
-      option :version
       option :id
       option :token
     end
 
-    def call(http_method, path, body: nil, headers: nil)
-      uri = root.merge(path).tap { |item| item.scheme = "https" }
-      req = prepare_request(http_method, uri, JSON(body.to_h), headers.to_h)
+    attr_reader :root
 
-      Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
-        handle_response http.request(req)
+    def call(http_method, path, **options)
+      uri = prepare_uri(path, options)
+      req = Net::HTTP.const_get(http_method.capitalize).new(uri)
+      setup_headers(req, options)
+      setup_body(req, options)
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(req)
       end
+      handle_response(res)
     end
 
     private
 
-    def root
-      @root ||= URI("https://api.abbyy.cloud").merge("v#{version}/")
+    def initialize(*)
+      super
+      @root = URI("https://api.abbyy.cloud").tap { |obj| obj.scheme = "https" }
     end
 
-    def prepare_request(http_method, uri, body, headers)
-      Net::HTTP.const_get(http_method.capitalize).new(uri).tap do |req|
-        req.body = body
-        req.basic_auth id, token
-        req["accept-charset"] = "utf-8"
-        req["accept"] = "application/json"
-        req["content-type"] = "application/json"
-        headers.each { |key, value| req[key.to_s] = value }
-      end
+    def prepare_uri(path, query: nil, **)
+      uri   = root.merge(path)
+      query = query.to_h.map { |k, v| "#{k}=#{v}" if v }.compact.join("&")
+      uri.query = query unless query.empty?
+      uri
+    end
+
+    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)

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

@@ -1,9 +1,11 @@
+require_relative "locale"
+
 class ABBYY::Cloud
   module Models
     # Description of the translation direction
     class Direction < Struct
-      attribute :source, Types::Language
-      attribute :target, Types::Language
+      attribute :source, Types::Locale
+      attribute :target, Types::Locale
     end
 
     # Registers type Types::Direction

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

@@ -0,0 +1,12 @@
+class ABBYY::Cloud
+  module Models
+    # Description of the price discount
+    class Discount < Struct
+      attribute :discount_type, Types::DiscountType
+      attribute :discount,      Types::Coercible::Float
+    end
+
+    # Registers type Types::Discount
+    Types.register_type Discount
+  end
+end

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

@@ -1,10 +1,13 @@
+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::Language)
+      attribute :languages,              Types::Array.member(Types::Locale)
       attribute :translation_directions, Types::Array.member(Types::Direction)
     end
 

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

@@ -0,0 +1,23 @@
+class ABBYY::Cloud
+  module Models
+    class Locale < String
+      FORMAT = /\A[A-Za-z0-9]{2,}(-[A-Za-z0-9]+)*\z|\A[i|x](-[A-Za-z0-9]+)+\z/
+
+      class << self
+        def new(value)
+          return unless value
+          return super if value[FORMAT]
+          raise <<-MESSAGE.gsub(" +\|", "")
+            |'#{value}' is not a valid locale. See:
+            |  RFC-5656 (https://tools.ietf.org/html/rfc5646) for valid format
+            |  Full list of locales at http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry
+          MESSAGE
+        end
+        alias_method :[], :new
+      end
+    end
+
+    # Registers type Types::Locale
+    Types.register_type Locale
+  end
+end

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

@@ -0,0 +1,22 @@
+require_relative "locale"
+require_relative "unit_price"
+require_relative "discount"
+
+class ABBYY::Cloud
+  module Models
+    # Price details
+    class Price < Struct
+      attribute :id,          Types::Strict::String
+      attribute :account_id,  Types::Strict::String
+      attribute :type,        Types::Strict::String
+      attribute :from,        Types::Locale
+      attribute :to,          Types::Locale
+      attribute :unit_prices, Types::Array.member(Types::UnitPrice)
+      attribute :discounts,   Types::Array.member(Types::Discount)
+      attribute :created,     Types::Coercible::Time
+    end
+
+    # Registers type Types::Price
+    Types.register_type Price
+  end
+end

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

@@ -0,0 +1,14 @@
+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([])
+    end
+
+    # Registers type Types::SourceSegment
+    Types.register_type SourceSegment
+  end
+end

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

@@ -0,0 +1,15 @@
+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
+      attribute :type, Types::Strict::String.constrained(included_in: TYPES)
+    end
+
+    # Registers type Types::SourceTag
+    Types.register_type SourceTag
+  end
+end

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

@@ -0,0 +1,14 @@
+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
+    end
+
+    # Registers type Types::TransferData
+    Types.register_type TransferData
+  end
+end