iiif-presentation 0.0.4

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

@@ -0,0 +1,133 @@
+require 'active_support/inflector'
+require 'json'
+require File.join(File.dirname(__FILE__), '../../../../lib/iiif/hash_behaviours')
+
+
+describe IIIF::Presentation::AbstractResource do
+
+  let(:fixtures_dir) { File.join(File.dirname(__FILE__), '../../../fixtures') }
+  let(:manifest_from_spec_path) { File.join(fixtures_dir, 'manifests/complete_from_spec.json') }
+  let(:abstract_resource_subclass) do
+    Class.new(IIIF::Presentation::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
+    end
+  end
+
+  subject do
+    instance = abstract_resource_subclass.new 
+    instance['@id'] = 'http://example.com/prefix/manifest/123'
+    instance
+  end
+
+  describe '#initialize' do
+    it 'raises an error if you try to instantiate AbstractResource' do
+      expect { IIIF::Presentation::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']).to eq 'Book 1'
+    end
+  end
+
+  describe 'A nested object (e.g. self[\'metdata\'])' 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 '#required_keys' do
+    it 'accumulates' do
+      expect(subject.required_keys).to eq %w{ @type @id }
+    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
+      # Test this here because there's nothing to validate on the superclass (Subject)
+      let(:error) { IIIF::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
+
+end
+

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

@@ -0,0 +1,7 @@
+describe IIIF::Presentation::AnnotationList do
+
+  describe "#{described_class}.define_methods_for_array_only_keys" do
+    it_behaves_like 'it has the appropriate methods for array-only keys'
+  end
+
+end

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

@@ -0,0 +1,7 @@
+describe IIIF::Presentation::Annotation do
+
+  describe "#{described_class}.define_methods_for_abstract_resource_only_keys" do
+    it_behaves_like 'it has the appropriate methods for abstract_resource_only_keys'
+  end
+
+end

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

@@ -0,0 +1,40 @@
+describe IIIF::Presentation::Canvas do
+
+  let(:fixed_values) do
+    {
+      "@context" => "http://iiif.io/api/presentation/2/context.json",
+      "@id" => "http://www.example.org/iiif/book1/canvas/p1",
+      "@type" => "sc:Canvas",
+      "label" => "p. 1",
+      "height" => 1000,
+      "width" => 750,
+      "images" =>  [ ],
+      "otherContent" =>  [ ]
+    }
+  end
+
+
+  describe '#initialize' do
+    it 'sets @type' do
+      expect(subject['@type']).to eq 'sc:Canvas'
+    end
+  end
+
+  describe "#{described_class}.int_only_keys" do
+    it_behaves_like 'it has the appropriate methods for integer-only keys'
+  end
+
+  describe "#{described_class}.define_methods_for_string_only_keys" do
+    it_behaves_like 'it has the appropriate methods for string-only keys'
+  end
+  
+  describe "#{described_class}.define_methods_for_array_only_keys" do
+    it_behaves_like 'it has the appropriate methods for array-only keys'
+  end
+
+  describe "#{described_class}.define_methods_for_any_type_keys" do
+    it_behaves_like 'it has the appropriate methods for any-type keys'
+  end
+
+end
+

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

@@ -0,0 +1,54 @@
+describe IIIF::Presentation::Collection do
+
+  let(:fixed_values) do 
+    {
+      '@context' => 'http://iiif.io/api/presentation/2/context.json',
+      '@id' => 'http://example.org/iiif/collection/top',
+      '@type' => 'sc:Collection',
+      'label' => 'Top Level Collection for Example Organization',
+      'description' => 'Description of Collection',
+      'attribution' => 'Provided by Example Organization',
+
+      'collections' => [
+        { '@id' => 'http://example.org/iiif/collection/part1',
+          '@type' => 'sc:Collection',
+          'label' => 'Sub Collection 1'
+         },
+         { '@id' => 'http://example.org/iiif/collection/part2',
+           '@type' => 'sc:Collection',
+           'label' => 'Sub Collection 2'
+          }
+      ],
+      'manifests' => [
+        { '@id' => 'http://example.org/iiif/book1/manifest',
+          '@type' => 'sc:Manifest',
+          'label' =>  'Book 1'
+        }
+      ]
+    }
+  end
+
+  describe '#initialize' do
+    it 'sets @type to sc:Collection by default' do
+      expect(subject['@type']).to eq 'sc:Collection'
+    end
+  end
+
+  describe "#{described_class}.define_methods_for_array_only_keys" do
+    it_behaves_like 'it has the appropriate methods for array-only keys'
+  end
+
+  describe "#{described_class}.define_methods_for_string_only_keys" do
+    it_behaves_like 'it has the appropriate methods for string-only keys'
+  end
+
+  describe "#{described_class}.define_methods_for_any_type_keys" do
+    it_behaves_like 'it has the appropriate methods for any-type keys'
+  end
+
+  describe '#validate' do
+  end
+
+end
+
+

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

@@ -0,0 +1,13 @@
+describe IIIF::Presentation::ImageResource do
+
+  describe '#initialize' do
+    it 'sets @type to dcterms:Image' do
+      expect(subject['@type']).to eq 'dcterms:Image'
+    end
+  end
+
+  describe "#{described_class}.int_only_keys" do
+    it_behaves_like 'it has the appropriate methods for integer-only keys'
+  end
+
+end

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

@@ -0,0 +1,38 @@
+describe IIIF::Presentation::Layer do
+
+  let(:fixed_values) do
+    {
+      '@context' => 'http://iiif.io/api/presentation/2/context.json',
+      '@id' => 'http://www.example.org/iiif/book1/layer/transcription',
+      '@type' => 'sc:Layer',
+      'label' => 'Diplomatic Transcription',
+      'otherContent' => [
+        'http://www.example.org/iiif/book1/list/l1',
+        'http://www.example.org/iiif/book1/list/l2',
+        'http://www.example.org/iiif/book1/list/l3',
+        'http://www.example.org/iiif/book1/list/l4'
+      ]
+    }
+  end
+
+
+  describe '#initialize' do
+    it 'sets @type' do
+      expect(subject['@type']).to eq 'sc:Layer'
+    end
+  end
+
+  describe "#{described_class}.define_methods_for_string_only_keys" do
+    it_behaves_like 'it has the appropriate methods for string-only keys'
+  end
+  
+  describe "#{described_class}.define_methods_for_array_only_keys" do
+    it_behaves_like 'it has the appropriate methods for array-only keys'
+  end
+
+  describe "#{described_class}.define_methods_for_any_type_keys" do
+    it_behaves_like 'it has the appropriate methods for any-type keys'
+  end
+
+end
+

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

@@ -0,0 +1,89 @@
+describe IIIF::Presentation::Manifest do
+
+  let(:subclass_subject) do
+    Class.new(IIIF::Presentation::Manifest) do
+      def initialize(hsh={})
+        hsh = { '@type' => 'a:SubClass' }
+        super(hsh)
+      end
+    end
+  end
+
+  let(:fixed_values) do
+    {
+      'type' => 'a:SubClass',
+      'id' => 'http://example.com/prefix/manifest/123',
+      'context' => IIIF::Presentation::CONTEXT,
+      'label' => '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',
+        'service'=> {
+          '@context' => 'http://iiif.io/api/image/2/context.json',
+          '@id' => 'http://www.example.org/images/book1-page1',
+          'profile' => 'http://iiif.io/api/image/2/level1.json'
+        }
+      },
+      'attribution' => 'Provided by Example Organization',
+      'license' => 'http://www.example.org/license.html',
+      'logo' => 'http://www.example.org/logos/institution1.jpg',
+      'see_also' => 'http://www.example.org/library/catalog/book1.xml',
+      'service' => {
+        '@context' => 'http://example.org/ns/jsonld/context.json',
+        '@id' =>  'http://example.org/service/example',
+        'profile' => 'http://example.org/docs/example-service.html'
+      },
+      'related' => {
+        '@id' => 'http://www.example.org/videos/video-book1.mpg',
+        'format' => 'video/mpeg'
+      },
+      'within' => 'http://www.example.org/collections/books/',
+    }
+  end
+
+  describe '#initialize' do
+    it 'sets @type to sc:Manifest by default' do
+      expect(subject['@type']).to eq 'sc:Manifest'
+    end
+    it 'allows subclasses to override @type' do
+      sub = subclass_subject.new
+      expect(sub['@type']).to eq 'a:SubClass'
+    end
+  end
+
+  describe '#required_keys' do
+    it 'accumulates' do
+      expect(subject.required_keys).to eq %w{ @type @id label }
+    end
+  end
+
+  describe '#validate' do
+    it 'raises an error if there is no @id' do
+      subject.label = 'Book 1'
+      expect { subject.validate }.to raise_error IIIF::Presentation::MissingRequiredKeyError
+    end
+    it 'raises an error if there is no label' do
+      subject['@id'] = 'http://www.example.org/iiif/book1/manifest'
+      expect { subject.validate }.to raise_error IIIF::Presentation::MissingRequiredKeyError
+    end
+    it 'raises an error if there is no @type' do
+      subject.delete('@type')
+      subject.label = 'Book 1'
+      subject['@id'] = 'http://www.example.org/iiif/book1/manifest'
+      expect { subject.validate }.to raise_error IIIF::Presentation::MissingRequiredKeyError
+    end
+  end
+
+  describe "#{described_class}.define_methods_for_array_only_keys" do
+    it_behaves_like 'it has the appropriate methods for array-only keys'
+  end
+
+  describe "#{described_class}.define_methods_for_string_only_keys" do
+    it_behaves_like 'it has the appropriate methods for string-only keys'
+  end
+
+  describe "#{described_class}.define_methods_for_any_type_keys" do
+    it_behaves_like 'it has the appropriate methods for any-type keys'
+  end
+
+end

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

@@ -0,0 +1,43 @@
+describe IIIF::Presentation::Range do
+
+  let(:fixed_values) do 
+    {
+      '@id' => 'http://www.example.org/iiif/book1/range/r1',
+      '@type' => 'sc:Range',
+      'label' => 'Introduction',
+      'ranges' => [
+        'http://www.example.org/iiif/book1/range/r1-1',
+        'http://www.example.org/iiif/book1/range/r1-2'
+      ],
+      'canvases' => [
+        'http://www.example.org/iiif/book1/canvas/p1',
+        'http://www.example.org/iiif/book1/canvas/p2',
+        'http://www.example.org/iiif/book1/canvas/p3#xywh=0,0,750,300'
+      ]
+    }
+  end
+
+  describe '#initialize' do
+    it 'sets @type to sc:Range by default' do
+      expect(subject['@type']).to eq 'sc:Range'
+    end
+  end
+
+  describe "#{described_class}.define_methods_for_array_only_keys" do
+    it_behaves_like 'it has the appropriate methods for array-only keys'
+  end
+
+  describe "#{described_class}.define_methods_for_string_only_keys" do
+    it_behaves_like 'it has the appropriate methods for string-only keys'
+  end
+
+  describe "#{described_class}.define_methods_for_any_type_keys" do
+    it_behaves_like 'it has the appropriate methods for any-type keys'
+  end
+
+  describe '#validate' do
+  end
+
+end
+
+

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

@@ -0,0 +1,16 @@
+describe IIIF::Presentation::Resource do
+
+  describe "#{described_class}.define_methods_for_abstract_resource_only_keys" do
+    it_behaves_like 'it has the appropriate methods for abstract_resource_only_keys'
+  end
+
+  describe "#{described_class}.int_only_keys" do
+    it_behaves_like 'it has the appropriate methods for integer-only keys'
+  end
+
+  describe "#{described_class}.define_methods_for_string_only_keys" do
+    it_behaves_like 'it has the appropriate methods for string-only keys'
+  end
+
+end
+