riiif 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 905d7f9639fc63f7764759b985ea235a4e369645
-  data.tar.gz: e73244b575876cd67008082a497a5cc9d339777f
+  metadata.gz: 0814f758c2b092db4867b41ebff4cf4d7c05f810
+  data.tar.gz: f4c1c9b97aaf9d4997581306809f1f1598011f2b
 SHA512:
-  metadata.gz: f4e8952000bb0374601d4b6d33e4d5428d721c69f30ef8bf5400e86021a4ce8214e764858401eb74779fe69380f51201ff968a3b678ae879caa7b066e2c7d77c
-  data.tar.gz: 4b46ed4fd0b9d004123b7fd181702a89f25019a9c891b6573b891ca0c6b0c1432a5814963b65d6cc4a25f63df8c84d7be2027d05e71c12efd6cd9db961237652
+  metadata.gz: 81000645e733fc009fd703dbaed8963aa26e32e3e0df85f8476a69b5cda5819462d6ab43673fc6bbd96d45efeedb1c16f1e4e98678325be621e47221d18f855f
+  data.tar.gz: 2cf093cacb93384de5df8ca6986a5bdff3789aa5617aad79e2f68c054d5342e7427d231ae0e588e4e7aefd6efac7ccc0545544c47e8d86c86708a78ab50b4332

data/README.md

@@ -1,4 +1,5 @@
 # Riiif
+[![Gem Version](https://badge.fury.io/rb/riiif.png)](http://badge.fury.io/rb/riiif)
 
 A Ruby IIIF image server as a rails engine
 
@@ -31,7 +32,7 @@ When the Id passed in is "foo_image", then it will look for an image file using
 ```
 
 ### Images retrieved over HTTP
-To source the images from the network instead of the file system, we first configure Riiif to use an alternative resolver:
+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
 ```
@@ -41,6 +42,11 @@ Then we configure the resolver with a mechanism for mapping the provided id to a
         "http://upload.wikimedia.org/wikipedia/commons/thumb/a/a4/#{id}.jpg/600px-#{id}.jpg"
       end
 ```
+
+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'`
+
 ## Usage
 
 Mount the gem as an engine:
@@ -57,6 +63,22 @@ 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
 
-For more information see the IIIF spec:
+### OpenSeadragon
+
+Riiif ships with OpenSeaDragon support.  To use it add this in your controller:
+
+```ruby
+helper Riiif::OpenseadragonHelper
+```
+
+Then in your view you can do this:
+```erb
+    <%=javascript_include_tag "openseadragon.js" %>
+    <%= openseadragon_viewer(@image.id, html: {style: 'width: 800px; height: 600px;'}) %>
+```
+
+
+## For more information
+see the IIIF spec:
 
 http://www-sul.stanford.edu/iiif/image-api/1.1/

data/app/helpers/riiif/openseadragon_helper.rb

@@ -0,0 +1,40 @@
+module Riiif
+  module OpenseadragonHelper
+    def openseadragon_viewer(id_or_image, options={})
+      image = case id_or_image
+      when String
+        Image.new(id_or_image)
+      when Image
+        id_or_image
+      end
+      options[:tile_width] ||= '1024'
+      options[:tile_height] ||= '1024'
+      options[:html_id] ||= 'openseadragon1'
+      options[:html] ||= {}
+      options[:html][:id] = options[:html_id]
+      options[:image_host] ||= '/image-service'
+      options[:prefix_url] ||= '/assets/openseadragon/'
+      js =<<-EOF
+        var viewer = OpenSeadragon({
+            id: "#{options[:html_id]}",
+            prefixUrl: "#{options[:prefix_url]}",
+            tileSources:   [{
+            "image_host":     "#{options[:image_host]}",
+            "identifier":   "#{image.id}",   
+            "width":        #{image.info[:width]},   
+            "height":       #{image.info[:height]},   
+            "scale_factors": [1, 2, 3, 4, 5],   
+            "tile_width":   #{options[:tile_width]},   
+            "tile_height":  #{options[:tile_height]},   
+            "formats":      [ "jpg", "png" ],   
+            "qualities":    ["native", "bitonal", "grey", "color"],   
+            "profile":      "http://library.stanford.edu/iiif/image-api/compliance.html#level3"
+          }]
+        });
+      EOF
+
+      #<%=javascript_include_tag "openseadragon.js" %>
+      content_tag(:div, '', options[:html]) + javascript_tag(js) 
+    end
+  end
+end

data/app/models/riiif/file.rb

@@ -2,27 +2,18 @@ require 'open3'
 module Riiif
   class File
     include Open3
+    include ActiveSupport::Benchmarkable
+
     attr_reader :path
+
+    delegate :logger, to: :Rails
+
     # @param input_path [String] The location of an image file
     def initialize(input_path, tempfile = nil)
-      raise "HUH" if input_path.is_a? Riiif::File
       @path = input_path
       @tempfile = tempfile # ensures that the tempfile will stick around until this file is garbage collected.
     end
 
-    def self.open(file_or_url, ext = nil)
-      file_or_url = file_or_url.to_s # Force it to be a String... hell or highwater
-      if file_or_url.include?("://")
-        require 'open-uri'
-        ext ||= ::File.extname(URI.parse(file_or_url).path)
-        Kernel::open(file_or_url) do |f|
-          self.read(f, ext)
-        end
-      else
-        self.new(file_or_url)
-      end
-    end
-
     def self.read(stream, ext)
       create(ext) do |f|
         while chunk = stream.read(8192)
@@ -60,7 +51,6 @@ module Riiif
         command << ' -type Bilevel'
       end
       command << " #{path} #{options[:format]}:-"
-      Rails.logger.debug "RIIIF executed: #{command}"
       execute(command)
     end
 
@@ -71,15 +61,19 @@ module Riiif
     end
 
     private
+
       def execute(command)
-          stdin, stdout, stderr, wait_thr = popen3(command)
-          stdin.close
-          stdout.binmode
-          out = stdout.read
-          stdout.close
-          err = stderr.read
-          stderr.close
-          raise "Unable to execute command \"#{command}\"\n#{err}" unless wait_thr.value.success?
+          out = nil
+          benchmark ("Riiif executed #{command}") do
+            stdin, stdout, stderr, wait_thr = popen3(command)
+            stdin.close
+            stdout.binmode
+            out = stdout.read
+            stdout.close
+            err = stderr.read
+            stderr.close
+            raise "Unable to execute command \"#{command}\"\n#{err}" unless wait_thr.value.success?
+          end
           out
       end
 

data/app/models/riiif/image.rb

@@ -7,28 +7,27 @@ module Riiif
 
     OUTPUT_FORMATS = %W{jpg png}
 
-    attr_reader :path_name, :id
+    attr_reader :id, :image
 
     # @param [String] id The identifier of the file
     def initialize(id)
       @id = id
-      @path_name = file_resolver.find(id)
+      @image = file_resolver.find(id)
     end
 
     def render(args)
       options = decode_options!(args)
-      # Use a MD5 digest to ensure the keys aren't too long.
-      digest = Digest::MD5.hexdigest(options.merge(id: id).to_s)
-      puts digest
-      Rails.cache.fetch(digest, compress: true, expires_in: 3.days) do
+      Rails.cache.fetch(Image.cache_key(id, options), compress: true, expires_in: 3.days) do
         image.extract(options)
       end
     end
 
     delegate :info, to: :image
 
-    def image
-      @image ||= Riiif::File.open(path_name)
+    def self.cache_key(id, options)
+      str = options.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)
     end
 
     private

data/app/views/riiif/images/view.html.erb

@@ -1,21 +1,2 @@
-    <div id="openseadragon1" style="width: 800px; height: 600px;"></div>
     <%=javascript_include_tag "openseadragon.js" %>
-    <script type="text/javascript">
-        var viewer = OpenSeadragon({
-            id: "openseadragon1",
-            prefixUrl: "/assets/openseadragon/",
-            tileSources:   [{
-            "image_host":     "http://localhost:8080/image-service",
-            "identifier":   "<%= @image.id %>",   
-            "width":        <%= @image.info[:width] %>,   
-            "height":       <%= @image.info[:height] %>,   
-            "scale_factors": [1, 2, 3, 4, 5],   
-            "tile_width":   1024,   
-            "tile_height":  1024,   
-            "formats":      [ "jpg", "png" ],   
-            "qualities":    ["native", "bitonal", "grey", "color"],   
-            "profile":      "http://library.stanford.edu/iiif/image-api/compliance.html#level1"
-          }]
-        });
-    </script>
-DOOD
+    <%= openseadragon_viewer(@image.id, html: {style: 'width: 800px; height: 600px;'}) %>

data/lib/riiif/file_system_file_resolver.rb

@@ -8,11 +8,17 @@ module Riiif
 
 
     def self.find(id)
-      Dir.glob(pattern(id)).first
+      Riiif::File.new(path(id))
     end
 
+    def self.path(id)
+      search = pattern(id)
+      Dir.glob(search).first || raise(Errno::ENOENT, search)
+    end
+
+
     def self.pattern(id)
-      raise ArgumentException, "Invalid characters in id `#{id}`" unless /^[\w-]+$/.match(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

@@ -1,3 +1,6 @@
+require 'open-uri'
+require 'active_support/core_ext/file/atomic'
+
 module Riiif
   module HTTPFileResolver
 
@@ -10,15 +13,64 @@ module Riiif
     #
     mattr_accessor :id_to_uri
 
+    mattr_accessor :cache_path
+    self.cache_path = 'tmp/network_files'
+
+
     def self.find(id)
-      uri(id)
+      remote = RemoteFile.new(uri(id))
+      Riiif::File.new(remote.fetch)
     end
 
-    protected
+    class RemoteFile
+      include ActiveSupport::Benchmarkable
+      delegate :logger, to: :Rails
+      attr_reader :url
+      def initialize(url)
+        @url = url 
+      end
+
+      def fetch
+        download_file unless ::File.exist?(file_name)
+        file_name
+      end
+
+      private
+
+      def ext
+        @ext ||= ::File.extname(URI.parse(url).path)
+      end
 
-    def self.uri(id)
-      raise "Must set the id_to_uri lambda" if id_to_uri.nil?
-      id_to_uri.call(id)
+      def file_name
+        @cache_file_name ||= ::File.join(HTTPFileResolver.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| 
+            Kernel::open(url) do |remote|
+              while chunk = remote.read(8192)
+                local.write(chunk)
+              end
+            end
+          end
+        end
+      end
+
+      # Make sure a file path's directories exist.
+      def ensure_cache_path(path)
+        FileUtils.makedirs(path) unless ::File.exist?(path)
+      end
     end
+
+
+    protected
+
+      def self.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/version.rb

@@ -1,3 +1,3 @@
 module Riiif
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/helpers/openseadragon_helper_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Riiif::OpenseadragonHelper do
+
+  it "should draw the viewer" do
+    out = openseadragon_viewer('world')
+    out.should == '<div id="openseadragon1"></div><script>
+//<![CDATA[
+        var viewer = OpenSeadragon({
+            id: "openseadragon1",
+            prefixUrl: "/assets/openseadragon/",
+            tileSources:   [{
+            "image_host":     "/image-service",
+            "identifier":   "world",   
+            "width":        800,   
+            "height":       400,   
+            "scale_factors": [1, 2, 3, 4, 5],   
+            "tile_width":   1024,   
+            "tile_height":  1024,   
+            "formats":      [ "jpg", "png" ],   
+            "qualities":    ["native", "bitonal", "grey", "color"],   
+            "profile":      "http://library.stanford.edu/iiif/image-api/compliance.html#level3"
+          }]
+        });
+
+//]]>
+</script>'
+  end
+end

data/spec/models/file_system_file_resolver_spec.rb

@@ -2,14 +2,17 @@ require 'spec_helper'
 
 describe Riiif::FileSystemFileResolver do
   subject { Riiif::FileSystemFileResolver }
-  it "should get nil when the file isn't found" do
-    expect(subject.find('1234')).to be_nil
+  it "should raise an error when the file isn't found" do
+    expect{subject.find('1234')}.to raise_error Errno::ENOENT
   end
   it "should get the jpeg2000 file" do
-    expect(subject.find('world')).to eq Riiif::FileSystemFileResolver.root + '/spec/samples/world.jp2'
+    expect(subject.find('world').path).to eq Riiif::FileSystemFileResolver.root + '/spec/samples/world.jp2'
   end
 
   it "should accept ids with dashes" do
     subject.pattern('foo-bar-baz')
   end
+  it "should accept ids with colins" do
+    subject.pattern('fo:baz')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riiif
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-18 00:00:00.000000000 Z
+date: 2013-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,7 @@ files:
 - 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
@@ -105,6 +106,7 @@ 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/image_spec.rb
 - spec/routing/resize_routes_spec.rb
@@ -162,6 +164,7 @@ 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/image_spec.rb
 - spec/routing/resize_routes_spec.rb