scnnr 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 701520f0f2410d7300d04bac498aec68db34597f
-  data.tar.gz: 15d6e7b77a2ad5c91d96fa302d4eb1fc800792f3
+  metadata.gz: bd33e72ddd88f87380fb7e690b9d24065f5c8130
+  data.tar.gz: e32a656bdf4f46aa0f367ae63aa35e2357bcac54
 SHA512:
-  metadata.gz: 99379cccbdb705692acd048f32355638b4084c19071c7c2833604fb1356164a36982aab1e7aa505d66495650524faf1d88d492e2eb854308b38b052ed821d0c0
-  data.tar.gz: ab1d3a36414710519e793259a1a9f655da7c6333971ac145e834bbb62fe02257985092cfd54568c78dd6aa86b4947e5961c9270adf44618adae7a121dba6c62b
+  metadata.gz: fedf81404ac294b6abdfe54b63b31c76407da144fac72f93fe3875b3e7af59af74068f152b7cc45002618c22afcda25a4a8848a2b531b2a1ff86d0a0f537cc6d
+  data.tar.gz: be1b7eab268b70f526241ffc23d02f732b676dc95dbe7ea1bd24573e365e9b8f0f95d566aea6f35ccc2a7714499ff88c8723060fa8078a7748edf49293461c78

data/CHANGELOG.md

@@ -4,13 +4,17 @@ 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).
 
+## [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

@@ -8,14 +8,20 @@ gem 'rake', '~> 10.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 '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

@@ -28,14 +28,18 @@ end
 ```
 
 ## Examples
+
 ### Basic usage
+
+#### Recognize images
+
 Request image recognition by an image URL.
 
 ```
 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)
 ```
 
@@ -44,6 +48,9 @@ Request image recognition by a binary image.
 ```
 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,6 +88,39 @@ 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`.
@@ -99,6 +139,29 @@ recognition.finished?
 => true
 ```
 
+#### Generate fashion coordinates
+
+Request fashion coordinates generation.
+
+```
+coordinate = client.coordinate('tops', ['グレー', 'パーカー'], casual: 0.7, girly: 0.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/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,51 @@ 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], 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[], 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 +76,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/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/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/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/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/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/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.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/response.rb

@@ -18,13 +18,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
@@ -39,7 +40,7 @@ module Scnnr
       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,55 @@
+# 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 = '1.1.0'
 end

data/lib/scnnr.rb

@@ -2,12 +2,17 @@
 
 require 'scnnr/configuration'
 require 'scnnr/errors'
+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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scnnr
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - NEWROPE Co. Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-02 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,6 +39,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -48,13 +49,18 @@ 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/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
@@ -77,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: ''