scnnr 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 235c38c591c2c703be24918f4036a1a5164682190757d79c5be8288bf293728f
-  data.tar.gz: 18f5a090fe68f2dc4d7e70529a3045085891ea12e3e8ad4dbf92e13c8db0eae0
+  metadata.gz: 5cb9874e1854429b787e165fbff198da0e2992ae506a6a84f0c85f42199701d0
+  data.tar.gz: 8c59dba0786ab878aef02294606f10fde6eb06fb154ea39ad8473eb8b498e02a
 SHA512:
-  metadata.gz: 3533faddd548618a744923f3790cd8cc6f46fa3fd73e0bb1b28bc45bd4df94940b187b025ba51e43332080976b3172c06fc44c8140a5e14c7352b15783c4c835
-  data.tar.gz: 345aaeb08008708d78cf2ab8b473f04d6261d227c1f2ec54e6e6a5e27b909179f906feec1644139b14d319f96649e5c63866b216934d3f0dc5f11fa1571ebb9d
+  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,27 +32,27 @@ jobs:
       - store_artifacts:
           path: /tmp/test-results
           destination: test-results
-  ruby-2.3:
-    <<: *build
-    docker:
-      - image: circleci/ruby:2.3
-  ruby-2.4:
+  ruby-24:
     <<: *build
     docker:
       - image: circleci/ruby:2.4
-  ruby-2.5:
+  ruby-25:
     <<: *build
     docker:
       - image: circleci/ruby:2.5
-  ruby-2.6:
+  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
-      - ruby-2.4
-      - ruby-2.5
-      - ruby-2.6
+      - 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,6 +4,15 @@ 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`.

data/Gemfile

@@ -4,7 +4,7 @@ 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'
@@ -18,9 +18,8 @@ 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/README.md

@@ -5,7 +5,7 @@
 - [API Documentation](https://api.scnnr.cubki.jp/v1/docs)
 
 ## Supported Ruby versions
-- Ruby 2.3+
+- Ruby 2.4+
 
 ## Installation
 

data/lib/scnnr.rb

@@ -2,6 +2,8 @@
 
 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'

data/lib/scnnr/client.rb

@@ -40,6 +40,7 @@ module Scnnr
     def fetch(recognition_id, options = {})
       options = merge_options options
       return request(recognition_id, options) if options.delete(:polling) == false
+
       PollingManager.new(options.delete(:timeout)).polling(self, recognition_id, options)
     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

@@ -37,9 +37,8 @@ module Scnnr
       end
     end
 
-    def send_request
-      block = block_given? ? Proc.new : nil
-      request = build_request(&block)
+    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}")

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/response.rb

@@ -6,6 +6,7 @@ module Scnnr
 
     def initialize(response)
       raise UnexpectedError, response if response.content_type != SUPPORTED_CONTENT_TYPE
+
       @response = response
     end
 
@@ -36,7 +37,9 @@ 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
 

data/lib/scnnr/routing.rb

@@ -26,9 +26,9 @@ module Scnnr
     end
 
     def path
-      '/' + [self.path_prefix, @path]
+      "/#{[self.path_prefix, @path]
         .map { |value| value.sub(%r{\A/}, '').sub(%r{/\z}, '') }
-        .join('/')
+        .join('/')}"
     end
 
     private
@@ -36,6 +36,7 @@ module Scnnr
     def query_string
       params = self.queries
       return if params.empty?
+
       params
         .map { |pair| pair.map { |val| URI.encode_www_form_component val }.join('=') }
         .join('&')

data/lib/scnnr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Scnnr
-  VERSION = '1.3.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.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - NEWROPE Co. Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-30 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
@@ -52,6 +52,8 @@ files:
 - 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
@@ -75,14 +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: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: ''