riiif 2.0.0.beta2 → 2.0.0

data/app/services/riiif/image_magick_info_extractor.rb

@@ -10,8 +10,15 @@ module Riiif
     end
 
     def extract
-      height, width = Riiif::CommandRunner.execute("#{external_command} -format %hx%w #{@path}[0]").split('x')
-      { height: Integer(height), width: Integer(width) }
+      height, width, format = Riiif::CommandRunner.execute(
+        "#{external_command} -format '%h %w %m' #{@path}[0]"
+      ).split(' ')
+
+      {
+        height: Integer(height),
+        width: Integer(width),
+        format: format
+      }
     end
   end
 end

data/app/services/riiif/imagemagick_command_factory.rb

@@ -44,8 +44,12 @@ module Riiif
         transformation.format == 'jpg'.freeze
       end
 
+      def layer_spec
+        '[0]' if info.format =~ /pdf/i
+      end
+
       def input
-        " #{path}"
+        " #{path}#{layer_spec}"
       end
 
       # pipe the output to STDOUT
@@ -54,17 +58,18 @@ module Riiif
       end
 
       def crop
-        directive = transformation.crop.to_imagemagick
+        directive = Crop.new(transformation.region, info).to_imagemagick
         " -crop #{directive}" if directive
       end
 
       def size
-        directive = transformation.size.to_imagemagick
+        directive = Resize.new(transformation.size, info).to_imagemagick
         " -resize #{directive}" if directive
       end
 
       def rotation
-        " -virtual-pixel white +distort srt #{transformation.rotation}" if transformation.rotation
+        return if transformation.rotation.zero?
+        " -virtual-pixel white +distort srt #{transformation.rotation}"
       end
 
       def quality

data/app/services/riiif/kakadu_command_factory.rb

@@ -25,7 +25,7 @@ module Riiif
     end
 
     def reduction_factor
-      @reduction_factor ||= transformation.size.reduction_factor
+      @reduction_factor ||= Resize.new(transformation.size, info).reduction_factor
     end
 
     private
@@ -47,7 +47,7 @@ module Riiif
       end
 
       def region
-        region_arg = transformation.crop.to_kakadu
+        region_arg = Crop.new(transformation.region, info).to_kakadu
         " -region \"#{region_arg}\"" if region_arg
       end
 

data/app/services/riiif/resize.rb

@@ -1,30 +1,89 @@
 module Riiif
   # Represents a resize operation
   class Resize
-    attr_reader :image_info
+    # @param size [IIIF::Image::Size] the result the user requested
+    # @param image_info []
+    def initialize(size, image_info)
+      @size = size
+      @image_info = image_info
+    end
+
+    attr_reader :image_info, :size
+
+    # @return [String] a resize directive for imagemagick to use
+    def to_imagemagick
+      case size
+      when IIIF::Image::Size::Percent
+        "#{size.percentage}%"
+      when IIIF::Image::Size::Width
+        size.width
+      when IIIF::Image::Size::Height
+        "x#{size.height}"
+      when IIIF::Image::Size::Absolute
+        "#{size.width}x#{size.height}!"
+      when IIIF::Image::Size::BestFit
+        "#{size.width}x#{size.height}"
+      when IIIF::Image::Size::Max, IIIF::Image::Size::Full
+        nil
+      else
+        raise "unknown size #{size.class}"
+      end
+    end
 
     # @return [Integer] the height in pixels
     def height
-      image_info.height
+      case size
+      when IIIF::Image::Size::Absolute
+        size.height
+      when IIIF::Image::Size::Percent
+        image_info.height * Integer(size.percentage).to_f / 100
+      when IIIF::Image::Size::Width
+        size.height_for_aspect_ratio(image_info.aspect)
+      else
+        image_info.height
+      end
     end
 
     # @return [Integer] the width in pixels
     def width
-      image_info.width
+      case size
+      when IIIF::Image::Size::Absolute
+        size.width
+      when IIIF::Image::Size::Percent
+        image_info.width * Integer(size.percentage).to_f / 100
+      when IIIF::Image::Size::Height
+        size.width_for_aspect_ratio(image_info.aspect)
+      else
+        image_info.width
+      end
     end
 
     # Should we reduce this image with KDU?
     def reduce?
-      true
+      case size
+      when IIIF::Image::Size::Full, IIIF::Image::Size::Max
+        false
+      when IIIF::Image::Size::Absolute
+        aspect_ratio = width.to_f / height
+        in_delta?(image_info.aspect, aspect_ratio, 0.001)
+      else
+        true
+      end
     end
 
     # This is used for a second resize by imagemagick after resizing
     # by kdu.
     # No need to scale most resize operations (only percent)
     # @param [Integer] factor to scale by
-    # @return [Absolute] a copy of self if factor is zero.
-    def reduce(_factor)
-      dup
+    # @return [IIIF::Image::Size] a copy of self if factor is zero.
+    def reduce(factor)
+      case size
+      when IIIF::Image::Size::Percent
+        pct = size.percentage * 2**factor
+        IIIF::Image::Size::Percent.new(pct)
+      else
+        size.dup
+      end
     end
 
     # @return [Integer] the reduction factor for this operation
@@ -41,5 +100,11 @@ module Riiif
       end
       factor
     end
+
+    private
+
+      def in_delta?(x1, x2, delta)
+        (x1 - x2).abs <= delta
+      end
   end
 end

data/app/transformers/riiif/kakadu_transformer.rb

@@ -23,15 +23,38 @@ module Riiif
     def post_process(intermediate_file, reduction_factor)
       # Calculate a new set of transforms with respect to reduction_factor
       transformation = if reduction_factor
-                         self.transformation.without_crop(image_info).reduce(reduction_factor)
+                         reduce(without_crop, reduction_factor)
                        else
-                         self.transformation.without_crop(image_info)
+                         without_crop
                        end
       Riiif::File.new(intermediate_file).extract(transformation, image_info)
     end
 
     private
 
+      # Create a clone of the Transformation, without the crop
+      # @return [IIIF::Image::Transformation] a new transformation
+      def without_crop
+        IIIF::Image::Transformation.new(region: IIIF::Image::Region::Full.new,
+                                        size: transformation.size.dup,
+                                        quality: transformation.quality,
+                                        rotation: transformation.rotation,
+                                        format: transformation.format)
+      end
+
+      # Create a clone of this Transformation, scaled by the factor
+      # @param [IIIF::Image::Transformation] transformation the transformation to clone
+      # @param [Integer] factor the scale for the new transformation
+      # @return [Transformation] a new transformation, scaled by factor
+      def reduce(transformation, factor)
+        resize = Resize.new(transformation.size, image_info)
+        IIIF::Image::Transformation.new(region: transformation.region.dup,
+                                        size: resize.reduce(factor),
+                                        quality: transformation.quality,
+                                        rotation: transformation.rotation,
+                                        format: transformation.format)
+      end
+
       def tmp_path
         @link_path ||= LinkNameService.create
       end

data/docs/benchmark.md

@@ -0,0 +1,75 @@
+# Benchmarks demonstrating different backends.
+
+This benchmarks were run on Riiif 2.0.0.beta.  They show the difference in speed in decoding a 5240x7057 pixel jp2 using openjpeg 2.2.0 (via Imagemagick) versus Kakadu 7.10.2.
+ 
+## RIIIF with openjpeg 2.2.0
+ 
+```
+$ ab -n 30 'https://localhost:3000/iiif/2/bc%2F151%2Fbq%2F1744%2Fbc151bq1744_00_0001.jp2/full/!400,400/0/default.jpg'
+
+Document Length:        27958 bytes
+
+Concurrency Level:      1
+Time taken for tests:   326.297 seconds
+Complete requests:      30
+Failed requests:        0
+Total transferred:      855851 bytes
+HTML transferred:       838740 bytes
+Requests per second:    0.09 [#/sec] (mean)
+Time per request:       10876.556 [ms] (mean)
+Time per request:       10876.556 [ms] (mean, across all concurrent requests)
+Transfer rate:          2.56 [Kbytes/sec] received
+
+Connection Times (ms)
+              min  mean[+/-sd] median   max
+Connect:       55  101  52.8     84     298
+Processing:  8432 10775 3627.0   9669   26365
+Waiting:     8420 10642 3395.2   9532   24849
+Total:       8489 10876 3626.9   9724   26442
+
+Percentage of the requests served within a certain time (ms)
+  50%   9724
+  66%  10197
+  75%  10537
+  80%  11088
+  90%  15837
+  95%  18224
+  98%  26442
+  99%  26442
+ 100%  26442 (longest request)
+ ```
+ 
+ ## RIIIF, no cache, kakadu + imagemagick
+ ```
+ ab -n 30 'https://localhost:3000/iiif/2/bc%2F151%2Fbq%2F1744%2Fbc151bq1744_00_0001.jp2/full/!400,400/0/default.jpg'
+ Document Length:        27978 bytes
+
+Concurrency Level:      1
+Time taken for tests:   82.646 seconds
+Complete requests:      30
+Failed requests:        0
+Total transferred:      856440 bytes
+HTML transferred:       839340 bytes
+Requests per second:    0.36 [#/sec] (mean)
+Time per request:       2754.880 [ms] (mean)
+Time per request:       2754.880 [ms] (mean, across all concurrent requests)
+Transfer rate:          10.12 [Kbytes/sec] received
+
+Connection Times (ms)
+              min  mean[+/-sd] median   max
+Connect:       49   95  65.4     78     398
+Processing:  1991 2660 431.4   2643    4207
+Waiting:     1943 2583 415.3   2565    4033
+Total:       2096 2755 448.5   2721    4395
+
+Percentage of the requests served within a certain time (ms)
+  50%   2721
+  66%   2820
+  75%   2944
+  80%   2975
+  90%   3260
+  95%   3486
+  98%   4395
+  99%   4395
+ 100%   4395 (longest request)
+ ```

data/lib/riiif/engine.rb

@@ -1,9 +1,10 @@
+require 'iiif-image-api'
 module Riiif
   class Engine < ::Rails::Engine
     require 'riiif/rails/routes'
 
     # How long to cache the tiles for.
-    config.cache_duration_in_days = 3
+    config.cache_duration = 3.days
 
     config.action_dispatch.rescue_responses['Riiif::ImageNotFoundError'] = :not_found
 

data/lib/riiif/routes.rb

@@ -26,6 +26,9 @@ module Riiif
             defaults: { format: 'json', model: resource },
             as: [options[:as], 'info'].compact.join('_')
 
+        match "#{route_prefix}/:id/info.json" => 'riiif/images#info_options',
+              via: [:options]
+
         # This doesn't work presently
         # get "#{route_prefix}/:id", to: redirect("#{route_prefix}/%{id}/info.json")
         get "#{route_prefix}/:id" => 'riiif/images#redirect', as: [options[:as], 'base'].compact.join('_')

data/lib/riiif/version.rb

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

data/riiif.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'riiif'
   spec.version       = Riiif::VERSION
   spec.authors       = ['Justin Coyne']
-  spec.email         = ['justin@curationexperts.com']
+  spec.email         = ['administrator@curationexperts.com']
   spec.description   = 'A IIIF image server'
   spec.summary       = 'A rails engine that support IIIF requests'
   spec.homepage      = 'https://github.com/curationexperts/riiif'
@@ -20,12 +20,12 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'railties', '>= 4.2', '<6'
   spec.add_dependency 'deprecation', '>= 1.0.0'
+  spec.add_dependency 'iiif-image-api', '~> 0.1.0'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'engine_cart', '~> 0.8'
   spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'rubocop', '~> 0.47.1'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.13'
+  spec.add_development_dependency 'bixby', '~> 1.0.0'
   spec.add_development_dependency 'coveralls'
 end

data/spec/controllers/riiif/images_controller_spec.rb

@@ -72,7 +72,7 @@ RSpec.describe Riiif::ImagesController do
     context 'with a invalid region' do
       it 'renders 400' do
         image = double('an image')
-        allow(image).to receive(:render).and_raise Riiif::InvalidAttributeError
+        allow(image).to receive(:render).and_raise IIIF::Image::InvalidAttributeError
         allow(Riiif::Image).to receive(:new).with('abcd1234').and_return(image)
         get :show, params: { id: 'abcd1234', action: 'show', region: '`szoW0', size: 'full',
                              rotation: '0', quality: 'default', format: 'jpg' }
@@ -131,6 +131,14 @@ RSpec.describe Riiif::ImagesController do
     end
   end
 
+  describe 'info_options' do
+    it 'is successful' do
+      process :info_options, method: 'OPTIONS', params: { id: 'abcd123', format: 'json' }
+      expect(response).to be_successful
+      expect(response.headers['Access-Control-Allow-Headers']).to eq 'Authorization'
+    end
+  end
+
   describe 'info' do
     context 'the happy path' do
       let(:image) { double }
@@ -138,7 +146,9 @@ RSpec.describe Riiif::ImagesController do
 
       before do
         allow(Riiif::Image).to receive(:new).with('abcd1234').and_return(image)
-        allow(image).to receive(:info).and_return(Riiif::ImageInformation.new(6000, 4000))
+        allow(image).to(
+          receive(:info).and_return(Riiif::ImageInformation.new(width: 6000, height: 4000, format: 'JPEG'))
+        )
       end
 
       it 'returns info' do
@@ -148,6 +158,7 @@ RSpec.describe Riiif::ImagesController do
                            '@id' => 'http://test.host/abcd1234',
                            'width' => 6000,
                            'height' => 4000,
+                           'format' => 'JPEG',
                            'profile' => ['http://iiif.io/api/image/2/level1.json', 'formats' => %w(jpg png)],
                            'protocol' => 'http://iiif.io/api/image'
         expect(response.headers['Link']).to eq '<http://iiif.io/api/image/2/level1.json>;rel="profile"'
@@ -163,7 +174,7 @@ RSpec.describe Riiif::ImagesController do
 
       before do
         allow(Riiif::Image).to receive(:new).with('abcd1234').and_return(image)
-        allow(image).to receive(:info).and_return(Riiif::ImageInformation.new(nil, nil))
+        allow(image).to receive(:info).and_return(Riiif::ImageInformation.new(width: nil, height: nil))
       end
 
       it 'returns an error' do

data/spec/models/riiif/image_information_spec.rb

@@ -5,23 +5,15 @@ RSpec.describe Riiif::ImageInformation do
     subject { info.valid? }
 
     context 'with valid dimensions' do
-      let(:info) { described_class.new(100, 200) }
+      let(:info) { described_class.new(width: 100, height: 200) }
 
       it { is_expected.to be true }
     end
 
     context 'with nil dimensions' do
-      let(:info) { described_class.new(nil, nil) }
+      let(:info) { described_class.new(width: nil, height: nil) }
 
       it { is_expected.to be false }
     end
   end
-
-  describe '#[]' do
-    subject { info[:width] }
-    let(:info) { described_class.new(100, 200) }
-    before { allow(Deprecation).to receive(:warn) }
-
-    it { is_expected.to eq 100 }
-  end
 end

data/spec/models/riiif/image_spec.rb

@@ -30,18 +30,12 @@ RSpec.describe Riiif::Image do
   it 'is able to override the file used for the Image' do
     img = described_class.new('some_id', Riiif::File.new(filename))
     expect(img.id).to eq 'some_id'
-    expect(img.info).to eq Riiif::ImageInformation.new(800, 400)
-  end
-
-  describe 'without a format' do
-    it 'raises an error' do
-      expect { subject.render('size' => 'full') }.to raise_error ArgumentError
-    end
+    expect(img.info).to eq Riiif::ImageInformation.new(width: 800, height: 400)
   end
 
   describe 'info' do
     it 'returns the data' do
-      expect(subject.info).to eq Riiif::ImageInformation.new(800, 400)
+      expect(subject.info).to eq Riiif::ImageInformation.new(width: 800, height: 400)
     end
   end
 
@@ -59,7 +53,7 @@ RSpec.describe Riiif::Image do
     describe 'get info' do
       subject { described_class.new('Cave_26,_Ajanta') }
       it 'is easy' do
-        expect(subject.info).to eq Riiif::ImageInformation.new(600, 390)
+        expect(subject.info).to eq Riiif::ImageInformation.new(width: 600, height: 390)
       end
     end
 
@@ -77,7 +71,7 @@ RSpec.describe Riiif::Image do
   describe '#render' do
     before do
       allow(Riiif::CommandRunner).to receive(:execute)
-        .with("identify -format %hx%w #{filename}[0]").and_return('131x175')
+        .with("identify -format '%h %w %m' #{filename}[0]").and_return('131 175 JPEG')
     end
 
     describe 'region' do
@@ -108,7 +102,7 @@ RSpec.describe Riiif::Image do
 
         it 'runs the correct imagemagick command' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -crop 80%x70+18+13 -strip #{filename} png:-")
+            .with("convert -crop 80.0%x70.0+18+13 -strip #{filename} png:-")
           render
         end
       end
@@ -127,7 +121,7 @@ RSpec.describe Riiif::Image do
         let(:region) { '150x75' }
 
         it 'raises an error' do
-          expect { render }.to raise_error Riiif::InvalidAttributeError
+          expect { render }.to raise_error IIIF::Image::InvalidAttributeError
         end
       end
     end
@@ -150,7 +144,7 @@ RSpec.describe Riiif::Image do
 
         it 'runs the correct imagemagick command' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -resize 50% -strip #{filename} png:-")
+            .with("convert -resize 50.0% -strip #{filename} png:-")
           render
         end
       end
@@ -208,7 +202,7 @@ RSpec.describe Riiif::Image do
         let(:size) { '150x75' }
 
         it 'raises an error' do
-          expect { render }.to raise_error Riiif::InvalidAttributeError
+          expect { render }.to raise_error IIIF::Image::InvalidAttributeError
         end
       end
     end
@@ -240,7 +234,7 @@ RSpec.describe Riiif::Image do
         let(:rotation) { '150x' }
 
         it 'raises an error for invalid angle' do
-          expect { render }.to raise_error Riiif::InvalidAttributeError
+          expect { render }.to raise_error IIIF::Image::InvalidAttributeError
         end
       end
     end
@@ -292,7 +286,7 @@ RSpec.describe Riiif::Image do
         let(:quality) { 'best' }
 
         it 'raises an error' do
-          expect { render }.to raise_error Riiif::InvalidAttributeError
+          expect { render }.to raise_error IIIF::Image::InvalidAttributeError
         end
       end
     end