scnnr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d5ce96021afa8ae437e4a7b23cdb7018bfc0202
+  data.tar.gz: e06b41c303d7f2949b8ac542454e6e40ffa77ed3
+SHA512:
+  metadata.gz: ea14db49ec5b7f1e671444ef7715015030133c4b4e2eaa533bb8bb6c66539db2beb20280725e47f3948178c6ff24094e430558edece68868a432de258fdac124
+  data.tar.gz: 005662bd30ebb39ad6065b2208b24c7c8301cd04123cf17b3175e7cd4bc1dee0501dd88250244e788073c4e561bc8af5e5cea71863176fbfbe91a54c27852242

data/.circleci/config.yml

@@ -0,0 +1,46 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build: &build
+    docker:
+      - image: ruby
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+      # 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 rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+  ruby-2.3.5:
+    <<: *build
+    docker:
+      - image: circleci/ruby:2.3.5-node-browsers
+  ruby-2.4.1:
+    <<: *build
+    docker:
+      - image: circleci/ruby:2.4.1-node-browsers
+workflows:
+  version: 2
+  ruby-multi-build:
+    jobs:
+      - ruby-2.3.5
+      - ruby-2.4.1

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.rspec_status
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1,67 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/BlockLength:
+  Max: 25
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - 'scnnr.gemspec'
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_parentheses
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    reduce: inject
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/Documentation:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 5
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/AnyInstance:
+  Exclude:
+    - 'spec/scnnr/connection_spec.rb'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at support@newrope.biz. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem 'rake', '~> 10.0'
+
+group :development do
+  gem 'pry', '~> 0.10'
+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 'webmock', '~> 3.0'
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 NEWROPE Co. Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,129 @@
+# Official #CBK scnnr client library for Ruby.
+
+## Installation
+### Bundler
+```
+gem 'scnnr'
+```
+
+### Manual
+```
+gem install scnnr
+```
+
+## Configuration
+You can pass configuration options as a block to `Scnnr::Client.new`.
+
+```
+client = Scnnr::Client.new do |config|
+  config.api_key = 'YOUR API KEY'
+  config.api_version = 'v1'
+  config.timeout = 0 # sec
+  config.logger = Logger.new(STDOUT) # You can specify an alternative logger.
+  config.logger.level = :info # You can change the default log level.
+end
+```
+
+## Examples
+### Basic usage
+Request image recognition by an image URL.
+
+```
+url = 'https://example.com/dummy.jpg'
+recognition = client.recognize_url(url)
+
+# you can override config.timeout.
+recognition = client.recognize_url(url, timeout: 10)
+```
+
+Request image recognition by a binary image.
+
+```
+img = File.open('dummy_image_file', 'rb')
+recognition = client.recognize_image(img)
+```
+
+`Recognition` class represents the image recognition result from API.
+If the recognition processing is completed, you will get `Recognition` instance whose state is `finished`.
+
+```
+recognition.finished?
+=> true
+
+recognition.to_h
+=> {"id"=>"20170829/ed4c674c-7970-4e9c-9b26-1b6076b36b49",
+ "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`.
+
+```
+recognition.queued?
+=> true
+
+recognition.to_h
+=> {"id"=>"20170829/ed4c674c-7970-4e9c-9b26-1b6076b36b49", "state"=>"queued"}
+
+recognition = client.fetch(recognition.id)
+recognition.finished?
+=> true
+```
+
+### Error handling
+
+If the recognition processing is not completed within the timeout time or the recognition failed,
+you will get an error with `Recognition` instance.
+
+```
+begin
+  url = 'https://example.com/dummy.jpg'
+  recognition = client.recognize_url(url, timeout: 10)
+rescue Scnnr::TimeoutError => e
+  # You can fetch the result just like when the timeout value is zero or nil.
+  recognition = client.fetch(e.recognition.id, timeout: 10)
+  recognition.finished? # => true or false
+rescue Scnnr::RecognitionFailed => e
+  # Failed to recognize the image you requested.
+  recognition = e.recognition
+  recognition.error? # => true
+  STDERR.puts "[ERROR] #{e.title}: #{e.detail} (e.type)"
+rescue Scnnr::RequestFailed => e
+  # Failed to reserve the recognition.
+  # This kind of errors have no `#recognition` field.
+  STDERR.puts "[ERROR] #{e.title}: #{e.detail} (e.type)"
+rescue Scnnr::RecognitionNotFound => e
+  # Failed to find the recognition with the specified ID.
+  # This kind of errors have no `#recognition` field.
+  STDERR.puts "[ERROR] #{e.title}: #{e.detail} (e.type)"
+rescue => e
+  # Unexpected error.
+  raise
+end
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'scnnr'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start
+
+# require 'irb'
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/scnnr.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'scnnr/configuration'
+require 'scnnr/errors'
+require 'scnnr/recognition'
+require 'scnnr/recognition/object'
+require 'scnnr/recognition/object/bounding_box'
+require 'scnnr/recognition/object/label'
+require 'scnnr/client'
+require 'scnnr/connection'
+require 'scnnr/polling_manager'
+require 'scnnr/response'
+require 'scnnr/version'

data/lib/scnnr/client.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Scnnr
+  class Client
+    require 'net/http'
+    require 'json'
+
+    ENDPOINT_BASE = 'https://api.scnnr.cubki.jp'
+
+    def initialize
+      yield(self.config) if block_given?
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def recognize_image(image, options = {})
+      options = merge_options(options)
+      uri = construct_uri('recognitions', options)
+      # TODO: Use PollingManager to be accepted timeout > 25
+      response = post_connection(uri, options).send_stream(image)
+      handle_response(response, options)
+    end
+
+    def recognize_url(url, options = {})
+      options = merge_options(options)
+      uri = construct_uri('remote/recognitions', options)
+      # TODO: Use PollingManager to be accepted timeout > 25
+      response = post_connection(uri, options).send_json({ url: url })
+      handle_response(response, options)
+    end
+
+    def fetch(recognition_id, 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
+
+    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]}")
+    end
+
+    def get_connection(uri, options = {})
+      Connection.new(uri, :get, nil, options[:logger])
+    end
+
+    def post_connection(uri, options = {})
+      Connection.new(uri, :post, options[:api_key], options[:logger])
+    end
+
+    def request(recognition_id, options = {})
+      options = merge_options(options)
+      uri = construct_uri("recognitions/#{recognition_id}", options)
+      response = get_connection(uri, options).send_request
+      handle_response(response, options)
+    end
+
+    def handle_response(response, options = {})
+      response = Response.new(response, options[:timeout].positive?)
+      response.build_recognition
+    end
+  end
+end

data/lib/scnnr/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Scnnr
+  Configuration = Struct.new(:api_key, :api_version, :timeout, :logger) do
+    require 'logger'
+
+    DEFAULT_LOGGER = Logger.new(STDOUT, level: :info)
+
+    def initialize
+      super(nil, 'v1', 0, DEFAULT_LOGGER)
+    end
+  end
+end

data/lib/scnnr/connection.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Scnnr
+  class Connection
+    require 'net/http'
+    require 'json'
+
+    def initialize(uri, method, api_key, logger)
+      @uri = uri
+      @method = method
+      @api_key = api_key
+      @logger = logger
+    end
+
+    def send_stream(stream)
+      send_request do |req|
+        req['Content-Type'] = 'application/octet-stream'
+        req['Transfer-Encoding'] = 'chunked'
+        req.body_stream = stream
+      end
+    end
+
+    def send_json(data)
+      data = data.to_json if data.is_a?(Hash)
+      send_request do |req|
+        req['Content-Type'] = 'application/json'
+        req.body = data
+      end
+    end
+
+    def send_request
+      block = block_given? ? Proc.new : nil
+      request = build_request(&block)
+      run_request(request)
+    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)
+      end
+    end
+
+    def use_ssl?
+      @uri.scheme == 'https'
+    end
+
+    def build_request
+      request =
+        case @method&.intern
+        when :get then Net::HTTP::Get.new(@uri.request_uri)
+        when :post then Net::HTTP::Post.new(@uri.request_uri)
+        else raise NotImplementedError
+        end
+      yield(request) if block_given?
+      request['x-api-key'] = @api_key if @api_key
+      request
+    end
+  end
+end

data/lib/scnnr/errors.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Scnnr
+  class Error < StandardError
+    attr_accessor :detail, :title, :type
+
+    def initialize(message, attrs)
+      super(message)
+      @detail = attrs['detail']
+      @title = attrs['title']
+      @type = attrs['type']
+    end
+  end
+
+  class RequestFailed < Error; end
+
+  class RecognitionNotFound < Error; end
+
+  class RecognitionFailed < Error
+    attr_accessor :recognition
+
+    def initialize(message, recognition)
+      super(message, recognition.error)
+      @recognition = recognition
+    end
+  end
+
+  class TimeoutError < StandardError
+    attr_accessor :recognition
+
+    def initialize(message, recognition)
+      super(message)
+      @recognition = recognition
+    end
+  end
+
+  class UnsupportedError < StandardError
+    attr_accessor :response
+
+    def initialize(response)
+      super(response.body)
+      @response = response
+    end
+  end
+end

data/lib/scnnr/polling_manager.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Scnnr
+  class PollingManager
+    MAX_TIMEOUT = 25
+
+    attr_accessor :timeout
+
+    def initialize(timeout)
+      case timeout
+      when Integer, Float::INFINITY then @timeout = timeout
+      else
+        raise ArgumentError, "timeout must be Integer or Float::INFINITY, but given: #{timeout}"
+      end
+    end
+
+    def remain_timeout?
+      self.timeout.positive?
+    end
+
+    def polling(client, recognition_id, options = {})
+      loop do
+        timeout = [self.timeout, MAX_TIMEOUT].min
+        self.timeout -= timeout
+        recognition = client.fetch(recognition_id, options.merge(timeout: timeout, polling: false))
+        break recognition if recognition.finished? || !self.remain_timeout?
+      end
+    end
+  end
+end

data/lib/scnnr/recognition.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Scnnr
+  class Recognition
+    attr_reader :id, :objects, :state, :error
+
+    def initialize(attrs = {})
+      @id = attrs['id']
+      @objects = (attrs['objects'] || []).map { |obj| Object.new(obj) }
+      @state = attrs['state']&.intern
+      @error = attrs['error']
+    end
+
+    def queued?
+      self.state == :queued
+    end
+
+    def finished?
+      self.state == :finished
+    end
+
+    def error?
+      self.state == :error
+    end
+
+    def to_h
+      { 'id' => self.id, 'objects' => self.objects.map(&:to_h), 'state' => self.state.to_s }
+    end
+  end
+end

data/lib/scnnr/recognition/object.rb

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

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Scnnr
+  class Recognition
+    class Object
+      class BoundingBox
+        attr_reader :bottom, :left, :right, :top
+
+        def initialize(attrs = {})
+          @bottom = attrs['bottom']
+          @left = attrs['left']
+          @right = attrs['right']
+          @top = attrs['top']
+        end
+
+        def to_h
+          { 'bottom' => self.bottom, 'left' => self.left, 'right' => self.right, 'top' => self.top }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+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 }
+        end
+      end
+    end
+  end
+end

data/lib/scnnr/response.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Scnnr
+  class Response
+    SUPPORTED_CONTENT_TYPE = 'application/jp.cubki.scnnr.v1+json'
+
+    def initialize(response, async)
+      raise UnsupportedError, response if response.content_type != SUPPORTED_CONTENT_TYPE
+      @response = response
+      @async = async
+    end
+
+    def body
+      @body ||= @response.body
+    end
+
+    def parsed_body
+      @parsed_body ||= JSON.parse(self.body)
+    end
+
+    def async?
+      @async == true
+    end
+
+    def build_recognition
+      case @response
+      when Net::HTTPSuccess
+        recognition = Recognition.new(self.parsed_body)
+        handle_recognition(recognition)
+      else
+        handle_error
+      end
+    end
+
+    private
+
+    def handle_recognition(recognition)
+      raise TimeoutError.new('recognition timed out', recognition) if recognition.queued? && async?
+      raise RecognitionFailed.new('recognition failed', recognition) if recognition.error?
+      recognition
+    end
+
+    def handle_error
+      case @response
+      when Net::HTTPNotFound
+        raise RecognitionNotFound.new('recognition not found', self.parsed_body)
+      when Net::HTTPUnprocessableEntity
+        raise RequestFailed.new('failed to reserve the recognition', self.parsed_body)
+      else raise UnsupportedError, @response
+      end
+    end
+  end
+end

data/lib/scnnr/version.rb

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

data/scnnr.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scnnr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'scnnr'
+  spec.version       = Scnnr::VERSION
+  spec.authors       = ['NEWROPE Co. Ltd.']
+  spec.email         = ['support@newrope.biz']
+
+  spec.summary       = spec.description
+  spec.description   = 'Official #CBK scnnr client library for Ruby.'
+  spec.homepage      = 'https://github.com/NEWROPE/scnnr-ruby'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: scnnr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- NEWROPE Co. Ltd.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: 'Official #CBK scnnr client library for Ruby.'
+email:
+- support@newrope.biz
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/scnnr.rb
+- lib/scnnr/client.rb
+- lib/scnnr/configuration.rb
+- lib/scnnr/connection.rb
+- lib/scnnr/errors.rb
+- lib/scnnr/polling_manager.rb
+- lib/scnnr/recognition.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/version.rb
+- scnnr.gemspec
+homepage: https://github.com/NEWROPE/scnnr-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []