iiif-presentation 1.4.1 → 1.5.0

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

@@ -2,68 +2,67 @@ module IIIF
   module V3
     module Presentation
       class Annotation < IIIF::V3::AbstractResource
-
-        TYPE = 'Annotation'.freeze
+        TYPE = "Annotation".freeze
 
         def required_keys
-          super + %w{ id motivation target }
+          super + %w[id motivation target]
         end
 
         def prohibited_keys
           super + CONTENT_RESOURCE_PROPERTIES + PAGING_PROPERTIES +
-          %w{ nav_date viewing_direction start_canvas content_annotations }
+            %w[nav_date viewing_direction start_canvas content_annotations]
         end
 
         def any_type_keys
-          super + %w{ body target }
+          super + %w[body target]
         end
 
         def uri_only_keys
-          super + %w{ id }
+          super + %w[id]
         end
 
         def string_only_keys
-          super + %w{ motivation time_mode }
+          super + %w[motivation time_mode]
         end
 
         def legal_time_mode_values
-          %w{ trim scale loop }.freeze
+          %w[trim scale loop].freeze
         end
 
         def legal_viewing_hint_values
-          super + %w{ none }
+          super + %w[none]
         end
 
-        def initialize(hsh={})
-          hsh['type'] = TYPE unless hsh.has_key? 'type'
-          hsh['motivation'] = 'painting' unless hsh.has_key? 'motivation'
-          super(hsh)
+        def initialize(hsh = {})
+          hsh["type"] = TYPE unless hsh.has_key? "type"
+          hsh["motivation"] = "painting" unless hsh.has_key? "motivation"
+          super
         end
 
         def validate
           super
 
-          if self.has_key?('body') && self['body'].kind_of?(IIIF::V3::Presentation::ImageResource)
+          if has_key?("body") && self["body"].is_a?(IIIF::V3::Presentation::ImageResource)
             img_res_class_str = "IIIF::V3::Presentation::ImageResource"
 
-            unless self.motivation == 'painting'
+            unless motivation == "painting"
               m = "#{self.class} motivation must be 'painting' when body is a kind of #{img_res_class_str}"
               raise IIIF::V3::Presentation::IllegalValueError, m
             end
 
-            body_resource = self['body']
-            body_id = body_resource['id']
+            body_resource = self["body"]
+            body_id = body_resource["id"]
             if body_id && body_id =~ /^https?:/
-              validate_uri(body_id, 'anno body ImageResource id') # can raise IllegalValueError
+              validate_uri(body_id, "anno body ImageResource id") # can raise IllegalValueError
             else
               m = "when #{self.class} body is a kind of #{img_res_class_str}, ImageResource id must be an http(s) URI"
               raise IIIF::V3::Presentation::IllegalValueError, m
             end
           end
 
-          if self.has_key?('time_mode')
-            unless self.legal_time_mode_values.include?(self['time_mode'])
-              m = "timeMode for #{self.class} must be one of #{self.legal_time_mode_values}."
+          if has_key?("time_mode")
+            unless legal_time_mode_values.include?(self["time_mode"])
+              m = "timeMode for #{self.class} must be one of #{legal_time_mode_values}."
               raise IIIF::V3::Presentation::IllegalValueError, m
             end
           end

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

@@ -2,19 +2,18 @@ module IIIF
   module V3
     module Presentation
       class AnnotationCollection < IIIF::V3::AbstractResource
-
-        TYPE = 'AnnotationCollection'.freeze
+        TYPE = "AnnotationCollection".freeze
 
         def required_keys
-          super + %w{ id }
+          super + %w[id]
         end
 
         def int_only_keys
-          super + %w{ total }
+          super + %w[total]
         end
 
         def array_only_keys
-          super + %w{ content }
+          super + %w[content]
         end
 
         # TODO: paging properties
@@ -27,11 +26,10 @@ module IIIF
         #
         # don't forget to validate
 
-        def initialize(hsh={})
-          hsh['type'] = TYPE unless hsh.has_key? 'type'
-          super(hsh)
+        def initialize(hsh = {})
+          hsh["type"] = TYPE unless hsh.has_key? "type"
+          super
         end
-
       end
     end
   end

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

@@ -2,47 +2,46 @@ module IIIF
   module V3
     module Presentation
       class AnnotationPage < IIIF::V3::AbstractResource
-
-        TYPE = 'AnnotationPage'.freeze
+        TYPE = "AnnotationPage".freeze
 
         def required_keys
-          super + %w{ id }
+          super + %w[id]
         end
 
         def prohibited_keys
           super + CONTENT_RESOURCE_PROPERTIES +
-            %w{ first last total nav_date viewing_direction start_canvas content_annotations }
+            %w[first last total nav_date viewing_direction start_canvas content_annotations]
         end
 
         def uri_only_keys
-          super + %w{ id }
+          super + %w[id]
         end
 
-        def array_only_keys;
-          super + %w{ items }
+        def array_only_keys
+          super + %w[items]
         end
 
         def legal_viewing_hint_values
-          super + %w{ none }
+          super + %w[none]
         end
 
-        def initialize(hsh={})
-          hsh['type'] = TYPE unless hsh.has_key? 'type'
-          super(hsh)
+        def initialize(hsh = {})
+          hsh["type"] = TYPE unless hsh.has_key? "type"
+          super
         end
 
         def validate
           super
 
-          unless self['id'] =~ /^https?:/
+          unless /^https?:/.match?(self["id"])
             err_msg = "id must be an http(s) URI for #{self.class}"
             raise IIIF::V3::Presentation::IllegalValueError, err_msg
           end
 
-          items = self['items']
-          if items && items.any?
+          items = self["items"]
+          if items&.any?
             unless items.all? { |entry| entry.instance_of?(IIIF::V3::Presentation::Annotation) }
-              err_msg = 'All entries in the items list must be a IIIF::V3::Presentation::Annotation'
+              err_msg = "All entries in the items list must be a IIIF::V3::Presentation::Annotation"
               raise IIIF::V3::Presentation::IllegalValueError, err_msg
             end
           end

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

@@ -2,54 +2,53 @@ module IIIF
   module V3
     module Presentation
       class Canvas < IIIF::V3::AbstractResource
-
-        TYPE = 'Canvas'.freeze
+        TYPE = "Canvas".freeze
 
         def required_keys
-          super + %w{ id label }
+          super + %w[id label]
         end
 
         def prohibited_keys
-          super + PAGING_PROPERTIES + %w{ viewing_direction format nav_date start_canvas content_annotations }
+          super + PAGING_PROPERTIES + %w[viewing_direction format nav_date start_canvas content_annotations]
         end
 
         def int_only_keys
-          super + %w{ depth }
+          super + %w[depth]
         end
 
         def array_only_keys
-          super + %w{ content }
+          super + %w[content]
         end
 
         def legal_viewing_hint_values
-          super + %w{ paged continuous non-paged facing-pages auto-advance }
+          super + %w[paged continuous non-paged facing-pages auto-advance]
         end
 
-        def initialize(hsh={})
-          hsh['type'] = TYPE unless hsh.has_key? 'type'
-          super(hsh)
+        def initialize(hsh = {})
+          hsh["type"] = TYPE unless hsh.has_key? "type"
+          super
         end
 
         def validate
           super
 
-          id_uri = URI.parse(self['id'])
-          unless self['id'] =~ /^https?:/ && id_uri.fragment.nil?
+          id_uri = URI.parse(self["id"])
+          unless self["id"] =~ /^https?:/ && id_uri.fragment.nil?
             err_msg = "id must be an http(s) URI without a fragment for #{self.class}"
             raise IIIF::V3::Presentation::IllegalValueError, err_msg
           end
 
-          content = self['content']
-          if content && content.any?
+          content = self["content"]
+          if content&.any?
             unless content.all? { |entry| entry.instance_of?(IIIF::V3::Presentation::AnnotationPage) }
-              err_msg = 'All entries in the content list must be a IIIF::V3::Presentation::AnnotationPage'
+              err_msg = "All entries in the content list must be a IIIF::V3::Presentation::AnnotationPage"
               raise IIIF::V3::Presentation::IllegalValueError, err_msg
             end
             content.each do |anno_page|
-              annos = anno_page['items']
-              if annos && annos.any?
-                unless annos.all? { |anno| anno.target == self.id }
-                  err_msg = 'URI of the canvas must be repeated in the target field of included Annotations'
+              annos = anno_page["items"]
+              if annos&.any?
+                unless annos.all? { |anno| anno.target == id }
+                  err_msg = "URI of the canvas must be repeated in the target field of included Annotations"
                   raise IIIF::V3::Presentation::IllegalValueError, err_msg
                 end
               end
@@ -58,9 +57,9 @@ module IIIF
 
           # "A canvas MUST have exactly one width and one height, or exactly one duration.
           # It may have width, height and duration.""
-          height = self['height']
-          width = self['width']
-          if (!!height ^ !!width) # this is an exclusive or: forces height and width to boolean
+          height = self["height"]
+          width = self["width"]
+          if !!height ^ !!width # this is an exclusive or: forces height and width to boolean
             extent_err_msg = "#{self.class} requires both height and width or neither"
             raise IIIF::V3::Presentation::IllegalValueError, extent_err_msg
           end

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

@@ -2,45 +2,44 @@ module IIIF
   module V3
     module Presentation
       class Choice < IIIF::V3::AbstractResource
-
-        TYPE = 'Choice'.freeze
+        TYPE = "Choice".freeze
 
         def prohibited_keys
           super + CONTENT_RESOURCE_PROPERTIES + PAGING_PROPERTIES +
-          %w{ nav_date viewing_direction start_canvas content_annotations }
+            %w[nav_date viewing_direction start_canvas content_annotations]
         end
 
         def any_type_keys
-          super + %w{ default }
+          super + %w[default]
         end
 
         def string_only_keys
-          super + %w{ choice_hint }
+          super + %w[choice_hint]
         end
 
-        def array_only_keys;
-          super + %w{ items };
+        def array_only_keys
+          super + %w[items]
         end
 
         def legal_viewing_hint_values
-          %w{ none }
+          %w[none]
         end
 
         def legal_choice_hint_values
-          %w{ client user }
+          %w[client user]
         end
 
-        def initialize(hsh={})
-          hsh['type'] = TYPE unless hsh.has_key? 'type'
-          super(hsh)
+        def initialize(hsh = {})
+          hsh["type"] = TYPE unless hsh.has_key? "type"
+          super
         end
 
         def validate
           super
 
-          if self.has_key?('choice_hint')
-            unless self.legal_choice_hint_values.include?(self['choice_hint'])
-              m = "choiceHint for #{self.class} must be one of #{self.legal_choice_hint_values}."
+          if has_key?("choice_hint")
+            unless legal_choice_hint_values.include?(self["choice_hint"])
+              m = "choiceHint for #{self.class} must be one of #{legal_choice_hint_values}."
               raise IIIF::V3::Presentation::IllegalValueError, m
             end
           end

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

@@ -2,15 +2,14 @@ module IIIF
   module V3
     module Presentation
       class Collection < IIIF::V3::AbstractResource
-
-        TYPE = 'Collection'.freeze
+        TYPE = "Collection".freeze
 
         def required_keys
-          super + %w{ id label }
+          super + %w[id label]
         end
 
         def array_only_keys
-          super + %w{ collections manifests }
+          super + %w[collections manifests]
         end
 
         # TODO: navDate (collection or manifest only) - The value must be an xsd:dateTime literal in UTC, expressed in the form “YYYY-MM-DDThh:mm:ssZ”;  There must be at most one navDate associated with any given resource.
@@ -24,12 +23,12 @@ module IIIF
         #   The value must be a non-negative integer.
 
         def legal_viewing_hint_values
-          %w{ auto-advance together }
+          %w[auto-advance together]
         end
 
-        def initialize(hsh={})
-          hsh['type'] = TYPE unless hsh.has_key? 'type'
-          super(hsh)
+        def initialize(hsh = {})
+          hsh["type"] = TYPE unless hsh.has_key? "type"
+          super
         end
 
         def validate

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

@@ -1,20 +1,19 @@
-require 'faraday'
+require "faraday"
 
 module IIIF
   module V3
     module Presentation
       class ImageResource < Resource
+        TYPE = "Image".freeze
 
-        TYPE = 'Image'.freeze
-
-        def initialize(hsh={})
-          hsh['type'] = TYPE unless hsh.has_key? 'type'
-          super(hsh)
+        def initialize(hsh = {})
+          hsh["type"] = TYPE unless hsh.has_key? "type"
+          super
         end
 
         class << self
-          IMAGE_API_DEFAULT_PARAMS = '/full/!200,200/0/default.jpg'.freeze
-          DEFAULT_FORMAT = 'image/jpeg'.freeze
+          IMAGE_API_DEFAULT_PARAMS = "/full/!200,200/0/default.jpg".freeze
+          DEFAULT_FORMAT = "image/jpeg".freeze
           # Create a new ImageResource that includes a IIIF Image API Service
           # See http://iiif.io/api/presentation/2.0/#image-resources
           #
@@ -54,8 +53,7 @@ module IIIF
           #   "width":1500
           # }
           #
-          def create_image_api_image_resource(params={})
-
+          def create_image_api_image_resource(params = {})
             service_id = params.fetch(:service_id)
             resource_id_default = "#{service_id}#{IMAGE_API_DEFAULT_PARAMS}"
             resource_id = params.fetch(:resource_id, resource_id_default)
@@ -69,32 +67,33 @@ module IIIF
 
             remote_info = get_info(service_id) if !have_whp || copy_info
 
-            resource = self.new
-            resource['id'] = resource_id
+            resource = new
+            resource["id"] = resource_id
             resource.format = format
-            resource.width = width.nil? ? remote_info['width'] : width
-            resource.height = height.nil? ? remote_info['height'] : height
+            resource.width = width.nil? ? remote_info["width"] : width
+            resource.height = height.nil? ? remote_info["height"] : height
             resource_service = Service.new
             if copy_info
               resource_service.merge!(remote_info)
-              resource_service['id'] ||= resource_service.delete('@id')
+              resource_service["id"] ||= resource_service.delete("@id")
             else
-              resource_service['id'] = service_id
-              if profile.nil?
-                if remote_info['profile'].kind_of?(Array)
-                  resource_service['profile'] = remote_info['profile'][0]
+              resource_service["id"] = service_id
+              resource_service["profile"] = if profile.nil?
+                if remote_info["profile"].is_a?(Array)
+                  remote_info["profile"][0]
                 else
-                  resource_service['profile'] = remote_info['profile']
+                  remote_info["profile"]
                 end
               else
-                resource_service['profile'] = profile
+                profile
               end
             end
             resource.service = [resource_service]
-            return resource
+            resource
           end
 
           protected
+
           def get_info(svc_id)
             conn = Faraday.new("#{svc_id}/info.json") do |c|
               c.use Faraday::Response::RaiseError

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

@@ -2,62 +2,61 @@ module IIIF
   module V3
     module Presentation
       class Manifest < IIIF::V3::AbstractResource
-
-        TYPE = 'Manifest'.freeze
+        TYPE = "Manifest".freeze
 
         def required_keys
           # NOTE:  relaxing requirement for items as Universal Viewer currently only accepts sequences
           #  see https://github.com/sul-dlss/osullivan/issues/27, sul-dlss/purl/issues/167
           # super + %w{ id label items }
-          super + %w{ id label }
+          super + %w[id label]
         end
 
         def prohibited_keys
-          super + CONTENT_RESOURCE_PROPERTIES + PAGING_PROPERTIES + %w{ start_canvas content_annotation }
+          super + CONTENT_RESOURCE_PROPERTIES + PAGING_PROPERTIES + %w[start_canvas content_annotation]
         end
 
         def uri_only_keys
-          super + %w{ id }
+          super + %w[id]
         end
 
         def array_only_keys
           # 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
           # super + %w{ items structures }
-          super + %w{ items structures sequences }
+          super + %w[items structures sequences]
         end
 
         def legal_viewing_hint_values
-          %w{ individuals paged continuous auto-advance }
+          %w[individuals paged continuous auto-advance]
         end
 
-        def initialize(hsh={})
-          hsh['type'] = TYPE unless hsh.has_key? 'type'
-          super(hsh)
+        def initialize(hsh = {})
+          hsh["type"] = TYPE unless hsh.has_key? "type"
+          super
         end
 
         def validate
           super # also checks navDate format
 
-          unless self['id'] =~ /^https?:/
+          unless /^https?:/.match?(self["id"])
             err_msg = "id must be an http(s) URI for #{self.class}"
             raise IIIF::V3::Presentation::IllegalValueError, err_msg
           end
 
           # Items object list
-          unless self&.[]('items')&.any?
-            m = 'The items list must have at least one entry (and it must be a IIIF::V3::Presentation::Canvas)'
+          unless self&.[]("items")&.any?
+            m = "The items list must have at least one entry (and it must be a IIIF::V3::Presentation::Canvas)"
             raise IIIF::V3::Presentation::MissingRequiredKeyError, m
           end
-          validate_items_list(self['items']) if self['items']
+          validate_items_list(self["items"]) if self["items"]
 
           # TODO: when embedding a sequence without any extensions within a manifest, the sequence must not have the @context field.
 
           # TODO: AnnotationLists must not be embedded within the manifest
 
-          if self['structures']
-            unless self['structures'].all? { |entry| entry.instance_of?(IIIF::V3::Presentation::Range)}
-              m = 'All entries in the structures list must be a IIIF::V3::Presentation::Range'
+          if self["structures"]
+            unless self["structures"].all? { |entry| entry.instance_of?(IIIF::V3::Presentation::Range) }
+              m = "All entries in the structures list must be a IIIF::V3::Presentation::Range"
               raise IIIF::V3::Presentation::IllegalValueError, m
             end
           end
@@ -65,12 +64,12 @@ module IIIF
 
         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)'
+            m = "The items list must have at least one entry (and it must be a IIIF::V3::Presentation::Canvas)"
             raise IIIF::V3::Presentation::MissingRequiredKeyError, m
           end
 
           unless items_array.all? { |entry| entry.instance_of?(IIIF::V3::Presentation::Canvas) }
-            m = 'All entries in the items list must be a IIIF::V3::Presentation::Canvas'
+            m = "All entries in the items list must be a IIIF::V3::Presentation::Canvas"
             raise IIIF::V3::Presentation::IllegalValueError, m
           end
         end