iiif-presentation 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55260d04809482b5ebd267655c07543d4c97e2d5166bdca7b26eff5b22725fe6
-  data.tar.gz: 616cb247a11b55e56aac745508e5aa5000cae11c47b3e384d37ca2011b187c55
+  metadata.gz: 8d5fac69b52d8f3510fa40fc221882302736f9b4afe8b55b1330497ab11d8033
+  data.tar.gz: 9156c96e93409320cddde7d86bb78894b6351cd2c291ab6bdca39958d3f27bbc
 SHA512:
-  metadata.gz: e83acf715f8b6bf0513d1211ce5797237f28e9cead4c2cf3446b150ba496df81e16ba7b0d7ffae04aebe9cb40a4b84098c8d184e493f1259419cd0f9d99fae0b
-  data.tar.gz: 2221b5bcfc51cabfefc039584a58b93bd16fa95f7729e7921017bdac46b6d71e8cea6cbcc687e38f96a903386d4b7daf56d66693868e719b7cb6944ccc1067a3
+  metadata.gz: 85f3b92e738793e5360cdff614c6f50fd271cb7b1033a6df1de8452603a18b4aa6cb0c6e4c9e5639f0587c6d1666cb47054c4b99894e398ee4a3c1fcfa08bd09
+  data.tar.gz: be3fc1d37352d21c018cffc8c2315d221aadcd00fad0c46847ffe1d68b131b6bc3844abf08ba6bd5cf56c049df706a31e1300c3279fa98b3fb1e43d267a34187

data/README.md

@@ -44,13 +44,13 @@ canvas.label = 'My Canvas'
 service = IIIF::Presentation::Resource.new('@context' => 'http://iiif.io/api/image/2/context.json', 'profile' => 'http://iiif.io/api/image/2/level2.json', '@id' => "http://images.exampl.com/loris2/my-image")
 
 image = IIIF::Presentation::ImageResource.new()
-i['@id'] = "http://images.exampl.com/loris2/my-image/full/#{canvas.width},#{canvas.height}/0/default.jpg"
-i.format = "image/jpeg"
-i.width = canvas.width
-i.height = canvas.height
-i.service = service
+image['@id'] = "http://images.exampl.com/loris2/my-image/full/#{canvas.width},#{canvas.height}/0/default.jpg"
+image.format = "image/jpeg"
+image.width = canvas.width
+image.height = canvas.height
+image.service = service
 
-images = IIIF::Presentation::Resource.new('@type' => 'oa:Annotation', 'motivation' => 'sc:painting', '@id' => "#{canvas['@id']}/images", 'resource' => i)
+images = IIIF::Presentation::Resource.new('@type' => 'oa:Annotation', 'motivation' => 'sc:painting', '@id' => "#{canvas['@id']}/images", 'resource' => image)
 
 canvas.images << images
 

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.4.0

data/lib/iiif/presentation/annotation.rb

@@ -7,7 +7,11 @@ module IIIF
       TYPE = 'oa:Annotation'
 
       def required_keys
-        super + %w{ motivation }
+        super + %w{ motivation on }
+      end
+
+      def string_only_keys
+        super + %w{ on }
       end
 
       def abstract_resource_only_keys

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

@@ -6,8 +6,7 @@ module IIIF
       class NavPlace < IIIF::V3::AbstractResource
         Rect = Struct.new(:coord1, :coord2)
 
-        COORD_REGEX = /(?<hemisphere>[NSEW]) (?<degrees>\d+)[°⁰*] ?(?<minutes>\d+)?[ʹ']? ?(?<seconds>\d+)?[ʺ"]?/
-
+        COORD_REGEX = /(?:(?<hemisphere>[NSEW])\s*)?(?<degrees>\d+)[°⁰*](?:\s*(?<minutes>\d+)[\'ʹ′])?(?:\s*(?<seconds>\d+)["ʺ″])?(?:\s*(?<hemisphere>[NSEW]))?/
         def initialize(coordinate_texts:, base_uri:)
           @coordinate_texts = coordinate_texts
           @base_uri = base_uri

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

@@ -3,8 +3,8 @@ module IIIF
     module Presentation
       # Ranges are linked or embedded within the manifest in a structures field
       class Range < Sequence
-
         TYPE = 'Range'.freeze
+        VALID_ITEM_TYPES = [IIIF::V3::Presentation::Canvas, IIIF::V3::Presentation::Range]
 
         def required_keys
           super + %w{ id label }
@@ -28,11 +28,21 @@ module IIIF
 
         def validate
           super
+          validate_list(self['items']) if self['items']
+          validate_list(self['canvases']) if self['canvases']
           # TODO: Ranges must have URIs and they should be http(s) URIs.
-          # TODO: Values of the members array must be canvas or range
           # TODO: contentAnnotations: links to AnnotationCollection
           # TODO: startCanvas: A link from a Sequence or Range to a Canvas that is contained within it
         end
+
+        private
+
+        def validate_list(canvas_array)
+          return if canvas_array.all? { |entry| VALID_ITEM_TYPES.include?(entry.class) }
+
+          m = "All entries in the (items or canvases) array must be one of #{VALID_ITEM_TYPES.join(', ')}"
+          raise IIIF::V3::Presentation::IllegalValueError, m
+        end
       end
     end
   end

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

@@ -37,29 +37,14 @@ module IIIF
           # NOTE: allowing 'items' or 'canvases' as Universal Viewer currently only accepts canvases
           #  see https://github.com/sul-dlss/osullivan/issues/27, sul-dlss/purl/issues/167
           unless (self['items'] && self['items'].any?) ||
-              (self['canvases'] && self['canvases'].any?)
-            m = 'The (items or canvases) list must have at least one entry (and it must be a IIIF::V3::Presentation::Canvas)'
+                 (self['canvases'] && self['canvases'].any?)
+            m = 'The (items or canvases) list must have at least one entry.'
             raise IIIF::V3::Presentation::MissingRequiredKeyError, m
           end
-          validate_canvas_list(self['items']) if self['items']
-          validate_canvas_list(self['canvases']) if self['canvases']
-
           # TODO: startCanvas: A link from a Sequence or Range to a Canvas that is contained within it
 
           # TODO: All external Sequences must have a dereference-able http(s) URI
         end
-
-        def validate_canvas_list(canvas_array)
-          unless canvas_array.size >= 1
-            m = 'The (items or canvases) list must have at least one entry (and it must be a IIIF::V3::Presentation::Canvas)'
-            raise IIIF::V3::Presentation::MissingRequiredKeyError, m
-          end
-
-          unless canvas_array.all? { |entry| entry.instance_of?(IIIF::V3::Presentation::Canvas) }
-            m = 'All entries in the (items or canvases) list must be a IIIF::V3::Presentation::Canvas'
-            raise IIIF::V3::Presentation::IllegalValueError, m
-          end
-        end
       end
     end
   end

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

@@ -6,7 +6,9 @@ describe IIIF::V3::Presentation::NavPlace do
     ["W 23°54'00\"--E 53°36'00\"/N 71°19'00\"--N 33°30'00\"",
     'E 103°48ʹ/S 3°46ʹ).',
     'X 103°48ʹ/Y 3°46ʹ).',
-    'In decimal degrees: (E 138.0--W 074.0/N 073.0--N 041.2).']
+    'In decimal degrees: (E 138.0--W 074.0/N 073.0--N 041.2).', # currently invalid therefore doesn't show up in nav_place
+    '23°54′00″W -- 53°36′00″E / 71°19′00″N -- 33°30′00″N'
+    ]
   end
   let(:nav_place) do
     { id: 'https://purl.stanford.edu/feature-collection/1',
@@ -23,7 +25,21 @@ describe IIIF::V3::Presentation::NavPlace do
                 { id: 'https://purl.stanford.edu/iiif/feature/2',
                   type: 'Feature',
                   properties: {},
-                  geometry: { type: 'Point', coordinates: ['103.8', '-3.766666'] } }] }
+                  geometry: { type: 'Point', coordinates: ['103.8', '-3.766666'] } },
+                { id: 'https://purl.stanford.edu/iiif/feature/3',
+                  type: 'Feature',
+                  properties: {},
+                  geometry: { coordinates: ['103.8', '3.766666'], type: "Point" } },
+                { id: 'https://purl.stanford.edu/iiif/feature/4',
+                  type: 'Feature',
+                  properties: {},
+                  geometry: { type: 'Polygon',
+                              coordinates: [[['-23.9', '71.316666'],
+                                              ['53.6', '71.316666'],
+                                              ['53.6', '33.5'],
+                                              ['-23.9', '33.5'],
+                                              ['-23.9', '71.316666']]] } }
+                ] }
   end
 
   describe '#build' do

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

@@ -49,6 +49,25 @@ describe IIIF::V3::Presentation::Range do
   end
 
   describe '#validate' do
+    let(:bad_val_msg) do
+      "All entries in the (items or canvases) array must be one of #{IIIF::V3::Presentation::Range::VALID_ITEM_TYPES.join(', ')}"
+    end
+    describe 'items' do
+      it 'raises IllegalValueError for items entry that is not valid type' do
+        subject['id'] = 'test_range'
+        subject['label'] = { 'en' => ['Test Range'] }
+        subject['items'] = [IIIF::V3::Presentation::Range.new('id' => 'child_range', 'label' => ['Child Label']),
+                            IIIF::V3::Presentation::AnnotationPage.new]
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, bad_val_msg)
+      end
+    end
+    describe 'canvases' do
+      it 'raises IllegalValueError for canvases entry that is not valid type' do
+        subject['id'] = 'test_range'
+        subject['label'] = { 'en' => ['Test Range'] }
+        subject['canvases'] = [IIIF::V3::Presentation::Canvas.new, IIIF::V3::Presentation::AnnotationPage.new]
+        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, bad_val_msg)
+      end
+    end
   end
-
 end

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

@@ -57,8 +57,7 @@ describe IIIF::V3::Presentation::Sequence do
   end
 
   describe '#validate' do
-    let(:req_key_msg) { "The (items or canvases) list must have at least one entry (and it must be a IIIF::V3::Presentation::Canvas)" }
-    let(:bad_val_msg) { "All entries in the (items or canvases) list must be a IIIF::V3::Presentation::Canvas" }
+    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
       expect { subject.validate }.to raise_error(IIIF::V3::Presentation::MissingRequiredKeyError, req_key_msg)
     end
@@ -67,20 +66,12 @@ describe IIIF::V3::Presentation::Sequence do
         subject['items'] = []
         expect { subject.validate }.to raise_error(IIIF::V3::Presentation::MissingRequiredKeyError, req_key_msg)
       end
-      it 'raises IllegalValueError for items entry that is not a Canvas' do
-        subject['items'] = [IIIF::V3::Presentation::Canvas.new, IIIF::V3::Presentation::AnnotationPage.new]
-        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, bad_val_msg)
-      end
     end
     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
-      it 'raises IllegalValueError for canvases entry that is not a Canvas' do
-        subject['canvases'] = [IIIF::V3::Presentation::Canvas.new, IIIF::V3::Presentation::AnnotationPage.new]
-        expect { subject.validate }.to raise_error(IIIF::V3::Presentation::IllegalValueError, bad_val_msg)
-      end
     end
   end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: iiif-presentation
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Jon Stroop
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -270,7 +269,6 @@ homepage: https://github.com/iiif/osullivan
 licenses:
 - Simplified BSD
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -285,8 +283,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: API for working with IIIF Presentation manifests.
 test_files: