iiif-presentation 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a766530b4d9f912c49a41e9c6d5982282671c4188a26b27e5a4fb99176fae90c
-  data.tar.gz: bbb25e477c3563ab2a65ec0de5bfc634acffa93c00e7504992dfe539f0e89ad2
+  metadata.gz: 8d5fac69b52d8f3510fa40fc221882302736f9b4afe8b55b1330497ab11d8033
+  data.tar.gz: 9156c96e93409320cddde7d86bb78894b6351cd2c291ab6bdca39958d3f27bbc
 SHA512:
-  metadata.gz: ac981b561c8e99f41891f2e5246bf46e6de9766abde2269e5eb46e35baeabb4a74404366b8e83ff2eef4e8656ddcb3e8946cd07bfcf14a96c40ba10b29f2fab7
-  data.tar.gz: 126391967ebc6b1e3db349daed94e3aad1ba43f8083729c49b0c976131f5e3c85f8f507713d0f04721f98c494b0193b761a714f1129b9b044d0dcf181e21e112
+  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.2.0
+1.4.0

data/iiif-presentation.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json'
   spec.add_dependency 'activesupport', '>= 3.2.18'
   spec.add_dependency 'faraday', '~> 2.7'
+  spec.add_dependency 'geo_coord'
 end

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

@@ -0,0 +1,108 @@
+require 'geo/coord'
+
+module IIIF
+  module V3
+    module Presentation
+      class NavPlace < IIIF::V3::AbstractResource
+        Rect = Struct.new(:coord1, :coord2)
+
+        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
+        end
+
+        # @return [Boolean] indicates if coordinate_texts passed in are valid
+        def valid?
+          !(coordinates.nil? || coordinates.empty?)
+        end
+
+        def build
+          raise ArgumentError.new('invalid coordinates') unless valid?
+
+          {
+            id: "#{base_uri}/feature-collection/1",
+            type: 'FeatureCollection',
+            features: features
+          }
+        end
+
+        private
+
+        attr_reader :coordinate_texts, :base_uri
+
+        def coordinates
+          @coordinates ||= coordinate_texts.map do |coordinate_text|
+            coordinate_parts = coordinate_text.split(%r{ ?--|/})
+            case coordinate_parts.length
+            when 2
+              coord_for(coordinate_parts[0], coordinate_parts[1])
+            when 4
+              rect_for(coordinate_parts)
+            end
+          end.compact
+        end
+
+        def coord_for(long_str, lat_str)
+          long_matcher = long_str.match(COORD_REGEX)
+          lat_matcher = lat_str.match(COORD_REGEX)
+          return unless long_matcher && lat_matcher
+
+          Geo::Coord.new(latd: lat_matcher[:degrees], latm: lat_matcher[:minutes], lats: lat_matcher[:seconds], lath: lat_matcher[:hemisphere],
+                        lngd: long_matcher[:degrees], lngm: long_matcher[:minutes], lngs: long_matcher[:seconds], lngh: long_matcher[:hemisphere])
+        end
+
+        def rect_for(coordinate_parts)
+          coord1 = coord_for(coordinate_parts[0], coordinate_parts[2])
+          coord2 = coord_for(coordinate_parts[1], coordinate_parts[3])
+          return if coord1.nil? || coord2.nil?
+
+          Rect.new(coord1, coord2)
+        end
+
+        def features
+          coordinates.map.with_index(1) do |coordinate, index|
+            {
+              id: "#{base_uri}/iiif/feature/#{index}",
+              type: 'Feature',
+              properties: {},
+              geometry: coordinate.is_a?(Rect) ? polygon_geometry(coordinate) : point_geometry(coordinate)
+            }
+          end
+        end
+
+        def point_geometry(coord)
+          {
+            type: 'Point',
+            coordinates: [format(coord.lng), format(coord.lat)]
+          }
+        end
+
+        def polygon_geometry(rect)
+          {
+            type: 'Polygon',
+            coordinates: [
+              [
+                [format(rect.coord1.lng), format(rect.coord1.lat)],
+                [format(rect.coord2.lng), format(rect.coord1.lat)],
+                [format(rect.coord2.lng), format(rect.coord2.lat)],
+                [format(rect.coord1.lng), format(rect.coord2.lat)],
+                [format(rect.coord1.lng), format(rect.coord1.lat)]
+              ]
+            ]
+          }
+        end
+
+        # @param [BigDecimal] coordinate value from geocoord gem
+        # @return [String] string formatted with max 6 digits after the decimal point
+        # The to_f ensures removal of scientific notation of BigDecimal before converting to a string.
+        # examples:
+        # input value is BigDecimal("-23.9") or "0.239e2", output value is "-23.9" as string
+        # input value is BigDecimal("23.9424213434") or "0.239424213434e2", output value is "23.942421" as string
+        def format(decimal)
+          decimal.truncate(6).to_f.to_s
+        end
+      end
+    end
+  end
+end

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/lib/iiif/v3/presentation.rb

@@ -11,6 +11,7 @@ require_relative '../ordered_hash'
   choice
   collection
   manifest
+  nav_place
   resource
   image_resource
   sequence

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

@@ -0,0 +1,96 @@
+describe IIIF::V3::Presentation::NavPlace do
+  let(:subject) { described_class.new(coordinate_texts: coordinate_texts, base_uri: base_uri) }
+  let(:base_uri) { "https://purl.stanford.edu" }
+  let(:invalid_coordinates) { ["bogus", "stuff", "is", "here"] }
+  let(:valid_coordinates) 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).', # 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',
+      type: 'FeatureCollection',
+      features: [{ id: 'https://purl.stanford.edu/iiif/feature/1',
+                  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']]] } },
+                { id: 'https://purl.stanford.edu/iiif/feature/2',
+                  type: 'Feature',
+                  properties: {},
+                  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
+    context 'when coordinates are valid' do
+      let(:coordinate_texts) { valid_coordinates }
+
+      it 'returns navPlace' do
+        expect(subject.build).to eq nav_place
+      end
+    end
+
+    context 'when coordinates are not present' do
+      let(:coordinate_texts) { [] }
+
+      it 'raises ArgumentError' do
+        expect { subject.build }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'when coordinates are invalid' do
+      let(:coordinate_texts) { invalid_coordinates }
+
+      it 'raises ArgumentError' do
+        expect { subject.build }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#valid' do
+    context 'when coordinates are valid' do
+      let(:coordinate_texts) { valid_coordinates }
+
+      it 'returns true' do
+        expect(subject.valid?).to be true
+      end
+    end
+
+    context 'when coordinates are not present' do
+      let(:coordinate_texts) { [] }
+
+      it 'returns false' do
+        expect(subject.valid?).to be false
+      end
+    end
+
+    context 'when coordinates are invalid' do
+      let(:coordinate_texts) { invalid_coordinates }
+
+      it 'returns false' do
+        expect(subject.valid?).to be false
+      end
+    end
+  end
+end

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.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Jon Stroop
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +149,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: geo_coord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: API for working with IIIF Presentation manifests.
 email:
 - jpstroop@gmail.com
@@ -192,6 +205,7 @@ files:
 - lib/iiif/v3/presentation/collection.rb
 - lib/iiif/v3/presentation/image_resource.rb
 - lib/iiif/v3/presentation/manifest.rb
+- lib/iiif/v3/presentation/nav_place.rb
 - lib/iiif/v3/presentation/range.rb
 - lib/iiif/v3/presentation/resource.rb
 - lib/iiif/v3/presentation/sequence.rb
@@ -238,6 +252,7 @@ files:
 - spec/unit/iiif/v3/presentation/collection_spec.rb
 - spec/unit/iiif/v3/presentation/image_resource_spec.rb
 - spec/unit/iiif/v3/presentation/manifest_spec.rb
+- spec/unit/iiif/v3/presentation/nav_place_spec.rb
 - spec/unit/iiif/v3/presentation/range_spec.rb
 - spec/unit/iiif/v3/presentation/resource_spec.rb
 - spec/unit/iiif/v3/presentation/sequence_spec.rb
@@ -254,7 +269,6 @@ homepage: https://github.com/iiif/osullivan
 licenses:
 - Simplified BSD
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -269,8 +283,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: API for working with IIIF Presentation manifests.
 test_files:
@@ -316,6 +329,7 @@ test_files:
 - spec/unit/iiif/v3/presentation/collection_spec.rb
 - spec/unit/iiif/v3/presentation/image_resource_spec.rb
 - spec/unit/iiif/v3/presentation/manifest_spec.rb
+- spec/unit/iiif/v3/presentation/nav_place_spec.rb
 - spec/unit/iiif/v3/presentation/range_spec.rb
 - spec/unit/iiif/v3/presentation/resource_spec.rb
 - spec/unit/iiif/v3/presentation/sequence_spec.rb