scnnr 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 701520f0f2410d7300d04bac498aec68db34597f
-  data.tar.gz: 15d6e7b77a2ad5c91d96fa302d4eb1fc800792f3
+SHA256:
+  metadata.gz: 5cb9874e1854429b787e165fbff198da0e2992ae506a6a84f0c85f42199701d0
+  data.tar.gz: 8c59dba0786ab878aef02294606f10fde6eb06fb154ea39ad8473eb8b498e02a
 SHA512:
-  metadata.gz: 99379cccbdb705692acd048f32355638b4084c19071c7c2833604fb1356164a36982aab1e7aa505d66495650524faf1d88d492e2eb854308b38b052ed821d0c0
-  data.tar.gz: ab1d3a36414710519e793259a1a9f655da7c6333971ac145e834bbb62fe02257985092cfd54568c78dd6aa86b4947e5961c9270adf44618adae7a121dba6c62b
+  metadata.gz: 77805ba9b1a35a675e918222e2925a56195cfbf10366ca6fe07d551d1f7ac95f8170acf7facd9d02e4e7c9b66aa3c1f3959f7d9b37c502b087b7d9c7a815d767
+  data.tar.gz: 0de1c9361be51d20fe0f95e57c9277efdac54450dceca1e065700bd07fa263db2635279438f65acb734a615b33b9cf083bfac18ef9dfb57c12891d06657db401

data/.circleci/config.yml

@@ -2,7 +2,7 @@
 #
 # Check https://circleci.com/docs/2.0/language-ruby/ for more details
 #
-version: 2
+version: 2.1
 jobs:
   build: &build
     docker:
@@ -13,13 +13,15 @@ jobs:
       - run:
           name: install dependencies
           command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
+            gem install bundler -v 2.1.2
+            bundle config set path vendor/bundle
+            bundle install --jobs=4 --retry=3
       # run tests!
       - run:
           name: run tests
           command: |
             mkdir /tmp/test-results
-            bundle exec rubocop --format progress -r $(bundle show rubocop-junit-formatter)/lib/rubocop/formatter/junit_formatter.rb --format RuboCop::Formatter::JUnitFormatter --out /tmp/test-results/rubocop.xml
+            bundle exec rubocop --format progress --format junit --out /tmp/test-results/rubocop.xml
             bundle exec rspec --format progress \
                             --format RspecJunitFormatter \
                             --out /tmp/test-results/rspec.xml \
@@ -30,17 +32,27 @@ jobs:
       - store_artifacts:
           path: /tmp/test-results
           destination: test-results
-  ruby-2.3.5:
+  ruby-24:
     <<: *build
     docker:
-      - image: circleci/ruby:2.3.5-node-browsers
-  ruby-2.4.1:
+      - image: circleci/ruby:2.4
+  ruby-25:
     <<: *build
     docker:
-      - image: circleci/ruby:2.4.1-node-browsers
+      - image: circleci/ruby:2.5
+  ruby-26:
+    <<: *build
+    docker:
+      - image: circleci/ruby:2.6
+  ruby-27:
+    <<: *build
+    docker:
+      - image: circleci/ruby:2.7
 workflows:
   version: 2
   ruby-multi-build:
     jobs:
-      - ruby-2.3.5
-      - ruby-2.4.1
+      - ruby-24
+      - ruby-25
+      - ruby-26
+      - ruby-27

data/.rubocop.yml

@@ -4,9 +4,6 @@ require:
 AllCops:
   TargetRubyVersion: 2.4
 
-Metrics/LineLength:
-  Max: 120
-
 Metrics/ClassLength:
   Max: 300
 
@@ -29,7 +26,10 @@ Style/CollectionMethods:
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: no_comma
 
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 
 Style/Documentation:
@@ -38,15 +38,15 @@ Style/Documentation:
 Style/RedundantSelf:
   Enabled: false
 
+Layout/LineLength:
+  Max: 120
+
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 RSpec/NestedGroups:
   Max: 5
 
@@ -65,3 +65,148 @@ RSpec/MessageSpies:
 RSpec/AnyInstance:
   Exclude:
     - 'spec/scnnr/connection_spec.rb'
+
+RSpec/ContextWording:
+  Prefixes:
+    - when
+    - with
+    - without
+    - and
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 7
+
+Layout/EmptyLinesAroundAttributeAccessor: # (new in 0.83)
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator: # (new in 0.82)
+  Enabled: true
+
+Lint/BinaryOperatorWithIdenticalOperands: # (new in 0.89)
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant: # (new in 0.84)
+  Enabled: true
+
+Lint/DuplicateElsifCondition: # (new in 0.88)
+  Enabled: true
+
+Lint/DuplicateRequire: # (new in 0.90)
+  Enabled: true
+
+Lint/DuplicateRescueException: # (new in 0.89)
+  Enabled: true
+
+Lint/EmptyConditionalBody: # (new in 0.89)
+  Enabled: true
+
+Lint/EmptyFile: # (new in 0.90)
+  Enabled: true
+
+Lint/FloatComparison: # (new in 0.89)
+  Enabled: true
+
+Lint/MissingSuper: # (new in 0.89)
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes: # (new in 0.85)
+  Enabled: true
+
+Lint/OutOfRangeRegexpRef: # (new in 0.89)
+  Enabled: true
+
+Lint/RaiseException: # (new in 0.81)
+  Enabled: true
+
+Lint/SelfAssignment: # (new in 0.89)
+  Enabled: true
+
+Lint/StructNewOverride: # (new in 0.81)
+  Enabled: true
+
+Lint/TopLevelReturnWithArgument: # (new in 0.89)
+  Enabled: true
+
+Lint/TrailingCommaInAttributeDeclaration: # (new in 0.90)
+  Enabled: true
+
+Lint/UnreachableLoop: # (new in 0.89)
+  Enabled: true
+
+Lint/UselessMethodDefinition: # (new in 0.90)
+  Enabled: true
+
+Style/AccessorGrouping: # (new in 0.87)
+  Enabled: true
+
+Style/ArrayCoercion: # (new in 0.88)
+  Enabled: true
+
+Style/BisectedAttrAccessor: # (new in 0.87)
+  Enabled: true
+
+Style/CaseLikeIf: # (new in 0.88)
+  Enabled: true
+
+Style/CombinableLoops: # (new in 0.90)
+  Enabled: true
+
+Style/ExplicitBlockArgument: # (new in 0.89)
+  Enabled: true
+
+Style/ExponentialNotation: # (new in 0.82)
+  Enabled: true
+
+Style/GlobalStdStream: # (new in 0.89)
+  Enabled: true
+
+Style/HashAsLastArrayItem: # (new in 0.88)
+  Enabled: true
+
+Style/HashEachMethods: # (new in 0.80)
+  Enabled: true
+
+Style/HashLikeCase: # (new in 0.88)
+  Enabled: true
+
+Style/HashTransformKeys: # (new in 0.80)
+  Enabled: true
+
+Style/HashTransformValues: # (new in 0.80)
+  Enabled: true
+
+Style/KeywordParametersOrder: # (new in 0.90)
+  Enabled: true
+
+Style/OptionalBooleanParameter: # (new in 0.89)
+  Enabled: true
+
+Style/RedundantAssignment: # (new in 0.87)
+  Enabled: true
+
+Style/RedundantFetchBlock: # (new in 0.86)
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire: # (new in 0.88)
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass: # (new in 0.85)
+  Enabled: true
+
+Style/RedundantRegexpEscape: # (new in 0.85)
+  Enabled: true
+
+Style/RedundantSelfAssignment: # (new in 0.90)
+  Enabled: true
+
+Style/SingleArgumentDig: # (new in 0.89)
+  Enabled: true
+
+Style/SlicingWithRange: # (new in 0.83)
+  Enabled: true
+
+Style/SoleNestedConditional: # (new in 0.89)
+  Enabled: true
+
+Style/StringConcatenation: # (new in 0.89)
+  Enabled: true

data/CHANGELOG.md

@@ -4,13 +4,39 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.0.0] - 2020-09-14
+### Added
+- Start supporting Ruby 2.7.
+- Provide image error details.
+- Raise `UnexpectedError` for unknown recognition error types.
+
+### Removed
+- Support for Ruby 2.3.
+
+## [1.3.0] - 2019-08-30
+### Added
+- Support a retrying feature on `Scnnr::Connection`.
+- Start supporting Ruby 2.5 and 2.6.
+
+## [1.2.0] - 2018-10-11
+### Added
+- Support `target` parameter for `Scnnr::Client#coordinate`.
+
+## [1.1.1] - 2018-06-20
+### Added
+- Support `force` parameter for `Scnnr::Client#recognize_url`.
+
+## [1.1.0] - 2018-03-23
+### Added
+- Support `public` parameter for `Scnnr::Client#recognize_image`.
+- Add `Scnnr::Client#coordinate` to request `POST /v1/coordinates`.
 
 ## [1.0.0] - 2017-11-01
 ### Added
 - Allow timeouts greater than 25s when recognising images.
 
 ### Fixed
-- Fix that `Scnnr::Client#fetch` with a long timeout does not make multiple request.
+- Fix that `Scnnr::Client#fetch` with a long timeout does not make multiple requests.
 
 ### Removed
 - Remove `async` from `Scnnr::Response`.

data/Gemfile

@@ -4,18 +4,23 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem 'rake', '~> 10.0'
+gem 'rake', '~> 13.0'
 
 group :development do
   gem 'pry', '~> 0.10'
+
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
 end
 
 group :test do
   gem 'rspec', '~> 3.5'
   gem 'rspec_junit_formatter', '~> 0.3'
-  gem 'rubocop', '~> 0.49.0'
-  gem 'rubocop-junit-formatter', '~> 0.1'
-  gem 'rubocop-rspec', '~> 1.15.0'
+
+  gem 'rubocop', '~> 0.90.0'
+  gem 'rubocop-rspec', '~> 1.43.2'
+
   gem 'webmock', '~> 3.0'
 end
 

data/Guardfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -1,20 +1,28 @@
 # Official #CBK scnnr client library for Ruby.
+[![CircleCI](https://circleci.com/gh/NEWROPE/scnnr-ruby.svg?style=svg)](https://circleci.com/gh/NEWROPE/scnnr-ruby)
 
 - [#CBK scnnr](https://scnnr.cubki.jp/)
 - [API Documentation](https://api.scnnr.cubki.jp/v1/docs)
 
+## Supported Ruby versions
+- Ruby 2.4+
+
 ## Installation
+
 ### Bundler
+
 ```
 gem 'scnnr'
 ```
 
 ### Manual
+
 ```
 gem install scnnr
 ```
 
 ## Configuration
+
 You can pass configuration options as a block to `Scnnr::Client.new`.
 
 ```
@@ -28,22 +36,33 @@ end
 ```
 
 ## Examples
+
 ### Basic usage
+
+#### Recognize images
+
 Request image recognition by an image URL.
 
+Refer: [`POST /v1/remote/recognitions`](https://api.scnnr.cubki.jp/v1/docs#tag/remoterecognitions%2Fpaths%2F~1remote~1recognitions%2Fpost)
+
 ```
 url = 'https://example.com/dummy.jpg'
 recognition = client.recognize_url(url)
 
-# you can override config.timeout.
+# You can override config.timeout.
 recognition = client.recognize_url(url, timeout: 10)
 ```
 
 Request image recognition by a binary image.
 
+Refer: [`POST /v1/recognitions`](https://api.scnnr.cubki.jp/v1/docs#tag/recognitions%2Fpaths%2F~1recognitions%2Fpost)
+
 ```
 img = File.open('dummy_image_file', 'rb')
 recognition = client.recognize_image(img)
+
+# You can use public parameter as well.
+recognition = client.recognize_image(img, timeout: 10, public: true)
 ```
 
 `Recognition` class represents the image recognition result from API.
@@ -81,12 +100,47 @@ recognition.to_h
     "category"=>"dress",
     "labels"=>[{"name"=>"グリーン", "score"=>0.9765959}, {"name"=>"ワンピース", "score"=>0.94697183}, {"name"=>"カーキ", "score"=>0.8136864}, {"name"=>"無地", "score"=>0.54719794}, {"name"=>"フレア", "score"=>0.51572186}]}],
  "state"=>"finished"}
+
+# If you recognize an image with `public` parameter, the `recognition` has `image`.
+recognition.to_h
+=> {"id"=>"20170829/ed4c674c-7970-4e9c-9b26-1b6076b36b49",
+ "image"=>
+  {"url"=>"some-image-url",
+   "size"=>{"height"=>400, "width"=>400}},
+ "objects"=>
+  [{"bounding_box"=>{"bottom"=>0.2696995, "left"=>0.3842466, "right"=>0.57190025, "top"=>0.14457992},
+    "category"=>"hat",
+    "labels"=>
+     [{"name"=>"ハット", "score"=>0.9985399},
+      {"name"=>"中折れ", "score"=>0.99334323},
+      {"name"=>"ストローハット", "score"=>0.95629793},
+      {"name"=>"ベージュ", "score"=>0.9062561},
+      {"name"=>"つば広ハット", "score"=>0.7737022},
+      {"name"=>"ホワイト", "score"=>0.5695046}]},
+   {"bounding_box"=>{"bottom"=>0.95560884, "left"=>0.41641566, "right"=>0.5212327, "top"=>0.8452401},
+    "category"=>"shoe",
+    "labels"=>
+     [{"name"=>"サンダル", "score"=>0.93934095},
+      {"name"=>"ホワイト", "score"=>0.74320596},
+      {"name"=>"パンプス", "score"=>0.70763165},
+      {"name"=>"サボ", "score"=>0.69153166},
+      {"name"=>"ストラップ", "score"=>0.66519636},
+      {"name"=>"ウェッジソール", "score"=>0.6325865},
+      {"name"=>"オープントゥ", "score"=>0.61965847},
+      {"name"=>"アンクルストラップ", "score"=>0.576824},
+      {"name"=>"厚底", "score"=>0.53842664}]},
+   {"bounding_box"=>{"bottom"=>0.7018228, "left"=>0.35182703, "right"=>0.6113004, "top"=>0.25296396},
+    "category"=>"dress",
+    "labels"=>[{"name"=>"グリーン", "score"=>0.9765959}, {"name"=>"ワンピース", "score"=>0.94697183}, {"name"=>"カーキ", "score"=>0.8136864}, {"name"=>"無地", "score"=>0.54719794}, {"name"=>"フレア", "score"=>0.51572186}]}],
+ "state"=>"finished"}
 ```
 
 If the timeout value is zero or `nil`, you will get `Recognition` instance whose state is `queued`.
 
 Then you can fetch the recognition result using `Scnnr::Client#fetch`.
 
+Refer: [`GET /v1/recognitions/*`](https://api.scnnr.cubki.jp/v1/docs#tag/recognitions%2Fpaths%2F~1recognitions~1*%2Fget)
+
 ```
 recognition.queued?
 => true
@@ -99,6 +153,32 @@ recognition.finished?
 => true
 ```
 
+#### Generate fashion coordinates
+
+Request fashion coordinates generation.
+
+Refer: [`POST /v1/coordinates`](https://api.scnnr.cubki.jp/v1/docs#tag/coordinates%2Fpaths%2F~1coordinates%2Fpost)
+
+```
+tastes = { casual: 0.7, girly: 0.3 }
+coordinate = client.coordinate('tops', ['グレー', 'パーカー'], tastes, target: 3)
+
+coordinate.to_h
+=> {"items"=>
+  [{"category"=>"tops", "labels"=>[{"name"=>"グレー", "score"=>nil}, {"name"=>"パーカー", "score"=>nil}]},
+   {"category"=>"shoe",
+    "labels"=>
+     [{"name"=>"ネイビー", "score"=>nil},
+      {"name"=>"スニーカー", "score"=>nil},
+      {"name"=>"ランニング", "score"=>nil}]},
+   {"category"=>"dress",
+    "labels"=>
+     [{"name"=>"デニム", "score"=>nil},
+      {"name"=>"ブルー", "score"=>nil},
+      {"name"=>"サロペット", "score"=>nil},
+      {"name"=>"オーバーオール", "score"=>nil}]}]}
+```
+
 ### Error handling
 
 If the recognition processing is not completed within the timeout time or the recognition failed,

data/lib/scnnr.rb

@@ -2,12 +2,19 @@
 
 require 'scnnr/configuration'
 require 'scnnr/errors'
+require 'scnnr/errors/image'
+require 'scnnr/errors/image/response'
+require 'scnnr/label'
 require 'scnnr/recognition'
+require 'scnnr/recognition/image'
 require 'scnnr/recognition/object'
 require 'scnnr/recognition/object/bounding_box'
 require 'scnnr/recognition/object/label'
+require 'scnnr/coordinate'
+require 'scnnr/coordinate/item'
 require 'scnnr/client'
 require 'scnnr/connection'
+require 'scnnr/routing'
 require 'scnnr/polling_manager'
 require 'scnnr/response'
 require 'scnnr/version'

data/lib/scnnr/client.rb

@@ -5,7 +5,11 @@ module Scnnr
     require 'net/http'
     require 'json'
 
-    ENDPOINT_BASE = 'https://api.scnnr.cubki.jp'
+    TASTES = %i[
+      boyish casual celebrity conservative
+      feminine girly gyaru harajuku
+      mode natural_style
+    ].freeze
 
     def initialize
       yield(self.config) if block_given?
@@ -16,36 +20,52 @@ module Scnnr
     end
 
     def recognize_image(image, options = {})
-      PollingManager.start(self, merge_options(options)) do |opts|
-        uri = construct_uri('recognitions', opts)
+      options = merge_options options
+      PollingManager.start(self, options) do |opts|
+        uri = construct_uri('recognitions', %i[timeout public], opts)
         response = post_connection(uri, opts).send_stream(image)
-        handle_response(response)
+        Response.new(response).build_recognition
       end
     end
 
     def recognize_url(url, options = {})
-      PollingManager.start(self, merge_options(options)) do |opts|
-        uri = construct_uri('remote/recognitions', opts)
+      options = merge_options options
+      PollingManager.start(self, options) do |opts|
+        uri = construct_uri('remote/recognitions', %i[timeout force], opts)
         response = post_connection(uri, opts).send_json({ url: url })
-        handle_response(response)
+        Response.new(response).build_recognition
       end
     end
 
     def fetch(recognition_id, options = {})
+      options = merge_options options
       return request(recognition_id, options) if options.delete(:polling) == false
-      options = merge_options(options)
+
       PollingManager.new(options.delete(:timeout)).polling(self, recognition_id, options)
     end
 
+    def coordinate(category, labels, taste = {}, options = {})
+      options = merge_options options
+      uri = construct_uri('coordinates', %i[target], options)
+      payload = {
+        item: { category: category, labels: labels },
+        taste: TASTES.each_with_object({}) { |key, memo| memo[key] = taste[key] if taste[key] },
+      }
+      response = post_connection(uri, options).send_json(payload)
+      Response.new(response).build_coordinate
+    end
+
     private
 
     def merge_options(options = {})
       self.config.to_h.merge(options)
     end
 
-    def construct_uri(path, options = {})
-      options = merge_options(options)
-      URI.parse("#{ENDPOINT_BASE}/#{options[:api_version]}/#{path}?timeout=#{options[:timeout]}")
+    def construct_uri(path, allowed_params, options = {})
+      Routing.new(
+        path, options[:api_version],
+        options, allowed_params
+      ).to_url
     end
 
     def get_connection(uri, options = {})
@@ -57,15 +77,9 @@ module Scnnr
     end
 
     def request(recognition_id, options = {})
-      options = merge_options(options)
-      uri = construct_uri("recognitions/#{recognition_id}", options)
+      uri = construct_uri("recognitions/#{recognition_id}", %i[timeout], options)
       response = get_connection(uri, options).send_request
-      handle_response(response)
-    end
-
-    def handle_response(response)
-      response = Response.new(response)
-      response.build_recognition
+      Response.new(response).build_recognition
     end
   end
 end

data/lib/scnnr/configuration.rb

@@ -4,7 +4,7 @@ module Scnnr
   Configuration = Struct.new(:api_key, :api_version, :timeout, :logger) do
     require 'logger'
 
-    DEFAULT_LOGGER = Logger.new(STDOUT, level: :info)
+    DEFAULT_LOGGER = Logger.new($stdout, level: :info)
 
     def initialize
       super(nil, 'v1', 0, DEFAULT_LOGGER)

data/lib/scnnr/connection.rb

@@ -5,6 +5,15 @@ module Scnnr
     require 'net/http'
     require 'json'
 
+    RETRY_LIMIT = 3
+    RETRY_SLEEP_TIME = 1
+    RETRY_ERROR_CLASSES = [
+      Timeout::Error, Errno::EINVAL,
+      Errno::ECONNRESET, EOFError,
+      Net::HTTPBadResponse, Net::ProtocolError,
+      Net::HTTPHeaderSyntaxError
+    ].freeze
+
     def initialize(uri, method, api_key, logger)
       @uri = uri
       @method = method
@@ -28,19 +37,32 @@ module Scnnr
       end
     end
 
-    def send_request
-      block = block_given? ? Proc.new : nil
-      request = build_request(&block)
-      run_request(request)
+    def send_request(&block)
+      request = block_given? ? build_request(&block) : build_request
+      with_retries do
+        Net::HTTP.start(@uri.host, @uri.port, use_ssl: use_ssl?) do |http|
+          @logger&.info("Started #{@method.upcase} #{@uri}")
+          http.request(request)
+        end
+      end
     end
 
     private
 
-    def run_request(request)
-      Net::HTTP.start(@uri.host, @uri.port, use_ssl: use_ssl?) do |http|
-        @logger&.info("Started #{@method.upcase} #{@uri}")
-        http.request(request)
+    def with_retries
+      yield
+    rescue *RETRY_ERROR_CLASSES => e
+      retry_count ||= 0
+
+      if retry_count < RETRY_LIMIT
+        retry_count += 1
+        @logger&.info("Retrying to connect: #{@uri}, attempt: #{retry_count}")
+
+        sleep RETRY_SLEEP_TIME
+        retry
       end
+
+      raise e.class, "#{e.message} (Endpoint: #{@method.upcase} #{@uri})"
     end
 
     def use_ssl?

data/lib/scnnr/coordinate.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Scnnr
+  class Coordinate
+    attr_reader :items
+
+    def initialize(attrs = {})
+      @items = attrs['items'].map { |item| Coordinate::Item.new(item) }
+    end
+
+    def to_h
+      { 'items' => self.items.map(&:to_h) }
+    end
+  end
+end

data/lib/scnnr/coordinate/item.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Scnnr
+  class Coordinate
+    class Item
+      attr_reader :category, :labels
+
+      def initialize(attrs = {})
+        @category = attrs['category']
+        @labels = (attrs['labels'] || []).map { |label| Label.new('name' => label) }
+      end
+
+      def to_h
+        { 'category' => self.category, 'labels' => self.labels.map(&:to_h) }
+      end
+    end
+  end
+end

data/lib/scnnr/errors.rb

@@ -17,11 +17,12 @@ module Scnnr
   class RecognitionNotFound < Error; end
 
   class RecognitionFailed < Error
-    attr_accessor :recognition
+    attr_accessor :recognition, :image
 
     def initialize(recognition)
       super(recognition.error)
       @recognition = recognition
+      @image = Scnnr::Errors::Image.new(recognition.error['image']) if recognition.error['image']
     end
   end
 

data/lib/scnnr/errors/image.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Scnnr
+  module Errors
+    class Image
+      attr_accessor :url, :response
+
+      def initialize(attrs)
+        @response = Response.new(attrs['response'])
+        @url = attrs['url']
+      end
+    end
+  end
+end

data/lib/scnnr/errors/image/response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Scnnr
+  module Errors
+    class Image
+      class Response
+        attr_accessor :status
+
+        def initialize(attrs)
+          @status = attrs['status']
+        end
+      end
+    end
+  end
+end

data/lib/scnnr/label.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Scnnr
+  class Label
+    attr_reader :name, :score
+
+    def initialize(attrs = {})
+      @name = attrs['name']
+      @score = attrs['score']
+    end
+
+    def to_h
+      { 'name' => self.name, 'score' => self.score }
+    end
+  end
+end

data/lib/scnnr/recognition.rb

@@ -2,10 +2,11 @@
 
 module Scnnr
   class Recognition
-    attr_reader :id, :objects, :state, :error
+    attr_reader :id, :image, :objects, :state, :error
 
     def initialize(attrs = {})
       @id = attrs['id']
+      @image = Image.new(attrs['image']) if attrs['image']
       @objects = (attrs['objects'] || []).map { |obj| Object.new(obj) }
       @state = attrs['state']&.intern
       @error = attrs['error']
@@ -24,7 +25,12 @@ module Scnnr
     end
 
     def to_h
-      { 'id' => self.id, 'objects' => self.objects.map(&:to_h), 'state' => self.state.to_s }
+      {
+        'id' => self.id,
+        'image' => self.image&.to_h,
+        'objects' => self.objects.map(&:to_h),
+        'state' => self.state.to_s,
+      }
     end
   end
 end

data/lib/scnnr/recognition/image.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Scnnr
+  class Recognition
+    class Image
+      attr_reader :url, :size
+
+      def initialize(attrs = {})
+        @url = attrs['url']
+        @size = attrs['size']
+      end
+
+      def to_h
+        { 'url' => self.url, 'size' => self.size }
+      end
+    end
+  end
+end

data/lib/scnnr/recognition/object.rb

@@ -8,7 +8,7 @@ module Scnnr
       def initialize(attrs = {})
         @bounding_box = BoundingBox.new(attrs['bounding_box'])
         @category = attrs['category']
-        @labels = (attrs['labels'] || []).map { |label| Label.new(label) }
+        @labels = (attrs['labels'] || []).map { |label| Scnnr::Label.new(label) }
       end
 
       def to_h

data/lib/scnnr/recognition/object/label.rb

@@ -3,16 +3,10 @@
 module Scnnr
   class Recognition
     class Object
-      class Label
-        attr_reader :name, :score
-
-        def initialize(attrs = {})
-          @name = attrs['name']
-          @score = attrs['score']
-        end
-
-        def to_h
-          { 'name' => self.name, 'score' => self.score }
+      class Label < Scnnr::Label
+        def initialize(*args)
+          warn "[DEPRECATION] `#{self.class.name}` is deprecated. Please use `Scnnr::Label` instead."
+          super
         end
       end
     end

data/lib/scnnr/response.rb

@@ -6,6 +6,7 @@ module Scnnr
 
     def initialize(response)
       raise UnexpectedError, response if response.content_type != SUPPORTED_CONTENT_TYPE
+
       @response = response
     end
 
@@ -18,13 +19,14 @@ module Scnnr
     end
 
     def build_recognition
-      case @response
-      when Net::HTTPSuccess
-        recognition = Recognition.new(self.parsed_body)
-        handle_recognition(recognition)
-      else
-        handle_error
-      end
+      raise_error_response unless @response.is_a? Net::HTTPSuccess
+      recognition = Recognition.new(self.parsed_body)
+      handle_recognition(recognition)
+    end
+
+    def build_coordinate
+      raise_error_response unless @response.is_a? Net::HTTPSuccess
+      Coordinate.new(self.parsed_body)
     end
 
     private
@@ -35,11 +37,13 @@ module Scnnr
       case recognition.error['type']
       when 'unexpected-content', 'bad-request'
         raise RequestFailed, recognition.error
-      else raise RecognitionFailed, recognition
+      when 'download-timeout', 'invalid-image', 'download-failed'
+        raise RecognitionFailed, recognition
+      else raise UnexpectedError, @response
       end
     end
 
-    def handle_error
+    def raise_error_response
       case @response
       when Net::HTTPNotFound
         raise RecognitionNotFound, self.parsed_body

data/lib/scnnr/routing.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Scnnr
+  class Routing
+    API_SCHEME = URI::HTTPS
+    API_HOST = 'api.scnnr.cubki.jp'
+
+    attr_reader :path_prefix
+
+    def initialize(path, path_prefix, params, allowed_params)
+      @path = path
+      @path_prefix = path_prefix
+      @queries = build_queries params, allowed_params
+    end
+
+    def to_url
+      API_SCHEME.build(
+        host: API_HOST,
+        path: self.path,
+        query: query_string
+      )
+    end
+
+    def queries
+      @queries.reject { |_, val| val.nil? }
+    end
+
+    def path
+      "/#{[self.path_prefix, @path]
+        .map { |value| value.sub(%r{\A/}, '').sub(%r{/\z}, '') }
+        .join('/')}"
+    end
+
+    private
+
+    def query_string
+      params = self.queries
+      return if params.empty?
+
+      params
+        .map { |pair| pair.map { |val| URI.encode_www_form_component val }.join('=') }
+        .join('&')
+    end
+
+    def build_queries(params, allowed_params)
+      {}.tap do |queries|
+        (allowed_params || []).each do |param|
+          case param.intern
+          when :timeout then queries[:timeout] = params[:timeout] if params[:timeout]&.positive?
+          else queries[param] = params[param]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scnnr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Scnnr
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/scnnr.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'scnnr/version'
 
@@ -23,5 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+
+  spec.required_ruby_version = '>= 2.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scnnr
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - NEWROPE Co. Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-02 00:00:00.000000000 Z
+date: 2020-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
 description: 'Official #CBK scnnr client library for Ruby.'
 email:
 - support@newrope.biz
@@ -39,6 +39,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -48,13 +49,20 @@ files:
 - lib/scnnr/client.rb
 - lib/scnnr/configuration.rb
 - lib/scnnr/connection.rb
+- lib/scnnr/coordinate.rb
+- lib/scnnr/coordinate/item.rb
 - lib/scnnr/errors.rb
+- lib/scnnr/errors/image.rb
+- lib/scnnr/errors/image/response.rb
+- lib/scnnr/label.rb
 - lib/scnnr/polling_manager.rb
 - lib/scnnr/recognition.rb
+- lib/scnnr/recognition/image.rb
 - lib/scnnr/recognition/object.rb
 - lib/scnnr/recognition/object/bounding_box.rb
 - lib/scnnr/recognition/object/label.rb
 - lib/scnnr/response.rb
+- lib/scnnr/routing.rb
 - lib/scnnr/version.rb
 - scnnr.gemspec
 homepage: https://github.com/NEWROPE/scnnr-ruby
@@ -69,15 +77,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: ''