riiif 0.0.10 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 201037b36eb8a0a7b31f6953ecaf4dbc980df9d4
-  data.tar.gz: 0eee522bedbd6e2653ef13621267dd23aeeacea0
+  metadata.gz: b40c5ba24332506e2dcb444e2034d45af7b96f22
+  data.tar.gz: 27a8f56407ceb92566925db564feb8bfff556e94
 SHA512:
-  metadata.gz: 0789760ccc3002354ad44cd5ca29547417d6375085dc7bb27600852b88df2aed746fbcd1e436f6b74958d09a722575e9deb8afea39f36542c7ffef802b970c38
-  data.tar.gz: dd653f25e076dc6ac8a3207132fd2652cf389158a74b2d6617e3c300ec1478f951c85f787752f9e93a29eb7dc718486129d42876118b8b73616f272f1b2b0e6e
+  metadata.gz: d98a5365e702626c211458f480d5b130089f4326bdd8f73c607141aaeaa52585e1b9d48fda9feb70705c57b359d6fbef8136817b10cfd95a8f4c65238cb6f59a
+  data.tar.gz: d42a807b1e645fa03e6d6bda49bd03b046c7b35470094cabe64b949f67203f943fe8e0e92cb521f825f0e18918c284302be2e399b5a151fe3047b6a795c9a445

data/.travis.yml

@@ -0,0 +1,8 @@
+notifications:
+  email: false
+
+rvm:
+  - 2.2
+
+sudo: false
+language: ruby

data/README.md

@@ -36,7 +36,7 @@ Or install it yourself as:
 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::FileSystemFileResolver.base_path = '/opt/repository/images/'
+    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: 
 ```
@@ -46,18 +46,22 @@ When the Id passed in is "foo_image", then it will look for an image file using
 ### Images retrieved over HTTP
 It's preferable to use files on the filesystem, because this avoids the overhead of downloading the file.  If this is unavoidable, Riiif can be configured to fetch files from the network.  To enable this behavior, configure Riiif to use an alternative resolver:
 ```
-      Riiif::Image.file_resolver = Riiif::HTTPFileResolver
+      Riiif::Image.file_resolver = Riiif::HTTPFileResolver.new
 ```
 Then we configure the resolver with a mechanism for mapping the provided id to a url:
 ```
-      Riiif::HTTPFileResolver.id_to_uri = lambda do |id| 
+      Riiif::Image.file_resolver.id_to_uri = lambda do |id|
         "http://upload.wikimedia.org/wikipedia/commons/thumb/a/a4/#{id}.jpg/600px-#{id}.jpg"
       end
 ```
+If you need to use HTTP basic authentication you can enable it like this:
+```
+      Riiif::Image.file_resolver.basic_auth_credentials = ['username', 's0s3kr3t']
+```
 
 This file resolver caches the network files, so you will want to clear out the old files or the cache will expand until you run out of disk space.
 Using a script like this would be a good idea: https://github.com/pulibrary/loris/blob/607567b921404a15a2111fbd7123604f4fdec087/bin/loris-cache_clean.sh
-By default the cache is located in `tmp/network_files`. You can set the cache path like this: `Riiif::HTTPFileResolver.cache_path = '/var/cache'`
+By default the cache is located in `tmp/network_files`. You can set the cache path like this: `Riiif::Image.file_resolver.cache_path = '/var/cache'`
 
 ## Usage
 
@@ -103,11 +107,11 @@ Create an initializer like this in `config/initializers/riiif_initializer.rb`
 
 ```ruby
 # Tell RIIIF to get files via HTTP (not from the local disk)
-Riiif::Image.file_resolver = Riiif::HTTPFileResolver
+Riiif::Image.file_resolver = Riiif::HTTPFileResolver.new
 
 # This tells RIIIF how to resolve the identifier to a URI in Fedora
 DATASTREAM = 'imageContent'
-Riiif::HTTPFileResolver.id_to_uri = lambda do |id| 
+Riiif::Image.file_resolver.id_to_uri = lambda do |id| 
   connection = ActiveFedora::Base.connection_for_pid(id)
   host = connection.config[:url]
   path = connection.api.datastream_content_url(id, DATASTREAM, {})

data/Rakefile

@@ -4,6 +4,8 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 require 'engine_cart/rake_task'
-task :ci => ['engine_cart:generate'] do
-  # run the tests
+task ci: ['engine_cart:generate'] do
+  Rake::Task["spec"].invoke
 end
+
+task default: :ci

data/app/controllers/riiif/images_controller.rb

@@ -3,11 +3,11 @@ module Riiif
     before_filter :link_header, only: [:show, :info]
     def show
       begin
-        image = Image.new(params[:id])
+        image = model.new(image_id)
         status = :ok
       rescue ImageNotFoundError
         if Riiif.not_found_image.present?
-          image = Riiif::Image.new(params[:id], Riiif::File.new(Riiif.not_found_image))
+          image = model.new(image_id, Riiif::File.new(Riiif.not_found_image))
           status = :not_found
         else
           raise
@@ -18,17 +18,20 @@ module Riiif
     end
 
     def info
-      image = Image.new(params[:id])
+      image = model.new(image_id)
       render json: image.info.merge(server_info)
     end
 
-    def view
-      @image = Image.new(params[:id])
-    end
-
     protected
 
     LEVEL2 = 'http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level2'
+    def model
+      params.fetch(:model, "riiif/image").camelize.constantize
+    end
+
+    def image_id
+      params[:id]
+    end
 
     def link_header
       response.headers["Link"] = "<#{LEVEL2}>;rel=\"profile\""
@@ -38,7 +41,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,
+        "formats" => model::OUTPUT_FORMATS,
         "profile" => "#{LEVEL2}"
         
       }

data/app/models/riiif/image.rb

@@ -3,7 +3,7 @@ module Riiif
   class Image
 
     class_attribute :file_resolver, :info_service
-    self.file_resolver = FileSystemFileResolver
+    self.file_resolver = FileSystemFileResolver.new
 
     # this is the default info service
     # returns a hash with the original image dimensions.

data/config/routes.rb

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

data/lib/riiif/engine.rb

@@ -1,6 +1,6 @@
 module Riiif
   class Engine < ::Rails::Engine
-    isolate_namespace Riiif
+    require 'riiif/rails/routes'
 
     # How long to cache the tiles for.
     config.cache_duration_in_days = 3

data/lib/riiif/file_system_file_resolver.rb

@@ -1,23 +1,24 @@
 module Riiif
-  module FileSystemFileResolver
-    mattr_accessor :root, :base_path, :input_types
-
-    self.root = File.expand_path(File.join(File.dirname(__FILE__), '../..'))
-    self.base_path = File.join(root, 'spec/samples')
-    self.input_types = %W{png jpg tiff jp jp2}
+  class FileSystemFileResolver
+    attr_accessor :root, :base_path, :input_types
 
+    def initialize
+      @root = ::File.expand_path(::File.join(::File.dirname(__FILE__), '../..'))
+      @base_path = ::File.join(root, 'spec/samples')
+      @input_types = %W{png jpg tiff jp jp2}
+    end
 
-    def self.find(id)
+    def find(id)
       Riiif::File.new(path(id))
     end
 
-    def self.path(id)
+    def path(id)
       search = pattern(id)
       Dir.glob(search).first || raise(ImageNotFoundError, search)
     end
 
 
-    def self.pattern(id)
+    def pattern(id)
       raise ArgumentError, "Invalid characters in id `#{id}`" unless /^[\w\-:]+$/.match(id)
       ::File.join(base_path, "#{id}.{#{input_types.join(',')}}")
     end

data/lib/riiif/http_file_resolver.rb

@@ -2,32 +2,46 @@ require 'open-uri'
 require 'active_support/core_ext/file/atomic'
 
 module Riiif
-  module HTTPFileResolver
+  class HTTPFileResolver
 
     # Set a lambda that maps the first parameter (id) to a URL
     # Example:
     #
-    # Riiif::HTTPFileResolver.id_to_uri = lambda do |id| 
+    # resolver = Riiif::HTTPFileResolver.new
+    # resolver.id_to_uri = lambda do |id|
     #  "http://upload.wikimedia.org/wikipedia/commons/thumb/a/a4/#{id}.jpg/600px-#{id}.jpg"
     # end
     #
-    mattr_accessor :id_to_uri
-
-    mattr_accessor :cache_path
-    self.cache_path = 'tmp/network_files'
+    attr_accessor :id_to_uri
+    attr_accessor :basic_auth_credentials
+    attr_accessor :cache_path
 
+    def initialize
+      @cache_path = 'tmp/network_files'
+    end
 
-    def self.find(id)
-      remote = RemoteFile.new(uri(id))
+    def find(id)
+      remote = RemoteFile.new(uri(id),
+                              cache_path: cache_path,
+                              basic_auth_credentials: basic_auth_credentials)
       Riiif::File.new(remote.fetch)
     end
 
     class RemoteFile
       include ActiveSupport::Benchmarkable
       delegate :logger, to: :Rails
-      attr_reader :url
-      def initialize(url)
-        @url = url 
+      attr_reader :url, :cache_path
+      def initialize(url, options = {})
+        @url = url
+        @options = options
+      end
+
+      def cache_path
+        @options.fetch(:cache_path)
+      end
+
+      def basic_auth_credentials
+        @options[:basic_auth_credentials]
       end
 
       def fetch
@@ -42,15 +56,15 @@ module Riiif
       end
 
       def file_name
-        @cache_file_name ||= ::File.join(HTTPFileResolver.cache_path, Digest::MD5.hexdigest(url)+"#{ext}")
+        @cache_file_name ||= ::File.join(cache_path, Digest::MD5.hexdigest(url)+"#{ext}")
       end
 
       def download_file
         ensure_cache_path(::File.dirname(file_name))
         benchmark ("Riiif downloaded #{url}") do
-          ::File.atomic_write(file_name, HTTPFileResolver.cache_path) do |local| 
+          ::File.atomic_write(file_name, cache_path) do |local|
             begin
-              Kernel::open(url) do |remote|
+              Kernel::open(url, download_opts) do |remote|
                 while chunk = remote.read(8192)
                   local.write(chunk)
                 end
@@ -62,6 +76,12 @@ module Riiif
         end
       end
 
+      # Get a hash of options for passing to Kernel::open
+      # This is the primary pathway for passing basic auth credentials
+      def download_opts
+        basic_auth_credentials ? { http_basic_authentication: basic_auth_credentials } : {}
+      end
+
       # Make sure a file path's directories exist.
       def ensure_cache_path(path)
         FileUtils.makedirs(path) unless ::File.exist?(path)
@@ -71,7 +91,7 @@ module Riiif
 
     protected
 
-      def self.uri(id)
+      def uri(id)
         raise "Must set the id_to_uri lambda" if id_to_uri.nil?
         id_to_uri.call(id)
       end

data/lib/riiif/rails/routes.rb

@@ -0,0 +1,12 @@
+module ActionDispatch::Routing
+  class Mapper
+    # example
+    #   iiif_for :image
+    def iiif_for(*resources)
+      options = resources.extract_options!
+
+      Riiif::Routes.new(self, options.merge(resource: resources.first)).draw
+
+    end
+  end
+end

data/lib/riiif/routes.rb

@@ -0,0 +1,29 @@
+module Riiif
+  class Routes
+    ALLOW_DOTS ||= /[\w.]+/
+    SIZES ||= /(pct:)?[\w.,]+/
+
+    def initialize(router, options)
+      @router = router
+      @options = options
+    end
+
+    def add_routes &blk
+      @router.instance_exec(@options, &blk)
+    end
+
+    def draw
+      add_routes do |options|
+        resource = options.fetch(:resource)
+        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: 'native', model: resource },
+          as: options[:as] || "image"
+
+        get "#{route_prefix}/:id/info.json" => "riiif/images#info", defaults: { format: 'json', model: resource  }, as: [options[:as], "info"].compact.join("_")
+      end
+    end
+  end
+end

data/lib/riiif/version.rb

@@ -1,3 +1,3 @@
 module Riiif
-  VERSION = "0.0.10"
+  VERSION = "0.1.0"
 end

data/lib/riiif.rb

@@ -6,6 +6,7 @@ module Riiif
   autoload :Image
   autoload :FileSystemFileResolver
   autoload :HTTPFileResolver
+  autoload :Routes
 
   class Error < RuntimeError; end
   class InvalidAttributeError < Error; end

data/spec/controllers/images_controller_spec.rb

@@ -25,7 +25,7 @@ describe Riiif::ImagesController do
     expect(response).to be_successful
     json = JSON.parse(response.body)
     expect(json).to eq "@context"=>"http://library.stanford.edu/iiif/image-api/1.1/context.json",
-      "@id" =>"http://test.host/image-service/abcd1234",
+      "@id" =>"http://test.host/abcd1234",
       "width" =>6000,
       "height" =>4000,
       "formats" =>  [ "jpg", "png" ],

data/spec/models/file_system_file_resolver_spec.rb

@@ -1,13 +1,13 @@
 require 'spec_helper'
 
 describe Riiif::FileSystemFileResolver do
-  subject { Riiif::FileSystemFileResolver }
+  subject { Riiif::FileSystemFileResolver.new }
   it "should raise an error when the file isn't found" do
     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'
+    expect(subject.find('world').path).to eq subject.root + '/spec/samples/world.jp2'
   end
 
   it "should accept ids with dashes" do

data/spec/models/http_file_resolver_spec.rb

@@ -1,15 +1,16 @@
 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
+  subject { Riiif::HTTPFileResolver.new }
+
+  before do
+    Dir.glob("tmp/network_files/*") do |f|
+      File.unlink(f)
+    end
+    subject.id_to_uri = lambda {|id| id}
   end
 
-  it "should raise an error when the file isn't found" do
+  it "raises 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')
@@ -18,5 +19,16 @@ describe Riiif::HTTPFileResolver do
     expect(e).to be_a Riiif::ImageNotFoundError
     expect(e.original_exception).to be_an OpenURI::HTTPError
   end
-end
 
+  context "when basic authentication credentials are set" do
+    let(:credentials) { ['username', 's0s3kr3t'] }
+    before do
+      subject.basic_auth_credentials = credentials
+    end
+
+    it "should use basic auth credentials" do
+      expect(Kernel).to receive(:open).with("1234", { http_basic_authentication: credentials })
+      subject.find('1234')
+    end
+  end
+end

data/spec/models/image_spec.rb

@@ -33,13 +33,13 @@ describe Riiif::Image do
 
   context "using HTTPFileResolver" do
     before do
-      Riiif::Image.file_resolver = Riiif::HTTPFileResolver
-      Riiif::HTTPFileResolver.id_to_uri = lambda do |id|
+      Riiif::Image.file_resolver = Riiif::HTTPFileResolver.new
+      Riiif::Image.file_resolver.id_to_uri = lambda do |id|
         "http://upload.wikimedia.org/wikipedia/commons/thumb/a/a4/#{id}.jpg/600px-#{id}.jpg"
       end
     end
     after do
-      Riiif::Image.file_resolver = Riiif::FileSystemFileResolver
+      Riiif::Image.file_resolver = Riiif::FileSystemFileResolver.new
     end
 
     describe "get info" do

data/spec/routing/resize_routes_spec.rb

@@ -9,7 +9,7 @@ describe "routes" do
         get: "/abcd1234/full/full/0/native.jpg"
       ).to route_to(controller: "riiif/images", id: 'abcd1234', action: "show", 
                     region: 'full', size: 'full', rotation: '0', 
-                    quality: 'native', format: 'jpg')
+                    quality: 'native', format: 'jpg', model: "riiif/image")
     end
 
     it "routes requests with floating point percent size" do
@@ -17,30 +17,30 @@ describe "routes" do
         get: "/abcd1234/full/pct:12.5/22.5/native.jpg"
       ).to route_to(controller: "riiif/images", id: 'abcd1234', action: "show", 
                     region: 'full', size: 'pct:12.5', rotation: '22.5', 
-                    quality: 'native', format: 'jpg')
+                    quality: 'native', format: 'jpg', model: "riiif/image")
     end
     it "routes requests with pixel size" do
       expect(
         get: "/abcd1234/full/100,50/22.5/native.jpg"
       ).to route_to(controller: "riiif/images", id: 'abcd1234', action: "show", 
                     region: 'full', size: '100,50', rotation: '22.5', 
-                    quality: 'native', format: 'jpg')
+                    quality: 'native', format: 'jpg', model: "riiif/image")
     end
     it "routes requests with dashes in the id" do
       expect(
         get: "/abcd-1234-5678/full/full/0/native.jpg"
       ).to route_to(controller: "riiif/images", id: 'abcd-1234-5678', action: "show", 
                     region: 'full', size: 'full', rotation: '0', 
-                    quality: 'native', format: 'jpg')
+                    quality: 'native', format: 'jpg', model: "riiif/image")
     end
 
     describe "route helper" do
       it "takes all the options" do
         expect(image_path('abcd1234', region: 'full', size: '100,50', rotation: '22.5', quality: 'native',
-                          format: 'jpg')).to eq '/image-service/abcd1234/full/100,50/22.5/native.jpg'
+                          format: 'jpg')).to eq '/abcd1234/full/100,50/22.5/native.jpg'
       end
       it "has defaults" do
-        expect(image_path('abcd1234', size: '100,50')).to eq '/image-service/abcd1234/full/100,50/0/native.jpg'
+        expect(image_path('abcd1234', size: '100,50')).to eq '/abcd1234/full/100,50/0/native.jpg'
       end
     end
   end
@@ -50,10 +50,10 @@ describe "routes" do
       expect(
         get: "/abcd1234/info.json"
       ).to route_to(controller: "riiif/images", id: 'abcd1234', 
-                    action: "info", format: 'json')
+                    action: "info", format: 'json', model: "riiif/image")
     end
     it "should have a route helper" do
-      expect(info_path('abcd1234')).to eq '/image-service/abcd1234/info.json'
+      expect(info_path('abcd1234')).to eq '/abcd1234/info.json'
     end
   end
 end

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -4,7 +4,7 @@ class TestAppGenerator < Rails::Generators::Base
   source_root "spec/test_app_templates"
 
   def add_routes
-    route "mount Riiif::Engine => '/image-service'"
+    route "iiif_for 'riiif/image', at: '/image-service'"
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riiif
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-16 00:00:00.000000000 Z
+date: 2015-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,6 +103,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -115,6 +116,8 @@ files:
 - lib/riiif/engine.rb
 - lib/riiif/file_system_file_resolver.rb
 - lib/riiif/http_file_resolver.rb
+- lib/riiif/rails/routes.rb
+- lib/riiif/routes.rb
 - lib/riiif/version.rb
 - riiif.gemspec
 - spec/controllers/images_controller_spec.rb
@@ -145,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A rails engine that support IIIF requests