riiif 2.0.0.beta1 → 2.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd3265a72519ab497b58fcd9314509a8bac800c4
-  data.tar.gz: 51c4d65cd6e0488a5ae225cb7c3d9917fd427033
+  metadata.gz: e944a8c92ae1774d9dd42515c3202a18b6a70f64
+  data.tar.gz: a4fa5460db8fc3703f21d3c8a07a62b920e4aa5e
 SHA512:
-  metadata.gz: 28447a5eadf4b943759bc3cf3df145aacff7a122528438b2f542779ad8ac06ab6ab1da4567d2cebaeea6d8148b92a3c895b2d077c2c5bee1eaee1a966df2eb8e
-  data.tar.gz: c0b443453bdfe6935f146fd7afa7b2377c239a189888660756406245746aba906a85bdb0c17e22c7d608b4e4fcc3e96901a05e9b8e54c543c1712fcd7bf8e224
+  metadata.gz: 33d4db4a5c49e09845ecdac04bdd35d88fa3ab1526eab8fbdd55bfbde786aee6adc1843e90e4f2bf0389c83570c005cb143e1dc831c18ec664fde6919a7feb6e
+  data.tar.gz: '05628c076ffc69365d0821f368118d0e078d7bbae5c946f4f59fafc485d8948d56b954338f0dfbdb4b8628212d48954b1a972fc937e4099985b97f67ca12ba9b'

data/app/resolvers/riiif/abstract_file_system_resolver.rb

@@ -25,7 +25,7 @@ module Riiif
     # @return the path of the file
     def path(id)
       search = pattern(id)
-      Dir.glob(search).first || raise(ImageNotFoundError, search)
+      search && Dir.glob(search).first || raise(ImageNotFoundError, search)
     end
 
     def pattern(_id)

data/app/resolvers/riiif/file_system_file_resolver.rb

@@ -2,13 +2,28 @@ module Riiif
   class FileSystemFileResolver < AbstractFileSystemResolver
     attr_writer :input_types
 
+    # @return a string suitable for a globbing match
+    #   e.g. /base/path/67352ccc-d1b0-11e1-89ae-279075081939.{jp2,tiff,png}
+    #   or nil when the id is not valid
     def pattern(id)
-      raise ArgumentError, "Invalid characters in id `#{id}`" unless id =~ /^[\w\-:]+$/
+      return unless validate_identifier(id: id)
       ::File.join(base_path, "#{id}.{#{input_types.join(',')}}")
     end
 
     private
 
+      # @return [Boolean] true if the id matches the regex
+      def validate_identifier(id:, regex: identifier_regex)
+        return true if id =~ regex
+        Rails.logger.warn "Invalid characters in id `#{id}`"
+        false
+      end
+
+      # Matches on word characters dashes and colons
+      def identifier_regex
+        /^[\w\-:]+$/
+      end
+
       def input_types
         @input_types ||= %w(png jpg tif tiff jp2)
       end

data/lib/riiif/version.rb

@@ -1,3 +1,3 @@
 module Riiif
-  VERSION = '2.0.0.beta1'.freeze
+  VERSION = '2.0.0.beta2'.freeze
 end

data/spec/models/riiif/file_system_file_resolver_spec.rb

@@ -21,6 +21,14 @@ describe Riiif::FileSystemFileResolver do
         expect(subject.path).to eq base_path + '/world.jp2'
       end
     end
+
+    context 'when pattern is not permitted' do
+      let(:id) { 'foo/bar' } # slashes are not permitted by default
+
+      it 'casts the error to a not found (required by the IIIF spec)' do
+        expect { subject.path }.to raise_error Riiif::ImageNotFoundError
+      end
+    end
   end
 
   describe '#input_types' do
@@ -63,5 +71,12 @@ describe Riiif::FileSystemFileResolver do
         expect { subject }.not_to raise_error
       end
     end
+
+    context 'with slashes (unallowed by default)' do
+      let(:id) { 'fo/baz' }
+      it 'returns nil' do
+        expect(subject).to be_nil
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riiif
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta1
+  version: 2.0.0.beta2
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-08 00:00:00.000000000 Z
+date: 2017-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties