abbyy-cloud 0.0.5 → 0.0.6

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

@@ -21,7 +21,7 @@ class ABBYY::Cloud
         items = Operations::Prices.new(settings)
                                   .call(skip: skip, take: take_now, **opts)
 
-        return items if (items.count < take_now) || take_later.zero?
+        return items if (items.count < take_now) || take_later&.zero?
         items + details(skip: skip_later, take: take_later, **opts)
       end
     end

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

@@ -6,7 +6,6 @@
 class ABBYY::Cloud
   module Operations
     class Base
-      # Helpers to specify concrete operations
       class << self
         include Forwardable
 
@@ -15,14 +14,18 @@ class ABBYY::Cloud
           @http_method || "Post"
         end
 
-        def path(value = nil)
-          value ? @path = value : @path
+        def path(&block)
+          block ? @path = block : @path
         end
 
         def link(value = nil)
           value ? @link = value : @link
         end
 
+        def request_type(value = nil)
+          value ? (@request_type = value) : (@request_type || :json)
+        end
+
         def request_body(struct = nil, &block)
           provide_struct :@request_body, struct, &block
         end
@@ -31,6 +34,10 @@ class ABBYY::Cloud
           provide_struct :@request_query, struct, &block
         end
 
+        def response_type(value = nil)
+          value ? (@response_type = value) : (@response_type || :json)
+        end
+
         def response_body(struct = nil, &block)
           provide_struct :@response_body, struct, &block
         end
@@ -54,25 +61,39 @@ class ABBYY::Cloud
 
       def_delegators :settings, :connection
       def_delegators :"self.class",
-                     :link,
-                     :http_method,
-                     :path,
-                     :request_body,
-                     :request_query,
-                     :response_body
-
-      def call(**data)
-        body  = prepare_request_body(data)
-        query = prepare_request_query(data)
-        res   = connection.call(http_method, path, body: body, query: query)
-
-        handle_response_body(res)
+                     :link, :http_method, :path, :request_type, :request_body,
+                     :request_query, :response_type, :response_body
+
+      def call(file = nil, **data)
+        mash      = Hashie::Mash.new(data)
+        url       = mash.instance_eval(&path)
+        multipart = prepare_multipart(file, **data) if file
+        body      = prepare_request_body(multipart, data)
+        query     = prepare_request_query(data)
+        headers   = prepare_request_headers(multipart)
+        res       = connection.call http_method, url, body: body,
+                                                      query: query,
+                                                      headers: headers
+        handle_response_body res
       end
 
       private
 
-      def prepare_request_body(data)
-        request_body[data]
+      def prepare_multipart(file, content_type: "plain/text", **)
+        name = SecureRandom.hex(10)
+        data = file.read if file.respond_to?(:read)
+        path = Pathname.new(file.path).basename if file.respond_to?(:path)
+        part = Part.new(name, data || file, path || "file")
+        part.content_type = content_type
+        MultipartBody.new [part]
+      end
+
+      def prepare_request_body(multipart, data)
+        case request_type
+        when :json then JSON(request_body[data].to_h)
+        when :file then multipart.to_s << "\r\n"
+        else data
+        end
       rescue => error
         raise ArgumentError.new(link, data, error.message)
       end
@@ -83,8 +104,24 @@ class ABBYY::Cloud
         raise ArgumentError.new(link, data, error.message)
       end
 
+      def prepare_request_headers(multipart)
+        headers = {}
+        headers["accept"] = "application/json" if response_type == :json
+        headers["content-type"] = \
+          case request_type
+          when :json then "application/json"
+          when :file then "multipart/form-data; boundary=#{multipart.boundary}"
+          end
+
+        headers
+      end
+
       def handle_response_body(data)
-        response_body[data]
+        case response_type
+        when :json then response_body[JSON.parse(data)]
+        when :file then StringIO.new(data)
+        else data
+        end
       rescue => error
         raise TypeError.new(link, data, error.message)
       end

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

@@ -0,0 +1,12 @@
+require_relative "base"
+
+class ABBYY::Cloud
+  module Operations
+    class DownloadFile < Base
+      link "https://api.abbyy.cloud/swagger/ui/index#!/File/File_DownloadFile"
+      path { "v0/file/#{id}/#{token}" }
+      http_method "get"
+      response_type :file
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ class ABBYY::Cloud
       # rubocop: disable Metrics/LineLength
       link "https://api.abbyy.cloud/swagger/ui/index#!/MachineTranslation/MachineTranslation_Engines"
       # rubocop: enable Metrics/LineLength
-      path "v0/mt/engines"
+      path { "v0/mt/engines" }
       http_method "get"
 
       response_body Types::Array.member(Types::Engine)

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

@@ -0,0 +1,13 @@
+require_relative "base"
+
+class ABBYY::Cloud
+  module Operations
+    class FindOrder < Base
+      link "https://api.abbyy.cloud/swagger/ui/index#!/Order/Order_GetOrder"
+      path { "v0/order/#{id}" }
+      http_method "get"
+
+      response_body Models::FullOrder
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ class ABBYY::Cloud
       # rubocop: disable Metrics/LineLength
       link "https://api.abbyy.cloud/swagger/ui/index#!/Prices/Prices_GetAccountPrices"
       # rubocop: enable Metrics/LineLength
-      path "v0/prices/details"
+      path { "v0/prices/details" }
       http_method "get"
 
       request_query do

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

@@ -0,0 +1,32 @@
+require_relative "base"
+
+class ABBYY::Cloud
+  module Operations
+    class SubmitOrder < Base
+      # rubocop: disable Metrics/LineLength
+      link "https://api.abbyy.cloud/swagger/ui/index#!/Order/Order_SubmitOrder_0"
+      # rubocop: enable Metrics/LineLength
+      path { "v0/order" }
+      http_method "post"
+
+      request_body do
+        attribute :type, Types::TranslationType
+        attribute :email, Types::Strict::String.optional
+        attribute :contact_culture, Types::Strict::String.optional
+        attribute :contact_utc_offset, Types::Coercible::String.optional
+        attribute :mt_engine, Types::Strict::String
+        attribute :approval_required, Types::Form::Bool
+        attribute :is_manual_estimation, Types::Form::Bool
+        attribute :cost_type, Types::CostType
+        attribute :unit_type, Types::UnitType
+        attribute :currency, Types::Currency
+        attribute :from, Types::Locale
+        attribute :label, Types::Label.optional
+        attribute :to, Types::FilledArray.member(Types::Locale)
+        attribute :files, Types::FilledArray.member(Types::FileReference)
+      end
+
+      response_body Models::FullOrder
+    end
+  end
+end

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

@@ -4,7 +4,7 @@ class ABBYY::Cloud
   module Operations
     class Translate < Base
       link "https://api.abbyy.cloud/swagger/ui/index#!/Order/Order_Translate"
-      path "v0/order/mt/sync"
+      path { "v0/order/mt/sync" }
       http_method "post"
 
       request_body do

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

@@ -6,7 +6,7 @@ class ABBYY::Cloud
       # rubocop: disable Metrics/LineLength
       link "https://api.abbyy.cloud/swagger/ui/index#!/Order/Order_TranslateSegments"
       # rubocop: enable Metrics/LineLength
-      path "v1/order/mt/sync"
+      path { "v1/order/mt/sync" }
       http_method "post"
 
       request_body do

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

@@ -0,0 +1,22 @@
+require_relative "base"
+
+class ABBYY::Cloud
+  module Operations
+    class UploadFile < Base
+      link "https://api.abbyy.cloud/swagger/ui/index#!/File/File_UploadFile"
+      path { "v0/file" }
+      http_method "post"
+
+      request_type :file
+
+      request_query do
+        attribute :quality,       Types::OcrQuality.optional
+        attribute :synthesisMode, Types::OcrMode.optional
+        attribute :exportFormat,  Types::FileFormat.optional
+        attribute :languages,     Types::Array.member(Types::Locale).optional
+      end
+
+      response_body Types::Array.member(Types::FileInfo)
+    end
+  end
+end

data/lib/abbyy/cloud/types.rb

@@ -1,26 +1,17 @@
 module ABBYY::Cloud::Types
   include Dry::Types.module
 
-  VERSIONS = [0].freeze
-  UNIT_TYPES = %w(Chars Words Pages Documents).freeze
-  DISCOUNT_TYPES = \
-    %w(TMTextMatch TMTaggedTextMatch TMHalfContextMatch TMFullContextMatch)
-    .freeze
-
   # Gem-specific primitive types
-  Version      = Coercible::Int.constrained(included_in: VERSIONS)
-  UnitType     = Strict::String.constrained(included_in: UNIT_TYPES)
-  DiscountType = Strict::String.constrained(included_in: DISCOUNT_TYPES)
-  Currency     = Strict::String.constrained(format: /\A[A-Z]{3}\z/)
+  FilledArray = Array.constrained(min_size: 1)
 
-  # Registers new coercible type from a struct class
-  def self.register_type(struct, as: nil, constructor: :new)
-    type_name  = Inflecto.underscore(as || struct.name.split("::").last)
-    definition = Dry::Types::Definition.new(struct).constructor do |value|
+  # Registers new coercible type
+  def self.register_type(klass, as: nil, constructor: :new)
+    type_name  = Inflecto.underscore(as || klass.name.split("::").last)
+    definition = Dry::Types::Definition.new(klass).constructor do |value|
       case value
-      when nil    then raise
-      when struct then value
-      else struct.send(constructor, value)
+      when nil   then raise
+      when klass then value
+      else klass.send(constructor, value)
       end
     end
 

data/spec/feature/abbyy/files_download_spec.rb

@@ -0,0 +1,57 @@
+RSpec.describe "files.download" do
+  subject { client.files.download(options) }
+
+  let(:client)  { ABBYY::Cloud.new(id: "foo", token: "bar") }
+  let(:path)    { "https://api.abbyy.cloud/v0/file/baz/qux" }
+  let(:options) { { id: "baz", token: "qux" } }
+
+  before do
+    stub_request(:get, path)
+      .with(basic_auth: %w(foo bar))
+      .to_return(status: 200, body: "Hello world!")
+  end
+
+  context "with valid params" do
+    it "sends a request to ABBYY Cloud API" do
+      subject
+      expect(a_request(:get, path)).to have_been_made
+    end
+
+    it "returns an IO" do
+      expect(subject).to be_kind_of StringIO
+      expect(subject.read).to eq "Hello world!"
+    end
+  end
+
+  context "without id:" do
+    before { options.delete(:id) }
+
+    it "raises ArgumentError without sending a request" do
+      expect { subject }.to raise_error(ArgumentError)
+      expect(a_request(:any, //)).not_to have_been_made
+    end
+  end
+
+  context "without token:" do
+    before { options.delete(:token) }
+
+    it "raises ArgumentError without sending a request" do
+      expect { subject }.to raise_error(ArgumentError)
+      expect(a_request(:any, //)).not_to have_been_made
+    end
+  end
+
+  context "when API responded with error:" do
+    before do
+      stub_request(:get, path)
+        .with(basic_auth: %w(foo bar))
+        .to_return status:  500,
+                   headers: { "Content-Type" => "application/json" },
+                   body:    "Server error"
+    end
+
+    it "raises ResponseError" do
+      expect { subject }.to raise_error(ABBYY::Cloud::ResponseError)
+    end
+  end
+end

data/spec/feature/abbyy/files_upload_spec.rb

@@ -0,0 +1,129 @@
+RSpec.describe "files.upload" do
+  subject do
+    client.files.upload file,
+                        synthesis_mode: synthesis_mode,
+                        export_format:  export_format,
+                        languages:      languages,
+                        quality:        quality
+  end
+
+  let(:client)         { ABBYY::Cloud.new(id: "foo", token: "bar") }
+  let(:path)           { %r{https://api.abbyy.cloud/v0/file} }
+  let(:file)           { StringIO.new("Hello world!") }
+  let(:export_format)  { "Doc" }
+  let(:quality)        { "Fast" }
+  let(:synthesis_mode) { "EditableCopy" }
+  let(:languages)      { %w(en) }
+  let(:response) do
+    {
+      id:    "foo",
+      token: "bar",
+      name:  "data.xml",
+      mime:  "application/xml",
+      is_recognizable: true,
+      expected_languages: %w(en),
+      ocr_settings: {
+        format: "Doc",
+        quality: "Fast",
+        mode: "EditableCopy"
+      },
+      statistics: {
+        language: "en",
+        chars_count: 0,
+        words_count: 0,
+        pages_count: 0
+      },
+      ocr_statistics: {
+        exported_pages: 0,
+        total_characters: 0,
+        uncertain_characters: 0,
+        success_part: 0
+      },
+      created:   "2016-09-05T08:33:03.567Z",
+      processed: "2016-09-05T08:33:03.567Z",
+      deleted:   "2016-09-05T08:33:03.567Z",
+      reading_progress: 0,
+      reading_status: "New",
+      ocr_warnings: [
+        {
+          warning_type: "BrightnessIsTooHigh",
+          page_number: 0,
+          dpi: 0,
+          language_count: 0,
+          full_warning_message: "Uwaga!"
+        }
+      ],
+      error: "Unsupported",
+      is_deleted: true
+    }
+  end
+
+  before do
+    stub_request(:post, path)
+      .with(basic_auth: %w(foo bar))
+      .to_return status:  200,
+                 headers: { "Content-Type" => "application/json" },
+                 body:    JSON([response])
+  end
+
+  context "with valid params" do
+    it "sends a request to ABBYY Cloud API" do
+      subject
+      expect(a_request(:post, path)).to have_been_made
+    end
+
+    it "returns array of file info" do
+      expect(subject.first).to be_kind_of ABBYY::Cloud::Models::FileInfo
+    end
+  end
+
+  context "with wrong export_format:" do
+    let(:export_format) { "Unknown" }
+
+    it "raises ArgumentError without sending a request" do
+      expect { subject }.to raise_error(ABBYY::Cloud::ArgumentError)
+      expect(a_request(:any, //)).not_to have_been_made
+    end
+  end
+
+  context "with wrong quality:" do
+    let(:quality) { "Unknown" }
+
+    it "raises ArgumentError without sending a request" do
+      expect { subject }.to raise_error(ABBYY::Cloud::ArgumentError)
+      expect(a_request(:any, //)).not_to have_been_made
+    end
+  end
+
+  context "with wrong synthesis_mode:" do
+    let(:synthesis_mode) { "Unknown" }
+
+    it "raises ArgumentError without sending a request" do
+      expect { subject }.to raise_error(ABBYY::Cloud::ArgumentError)
+      expect(a_request(:any, //)).not_to have_been_made
+    end
+  end
+
+  context "with wrong languages:" do
+    let(:languages) { "foo" }
+
+    it "raises ArgumentError without sending a request" do
+      expect { subject }.to raise_error(ABBYY::Cloud::ArgumentError)
+      expect(a_request(:any, //)).not_to have_been_made
+    end
+  end
+
+  context "when API responded with error:" do
+    before do
+      stub_request(:post, path)
+        .with(basic_auth: %w(foo bar))
+        .to_return status:  500,
+                   headers: { "Content-Type" => "application/json" },
+                   body:    "Server error"
+    end
+
+    it "raises ResponseError" do
+      expect { subject }.to raise_error(ABBYY::Cloud::ResponseError)
+    end
+  end
+end