iiif-presentation 1.4.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d5fac69b52d8f3510fa40fc221882302736f9b4afe8b55b1330497ab11d8033
-  data.tar.gz: 9156c96e93409320cddde7d86bb78894b6351cd2c291ab6bdca39958d3f27bbc
+  metadata.gz: 8e5872ac7de857fa05e0181916f712460413e5b08b09d0b99867cc14ae39e0e5
+  data.tar.gz: 213166e3e00800955380ed432a1b10fce3a497011af92db4657474ef56e4b2aa
 SHA512:
-  metadata.gz: 85f3b92e738793e5360cdff614c6f50fd271cb7b1033a6df1de8452603a18b4aa6cb0c6e4c9e5639f0587c6d1666cb47054c4b99894e398ee4a3c1fcfa08bd09
-  data.tar.gz: be3fc1d37352d21c018cffc8c2315d221aadcd00fad0c46847ffe1d68b131b6bc3844abf08ba6bd5cf56c049df706a31e1300c3279fa98b3fb1e43d267a34187
+  metadata.gz: 840576064059d424a68fc9917e30a6a2bc120fb7157691fae70edadaa705711301fd175a3942ce227298086c934ae0f0f471b8379a00314da9aea7b068643b07
+  data.tar.gz: 308dd4b3bcd7b4dfbfaa5147a4d0208dfaedaa69265577b43fd46e04e59be8f95f12a92667a12c935d07a534e6ef271ea2ce9d50dbc449b5a2af1a800b0a51d9

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.4.2

data/lib/iiif/v3/abstract_resource.rb

@@ -31,11 +31,11 @@ module IIIF
       end
 
       def string_only_keys
-        %w{ nav_date type format viewing_direction start_canvas }
+        %w{ nav_date type format rights viewing_direction start_canvas }
       end
 
       def array_only_keys
-        %w{ metadata rights thumbnail rendering first last next prev items service }
+        %w{ metadata thumbnail rendering first last next prev items service }
       end
 
       def hash_only_keys
@@ -122,10 +122,9 @@ module IIIF
           end
         end
 
-        self.uri_only_keys.each do |k|
+        uri_only_keys.each do |k|
           if self[k]
-            vals = *self[k]
-            vals.each { |val| validate_uri(val, k) }
+            Array(self[k]).each { |val| validate_uri(val, k) }
           end
         end
 
@@ -187,20 +186,12 @@ module IIIF
             raise IIIF::V3::Presentation::IllegalValueError, m
           end
         end
-        # rights is Array; each entry is a Hash containing 'id' with a URI value
-        if self.has_key?('rights')
-          unless self['rights'].all? { |entry| entry.kind_of?(Hash) }
-            m = 'rights must be an Array with Hash members'
-            raise IIIF::V3::Presentation::IllegalValueError, m
-          end
-          self['rights'].each do |entry|
-            unless entry.keys.include?('id')
-              m = 'rights members must be a Hash including "id"'
-              raise IIIF::V3::Presentation::IllegalValueError, m
-            end
-            validate_uri(entry['id'], 'id') # raises IllegalValueError
-          end
+
+        if key?('rights') && !self['rights'].kind_of?(String)
+          m = 'rights must be a String'
+          raise IIIF::V3::Presentation::IllegalValueError, m
         end
+
         # rendering is Array; each entry is a Hash containing 'label' and 'format' keys
         if self.has_key?('rendering') && self['rendering']
           unless self['rendering'].all? { |entry| entry.kind_of?(Hash) }
@@ -347,7 +338,9 @@ module IIIF
         hsh.keys.each do |key|
           new_key = key.underscore == key ? key : key.underscore
           if new_key == 'service'
-            new_object[new_key] = IIIF::V3::AbstractResource.from_ordered_hash(hsh[key], IIIF::V3::Presentation::Service)
+            new_object[new_key] = hsh[key].map do |entry|
+              IIIF::V3::AbstractResource.from_ordered_hash(entry, IIIF::V3::Presentation::Service)
+            end
           elsif new_key == 'body'
             new_object[new_key] = IIIF::V3::AbstractResource.from_ordered_hash(hsh[key], IIIF::V3::Presentation::Resource)
           elsif hsh[key].kind_of?(Hash)

data/lib/iiif/v3/presentation/manifest.rb

@@ -63,8 +63,6 @@ module IIIF
           end
         end
 
-        # NOTE: allowing 'items' or 'sequences' as Universal Viewer currently only accepts sequences
-        #  see https://github.com/sul-dlss/osullivan/issues/27, sul-dlss/purl/issues/167
         def validate_items_list(items_array)
           unless items_array.size >= 1
             m = 'The items list must have at least one entry (and it must be a IIIF::V3::Presentation::Canvas)'

data/spec/fixtures/v3/manifests/complete_from_spec.json

@@ -28,11 +28,13 @@
   "description": "A longer description of this example book. It should give some real information.",
   "rights": "http://www.example.org/license.html",
   "attribution": "Provided by Example Organization",
-  "service": {
-    "@context": "http://example.org/ns/jsonld/context.json",
-    "id": "http://example.org/service/example",
-    "profile": "http://example.org/docs/example-service.html"
-  },
+  "service": [
+    {
+      "@context": "http://example.org/ns/jsonld/context.json",
+      "id": "http://example.org/service/example",
+      "profile": "http://example.org/docs/example-service.html"
+    }
+  ],
   "seeAlso": {
     "id": "http://www.example.org/library/catalog/book1.marc",
     "format": "application/marc"
@@ -67,11 +69,13 @@
                     "format": "image/jpeg",
                     "height": 2000,
                     "width": 1500,
-                    "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"
-                    }
+                    "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"
+                      }
+                    ]
                   }
                 }
               ]
@@ -102,25 +106,27 @@
                     "format": "image/jpeg",
                     "height": 2000,
                     "width": 1500,
-                    "service": {
-                      "@context": "http://iiif.io/api/image/2/context.json",
-                      "id": "http://www.example.org/images/book1-page2",
-                      "profile": "http://iiif.io/api/image/2/level1.json",
-                      "height": 8000,
-                      "width": 6000,
-                      "tiles": [
-                        {
-                          "width": 512,
-                          "scaleFactors": [
-                            1,
-                            2,
-                            4,
-                            8,
-                            16
-                          ]
-                        }
-                      ]
-                    }
+                    "service": [
+                      {
+                        "@context": "http://iiif.io/api/image/2/context.json",
+                        "id": "http://www.example.org/images/book1-page2",
+                        "profile": "http://iiif.io/api/image/2/level1.json",
+                        "height": 8000,
+                        "width": 6000,
+                        "tiles": [
+                          {
+                            "width": 512,
+                            "scaleFactors": [
+                              1,
+                              2,
+                              4,
+                              8,
+                              16
+                            ]
+                          }
+                        ]
+                      }
+                    ]
                   },
                   "target": "http://www.example.org/iiif/book1/canvas/p2"
                 }
@@ -153,11 +159,13 @@
                     "format": "image/jpeg",
                     "height": 2000,
                     "width": 1500,
-                    "service": {
-                      "@context": "http://iiif.io/api/image/2/context.json",
-                      "id": "http://www.example.org/images/book1-page3",
-                      "profile": "http://iiif.io/api/image/2/level1.json"
-                    }
+                    "service": [
+                      {
+                        "@context": "http://iiif.io/api/image/2/context.json",
+                        "id": "http://www.example.org/images/book1-page3",
+                        "profile": "http://iiif.io/api/image/2/level1.json"
+                      }
+                    ]
                   }
                 }
               ]

data/spec/fixtures/v3/manifests/minimal.json

@@ -32,11 +32,13 @@
                     "format": "image/jpeg",
                     "height": 2000,
                     "width": 1500,
-                    "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"
-                    }
+                    "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"
+                      }
+                    ]
                   }
                 }
               ]

data/spec/fixtures/v3/manifests/service_only.json

@@ -6,9 +6,11 @@
   "type": "Manifest",
   "id": "http://www.example.org/iiif/book1/manifest",
   "label": "Book 1",
-  "service": {
-    "@context": "http://example.org/ns/jsonld/context.json",
-    "id": "http://example.org/service/example",
-    "profile": "http://example.org/docs/example-service.html"
-  }
+  "service": [
+    {
+      "@context": "http://example.org/ns/jsonld/context.json",
+      "id": "http://example.org/service/example",
+      "profile": "http://example.org/docs/example-service.html"
+    }
+  ]
 }

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

@@ -46,13 +46,16 @@ describe IIIF::V3::AbstractResource do
         ],
         "id": "http://example.com/manifest",
         "type": "Manifest",
+        "rights": "http://creativecommons.org/licenses/by/4.0/",
         "label": "My Manifest",
-        "service": {
-          "@context": "http://iiif.io/api/image/2/context.json",
-          "@id":"http://www.example.org/images/book1-page1",
-          "id":"http://www.example.org/images/book1-page1",
-          "profile":"http://iiif.io/api/image/2/profiles/level2.json"
-        },
+        "service": [
+          {
+            "@context": "http://iiif.io/api/image/2/context.json",
+            "@id":"http://www.example.org/images/book1-page1",
+            "id":"http://www.example.org/images/book1-page1",
+            "profile":"http://iiif.io/api/image/2/profiles/level2.json"
+          }
+        ],
         "some_other_thing": {
           "foo" : "bar"
         },
@@ -95,7 +98,7 @@ describe IIIF::V3::AbstractResource do
     it 'turns services into Services' do
       expected_klass = IIIF::V3::Presentation::Service
       parsed = described_class.from_ordered_hash(fixture)
-      expect(parsed['service'].class).to be expected_klass
+      expect(parsed['service'].map(&:class).uniq).to contain_exactly expected_klass
     end
 
     it 'round-trips' do

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

@@ -139,27 +139,19 @@ describe IIIF::V3::AbstractResource do
         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
+      it 'raises IllegalValueError for entry that is not a string' 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)
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError)
       end
-      it 'does not raise error for entry with "id" that is URI' do
-        subject['rights'] = [{ 'id' => 'http://example.org/rights', 'format' => 'text/html' }]
+
+      it 'does not raise error for entry that is string' do
+        subject['rights'] = 'http://example.org/rights'
         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']

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

@@ -12,7 +12,7 @@ describe IIIF::V3::Presentation::Annotation do
     'id' => content_id,
     'type' => content_type,
     'format' => mimetype,
-    'service' => image_2_api_service
+    'service' => [image_2_api_service]
     )}
 
   describe '#required_keys' do
@@ -183,14 +183,16 @@ describe IIIF::V3::Presentation::Annotation do
         let(:img_mime) { 'image/jpeg' }
         let(:img_h) { 2000 }
         let(:img_w) { 1500 }
-        let(:img_hw_resource) { IIIF::V3::Presentation::ImageResource.new(
-          'id' => content_id,
-          'type' => img_type,
-          'format' => img_mime,
-          'height' => img_h,
-          'width' => img_w,
-          'service' => image_2_api_service
-          )}
+        let(:img_hw_resource)  do
+          IIIF::V3::Presentation::ImageResource.new(
+            'id' => content_id,
+            'type' => img_type,
+            'format' => img_mime,
+            'height' => img_h,
+            'width' => img_w,
+            'service' => [image_2_api_service]
+          )
+        end
         let(:my_anno) {
           anno = described_class.new
           anno['id'] = anno_id
@@ -209,22 +211,23 @@ describe IIIF::V3::Presentation::Annotation do
 
         describe 'and service with height and width and tiles' do
           let(:tiles_val) { [{"width" => 512, "scaleFactors" => [1,2,4,8,16]}] }
-          let(:service) {
+          let(:service) do
             s = image_2_api_service
             s['height'] = 8000
             s['width'] = 6000
             s['tiles'] = tiles_val
-            s
-          }
+            [s]
+          end
           it 'validates' do
             img_hw_resource['service'] = service
             expect{my_anno.validate}.not_to raise_error
           end
           it "body['service'] has expected additional values'" do
-            expect(my_anno['body']['service']).to eq service
-            expect(my_anno['body']['service']['height']).to eq 8000
-            expect(my_anno['body']['service']['width']).to eq 6000
-            expect(my_anno['body']['service']['tiles']).to eq tiles_val
+            annotation_service = my_anno['body']['service'].first
+            expect(annotation_service).to eq service.first
+            expect(annotation_service['height']).to eq 8000
+            expect(annotation_service['width']).to eq 6000
+            expect(annotation_service['tiles']).to eq tiles_val
           end
         end
       end

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

@@ -131,7 +131,7 @@ describe IIIF::V3::Presentation::ImageResource do
           'format' => img_mimetype,
           'height' => height,
           'width' => width,
-          'service' => image_v2_service
+          'service' => [image_v2_service]
           })
       }
       describe 'simpler' do
@@ -146,7 +146,7 @@ describe IIIF::V3::Presentation::ImageResource do
           expect(image_object.format).to eq img_mimetype
           expect(image_object.height).to eq height
           expect(image_object.width).to eq width
-          expect(image_object.service).to eq image_v2_service
+          expect(image_object.service.first).to eq image_v2_service
         end
       end
       describe 'height and width in service' do
@@ -156,27 +156,27 @@ describe IIIF::V3::Presentation::ImageResource do
         #   "format": "image/jpeg",
         #   "height":2000,
         #   "width":1500,
-        #   "service": {
+        #   "service": [{
         #       "@context": "http://iiif.io/api/image/2/context.json",
         #       "id": "http://example.org/images/book1-page2",
         #       "profile": "http://iiif.io/api/image/2/level1.json",
         #       "height":8000,
         #       "width":6000,
         #       "tiles": [{"width": 512, "scaleFactors": [1,2,4,8,16]}]
-        #   }
+        #   }]
         # }
         let(:img_obj) {
           img = image_object
-          img.service['height'] = 6666
-          img.service['width'] = 9999
-          img.service['tiles'] = [{"width" => 512, "scaleFactors" => [1,2,4,8,16]}]
+          img.service.first['height'] = 6666
+          img.service.first['width'] = 9999
+          img.service.first['tiles'] = [{"width" => 512, "scaleFactors" => [1,2,4,8,16]}]
           img
         }
         it 'validates' do
           expect{img_obj.validate}.not_to raise_error
         end
         it 'has expected service value' do
-          service_obj = img_obj.service
+          service_obj = img_obj.service.first
           expect(service_obj.class).to eq IIIF::V3::Presentation::Service
           expect(service_obj.keys.size).to eq 7
           expect(service_obj['height']).to eq 6666

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

@@ -176,7 +176,7 @@ describe IIIF::V3::Presentation::Manifest do
       let!(:thumbnail_image) { IIIF::V3::Presentation::ImageResource.new({
         "id" => "https://example.org/image/iiif/abc666_05_0001/full/!400,400/0/default.jpg",
         "format" => "image/jpeg",
-        "service" => thumbnail_image_service
+        "service" => [thumbnail_image_service]
         })}
       let!(:manifest_object) { described_class.new({
         "id" => "https://example.org/abc666/iiif3/manifest",
@@ -189,7 +189,7 @@ describe IIIF::V3::Presentation::Manifest do
         "items" => [canvas_object],
         "logo" => {
           "id" => "https://example.org/logo/full/400,/0/default.jpg",
-          "service" => logo_service
+          "service" => [logo_service]
         },
         "seeAlso" => {
           "id" => "https://example.org/abc666.mods",
@@ -242,7 +242,7 @@ describe IIIF::V3::Presentation::Manifest do
             },
             "logo" => {
               "id" => "https://example.org/logo/full/400,/0/default.jpg",
-              "service" => logo_service
+              "service" => [logo_service]
             },
             "seeAlso" => {
               "id" => "https://example.org/abc666.mods",
@@ -322,9 +322,7 @@ describe IIIF::V3::Presentation::Manifest do
         "viewingDirection" => "right-to-left",
         "viewingHint" => ["paged"],
         "navDate" => "1856-01-01T00:00:00Z",
-        "rights" => [{
-          "id" =>"http://example.org/license.html",
-          "format" => "text/html"}],
+        "rights" => "http://example.org/license.html",
         "requiredStatement" => {
           "label": { "en": [ "Attribution" ] },
           "value": { "en": [ "bleah" ] },

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

@@ -96,7 +96,7 @@ describe IIIF::V3::Presentation::Sequence do
         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' }
       let(:sequence_object) {
@@ -177,21 +177,21 @@ describe IIIF::V3::Presentation::Sequence do
         'thumbnail' => [{
           'id' => 'http://www.example.org/images/book1-page1/full/80,100/0/default.jpg',
           'type' => 'Image',
-          'service'=> {
+          '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'}],
+        'rights' => 'Sample rights',
         'logo' => 'http://www.example.org/logos/institution1.jpg',
         'see_also' => 'http://www.example.org/library/catalog/book1.xml',
-        'service' => {
+        '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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iiif-presentation
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Jon Stroop