wax_iiif 0.0.1

data/lib/iiif_s3/image_tile.rb

@@ -0,0 +1,46 @@
+
+require "mini_magick"
+require 'fileutils'
+
+module IiifS3
+
+  #
+  # Class ImageTile is a specific ImageVariant used when generating a 
+  # stack of tiles suitable for Mirador-style zooming interfaces. Each
+  # instance of ImageTile represents a single tile.
+  #
+  # @author David Newbury <david.newbury@gmail.com>
+  #
+  class ImageTile < ImageVariant
+
+    #
+    # Initializing this
+    #
+    # @param [Hash] data A Image Data object.
+    # @param [IiifS3::Config] config The configuration object
+    # @param [Hash<width: Number, height: Number, x Number, y: Number, xSize: Number, ySize: Number>] tile
+    #    A hash of parameters that defines this tile.
+    def initialize(data, config, tile)
+      @tile = tile
+      super(data, config)
+    end
+
+    protected
+        
+    def resize(width=nil,height=nil)
+      @image.combine_options do |img|
+        img.crop "#{@tile[:width]}x#{@tile[:height]}+#{@tile[:x]}+#{@tile[:y]}"
+        img.resize "#{@tile[:xSize]}x#{@tile[:ySize]}"
+      end
+    end
+    
+    def region
+      "#{@tile[:x]},#{@tile[:y]},#{@tile[:width]},#{@tile[:height]}"
+    end
+
+    def filestring
+      "/#{region}/#{@tile[:xSize]},/0"
+    end
+
+  end
+end

data/lib/iiif_s3/image_variant.rb

@@ -0,0 +1,126 @@
+
+require "mini_magick"
+require 'fileutils'
+require_relative "utilities"
+
+module IiifS3
+
+  FakeImageVariant = Struct.new(:id, :width, :height, :uri, :mime_type)
+
+  #
+  # Class ImageVariant represents a single image file within a manifest.
+  # 
+  #
+  # @author David Newbury <david.newbury@gmail.com>
+  #
+  class ImageVariant
+    include Utilities::Helpers
+    include MiniMagick
+
+    #
+    # Initializing an ImageVariant will create the actual image file 
+    # on the file system.  
+    # 
+    # To initialize an image, you will need the 
+    # data hash to have an "id", a "image_path", and a "page_number".
+    #
+    # @param [Hash] data A Image Data object.
+    # @param [IiifS3::Config] config The configuration object
+    # @param [Number] width the desired width of this object in pixels
+    # @param [Number] height the desired height of this object in pixels
+    # @raise IiifS3::Error::InvalidImageData
+    #  
+    def initialize(data, config, width = nil, height = nil)
+
+      @config = config
+      # Validate input data
+      if data.id.nil? || data.id.to_s.empty?
+        raise IiifS3::Error::InvalidImageData, "Each image needs an ID" 
+      elsif data.image_path.nil? || data.image_path.to_s.empty?
+        raise IiifS3::Error::InvalidImageData, "Each image needs an path." 
+      end
+
+      # open image
+      begin
+        @image = Image.open(data.image_path)
+      rescue MiniMagick::Invalid => e
+        raise IiifS3::Error::InvalidImageData, "Cannot read this image file: #{data.image_path}. #{e}"
+      end
+
+      resize(width, height)
+      @image.format "jpg"
+
+      @id =   generate_image_id(data.id,data.page_number)
+      @uri =  "#{id}#{filestring}/default.jpg"
+
+      # Create the on-disk version of the file
+      path = "#{generate_image_location(data.id,data.page_number)}#{filestring}"
+      FileUtils::mkdir_p path
+      filename = "#{path}/default.jpg"
+      @image.write filename unless File.exists? filename
+      add_file_to_s3(filename) if @config.upload_to_s3
+    end
+
+
+    # @!attribute [r] uri
+    # @return [String] The URI for the jpeg image
+    attr_reader :uri
+
+    #
+    # @!attribute [r] id
+    #   @return [String] The URI for the variant.  
+    attr_reader :id
+
+
+    # Get the image width
+    #
+    #
+    # @return [Number] The width of the image in pixels
+    def width
+      @image.width
+    end
+
+    # Get the image height
+    #
+    #
+    # @return [Number] The height of the image in pixels
+    def height
+      @image.height
+    end
+
+    #
+    # Get the MIME Content-Type of the image. 
+    #
+    # @return [String] the MIME Content-Type (typically "image/jpeg")
+    # 
+    def mime_type
+      @image.mime_type
+    end
+
+    # Generate a URI for an image
+    #
+    # @param [String] id The specific ID for the image
+    # @param [String, Number] page_number The page number for this particular image.
+    #
+    # @return [<type>] <description>
+    # 
+    def generate_image_id(id, page_number)
+      "#{@config.base_url}#{@config.prefix}/#{@config.image_directory_name}/#{id}-#{page_number}"
+    end
+
+    protected
+
+    def region
+      "full"
+    end
+
+    def resize(width, height)
+      @image.resize "#{width}x#{height}"
+    end
+
+    def filestring
+      "/#{region}/#{width},/0"
+    end
+
+  end
+end

data/lib/iiif_s3/manifest.rb

@@ -0,0 +1,151 @@
+module IiifS3
+
+  FakeManifest = Struct.new(:id, :type, :label)
+
+  #
+  # Class Manifest is an abstraction over the IIIF Manifest, and by extension over the
+  # entire Presentation API.  It takes the internal representation of data and converts
+  # it into a collection of JSON-LD documents.  Optionally, it also provides the ability
+  # to save these files to disk and upload them to Amazon S3.
+  #
+  # @author David Newbury <david.newbury@gmail.com>
+  #
+
+  class Manifest
+
+    # @return [String] The IIIF default type for a manifest.
+    TYPE = "sc:Manifest"
+
+    include BaseProperties
+
+    #--------------------------------------------------------------------------
+    # CONSTRUCTOR
+    #--------------------------------------------------------------------------
+
+    # This will initialize a new manifest.
+    #
+    # @param [Array<ImageRecord>] image_records An array of ImageRecord types
+    # @param [<type>] config <description>
+    # @param [<type>] opts <description>
+    # 
+    def initialize(image_records,config, opts = {})
+      @config = config
+      image_records.each do |record|
+        raise IiifS3::Error::InvalidImageData, "The data provided to the manifest were not ImageRecords" unless record.is_a? ImageRecord
+      end
+
+      @primary = image_records.find{|obj| obj.is_primary}
+      raise IiifS3::Error::InvalidImageData, "No 'is_primary' was found in the image data." unless @primary
+      raise IiifS3::Error::MultiplePrimaryImages, "Multiple primary images were found in the image data." unless image_records.count{|obj| obj.is_primary} == 1
+
+      self.id =          "#{@primary.id}/manifest"
+      self.label =        @primary.label       || opts[:label]                 || ""
+      self.description =  @primary.description || opts[:description]
+      self.attribution =  @primary.attribution || opts.fetch(:attribution, nil) 
+      self.logo =         @primary.logo        || opts.fetch(:logo, nil)
+      self.license =      @primary.license     || opts.fetch(:license, nil)
+      self.metadata =     @primary.metadata    || opts.fetch(:metadata, nil)
+
+      @sequences = build_sequence(image_records)
+    end
+
+    #
+    # @return [String]  the JSON-LD representation of the manifest as a string.
+    # 
+    def to_json
+      obj = base_properties
+
+      obj["thumbnail"]   = @primary.variants["thumbnail"].uri
+      obj["viewingDirection"] = @primary.viewing_direction 
+      obj["viewingHint"] = @primary.is_document ? "paged" : "individuals"
+      obj["sequences"] = [@sequences]
+
+      return JSON.pretty_generate obj
+    end
+
+    #
+    # Save the manifest and all sub-resources to disk, using the
+    # paths contained withing the IiifS3::Config object passed at 
+    # initialization.
+    # 
+    # Will create the manifest, sequences, canvases, and annotation subobjects.
+    #
+    # @return [Void] 
+    # 
+    def save_all_files_to_disk
+      data = JSON.parse(self.to_json)
+      save_to_disk(data)
+      data["sequences"].each do |sequence|
+        save_to_disk(sequence)
+        sequence["canvases"].each do |canvas|
+          save_to_disk(canvas)
+          canvas["images"].each do |annotation|
+            save_to_disk(annotation)
+          end
+        end
+      end
+      return nil
+    end
+
+    protected
+
+
+    #--------------------------------------------------------------------------
+    def build_sequence(image_records,opts = {name: DEFAULT_SEQUENCE_NAME}) 
+      name = opts.delete(:name)
+      seq_id = generate_id "#{@primary.id}/sequence/#{name}"
+
+      opts.merge({
+        "@id" => seq_id,
+        "@type" => SEQUENCE_TYPE,
+        "canvases" => image_records.collect {|image_record| build_canvas(image_record)}
+      })
+    end
+
+    #--------------------------------------------------------------------------
+    def build_canvas(data)
+
+      canvas_id = generate_id "#{data.id}/canvas/#{data.section}"
+
+      obj = {
+        "@type" => CANVAS_TYPE,
+        "@id"   => canvas_id,
+        "label" => data.section_label,
+        "width" => data.variants["full"].width.floor,
+        "height" => data.variants["full"].height.floor,
+        "thumbnail" => data.variants["thumbnail"].uri
+      }
+      obj["images"] = [build_image(data, obj)]
+
+      # handle objects that are less than 1200px on a side by doubling canvas size
+      if obj["width"] < MIN_CANVAS_SIZE || obj["height"] < MIN_CANVAS_SIZE
+        obj["width"]  *= 2
+        obj["height"] *= 2
+      end
+      return obj
+    end
+
+    #--------------------------------------------------------------------------
+    def build_image(data, canvas)     
+      annotation_id =  generate_id "#{data.id}/annotation/#{data.section}"
+      {
+        "@type" => ANNOTATION_TYPE,
+        "@id"   => annotation_id,
+        "motivation" => MOTIVATION,
+        "resource" => {
+          "@id" => data.variants["full"].uri,
+          "@type" => IMAGE_TYPE,
+          "format" => data.variants["full"].mime_type || "image/jpeg",
+          "service" => {
+            "@context" => IiifS3::IMAGE_CONTEXT,
+            "@id" => data.variants["full"].id,
+            "profile" => IiifS3::LEVEL_0,
+          },
+          "width" => data.variants["full"].width,
+          "height" => data.variants["full"].height,
+        },
+        "on" => canvas["@id"]
+      }
+    end   
+  end
+end

data/lib/iiif_s3/thumbnail.rb

@@ -0,0 +1,35 @@
+require "mini_magick"
+require 'fileutils'
+
+module IiifS3
+
+  #
+  # Class Thumbnail provides a specific variant of an image file used for the thumbnail links
+  # within the metadata.  It will generate a consistent sized version based on a max width
+  # and height.  By default, it generates images at 250px on the longest size.
+  #
+  # @author David Newbury <david.newbury@gmail.com>
+  #
+  class Thumbnail < ImageVariant
+
+    # Initialize a new thumbnail.  
+    #
+    # @param [hash] data The image data object
+    # @param [Hash] config The configuration hash
+    # @param [Integer] max_width The maximum width of the thumbnail
+    # @param [Integer] max_height The maximum height of the thumbnail
+    # 
+    def initialize(data, config, max_width=nil, max_height = nil)
+      @max_width = max_width || config.thumbnail_size
+      @max_height = max_height || config.thumbnail_size
+      super(data,config)
+    end
+
+    protected
+
+    def resize(width, height)
+      @image.resize "#{@max_width}x#{@max_height}"
+    end
+    
+  end
+end

data/lib/iiif_s3/utilities.rb

@@ -0,0 +1,12 @@
+require_relative "utilities/pdf_splitter"
+require_relative "utilities/helpers"
+
+module IiifS3
+  # Module Utilities provides a set of basic utilities and helper functions for
+  # the IIIFS3 library.
+  #
+  # @author David Newbury <david.newbury@gmail.com>
+  #
+  module Utilities
+  end
+end

data/lib/iiif_s3/utilities/helpers.rb

@@ -0,0 +1,96 @@
+module IiifS3
+  module Utilities
+
+    # Module Helpers provides helper functions.  Which seems logical.
+    # 
+    # Note that these functions require an @config object to exist on the
+    # mixed-in class.  
+    #
+    # @author David Newbury <david.newbury@gmail.com>
+    #
+    module Helpers
+
+      # def self.included(klass)
+      #   unless respond_to? :config
+      #     raise StandardError, "The helpers have been included in class #{klass}, but #{klass} does not have a @config object."
+      #   end
+      # end
+
+      # This will generate a valid, escaped URI for an object.
+      # 
+      # This will prepend the standard path and prefix, and will append .json
+      # if enabled.
+      #
+      # @param [String] path The desired ID string
+      # @return [String] The generated URI
+      def generate_id(path)
+        val =  "#{@config.base_url}#{@config.prefix}/#{path}"
+        val += ".json" if @config.use_extensions
+        URI.escape(val)
+      end
+
+      # Given an id, generate a path on disk for that id, based on the config file
+      # 
+      # @param [String] id the path to the unique key for the object
+      # @return [String] a path within the output dir, with the prefix included
+      def generate_build_location(id)
+        "#{@config.output_dir}#{@config.prefix}/#{id}"
+      end
+
+      # Given an id and a page number, generate a path on disk for an image
+      # The path will be based on the config file.
+      # 
+      # @param [String] id the unique key for the object
+      # @param [String] page_number the page for this image.
+      # @return [String] a path for the image
+      def generate_image_location(id, page_number)
+        generate_build_location "#{@config.image_directory_name}/#{id}-#{page_number}"
+      end
+
+
+      def get_data_path(data)
+        data['@id'].gsub(@config.base_url,@config.output_dir)
+      end
+
+      def save_to_disk(data)
+        path = get_data_path(data)
+        data["@context"] ||= IiifS3::PRESENTATION_CONTEXT
+        puts "writing #{path}" if @config.verbose?
+        FileUtils::mkdir_p File.dirname(path)
+        File.open(path, "w") do |file|
+           file.puts JSON.pretty_generate(data)
+        end
+        add_file_to_s3(path) if @config.upload_to_s3
+      end
+
+      def get_s3_key(filename)
+        key = filename.gsub(@config.output_dir,"")
+        key = key[1..-1] if key[0] == "/"
+      end
+
+      def add_file_to_s3(filename)
+        key = get_s3_key(filename)
+        if File.extname(filename) == ".json" || File.extname(filename)  == ""
+          @config.s3.add_json(key,filename) 
+        elsif  File.extname(filename) == ".jpg" 
+          @config.s3.add_image(key,filename)
+        else
+          raise "Cannot identify file type!"
+        end
+      end
+
+      def add_default_redirect(filename) 
+        key = filename.gsub(@config.output_dir,"")
+        key = key[1..-1] if key[0] == "/"
+
+        name_key = key.split(".")[0..-2].join(".")
+
+        unless key == name_key
+          key = "#{@config.base_url}/#{key}"
+          puts "adding redirect from #{name_key} to #{key}" if @config.verbose?
+          @config.s3.add_redirect(name_key, key)
+        end
+      end
+    end
+  end
+end