riiif 0.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30f471dbabbb6d626cbc8477de2490b0ed732b8e
-  data.tar.gz: de3732ff0b0d71d96474e650fc1e72df8564e772
+  metadata.gz: 5cbaa7e8d7dc7e47f05b3ed955c3710c8775faac
+  data.tar.gz: 7a3564aee52673c50d30999b07aedf6543eaa854
 SHA512:
-  metadata.gz: b704b4e3a0c8fbda79a78b040f1d6dec12db688932ccdbfdaa8ce7b74419aa1a152930d6e2e7eeec2dfbaa51d52b77853651381a4709cb4f50164428f60f5092
-  data.tar.gz: 711c3a7639ac468462b88fbabe5840f0a6fe6c2bedd51a300bbd19404ff8dffca8a29d585a365a59cbe41db9fd4c453b4a91e84cf531a74172acab6fa11238c2
+  metadata.gz: ab9dbd8ff0384e995595dca5bba8a8feb17a71535664cc79b5dba36fd2b55940ffe1ff80f2cbe68080c8177d2c54d9aea8480a51f0dff623647ad5885c681a1e
+  data.tar.gz: ae18e3a8d769bb6f1f130b87b9ed9bc78af32887839d3e54cb60e770e8cd8e884b89f4ec629f9e725ab40dc5421cee31cc750f08a356ea7b02043428110f2d29

data/.rubocop_todo.yml

@@ -1,7 +1,6 @@
-require: rubocop-rspec
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-07-11 08:45:16 -0500 using RuboCop version 0.41.2.
+# on 2017-01-24 17:33:24 -0500 using RuboCop version 0.47.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -25,16 +24,26 @@ Lint/UselessAssignment:
   Exclude:
     - 'app/models/riiif/file.rb'
 
-# Offense count: 5
+# Offense count: 4
 Metrics/AbcSize:
-  Max: 28
+  Max: 38
+
+# Offense count: 12
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 143
 
 # Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 103
+
+# Offense count: 2
 Metrics/CyclomaticComplexity:
   Max: 8
 
-# Offense count: 65
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# Offense count: 68
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 160
@@ -42,9 +51,9 @@ Metrics/LineLength:
 # Offense count: 7
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 17
+  Max: 21
 
-# Offense count: 1
+# Offense count: 2
 Metrics/PerceivedComplexity:
   Max: 9
 
@@ -54,26 +63,11 @@ Performance/RedundantMatch:
   Exclude:
     - 'lib/riiif/file_system_file_resolver.rb'
 
-# Offense count: 1
-RSpec/DescribeClass:
-  Exclude:
-    - 'spec/routing/resize_routes_spec.rb'
-
-# Offense count: 6
-# Configuration parameters: Max.
-RSpec/ExampleLength:
-  Exclude:
-    - 'spec/controllers/riiif/images_controller_spec.rb'
-    - 'spec/models/riiif/http_file_resolver_spec.rb'
-
-# Offense count: 4
-RSpec/VerifiedDoubles:
-  Exclude:
-    - 'spec/controllers/riiif/images_controller_spec.rb'
-
 # Offense count: 3
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle, SupportedLastArgumentHashStyles.
+# Configuration parameters: EnforcedHashRocketStyle, SupportedHashRocketStyles, EnforcedColonStyle, SupportedColonStyles, EnforcedLastArgumentHashStyle, SupportedLastArgumentHashStyles.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
 # SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
 Style/AlignHash:
   Exclude:
@@ -100,7 +94,7 @@ Style/ColonMethodCall:
   Exclude:
     - 'lib/riiif/http_file_resolver.rb'
 
-# Offense count: 13
+# Offense count: 14
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
@@ -109,6 +103,7 @@ Style/Documentation:
     - 'app/models/riiif/file.rb'
     - 'app/models/riiif/image.rb'
     - 'lib/riiif.rb'
+    - 'lib/riiif/abstract_file_system_resolver.rb'
     - 'lib/riiif/akubra_system_file_resolver.rb'
     - 'lib/riiif/engine.rb'
     - 'lib/riiif/file_system_file_resolver.rb'
@@ -117,26 +112,24 @@ Style/Documentation:
     - 'lib/riiif/rails/routes.rb'
     - 'lib/riiif/routes.rb'
 
-# Offense count: 3
+# Offense count: 2
 # Cop supports --auto-correct.
 Style/EmptyLines:
   Exclude:
     - 'app/models/riiif/image.rb'
-    - 'lib/riiif/file_system_file_resolver.rb'
     - 'lib/riiif/http_file_resolver.rb'
 
-# Offense count: 6
+# Offense count: 5
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: empty_lines, no_empty_lines
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
 Style/EmptyLinesAroundClassBody:
   Exclude:
     - 'app/models/riiif/file.rb'
     - 'app/models/riiif/image.rb'
-    - 'lib/riiif/file_system_file_resolver.rb'
     - 'lib/riiif/http_file_resolver.rb'
 
-# Offense count: 3
+# Offense count: 5
 # Cop supports --auto-correct.
 Style/EmptyLinesAroundMethodBody:
   Exclude:
@@ -150,4 +143,3 @@ Style/EmptyLinesAroundMethodBody:
 Style/ExtraSpacing:
   Exclude:
     - 'lib/riiif/routes.rb'
-

data/.travis.yml

@@ -1,8 +1,11 @@
 notifications:
   email: false
 
+before_install:
+  - gem update --system
+
 rvm:
-  - 2.2
+  - 2.4.0
 
 sudo: false
 language: ruby

data/README.md

@@ -7,13 +7,13 @@ A Ruby IIIF image server as a rails engine
 
 RIIIF depends on Imagemagick so you must install that first. On a mac using Homebrew you can follow these instructions:
 
-ImageMagick (6.8.8) may be installed with a few options:
+ImageMagick (7.0.4) may be installed with a few options:
 * `--with-ghostscript` Compile with Ghostscript for Postscript/PDF support
 * `--with-tiff` Compile with libtiff support for TIFF files
-* `--with-jp2` Compile with openjpeg2 support for jpeg2000
+* `--with-openjpeg` Compile with openjpeg2 support for jpeg2000
 
 ```bash
-brew install imagemagick --with-ghostscript --with-tiff --with-jp2
+brew install imagemagick --with-ghostscript --with-tiff --with-openjpeg
 ```
 
 ## Install the gem

data/app/controllers/riiif/images_controller.rb

@@ -1,9 +1,9 @@
 module Riiif
   class ImagesController < ::ApplicationController
-    before_filter :link_header, only: [:show, :info]
+    before_action :link_header, only: [:show, :info]
 
     rescue_from Riiif::InvalidAttributeError do
-      render nothing: true, status: 400
+      head 400
     end
 
     def show
@@ -20,7 +20,7 @@ module Riiif
 
       image = not_found_image unless status == :ok
 
-      data = image.render(params.permit(:region, :size, :rotation, :quality, :format))
+      data = image.render(image_request_params)
       headers['Access-Control-Allow-Origin'] = '*'
       send_data data,
                 status: status,
@@ -56,6 +56,12 @@ module Riiif
         params[:id]
       end
 
+      ##
+      # @return [ActiveSupport::HashWithIndifferentAccess]
+      def image_request_params
+        params.permit(:region, :size, :rotation, :quality, :format).to_h
+      end
+
       def authorization_service
         model.authorization_service.new(self)
       end

data/app/models/riiif/image.rb

@@ -32,6 +32,8 @@ module Riiif
       @image ||= file_resolver.find(id)
     end
 
+    ##
+    # @param [ActiveSupport::HashWithIndifferentAccess] args
     def render(args)
       options = decode_options!(args)
       Rails.cache.fetch(Image.cache_key(id, options), compress: true, expires_in: Image.expires_in) do
@@ -58,8 +60,9 @@ module Riiif
 
     private
 
-      def decode_options!(args)
-        options = args.with_indifferent_access
+      ##
+      # @param [ActiveSupport::HashWithIndifferentAccess] options
+      def decode_options!(options)
         raise ArgumentError, 'You must provide a format' unless options[:format]
         options[:crop] = decode_region(options.delete(:region))
         options[:size] = decode_size(options.delete(:size))

data/lib/riiif/abstract_file_system_resolver.rb

@@ -18,9 +18,8 @@ module Riiif
       Dir.glob(search).first || raise(ImageNotFoundError, search)
     end
 
-    def pattern(id)
+    def pattern(_id)
       raise NotImplementedError, "Implement `pattern(id)' in the concrete class"
     end
   end
 end
-

data/lib/riiif/file_system_file_resolver.rb

@@ -3,7 +3,7 @@ module Riiif
     attr_writer :input_types
 
     def pattern(id)
-      raise ArgumentError, "Invalid characters in id `#{id}`" unless %r{^[\w\-:]+$}.match(id)
+      raise ArgumentError, "Invalid characters in id `#{id}`" unless /^[\w\-:]+$/.match(id)
       ::File.join(base_path, "#{id}.{#{input_types.join(',')}}")
     end
 

data/lib/riiif/nil_authorization_service.rb

@@ -1,7 +1,6 @@
 module Riiif
   class NilAuthorizationService
-    def initialize(_controller)
-    end
+    def initialize(_controller); end
 
     def can?(_action, _object)
       true

data/lib/riiif/routes.rb

@@ -26,7 +26,7 @@ module Riiif
 
         # This doesn't work presently
         # get "#{route_prefix}/:id", to: redirect("#{route_prefix}/%{id}/info.json")
-        get "#{route_prefix}/:id" => 'riiif/images#redirect'
+        get "#{route_prefix}/:id" => 'riiif/images#redirect', as: [options[:as], 'base'].compact.join('_')
       end
     end
   end

data/lib/riiif/version.rb

@@ -1,3 +1,3 @@
 module Riiif
-  VERSION = '0.4.1'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/riiif.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rails', '> 3.2.0'
+  spec.add_dependency 'railties', '>= 4.2', '<6'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'engine_cart', '~> 0.8'

data/spec/controllers/riiif/images_controller_spec.rb

@@ -12,8 +12,8 @@ describe Riiif::ImagesController do
       expect(image).to receive(:render).with('region' => 'full', 'size' => 'full',
                                              'rotation' => '0', 'quality' => 'default',
                                              'format' => 'jpg').and_return('IMAGEDATA')
-      get :show, id: 'abcd1234', action: 'show', region: 'full', size: 'full',
-                 rotation: '0', quality: 'default', format: 'jpg'
+      get :show, params: { id: 'abcd1234', action: 'show', region: 'full', size: 'full',
+                           rotation: '0', quality: 'default', format: 'jpg' }
       expect(response).to be_successful
       expect(response.body).to eq 'IMAGEDATA'
       expect(response.headers['Link']).to eq '<http://iiif.io/api/image/2/level1.json>;rel="profile"'
@@ -28,8 +28,8 @@ describe Riiif::ImagesController do
         allow(controller).to receive(:not_found_image).and_return(not_found_image)
       end
       it 'renders 401' do
-        get :show, id: 'abcd1234', action: 'show', region: 'full', size: 'full',
-                   rotation: '0', quality: 'default', format: 'jpg'
+        get :show, params: { id: 'abcd1234', action: 'show', region: 'full', size: 'full',
+                             rotation: '0', quality: 'default', format: 'jpg' }
         expect(response.body).to eq 'test data'
         expect(response.code).to eq '401'
       end
@@ -40,8 +40,8 @@ describe Riiif::ImagesController do
         image = double('an image')
         allow(image).to receive(:render).and_raise Riiif::InvalidAttributeError
         allow(Riiif::Image).to receive(:new).with('abcd1234').and_return(image)
-        get :show, id: 'abcd1234', action: 'show', region: '`szoW0', size: 'full',
-                   rotation: '0', quality: 'default', format: 'jpg'
+        get :show, params: { id: 'abcd1234', action: 'show', region: '`szoW0', size: 'full',
+                             rotation: '0', quality: 'default', format: 'jpg' }
         expect(response.code).to eq '400'
       end
     end
@@ -50,8 +50,8 @@ describe Riiif::ImagesController do
       it "errors when a default image isn't sent" do
         expect(Riiif::Image).to receive(:new).with('bad_id').and_raise(OpenURI::HTTPError.new('fail', StringIO.new))
         expect do
-          get :show, id: 'bad_id', action: 'show', region: 'full', size: 'full',
-                     rotation: '0', quality: 'default', format: 'jpg'
+          get :show, params: { id: 'bad_id', action: 'show', region: 'full', size: 'full',
+                               rotation: '0', quality: 'default', format: 'jpg' }
         end.to raise_error(StandardError)
       end
 
@@ -73,8 +73,8 @@ describe Riiif::ImagesController do
                                                            'rotation' => '0', 'quality' => 'default',
                                                            'format' => 'jpg').and_return('default-image-data')
 
-          get :show, id: 'bad_id', action: 'show', region: 'full', size: 'full',
-                     rotation: '0', quality: 'default', format: 'jpg'
+          get :show, params: { id: 'bad_id', action: 'show', region: 'full', size: 'full',
+                               rotation: '0', quality: 'default', format: 'jpg' }
           expect(response).to be_not_found
           expect(response.body).to eq 'default-image-data'
         end
@@ -89,8 +89,8 @@ describe Riiif::ImagesController do
                                                            'rotation' => '0', 'quality' => 'default',
                                                            'format' => 'jpg').and_return('default-image-data')
 
-          get :show, id: 'bad_id', action: 'show', region: 'full', size: 'full',
-                     rotation: '0', quality: 'default', format: 'jpg'
+          get :show, params: { id: 'bad_id', action: 'show', region: 'full', size: 'full',
+                               rotation: '0', quality: 'default', format: 'jpg' }
           expect(response).to be_not_found
           expect(response.body).to eq 'default-image-data'
         end
@@ -103,11 +103,11 @@ describe Riiif::ImagesController do
       image = double
       expect(Riiif::Image).to receive(:new).with('abcd1234').and_return(image)
       expect(image).to receive(:info).and_return(width: 6000, height: 4000)
-      get :info, id: 'abcd1234', format: 'json'
+      get :info, params: { id: 'abcd1234', format: 'json' }
       expect(response).to be_successful
       json = JSON.parse(response.body)
       expect(json).to eq '@context' => 'http://iiif.io/api/image/2/context.json',
-                         '@id' => 'http://test.host/images/abcd1234',
+                         '@id' => 'http://test.host/abcd1234',
                          'width' => 6000,
                          'height' => 4000,
                          'profile' => ['http://iiif.io/api/image/2/level1.json', 'formats' => %w(jpg png)],
@@ -123,7 +123,7 @@ describe Riiif::ImagesController do
         allow(controller).to receive(:authorization_service).and_return(auth)
       end
       it 'renders 401' do
-        get :info, id: 'abcd1234', format: 'json'
+        get :info, params: { id: 'abcd1234', format: 'json' }
         expect(response.body).to eq '{"error":"unauthorized"}'
         expect(response.code).to eq '401'
       end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: riiif
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-29 00:00:00.000000000 Z
+date: 2017-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -184,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A rails engine that support IIIF requests