iiif-presentation 0.0.4

data/lib/iiif/presentation.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__), 'service')
+%w{
+abstract_resource
+  annotation
+  annotation_list
+  canvas
+  collection
+  layer
+  manifest
+  resource
+    image_resource 
+  sequence 
+    range
+}.each do |f|
+  require File.join(File.dirname(__FILE__), 'presentation', f)
+end
+
+module IIIF
+  module Presentation
+    CONTEXT ||= 'http://iiif.io/api/presentation/2/context.json'
+
+    class MissingRequiredKeyError < StandardError; end
+    class IllegalValueError < StandardError; end
+  end
+end

data/lib/iiif/presentation/abstract_resource.rb

@@ -0,0 +1,75 @@
+require File.join(File.dirname(__FILE__), '../service')
+
+module IIIF
+  module Presentation
+    class AbstractResource < Service
+
+      # Every subclass should override the following five methods where
+      # appropriate, see Subclasses for how.
+      def required_keys
+        %w{ @type }
+      end
+
+      def any_type_keys # these are allowed on all classes
+        %w{ label description thumbnail attribution license logo see_also
+        related within }
+      end
+
+      def string_only_keys
+        %w{ viewing_hint } # should any of the any_type_keys be here?
+      end
+
+      def array_only_keys
+        %w{ metadata }
+      end
+
+      def abstract_resource_only_keys
+        super + [ { key: 'service', type: IIIF::Service } ]
+      end
+
+      def hash_only_keys
+        %w{ }
+      end
+
+      def int_only_keys
+        %w{ }
+      end
+
+      # Not every subclass is allowed to have viewingDirect, but when it is,
+      # it must be one of these values
+      def legal_viewing_direction_values
+        %w{ left-to-right right-to-left top-to-bottom bottom-to-top }
+      end
+
+      # Initialize a Presentation node
+      # @param [Hash] hsh - Anything in this hash will be added to the Object.'
+      #   Order is only guaranteed if an ActiveSupport::OrderedHash is passed.
+      # @param [boolean] include_context (default: false). Pass true if the'
+      #   context should be included.
+      def initialize(hsh={})
+        if self.class == IIIF::Presentation::AbstractResource
+          raise "#{self.class} is an abstract class. Please use one of its subclasses."
+        end
+        super(hsh)
+      end
+
+
+      # Options:
+      #  * force: (true|false). Skips validations.
+      #  * include_context: (true|false). Adds the @context to the top of the
+      #      document if it doesn't exist. Default: true.
+      #  * sort_json_ld_keys: (true|false). Brings all properties starting with
+      #      '@'. Default: true. to the top of the document and sorts them.
+      def to_ordered_hash(opts={})
+        include_context = opts.fetch(:include_context, true)
+        if include_context && !self.has_key?('@context')
+          self['@context'] = IIIF::Presentation::CONTEXT
+        end
+        super(opts)
+      end
+      
+    end
+
+  end
+end
+

data/lib/iiif/presentation/annotation.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__), 'abstract_resource')
+
+module IIIF
+  module Presentation
+    class Annotation < AbstractResource
+
+      TYPE = 'oa:Annotation'
+
+      def required_keys
+        super + %w{ motivation }
+      end
+
+      def abstract_resource_only_keys
+        super + [ { key: 'resource', type: IIIF::Presentation::Resource } ]
+      end
+
+      def initialize(hsh={})
+        hsh['@type'] = TYPE unless hsh.has_key? '@type'
+        hsh['motivation'] = 'sc:painting' unless hsh.has_key? 'motivation'
+        super(hsh)
+      end
+
+    end
+  end
+end

data/lib/iiif/presentation/annotation_list.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__), 'abstract_resource')
+
+module IIIF
+  module Presentation
+    class AnnotationList < AbstractResource
+
+      TYPE = 'sc:AnnotationList'
+
+      def required_keys
+        super + %w{ @id }
+      end
+
+      def array_only_keys; 
+        super + %w{ resources }; 
+      end
+
+      def initialize(hsh={})
+        hsh['@type'] = TYPE unless hsh.has_key? '@type'
+        super(hsh)
+      end
+
+      def validate
+        # Each member or resources must be a kind of Annotation
+      end
+
+    end
+  end
+end

data/lib/iiif/presentation/canvas.rb

@@ -0,0 +1,45 @@
+require File.join(File.dirname(__FILE__), 'abstract_resource')
+
+module IIIF
+  module Presentation
+    class Canvas < AbstractResource
+
+      # TODO (?) a simple 'Image Canvas' constructor.
+
+      TYPE = 'sc:Canvas'
+
+      def required_keys
+        super + %w{ @id width height label }
+      end
+
+      def any_type_keys
+        super + %w{  }
+      end
+
+      def array_only_keys
+        super + %w{ images other_content }
+      end
+
+      # TODO: test and validate
+      def int_only_keys
+        super + %w{ width height }
+      end
+
+      def legal_viewing_hint_values
+        super + %w{ non-paged }
+      end
+
+      def initialize(hsh={})
+        hsh['@type'] = TYPE unless hsh.has_key? '@type'
+        super(hsh)
+      end
+
+      def validate
+        # all members of images must be an annotation
+        # all members of otherContent must be an annotation list
+        super
+      end
+
+    end
+  end
+end

data/lib/iiif/presentation/collection.rb

@@ -0,0 +1,29 @@
+require File.join(File.dirname(__FILE__), 'abstract_resource')
+
+module IIIF
+  module Presentation
+    class Collection < AbstractResource
+
+      TYPE = 'sc:Collection'
+
+      def required_keys
+        super + %w{ @id label }
+      end
+
+      def array_only_keys
+        super + %w{ collections manifests }
+      end
+
+      def initialize(hsh={})
+        hsh['@type'] = TYPE unless hsh.has_key? '@type'
+        super(hsh)
+      end
+
+      def validate
+        # each member of collections and manifests must be a Hash
+        # each member of collections and manifests MUST have @id, @type, and label
+      end
+
+    end
+  end
+end

data/lib/iiif/presentation/image_resource.rb

@@ -0,0 +1,115 @@
+require File.join(File.dirname(__FILE__), 'resource')
+require 'faraday'
+require 'json'
+
+module IIIF
+  module Presentation
+    class ImageResource < Resource
+
+      TYPE = 'dctypes:Image'
+
+      def int_only_keys
+        super + %w{ width height }
+      end
+
+      def initialize(hsh={})
+        hsh['@type'] = 'dcterms:Image' unless hsh.has_key? '@type'
+        super(hsh)
+      end
+
+      class << self
+        IMAGE_API_DEFAULT_PARAMS = '/full/!200,200/0/default.jpg'
+        IMAGE_API_CONTEXT = 'http://iiif.io/api/image/2/context.json'
+        DEFAULT_FORMAT = 'image/jpeg'
+        # Create a new ImageResource that includes a IIIF Image API Service
+        # See http://iiif.io/api/presentation/2.0/#image-resources
+        #
+        # Params
+        #  * :service_id (required) - The base URI for the image on the image 
+        #      server.
+        #  * :resource_id - The id for the resource; if supplied this should 
+        #      resolve to an actual image. Default: 
+        #      "#{:service_id}/full/!200,200/0/default.jpg"
+        #  * :format - The format of the image that is returned when 
+        #       `:resource_id` is resolved. Default: 'image/jpeg'
+        #  * :height (Integer)
+        #  * :profile (String)
+        #  * :width (Integer) - If width, height, and profile are not supplied, 
+        #      this method will try to get the info from the server (based on 
+        #      :resource_id) and raise an Exception if this is not possible for
+        #       some reason.
+        #  * :copy_info (bool)- Even if width and height are supplied, try to 
+        #      get the info.json from the server and copy it in. Default: false
+        #
+        # Raises:
+        #  * KeyError if `:service_id` is not supplied
+        #  * Expections related to HTTP problems if a call to an image server fails
+        #
+        # The result is something like this:
+        #
+        # {
+        #   "@id":"http://www.example.org/iiif/book1/res/page1.jpg",
+        #   "@type":"dctypes:Image",
+        #   "format":"image/jpeg",
+        #   "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/profiles/level2.json",
+        #   },
+        #   "height":2000,
+        #   "width":1500
+        # }
+        #
+        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)
+          format = params.fetch(:format, DEFAULT_FORMAT)
+          height = params.fetch(:height, nil)
+          profile = params.fetch(:profile, nil)
+          width = params.fetch(:width, nil)
+          copy_info = params.fetch(:copy_info, false)
+          
+          have_whp = [width, height, profile].all? { |prop| !prop.nil? }
+
+          remote_info = get_info(service_id) if !have_whp || copy_info
+
+          resource = self.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.service = Service.new
+          if copy_info
+            resource.service.merge!(remote_info)
+          else
+            resource.service['@context'] = IMAGE_API_CONTEXT
+            resource.service['@id'] = service_id
+            if profile.nil?
+              if remote_info['profile'].kind_of?(Array)
+                resource.service['profile'] = remote_info['profile'][0]
+              else
+                resource.service['profile'] = remote_info['profile'][0]
+              end
+            else
+              resource.service['profile'] = profile
+            end
+          end
+          return resource
+        end
+
+        protected
+        def get_info(svc_id)
+          conn = Faraday.new("#{svc_id}/info.json") do |c|
+            c.use Faraday::Response::RaiseError
+            c.use Faraday::Adapter::NetHttp
+          end
+          resp = conn.get # raises exceptions that indicate HTTP problems
+          JSON.parse(resp.body)
+        end
+      end
+
+    end
+  end
+end

data/lib/iiif/presentation/layer.rb

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__), 'abstract_resource')
+
+module IIIF
+  module Presentation
+    class Layer < AbstractResource
+
+      TYPE = 'sc:Layer'
+
+      def required_keys
+        super + %w{ @id label }
+      end
+
+      def array_only_keys
+        super + %w{ other_content }
+      end
+
+      def string_only_keys
+        super + %w{ viewing_direction } # should any of the any_type_keys be here?
+      end
+
+      def initialize(hsh={})
+        hsh['@type'] = TYPE unless hsh.has_key? '@type'
+        super(hsh)
+      end
+
+      def validate
+        # Must all members of otherContent and images must be a URI (string), or
+        # can they be inline?
+        super
+      end
+
+    end
+  end
+end

data/lib/iiif/presentation/manifest.rb

@@ -0,0 +1,39 @@
+require File.join(File.dirname(__FILE__), 'abstract_resource')
+
+module IIIF
+  module Presentation
+    class Manifest < AbstractResource
+
+      TYPE = 'sc:Manifest'
+
+      def required_keys
+        super + %w{ @id label }
+      end
+
+      def string_only_keys
+        super + %w{ viewing_direction }
+      end
+
+      def array_only_keys
+        super + %w{ sequences structures }
+      end
+
+      def legal_viewing_hint_values
+        %w{ individuals paged continuous }
+      end
+
+      def initialize(hsh={})
+        hsh['@type'] = TYPE unless hsh.has_key? '@type'
+        super(hsh)
+      end
+
+      def validate
+        # TODO: check types of sequences and structure members
+
+        super
+      end
+
+    end
+  end
+end
+

data/lib/iiif/presentation/range.rb

@@ -0,0 +1,32 @@
+require File.join(File.dirname(__FILE__), 'sequence')
+
+module IIIF
+  module Presentation
+    class Range < Sequence
+
+      TYPE = 'sc:Range'
+
+      def required_keys
+        super + %w{ @id label }
+      end
+
+      def array_only_keys
+        super + %w{ ranges }
+      end
+
+      def legal_viewing_hint_values
+        super + %w{ top }
+      end
+
+      def initialize(hsh={})
+        hsh['@type'] = TYPE unless hsh.has_key? '@type'
+        super(hsh)
+      end
+
+      def validate
+        # Values of the ranges array must be strings
+      end
+
+    end
+  end
+end