iiif-presentation 1.4.1 → 1.5.0

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

@@ -1,147 +1,149 @@
 describe IIIF::V3::Presentation::Resource do
-  describe '#required_keys' do
-    it 'id' do
-      expect(subject.required_keys).to include('id')
+  describe "#required_keys" do
+    it "id" do
+      expect(subject.required_keys).to include("id")
     end
-    it 'type' do
-      expect(subject.required_keys).to include('type')
+    it "type" do
+      expect(subject.required_keys).to include("type")
     end
   end
 
-  describe '#prohibited_keys' do
-    it 'contains the expected key names' do
+  describe "#prohibited_keys" do
+    it "contains the expected key names" do
       keys = described_class::PAGING_PROPERTIES +
-        %w{
+        %w[
           nav_date
           viewing_direction
           start_canvas
           content_annotations
-        }
+        ]
       expect(subject.prohibited_keys).to include(*keys)
     end
   end
 
-  describe '#uri_only_keys' do
-    it 'id' do
-      expect(subject.uri_only_keys).to include('id')
+  describe "#uri_only_keys" do
+    it "id" do
+      expect(subject.uri_only_keys).to include("id")
     end
   end
 
-  describe '#initialize' do
-    it 'allows subclasses to override type' do
+  describe "#initialize" do
+    it "allows subclasses to override type" do
       subclass = Class.new(described_class) do
-        def initialize(hsh={})
-          hsh = { 'type' => 'a:SubClass' }
-          super(hsh)
+        def initialize(_hsh = {})
+          super({"type" => "a:SubClass"})
         end
       end
       sub = subclass.new
-      expect(sub['type']).to eq 'a:SubClass'
+      expect(sub["type"]).to eq "a:SubClass"
     end
   end
 
-  describe '#validate' do
-    it 'raises an IllegalValueError if id is not URI' do
-      subject['id'] = 'foo'
-      subject['type'] = 'image/jpeg'
+  describe "#validate" do
+    it "raises an IllegalValueError if id is not URI" do
+      subject["id"] = "foo"
+      subject["type"] = "image/jpeg"
       exp_err_msg = "id value must be a String containing a URI for #{described_class}"
       expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_err_msg)
     end
-    it 'raises an IllegalValueError if id is not http' do
-      subject['id'] = 'ftp://www.example.org'
-      subject['type'] = 'image/jpeg'
+    it "raises an IllegalValueError if id is not http" do
+      subject["id"] = "ftp://www.example.org"
+      subject["type"] = "image/jpeg"
       exp_err_msg = "id must be an http(s) URI for #{described_class}"
       expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, exp_err_msg)
     end
   end
 
-  describe 'realistic examples' do
-    describe 'non-image examples from http://prezi3.iiif.io/api/presentation/3.0' do
-      describe 'audio' do
-        let(:file_id) { 'http://example.org/iiif/book1/res/music.mp3' }
-        let(:file_type) { 'dctypes:Sound' }
-        let(:file_mimetype) { 'audio/mpeg' }
-        let(:resource_object) { IIIF::V3::Presentation::Resource.new({
-            'id' => file_id,
-            'type' => file_type,
-            'format' => file_mimetype
-        })}
-        it 'validates' do
-          expect{resource_object.validate}.not_to raise_error
+  describe "realistic examples" do
+    describe "non-image examples from http://prezi3.iiif.io/api/presentation/3.0" do
+      describe "audio" do
+        let(:file_id) { "http://example.org/iiif/book1/res/music.mp3" }
+        let(:file_type) { "dctypes:Sound" }
+        let(:file_mimetype) { "audio/mpeg" }
+        let(:resource_object) {
+          IIIF::V3::Presentation::Resource.new({
+            "id" => file_id,
+            "type" => file_type,
+            "format" => file_mimetype
+          })
+        }
+        it "validates" do
+          expect { resource_object.validate }.not_to raise_error
         end
-        it 'has expected required values' do
+        it "has expected required values" do
           expect(resource_object.id).to eq file_id
         end
-        it 'has expected other values' do
+        it "has expected other values" do
           expect(resource_object.type).to eq file_type
           expect(resource_object.format).to eq file_mimetype
           expect(resource_object.service).to eq []
         end
       end
-      describe 'text' do
-        let(:file_id) { 'http://example.org/iiif/book1/res/tei-text-p1.xml' }
-        let(:file_type) { 'dctypes:Text' }
-        let(:file_mimetype) { 'application/tei+xml' }
-        let(:resource_object) { IIIF::V3::Presentation::Resource.new({
-            'id' => file_id,
-            'type' => file_type,
-            'format' => file_mimetype
-        })}
-        it 'validates' do
-          expect{resource_object.validate}.not_to raise_error
+      describe "text" do
+        let(:file_id) { "http://example.org/iiif/book1/res/tei-text-p1.xml" }
+        let(:file_type) { "dctypes:Text" }
+        let(:file_mimetype) { "application/tei+xml" }
+        let(:resource_object) {
+          IIIF::V3::Presentation::Resource.new({
+            "id" => file_id,
+            "type" => file_type,
+            "format" => file_mimetype
+          })
+        }
+        it "validates" do
+          expect { resource_object.validate }.not_to raise_error
         end
-        it 'has expected required values' do
+        it "has expected required values" do
           expect(resource_object.id).to eq file_id
         end
-        it 'has expected other values' do
+        it "has expected other values" do
           expect(resource_object.type).to eq file_type
           expect(resource_object.format).to eq file_mimetype
           expect(resource_object.service).to eq []
         end
       end
-
     end
-    describe 'stanford' do
-      describe 'non-image resource per purl code' do
-        let(:file_id) { 'https://example.org/file/abc666/ocr.txt' }
-        let(:file_type) { 'Document' }
-        let(:file_mimetype) { 'text/plain' }
+    describe "stanford" do
+      describe "non-image resource per purl code" do
+        let(:file_id) { "https://example.org/file/abc666/ocr.txt" }
+        let(:file_type) { "Document" }
+        let(:file_mimetype) { "text/plain" }
         let(:resource_object) {
           resource = IIIF::V3::Presentation::Resource.new
-          resource['id'] = file_id
-          resource['type'] = file_type
+          resource["id"] = file_id
+          resource["type"] = file_type
           resource.format = file_mimetype
           resource
         }
-        describe 'world visible' do
-          it 'validates' do
-            expect{resource_object.validate}.not_to raise_error
+        describe "world visible" do
+          it "validates" do
+            expect { resource_object.validate }.not_to raise_error
           end
-          it 'has expected required values' do
+          it "has expected required values" do
             expect(resource_object.id).to eq file_id
           end
-          it 'has expected other values' do
+          it "has expected other values" do
             expect(resource_object.type).to eq file_type
             expect(resource_object.format).to eq file_mimetype
             expect(resource_object.service).to eq []
           end
         end
-        describe 'requires login' do
+        describe "requires login" do
           # let(:auth_token_service) {
           #   IIIF::V3::Presentation::Service.new({
           #     'id' => 'https://example.org/image/iiif/token',
           #     'profile' => IIIF::V3::Presentation::Service::IIIF_AUTHENTICATION_V1_TOKEN_PROFILE
           #     })}
-          let(:service_label) { 'login message' }
-          let(:token_service_id) { 'https://example.org/iiif/token' }
+          let(:service_label) { "login message" }
+          let(:token_service_id) { "https://example.org/iiif/token" }
           let(:login_service) {
             IIIF::V3::Presentation::Service.new(
-              'id' => 'https://example.org/auth/iiif',
-              'profile' => 'http://iiif.io/api/auth/1/login',
-              'label' => service_label,
-              'service' => [{
-                'id' => token_service_id,
-                'profile' => 'http://iiif.io/api/auth/1/token'
+              "id" => "https://example.org/auth/iiif",
+              "profile" => "http://iiif.io/api/auth/1/login",
+              "label" => service_label,
+              "service" => [{
+                "id" => token_service_id,
+                "profile" => "http://iiif.io/api/auth/1/token"
               }]
             )
           }
@@ -150,25 +152,24 @@ describe IIIF::V3::Presentation::Resource do
             resource.service = [login_service]
             resource
           }
-          it 'validates' do
-            expect{resource_object_w_login.validate}.not_to raise_error
+          it "validates" do
+            expect { resource_object_w_login.validate }.not_to raise_error
           end
-          it 'has expected service value' do
+          it "has expected service value" do
             service_obj = resource_object_w_login.service.first
             expect(service_obj.class).to eq IIIF::V3::Presentation::Service
             expect(service_obj.keys.size).to eq 4
-            expect(service_obj.id).to eq 'https://example.org/auth/iiif'
+            expect(service_obj.id).to eq "https://example.org/auth/iiif"
             expect(service_obj.profile).to eq IIIF::V3::Presentation::Service::IIIF_AUTHENTICATION_V1_LOGIN_PROFILE
             expect(service_obj.label).to eq service_label
             expect(service_obj.service.class).to eq Array
             expect(service_obj.service.size).to eq 1
             expect(service_obj.service.first.keys.size).to eq 2
-            expect(service_obj.service.first['id']).to eq token_service_id
-            expect(service_obj.service.first['profile']).to eq IIIF::V3::Presentation::Service::IIIF_AUTHENTICATION_V1_TOKEN_PROFILE
+            expect(service_obj.service.first["id"]).to eq token_service_id
+            expect(service_obj.service.first["profile"]).to eq IIIF::V3::Presentation::Service::IIIF_AUTHENTICATION_V1_TOKEN_PROFILE
           end
         end
       end
     end
   end
-
 end

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

@@ -1,212 +1,218 @@
 describe IIIF::V3::Presentation::Sequence do
-
-  describe '#required_keys' do
+  describe "#required_keys" do
     # NOTE:  relaxing requirement for items as Universal Viewer currently only accepts canvases
     #  see https://github.com/sul-dlss/osullivan/issues/27, sul-dlss/purl/issues/167
     # %w{ type items }.each do |k|
-    %w{ type }.each do |k|
+    %w[type].each do |k|
       it k do
         expect(subject.required_keys).to include(k)
       end
     end
   end
 
-  describe '#prohibited_keys' do
-    it 'contains the expected key names' do
+  describe "#prohibited_keys" do
+    it "contains the expected key names" do
       keys = described_class::CONTENT_RESOURCE_PROPERTIES +
         described_class::PAGING_PROPERTIES +
-        %w{
+        %w[
           nav_date
           content_annotations
-        }
+        ]
       expect(subject.prohibited_keys).to include(*keys)
     end
   end
 
-  describe '#array_only_keys' do
-    it 'items' do
-      expect(subject.array_only_keys).to include('items')
+  describe "#array_only_keys" do
+    it "items" do
+      expect(subject.array_only_keys).to include("items")
     end
     # NOTE:  also allowing sequences as Universal Viewer currently only accepts canvases
     #  see https://github.com/sul-dlss/osullivan/issues/27, sul-dlss/purl/issues/167
-    it 'canvases' do
-      expect(subject.array_only_keys).to include('canvases')
+    it "canvases" do
+      expect(subject.array_only_keys).to include("canvases")
     end
   end
 
-  describe '#legal_viewing_hint_values' do
-    it 'contains the expected values' do
-      expect(subject.legal_viewing_hint_values).to contain_exactly('individuals', 'paged', 'continuous', 'auto-advance')
+  describe "#legal_viewing_hint_values" do
+    it "contains the expected values" do
+      expect(subject.legal_viewing_hint_values).to contain_exactly("individuals", "paged", "continuous", "auto-advance")
     end
   end
 
-  describe '#initialize' do
-    it 'sets type to Sequence by default' do
-      expect(subject['type']).to eq 'Sequence'
+  describe "#initialize" do
+    it "sets type to Sequence by default" do
+      expect(subject["type"]).to eq "Sequence"
     end
-    it 'allows subclasses to override type' do
+    it "allows subclasses to override type" do
       subclass = Class.new(described_class) do
-        def initialize(hsh={})
-          hsh = { 'type' => 'a:SubClass' }
-          super(hsh)
+        def initialize(_hsh = {})
+          super({"type" => "a:SubClass"})
         end
       end
       sub = subclass.new
-      expect(sub['type']).to eq 'a:SubClass'
+      expect(sub["type"]).to eq "a:SubClass"
     end
   end
 
-  describe '#validate' do
+  describe "#validate" do
     let(:req_key_msg) { "The (items or canvases) list must have at least one entry." }
-    it 'raises MissingRequiredKeyError if no items or canvases key' do
+    it "raises MissingRequiredKeyError if no items or canvases key" do
       expect { subject.validate }.to raise_error(IIIF::V3::Presentation::MissingRequiredKeyError, req_key_msg)
     end
-    describe 'items' do
-      it 'raises MissingRequiredKeyError for items as empty Array' do
-        subject['items'] = []
+    describe "items" do
+      it "raises MissingRequiredKeyError for items as empty Array" do
+        subject["items"] = []
         expect { subject.validate }.to raise_error(IIIF::V3::Presentation::MissingRequiredKeyError, req_key_msg)
       end
     end
-    describe 'canvases' do
-      it 'raises MissingRequiredKeyError for canvases as empty Array' do
-        subject['items'] = []
+    describe "canvases" do
+      it "raises MissingRequiredKeyError for canvases as empty Array" do
+        subject["items"] = []
         expect { subject.validate }.to raise_error(IIIF::V3::Presentation::MissingRequiredKeyError, req_key_msg)
       end
     end
   end
 
-  describe 'realistic examples' do
-    let!(:canvas_object) { IIIF::V3::Presentation::Canvas.new({
-      "id" => "https://example.org/abc666/iiif3/canvas/0001",
-      "label" => "p. 1",
-      "height" => 7579,
-      "width" => 10108,
-      "content" => []
-      })}
-    describe 'minimal sequence' do
-      let!(:sequence_object) { described_class.new({
-        "items" => [canvas_object]
-      })}
-      it 'validates' do
-        expect{sequence_object.validate}.not_to raise_error
+  describe "realistic examples" do
+    let!(:canvas_object) {
+      IIIF::V3::Presentation::Canvas.new({
+        "id" => "https://example.org/abc666/iiif3/canvas/0001",
+        "label" => "p. 1",
+        "height" => 7579,
+        "width" => 10108,
+        "content" => []
+      })
+    }
+    describe "minimal sequence" do
+      let!(:sequence_object) {
+        described_class.new({
+          "items" => [canvas_object]
+        })
+      }
+      it "validates" do
+        expect { sequence_object.validate }.not_to raise_error
       end
-      it 'has expected required values' do
-        expect(sequence_object.type).to eq 'Sequence'
+      it "has expected required values" do
+        expect(sequence_object.type).to eq "Sequence"
         expect(sequence_object.items.size).to be 1
         expect(sequence_object.items.first).to eq canvas_object
       end
     end
-    
-    describe 'example from Stanford purl' do
-      let(:seq_id) { 'https://example.org/abc666#sequence-1' }
+
+    describe "example from Stanford purl" do
+      let(:seq_id) { "https://example.org/abc666#sequence-1" }
       let(:sequence_object) {
         s = described_class.new({
-        "id" => seq_id,
-        "label" => "Current order"
+          "id" => seq_id,
+          "label" => "Current order"
         })
         s.canvases << canvas_object
         s
       }
-      it 'validates' do
-        expect{sequence_object.validate}.not_to raise_error
+      it "validates" do
+        expect { sequence_object.validate }.not_to raise_error
       end
-      it 'has expected required values' do
-        expect(sequence_object.type).to eq 'Sequence'
+      it "has expected required values" do
+        expect(sequence_object.type).to eq "Sequence"
         expect(sequence_object.canvases.size).to be 1
         expect(sequence_object.canvases.first).to eq canvas_object
       end
-      it 'has expected string values' do
+      it "has expected string values" do
         expect(sequence_object.id).to eq seq_id
         expect(sequence_object.label).to eq "Current order"
       end
-      describe 'with viewingDirection' do
+      describe "with viewingDirection" do
         let(:sequence_vd) {
-          sequence_object.viewingDirection = 'left-to-right'
+          sequence_object.viewingDirection = "left-to-right"
           sequence_object
         }
-        it 'validates' do
-          expect{sequence_vd.validate}.not_to raise_error
+        it "validates" do
+          expect { sequence_vd.validate }.not_to raise_error
         end
-        it 'has expected required values' do
-          expect(sequence_vd.type).to eq 'Sequence'
+        it "has expected required values" do
+          expect(sequence_vd.type).to eq "Sequence"
           expect(sequence_vd.canvases.size).to be 1
           expect(sequence_vd.canvases.first).to eq canvas_object
         end
-        it 'has expected string values' do
+        it "has expected string values" do
           expect(sequence_vd.id).to eq seq_id
           expect(sequence_vd.label).to eq "Current order"
-          expect(sequence_vd.viewing_direction).to eq 'left-to-right'
-          expect(sequence_vd.viewingDirection).to eq 'left-to-right'
+          expect(sequence_vd.viewing_direction).to eq "left-to-right"
+          expect(sequence_vd.viewingDirection).to eq "left-to-right"
         end
       end
     end
 
-    describe 'example from http://prezi3.iiif.io/api/presentation/3.0' do
-      let!(:sequence_object) { described_class.new({
-        "id" => "http://example.org/iiif/book1/sequence/normal",
-        "label" => {"en" => "Current Page Order"},
-        "viewingDirection" => "left-to-right",
-        "viewingHint" => ["paged"],
-        "startCanvas" => canvas_object.id,
-        "items" => [canvas_object]
-      })}
-      it 'validates' do
-        expect{sequence_object.validate}.not_to raise_error
+    describe "example from http://prezi3.iiif.io/api/presentation/3.0" do
+      let!(:sequence_object) {
+        described_class.new({
+          "id" => "http://example.org/iiif/book1/sequence/normal",
+          "label" => {"en" => "Current Page Order"},
+          "viewingDirection" => "left-to-right",
+          "viewingHint" => ["paged"],
+          "startCanvas" => canvas_object.id,
+          "items" => [canvas_object]
+        })
+      }
+      it "validates" do
+        expect { sequence_object.validate }.not_to raise_error
       end
-      it 'has expected required values' do
-        expect(sequence_object.type).to eq 'Sequence'
+      it "has expected required values" do
+        expect(sequence_object.type).to eq "Sequence"
         expect(sequence_object.items.size).to be 1
         expect(sequence_object.items.first).to eq canvas_object
       end
-      it 'has expected string values' do
+      it "has expected string values" do
         expect(sequence_object.id).to eq "http://example.org/iiif/book1/sequence/normal"
         expect(sequence_object.viewingDirection).to eq "left-to-right"
         expect(sequence_object.startCanvas).to eq "https://example.org/abc666/iiif3/canvas/0001"
       end
-      it 'has expected additional content' do
+      it "has expected additional content" do
         expect(sequence_object.viewingHint).to eq ["paged"]
-        expect(sequence_object.label).to eq ({"en" => "Current Page Order"})
+        expect(sequence_object.label).to eq({"en" => "Current Page Order"})
       end
     end
 
-    describe 'another example' do
-      let!(:sequence_object) { described_class.new({
-        "id" => "http://example.com/prefix/sequence/456",
-        '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',
-          'type' => 'Image',
-          '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',
-        'rights' => [{'id' => '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/',
-        # Sequence
-        'metadata' => [{'label'=>'Author', 'value'=>'Anne Author'}],
-        "items" => [canvas_object],
-        'start_canvas' => 'http://www.example.org/iiif/book1/canvas/p2',
-        "viewingDirection" => "left-to-right",
-        "viewingHint" => ["paged"],
-        "startCanvas" => canvas_object.id,
-      })}
-      it 'validates' do
-        expect{sequence_object.validate}.not_to raise_error
+    describe "another example" do
+      let!(:sequence_object) {
+        described_class.new({
+          "id" => "http://example.com/prefix/sequence/456",
+          "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",
+            "type" => "Image",
+            "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",
+          "rights" => "Sample rights",
+          "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/",
+          # Sequence
+          "metadata" => [{"label" => "Author", "value" => "Anne Author"}],
+          "items" => [canvas_object],
+          "start_canvas" => "http://www.example.org/iiif/book1/canvas/p2",
+          "viewingDirection" => "left-to-right",
+          "viewingHint" => ["paged"],
+          "startCanvas" => canvas_object.id
+        })
+      }
+      it "validates" do
+        expect { sequence_object.validate }.not_to raise_error
       end
     end
   end