riiif 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0aaf0ae50831c1b402852fee520e6a4a0c9b8760
-  data.tar.gz: 141b672ec9ce926ae80d139febb926a82d607cc2
+  metadata.gz: 83e09f8e63165428baf455b3547e78819582ec2f
+  data.tar.gz: 2bb3a70107f4e4ab94c2561e4ab316b7b360beaa
 SHA512:
-  metadata.gz: 3729b7972bea7cfea2d4f1c21b75ad3c974b54c2307a1ab63e297a7b06cf5e5dc9efb9bc919a6c8b5c3e7d04dc9030866e10e2c0fc368dc8a2b1bc4518dd0b4f
-  data.tar.gz: ee0acb8006038a89caceb49cd4216ce08d3f65136ca38f5aff3ed2391bd0fb17ced7a48075e7f65565d3d0b600f199c004d2ee0e027b0ad80f3ff9ba48ecf338
+  metadata.gz: 77d9392212565fe905219e1811dea64d8c090e2d5121508286936876b959915c1d9548463085c601e719adbcb7862d3f4cc6b830c2fbec6a23915f07789ca83b
+  data.tar.gz: 5a2a9866ac295b9a0739f43dcf3209b31c659a279a0afad4d6a7c804e4d8faf27237828363c219d9260f04669191cc5ed5e97d11ddb14a3b17476457b824bdd1

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-01-24 17:33:24 -0500 using RuboCop version 0.47.0.
+# on 2017-04-11 15:07:00 -0500 using RuboCop version 0.47.1.
 # 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
@@ -24,53 +24,24 @@ Lint/UselessAssignment:
   Exclude:
     - 'app/models/riiif/file.rb'
 
-# Offense count: 4
+# Offense count: 5
 Metrics/AbcSize:
-  Max: 38
+  Max: 29
 
 # Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 103
-
-# Offense count: 2
 Metrics/CyclomaticComplexity:
   Max: 8
 
-# Offense count: 68
+# Offense count: 96
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 120
+  Max: 117
 
-# Offense count: 7
+# Offense count: 6
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 21
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Performance/RedundantMatch:
-  Exclude:
-    - 'lib/riiif/file_system_file_resolver.rb'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# 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:
-    - 'lib/riiif/routes.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: braces, no_braces, context_dependent
-Style/BracesAroundHashParameters:
-  Exclude:
-    - 'app/models/riiif/image.rb'
+  Max: 18
 
 # Offense count: 1
 # Configuration parameters: EnforcedStyle, SupportedStyles.
@@ -79,12 +50,6 @@ Style/ClassAndModuleChildren:
   Exclude:
     - 'lib/riiif/rails/routes.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/ColonMethodCall:
-  Exclude:
-    - 'lib/riiif/http_file_resolver.rb'
-
 # Offense count: 14
 Style/Documentation:
   Exclude:
@@ -102,35 +67,3 @@ Style/Documentation:
     - 'lib/riiif/nil_authorization_service.rb'
     - 'lib/riiif/rails/routes.rb'
     - 'lib/riiif/routes.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/EmptyLines:
-  Exclude:
-    - 'app/models/riiif/image.rb'
-    - 'lib/riiif/http_file_resolver.rb'
-
-# Offense count: 5
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# 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/http_file_resolver.rb'
-
-# Offense count: 5
-# Cop supports --auto-correct.
-Style/EmptyLinesAroundMethodBody:
-  Exclude:
-    - 'app/models/riiif/file.rb'
-    - 'app/models/riiif/image.rb'
-    - 'lib/riiif/rails/routes.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
-Style/ExtraSpacing:
-  Exclude:
-    - 'lib/riiif/routes.rb'

data/README.md

@@ -28,17 +28,17 @@ And then execute:
 Or install it yourself as:
 
     $ gem install riiif
-    
+
 ## Configure
 
 ### Images on the servers file system.
 
-By default Riiif is set to load images from the filesystem using the Riiif::FileSystemFileResolver. 
+By default Riiif is set to load images from the filesystem using the Riiif::FileSystemFileResolver.
 You can configure how this resolver finds the files by setting this property:
 ```
     Riiif::Image.file_resolver.base_path = '/opt/repository/images/'
 ```
-When the Id passed in is "foo_image", then it will look for an image file using this glob: 
+When the Id passed in is "foo_image", then it will look for an image file using this glob:
 ```
 /opt/repository/images/foo_image.{png,jpg,tiff,jp,jp2}
 ```
@@ -65,7 +65,7 @@ By default the cache is located in `tmp/network_files`. You can set the cache pa
 
 ## Usage
 
-Add the routes to your application by inserting the following line into `config/routes.rb` 
+Add the routes to your application by inserting the following line into `config/routes.rb`
 ```
   mount Riiif::Engine => '/image-service', as: 'riiif'
 ```
@@ -87,12 +87,21 @@ It is prefereable that you use the provided route helpers to build these URIs. H
   image_tag(Riiif::Engine.routes.url_helpers.image_path(file_id, size: ',600'))
 ```
 
-### Using a default image
+### Using default images for missing and unauthorized requests
+
+If there is a request for an id that doesn't exist, a 404 will be
+returned. You can optionally return an image with this 404 by setting
+this in your initializer:
+
+```ruby
+Riiif.not_found_image = 'path/to/image.png'
+```
 
-If there is a request for an id that doesn't exist, a 404 will be returned. You can optionally return an image with this 404 by setting this in your initializer:
+If the request is unauthorized, a 401 will be returned, and a custom
+error image can also be configured.
 
 ```ruby
-Riiif::not_found_image = 'path/to/image.png'
+Riiif.unauthorized_image = 'path/to/unauthorized_image.png'
 ```
 
 You can do this to create a default Riiif::Image to use (useful for passing "missing" images to openseadragon_collection_viewer):
@@ -103,7 +112,7 @@ Riiif::Image.new('no_image', Riiif::File.new(Riiif.not_found_image))
 
 ## Authorization
 
-The controller will call an authorization service with the controller context.  This service must have a method `can?(action, image)` which returns a boolean. The default service is the `RIIIF::NilAuthrorizationService` which permits all requests. 
+The controller will call an authorization service with the controller context.  This service must have a method `can?(action, image)` which returns a boolean. The default service is the `RIIIF::NilAuthrorizationService` which permits all requests.
 
 In this example we've dissallowed all requests:
 
@@ -129,14 +138,14 @@ Create an initializer like this in `config/initializers/riiif_initializer.rb`
 Riiif::Image.file_resolver = Riiif::HTTPFileResolver.new
 
 # This tells RIIIF how to resolve the identifier to a URI in Fedora
-Riiif::Image.file_resolver.id_to_uri = lambda do |id| 
+Riiif::Image.file_resolver.id_to_uri = lambda do |id|
   ActiveFedora::Base.id_to_uri(CGI.unescape(id)).tap do |url|
     logger.info "Riiif resolved #{id} to #{url}"
   end
 end
 
 # In order to return the info.json endpoint, we have to have the full height and width of
-# each image. If you are using hydra-file_characterization, you have the height & width 
+# each image. If you are using hydra-file_characterization, you have the height & width
 # cached in Solr. The following block directs the info_service to return those values:
 Riiif::Image.info_service = lambda do |id, file|
   # id will look like a path to a pcdm:file
@@ -155,6 +164,11 @@ def logger
   Rails.logger
 end
 
+# Note that this is translated to an `expires` argument to the
+# ActiveSupport::Cache::Store in use, by default the host application's
+# Rails.cache. Some cache stores may not automatically purge expired content,
+# such as the default FileStore.
+# http://guides.rubyonrails.org/caching_with_rails.html#cache-stores
 Riiif::Engine.config.cache_duration_in_days = 30
 ```
 #### Special note for Passenger and Apache users

data/app/controllers/riiif/images_controller.rb

@@ -18,7 +18,7 @@ module Riiif
         status = :not_found
       end
 
-      image = not_found_image unless status == :ok
+      image = error_image(status) unless status == :ok
 
       data = image.render(image_request_params)
       headers['Access-Control-Allow-Origin'] = '*'
@@ -88,9 +88,22 @@ module Riiif
         response.headers['Link'] = "<#{LEVEL1}>;rel=\"profile\""
       end
 
-      def not_found_image
-        raise "Not found image doesn't exist" unless Riiif.not_found_image
-        model.new(image_id, Riiif::File.new(Riiif.not_found_image))
+      # @param [Symbol] err E.g., :not_found, :unauthorized
+      # @return [Image]
+      def error_image(err)
+        # rubocop:disable Lint/HandleExceptions
+        begin
+          image = Riiif.send("#{err}_image")
+        rescue NoMethodError
+        end
+        # rubocop:enable Lint/HandleExceptions
+
+        if image.nil?
+          raise ImageNotFoundError,
+                "Riiif.#{err}_image is not configured; assign it to an image path in your RIIIF initializer"
+        end
+
+        model.new(image_id, Riiif::File.new(image))
       end
 
       CONTEXT = '@context'.freeze

data/app/models/riiif/file.rb

@@ -20,7 +20,6 @@ module Riiif
     end
 
     def self.create(ext = nil, _validate = true, &block)
-
       tempfile = Tempfile.new(['mini_magick', ext.to_s.downcase])
       tempfile.binmode
       block.call(tempfile)
@@ -28,7 +27,6 @@ module Riiif
       image = new(tempfile.path, tempfile)
     ensure
       tempfile.close if tempfile
-
     end
 
     # @param [Transformation] transformation

data/app/models/riiif/image.rb

@@ -1,10 +1,10 @@
 require 'digest/md5'
 module Riiif
   class Image
-
-    class_attribute :file_resolver, :info_service, :authorization_service
+    class_attribute :file_resolver, :info_service, :authorization_service, :cache
     self.file_resolver = FileSystemFileResolver.new
     self.authorization_service = NilAuthorizationService
+    self.cache = Rails.cache
 
     # this is the default info service
     # returns a hash with the original image dimensions.
@@ -12,7 +12,7 @@ module Riiif
     # example:
     #   {:height=>390, :width=>600}
     self.info_service = lambda do |id, image|
-      Rails.cache.fetch(cache_key(id, { info: true }), compress: true, expires_in: expires_in) do
+      cache.fetch(cache_key(id, info: true), compress: true, expires_in: expires_in) do
         image.info
       end
     end
@@ -36,7 +36,7 @@ module Riiif
     # @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
+      cache.fetch(Image.cache_key(id, options), compress: true, expires_in: Image.expires_in) do
         image.extract(options)
       end
     end
@@ -53,11 +53,11 @@ module Riiif
         Riiif::Engine.config.cache_duration_in_days.days
       end
 
-
       def cache_key(id, options)
         str = options.to_h.merge(id: id).delete_if { |_, v| v.nil? }.to_s
-        # Use a MD5 digest to ensure the keys aren't too long.
-        Digest::MD5.hexdigest(str)
+        # Use a MD5 digest to ensure the keys aren't too long, and a prefix
+        # to avoid collisions with other components in shared cache.
+        'riiif:' + Digest::MD5.hexdigest(str)
       end
     end
 
@@ -93,7 +93,6 @@ module Riiif
 
       def validate_format!(format)
         raise InvalidAttributeError, "Unsupported format: #{format}" unless OUTPUT_FORMATS.include?(format)
-
       end
 
       def decode_region(region)

data/lib/riiif/file_system_file_resolver.rb

@@ -3,14 +3,14 @@ module Riiif
     attr_writer :input_types
 
     def pattern(id)
-      raise ArgumentError, "Invalid characters in id `#{id}`" unless /^[\w\-:]+$/.match(id)
+      raise ArgumentError, "Invalid characters in id `#{id}`" unless id =~ /^[\w\-:]+$/
       ::File.join(base_path, "#{id}.{#{input_types.join(',')}}")
     end
 
     private
 
       def input_types
-        @input_types ||= %w(png jpg tiff jp jp2)
+        @input_types ||= %w(png jpg tif tiff jp2)
       end
   end
 end

data/lib/riiif/http_file_resolver.rb

@@ -3,7 +3,6 @@ require 'active_support/core_ext/file/atomic'
 
 module Riiif
   class HTTPFileResolver
-
     # Set a lambda that maps the first parameter (id) to a URL
     # Example:
     #
@@ -16,8 +15,8 @@ module Riiif
     attr_accessor :basic_auth_credentials
     attr_accessor :cache_path
 
-    def initialize
-      @cache_path = 'tmp/network_files'
+    def initialize(cache_path: 'tmp/network_files')
+      @cache_path = cache_path
     end
 
     def find(id)
@@ -64,7 +63,7 @@ module Riiif
           benchmark("Riiif downloaded #{url}") do
             ::File.atomic_write(file_name, cache_path) do |local|
               begin
-                Kernel::open(url, download_opts) do |remote|
+                Kernel.open(url, download_opts) do |remote|
                   while chunk = remote.read(8192)
                     local.write(chunk)
                   end
@@ -88,13 +87,11 @@ module Riiif
         end
     end
 
-
     protected
 
       def uri(id)
         raise 'Must set the id_to_uri lambda' if id_to_uri.nil?
         id_to_uri.call(id)
       end
-
   end
 end

data/lib/riiif/rails/routes.rb

@@ -6,7 +6,6 @@ module ActionDispatch::Routing
       options = resources.extract_options!
 
       Riiif::Routes.new(self, options.merge(resource: resources.first)).draw
-
     end
   end
 end

data/lib/riiif/routes.rb

@@ -18,12 +18,12 @@ module Riiif
         route_prefix = options[:at]
         route_prefix ||= "/#{options[:as]}" if options[:as]
         get "#{route_prefix}/:id/:region/:size/:rotation/:quality.:format" => 'riiif/images#show',
-          constraints: { rotation: ALLOW_DOTS, size: SIZES },
-          defaults: { format: 'jpg', rotation: '0', region: 'full', quality: 'default', model: resource },
-          as: options[:as] || 'image'
+            constraints: { rotation: ALLOW_DOTS, size: SIZES },
+            defaults: { format: 'jpg', rotation: '0', region: 'full', quality: 'default', model: resource },
+            as: options[:as] || 'image'
 
         get "#{route_prefix}/:id/info.json" => 'riiif/images#info',
-            defaults: { format: 'json', model: resource  },
+            defaults: { format: 'json', model: resource },
             as: [options[:as], 'info'].compact.join('_')
 
         # This doesn't work presently

data/lib/riiif/version.rb

@@ -1,3 +1,3 @@
 module Riiif
-  VERSION = '1.4.0'.freeze
+  VERSION = '1.4.1'.freeze
 end

data/spec/controllers/riiif/images_controller_spec.rb

@@ -16,23 +16,41 @@ describe Riiif::ImagesController do
                            rotation: '0', quality: 'default', format: 'jpg' }
       expect(response).to be_successful
       expect(response.body).to eq 'IMAGEDATA'
+      expect(response.headers['Content-Type']).to eq 'image/jpeg'
       expect(response.headers['Link']).to eq '<http://iiif.io/api/image/2/level1.json>;rel="profile"'
       expect(response.headers['Access-Control-Allow-Origin']).to eq '*'
-      expect(response.headers['Cache-Control']).to eq 'max-age=31557600, private'
+      expect(response.headers['Cache-Control']).to eq "max-age=#{1.year.to_i}, private"
     end
 
     context 'with an unauthorized image' do
       let(:auth) { double('no auth service', can?: false) }
-      let(:not_found_image) { double('not_found_image', render: 'test data') }
+
       before do
         allow(controller).to receive(:authorization_service).and_return(auth)
-        allow(controller).to receive(:not_found_image).and_return(not_found_image)
       end
-      it 'renders 401' do
-        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'
+
+      context 'with Riiif::unauthorized_image configured' do
+        before do
+          allow(controller).to receive(:error_image).with(:unauthorized).and_return(unauthorized_image)
+        end
+
+        let(:unauthorized_image) { double('unauthorized_image', render: 'test data') }
+
+        it 'renders 401 and renders the unauthorized_image' do
+          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
+      end
+
+      context 'with Riiif::unauthorized_image left to nil' do
+        it 'gives a helpful error' do
+          expect do
+            get :show, params: { id: 'abcd1234', action: 'show', region: 'full', size: 'full',
+                                 rotation: '0', quality: 'default', format: 'jpg' }
+          end.to raise_error(Riiif::ImageNotFoundError)
+        end
       end
     end
 
@@ -49,11 +67,10 @@ describe Riiif::ImagesController do
 
     context 'with a nonexistent image' 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, params: { id: 'bad_id', action: 'show', region: 'full', size: 'full',
                                rotation: '0', quality: 'default', format: 'jpg' }
-        end.to raise_error(StandardError)
+        end.to raise_error(Riiif::ImageNotFoundError)
       end
 
       context 'with a default image set' do
@@ -116,7 +133,7 @@ describe Riiif::ImagesController do
       expect(response.headers['Link']).to eq '<http://iiif.io/api/image/2/level1.json>;rel="profile"'
       expect(response.headers['Content-Type']).to eq 'application/ld+json; charset=utf-8'
       expect(response.headers['Access-Control-Allow-Origin']).to eq '*'
-      expect(response.headers['Cache-Control']).to eq 'max-age=31557600, private'
+      expect(response.headers['Cache-Control']).to eq "max-age=#{1.year.to_i}, private"
     end
 
     context 'with an unauthorized image' do

data/spec/models/riiif/file_system_file_resolver_spec.rb

@@ -13,7 +13,7 @@ describe Riiif::FileSystemFileResolver do
       end
     end
 
-    context 'when the file is found' do
+    context 'when a jpeg2000 file is found' do
       let(:id) { 'world' }
       it 'returns the jpeg2000 file' do
         expect(subject.path).to eq resolver.root + '/spec/samples/world.jp2'
@@ -21,6 +21,30 @@ describe Riiif::FileSystemFileResolver do
     end
   end
 
+  describe '#input_types' do
+    subject { described_class.new.send(:input_types) }
+
+    it 'includes jp2 extension' do
+      expect(subject).to include 'jp2'
+    end
+
+    it 'includes jpg extension' do
+      expect(subject).to include 'jpg'
+    end
+
+    it 'includes tif extension' do
+      expect(subject).to include 'tif'
+    end
+
+    it 'includes tiff extension' do
+      expect(subject).to include 'tiff'
+    end
+
+    it 'includes png extension' do
+      expect(subject).to include 'png'
+    end
+  end
+
   describe '#pattern' do
     subject { resolver.pattern(id) }
 
@@ -31,9 +55,9 @@ describe Riiif::FileSystemFileResolver do
       end
     end
 
-    context 'with colins' do
+    context 'with colons' do
       let(:id) { 'fo:baz' }
-      it 'accepts ids with colins' do
+      it 'accepts ids with colons' do
         expect { subject }.not_to raise_error
       end
     end

data/spec/models/riiif/image_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe Riiif::Image do
-  before { Rails.cache.clear }
+  before { Riiif::Image.cache.clear }
   let(:filename) { File.expand_path('spec/samples/world.jp2') }
   subject { described_class.new('world') }
   describe 'happy path' do
@@ -53,7 +53,7 @@ RSpec.describe Riiif::Image do
 
     context 'when the rendered image is in the cache' do
       subject { described_class.new('Cave_26,_Ajanta') }
-      before { allow(Rails.cache).to receive(:fetch).and_return('expected') }
+      before { allow(Riiif::Image.cache).to receive(:fetch).and_return('expected') }
 
       it 'does not fetch the file' do
         expect(described_class.file_resolver).not_to receive(:find)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riiif
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-11 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -204,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: A rails engine that support IIIF requests