wax_iiif 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25b432a185e5f5ee4cd830eb7bb65ed7306ae44bc48d392efeba1b501425470a
+  data.tar.gz: fbb6291fecd4e872ec20ac7471cf7078a7a4cd4772077d7f1a93368bf145133f
+SHA512:
+  metadata.gz: 133ae808b98aa7d4ac1de14f266243f53e849ad81b355718faf5b0bde9bbac04e598475e1f00366a8acc96d2c85f3f170a7d576ee9a1c3fbfe62864f0985d7e2
+  data.tar.gz: 2ff7691fde04e30fc5be5402aaa8b56cd64b0dcfecbe0cf3f0044b7a5de014821d48f3c39e5f213bd2935dddb0914eb16c5eba7e49d8c17b1c2058682418099c

data/.gitignore

@@ -0,0 +1,29 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.env
+
+build/*
+data/*
+
+!/*/.gitkeep

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+addons:
+  apt:
+    packages:
+      - ghostscript
+script:
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wax_iiif.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,10 @@
+clearing :on
+
+
+# Run the test suite
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.md

@@ -0,0 +1,30 @@
+Copyright (c) 2018 Marii Nyröp.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+_This project incorporates code covered by the following terms:_
+
+Copyright (c) 2015 Carnegie Museum of Pittsburgh
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,8 @@
+# wax_iiif
+[![Build Status](https://travis-ci.org/mnyrop/wax_iiif.svg?branch=master)](https://travis-ci.org/mnyrop/wax_iiif) [![Dependency Status](https://gemnasium.com/badges/github.com/mnyrop/wax_iiif.svg)](https://gemnasium.com/github.com/mnyrop/wax_iiif)  [![Maintainability](https://api.codeclimate.com/v1/badges/3eb2fcf5ae47e7b6d686/maintainability)](https://codeclimate.com/github/mnyrop/wax_iiif/maintainability)
+
+This fork is TRULY just a copy of the [iiif_s3 gem](https://github.com/cmoa/iiif_s3) with all the s3 dependencies and functionality removed!
+
+It enables the static creation of IIIF derivatives (level 0) for static exhibtion sites with [wax](https://minicomp.github.io/wax/).
+
+For credit and documentation, head over to [iiif_s3](https://github.com/cmoa/iiif_s3).

data/Rakefile

@@ -0,0 +1,24 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']   # optional
+  t.stats_options = ['--list-undoc']         # optional
+end
+
+desc "Clear the screen"
+task :cls do
+  puts "Clearing the Screen \033c"
+end
+
+task :full do
+  ENV["TEST_INTERNET_CONNECTIVITY"] = "yes"
+  ENV["SKIP_EXPENSIVE_TESTS"] = nil
+end
+
+task :default => [:cls, :spec, :yard]
+
+task :full_test => [:full, :default]

data/lib/iiif_s3/base_properties.rb

@@ -0,0 +1,95 @@
+require_relative "utilities"
+module IiifS3
+
+  # Module BaseProperties provides the set of properties that are shared across
+  # all IIIF types.  It is not a comprehensive list (yet), but it does handle
+  # most of the shared types.  It does not include any types that have class-based
+  # restrictions.
+  # 
+  # It also performs some basic sanity checking on (some of) the fields, and 
+  # provides utility classes that are applicable across the fields.
+  # 
+  # @todo Add within, service, seeAlso, viewingHint fields
+  #
+  # @author David Newbury <david.newbury@gmail.com>
+  #
+  module BaseProperties
+    include Utilities::Helpers
+
+
+    # @!attribute [rw] label
+    #   @return [String] The human-readable label for this record
+    attr_accessor :label
+    # @!attribute [r] id
+    #   @return [String] The URI for this record
+    attr_reader :id
+     # @!attribute [rw] description
+    #   @return [String] The long-form description of this record
+    attr_accessor :description
+    # @!attribute [rw] metadata
+    #   @return [Hash] A set of key/value pairs describing additional metadata for the object.
+    attr_accessor :metadata    
+    # @!attribute [rw] attribution
+    #   @return [String] a human-readable label, typically used for attribution or credit.
+    attr_accessor :attribution
+    # @!attribute [rw] logo
+    #   @return [String] The URI to an image for the logo of the institution associated with this record.
+    attr_accessor :logo
+    # @!attribute [rw] license
+    #   @return [String] The URI to a resource that describes the license or rights statement associated.
+    attr_accessor :license
+    # @!attribute [rw] related
+    #   @return [String, Array<String>] The URI to related resources.  Can be both a string or an array
+    attr_accessor :related
+
+    # The type of resource provided by this record.
+    #
+    # @return [String] The type of record
+    def type
+      self.class::TYPE
+    end
+
+    # Set the unique id for this record.  
+    # This will automatically append the defined prefixes and suffixes.
+    #
+    # @param [String] _id The unique portion of this ID
+    # @return [string] The URI for this record
+    def id=(_id)
+      @id = generate_id(_id)
+    end
+
+    # Return the base data structure for this record as a Hash
+    # This will be in IIIF format, and should convert to JSON as JSON-LD nicely.
+    #
+    # @return [Hash] The base properties of this record
+    def base_properties
+      obj = { 
+        "@context" => PRESENTATION_CONTEXT,
+        "@id" => self.id,
+        "@type" => self.type,
+        "label" => self.label
+      }
+      obj["attribution"] = self.attribution if self.attribution
+      obj["logo"] = self.logo if self.logo
+      obj["description"] = self.description if self.description
+      obj["attribution"] = self.attribution if self.attribution
+      obj["license"] = self.license if self.license
+      obj["related"] = self.related if self.related
+      obj["metadata"] = self.metadata if self.metadata
+
+      obj
+    end
+
+    # Save the JSON representation of this record to disk and to S3 (if enabled).
+    #
+    # @return [Void]
+    def save
+      save_to_disk(JSON.parse(self.to_json))
+    end
+
+
+
+    protected
+
+  end
+end

data/lib/iiif_s3/builder.rb

@@ -0,0 +1,254 @@
+require_relative "utilities"
+require 'pathname'
+
+module IiifS3
+  class Builder
+
+    include Utilities::Helpers
+
+    HEADER_VAL = 'filename'
+    
+    #
+    # @!attribute [r] data
+    #   @return [Array<Hash>] The raw data computed for the given set of images
+    attr_reader :data
+
+    #
+    # @!attribute [r] manifests
+    #   @return [Array<Hash>] The manifest hashes for this configuration
+    attr_accessor :manifests
+
+    # @!attribute [r] config
+    #   @return [IiifS3::Config] The configuration object
+    attr_reader :config
+
+    # Initialize the builder.
+    #
+    # @param [Hash] config an optional configuration object.
+    # @see IiifS3::Config
+    # @return [Void]
+    # 
+    def initialize(config = {})
+      @manifests = []
+      @config = IiifS3::Config.new(config)
+    end
+
+
+    #
+    # Load data into the IIIF builder. 
+    # 
+    # This will load the data, perform some basic verifications on it, and sort
+    # it into proper order.
+    #
+    # @param [Array<ImageRecord>, ImageRecord] data 
+    #   Either a single ImageRecord or an Array of ImageRecords.
+    # @raise [IiifS3::Error::InvalidImageData] if any of the data does 
+    #   not pass the validation checks
+    # 
+    # @return [Void]
+    # 
+    def load(data)
+      @data = [data].flatten # handle hashes and arrays of hashes
+
+      # validate
+      @data.each  do |image_record| 
+        raise IiifS3::Error::InvalidImageData, "Image record #{image_record.inspect} is not an ImageRecord" unless image_record.is_a? ImageRecord
+        raise IiifS3::Error::InvalidImageData, "Image record #{image_record.inspect} does not have an ID and/or a page number" if image_record.id.nil? || image_record.page_number.nil?
+      end
+    end
+
+
+    #
+    # Take the loaded data and generate all the files.
+    #
+    # @param [Boolean] force_image_generation Generate images even if they already exist
+    #
+    # @return [Void]
+    # 
+    def process_data(force_image_generation=false)
+      return nil if @data.nil? # do nothing without data.
+      @manifests = []
+
+      resources = {}
+      @data.each do |image_record|
+        
+        # image generation
+        # 
+        # It attempts to load the info files and skip generation — not currently working.
+        info_file = image_info_file_name(image_record)
+        if (File.exist?(info_file) && !force_image_generation)
+          puts "skipping #{info_file}" if @config.verbose?
+          image_record.variants = load_variants(info_file)
+        else
+          image_record.variants = generate_variants(image_record, @config)
+          generate_tiles(image_record, @config)
+          generate_image_json(image_record, @config)
+        end
+        # Save the image info for the manifest
+        resources[image_record.id] ||= []
+        resources[image_record.id].push image_record
+      end
+
+      # Generate the manifests
+      resources.each do |key, val|
+        manifests.push generate_manifest(val, @config) 
+      end
+
+      generate_collection
+    end    
+
+    def generate_collection(label="top")
+      collection = Collection.new(label,@config)
+      manifests.each{|m| collection.add_manifest(m)}
+      collection.save
+    end
+
+    # Creates the required directories for exporting to the file system.
+    #
+    # @return [Void]
+    def create_build_directories
+    root_dir =  generate_build_location("")
+      Dir.mkdir root_dir unless Dir.exists?(root_dir)
+      img_dir = generate_image_location("","").split("/")[0...-1].join("/")
+      Dir.mkdir img_dir unless Dir.exists?(img_dir)
+    end
+
+    # Load data into the IIIF server from a CSV
+    #
+    # @param [String] csv_path Path to the CSV file containing the image data
+    #
+    # @return [Void]
+    # @todo Fix this to use the correct data format!
+    # 
+    def load_csv(csv_path)
+      raise Error::InvalidCSV unless File.exist? csv_path
+      begin
+        vals = CSV.read(csv_path)
+      rescue CSV::MalformedCSVError
+        raise Error::InvalidCSV
+      end  
+
+      raise Error::BlankCSV if vals.length == 0
+      raise Error::InvalidCSV if vals[0].length != 3
+
+      # remove optional header
+      vals.shift if vals[0][0] == HEADER_VAL
+
+      @data = vals.collect do |data|
+        {
+          "image_path" => data[0],
+          "id"       => data[1],
+          "label"    => data[2]
+        }
+      end
+    end 
+
+    protected
+
+    #----------------------------------------------------------------
+    def load_variants(path)
+
+      data = JSON.parse File.read(path)
+      id = data["@id"]
+      w = data["width"]
+      h = data["height"]
+      thumb_size = data["sizes"].find{|a| a["width"] == config.thumbnail_size || a["height"] == config.thumbnail_size}
+      thumb_w = thumb_size["width"]
+      thumb_h = thumb_size["height"]
+      full_url = "#{id}/full/full/0/default.jpg"
+      thumb_url = "#{id}/full/#{thumb_w},/0/default.jpg"
+      full = FakeImageVariant.new( id,w, h,full_url, "image/jpeg")
+      thumbnail = FakeImageVariant.new( id, thumb_w, thumb_h, thumb_url, "image/jpeg")
+      return {"full" => full, "thumbnail" => thumbnail}
+    end
+
+    def generate_tiles(data, config) 
+      width = data.variants["full"].width
+      tile_width = config.tile_width
+      height = data.variants["full"].height
+      tiles = []
+      config.tile_scale_factors.each do |s|
+        (0..(height*1.0/(tile_width*s)).floor).each do |tileY|
+          (0..(width*1.0/(tile_width*s)).floor).each do |tileX|
+            tile = {
+              scale_factor: s,
+              xpos: tileX,
+              ypos: tileY,
+              x: tileX * tile_width * s,
+              y: tileY * tile_width * s,
+              width: tile_width * s,
+              height: tile_width * s,
+              xSize: tile_width,
+              ySize: tile_width
+            }
+            if (tile[:x] + tile[:width]  > width)
+              tile[:width]  = width  - tile[:x]
+              tile[:xSize]  = (tile[:width]/(s*1.0)).ceil
+            end
+            if (tile[:y] + tile[:height] > height)
+              tile[:height] = height - tile[:y] 
+              tile[:ySize]  = (tile[:height]/(s*1.0)).ceil
+            end
+            tiles.push(tile)
+          end
+        end
+      end
+      tiles.each do |tile|
+        ImageTile.new(data, @config, tile)
+      end
+    end
+
+    def image_info_file_name(data)
+      "#{generate_image_location(data.id,data.page_number)}/info.json"
+    end
+
+    def generate_image_json(data, config) 
+      filename = image_info_file_name(data)
+      info = ImageInfo.new(data.variants["full"].id, data.variants ,config.tile_width, config.tile_scale_factors)
+
+      puts "writing #{filename}" if config.verbose?
+      Pathname.new(Pathname.new(filename).dirname).mkpath
+      File.open(filename, "w") do |file|
+       file.puts info.to_json 
+      end
+      if @config.upload_to_s3
+        add_file_to_s3(filename)
+        add_default_redirect(filename)
+      end
+      return info
+    end
+
+
+    def generate_manifest(data, config)
+        m = Manifest.new(data, config)
+        m.save_all_files_to_disk
+        return m
+    end
+
+    def build_a_manifest
+
+      manifest_uri = "@config.s3.bucket/#{generate_id(record)}/manifest.json"
+      # response = Typhoeus.get(manifest_uri, followlocation: true)
+      # if response.code == 200
+      #   puts "Skipping #{file}—Manifest already exists." if verbose
+      #   data = JSON.parse(response.body)
+      #   obj = IiifS3::FakeManifest.new(data["@id"], data["@type"], data["label"])
+      #   @iiif.manifests.push(obj)
+      #   next
+      # end 
+    end
+
+
+    def generate_variants(data, config)
+      obj = {
+        "full" => FullImage.new(data, config),
+        "thumbnail" => Thumbnail.new(data, config)
+      }
+
+      config.variants.each do |key,image_size|
+        obj[key] = ImageVariant.new(data, config, image_size, image_size)
+      end
+      return obj
+    end
+  end
+end