wax_iiif 0.0.2 → 0.1.0

data/lib/{iiif_s3 → wax_iiif}/image_tile.rb

@@ -1,23 +1,18 @@
-
-require "mini_magick"
+require 'mini_magick'
 require 'fileutils'
 
-module IiifS3
-
-  #
-  # Class ImageTile is a specific ImageVariant used when generating a 
+module WaxIiif
+  # 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 [WaxIiif::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)
@@ -26,14 +21,14 @@ module IiifS3
     end
 
     protected
-        
-    def resize(width=nil,height=nil)
+
+    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
@@ -41,6 +36,5 @@ module IiifS3
     def filestring
       "/#{region}/#{@tile[:xSize]},/0"
     end
-
   end
-end
+end

data/lib/{iiif_s3 → wax_iiif}/image_variant.rb

@@ -1,23 +1,17 @@
-
-require "mini_magick"
+require 'mini_magick'
 require 'fileutils'
-require_relative "utilities"
-
-module IiifS3
+require_relative 'utilities'
 
+module WaxIiif
   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.
     #
@@ -25,57 +19,48 @@ module IiifS3
     # 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 [WaxIiif::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
+    # @raise WaxIiif::Error::InvalidImageData
     #
     def initialize(data, config, size = 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
+
+      raise WaxIiif::Error::InvalidImageData, 'Each image needs an ID' if data.id.nil? || data.id.to_s.empty?
+      raise WaxIiif::Error::InvalidImageData, 'Each image needs an path.' if data.image_path.nil? || data.image_path.to_s.empty?
 
       # 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}"
+        raise WaxIiif::Error::InvalidImageData, "Cannot read this image file: #{data.image_path}. #{e}"
       end
 
       width = size.nil? ? width : size
       resize(width)
-      @image.format "jpg"
 
-      @id =   generate_image_id(data.id,data.page_number)
-      @uri =  "#{id}#{filestring}/default.jpg"
+      @image.format 'jpg'
+      @id   = generate_image_id(data.id)
+      @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
+      path = "#{@id}#{filestring}".gsub(@config.base_url, @config.output_dir)
+      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
+      @image.write filename unless File.exist? filename
     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
@@ -83,16 +68,14 @@ module IiifS3
 
     # 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")
+    # @return [String] the MIME Content-Type (typically 'image/jpeg')
     #
     def mime_type
       @image.mime_type
@@ -105,23 +88,22 @@ module IiifS3
     #
     # @return [<type>] <description>
     #
-    def generate_image_id(id, page_number)
-      "#{@config.base_url}#{@config.prefix}/#{@config.image_directory_name}/#{id}-#{page_number}"
+    def generate_image_id(id)
+      "#{@config.base_url}#{@config.prefix}/#{@config.image_directory_name}/#{id}"
     end
 
     protected
 
     def region
-      "full"
+      'full'
     end
 
     def resize(width)
-      @image.resize "#{width}"
+      @image.resize width
     end
 
     def filestring
       "/#{region}/#{width},/0"
     end
-
   end
 end

data/lib/wax_iiif/manifest.rb

@@ -0,0 +1,151 @@
+module WaxIiif
+  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'.freeze
+
+    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 WaxIiif::Error::InvalidImageData, 'The data provided to the manifest were not ImageRecords' unless record.is_a? ImageRecord
+      end
+
+      @primary = image_records.find(&:primary?)
+
+      raise WaxIiif::Error::InvalidImageData, "No 'primary?' was found in the image data." unless @primary
+      raise WaxIiif::Error::MultiplePrimaryImages, 'Multiple primary images were found in the image data.' unless image_records.count(&:primary?) == 1
+
+      id = @primary.manifest_id.nil? ? "#{@primary.id}/manifest" : "#{@primary.manifest_id}/manifest"
+
+      @id           = generate_id(id)
+      @label        = @primary.label       || opts[:label] || ''
+      @description  = @primary.description || opts[:description]
+      @attribution  = @primary.attribution || opts.fetch(:attribution, nil)
+      @logo         = @primary.logo        || opts.fetch(:logo, nil)
+      @license      = @primary.license     || opts.fetch(:license, nil)
+      @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.document? ? 'paged' : 'individuals'
+      obj['sequences']        = [@sequences]
+
+      JSON.pretty_generate obj
+    end
+
+    # @return [String]
+    def base_id
+      @primary.manifest_id || @primary.id
+    end
+
+    #
+    # Save the manifest and all sub-resources to disk, using the
+    # paths contained withing the WaxIiif::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
+      nil
+    end
+
+    protected
+
+    #--------------------------------------------------------------------------
+    def build_sequence(image_records, opts = {})
+      seq_id = generate_id "sequence/#{@primary.id}"
+
+      opts.merge(
+        '@id' => seq_id,
+        '@type' => SEQUENCE_TYPE,
+        'canvases' => image_records.collect { |i| build_canvas(i) }
+      )
+    end
+
+    #--------------------------------------------------------------------------
+    def build_canvas(data)
+      canvas_id = generate_id "canvas/#{data.id}"
+
+      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
+      obj
+    end
+
+    #--------------------------------------------------------------------------
+    def build_image(data, canvas)
+      annotation_id = generate_id "annotation/#{data.id}"
+      {
+        '@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' => WaxIiif::IMAGE_CONTEXT,
+            '@id' => data.variants['full'].id,
+            'profile' => WaxIiif::LEVEL_0
+          },
+          'width' => data.variants['full'].width,
+          'height' => data.variants['full'].height
+        },
+        'on' => canvas['@id']
+      }
+    end
+  end
+end

data/lib/{iiif_s3 → wax_iiif}/thumbnail.rb

@@ -1,9 +1,7 @@
-require "mini_magick"
+require 'mini_magick'
 require 'fileutils'
 
-module IiifS3
-
-  #
+module WaxIiif
   # 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.
@@ -11,7 +9,6 @@ module IiifS3
   # @author David Newbury <david.newbury@gmail.com>
   #
   class Thumbnail < ImageVariant
-
     # Initialize a new thumbnail.
     #
     # @param [hash] data The image data object
@@ -19,16 +16,15 @@ module IiifS3
     # @param [Integer] max_width The maximum width of the thumbnail
     # @param [Integer] max_height The maximum height of the thumbnail
     #
-    def initialize(data, config, width=nil)
+    def initialize(data, config, width = nil)
       @width = width || config.thumbnail_size
-      super(data,config)
+      super(data, config)
     end
 
     protected
 
     def resize(width)
-      @image.resize "#{@width}"
+      @image.resize(width || @width)
     end
-
   end
 end

data/lib/{iiif_s3 → wax_iiif}/utilities.rb

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

data/lib/{iiif_s3 → wax_iiif}/utilities/helpers.rb

@@ -1,15 +1,13 @@
-module IiifS3
+module WaxIiif
   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.  
+    # 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."
@@ -17,7 +15,7 @@ module IiifS3
       # 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.
       #
@@ -25,12 +23,12 @@ module IiifS3
       # @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)
+        val += '.json' if @config.use_extensions
+        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)
@@ -39,58 +37,30 @@ module IiifS3
 
       # 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}"
+      def generate_image_location(id)
+        generate_build_location "#{@config.image_directory_name}/#{id}"
       end
 
-
       def get_data_path(data)
-        data['@id'].gsub(@config.base_url,@config.output_dir)
+        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
+        data['@context'] ||= WaxIiif::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)
+        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
+      def escape_yaml(str)
+        str.gsub(/\A---(.|\n)*?---/, '')
       end
     end
   end
-end
+end