wax_iiif 0.0.1

data/spec/iiif_s3/image_record_spec.rb

@@ -0,0 +1,96 @@
+ require 'spec_helper'
+ require "base_properties_spec"
+
+
+describe IiifS3::ImageRecord do
+  let(:opts) {{
+      id: 1
+    }}
+    let(:image_record) {IiifS3::ImageRecord.new(opts)}
+
+  it "initializes without an error" do
+    expect{IiifS3::ImageRecord.new}.not_to raise_error    
+  end
+  it "initializes without an error when provided a hash" do
+    opts = {id: 1}
+    expect{IiifS3::ImageRecord.new(opts)}.not_to raise_error    
+  end
+
+  context "#viewing_direction" do
+    it "has a sensible default" do
+      expect(image_record.viewing_direction).to eq IiifS3::DEFAULT_VIEWING_DIRECTION
+    end
+
+    it "rejects invalid viewing directions on init" do 
+      opts = {viewing_direction: "wonky"}
+      expect{IiifS3::ImageRecord.new(opts)}.to raise_error(IiifS3::Error::InvalidViewingDirection)
+    end
+
+    it "rejects setting invalid viewing directions" do 
+      expect{image_record.viewing_direction = "wonky"}.to raise_error(IiifS3::Error::InvalidViewingDirection)
+    end
+  end
+
+  it "initializes with provided hash values" do
+    expect(image_record.id).to eq opts[:id]
+  end 
+  it "ignores unknown data" do
+    opts["junk_data"] = "bozo"
+    expect{IiifS3::ImageRecord.new(opts)}.not_to raise_error    
+  end 
+  context "#is_primary" do
+    it "defaults to false" do
+      image_record.page_number = 2
+      expect(image_record.is_primary).to equal(false)
+    end
+    it "defaults to true for first pages" do
+      image_record.page_number = 1
+      expect(image_record.is_primary).to equal(true)
+    end
+    it "has an alias" do
+      image_record.page_number = 1
+      expect(image_record.is_primary?).to equal(true)
+    end
+    it "forces is_primary to boolean" do
+      image_record.is_primary = "banana"
+      expect(image_record.is_primary).to equal(true)
+    end
+    it "uses page_number for intellegent defaults" do
+      image_record.page_number = 1
+      expect(image_record.is_primary).to equal(true)
+    end
+    it "allows page_number default to be overridded" do
+      image_record.page_number = 1
+      image_record.is_primary = false
+      expect(image_record.is_primary).to equal(false)
+    end
+  end
+  context "#image_path" do
+    it "raises on a blan path" do
+      expect{image_record.path = nil}.to raise_error(IiifS3::Error::InvalidImageData)
+    end
+    it "raises an error for a bad file name" do
+      expect{image_record.path = "imaginary_file.jpg"}.to raise_error(IiifS3::Error::InvalidImageData)
+    end
+  end
+  context "#section" do
+    it "uses the default for the name" do
+      expect(image_record.section).to eq DEFAULT_CANVAS_LABEL
+    end
+    it "uses the default for the label" do
+      expect(image_record.section_label).to eq DEFAULT_CANVAS_LABEL
+    end
+  end
+  context "#is_document" do
+    it "defaults to false" do
+      expect(image_record.is_document).to equal(false)
+    end
+    it "has_an_alias" do
+      expect(image_record.is_document?).to equal(false)
+    end
+    it "forces is_document to boolean" do
+      image_record.is_document = "banana"
+      expect(image_record.is_document).to equal(true)
+    end
+  end
+end

data/spec/iiif_s3/image_variant_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe IiifS3::ImageVariant do
+  let(:config) {IiifS3::Config.new}
+  let(:data) { IiifS3::ImageRecord.new({
+      "path" => "./spec/data/test.jpg",
+      "id" => 1,
+      "page_number" => 1
+    }) }
+ 
+  context "initialization errors" do
+    it "raises if the image does not have an ID" do
+      data.id =nil
+      expect{IiifS3::ImageVariant.new(data, config)}.to raise_error(IiifS3::Error::InvalidImageData)
+    end
+    it "raises if the image has a blank ID" do
+      data.id = ""
+      expect{IiifS3::ImageVariant.new(data, config)}.to raise_error(IiifS3::Error::InvalidImageData)
+    end
+
+    it "raises if the image is not a valid image file" do
+      data.path = "./spec/data/test.csv"
+      expect{IiifS3::ImageVariant.new(data, config)}.to raise_error(IiifS3::Error::InvalidImageData)
+    end
+
+  end
+
+  context "basic data" do
+    before(:all) do
+      data = IiifS3::ImageRecord.new({
+        "path" => "./spec/data/test.jpg",
+        "id" => 1,
+        "page_number" => 1
+      })
+       config = IiifS3::Config.new
+       @img = IiifS3::ImageVariant.new(data, config, 100, 100)
+    end
+    
+    it "has a uri" do
+      expect(@img.uri).to eq("#{@img.generate_image_id(1,1)}/full/83,/0/default.jpg")
+    end     
+    it "has an id" do
+      expect(@img.id).to eq("#{@img.generate_image_id(1,1)}")
+    end 
+    it "has a width" do
+      expect(@img.width).to eq(83)
+    end    
+    it "has a height" do
+      expect(@img.height).to eq(100)
+    end 
+    it "has a mime type" do
+      expect(@img.mime_type).to eq("image/jpeg")   
+    end
+  end
+
+  context "Full Image" do
+    before(:all) do
+      data = IiifS3::ImageRecord.new({
+        "path" => "./spec/data/test.jpg",
+        "id" => 1,
+        "page_number" => 1
+      })
+       config = IiifS3::Config.new
+       @img = IiifS3::FullImage.new(data, config)
+    end
+    it "has the default filestring" do
+      expect(@img.uri).to include "full/full"
+    end
+
+  end
+end

data/spec/iiif_s3/manifest_spec.rb

@@ -0,0 +1,97 @@
+ require 'spec_helper'
+ require "base_properties_spec"
+
+
+describe IiifS3::Manifest do
+  include_context("fake data")
+
+  context "base" do
+      before(:each) do
+        @object = m
+      end
+      it_behaves_like "base properties"
+  end
+
+  let (:config) {IiifS3::Config.new()}
+  let (:m) {IiifS3::Manifest.new([@fake_data],config)}
+  let (:output) {JSON.parse(m.to_json)}
+
+  it "initializes without an error" do
+    expect(m).to be_a(IiifS3::Manifest)    
+  end
+
+
+  it "exports JSON-LD as a valid JSON string" do
+    expect(m.to_json).to be_a(String)
+    expect{JSON.parse(m.to_json)}.not_to raise_error
+  end
+
+  it "has a @context" do
+    expect(output["@context"]).to eq(IiifS3::PRESENTATION_CONTEXT)
+  end
+  it "has a @type" do
+    expect(output["@type"]).to eq(IiifS3::Manifest::TYPE)
+  end
+  it "has an @id" do
+    expect(output["@id"]).to eq("#{IiifS3::Config::DEFAULT_URL}/1/manifest.json")
+  end 
+  
+  context "error checking" do
+    it "throws an error if not provided ImageRecords" do
+      expect{IiifS3::Manifest.new(["not an image record"],config)}.to raise_error(IiifS3::Error::InvalidImageData)
+    end
+    it "throws an error unless there's a primary image" do
+      data = @fake_data.clone
+      data.is_primary = false
+      expect{IiifS3::Manifest.new([data],config)}.to raise_error(IiifS3::Error::InvalidImageData)
+    end
+    it "throws an error if there are two primary images" do
+      data1 = IiifS3::ImageRecord.new({is_primary: true})
+      data2 = IiifS3::ImageRecord.new({is_primary: true})
+
+      expect{IiifS3::Manifest.new([data1, data2],config)}.to raise_error(IiifS3::Error::MultiplePrimaryImages)
+    end
+  end
+
+  context "config variables" do
+    let (:config) {IiifS3::Config.new({:use_extensions => false})}
+    it "the @id has an extension if configured thusly" do
+      expect(output["@id"]).to eq("#{IiifS3::Config::DEFAULT_URL}/1/manifest")
+    end
+  end
+
+  context "base_url config variable" do
+    let (:config) {IiifS3::Config.new({base_url: "http://www.example.com"})}
+    it "uses non-test uris" do
+      expect(output["@id"]).to eq("http://www.example.com/1/manifest.json")
+    end
+  end
+  
+  context "spec requirements" do
+    it "has a label" do
+      expect(output["label"].length).to be > 0
+    end
+    it "does not have a format" do
+      expect(output["format"]).to be_nil
+    end
+    it "does not have a height" do
+      expect(output["height"]).to be_nil
+    end
+    it "does not have a width" do
+      expect(output["width"]).to be_nil
+    end
+    it "does not have a startCanvas" do
+      expect(output["startCanvas"]).to be_nil
+    end
+    it "accepts valid viewing directions" do 
+      dir = "right-to-left"
+      new_data = @fake_data
+      new_data.viewing_direction = dir
+      m = IiifS3::Manifest.new([new_data],config)
+      o = JSON.parse(m.to_json)
+      expect(o["viewingDirection"]).to eq(dir)
+
+    end
+  end
+
+end

data/spec/iiif_s3/utilities/pdf_splitter_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+
+describe IiifS3::Utilities::PdfSplitter do
+  context "comparing" do
+    it "generates the proper number of files" do
+      skip("skipping expensive tests") if ENV["SKIP_EXPENSIVE_TESTS"]
+      Dir.mktmpdir do |dir|
+        results = IiifS3::Utilities::PdfSplitter.split("./spec/data/test.pdf", output_dir: dir)
+        expect(results.count).to eq(3)
+        results.each do |file|
+          File.delete(file)
+        end
+      end
+    end
+  end
+end

data/spec/shared_contexts.rb

@@ -0,0 +1,115 @@
+RSpec.shared_context "fake variants" do
+  before(:example) do
+    @fake_variants = {
+      "full" => OpenStruct.new(:id => "http://www.example.com/images/1", :width => 1000, :height => 1200),
+      "thumbnail" => OpenStruct.new(:id => "http://www.example.com/images/1", :width => 100, :height => 120)
+    }
+    @fake_image_info = '{
+  "@context": "http://iiif.io/api/image/2/context.json",
+  "@id": "http://www.example.com/test/1",
+  "protocol": "http://iiif.io/api/image",
+  "width": 1000,
+  "height": 1200,
+  "sizes": [
+    {
+      "width": 1000,
+      "height": 1200
+    },
+    {
+      "width": 100,
+      "height": 120
+    }
+  ],
+  "profile": [
+    "http://iiif.io/api/image/2/level0.json",
+    {
+      "supports": [
+        "cors",
+        "sizeByWhListed",
+        "baseUriRedirect"
+      ]
+    }
+  ]
+}'
+  end
+end
+
+RSpec.shared_context "fake data" do
+  include_context("fake variants")
+  before(:example) do
+    
+    @fake_collection = '{
+  "@context": "http://iiif.io/api/presentation/2/context.json",
+  "@id": "http://0.0.0.0/collection/name.json",
+  "@type": "sc:Collection",
+  "label": "Test Data",
+  "manifests": [
+    {
+      "@id": "http://0.0.0.0/1/manifest.json",
+      "@type": "sc:Manifest",
+      "label": "test label"
+    }
+  ]
+}'
+
+    @fake_data = ImageRecord.new({
+      "id" => 1,
+      "page_number" => "1",
+      "image_path" => "./spec/data/test.jpg",
+      "is_primary" => true,
+      "variants" => @fake_variants,
+      "label" => "test label",
+      "attribution" => "All rights reserved",
+      "logo" => "http://www.example.com/logo.jpg"
+    })
+    @fake_manifest = '{
+  "@context": "http://iiif.io/api/presentation/2/context.json",
+  "@id": "http://0.0.0.0/1/manifest.json",
+  "@type": "sc:Manifest",
+  "label": "test label",
+  "attribution": "All rights reserved",
+  "logo": "http://www.example.com/logo.jpg",
+  "thumbnail": "http://www.example.com/images/1/full/100,/0/default.jpg",
+  "viewingDirection": "left-to-right",
+  "viewingHint": "individuals",
+  "sequences": [
+    {
+      "@id": "http://0.0.0.0/1/sequence/default.json",
+      "@type": "sc:Sequence",
+      "canvases": [
+        {
+          "@type": "sc:Canvas",
+          "@id": "http://0.0.0.0/1/canvas/front.json",
+          "label": "front",
+          "width": 2000,
+          "height": 2400,
+          "thumbnail": "http://www.example.com/images/1/full/100,/0/default.jpg",
+          "images": [
+            {
+              "@type": "oa:Annotation",
+              "@id": "http://0.0.0.0/1/annotation/front.json",
+              "motivation": "sc:painting",
+              "resource": {
+                "@id": "http://www.example.com/images/1/full/full/0/default.jpg",
+                "@type": "dcterms:Image",
+                "format": "image/jpeg",
+                "service": {
+                  "@context": "http://iiif.io/api/image/2/context.json",
+                  "@id": "http://www.example.com/images/1",
+                  "profile": "http://iiif.io/api/image/2/level0.json"
+                },
+                "width": 1000,
+                "height": 1200
+              },
+              "on": "http://0.0.0.0/1/canvas/front.json"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}'
+
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'dotenv'
+Dotenv.load
+
+require 'simplecov'
+SimpleCov.start
+
+require "shared_contexts"
+require 'wax_iiif'
+
+ENV["TEST_INTERNET_CONNECTIVITY"] ||= nil
+ENV["SKIP_EXPENSIVE_TESTS"] ||= nil

data/test.rb

@@ -0,0 +1,77 @@
+require 'dotenv'
+Dotenv.load
+
+require_relative 'lib/wax_iiif'
+
+# Set up configuration variables
+opts = {}
+opts[:image_directory_name] = "img"
+opts[:variants] = { "reference" => 600, "access" => 1200}
+opts[:image_types] = [".jpg", ".tif", ".jpeg", ".tiff"]
+opts[:document_file_types] = [".pdf"]
+
+# Setup Temporary stores
+@data = []
+@cleanup_list = []
+@dir = "./data"
+
+
+def add_image(file, is_doc = false)
+  name = File.basename(file, File.extname(file))
+  name_parts = name.split("_")
+  is_paged = name_parts.length == 8
+  page_num = is_paged ? name_parts[7].to_i : 1
+  name_parts.pop if is_paged
+  id = name_parts.join("_")
+
+  obj = {
+        "path" => "#{file}",
+        "id"       => id,
+        "label"    => name_parts.join("."),
+        "is_master" => page_num == 1,
+        "page_number" => page_num,
+        "is_document" => false,
+        "description" => "This is a test file generated as part of the development on the ruby IiifS3 Gem. <b> This should be bold.</b>"
+    }
+
+  if is_paged
+    obj["section"] = "p#{page_num}"
+    obj["section_label"] = "Page #{page_num}"
+  end
+
+  if is_doc
+    obj["is_document"] = true
+  end
+  @data.push IiifS3::ImageRecord.new(obj)
+end
+
+def add_to_cleanup_list(img)
+  @cleanup_list.push(img)
+end
+
+def cleanup
+  @cleanup_list.each do |file|
+    File.delete(file)
+  end
+end
+
+
+iiif = IiifS3::Builder.new(opts)
+iiif.create_build_directories
+
+Dir.foreach(@dir) do |file|
+  if opts[:image_file_types].include? File.extname(file)
+    add_image("#{@dir}/#{file}")
+  elsif opts[:document_file_types].include? File.extname(file)
+    path = "#{@dir}/#{file}"
+    images = IiifS3::Utilities::PdfSplitter.split(path)
+    images.each  do |img|
+      add_image(img, true)
+      add_to_cleanup_list(img)
+    end
+  end
+end
+
+iiif.load(@data)
+iiif.process_data
+cleanup