riiif 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5e8d0c868b034e0955aef6e76fe8e6b0944787a
-  data.tar.gz: 5e8e67c40d3804bd7d3852b10f1347493d110c5f
+  metadata.gz: 201037b36eb8a0a7b31f6953ecaf4dbc980df9d4
+  data.tar.gz: 0eee522bedbd6e2653ef13621267dd23aeeacea0
 SHA512:
-  metadata.gz: b0f9f42f5a19abc877adba948c55b6e02ff5b03452d128df252823f65ac6c179e24e16885c9699550b4a86d09d5ddbed5463fc9b74ccccede4ea34d8adb49749
-  data.tar.gz: bb323cfe3324c38f2ebaffc0eec65044fd60c6fdd1cee9a0a3835f900ebec960f60402d770479ac716c8fdbfe254e556a3a2953d3cce6b4d3b94a342eee44ee1
+  metadata.gz: 0789760ccc3002354ad44cd5ca29547417d6375085dc7bb27600852b88df2aed746fbcd1e436f6b74958d09a722575e9deb8afea39f36542c7ffef802b970c38
+  data.tar.gz: dd653f25e076dc6ac8a3207132fd2652cf389158a74b2d6617e3c300ec1478f951c85f787752f9e93a29eb7dc718486129d42876118b8b73616f272f1b2b0e6e

data/README.md

@@ -5,6 +5,18 @@ A Ruby IIIF image server as a rails engine
 
 ## Installation
 
+RIIIF depends on Imagemagick so you must install that first. On a mac using Homebrew you can follow these instructions:
+
+ImageMagick (6.8.8) may be installed with a few options:
+* `--with-ghostscript` Compile with Ghostscript for Postscript/PDF support
+* `--with-tiff` Compile with libtiff support for TIFF files
+* `--with-jp2` Compile with openjpeg2 support for jpeg2000
+
+```bash
+brew install imagemagick --with-ghostscript --with-tiff --with-jp2
+```
+
+## Install the gem
 Add this line to your application's Gemfile:
 
     gem 'riiif'
@@ -63,6 +75,14 @@ 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
 
+### Route helpers
+
+It is prefereable that you use the provided route helpers to build these URIs. Here's an example:
+
+```ruby
+  image_tag(Riiif::Engine.routes.url_helpers.image_path(file_id, size: ',600'))
+```
+
 ### Using a default image
 
 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:
@@ -77,20 +97,56 @@ You can do this to create a default Riiif::Image to use (useful for passing "mis
 Riiif::Image.new('no_image', Riiif::File.new(Riiif.not_found_image))
 ```
 
+## Integration with Hydra/Fedora
+
+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
+
+# This tells RIIIF how to resolve the identifier to a URI in Fedora
+DATASTREAM = 'imageContent'
+Riiif::HTTPFileResolver.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, {})
+  host + '/' + path
+end
+
+# In order to return the info.json endpoint, we have to have the full height and width of
+# each image. If you are using hydra-file_characterization, you have the height & width 
+# cached in Solr. The following block directs the info_service to return those values:
+HEIGHT_SOLR_FIELD = 'height_isi'
+WIDTH_SOLR_FIELD = 'width_isi'
+Riiif::Image.info_service = lambda do |id, file|
+  resp = get_solr_response_for_doc_id id
+  doc = resp.first['response']['docs'].first
+  { height: doc[HEIGHT_SOLR_FIELD], width: doc[WIDTH_SOLR_FIELD] }
+end
+
+include Blacklight::SolrHelper
+def blacklight_config
+  CatalogController.blacklight_config
+end
+
+### ActiveSupport::Benchmarkable (used in Blacklight::SolrHelper) depends on a logger method
+
+def logger
+  Rails.logger
+end
+
+
+Riiif::Engine.config.cache_duration_in_days = 30
+```
+
+
 ## 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
-```
-It appears that as of imagemagick 6.8.8 you have to use openjpeg2 instead of jasper:
-http://www.imagemagick.org/discourse-server/viewtopic.php?f=2&t=25357#p109912
-This doesn't appear to be possible on homebrew until this ticket gets closed: https://github.com/Homebrew/homebrew/issues/28153
-
 Run the tests
 ```bash
 rake spec

data/app/models/riiif/image.rb

@@ -1,7 +1,7 @@
 require 'digest/md5'
 module Riiif
   class Image
-    
+
     class_attribute :file_resolver, :info_service
     self.file_resolver = FileSystemFileResolver
 
@@ -18,13 +18,17 @@ module Riiif
 
     OUTPUT_FORMATS = %W{jpg png}
 
-    attr_reader :id, :image
+    attr_reader :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.present? ? file : file_resolver.find(id)
+      @image = file if file.present?
+    end
+
+    def image
+      @image ||= file_resolver.find(id)
     end
 
     def render(args)

data/lib/riiif/version.rb

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

data/spec/models/image_spec.rb

@@ -31,19 +31,32 @@ describe Riiif::Image do
     end
   end
 
-  describe "get images from web" do
+  context "using HTTPFileResolver" do
     before do
       Riiif::Image.file_resolver = Riiif::HTTPFileResolver
-      Riiif::HTTPFileResolver.id_to_uri = lambda do |id| 
+      Riiif::HTTPFileResolver.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
     end
-    subject { Riiif::Image.new('Cave_26,_Ajanta') }
-    it "should be easy" do
-      expect(subject.info).to eq height: 390, width:600
+
+    describe "get info" do
+      subject { Riiif::Image.new('Cave_26,_Ajanta') }
+      it "should be easy" do
+        expect(subject.info).to eq height: 390, width:600
+      end
+    end
+
+    context "when the rendered image is in the cache" do
+      subject { Riiif::Image.new('Cave_26,_Ajanta') }
+      before { allow(Rails.cache).to receive(:fetch).and_return('expected') }
+
+      it "should not fetch the file" do
+        expect(Riiif::Image.file_resolver).not_to receive(:find)
+        expect(subject.render(region: 'full', format: 'png')).to eq 'expected'
+      end
     end
   end
 

data/spec/spec_helper.rb

@@ -4,20 +4,13 @@ ENV["RAILS_ENV"] ||= 'test'
 
 EngineCart.load_application!
 require 'rspec/rails'
-require 'rspec/autorun'
 
 
-
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
-  config.filter_run :focus
+
+  config.infer_spec_type_from_file_location!
+
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riiif
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2015-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler