iiif-presentation 1.4.1 → 1.5.0

data/lib/iiif/presentation/canvas.rb

@@ -1,41 +1,40 @@
-require File.join(File.dirname(__FILE__), 'abstract_resource')
+require File.join(File.dirname(__FILE__), "abstract_resource")
 
 module IIIF
   module Presentation
     class Canvas < AbstractResource
-
       # TODO (?) a simple 'Image Canvas' constructor.
 
-      TYPE = 'sc:Canvas'
+      TYPE = "sc:Canvas"
 
       def required_keys
-        super + %w{ @id width height label }
+        super + %w[@id width height label]
       end
 
       def any_type_keys
-        super + %w{  }
+        super + %w[]
       end
 
       def array_only_keys
-        super + %w{ images other_content }
+        super + %w[images other_content]
       end
 
       # TODO: test and validate
       def int_only_keys
-        super + %w{ width height }
+        super + %w[width height]
       end
 
       def numeric_only_keys
-        super + %w{ duration }
+        super + %w[duration]
       end
 
       def legal_viewing_hint_values
-        super + %w{ non-paged }
+        super + %w[non-paged]
       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
@@ -43,7 +42,6 @@ module IIIF
         # all members of otherContent must be an annotation list
         super
       end
-
     end
   end
 end

data/lib/iiif/presentation/collection.rb

@@ -1,29 +1,27 @@
-require File.join(File.dirname(__FILE__), 'abstract_resource')
+require File.join(File.dirname(__FILE__), "abstract_resource")
 
 module IIIF
   module Presentation
     class Collection < AbstractResource
-
-      TYPE = 'sc:Collection'
+      TYPE = "sc:Collection"
 
       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
 
-      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
         # 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

@@ -1,44 +1,43 @@
-require File.join(File.dirname(__FILE__), 'resource')
-require 'faraday'
-require 'json'
+require File.join(File.dirname(__FILE__), "resource")
+require "faraday"
+require "json"
 
 module IIIF
   module Presentation
     class ImageResource < Resource
-
-      TYPE = 'dctypes:Image'
+      TYPE = "dctypes:Image"
 
       def int_only_keys
-        super + %w{ width height }
+        super + %w[width height]
       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
 
       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'
+        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 
+        #  * :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: 
+        #  * :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 
+        #  * :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 
+        #  * :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 
+        #  * :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:
@@ -60,8 +59,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)
@@ -70,36 +68,37 @@ module IIIF
           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 = 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)
           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]
+            resource.service["@context"] = IMAGE_API_CONTEXT
+            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
-          return resource
+          resource
         end
 
         protected
+
         def get_info(svc_id)
           conn = Faraday.new("#{svc_id}/info.json") do |c|
             c.use Faraday::Response::RaiseError
@@ -114,7 +113,6 @@ module IIIF
           JSON.parse(resp.body)
         end
       end
-
     end
   end
 end

data/lib/iiif/presentation/layer.rb

@@ -1,26 +1,25 @@
-require File.join(File.dirname(__FILE__), 'abstract_resource')
+require File.join(File.dirname(__FILE__), "abstract_resource")
 
 module IIIF
   module Presentation
     class Layer < AbstractResource
-
-      TYPE = 'sc:Layer'
+      TYPE = "sc:Layer"
 
       def required_keys
-        super + %w{ @id label }
+        super + %w[@id label]
       end
 
       def array_only_keys
-        super + %w{ other_content }
+        super + %w[other_content]
       end
 
       def string_only_keys
-        super + %w{ viewing_direction } # should any of the any_type_keys be here?
+        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)
+      def initialize(hsh = {})
+        hsh["@type"] = TYPE unless hsh.has_key? "@type"
+        super
       end
 
       def validate
@@ -28,7 +27,6 @@ module IIIF
         # can they be inline?
         super
       end
-
     end
   end
 end

data/lib/iiif/presentation/manifest.rb

@@ -1,30 +1,29 @@
-require File.join(File.dirname(__FILE__), 'abstract_resource')
+require File.join(File.dirname(__FILE__), "abstract_resource")
 
 module IIIF
   module Presentation
     class Manifest < AbstractResource
-
-      TYPE = 'sc:Manifest'
+      TYPE = "sc:Manifest"
 
       def required_keys
-        super + %w{ @id label }
+        super + %w[@id label]
       end
 
       def string_only_keys
-        super + %w{ viewing_direction }
+        super + %w[viewing_direction]
       end
 
       def array_only_keys
-        super + %w{ sequences structures }
+        super + %w[sequences structures]
       end
 
       def legal_viewing_hint_values
-        %w{ individuals paged continuous }
+        %w[individuals paged continuous]
       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
@@ -32,8 +31,6 @@ module IIIF
 
         super
       end
-
     end
   end
 end
-

data/lib/iiif/presentation/range.rb

@@ -1,32 +1,30 @@
-require File.join(File.dirname(__FILE__), 'sequence')
+require File.join(File.dirname(__FILE__), "sequence")
 
 module IIIF
   module Presentation
     class Range < Sequence
-
-      TYPE = 'sc:Range'
+      TYPE = "sc:Range"
 
       def required_keys
-        super + %w{ @id label }
+        super + %w[@id label]
       end
 
       def array_only_keys
-        super + %w{ ranges }
+        super + %w[ranges]
       end
 
       def legal_viewing_hint_values
-        super + %w{ top }
+        super + %w[top]
       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
         # Values of the ranges array must be strings
       end
-
     end
   end
 end

data/lib/iiif/presentation/resource.rb

@@ -1,21 +1,19 @@
-require File.join(File.dirname(__FILE__), 'abstract_resource')
+require File.join(File.dirname(__FILE__), "abstract_resource")
 
 module IIIF
   module Presentation
     class Resource < AbstractResource
-
       def required_keys
-        %w{ @id }
+        %w[@id]
       end
 
       def string_only_keys
-        super + %w{ format }
+        super + %w[format]
       end
 
-      def initialize(hsh={})
-        super(hsh)
+      def initialize(hsh = {})
+        super
       end
-
     end
   end
 end

data/lib/iiif/presentation/sequence.rb

@@ -1,26 +1,25 @@
-require File.join(File.dirname(__FILE__), 'abstract_resource')
+require File.join(File.dirname(__FILE__), "abstract_resource")
 
 module IIIF
   module Presentation
     class Sequence < AbstractResource
-
-      TYPE = 'sc:Sequence'
+      TYPE = "sc:Sequence"
 
       def array_only_keys
-        super + %w{ canvases }
+        super + %w[canvases]
       end
 
       def string_only_keys
-        super + %w{ start_canvas viewing_direction }
+        super + %w[start_canvas viewing_direction]
       end
 
       def legal_viewing_hint_values
-        %w{ individuals paged continuous }
+        %w[individuals paged continuous]
       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
@@ -28,8 +27,6 @@ module IIIF
         # * All members of canvases must be a kind of Canvas
         super
       end
-
     end
   end
 end
-

data/lib/iiif/presentation/service.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'abstract_resource')
+require File.join(File.dirname(__FILE__), "abstract_resource")
 
 module IIIF
   module Presentation
@@ -9,4 +9,3 @@ module IIIF
     end
   end
 end
-

data/lib/iiif/presentation.rb

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