scnnr 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d5ce96021afa8ae437e4a7b23cdb7018bfc0202
-  data.tar.gz: e06b41c303d7f2949b8ac542454e6e40ffa77ed3
+  metadata.gz: 63bcc0cea5fbfb536f2ebd9b87623f7ec943b68e
+  data.tar.gz: 295d5b100e0cd86ffcaaad0e815f28276c063597
 SHA512:
-  metadata.gz: ea14db49ec5b7f1e671444ef7715015030133c4b4e2eaa533bb8bb6c66539db2beb20280725e47f3948178c6ff24094e430558edece68868a432de258fdac124
-  data.tar.gz: 005662bd30ebb39ad6065b2208b24c7c8301cd04123cf17b3175e7cd4bc1dee0501dd88250244e788073c4e561bc8af5e5cea71863176fbfbe91a54c27852242
+  metadata.gz: 5659d4858fdce6480279c9d988f61813ccfd852c7eba5e366913ec4d7583d5eccd14f19182d54032f0eb91bb1eb0f1bdb1e1a524f8b7b36713c3121aab3db46b
+  data.tar.gz: 9880c8a857b3bd38ec11bd19c4b80d73a9f242cea72585ddc9f6108897f6be63890ccbda5e6306c45b2136a43bbc3196571feec63b90dce900ea5ca3e21e37e1

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+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).
+
+## [0.2.0] - 2017-10-20
+### Added
+- Add reference links to README.
+
+### Fixed
+- Fix the client specs to make them easier to understand.
+- Fix to handle `unexpected-content` and `bad-request` API errors.
+
+### Changed
+- Rename `UnsupportedError` -> `UnexpectedError`.
+
+## [0.1.0] - 2017-09-21
+### Added
+- Initial release of scnnr-ruby.

data/README.md

@@ -1,5 +1,8 @@
 # Official #CBK scnnr client library for Ruby.
 
+- [#CBK scnnr](https://scnnr.cubki.jp/)
+- [API Documentation](https://api.scnnr.cubki.jp/v1/docs)
+
 ## Installation
 ### Bundler
 ```
@@ -113,15 +116,15 @@ 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)"
+  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)"
+  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)"
+  STDERR.puts "[ERROR] #{e.title}: #{e.detail} #{e.type}"
 rescue => e
   # Unexpected error.
   raise

data/lib/scnnr/errors.rb

@@ -4,8 +4,8 @@ module Scnnr
   class Error < StandardError
     attr_accessor :detail, :title, :type
 
-    def initialize(message, attrs)
-      super(message)
+    def initialize(attrs)
+      super(attrs['detail'])
       @detail = attrs['detail']
       @title = attrs['title']
       @type = attrs['type']
@@ -19,8 +19,8 @@ module Scnnr
   class RecognitionFailed < Error
     attr_accessor :recognition
 
-    def initialize(message, recognition)
-      super(message, recognition.error)
+    def initialize(recognition)
+      super(recognition.error)
       @recognition = recognition
     end
   end
@@ -34,7 +34,7 @@ module Scnnr
     end
   end
 
-  class UnsupportedError < StandardError
+  class UnexpectedError < StandardError
     attr_accessor :response
 
     def initialize(response)

data/lib/scnnr/response.rb

@@ -5,7 +5,7 @@ module Scnnr
     SUPPORTED_CONTENT_TYPE = 'application/jp.cubki.scnnr.v1+json'
 
     def initialize(response, async)
-      raise UnsupportedError, response if response.content_type != SUPPORTED_CONTENT_TYPE
+      raise UnexpectedError, response if response.content_type != SUPPORTED_CONTENT_TYPE
       @response = response
       @async = async
     end
@@ -36,17 +36,22 @@ module Scnnr
 
     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
+      return recognition unless recognition.error?
+
+      case recognition.error['type']
+      when 'unexpected-content', 'bad-request'
+        raise RequestFailed, recognition.error
+      else raise RecognitionFailed, recognition
+      end
     end
 
     def handle_error
       case @response
       when Net::HTTPNotFound
-        raise RecognitionNotFound.new('recognition not found', self.parsed_body)
+        raise RecognitionNotFound, self.parsed_body
       when Net::HTTPUnprocessableEntity
-        raise RequestFailed.new('failed to reserve the recognition', self.parsed_body)
-      else raise UnsupportedError, @response
+        raise RequestFailed, self.parsed_body
+      else raise UnexpectedError, @response
       end
     end
   end

data/lib/scnnr/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scnnr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - NEWROPE Co. Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2017-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -36,6 +36,7 @@ files:
 - ".circleci/config.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE