wax_iiif 0.0.1

data/lib/iiif_s3/utilities/pdf_splitter.rb

@@ -0,0 +1,50 @@
+require "mini_magick"
+
+module IiifS3
+  module Utilities
+
+    #
+    # Class PdfSplitter is a utility function designed to convert a PDF into a stack of images.
+    #
+    # @author David Newbury <david.newbury@gmail.com>
+    #
+    class PdfSplitter
+      # Convert a PDF File into a series of JPEG images, one per-page
+      #
+      # @param [String] path The path to the PDF file
+      # @param [Hash] options The configuration hash
+      #
+      # @return [Array<String>] The paths to the generated files
+      # 
+      def self.split(path, options={})
+
+        output_dir = options.fetch(:output_dir, ".")
+        verbose = options.fetch(:verbose, false)
+        puts "processing #{path}" if verbose
+        name = File.basename(path, File.extname(path))
+
+        pages = []
+
+        pdf = MiniMagick::Image.open(path)
+
+        pdf.pages.each_with_index do |page, index|
+          page_file_name = "#{output_dir}/#{name}_#{index+1}.jpg"
+          
+          MiniMagick::Tool::Convert.new do |convert|
+            convert.density("300")
+            convert.units("PixelsPerInch")
+            convert << page.path  
+            convert.quality("80")
+            convert.colorspace("sRGB")
+            convert.interlace("none")
+            convert.flatten
+            convert << page_file_name
+          end
+          pages.push(page_file_name)
+        end
+        GC.start
+        pages
+      end
+    end
+  end
+end

data/lib/iiif_s3/version.rb

@@ -0,0 +1,5 @@
+module IiifS3
+  #
+  # @return [String] The current library version
+  VERSION = "0.1.0"
+end

data/lib/wax_iiif.rb

@@ -0,0 +1,83 @@
+require 'csv'
+require 'json'
+
+require "iiif_s3/version"
+require "iiif_s3/errors"
+require "iiif_s3/base_properties"
+require "iiif_s3/image_record"
+require "iiif_s3/builder"
+require "iiif_s3/manifest"
+require "iiif_s3/config"
+require "iiif_s3/collection"
+require "iiif_s3/image_variant"
+require "iiif_s3/thumbnail"
+require "iiif_s3/image_tile"
+require "iiif_s3/full_image"
+require "iiif_s3/image_info"
+require "iiif_s3/utilities"
+
+# Module IiifS3 is a tool for generating IIIF resources from a set of files.
+# It's designed to support the IIIF level 0 profile, and generates entirely static files.
+#
+# @author David Newbury <david.newbury@gmail.com>
+#
+module IiifS3
+
+
+  #--------------------------------------------------------------------------
+  # CONSTANTS
+  #--------------------------------------------------------------------------
+
+
+  # @return [String] The URI of the presentation context for the IIIF V.2
+  PRESENTATION_CONTEXT  = "http://iiif.io/api/presentation/2/context.json"
+  # @return [String] The URI of the image context for the IIIF V.2
+  IMAGE_CONTEXT         = "http://iiif.io/api/image/2/context.json"
+  # @return [String] The URI of the image protocol for IIIF
+  IMAGE_PROTOCOL        = "http://iiif.io/api/image"
+  # @return [String] The URI of the Level 0 profile for the IIIF V.2
+  LEVEL_0               = "http://iiif.io/api/image/2/level0.json"
+  # @return [String]  The IIIF default type for a sequence.
+  SEQUENCE_TYPE             = "sc:Sequence"
+  # @return [String]  The IIIF default type for a canvas
+  CANVAS_TYPE               = "sc:Canvas"
+  # @return [String]  The IIIF default type for a annotation.
+  ANNOTATION_TYPE           = "oa:Annotation"
+  # @return [String]  The IIIF default type for an image.
+  IMAGE_TYPE                = "dcterms:Image"
+  # @return [String] The default label for a canvas without a specified name.
+  MOTIVATION                = "sc:painting"
+  # @return [String] The default label for a canvas without a specified name.
+  DEFAULT_CANVAS_LABEL      = "front"
+  # @return [String] The default name for a sequence without a specified name.
+  DEFAULT_SEQUENCE_NAME     = "default"
+  # @return [String] The default reading direction for this manifest.
+  DEFAULT_VIEWING_DIRECTION = "left-to-right"
+  # @return [Number] The size in pixels below which the canvas will be doubled.
+  MIN_CANVAS_SIZE           = 1200
+
+
+    #--------------------------------------------------------------------------
+    # HELPERS
+    #--------------------------------------------------------------------------
+
+
+
+  # Validates a viewing direction string against the IIIF V.2.0 spec.
+  #
+  # According to v2 of the IIIF standards, there are only four valid viewing directions:
+  # "left-to-right", "top-to-bottom”, "bottom-to-top" , and "right-to-left".  This
+  #  returns true if the provided direction is one of these, and falst for anything else.
+  #
+  # @param [String] direction A viewing direction string
+  #
+  # @return [boolean] Is the provided string a valid viewing direction?
+  #
+  def self.is_valid_viewing_direction(direction)
+    direction == "left-to-right" ||
+    direction == "top-to-bottom" ||
+    direction == "bottom-to-top" ||
+    direction == "right-to-left"
+  end
+
+end

data/spec/base_properties_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+shared_examples "base properties" do
+  it "has a description" do
+    test_string = "test description"
+    @object.description = test_string
+    expect(@object.description).to eq test_string
+  end
+  it "has an @id" do
+    expect(@object.id).not_to be_nil
+  end
+  it "has a valid @id" do
+    expect(@object.id).to include IiifS3::Config::DEFAULT_URL
+  end
+  it "encodes @ids when set" do
+    @object.id = "http://www.example.com/a space"
+    expect(@object.id).to include "%20"
+  end
+  it "reveals the type" do
+    expect(@object.type).to eq described_class::TYPE
+  end
+end

data/spec/data/invalid.csv

@@ -0,0 +1 @@
+I'm an invalid CSV file "

data/spec/data/no_header.csv

@@ -0,0 +1 @@
+spec/data/test.jpg,1,"Test Image #1"

data/spec/data/test.csv

@@ -0,0 +1,2 @@
+filename,identifier,name
+spec/data/test.jpg,1,"Test Image #1"

data/spec/iiif_s3/builder_spec.rb

@@ -0,0 +1,152 @@
+require 'spec_helper'
+require 'ostruct'
+require 'fileutils'
+
+describe IiifS3::Builder do
+  # before(:each) do
+  #   fake_aws_bucket = OpenStruct.new({
+  #     "exists?" => "true"
+  #   })
+  #   unless ENV["TEST_INTERNET_CONNECTIVITY"]
+  #     allow(Aws::S3::Bucket).to receive(:new) {nil}
+  #     allow(Aws::S3::Bucket).to receive(:exists?) {true}
+  #   end
+  # end
+
+  let (:iiif) { IiifS3::Builder.new() }
+  let (:test_object_0) {ImageRecord.new({"id" => 1, "page_number" => 1})}
+  let (:test_object_1) {ImageRecord.new({"id" => 2, "page_number" => 1})}
+  let (:test_object_2) {ImageRecord.new({"id" => 2, "page_number" => 2})}
+  let (:data) {[test_object_0, test_object_1,test_object_2]}
+
+  context "When initializing" do
+    it "generates manifests" do
+      expect(iiif.manifests).to eq(Array.new)
+    end
+    it "uses the default config" do
+      expect(iiif.config).to eq(IiifS3::Config.new)
+    end
+    it "will accept a configuration hash" do
+      opts = {tile_width: 99}
+      iiif2 = IiifS3::Builder.new(opts)
+      expect(iiif2.config.tile_width).to eq(99)
+    end
+  end
+
+  context "loading data" do
+    it "will accept an array of objects" do
+      iiif.load(data)
+      expect(iiif.data).to eq(data)
+    end 
+    it "will accept a single object" do 
+      iiif.load(test_object_1)
+      expect(iiif.data).to eq([test_object_1])
+    end
+
+    it "will error if the data is bad" do
+      expect{iiif.load({random: "hash"})}.to raise_error(IiifS3::Error::InvalidImageData)
+      expect{iiif.load([{random: "hash"}])}.to raise_error(IiifS3::Error::InvalidImageData)
+    end
+  end
+
+  context "when processing data" do
+    include_context("fake variants")
+    include_context("fake data")
+
+    before(:example) do
+      @iiif = IiifS3::Builder.new({base_url: 'http://0.0.0.0', verbose: true, thumbnail_size: 120})
+      @iiif.load(@fake_data)
+      allow(@iiif).to receive(:generate_tiles) {nil}
+      allow(@iiif).to receive(:generate_variants) {@fake_variants}
+
+    end
+    it "does not fail with no data" do
+      expect {iiif.process_data}.not_to raise_error
+    end
+
+    it "does not fail with real data" do
+      expect {@iiif.process_data}.not_to raise_error
+    end
+  
+    it " passes the Temporary Manifest Check" do
+      @iiif.process_data
+      expect(@iiif.manifests.count).to eq 1
+      expect(@iiif.manifests.first.to_json).to eq @fake_manifest
+    end
+  end
+
+
+  context "when dealing with already loaded data" do
+    include_context("fake data")
+    include_context("fake variants")
+
+    before(:example) do
+      @dir = Dir.mktmpdir
+      @iiif = IiifS3::Builder.new({output_dir: @dir, base_url: 'http://0.0.0.0', verbose: true, thumbnail_size: 120})
+      @iiif.load(@fake_data)
+      @info_json = "#{@dir}/images/1-1/info.json"
+      allow(@iiif).to receive(:generate_tiles) {nil}
+      allow(@iiif).to receive(:generate_variants) {@fake_variants}
+      @iiif.process_data
+    end
+
+    after(:example) do
+      FileUtils.remove_entry @dir
+    end
+
+    it "has the temporary file" do
+      expect(File.exist?(@info_json)).to eq true
+    end
+
+   it "does try to generate images if that file is missing" do
+      File.delete(@info_json)
+      @iiif.process_data
+      expect(@iiif).to have_received(:generate_tiles).twice
+      expect(@iiif).to have_received(:generate_variants).twice
+    end
+
+    it "does not try to generate images if that file is present" do
+      @iiif.process_data
+      expect(@iiif).to have_received(:generate_tiles).once
+      expect(@iiif).to have_received(:generate_variants).once
+    end
+
+    it "generates the correct manifest anyway" do
+      @iiif.process_data
+      expect(@iiif.manifests.count).to eq 1
+      expect(@iiif.manifests.first.to_json).to eq @fake_manifest
+    end
+
+  end
+
+  context "When load_csving CSV files" do
+    it "accepts a path" do
+      expect{iiif.load_csv('./spec/data/test.csv')}.not_to raise_error()
+    end
+    it "fails on blank CSV files" do
+      expect{iiif.load_csv('./spec/data/blank.csv')}.to raise_error(IiifS3::Error::BlankCSV)
+    end
+    it "fails on invalid CSV files" do
+      expect{iiif.load_csv('./spec/data/invalid.csv')}.to raise_error(IiifS3::Error::InvalidCSV)
+    end
+    it "fails on missing CSV files" do
+      expect{iiif.load_csv('./spec/data/i_dont_exist.csv')}.to raise_error(IiifS3::Error::InvalidCSV)
+    end
+  end
+
+  context "When loading a CSV file" do
+    it "saves the data into the @data param" do
+      expect(iiif.data).to be_nil
+      iiif.load_csv('./spec/data/test.csv')
+      expect(iiif.data).not_to be_nil
+    end
+    it "removes headers" do
+      iiif.load_csv('./spec/data/test.csv')
+      expect(iiif.data[0]['image_path']).to eq('spec/data/test.jpg')        
+    end
+    it "doesn't remove headers if not present" do
+      iiif.load_csv('./spec/data/no_header.csv')
+      expect(iiif.data[0]['image_path']).to eq('spec/data/test.jpg')        
+    end
+  end
+end

data/spec/iiif_s3/collection_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require "base_properties_spec"
+
+describe IiifS3::Collection do
+  let (:config) {IiifS3::Config.new()}
+  context "base" do
+      before(:each) do
+        @object = IiifS3::Collection.new("Test data", config)
+      end
+      it_behaves_like "base properties"
+  end
+
+  context "initialization" do
+    it "initializes without issues" do
+      collection = nil
+      expect{collection = IiifS3::Collection.new("Test data", config)}.not_to raise_error
+      expect(collection.id).to eq("http://0.0.0.0/collection/top.json")
+    end
+    it "initializes without issues when provided a name" do
+      collection = nil
+      expect{collection = IiifS3::Collection.new("Test data", config, "name")}.not_to raise_error
+      expect(collection.id).to eq("http://0.0.0.0/collection/name.json")
+    end
+    it "initializes without issues when provided a name with a space in it" do
+      collection = nil
+      expect{collection = IiifS3::Collection.new("Test data", config, "name and space")}.not_to raise_error
+      expect(collection.id).to eq("http://0.0.0.0/collection/name%20and%20space.json")
+    end
+    it "fails if there is no label" do
+      expect{collection = IiifS3::Collection.new(nil, config)}.to raise_error(IiifS3::Error::MissingCollectionName)
+    end
+    it "fails if there is a blank label" do
+      expect{collection = IiifS3::Collection.new("", config)}.to raise_error(IiifS3::Error::MissingCollectionName)
+    end
+    it "has the correct default name" do
+      collection = IiifS3::Collection.new("Test data", config)
+      expect(collection.id).to include "top.json"
+    end
+  end
+  context "data init" do
+    include_context("fake data")
+    let(:collection) {IiifS3::Collection.new("Test Data", config, "name")}
+    let(:manifest) {IiifS3::Manifest.new([@fake_data],config)}
+    it "has a label" do
+      expect(collection.label).to eq "Test Data"
+    end
+    it "has an id" do
+      expect(collection.id).to eq "http://0.0.0.0/collection/name.json"
+    end
+   
+    it "allows you to add a collection" do
+      newCollection = collection.clone
+      expect{collection.add_collection(newCollection)}.not_to raise_error
+    end
+
+    it "fails if you add something else to a collection" do
+      newCollection = {}
+      expect{collection.add_collection(newCollection)}.to raise_error(IiifS3::Error::NotACollection)
+    end
+
+
+    it "generates correct JSON" do
+      collection.add_manifest(manifest)
+      expect(collection.to_json).to eq @fake_collection
+    end
+
+  end
+end

data/spec/iiif_s3/config_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+
+describe IiifS3::Config do
+  context "comparing" do
+    it "shows equal things to be equal" do
+      expect(IiifS3::Config.new).to eq(IiifS3::Config.new)
+    end
+    it "shows different things to be different" do
+      opts = {tile_width: 99, upload_to_s3: false}
+      opts2 = {tile_width: 100, upload_to_s3: false}
+      expect(IiifS3::Config.new opts).not_to eq(IiifS3::Config.new opts2)      
+    end
+  end
+end

data/spec/iiif_s3/image_info_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'ostruct'
+
+include IiifS3
+
+describe IiifS3::ImageInfo do
+
+  let(:uri) {"http://www.example.com/test/1"}
+  include_context("fake variants")
+
+  context "intialization" do
+
+  
+    it "initializes without errors" do  
+      expect{ImageInfo.new(uri,@fake_variants)}.not_to raise_error
+    end
+    it "raises an error without a 'full' variant" do
+      @fake_variants.delete "full"
+      expect{ImageInfo.new(uri,@fake_variants)}.to raise_error(Error::InvalidImageData)
+    end
+    it "raises an error without a 'thumbnail' variant" do
+      @fake_variants.delete "thumbnail"
+      expect{ImageInfo.new(uri,@fake_variants)}.to raise_error(Error::InvalidImageData)
+    end
+  end
+
+
+  context "valid data" do
+    before(:example) do 
+      @info = ImageInfo.new(uri,@fake_variants)
+    end  
+
+    it "generates correct sizes" do
+      expect(@info.sizes).to eq([{"width" => 1000, "height" => 1200},{"width" => 100, "height" => 120}])
+    end
+
+    it "generates nil when no tile data appears" do
+      expect(@info.tiles).to be_nil
+    end
+
+    it "generates tile info when tile data appears" do
+      info = ImageInfo.new(uri,@fake_variants,500,[1,2,4])
+      expect(info.tiles).to eq([{"width" => 500, "scaleFactors" => [1,2,4]}])
+    end
+
+    it "has the correct other methods" do
+      expect(@info).to respond_to "context"
+      expect(@info).to respond_to "protocol"
+      expect(@info).to respond_to "profile"
+      expect(@info).to respond_to "service"
+    end
+
+    it "generates correct JSON" do
+      expect(@info.to_json).to eq(@fake_image_info)
+    end
+  end
+end