abbyy-cloud 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cababb6c66e2c17fe4b3b8536f61ca2273695712
-  data.tar.gz: aa4eb72f7805fd507c529ffd8fb79d2ad8f3f8dd
+  metadata.gz: 1d52d8a388887b3f4e08cf42ef30ae712b906871
+  data.tar.gz: a10ee9b0f18b09cb669b1d48f8724f2df89a9ba2
 SHA512:
-  metadata.gz: 67a49f25576bbece4ee85226116275642bc5e3b3a1bcf86e4bf0182ee318de16687ef206f43edb59048ceb71151f28138be10d4765f2d8bf600ef7a4b1ecb9da
-  data.tar.gz: 394413929ad8198cde627b12056c8119aefafa2a358e5f93dd59024604eb9d2bb3203a8a524b69b67ffe898d77ece5e917371bf5c3d0e12c72570010806d1eb5
+  metadata.gz: ad61bbb9f0c6fa939e34383692fece8384ed621269eb4761e530907e12d8a95d34b5ce3c36dd001f616b94f500ea0d21fc964bb788b80b79997f8417c2341c2a
+  data.tar.gz: 66999b7e975385018c8d40f6f31e67414ece9f4f36781af0359237024dff32f23de0880691f608613aaf4539ca6012316b95bb2fc3f7a6394bae2702be283a3f

data/.rubocop.yml

@@ -13,8 +13,10 @@ AllCops:
   TargetRubyVersion: 2.3
 
 RSpec/NamedSubject:
-  Exclude:
-    - spec/**/*_spec.rb
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
 
 Documentation:
   Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# [v0.0.2 2016-08-18](https://github.com/nepalez/abbyy-cloud/tree/v0.0.2)
+
+### Changed
+
+* Move `#translation` from root to `#orders` namespace (nepalez)
+
+  Instead of `client.translation(*)` use `client.orders.translation(*)`
+
+* Make `#translation` return model `ABBYY::Cloud::Models::Translation` instead of hash (nepalez)
+
+### Internal
+
+* Extract settings from root object and isolate them in the shareable container `ABBYY::Cloud::Settings` (nepalez)
+* Add namespaces for operations (nepalez)
+* Add models for objects returned by operations (nepalez)
+
+[Compare v0.0.1...v0.0.2](https://github.com/nepalez/abbyy-cloud/compare/v0.0.1...v0.0.2)
+
+# [v0.0.1 2016-08-16](https://github.com/nepalez/abbyy-cloud/tree/v0.0.1)
+
+First public release

data/README.md

@@ -31,22 +31,25 @@ CLIENT = ABBYY::Cloud.new id:      "foo",
                           version: 0          # the only supported version
 ```
 
-### Instant Translation
+### Orders
+
+#### Instant Translation
 
 See [the specification](https://api.abbyy.cloud/swagger/ui/index#!/Order/Order_Translate).
 
 ```ruby
-result = CLIENT.translate("To be or not to be", from: :en, to: :ru)
+result = CLIENT.orders.translate("To be or not to be", from: :en, to: :ru)
 
-result.class       # => ABBYY::Cloud::Translation
+result.class       # => ABBYY::Cloud::Models::Translation
 result.translation # => "Быть или не быть"
-result.order_id    # => 2832934
+result.id          # => "2832934"
+result.to_h        # => { id: "2832934", translation: "Быть или не быть" }
 ```
 
 You can specify an engine (different from default):
 
 ```ruby
-CLIENT.translate("To be or not to be", from: :en, to: :ru, engine: "Bing")
+CLIENT.orders.translate("To be or not to be", from: :en, to: :ru, engine: "Bing")
 ```
 
 The method raises an exception in case the cloud responded with error.
@@ -54,13 +57,19 @@ The method raises an exception in case the cloud responded with error.
 ```ruby
 error = \
   begin
-    CLIENT.translate("To be or not to be")
+    CLIENT.orders.translate("To be or not to be")
   rescue ABBYY::Cloud::Error => error
     error
   end
 
 error.class  # => ABBYY::Cloud::ResponceError
 error.status # => 400
+```
+
+The exception carries returned error model in its `#data` attribute:
+
+```ruby
+error.data   # => ABBYY::Cloud::Models::Error
 error.data.to_h
 # => {
 #   model_state: {},

data/abbyy-cloud.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "abbyy-cloud"
-  gem.version  = "0.0.1"
+  gem.version  = "0.0.2"
   gem.authors  = ["Andrew Kozin"]
   gem.email    = ["andrew.kozin@gmail.com"]
   gem.summary  = "HTTP client to ABBYY Cloud API"
@@ -16,7 +16,6 @@ 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 "dry-types", "~> 0.8.0"
 
   gem.add_development_dependency "bundler", "~> 1.12"
   gem.add_development_dependency "rake", "~> 10.0"

data/lib/abbyy/cloud.rb

@@ -1,6 +1,5 @@
 require "dry-initializer"
 require "dry-struct"
-require "dry-types"
 require "json"
 require "net/http"
 require "net/https"
@@ -9,32 +8,32 @@ module ABBYY
   class Cloud
     require_relative "cloud/struct"
     require_relative "cloud/types"
-    require_relative "cloud/response_error"
-    require_relative "cloud/argument_error"
-    require_relative "cloud/type_error"
     require_relative "cloud/connection"
-    require_relative "cloud/operation"
-    require_relative "cloud/operation/translate"
-
-    include Dry::Initializer.define -> do
-      option :id,      type: Types::AuthId
-      option :token,   type: Types::AuthToken
-      option :version, type: Types::Version, default: proc { 0 }
-      option :engine,  type: Types::Engine,  default: proc { "Sandbox" }
-    end
+    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/operations/base"
+    require_relative "cloud/operations/translate"
+
+    require_relative "cloud/namespaces/base"
+    require_relative "cloud/namespaces/orders"
+
+    attr_reader :settings
 
-    def translate(text, from:, to:, **opts)
-      Operation::Translate.new(connection).call source_text:     text,
-                                                source_language: from,
-                                                target_language: to,
-                                                engine:          engine,
-                                                **opts
+    def orders
+      Namespaces::Orders.new(settings)
     end
 
     private
 
-    def connection
-      @connection ||= Connection.new(version: version, id: id, token: token)
+    def initialize(*args)
+      @settings ||= Settings.new(*args)
     end
   end
 end

data/lib/abbyy/cloud/{response_error.rb → exceptions/response_error.rb}

@@ -2,17 +2,10 @@
 # It takes a raw Net::HTTPResponse and extracts all the data returned by API.
 class ABBYY::Cloud
   class ResponseError < StandardError
-    class Data < Struct
-      attribute :request_id,        Types::Coercible::String.optional
-      attribute :error,             Types::Coercible::String.optional
-      attribute :error_description, Types::Coercible::String.optional
-      attribute :model_state,       Types::Hash.optional
-    end
-
     attr_reader :status, :data
 
     def initialize(response)
-      @data   = Data[JSON.parse(response.body)]
+      @data   = Models::Error[JSON.parse(response.body)]
       @status = response.code.to_i
 
       super <<-MESSAGE.gsub(/ +\|/, "")

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

@@ -0,0 +1,12 @@
+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::Coercible::String.optional
+      attribute :error,             Types::Coercible::String.optional
+      attribute :error_description, Types::Coercible::String.optional
+      attribute :model_state,       Types::Hash.optional
+    end
+  end
+end

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

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

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

@@ -0,0 +1,11 @@
+class ABBYY::Cloud
+  module Namespaces
+    # Base class for namespaces
+    # Every namespace carries shared settings and defines its own methods
+    class Base
+      include Dry::Initializer.define -> do
+        param :settings
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+class ABBYY::Cloud
+  module Namespaces
+    # Namespace for operations with orders
+    # @see [https://api.abbyy.cloud/swagger/ui/index#!/Order] ABBYY Cloud API
+    class Orders < Base
+      # Instantly (synchronously) translates the text
+      #
+      # @example
+      #   translate "Hello world!", from: "en", to: "fr_FR"
+      #
+      # @param  [String] text
+      # @option [ABBYY::Cloud::Types::Language] :from Source language
+      # @option [ABBYY::Cloud::Types::Language] :to   Target language
+      # @return [Hash<Symbol, Object>] translation
+      #
+      def translate(text, from:, to:, **opts)
+        Operations::Translate.new(settings).call source_text:     text,
+                                                 source_language: from,
+                                                 target_language: to,
+                                                 engine: settings.engine,
+                                                 **opts
+      end
+    end
+  end
+end

data/lib/abbyy/cloud/operations/base.rb

@@ -0,0 +1,78 @@
+# Base class for specific operations
+# It validates request and response using corresponding structs
+#
+# @abstract
+#
+class ABBYY::Cloud
+  module Operations
+    class Base
+      # Contains helper methods to specify concrete operations
+      class << self
+        include Forwardable
+
+        def http_method(value = nil)
+          @http_method = value.to_s.capitalize if value
+          @http_method || "Post"
+        end
+
+        def path(value = nil)
+          value ? @path = value : @path
+        end
+
+        def link(value = nil)
+          value ? @link = value : @link
+        end
+
+        def request_body(struct = nil, &block)
+          provide_struct :@request_body, struct, &block
+        end
+
+        def response_body(struct = nil, &block)
+          provide_struct :@response_body, struct, &block
+        end
+
+        private
+
+        def provide_struct(variable, struct, &block)
+          if block || instance_variable_get(variable).nil?
+            struct ||= Class.new(Struct).tap { |obj| obj.instance_eval(&block) }
+            instance_variable_set(variable, struct)
+          else
+            instance_variable_get(variable)
+          end
+        end
+      end
+
+      def_delegators :"self.class",
+                     :link,
+                     :http_method,
+                     :path,
+                     :request_body,
+                     :response_body
+
+      include Dry::Initializer.define -> do
+        param :settings
+      end
+
+      def call(**data)
+        body = prepare_request_body(data)
+        res  = settings.connection.call(http_method, path, body: body)
+        handle_response_body(res)
+      end
+
+      private
+
+      def prepare_request_body(data)
+        request_body[data]
+      rescue => error
+        raise ArgumentError.new(link, data, error.message)
+      end
+
+      def handle_response_body(data)
+        response_body[data]
+      rescue => error
+        raise TypeError.new(link, data, error.message)
+      end
+    end
+  end
+end

data/lib/abbyy/cloud/{operation → operations}/translate.rb

@@ -1,6 +1,6 @@
 class ABBYY::Cloud
-  class Operation
-    class Translate < Operation
+  module Operations
+    class Translate < Base
       link "https://api.abbyy.cloud/swagger/ui/index#!/Order/Order_Translate"
       path "order/mt/sync"
       http_method "post"
@@ -12,10 +12,7 @@ class ABBYY::Cloud
         attribute :source_text,     Types::Strict::String
       end
 
-      response_body do
-        attribute :id,          Types::OrderId
-        attribute :translation, Types::Strict::String
-      end
+      response_body Models::Translation
     end
   end
 end

data/lib/abbyy/cloud/settings.rb

@@ -0,0 +1,16 @@
+# Container for settings, that is initialized by [ABBYY::Cloud#initializer]
+# and then shared by namespaces and operations.
+class ABBYY::Cloud
+  class Settings
+    include Dry::Initializer.define -> do
+      option :id,      type: Types::AuthId
+      option :token,   type: Types::AuthToken
+      option :version, type: Types::Version, default: proc { 0 }
+      option :engine,  type: Types::Engine,  default: proc { "Sandbox" }
+    end
+
+    def connection
+      @connection ||= Connection.new(version: version, id: id, token: token)
+    end
+  end
+end

data/spec/abbyy/cloud/settings_spec.rb

@@ -0,0 +1,101 @@
+RSpec.describe ABBYY::Cloud::Settings do
+  let(:options)  { { id: "foo", token: "bar" } }
+  let(:settings) { described_class.new options }
+
+  describe ".new" do
+    subject { settings }
+
+    context "with wrong engine" do
+      before { options[:engine] = "Wrong" }
+
+      it "fails" do
+        expect { subject }.to raise_error(StandardError)
+      end
+    end
+
+    context "without id" do
+      before { options.delete :id }
+
+      it "fails" do
+        expect { subject }.to raise_error(StandardError)
+      end
+    end
+
+    context "without token" do
+      before { options.delete :token }
+
+      it "fails" do
+        expect { subject }.to raise_error(StandardError)
+      end
+    end
+
+    context "with empty id" do
+      before { options[:id] = nil }
+
+      it "fails" do
+        expect { subject }.to raise_error(StandardError)
+      end
+    end
+
+    context "with empty token" do
+      before { options[:token] = nil }
+
+      it "fails" do
+        expect { subject }.to raise_error(StandardError)
+      end
+    end
+
+    context "with wrong version" do
+      before { options[:id] = 1 }
+
+      it "fails" do
+        expect { subject }.to raise_error(StandardError)
+      end
+    end
+  end
+
+  describe "#id" do
+    subject { settings.id }
+    it { is_expected.to eq "foo" }
+  end
+
+  describe "#token" do
+    subject { settings.token }
+    it { is_expected.to eq "bar" }
+  end
+
+  describe "#engine" do
+    subject { settings.engine }
+
+    context "by default:" do
+      it { is_expected.to eq "Sandbox" }
+    end
+
+    context "when assigned:" do
+      before { options[:engine] = "Google" }
+      it { is_expected.to eq "Google" }
+    end
+  end
+
+  describe "#version" do
+    subject { settings.version }
+
+    context "by default:" do
+      it { is_expected.to eq 0 }
+    end
+
+    context "when assigned:" do
+      before { options[:version] = 0 }
+      it { is_expected.to eq 0 }
+    end
+  end
+
+  describe "#connection" do
+    subject { settings.connection }
+
+    it { is_expected.to be_instance_of ABBYY::Cloud::Connection }
+    its(:version) { is_expected.to eq settings.version }
+    its(:id)      { is_expected.to eq settings.id }
+    its(:token)   { is_expected.to eq settings.token }
+  end
+end

data/spec/abbyy/cloud_spec.rb

@@ -2,57 +2,13 @@ RSpec.describe ABBYY::Cloud do
   let(:options) { { id: "foo", token: "bar" } }
   let(:cloud)   { described_class.new options }
 
-  describe ".new" do
-    subject { cloud }
+  describe "#settings" do
+    subject { cloud.settings }
 
+    it { is_expected.to be_a ABBYY::Cloud::Settings }
     its(:version) { is_expected.to eq 0 }
     its(:engine)  { is_expected.to eq "Sandbox" }
     its(:id)      { is_expected.to eq "foo" }
     its(:token)   { is_expected.to eq "bar" }
-
-    context "with custom engine" do
-      before { options[:engine] = "Google" }
-      its(:engine) { is_expected.to eq "Google" }
-    end
-
-    context "with wrong engine" do
-      before { options[:engine] = "Wrong" }
-
-      it "fails" do
-        expect { subject }.to raise_error(StandardError)
-      end
-    end
-
-    context "without id" do
-      before { options.delete :id }
-
-      it "fails" do
-        expect { subject }.to raise_error(StandardError)
-      end
-    end
-
-    context "without token" do
-      before { options.delete :token }
-
-      it "fails" do
-        expect { subject }.to raise_error(StandardError)
-      end
-    end
-
-    context "with empty id" do
-      before { options[:id] = nil }
-
-      it "fails" do
-        expect { subject }.to raise_error(StandardError)
-      end
-    end
-
-    context "with empty token" do
-      before { options[:token] = nil }
-
-      it "fails" do
-        expect { subject }.to raise_error(StandardError)
-      end
-    end
   end
 end

data/spec/feature/abbyy/{cloud_translate_spec.rb → order_translate_spec.rb}

@@ -1,5 +1,5 @@
-RSpec.describe ABBYY::Cloud, "#translate" do
-  let(:client)          { described_class.new settings }
+RSpec.describe "orders.translate" do
+  let(:client)          { ABBYY::Cloud.new settings }
   let(:settings)        { { id: "foo", token: "bar", engine: default_engine } }
   let(:default_engine)  { "Google" }
   let(:custom_engine)   { "Bing" }
@@ -21,13 +21,18 @@ RSpec.describe ABBYY::Cloud, "#translate" do
                  body:    JSON(response_model)
   end
 
-  subject { client.translate source_text, params }
+  subject { client.orders.translate source_text, params }
 
-  it "sends a request to ABBYY Cloud API and returns translation as a hash" do
-    expect(subject).to eq response_model
+  it "sends a request to ABBYY Cloud API" do
+    subject
     expect(a_request(:post, path)).to have_been_made
   end
 
+  it "returns translation model" do
+    expect(subject).to be_instance_of ABBYY::Cloud::Models::Translation
+    expect(subject.to_h).to eq response_model
+  end
+
   context "without custom engine:" do
     before { params.delete :engine }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abbyy-cloud
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-16 00:00:00.000000000 Z
+date: 2016-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.1
-- !ruby/object:Gem::Dependency
-  name: dry-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -143,29 +129,37 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
+- CHANGELOG.md
 files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - abbyy-cloud.gemspec
 - lib/abbyy/cloud.rb
-- lib/abbyy/cloud/argument_error.rb
 - lib/abbyy/cloud/connection.rb
-- lib/abbyy/cloud/operation.rb
-- lib/abbyy/cloud/operation/translate.rb
-- lib/abbyy/cloud/response_error.rb
+- lib/abbyy/cloud/exceptions/argument_error.rb
+- lib/abbyy/cloud/exceptions/response_error.rb
+- lib/abbyy/cloud/exceptions/type_error.rb
+- lib/abbyy/cloud/models/error.rb
+- lib/abbyy/cloud/models/translation.rb
+- lib/abbyy/cloud/namespaces/base.rb
+- lib/abbyy/cloud/namespaces/orders.rb
+- lib/abbyy/cloud/operations/base.rb
+- lib/abbyy/cloud/operations/translate.rb
+- lib/abbyy/cloud/settings.rb
 - lib/abbyy/cloud/struct.rb
-- lib/abbyy/cloud/type_error.rb
 - lib/abbyy/cloud/types.rb
 - spec/abbyy/cloud/connection_spec.rb
 - spec/abbyy/cloud/response_error_spec.rb
+- spec/abbyy/cloud/settings_spec.rb
 - spec/abbyy/cloud_spec.rb
-- spec/feature/abbyy/cloud_translate_spec.rb
+- spec/feature/abbyy/order_translate_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/nepalez/abbyy-cloud
 licenses:
@@ -194,6 +188,7 @@ summary: HTTP client to ABBYY Cloud API
 test_files:
 - spec/abbyy/cloud/connection_spec.rb
 - spec/abbyy/cloud/response_error_spec.rb
+- spec/abbyy/cloud/settings_spec.rb
 - spec/abbyy/cloud_spec.rb
-- spec/feature/abbyy/cloud_translate_spec.rb
+- spec/feature/abbyy/order_translate_spec.rb
 - spec/spec_helper.rb

data/lib/abbyy/cloud/operation.rb

@@ -1,76 +0,0 @@
-# Base class for specific operations
-# It validates request and response using corresponding structs
-#
-# @abstract
-#
-class ABBYY::Cloud
-  class Operation
-    # Contains helper methods to specify concrete operations
-    class << self
-      include Forwardable
-
-      def http_method(value = nil)
-        @http_method = value.to_s.capitalize if value
-        @http_method || "Post"
-      end
-
-      def path(value = nil)
-        value ? @path = value : @path
-      end
-
-      def link(value = nil)
-        value ? @link = value : @link
-      end
-
-      def request_body(struct = nil, &block)
-        provide_struct :@request_body, struct, &block
-      end
-
-      def response_body(struct = nil, &block)
-        provide_struct :@response_body, struct, &block
-      end
-
-      private
-
-      def provide_struct(variable, struct, &block)
-        if block || instance_variable_get(variable).nil?
-          struct ||= Class.new(Struct).tap { |item| item.instance_eval(&block) }
-          instance_variable_set(variable, struct)
-        else
-          instance_variable_get(variable)
-        end
-      end
-    end
-
-    def_delegators :"self.class",
-                   :link,
-                   :http_method,
-                   :path,
-                   :request_body,
-                   :response_body
-
-    include Dry::Initializer.define -> do
-      param :connection
-    end
-
-    def call(**data)
-      body = prepare_request_body(data)
-      res  = connection.call(http_method, path, body: body)
-      handle_response_body(res)
-    end
-
-    private
-
-    def prepare_request_body(data)
-      request_body[data]
-    rescue => error
-      raise ArgumentError.new(link, data, error.message)
-    end
-
-    def handle_response_body(data)
-      response_body[data].to_h
-    rescue => error
-      raise TypeError.new(link, data, error.message)
-    end
-  end
-end