riiif 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13b44576c71052f837544aa7b4f35e1ead018009
-  data.tar.gz: a7bd5073a3091335aac72798bdd31881d8d15481
+  metadata.gz: dea7c70b11b5f293a13b1518eaad32036f450189
+  data.tar.gz: 26af68981801093f8d7a0f0e7b4f4aaf4d1cb14f
 SHA512:
-  metadata.gz: 9f12758453c5d6503e56993746130bca893379b2648fa6a2b5a305057710b76963fe688f4f8a080ba3543a11e1db13a880e9d848fce5ba6a2b3bacb51d1e8d5f
-  data.tar.gz: 69c991af0419d7413a7c8bb8d658ad0f703e3b68e27877c41a154e8061097531737d3fdb35848a5e703e4a121991d2c28243611451be42030e29b7069b56ccb5
+  metadata.gz: 619d7dd008484a2cb62d18d0a21d9e015d7d3a2c3b04065f3859eb59bf9857007b7768e2e1898f53b9795eff11f98eadeb0aef4be694d533a8ec1d822f5f70cc
+  data.tar.gz: 31a0d174c238ad6177b887028370665cb9e61dcf02522843a71be121e97ac88b2069ddab733b6e87d414332cb57eb53cb40de32bc35bc1d5c5a62b178b4280ae

data/README.md

@@ -63,18 +63,34 @@ Then you can make requests like this:
 * http://www.example.org/image-service/abcd1234/full/150,75/0/native.jpg
 * http://www.example.org/image-service/abcd1234/full/!150,75/0/native.jpg
 
-### OpenSeadragon
+### Using a default image
 
-Riiif ships with OpenSeaDragon support.  To use it add this in your controller:
+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
-helper Riiif::OpenseadragonHelper
+Riiif::not_found_image = 'path/to/image.png'
 ```
 
-Then in your view you can do this:
-```erb
-    <%=javascript_include_tag "openseadragon.js" %>
-    <%= openseadragon_viewer(@image.id, html: {style: 'width: 800px; height: 600px;'}) %>
+You can do this to create a default Riiif::Image to use (useful for passing "missing" images to openseadragon_collection_viewer):
+
+```ruby
+Riiif::Image.new('no_image', Riiif::File.new(Riiif.not_found_image))
+```
+
+## Running the tests
+First, build the engine
+```bash
+rake engine_cart:generate
+```
+
+ImageMagick must be installed with jasper support
+```bash
+brew install imagemagick --with-jasper # if using Homebrew
+```
+
+Run the tests
+```bash
+rake spec
 ```
 
 

data/Rakefile

@@ -1,9 +1,9 @@
 require "bundler/gem_tasks"
-
-require 'engine_cart/rake_task'
+require 'bundler/setup'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
+require 'engine_cart/rake_task'
 task :ci => ['engine_cart:generate'] do
   # run the tests
 end

data/app/controllers/riiif/images_controller.rb

@@ -2,9 +2,19 @@ module Riiif
   class ImagesController < ::ApplicationController
     before_filter :link_header, only: [:show, :info]
     def show
-      image = Image.new(params[:id])
+      begin
+        image = Image.new(params[:id])
+        status = :ok
+      rescue ImageNotFoundError
+        if Riiif.not_found_image.present?
+          image = Riiif::Image.new(params[:id], Riiif::File.new(Riiif.not_found_image))
+          status = :not_found
+        else
+          raise
+        end
+      end
       data = image.render(params.permit(:region, :size, :rotation, :quality, :format))
-      send_data data, type: Mime::Type.lookup_by_extension(params[:format]), :disposition => 'inline'
+      send_data data, status: status, type: Mime::Type.lookup_by_extension(params[:format]), :disposition => 'inline'
     end
 
     def info
@@ -18,8 +28,10 @@ module Riiif
 
     protected
 
+    LEVEL2 = 'http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level2'
+
     def link_header
-      response.headers["Link"] = '<http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level2>;rel="profile"'
+      response.headers["Link"] = "<#{LEVEL2}>;rel=\"profile\""
     end
 
     def server_info
@@ -27,7 +39,7 @@ module Riiif
         "@context" => "http://library.stanford.edu/iiif/image-api/1.1/context.json",
         "@id" => request.original_url.sub('/info.json', ''), 
         "formats" => Image::OUTPUT_FORMATS,
-        "profile" => "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level0"
+        "profile" => "#{LEVEL2}"
         
       }
     end

data/app/models/riiif/image.rb

@@ -9,10 +9,11 @@ module Riiif
 
     attr_reader :id, :image
 
-    # @param [String] id The identifier of the file
-    def initialize(id)
+    # @param [String] id The identifier of the file to be looked up.
+    # @param [Riiif::File] file Optional: The Riiif::File to use instead of looking one up.
+    def initialize(id, file=nil)
       @id = id
-      @image = file_resolver.find(id)
+      @image = file.present? ? file : file_resolver.find(id)
     end
 
     def render(args)

data/config/routes.rb

@@ -3,6 +3,6 @@ Riiif::Engine.routes.draw do
   SIZES ||= /(pct:)?[\w.,]+/
   get "/:id/:region/:size/:rotation/:quality(.:format)" => "images#show", 
     constraints: { rotation: ALLOW_DOTS, size: SIZES}
-  get "/:id/info(.:format)" => "images#info", :constraints => { :format => /json/}
+  get "/:id/info.json" => "images#info", defaults: { format: 'json' }, as: 'info'
   get "/:id/view(.:format)" => "images#view"
 end

data/lib/riiif.rb

@@ -9,4 +9,12 @@ module Riiif
 
   class Error < RuntimeError; end
   class InvalidAttributeError < Error; end
+  class ImageNotFoundError < Error
+    attr_reader :original_exception
+    def initialize(orig=nil)
+      @original_exception = orig
+    end
+  end
+
+  mattr_accessor :not_found_image # the image to use when a lookup fails
 end

data/lib/riiif/file_system_file_resolver.rb

@@ -13,7 +13,7 @@ module Riiif
 
     def self.path(id)
       search = pattern(id)
-      Dir.glob(search).first || raise(Errno::ENOENT, search)
+      Dir.glob(search).first || raise(ImageNotFoundError, search)
     end
 
 

data/lib/riiif/http_file_resolver.rb

@@ -49,10 +49,14 @@ module Riiif
         ensure_cache_path(::File.dirname(file_name))
         benchmark ("Riiif downloaded #{url}") do
           ::File.atomic_write(file_name, HTTPFileResolver.cache_path) do |local| 
-            Kernel::open(url) do |remote|
-              while chunk = remote.read(8192)
-                local.write(chunk)
+            begin
+              Kernel::open(url) do |remote|
+                while chunk = remote.read(8192)
+                  local.write(chunk)
+                end
               end
+            rescue OpenURI::HTTPError => e
+              raise ImageNotFoundError.new(e)
             end
           end
         end

data/lib/riiif/version.rb

@@ -1,3 +1,3 @@
 module Riiif
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/riiif.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "engine_cart"
   spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "sqlite3"
   spec.add_dependency 'rails', '> 3.2.0'
 end

data/spec/controllers/images_controller_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
+require 'open-uri'
 
 describe Riiif::ImagesController do
+  let(:filename) { File.expand_path('spec/samples/world.jp2') }
   routes { Riiif::Engine.routes }
   it "should send images to the service" do
     image = double
@@ -27,7 +29,64 @@ describe Riiif::ImagesController do
       "width" =>6000,
       "height" =>4000,
       "formats" =>  [ "jpg", "png" ],
-      "profile" =>  "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level0" 
+      "profile" =>  "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level2" 
     expect(response.headers['Link']).to eq '<http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level2>;rel="profile"'
   end
+
+  context "with a nonexistent image" do
+    it "should error 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: 'native', format: 'jpg'
+      end.to raise_error(StandardError)
+    end
+
+    context "with a default image set" do
+      around do |example|
+        old_value = Riiif.not_found_image
+        Riiif.not_found_image = filename
+        example.run
+        Riiif.not_found_image = old_value
+      end
+
+      it "should send the default 'not found' image for failed http files" do
+        not_found_image = double
+        expect(Riiif::Image).to receive(:new) do |id, file|
+          if file.present?
+            not_found_image
+          else
+            raise Riiif::ImageNotFoundError
+          end
+        end.twice
+        expect(not_found_image).to receive(:render).with("region" => 'full', "size" => 'full',
+                                  "rotation" => '0', "quality" => 'native',
+                                  "format" => 'jpg').and_return("default-image-data")
+
+        get :show, id: 'bad_id', action: "show", region: 'full', size: 'full',
+                   rotation: '0', quality: 'native', format: 'jpg'
+        expect(response).to be_not_found
+        expect(response.body).to eq 'default-image-data'
+      end
+
+      it "should send the default 'not found' image for failed files on the filesystem" do
+        not_found_image = double
+        expect(Riiif::Image).to receive(:new) do |id, file|
+          if file.present?
+            not_found_image
+          else
+            raise Riiif::ImageNotFoundError
+          end
+        end.twice
+        expect(not_found_image).to receive(:render).with("region" => 'full', "size" => 'full',
+                                  "rotation" => '0', "quality" => 'native',
+                                  "format" => 'jpg').and_return("default-image-data")
+
+        get :show, id: 'bad_id', action: "show", region: 'full', size: 'full', 
+                   rotation: '0', quality: 'native', format: 'jpg'
+        expect(response).to be_not_found
+        expect(response.body).to eq 'default-image-data'
+      end
+    end
+  end
 end

data/spec/models/file_system_file_resolver_spec.rb

@@ -3,8 +3,9 @@ require 'spec_helper'
 describe Riiif::FileSystemFileResolver do
   subject { Riiif::FileSystemFileResolver }
   it "should raise an error when the file isn't found" do
-    expect{subject.find('1234')}.to raise_error Errno::ENOENT
+    expect{subject.find('1234')}.to raise_error Riiif::ImageNotFoundError
   end
+
   it "should get the jpeg2000 file" do
     expect(subject.find('world').path).to eq Riiif::FileSystemFileResolver.root + '/spec/samples/world.jp2'
   end

data/spec/models/http_file_resolver_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Riiif::HTTPFileResolver do
+  subject { Riiif::HTTPFileResolver }
+  around do |example|
+    old_value = Riiif::HTTPFileResolver.id_to_uri
+    Riiif::HTTPFileResolver.id_to_uri = lambda {|id| id}
+    example.run
+    Riiif::HTTPFileResolver.id_to_uri = old_value
+  end
+
+  it "should raise an error when the file isn't found" do
+    expect(Kernel).to receive(:open).and_raise(OpenURI::HTTPError.new("failure", StringIO.new))
+    begin
+      subject.find('1234')
+    rescue Riiif::ImageNotFoundError => e
+    end
+    expect(e).to be_a Riiif::ImageNotFoundError
+    expect(e.original_exception).to be_an OpenURI::HTTPError
+  end
+end
+

data/spec/models/image_spec.rb

@@ -13,6 +13,12 @@ describe Riiif::Image do
     end
   end
 
+  it "should be able to override the file used for the Image" do
+    img = Riiif::Image.new('some_id', Riiif::File.new(filename))
+    expect(img.id).to eq 'some_id'
+    expect(img.info).to eq height: 400, width: 800
+  end
+
   describe "without a format" do
     it "should raise an error" do
       expect { subject.render('size' => 'full') }.to raise_error ArgumentError
@@ -41,7 +47,6 @@ describe Riiif::Image do
     end
   end
 
-
   describe "mogrify" do
     describe "region" do
       it "should return the original when specifing full size" do

data/spec/routing/resize_routes_spec.rb

@@ -42,5 +42,8 @@ describe "routes" do
       ).to route_to(controller: "riiif/images", id: 'abcd1234', 
                     action: "info", format: 'json')
     end
+    it "should have a route helper" do
+      expect(info_path('abcd1234')).to eq '/image-service/abcd1234/info.json'
+    end
   end
 end

metadata

@@ -1,83 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: riiif
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-21 00:00:00.000000000 Z
+date: 2014-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: engine_cart
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 3.2.0
 description: A IIIF image server
@@ -87,17 +101,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - app/controllers/riiif/images_controller.rb
-- app/helpers/riiif/openseadragon_helper.rb
 - app/models/riiif/file.rb
 - app/models/riiif/image.rb
-- app/views/riiif/images/view.html.erb
 - config/routes.rb
 - lib/riiif.rb
 - lib/riiif/engine.rb
@@ -106,38 +118,13 @@ files:
 - lib/riiif/version.rb
 - riiif.gemspec
 - spec/controllers/images_controller_spec.rb
-- spec/helpers/openseadragon_helper_spec.rb
 - spec/models/file_system_file_resolver_spec.rb
+- spec/models/http_file_resolver_spec.rb
 - spec/models/image_spec.rb
 - spec/routing/resize_routes_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
-- vendor/assets/images/openseadragon/fullpage_grouphover.png
-- vendor/assets/images/openseadragon/fullpage_hover.png
-- vendor/assets/images/openseadragon/fullpage_pressed.png
-- vendor/assets/images/openseadragon/fullpage_rest.png
-- vendor/assets/images/openseadragon/home_grouphover.png
-- vendor/assets/images/openseadragon/home_hover.png
-- vendor/assets/images/openseadragon/home_pressed.png
-- vendor/assets/images/openseadragon/home_rest.png
-- vendor/assets/images/openseadragon/next_grouphover.png
-- vendor/assets/images/openseadragon/next_hover.png
-- vendor/assets/images/openseadragon/next_pressed.png
-- vendor/assets/images/openseadragon/next_rest.png
-- vendor/assets/images/openseadragon/previous_grouphover.png
-- vendor/assets/images/openseadragon/previous_hover.png
-- vendor/assets/images/openseadragon/previous_pressed.png
-- vendor/assets/images/openseadragon/previous_rest.png
-- vendor/assets/images/openseadragon/zoomin_grouphover.png
-- vendor/assets/images/openseadragon/zoomin_hover.png
-- vendor/assets/images/openseadragon/zoomin_pressed.png
-- vendor/assets/images/openseadragon/zoomin_rest.png
-- vendor/assets/images/openseadragon/zoomout_grouphover.png
-- vendor/assets/images/openseadragon/zoomout_hover.png
-- vendor/assets/images/openseadragon/zoomout_pressed.png
-- vendor/assets/images/openseadragon/zoomout_rest.png
-- vendor/assets/javascripts/openseadragon.js
 homepage: https://github.com/curationexperts/riiif
 licenses:
 - APACHE2
@@ -148,27 +135,26 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A rails engine that support IIIF requests
 test_files:
 - spec/controllers/images_controller_spec.rb
-- spec/helpers/openseadragon_helper_spec.rb
 - spec/models/file_system_file_resolver_spec.rb
+- spec/models/http_file_resolver_spec.rb
 - spec/models/image_spec.rb
 - spec/routing/resize_routes_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
-has_rdoc: