iiif-presentation 1.0.0 → 1.2.0

data/spec/integration/iiif/v3/presentation/image_resource_spec.rb

@@ -0,0 +1,118 @@
+describe IIIF::V3::Presentation::ImageResource do
+  vcr_options = {
+    cassette_name: 'pul_loris_cassette_v3',
+    record: :new_episodes,
+    serialize_with: :json
+  }
+
+  describe 'self#create_image_api_image_resource', vcr: vcr_options do
+
+    let(:image_server) { 'https://libimages.princeton.edu/loris' }
+
+    let(:valid_service_id) {
+      id = 'pudl0001%2F4612422%2F00000001.jp2'
+      "#{image_server}/#{id}"
+    }
+
+    let(:invalid_service_id) {
+      id = 'xxxx%2F4612422%2F00000001.jp2'
+      "#{image_server}/#{id}"
+    }
+
+    it 'returns an ImageResource' do
+      instance = described_class.create_image_api_image_resource(service_id: valid_service_id)
+      expect(instance.class).to be described_class
+    end
+
+
+    describe 'has expected values from our fixture' do
+      it 'when copy_info is false' do
+        opts = { service_id: valid_service_id }
+        resource = described_class.create_image_api_image_resource(opts)
+        expect(resource['id']).to eq 'https://libimages.princeton.edu/loris/pudl0001%2F4612422%2F00000001.jp2/full/!200,200/0/default.jpg'
+        expect(resource['type']).to eq 'Image'
+        expect(resource.format).to eq "image/jpeg"
+        expect(resource.width).to eq 3047
+        expect(resource.height).to eq 7200
+        expect(resource.service.first['id']).to eq 'https://libimages.princeton.edu/loris/pudl0001%2F4612422%2F00000001.jp2'
+        expect(resource.service.first['profile']).to eq 'http://iiif.io/api/image/2/level2.json'
+      end
+      it 'copies over all teh infos (when copy_info is true)' do
+        opts = { service_id: valid_service_id, copy_info: true }
+        resource = described_class.create_image_api_image_resource(opts)
+
+        expect(resource['id']).to eq 'https://libimages.princeton.edu/loris/pudl0001%2F4612422%2F00000001.jp2/full/!200,200/0/default.jpg'
+        expect(resource['type']).to eq 'Image'
+        expect(resource.format).to eq "image/jpeg"
+        expect(resource.width).to eq 3047
+        expect(resource.height).to eq 7200
+        expect(resource.service.first['profile']).to eq [
+          'http://iiif.io/api/image/2/level2.json',
+          {
+            'supports' => [
+              'canonicalLinkHeader', 'profileLinkHeader', 'mirroring',
+              'rotationArbitrary', 'regionSquare', 'sizeAboveFull'
+            ],
+            'qualities' => ['default', 'bitonal', 'gray', 'color'],
+            'formats'=>['jpg', 'png', 'gif', 'webp']
+          }
+        ]
+        expect(resource.service.first['tiles']).to eq [ {
+          'width' =>  1024,
+          'scaleFactors' =>  [ 1, 2, 4, 8, 16, 32 ]
+        } ]
+        expect(resource.service.first['sizes']).to eq [
+          {'width' => 96, 'height' =>  225 },
+          {'width' => 191, 'height' =>  450 },
+          {'width' => 381, 'height' =>  900 },
+          {'width' => 762, 'height' => 1800 },
+          {'width' => 1524, 'height' => 3600 },
+          {'width' => 3047, 'height' =>  7200 }
+        ]
+        expect(resource.service.first['id']).to eq 'https://libimages.princeton.edu/loris/pudl0001%2F4612422%2F00000001.jp2'
+        expect(resource.service.first).not_to have_key('@id')
+      end
+    end
+
+    describe 'respects the params we supply' do
+      it ':resource_id' do
+        r_id = 'http://example.edu/images/some.jpg'
+        opts = { service_id: valid_service_id, resource_id: r_id}
+        resource = described_class.create_image_api_image_resource(opts)
+        expect(resource['id']).to eq r_id
+      end
+      it ':width' do
+        width = 42
+        opts = { service_id: valid_service_id, width: width}
+        resource = described_class.create_image_api_image_resource(opts)
+        expect(resource.width).to eq width
+      end
+      it ':height' do
+        height = 42
+        opts = { service_id: valid_service_id, height: height}
+        resource = described_class.create_image_api_image_resource(opts)
+        expect(resource.height).to eq height
+      end
+      it ':profile (service[\'profile\'])' do
+        profile = 'http://iiif.io/api/image/2/level1.json'
+        opts = { service_id: valid_service_id, profile: profile}
+        resource = described_class.create_image_api_image_resource(opts)
+        expect(resource.service.first['profile']).to eq profile
+      end
+    end
+
+    describe 'errors' do
+      it 'raises if :service_id is not included' do
+        expect {
+          described_class.create_image_api_image_resource
+        }.to raise_error
+      end
+      it 'raises if the info can\'t be pulled in' do
+        expect {
+          described_class.create_image_api_image_resource(service_id: invalid_service_id)
+        }.to raise_error
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -1,10 +1,16 @@
 require 'iiif/presentation'
+require 'iiif/v3/presentation'
 require 'simplecov'
 require 'coveralls'
+require 'debug'
 Dir["#{File.dirname(__FILE__)}/unit/iiif/presentation/shared_examples/*.rb"].each do |f|
   require f
 end
+Dir["#{File.dirname(__FILE__)}/unit/iiif/v3/presentation/shared_examples/*.rb"].each do |f|
+  require f
+end
 require 'vcr'
+require 'webmock/rspec'
 
 VCR.configure do |c|
   c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'

data/spec/unit/iiif/presentation/canvas_spec.rb

@@ -43,4 +43,3 @@ describe IIIF::Presentation::Canvas do
   end
 
 end
-

data/spec/unit/iiif/presentation/manifest_spec.rb

@@ -14,7 +14,7 @@ describe IIIF::Presentation::Manifest do
       'type' => 'a:SubClass',
       'id' => 'http://example.com/prefix/manifest/123',
       'context' => IIIF::Presentation::CONTEXT,
-      'label' => 'Book 1',
+      'label' => {'en' => ['Book 1']},
       'description' => 'A longer description of this example book. It should give some real information.',
       'thumbnail' => {
         '@id' => 'http://www.example.org/images/book1-page1/full/80,100/0/default.jpg',

data/spec/unit/iiif/v3/abstract_resource_define_methods_for_spec.rb

@@ -0,0 +1,78 @@
+class AbstractResourceSubClass < IIIF::V3::AbstractResource
+  TYPE = 'Ignore'
+  # need a property here for type of key not already initialized in AbstractResource
+  def array_only_keys
+    super + %w{ array my_array }
+  end
+  def hash_only_keys
+    super + %w{ hash my_hash }
+  end
+  def int_only_keys
+    super + %w{ int my_int }
+  end
+  def numeric_only_keys
+    super + %w{ num my_num }
+  end
+  def uri_only_keys
+    super + %w{ uri my_uri }
+  end
+
+  def initialize(hsh={})
+    hsh = { 'type' => 'a:SubClass' }
+    super(hsh)
+  end
+end
+
+describe AbstractResourceSubClass do
+
+  describe "*define_methods_for_any_type_keys" do
+    # shared_example expects fixed_values;  these are roughly based on Stanford purl code
+    # (see https://github.com/sul-dlss/purl/blob/master/app/models/iiif3_presentation_manifest.rb)
+    let(:fixed_values) do
+      {
+        'label' => 'foo',
+        'description' => 'bar',
+        'thumbnail' => IIIF::V3::Presentation::ImageResource.new(
+          'type' => 'Image',
+          'id' => "http://example.org/full/!400,400/0/default.jpg",
+          'format' => 'image/jpeg'
+          ),
+        'attribution' => ['foo'],
+        'logo' => {
+          'id' => 'https://example.org/default.jpg',
+          'service' => IIIF::V3::Presentation::Service.new(
+            '@context' => 'http://iiif.io/api/image/2/context.json',
+            '@id' => 'http://example.org/1',
+            'id' => 'http://example.org/1',
+            'profile' => 'http://example.org/whatever'
+          )
+        },
+        'see_also' => {
+          'id' => 'http://example.org/whatever',
+          'format' => 'application/mods+xml'
+        },
+        'related' => ['no', 'idea'],
+        'within' => {'foo' => 'bar'}
+      }
+    end
+    it_behaves_like 'it has the appropriate methods for any-type keys v3'
+  end
+  describe "*define_methods_for_array_only_keys" do
+    it_behaves_like 'it has the appropriate methods for array-only keys v3'
+  end
+  describe "*define_methods_for_hash_only_keys" do
+    it_behaves_like 'it has the appropriate methods for hash-only keys v3'
+  end
+  describe "*define_methods_for_int_only_keys" do
+    it_behaves_like 'it has the appropriate methods for integer-only keys v3'
+  end
+  describe "*define_methods_for_numeric_only_keys" do
+    it_behaves_like 'it has the appropriate methods for numeric-only keys v3'
+  end
+  describe "*define_methods_for_string_only_keys" do
+    it_behaves_like 'it has the appropriate methods for string-only keys v3'
+  end
+  describe "*define_methods_for_uri_only_keys" do
+    it_behaves_like 'it has the appropriate methods for uri-only keys v3'
+  end
+end

data/spec/unit/iiif/v3/abstract_resource_spec.rb

@@ -0,0 +1,293 @@
+require 'active_support/inflector'
+require 'json'
+require_relative '../../../../lib/iiif/hash_behaviours'
+
+describe IIIF::V3::AbstractResource do
+
+  let(:fixtures_dir) { File.join(File.dirname(__FILE__), '../../../fixtures') }
+  let(:manifest_from_spec_path) { File.join(fixtures_dir, 'v3/manifests/complete_from_spec.json') }
+  let(:abstract_resource_subclass) do
+    Class.new(IIIF::V3::AbstractResource) do
+      include IIIF::HashBehaviours
+
+      def initialize(hsh={})
+        hsh['type'] = 'a:SubClass' unless hsh.has_key?('type')
+        super(hsh)
+      end
+
+      def required_keys
+        super + %w{ id }
+      end
+
+      def prohibited_keys
+        super + %w{ verboten }
+      end
+
+      def legal_viewing_hint_values
+        %w{ viewing_hint1 viewing_hint2 }
+      end
+    end
+  end
+  subject do
+    instance = abstract_resource_subclass.new
+    instance['id'] = 'http://example.com/prefix/manifest/123'
+    instance
+  end
+
+  describe '#required_keys' do
+    it 'accumulate' do
+      expect(subject.required_keys).to eq %w{ type id }
+    end
+  end
+
+  describe '#initialize' do
+    it 'raises an error if you try to instantiate AbstractResource' do
+      expect { IIIF::V3::AbstractResource.new }.to raise_error(RuntimeError)
+    end
+    it 'sets type' do
+      expect(subject['type']).to eq 'a:SubClass'
+    end
+    it 'can take any old hash' do
+      hsh = JSON.parse(IO.read(manifest_from_spec_path))
+      new_instance = abstract_resource_subclass.new(hsh)
+      expect(new_instance['label']['en']).to include 'Book 1'
+    end
+  end
+
+  describe '#validate' do
+    it 'raises MissingRequiredKeyError if required key is missing' do
+      subject.required_keys.each { |k| subject.delete(k) }
+      expect { subject.validate }.to raise_error IIIF::V3::Presentation::MissingRequiredKeyError
+    end
+    it 'raises ProhibitedKeyError if prohibited key is present' do
+      subject['verboten'] = 666
+      exp_err_msg = "verboten is a prohibited key in #{subject.class}"
+      expect { subject.validate }.to raise_error(IIIF::V3::Presentation::ProhibitedKeyError, exp_err_msg)
+    end
+    it 'raises IllegalValueError for bad viewing_direction' do
+      subject['viewing_direction'] = 'foo'
+      exp_err_msg = "viewingDirection must be one of #{subject.legal_viewing_direction_values}"
+      expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_err_msg)
+    end
+    describe 'viewing_hint' do
+      it 'can be a uri' do
+        subject['viewing_hint'] = 'https://example.org/viewiing_hint'
+        expect { subject.validate }.not_to raise_error
+      end
+      it 'can be a member of legal_viewing_hint_values' do
+        subject['viewing_hint'] = subject.legal_viewing_hint_values.first
+        expect { subject.validate }.not_to raise_error
+      end
+      it 'raises IllegalValueError for bad viewing_hint' do
+        subject['viewing_hint'] = 'foo'
+        exp_err_msg = "viewingHint for #{subject.class} must be one or more of #{subject.legal_viewing_hint_values} or a URI"
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_err_msg)
+      end
+      it 'can have multiple values' do
+        subject['viewing_hint'] = [subject.legal_viewing_hint_values.first, subject.legal_viewing_hint_values.last]
+        expect { subject.validate }.not_to raise_error
+      end
+    end
+    describe 'metadata' do
+      it 'raises IllegalValueError for entry that is not a Hash' do
+        subject['metadata'] = ['error']
+        exp_err_msg = "metadata must be an Array with Hash members"
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_err_msg)
+      end
+      it 'does not raise error for entry that contains exactly "label" and "value"' do
+        subject['metadata'] = [{ 'label' => 'bar', 'value' => 'foo' }]
+        expect { subject.validate }.not_to raise_error
+      end
+      it 'raises IllegalValueError for entry that does not contain exactly "label" and "value"' do
+        subject['metadata'] = [{ 'label' => 'bar', 'bar' => 'foo' }]
+        exp_err_msg = "metadata members must be a Hash of keys 'label' and 'value'"
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_err_msg)
+      end
+    end
+    describe 'thumbnail' do
+      let (:exp_basic_err_msg) { "thumbnail must be an Array with Hash or ImageResource members" }
+      let (:exp_keys_msg) { 'thumbnail members must include keys "id" and "type"' }
+      it 'raises IllegalValueError for entry that is not a Hash or ImageResource object' do
+        subject['thumbnail'] = ['error']
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_basic_err_msg)
+      end
+      it 'does not raise error for entry Hash with "id" and "type"' do
+        subject['thumbnail'] = [{ 'id' => 'bar', 'type' => 'foo', 'random' => 'xxx' }]
+        expect { subject.validate }.not_to raise_error
+      end
+      it 'raises IllegalValueError for entry Hash that does not contain "id" and "type"' do
+        subject['thumbnail'] = [{ 'id' => 'bar' }]
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_keys_msg)
+      end
+      it 'does not raise error for entry ImageResource with "id"' do
+        subject['thumbnail'] = [IIIF::V3::Presentation::ImageResource.new({ 'id' => 'bar', 'label' => 'xxx' })]
+        expect { subject.validate }.not_to raise_error
+      end
+      it 'raises IllegalValueError for entry ImageResource without id' do
+        subject['thumbnail'] = [IIIF::V3::Presentation::ImageResource.new]
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_keys_msg)
+      end
+    end
+    describe 'nav_date' do
+      it 'does not raise error for value of form YYYY-MM-DDThh:mm:ssZ' do
+        subject['nav_date'] = '1991-01-02T13:04:27Z'
+        expect { subject.validate }.not_to raise_error
+      end
+      it 'raises IllegalValueError for value not of form YYYY-MM-DDThh:mm:ssZ' do
+        subject['nav_date'] = '1991-01-02T13:04:27+0500'
+        exp_err_msg = 'nav_date must be of form YYYY-MM-DDThh:mm:ssZ'
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_err_msg)
+      end
+    end
+    describe 'rights' do
+      it 'raises IllegalValueError for entry that is not a Hash' do
+        subject['rights'] = ['error']
+        exp_err_msg = "rights must be an Array with Hash members"
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_err_msg)
+      end
+      it 'does not raise error for entry with "id" that is URI' do
+        subject['rights'] = [{ 'id' => 'http://example.org/rights', 'format' => 'text/html' }]
+        expect { subject.validate }.not_to raise_error
+      end
+      it 'raises IllegalValueError for entry with "id" that is not URI' do
+        subject['rights'] = [{ 'id' => 'bar', 'format' => 'text/html' }]
+        exp_err_msg = "id value must be a String containing a URI for #{subject.class}"
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_err_msg)
+      end
+      it 'raises IllegalValueError for entry that does not contain "id"' do
+        subject['rights'] = [{ 'whoops' => 'http://example.org/rights' }]
+        exp_err_msg = 'rights members must be a Hash including "id"'
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_err_msg)
+      end
+    end
+    describe 'rendering' do
+      it 'raises IllegalValueError for entry that is not a Hash' do
+        subject['rendering'] = ['error']
+        exp_err_msg = "rendering must be an Array with Hash members"
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_err_msg)
+      end
+      it 'does not raise error for entry with "label" and "format"' do
+        subject['rendering'] = [{ 'label' => 'bar', 'format' => 'foo', 'random' => 'xxx' }]
+        expect { subject.validate }.not_to raise_error
+      end
+      it 'raises IllegalValueError for entry that does not contain "label" and "format"' do
+        subject['rendering'] = [{ 'label' => 'bar' }]
+        exp_err_msg = 'rendering members must be a Hash including keys "label" and "format"'
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_err_msg)
+      end
+    end
+    describe 'startCanvas' do
+      it 'raises IllegalValueError for entry that is not URI' do
+        subject.startCanvas = 'foo'
+        exp_err_msg = "startCanvas value must be a String containing a URI for #{subject.class}"
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_err_msg)
+      end
+    end
+  end
+
+  describe 'A nested object (e.g. self[\'metadata\'])' do
+    it 'returns [] if not set' do
+      expect(subject.metadata).to eq([])
+    end
+    it 'is not in #to_ordered_hash at all if we access it but do not append to it' do
+      subject.metadata # touch it
+      expect(subject.metadata).to eq([])
+      expect(subject.to_ordered_hash.has_key?('metadata')).to be_falsey
+    end
+    it 'gets structured as we\'d expect' do
+      subject.metadata << {
+        'label' => 'Author',
+        'value' => 'Anne Author'
+      }
+      subject.metadata << {
+        'label' => 'Published',
+        'value' => [
+          {'@value'=> 'Paris, circa 1400', '@language'=>'en'},
+          {'@value'=> 'Paris, environ 14eme siecle', '@language'=>'fr'}
+        ]
+      }
+      expect(subject.metadata[0]['label']).to eq('Author')
+      expect(subject.metadata[1]['value'].length).to eq(2)
+      expect(subject.metadata[1]['value'].select { |e| e['@language'] == 'fr'}.last['@value']).to eq('Paris, environ 14eme siecle')
+    end
+
+    it 'roundtrips' do
+      subject.metadata << {
+        'label' => 'Author',
+        'value' => 'Anne Author'
+      }
+      subject.metadata << {
+        'label' => 'Published',
+        'value' => [
+          {'@value'=> 'Paris, circa 1400', '@language'=>'en'},
+          {'@value'=> 'Paris, environ 14eme siecle', '@language'=>'fr'}
+        ]
+      }
+      File.open('/tmp/osullivan-spec.json','w') do |f|
+        f.write(subject.to_json)
+      end
+      parsed = subject.class.parse('/tmp/osullivan-spec.json')
+      expect(parsed['metadata'][0]['label']).to eq('Author')
+      expect(parsed['metadata'][1]['value'].length).to eq(2)
+      expect(parsed['metadata'][1]['value'].select { |e| e['@language'] == 'fr'}.last['@value']).to eq('Paris, environ 14eme siecle')
+      File.delete('/tmp/osullivan-spec.json')
+    end
+  end
+
+  describe '#to_ordered_hash' do
+    describe 'adds the @context' do
+      before(:each) { subject.delete('@context') }
+      it 'by default' do
+        expect(subject.has_key?('@context')).to be_falsey
+        expect(subject.to_ordered_hash.has_key?('@context')).to be_truthy
+      end
+      it 'unless you say not to' do
+        expect(subject.has_key?('@context')).to be_falsey
+        expect(subject.to_ordered_hash(include_context: false).has_key?('@context')).to be_falsey
+      end
+      it 'or it\'s already there' do
+        different_ctxt = 'http://example.org/context'
+        subject['@context'] = different_ctxt
+        oh = subject.to_ordered_hash
+        expect(oh['@context']).to eq different_ctxt
+      end
+    end
+
+    describe 'runs the validations' do
+      let(:error) { IIIF::V3::Presentation::MissingRequiredKeyError }
+      before(:each) { subject.delete('id') }
+      it 'raises exceptions' do
+        expect { subject.to_ordered_hash }.to raise_error error
+      end
+      it 'unless you tell it not to' do
+        expect { subject.to_ordered_hash(force: true) }.to_not raise_error
+      end
+    end
+  end
+
+  describe '*get_descendant_class_by_jld_type' do
+    before do
+      class DummyClass < IIIF::V3::AbstractResource
+        TYPE = "Collection"
+        def self.singleton_class?
+          true
+        end
+      end
+    end
+    after do
+      Object.send(:remove_const, :DummyClass)
+    end
+    it 'gets the right class' do
+      klass = described_class.get_descendant_class_by_jld_type('Canvas')
+      expect(klass).to eq IIIF::V3::Presentation::Canvas
+    end
+    context "when there are singleton classes which are returned" do
+      it "gets the right class" do
+        allow(IIIF::V3::AbstractResource).to receive(:descendants).and_return([DummyClass, IIIF::V3::Presentation::Collection])
+        klass = described_class.get_descendant_class_by_jld_type('Collection')
+        expect(klass).to eq IIIF::V3::Presentation::Collection
+      end
+    end
+  end
+
+end

data/spec/unit/iiif/v3/presentation/annotation_collection_spec.rb

@@ -0,0 +1,36 @@
+describe IIIF::V3::Presentation::AnnotationCollection do
+
+  let(:fixed_values) do
+    {
+      '@context' => [
+        'http://iiif.io/api/presentation/3/context.json',
+        'http://www.w3.org/ns/anno.jsonld'
+      ],
+      'id' => 'http://www.example.org/iiif/book1/annoColl/transcription',
+      'type' => 'AnnotationCollection',
+      'label' => 'Diplomatic Transcription',
+      'first' => 'http://www.example.org/iiif/book1/list/l1',
+      'last' => 'http://www.example.org/iiif/book1/list/l4',
+    }
+  end
+
+
+  describe '#initialize' do
+    it 'sets type' do
+      expect(subject['type']).to eq 'AnnotationCollection'
+    end
+  end
+
+  describe "#{described_class}.define_methods_for_string_only_keys" do
+    it_behaves_like 'it has the appropriate methods for string-only keys v3'
+  end
+
+  describe "#{described_class}.define_methods_for_array_only_keys" do
+    it_behaves_like 'it has the appropriate methods for array-only keys v3'
+  end
+
+  describe "#{described_class}.define_methods_for_any_type_keys" do
+    it_behaves_like 'it has the appropriate methods for any-type keys v3'
+  end
+
+end