wax_iiif 0.0.1

data/lib/iiif_s3/collection.rb

@@ -0,0 +1,61 @@
+module IiifS3
+
+  #
+  # Class Collection is an abstraction over the IIIF Collection, which is an aggregation
+  # of IIIF manifests. 
+  #
+  # @author David Newbury <david.newbury@gmail.com>
+  #
+  class Collection
+
+    # @return [String] The IIIF Type for collections
+    TYPE = "sc:Collection"
+
+    include BaseProperties
+    attr_reader :collections, :manifests
+
+    def initialize(label, config, name="top")  
+      raise IiifS3::Error::MissingCollectionName if label.nil? || label.empty?
+      @config = config
+      @manifests = []
+      @collections = []
+      self.label = label
+      self.id = "collection/#{name}"
+    end
+
+    def add_collection(collection)
+      raise IiifS3::Error::NotACollection unless collection.respond_to?(:type) && collection.type == Collection::TYPE
+      @collections.push(collection)
+    end
+
+    def add_manifest(manifest)
+      raise IiifS3::Error::NotAManifest unless manifest.respond_to?(:type) && manifest.type == Manifest::TYPE
+      @manifests.push(manifest)
+    end
+
+    # The JSON representation of this collection in the IIIF-expected format
+    #
+    #
+    # @return [String] The JSON representation as a string
+    # 
+    def to_json
+      obj = base_properties
+      obj["collections"] = collect_object(collections) unless collections.empty?
+      obj["manifests"] = collect_object(manifests) unless manifests.empty?
+      JSON.pretty_generate obj
+    end
+
+    protected
+
+    def collect_object(things)
+      things.collect do |thing|
+        {
+          "@id" => thing.id,
+          "@type" => thing.type,
+          "label" => thing.label
+        }
+      end
+    end
+  end
+end
+

data/lib/iiif_s3/config.rb

@@ -0,0 +1,142 @@
+module IiifS3
+  
+  # Config provides a data structure for holding the configuration settings
+  # for the IiifS3 class.  
+  #
+  # @author David Newbury <david.newbury@gmail.com>
+  #
+  class Config
+
+    # @return [String] The default URL to append to all IDs.
+    DEFAULT_URL = "http://0.0.0.0"
+    # @return [String] The name of the subdirectory where generated images live 
+    DEFAULT_IMAGE_DIRECTORY_NAME = "images"
+    # @return [String] The default path for writing generated image files
+    DEFAULT_OUTPUT_DIRECTORY = "./build"
+    # @return [Number] The default tile width/height in pixels
+    DEFAULT_TILE_WIDTH = 512
+    # @return [Array<Number>] The default tile scaling factors
+    DEFAULT_TILE_SCALE_FACTORS = [1,2,4,8]
+    # @return [Number] The default thumbnail size in pixels
+    DEFAULT_THUMBNAIL_SIZE = 250    
+
+    #
+    # @!attribute [r] base_url
+    #   @return [String] The protocol, domain, and port used for generating URIs.
+    #   Defaults to {IiifS3::Config::DEFAULT_URL}
+    attr_reader :base_url
+    #
+    # @!attribute [r] use_extensions
+    #   @return [Boolean] Should generated IDs and files have a .json extension?
+    #   Defaults to true
+    attr_reader :use_extensions
+    #
+    # @!attribute [r] output_dir
+    #   @return [String] The directory on the local file system where the output
+    #     files should be saved
+    #     Defaults to {IiifS3::Config::DEFAULT_OUTPUT_DIRECTORY}
+    attr_reader :output_dir
+    #
+    # @!attribute [r] prefix
+    #   @return [String] A prefix to be appended between the base URI and the id.
+    #     Can be blank,and it will automatically prepend a slash if one is not
+    #     provided.
+    #   Defaults to ""
+    attr_reader :prefix
+    #
+    # @!attribute [r] image_directory_name
+    #   @return [String] The name of the directory/prefix where image files will be
+    #   located.
+    #   Defaults to IiifS3::Config::DEFAULT_IMAGE_DIRECTORY_NAME
+    attr_reader :image_directory_name
+    #
+    # @!attribute [r] tile_width
+    #   @return [Number] The width (and height) of each individual tile.
+    #   Defaults to IiifS3::Config::DEFAULT_TILE_WIDTH
+    attr_reader :tile_width
+    #
+    # @!attribute [r] tile
+    #   @return [Array<Number>] An array of tile ratios to be uploaded.
+    #   Defaults to IiifS3::Config::DEFAULT_TILE_SCALE_FACTORS
+    attr_reader :tile_scale_factors
+    #
+    # @!attribute [r] variants
+    #   @return [Hash] A Hash of key/value pairs.  Each key should be the name of a variant,
+    #     each value the maximum pixel dimension of the longest side.
+    #   Defaults to {}
+    attr_reader :variants
+    #
+    # @!attribute [r] upload_to_s3
+    #   @return [Boolean] Should the files that are created by automatically uploaded to Amazon S3?
+    #   Defaults to false
+    attr_reader :upload_to_s3
+
+    # @!attribute [r] thumbnail_size
+    #   @return [Number] The max width in pixels for a thumbnail image
+    attr_reader :thumbnail_size
+
+    # @!attribute [r] verbose
+    #   @return [Bool] Should the program log information to the console?
+    attr_reader :verbose
+    alias :verbose? :verbose
+
+    # @!attribute [r] s3
+    #   @return [IiifS3::AmazonS3] the S3 object for this system
+    attr_reader :s3
+
+
+    # Initialize a new configuration option.
+    #
+    # @param [Hash] opts 
+    # @option opts [Boolean] :upload_to_s3 if true, images and metadata will be
+    #   uploaded to Amazon S3.  Defaults to False.
+    # @option opts [Number] :tile_width The width in pixels for generated tiles.
+    #   Defaults to {DEFAULT_TILE_WIDTH}
+    # @option opts [Array<Number>] :tile_scale_factors An array of ratios for generated tiles.
+    #   Defaults to {DEFAULT_TILE_SCALE_FACTORS}
+    # @option opts [String] :image_directory_name The name of the subdirectory for actual
+    #   image data. Defaults to {DEFAULT_IMAGE_DIRECTORY_NAME}
+    # @option opts [String] :output_dir The name of the directory for generated files.
+    #   image data. Defaults to {DEFAULT_OUTPUT_DIRECTORY}
+    # @option opts [String] :base_url The base URL for the generated URIs.  Defaults to
+    #   {DEFAULT_URL} if not auto-uploading to S3 and to the s3 bucket if upload_to_s3 is enabled. 
+    # @option opts [Number] :thumbnail_size the size in pixels
+    #   for the largest side of the thumbnail images.  Defaults to {DEFAULT_THUMBNAIL_SIZE}.
+    # @option opts [Bool] :use_extensions (true) should files have exensions appended?  
+    # @option opts [Bool] :verbose (false) Should debug information be printed to the console?  
+    # @option opts [String] :prefix ("") a prefix (read: subdirectory) for the generated URIs.
+    # @option opts [Hash{String: String}] :variants
+    def initialize(opts = {})
+      @upload_to_s3   = opts[:upload_to_s3] || false
+      @s3             = IiifS3::AmazonS3.new if @upload_to_s3
+      @tile_width     = opts[:tile_width]                 || DEFAULT_TILE_WIDTH
+      @tile_scale_factors = opts[:tile_scale_factors]     || DEFAULT_TILE_SCALE_FACTORS
+      @image_directory_name = opts[:image_directory_name] || DEFAULT_IMAGE_DIRECTORY_NAME
+      @base_url       = opts[:base_url]                   || ( @upload_to_s3 ? @s3.bucket.url : DEFAULT_URL)
+      @use_extensions = opts.fetch(:use_extensions, true) ## true
+      @output_dir     = opts[:output_dir]                 || DEFAULT_OUTPUT_DIRECTORY
+      @variants       = opts[:variants]                   || {}
+      @thumbnail_size = opts[:thumbnail_size]             || DEFAULT_THUMBNAIL_SIZE
+      @verbose        = opts.fetch(:verbose, false)       ## false
+      @prefix         = opts[:prefix]                     || ""
+      if @prefix.length > 0 && @prefix[0] != "/"
+        @prefix = "/#{@prefix}" 
+      end
+    end
+
+
+    # Compare two configuration files
+    #
+    # @param [IiifS3::Config] other_config The configuration file to compare
+    #
+    # @return [Bool] True if they are the same, false otherwise
+    # 
+    def ==(other_config)
+      valid = true
+      self.instance_variables.each do |v|
+        valid &&= instance_variable_get(v) == other_config.instance_variable_get(v)
+      end
+      valid
+    end
+  end
+end

data/lib/iiif_s3/errors.rb

@@ -0,0 +1,37 @@
+module IiifS3
+
+  #
+  # Module Error collects standard errors for th IiifS3 library.
+  module Error
+
+    # Class BlankCSV indicates that a provided CSV has no data.
+    class BlankCSV < StandardError; end
+
+    # Class InvalidCSV indicates that there is something wrong with the provided CSV.
+    class InvalidCSV < StandardError; end
+
+    # Class BadAmazonCredentials indicates that something was wrong with the Amazon login information.
+    class BadAmazonCredentials < StandardError; end
+
+    # Class MissingCollectionName indicates that the collection provided did not have a label.
+    class MissingCollectionName < StandardError; end
+
+    # Class NotACollection indicates that the object provided was not a sc:Collection.
+    class NotACollection < StandardError; end
+ 
+    # Class NotAManifest indicates that the object provided was not a sc:Manifest.
+    class NotAManifest < StandardError; end
+    
+    # Class InvalidCSV indicates that there is something wrong with the provided Image Data.
+    class InvalidImageData < StandardError; end
+
+    # Class InvalidViewingDirection indicates that the direction provided was not a valid viewing direction.
+    class InvalidViewingDirection < InvalidImageData; end
+    
+    # Class MultiplePrimaryImages indicates that multiple images were tagged as primary for a given manifest.
+    class MultiplePrimaryImages < InvalidImageData; end
+
+    # Class NoMasterError indicates that all of the images in a collection are secondary images.
+    class NoMasterError < InvalidImageData; end
+  end
+end

data/lib/iiif_s3/full_image.rb

@@ -0,0 +1,20 @@
+
+require "mini_magick"
+require 'fileutils'
+
+module IiifS3
+
+  #
+  # Class FullImage is a standard image variant that does not resize the image at all.
+  class FullImage < ImageVariant
+
+    protected
+    
+    def filestring
+      "/full/full/0"
+    end
+
+    def resize(width, height); end
+
+  end
+end

data/lib/iiif_s3/image_info.rb

@@ -0,0 +1,96 @@
+module IiifS3
+
+  #
+  # Class ImageInfo is a data object for the JSON representation of the image.
+  # 
+  # It is designed to support the http://iiif.io/api/image/2.0/#image-information spec.
+  class ImageInfo
+
+      attr_accessor :id
+      attr_accessor :width
+      attr_accessor :height
+      attr_accessor :tile_width
+      attr_accessor :tile_scale_factors
+
+      def initialize(uri, variants, tile_width= nil, tile_scale_factors = nil)
+
+        raise IiifS3::Error::InvalidImageData, "No full variant provided:  variants: #{variants}" unless variants["full"]
+        raise IiifS3::Error::InvalidImageData, "No thumbnail variant provided:  variants: #{variants}" unless variants["thumbnail"]
+        raise IiifS3::Error::InvalidImageData, "No URI was provided for this image!" if uri.nil?
+
+        @id = uri
+        full = variants["full"]
+        @variants = variants
+        @width = full.width
+        @height = full.height
+        @tile_width = tile_width
+        @tile_scale_factors = tile_scale_factors
+      end
+
+      # @return [Hash] a collection of valid sizes based on the available image variants
+      #  
+      def sizes
+         @variants.collect do |name,obj|
+          {"width" => obj.width, "height" => obj.height}
+        end
+      end
+
+      # The hash of tile information, or nil if the information does not exist.
+      #
+      #
+      # @return [Hash, nil] A hash of the tile metadata properly formatted for IIIF JSON.
+      # 
+      def tiles
+        return nil if @tile_scale_factors.nil? || @tile_scale_factors.empty?
+        
+        return [{
+          "width" => @tile_width,
+          "scaleFactors" => @tile_scale_factors
+        }]
+      end
+
+
+      # Generate the JSON data for this image in the IIIF-expected format.
+      #
+      #
+      # @return [String] the JSON representation of this image
+      # 
+      def to_json
+        obj = {
+          "@context" => context,
+          "@id" => URI.escape(id),
+          "protocol" => protocol,
+          "width" => width,
+          "height" => height,
+          "sizes" => sizes,
+          "profile" => profile,
+        }
+        obj["tiles"] = tiles unless tiles.nil?
+        obj["profile"]  = profile
+        obj["service"] = service unless service.nil?
+        JSON.pretty_generate obj
+      end
+
+      # @return [String] The IIIF context for this image
+      def context
+       IiifS3::IMAGE_CONTEXT
+      end
+
+      # @return [String] The IIIF protocol for this image
+      def protocol 
+        IiifS3::IMAGE_PROTOCOL
+      end
+
+      # @return [String] The IIIF profile this image supports
+      def profile
+        [IiifS3::LEVEL_0,{
+          supports: ["cors","sizeByWhListed", "baseUriRedirect"]
+        }]
+      end
+
+      # TODO:  Implement this.  See <http://iiif.io/api/annex/services/#physical-dimensions>
+      def service
+        return nil
+      end
+  end
+end

data/lib/iiif_s3/image_record.rb

@@ -0,0 +1,141 @@
+module IiifS3
+  # Class ImageRecord provides a data structure for a single image file.
+  # It contains information for content from the manifest level down to the
+  # specific variants of the images.  
+  # 
+  # It has the concept of primary images, which are the first (or only) image
+  # in the sequence.  This is the image where much of the top-level metadata is 
+  # taken from.  Each sequence can only have a single primary image, but that 
+  # constraint in enforced
+  #
+  # @author David Newbury <david.newbury@gmail.com>
+  #
+  class ImageRecord
+    attr_accessor :id
+    attr_accessor :label
+    attr_accessor :description
+    attr_accessor :attribution
+    attr_accessor :license
+    attr_accessor :metadata
+
+    attr_accessor :logo
+    attr_accessor :variants
+    
+    attr_writer :page_number
+    attr_writer :section
+    attr_writer :section_label
+    attr_writer :is_document
+    
+    # @param [Hash] opts 
+    # @option opts [String] :id The primary ID for the object.
+    # @option opts [String] :label The human-readable label for all grouped records
+    # @option opts [String] :description A longer, human-readable description of the gropued records
+    # @option opts [String] :logo A URL pointing to a logo of the institution
+    # @option opts [Hash]   :variants A hash of derivative names and sizes
+    #   @example {thumb: 150}
+    def initialize(opts={})
+      opts.each do |key, val|
+        self.send("#{key}=",val) if self.methods.include? "#{key}=".to_sym
+      end
+    end
+
+    # The page number of this image.  Defaults to 1.
+    #
+    # @return [Number]
+    def page_number
+      @page_number || 1
+    end
+
+    # The path to this image.
+    #
+    # @return [String]
+    def image_path
+      @path
+    end
+
+    def path=(_path)
+      raise IiifS3::Error::InvalidImageData, "Path is invalid: '#{_path}'" unless _path && File.exist?(_path)
+      @path = _path
+    end
+
+    # Is this image part of a document, or is it a standalone image (or image sequence)?
+    # 
+    # Currently, the only effects the page viewing hint for the image sequence.  
+    # This will only have an effect on the primary image for this sequence.
+    #
+    # @return [Bool]
+    # 
+    def is_document
+      return !!@is_document
+    end
+    alias :is_document? :is_document
+
+    # The name of the section this image is contained in.  
+    # Currently used to id the canvas for this image. 
+    # 
+    # defaults to IiifS3::DEFAULT_CANVAS_LABEL
+    #
+    # @return [String]
+    # 
+    def section
+      @section || DEFAULT_CANVAS_LABEL
+    end
+
+    # The label for the section this image is contained in.  
+    # Currently used to label the canvas for this image. 
+    #
+    # defaults to IiifS3::DEFAULT_CANVAS_LABEL
+    #
+    # @return [String] 
+    # 
+    def section_label
+      @section_label || DEFAULT_CANVAS_LABEL
+    end
+
+    # @return [String] The prefered viewing direction for this image.
+    #   Will default to IiifS3::DEFAULT_VIEWING_DIRECTION
+    # 
+    def viewing_direction
+      @viewing_direction || DEFAULT_VIEWING_DIRECTION
+    end
+
+    def viewing_direction=(dir)
+      raise Error::InvalidViewingDirection unless IiifS3.is_valid_viewing_direction(dir)
+      @viewing_direction = dir  
+    end
+
+    # Is this image the master image for its sequence?
+    #
+    # Each image sequence has a single image chosen as the primary image for
+    # the sequence.  By default, page one is the master image, but another image
+    # could be chosen as the master if desired. 
+    # 
+    # This is, for instance, the image whose thumbnail is the representation for
+    # the entire sequence, and it defined viewing direction and other top-level
+    # metadata.
+    #
+    # @return [Bool]
+    #
+    def is_primary
+      if @is_primary.nil?
+        self.page_number == 1
+      else
+        @is_primary
+      end
+    end
+
+    alias :is_primary? :is_primary
+    alias :is_master :is_primary # Depriciated, but around for backwards compatibility
+
+
+    # Set this image record as the master record for the sequence
+    #
+    # @param [Bool] val Is this image the master
+    #
+    # @return [Bool]
+    # 
+    def is_primary=(val)
+      @is_primary = !!val
+    end
+  end
+end