djatoka 0.2.2 → 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11aaf1e80818a81069ad5935756e293a80b87dbf
+  data.tar.gz: 850d1b033f7c80a5ac496e1fcfa3902ad1040bb8
+SHA512:
+  metadata.gz: ac8a7b99068dd81346499e49302d00a5bced11ee481744f8a3698e8f4ff66f93adcffbe6e8a2fa741c1a4bc96e012e518088116f576f4232a4b808f39c996288
+  data.tar.gz: 3e0231731a8cbe8154d37895994a2e8b0d097eaae00a40866dd3bf15a5e64302bda280e16e7991e05a1de3e258e938c2d1b949a8fbff314589a21cb1e2444373

data/.gitignore

@@ -21,5 +21,7 @@ pkg
 ## PROJECT::SPECIFIC
 .redcar
 .rvmrc
+.ruby-gemset
+.ruby-version
 
 .rbx

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    djatoka (0.2.0)
+    djatoka (0.2.2)
       addressable
       hashie
       json
+      mime-types
       trollop
 
 GEM
@@ -13,10 +14,12 @@ GEM
     activesupport (3.2.13)
       i18n (= 0.6.1)
       multi_json (~> 1.0)
-    addressable (2.3.3)
+    addressable (2.3.4)
     bourne (1.4.0)
       mocha (~> 0.13.2)
     coderay (1.0.9)
+    equivalent-xml (0.3.0)
+      nokogiri (>= 1.4.3)
     fakeweb (1.3.0)
     ffi (1.6.0-java)
     hashie (2.0.3)
@@ -25,9 +28,12 @@ GEM
     json (1.7.7-java)
     metaclass (0.0.1)
     method_source (0.8.1)
+    mime-types (1.22)
     mocha (0.13.3)
       metaclass (~> 0.0.1)
     multi_json (1.7.2)
+    nokogiri (1.5.9)
+    nokogiri (1.5.9-java)
     pry (0.9.12)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
@@ -59,6 +65,7 @@ PLATFORMS
 
 DEPENDENCIES
   djatoka!
+  equivalent-xml
   fakeweb
   mocha
   pry

data/README.rdoc

@@ -90,6 +90,46 @@ Tested with the following Ruby versions:
 - 1.8.7-p302
 - 1.9.2-p0
 
+== IIIF Support
+This gem can translate parameters from {International Image Interoperability Framework (IIIF)}[http://www-sul.stanford.edu/iiif/image-api/] requests into Djatoka requests.  It follows the same pattern as creating a Djatoka::Region
+
+=== IIIF Example
+  # Create a resolver object with a URL.
+  resolver = Djatoka::Resolver.new('http://african.lanl.gov/adore-djatoka/resolver')
+
+  # A known good identifier
+  identifier = 'info:lanl-repo/ds/5aa182c2-c092-4596-af6e-e95d2e263de3'
+
+  # IIIF Image Request
+  # Create a IiifRequest with the resolver and id
+  iiif_request = Djatoka::IiifRequest.new(resolver, identifier)
+
+  # Set IIIF parameters and create a Djatoka::Region
+  # Note: All IIIF parameters are required before creating a Djatoka::Region
+  djatoka_region = iiif_request.region('full').size('full').rotation('0').quality('native').format('jpg').djatoka_region
+
+  # Use the Djatoka::Region as normal
+  djatoka_region.url
+
+  # IIIF Info Request (Metadata)
+  # First, create a Djatoka::Metadata object and perform the request to the server for metadata.
+  metadata = resolver.metadata(identifier).perform
+
+  # Create a IIIF Info json response string
+  # Set values to optional fields by passing in a block and calling setters on the yielded Mash
+  json = metadata.to_iiif_json do |info|
+    info.tile_width   = 512
+    info.tile_height  = 512
+    info.formats      = ['jpg', 'png']
+    info.qualities    = ['native', 'grey']
+    info.profile      = 'http://library.stanford.edu/iiif/image-api/compliance.html#level1'
+    info.image_host   = 'http://myserver.com/image'
+  end
+
+  # If you want the xml flavor of a IIIF Info response, use
+  xml = metadata.to_iiif_xml
+  # It can be called with the same type of block as #to_iiif_json
+
 == Commandline
 
 There is also a little commandline utility for outputting the OpenURL.
@@ -102,14 +142,13 @@ There is also a little commandline utility for outputting the OpenURL.
 
     $ djatoka_url --help
 
-
 == TODO
 - Testing the view helpers.
 - View more examples of images where the dwtLevels differ from the Djatoka levels.
 
-== Author
+== Authors
 
-Jason Ronallo
+Jason Ronallo, Willy Mene
 
 == Copyright
 

data/djatoka.gemspec

@@ -5,9 +5,9 @@
 
 Gem::Specification.new do |s|
   s.name = %q{djatoka}
-  s.version = "0.2.2"
-  s.authors = ["Jason Ronallo"]
-  s.email = %q{jronallo@gmail.com}
+  s.version = "0.2.3"
+  s.authors = ["Jason Ronallo", "Willy Mene"]
+  s.email = %q{jronallo@gmail.com wmene@stanford.edu}
   s.homepage = %q{http://github.com/jronallo/djatoka}
   s.summary = %q{Djatoka image server helpers for Ruby and Rails.}
   s.description = %q{The djatoka library provides some simple methods for creation of the OpenURLs needed to communicate with the Djatoka image server.}
@@ -16,15 +16,17 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
+
   s.add_dependency "addressable"
   s.add_dependency "hashie"
   s.add_dependency "json"
-  
+  s.add_dependency "mime-types"
+
   s.add_dependency "trollop"
 
   s.add_development_dependency "mocha"
   s.add_development_dependency "fakeweb"
   s.add_development_dependency "shoulda"
+  s.add_development_dependency "equivalent-xml"
 end
 

data/lib/djatoka/iiif_request.rb

@@ -0,0 +1,163 @@
+
+# For rotation param testing.  Allows you to do the following with String:
+#  '123.456'.numeric? => true
+class String
+  def numeric?
+    return true if self =~ /^\d+$/
+    true if Float(self) rescue false
+  end
+end
+
+module Djatoka
+
+  class IiifException < Exception; end
+
+  class IiifInvalidParam < IiifException
+
+    def initialize (param_name, value=nil)
+      @param_name = param_name
+      @value = value
+    end
+
+    def to_s
+      "#{@param_name.capitalize} is invalid: " << @value.to_s
+    end
+
+  end
+
+  #  A class for translating IIIF parameters into a Djatoka::Region object.
+  #
+  #  * See the {documentation for the IIIF API}[http://www-sul.stanford.edu/iiif/image-api/#size]
+  #
+  #  It behaves like the Djatoka::Region object, in that you can chain methods together when setting params.
+  #  Once you've set all the params, call #djatoka_region to translate the parameters.  Validation of
+  #  values occurs in this method, and a Djatoka::IiifInvalidParam exception is raised if any of the values
+  #  are invalid.
+  #
+  #  *  Usage example
+  #   resolver = Djatoka::Resolver.new('http://server.edu/adore-djatoka/resolver')
+  #   id = 'someImageId1234'
+  #
+  #   request = Djatoka::IiifRequest.new(resolver, id)
+  #   djatoka_region = request.region('full').size('full').rotation('0').quality('native').format('jpg').djatoka_region
+  class IiifRequest
+
+    ALL_PARAMS = Set.new(['region', 'size', 'rotation', 'quality', 'format'])
+
+    attr_accessor :iiif_params
+
+    # You can set the params for the request in 2 ways:
+    # 1. Pass in params as a hash with the IIIF parameters {:id => 'some/id', :region => 'full'...}
+    # 2. Do not pass in params, and use the chain methods to set each value
+    def initialize(resolver, id, params = nil)
+      @id = id
+      @resolver = resolver
+      @iiif_params = Hashie::Mash.new
+
+      if(!params.nil? && params.is_a?(Hash))
+        params.keys.each do |k|
+          self.send("#{k}", params[k])
+        end
+      end
+      # else, params is nil, the caller will set each value
+    end
+
+    def id(v)
+      @iiif_params[:id] = v
+      self
+    end
+
+    def region(v)
+      @iiif_params[:region] = v
+      self
+    end
+
+    def size(v)
+      @iiif_params[:size] = v
+      self
+    end
+
+    def rotation(v)
+      @iiif_params[:rotation] = v
+      self
+    end
+
+    def quality(v)
+      @iiif_params[:quality] = v
+      self
+    end
+
+    def format(v)
+      @iiif_params[:format] = v
+      self
+    end
+
+    def all_params_present?
+      names = Set.new(@iiif_params.keys)
+      names == ALL_PARAMS
+    end
+
+    def djatoka_region
+      unless(all_params_present?)
+        current = Set.new(@iiif_params.keys)
+        missing = (ALL_PARAMS - current).to_a
+        msg = "Invalid IIIF request.  The following params are missing: " << missing.join(',')
+        raise IiifException.new(msg)
+      end
+
+      region = @resolver.region(@iiif_params[:id])
+
+      if(@iiif_params[:region] =~ /^(\d+),(\d+),(\d+),(\d+)$/)
+        region.region("#{$2},#{$1},#{$4},#{$3}")
+      elsif(!(@iiif_params[:region] =~ /^full$/i))
+        raise IiifInvalidParam.new "region", @iiif_params[:region]
+      end
+
+      s = @iiif_params[:size]
+      case s
+      when /^full$/i
+        s #noop
+      when /^(\d+),$/
+        region.scale( ["#{$1}", "0"] ) #w => w,0
+      when /^,(\d+)$/
+        region.scale( ["0", "#{$1}"] ) #h => 0,h
+      when /^pct:(\d+)$/i
+        dj_scale = $1.to_f / 100.0
+        region.scale(dj_scale.to_s)
+      when /^(\d+),(\d+)$/
+        region.scale("#{$1},#{$2}")
+      # TODO Best Fit: when /^!(\d+),(\d+)$/
+      else
+        raise IiifInvalidParam.new "size", s
+      end
+
+      unless(@iiif_params[:rotation].numeric?)
+        raise IiifInvalidParam.new "rotation", @iiif_params[:rotation]
+      end
+      region.rotate(@iiif_params[:rotation])
+
+      f = @iiif_params[:format]
+      if(f)
+        if(f =~ /\//)
+          type = MIME::Types[f].first
+        else
+          type = MIME::Types.type_for(@iiif_params[:format]).first
+        end
+        raise IiifInvalidParam.new("format", f) if(type.nil?)
+      else
+        #default to jpg or let djatoka determine default
+        type = MIME::Types.type_for('jpg').first
+      end
+      region.format(type.to_s)
+
+      unless(@iiif_params[:quality] =~ /^(native|color|grey|bitonal)$/i)
+        raise IiifInvalidParam.new 'quality', @iiif_params[:quality]
+      end
+
+      region
+
+    end
+
+  end
+
+end

data/lib/djatoka/metadata.rb

@@ -56,7 +56,7 @@ class Djatoka::Metadata
   def all_levels
     perform if !response # if we haven't already performed the metadata query do it now
     levels_hash = Hashie::Mash.new
-    levels_i = levels.to_i 
+    levels_i = levels.to_i
     (0..levels_i).each do |level_num|
       level_height = height.to_i
       level_width = width.to_i
@@ -71,9 +71,94 @@ class Djatoka::Metadata
     end
     levels_hash
   end
-    
+
   def max_level
-    all_levels.keys.sort.last  
+    all_levels.keys.sort.last
+  end
+
+  # Builds a String containing the JSON response to a IIIF Image Information Request
+  #
+  # * {Documentation about the Image Info Request}[http://www-sul.stanford.edu/iiif/image-api/#info]
+  #
+  # It will fill in the required fields of identifier, width, and height.  It will also fill in
+  # the scale_factors as determined from Djatoka::Metadata#levels
+  # The method yields a Mash where you can set the value of the optional fields.  Here's an example:
+  #
+  #   metadata.to_iiif_xml do |info|
+  #     info.tile_width   = 512
+  #     info.tile_height  = 512
+  #     info.formats      = ['jpg', 'png']
+  #     info.qualities    = ['native', 'grey']
+  #     info.profile      = 'http://library.stanford.edu/iiif/image-api/compliance.html#level1'
+  #     info.image_host   = 'http://myserver.com/image'
+  #   end
+  def to_iiif_json(&block)
+     info = Hashie::Mash.new
+     info.identifier =  @rft_id
+     info.width = @width.to_i
+     info.height = @height.to_i
+     info.scale_factors = levels_as_i
+     # optional fields map directly to json from the Mash
+     yield(info)
+
+     # convert strings to ints for tile width and height
+     info.tile_width = info.tile_width.to_i if(info.tile_width?)
+     info.tile_height = info.tile_height.to_i if(info.tile_height?)
+     JSON.pretty_generate(info)
+  end
+
+  # Builds a String containing the xml response to a IIIF Image Information Request
+  #
+  # * {Documentation about the Image Info Request}[http://www-sul.stanford.edu/iiif/image-api/#info]
+  #
+  # It will fill in the required fields of identifier, width, and height.  It will also fill in
+  # the scale_factors as determined from Djatoka::Metadata#levels
+  # The method yields a Mash where you can set the values of the optional fields.  Here's an example:
+  #
+  #   metadata.to_iiif_json do |info|
+  #     info.tile_width   = 512
+  #     info.tile_height  = 512
+  #     info.formats      = ['jpg', 'png']
+  #     info.qualities    = ['native', 'grey']
+  #     info.profile      = 'http://library.stanford.edu/iiif/image-api/compliance.html#level1'
+  #     info.image_host   = 'http://myserver.com/image'
+  #   end
+  def to_iiif_xml(&block)
+    builder = Nokogiri::XML::Builder.new do |xml|
+      info = Hashie::Mash.new
+      yield(info)
+      xml.info('xmlns' => 'http://library.stanford.edu/iiif/image-api/ns/') {
+        xml.identifier @rft_id
+        xml.width @width
+        xml.height @height
+        xml.scale_factors {
+          levels_as_i.each {|lvl| xml.scale_factor lvl}
+        }
+
+        #optional fields
+        xml.tile_width info.tile_width if(info.tile_width?)
+        xml.tile_height info.tile_height if(info.tile_height?)
+        if(info.formats?)
+          xml.formats {
+            info.formats.each {|mt| xml.format mt}
+          }
+        end
+        if(info.qualities?)
+          xml.qualities {
+            info.qualities.each {|q| xml.quality q}
+          }
+        end
+        xml.profile info.profile if(info.profile?)
+        xml.image_host info.image_host if(info.image_host?)
+      }
+    end
+    builder.to_xml
+  end
+
+  private
+  # Just the levels themselves, as a sorted array of integers
+  def levels_as_i
+    all_levels.keys.map{ |l| l.to_i}.sort
   end
 
 end

data/lib/djatoka/resolver.rb

@@ -63,6 +63,16 @@ class Djatoka::Resolver
     Djatoka::Region.new(self, rft_id, params).uri
   end
 
+  # Shortcut for creating a Djatoka::Region from a Hash of Iiif parameters.
+  def iiif_region(rft_id, params={})
+    Djatoka::IiifRequest.new(self, rft_id, params).djatoka_region
+  end
+
+  # Shortcut for creating an Addressable::URI from a Hash of Iiif parameters.
+  def iiif_uri(rft_id, params={})
+    Djatoka::IiifRequest.new(self, rft_id, params).djatoka_region.uri
+  end
+
   def base_uri_params
     params = {:host => host, :path => path, :scheme => scheme}
     params[:port] = port if port

data/lib/djatoka.rb

@@ -52,17 +52,21 @@ end
 require 'net/http'
 require 'net/https'
 require 'uri'
+require 'set'
 
 require 'djatoka/net'
 require 'djatoka/resolver'
 require 'djatoka/metadata'
 require 'djatoka/common'
 require 'djatoka/region'
+require 'djatoka/iiif_request'
 
 require 'addressable/uri'
 require 'addressable/template'
 require 'json'
+require 'nokogiri'
 require 'hashie'
+require 'mime/types'
 
 
 if defined? Rails

data/test/helper.rb

@@ -3,6 +3,7 @@ require 'test/unit'
 require 'shoulda'
 require 'fakeweb'
 require 'pry'
+require 'equivalent-xml'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -39,7 +40,7 @@ end
 
 FakeWeb.register_uri(:get, "http://african.lanl.gov/adore-djatoka/resolver?rft_id=ua023_015-006-bx0003-014-075&svc_id=info%3Alanl-repo%2Fsvc%2FgetMetadata&url_ver=Z39.88-2004",
   :response => File.read('test/fixtures/ua023_015-006-bx0003-014-075-metadata.json'))
-  
+
 FakeWeb.register_uri(:get, "http://african.lanl.gov/adore-djatoka/resolver?rft_id=asdf&svc_id=info%3Alanl-repo%2Fsvc%2FgetMetadata&url_ver=Z39.88-2004",
   :response => File.read('test/fixtures/empty-metadata.json'))
 FakeWeb.register_uri(:get, "http://african.lanl.gov/adore-djatoka/resolver?url_ver=Z39.88-2004&svc_id=info%3Alanl-repo%2Fsvc%2Fping&rft_id=asdf",

data/test/test_iiif_request.rb

@@ -0,0 +1,173 @@
+require 'helper'
+
+class TestDjatokaIiifRequest < Test::Unit::TestCase
+  with_a_resolver do
+    context 'creates Djatoka::Region objects' do
+      setup do
+        @req = Djatoka::IiifRequest.new(@resolver, @identifier)
+      end
+
+      context 'from a IIIF request with all defaults' do
+        setup do
+          @region = @req.region('full').size('full').rotation('0').quality('native').format('jpg').djatoka_region
+        end
+
+        should 'set region to nil from full' do
+          assert_nil @region.query.region
+        end
+
+        should 'set size to nil from full' do
+          assert_nil @region.query.scale
+        end
+
+        should 'set rotation to 0' do
+          assert_equal '0', @region.query.rotate
+        end
+
+        should 'set format to image/jpg' do
+          assert_equal 'image/jpeg', @region.query.format
+        end
+
+      end
+
+      context 'translates region parameters' do
+        setup do
+          @req.size('full').rotation('0').quality('native').format('jpg')
+        end
+
+        should 'set x,y,w,h requests' do
+          reg = @req.region('10,20,50,100').djatoka_region
+          assert_equal '20,10,100,50', reg.query.region
+        end
+
+        should 'raise an exception if the region does not fit the x,y,w,h format, or is not "full"' do
+          assert_raise Djatoka::IiifInvalidParam do
+            @req.region('blah').djatoka_region
+          end
+        end
+      end
+
+      context 'translates size parameters' do
+        setup do
+          @req.region('10,20,50,100').rotation('0').quality('native').format('jpg')
+        end
+
+        should 'set "w," requests to the correct scale value' do
+          reg = @req.size('800,').djatoka_region
+          assert_equal '800,0', reg.query.scale
+        end
+
+        should 'set ",h" requests to the correct scale value' do
+          reg = @req.size(',900').djatoka_region
+          assert_equal '0,900', reg.query.scale
+        end
+
+        should 'set "pct:n" requests to the correct scale value' do
+          reg = @req.size('pct:75').djatoka_region
+          assert_equal '0.75', reg.query.scale
+
+          reg = @req.size('pct:125').djatoka_region
+          assert_equal '1.25', reg.query.scale
+        end
+
+        should 'set "w,h" requests to the correct scale value' do
+          reg = @req.size('1024,768').djatoka_region
+          assert_equal '1024,768', reg.query.scale
+        end
+
+        should 'raise an exception if the value cannot be parsed into a Float' do
+          assert_raise Djatoka::IiifInvalidParam do
+            @req.size('pct:0.75').djatoka_region
+          end
+        end
+
+      end
+
+      context 'translates rotation parameters' do
+        setup do
+          @req.region('10,20,50,100').size('800,').quality('native').format('jpg')
+        end
+
+        should 'set values that are numeric' do
+          reg = @req.rotation('90').djatoka_region
+          assert_equal '90', reg.query.rotate
+
+          reg = @req.rotation('270').djatoka_region
+          assert_equal '270', reg.query.rotate
+        end
+
+        should 'raise an exception if the value is not numeric' do
+          assert_raise Djatoka::IiifInvalidParam do
+            @req.rotation('blah').djatoka_region
+          end
+        end
+      end
+
+      context 'translates format parameters' do
+        setup do
+          @req.region('full').size('full').rotation('0').quality('native')
+        end
+
+        should 'set the format from a valid extension as from the end of a URL' do
+          reg = @req.format('image.png').djatoka_region
+          assert_equal 'image/png', reg.query.format
+        end
+
+        should 'set the format from a valid mime-type as from the "Accept:" HTTP header' do
+          reg = @req.format('image/tiff').djatoka_region
+          assert_equal 'image/tiff', reg.query.format
+        end
+
+        should 'raise an exception if the value is not a valid mime type extension' do
+          assert_raise Djatoka::IiifInvalidParam do
+            @req.format('nobody').djatoka_region
+          end
+        end
+
+        should 'raise an exception if the value is not a valid mime type value' do
+          assert_raise Djatoka::IiifInvalidParam do
+            @req.format('image/blahtype').djatoka_region
+          end
+        end
+      end
+
+      context 'validates quaility parameters' do
+        setup do
+          @req.region('full').size('full').rotation('0').format('jpg')
+        end
+
+        should 'not raise when the quality is valid' do
+          assert_nothing_raised do
+            @req.quality('color').djatoka_region
+          end
+        end
+
+        should 'raise an exception when the quality is invalid' do
+          assert_raise Djatoka::IiifInvalidParam do
+            @req.quality('3d').djatoka_region
+          end
+        end
+      end
+
+      context '#all_params_present?' do
+        should 'return true when all the valid params have been set' do
+          @req.region('full').size('full').rotation('0').quality('native').format('jpg')
+          assert @req.all_params_present?
+        end
+
+        should 'return false when params are missing' do
+          @req.region('full').size('full').quality('native').format('jpg')
+          assert_equal false, @req.all_params_present?
+        end
+      end
+
+      context '#djatoka_region' do
+        should 'raise a IiifException if a required param is missing from the request' do
+          assert_raise Djatoka::IiifException do
+            @req.size('800,').djatoka_region
+          end
+        end
+      end
+    end #context
+  end #with_a_resolver
+end

data/test/test_metadata.rb

@@ -60,14 +60,14 @@ class TestDjatokaMetadata < Test::Unit::TestCase
       end
     end
 
-    context 'using net::https' do 
-      should 'get metadata when using an https URI' do 
+    context 'using net::https' do
+      should 'get metadata when using an https URI' do
         Djatoka.use_curb=false
         resolver = Djatoka::Resolver.new('https://scrc.lib.ncsu.edu/adore-djatoka/resolver')
         metadata_obj = resolver.metadata('0004817')
         metadata = metadata_obj.perform
         assert_equal('10669', metadata.height)
-      end 
+      end
     end
 
     context 'determining all the levels for a particular metadata response' do
@@ -92,7 +92,7 @@ class TestDjatokaMetadata < Test::Unit::TestCase
       should 'know which is the max level' do
         assert_equal "6", @metadata.max_level
       end
-      
+
       should 'return appropriate height and width for all levels when levels and dwt_levels do not match' do
         levels = {"0"=>{"height"=>58, "width"=>37},
                   "1"=>{"height"=>115, "width"=>74},
@@ -104,10 +104,85 @@ class TestDjatokaMetadata < Test::Unit::TestCase
         assert_equal levels, returned_levels
 
       end
-      
+
     end # levels
 
+    context 'IIIF Image Information Requests' do
+      setup do
+        @metadata_obj = @resolver.metadata(@identifier)
+        @metadata = @metadata_obj.perform
+      end
+
+      should 'create json responses' do
+        iiif_json = <<-EOF
+        {
+          "identifier": "info:lanl-repo/ds/5aa182c2-c092-4596-af6e-e95d2e263de3",
+          "width": 5120,
+          "height": 3372,
+          "scale_factors": [ 0,1,2,3,4,5,6 ],
+          "tile_width": 512,
+          "tile_height": 512,
+          "formats": [ "jpg", "png" ],
+          "qualities": [ "native", "grey" ],
+          "profile": "http://library.stanford.edu/iiif/image-api/compliance.html#level1",
+          "image_host": "http://myserver.com/image"
+        }
+        EOF
+        expected = JSON.parse(iiif_json)
+
+        str = @metadata.to_iiif_json do |info|
+            info.tile_width   = '512'
+            info.tile_height  = 512   # tile_* can be string or int
+            info.formats      = ['jpg', 'png']
+            info.qualities    = ['native', 'grey']
+            info.profile      = 'http://library.stanford.edu/iiif/image-api/compliance.html#level1'
+            info.image_host   = 'http://myserver.com/image'
+        end
+        assert_equal expected, JSON.parse(str)
+      end
+
+      should 'create xml responses' do
+        iiif_xml =<<-EOXML
+        <info xmlns="http://library.stanford.edu/iiif/image-api/ns/">
+          <identifier>info:lanl-repo/ds/5aa182c2-c092-4596-af6e-e95d2e263de3</identifier>
+          <width>5120</width>
+          <height>3372</height>
+          <scale_factors>
+            <scale_factor>0</scale_factor>
+            <scale_factor>1</scale_factor>
+            <scale_factor>2</scale_factor>
+            <scale_factor>3</scale_factor>
+            <scale_factor>4</scale_factor>
+            <scale_factor>5</scale_factor>
+            <scale_factor>6</scale_factor>
+          </scale_factors>
+          <tile_width>512</tile_width>
+          <tile_height>512</tile_height>
+          <formats>
+            <format>jpg</format>
+            <format>png</format>
+          </formats>
+          <qualities>
+            <quality>native</quality>
+            <quality>grey</quality>
+          </qualities>
+          <profile>http://library.stanford.edu/iiif/image-api/compliance.html#level1</profile>
+          <image_host>http://myserver.com/image</image_host>
+        </info>
+        EOXML
+
+        str = @metadata.to_iiif_xml do |info|
+            info.tile_width   = '512'
+            info.tile_height  = 512   # tile_* can be string or int
+            info.formats      = ['jpg', 'png']
+            info.qualities    = ['native', 'grey']
+            info.profile      = 'http://library.stanford.edu/iiif/image-api/compliance.html#level1'
+            info.image_host   = 'http://myserver.com/image'
+        end
+        assert EquivalentXml.equivalent?(str, iiif_xml)
+      end
+    end #IIIF Info Responses
+
   end #with_a_resolver
 
 end
-

data/test/test_resolver.rb

@@ -58,6 +58,26 @@ class TestDjatokaResolver < Test::Unit::TestCase
         assert @resolver.region_uri(@identifier).is_a? Addressable::URI
       end
 
+      context 'Iiif Requests' do
+        setup do
+          @iiif = {
+            :region => 'full',
+            :size => 'full',
+            :rotation => '0',
+            :quality => 'native',
+            :format => 'jpg'
+          }
+        end
+
+        should 'create a region from a hash of IIIF parameters' do
+          assert @resolver.iiif_region(@identifier, @iiif).is_a? Djatoka::Region
+        end
+
+        should 'create a region uri from a hash of IIIF parameters' do
+          assert @resolver.iiif_uri(@identifier, @iiif).is_a? Addressable::URI
+        end
+      end
+
     end #context a Djatoka::Resolver
 
     context 'a resolver with a port number' do

metadata

@@ -1,131 +1,145 @@
 --- !ruby/object:Gem::Specification
 name: djatoka
 version: !ruby/object:Gem::Version
-  version: 0.2.2
-  prerelease: 
+  version: 0.2.3
 platform: ruby
 authors:
 - Jason Ronallo
+- Willy Mene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-08 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
-    none: false
     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: equivalent-xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: The djatoka library provides some simple methods for creation of the
   OpenURLs needed to communicate with the Djatoka image server.
-email: jronallo@gmail.com
+email: jronallo@gmail.com wmene@stanford.edu
 executables:
 - djatoka_url
 extensions: []
@@ -158,6 +172,7 @@ files:
 - init.rb
 - lib/djatoka.rb
 - lib/djatoka/common.rb
+- lib/djatoka/iiif_request.rb
 - lib/djatoka/metadata.rb
 - lib/djatoka/net.rb
 - lib/djatoka/region.rb
@@ -173,6 +188,7 @@ files:
 - test/helper.rb
 - test/test_common.rb
 - test/test_djatoka.rb
+- test/test_iiif_request.rb
 - test/test_metadata.rb
 - test/test_region.rb
 - test/test_resolver.rb
@@ -180,27 +196,25 @@ files:
 - watchr.rb
 homepage: http://github.com/jronallo/djatoka
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: djatoka
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0.rc.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Djatoka image server helpers for Ruby and Rails.
 test_files: []
-has_rdoc: