wax_iiif 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25b432a185e5f5ee4cd830eb7bb65ed7306ae44bc48d392efeba1b501425470a
-  data.tar.gz: fbb6291fecd4e872ec20ac7471cf7078a7a4cd4772077d7f1a93368bf145133f
+  metadata.gz: 31844c9c4c8aa58c1e5e940fd0bc447c073e0b4e1e5bf8f7dc77970eeaac95b5
+  data.tar.gz: d17b64b8d0f9a6c69340128571128c74bb44c26fb119911aff496dd71a4abc5f
 SHA512:
-  metadata.gz: 133ae808b98aa7d4ac1de14f266243f53e849ad81b355718faf5b0bde9bbac04e598475e1f00366a8acc96d2c85f3f170a7d576ee9a1c3fbfe62864f0985d7e2
-  data.tar.gz: 2ff7691fde04e30fc5be5402aaa8b56cd64b0dcfecbe0cf3f0044b7a5de014821d48f3c39e5f213bd2935dddb0914eb16c5eba7e49d8c17b1c2058682418099c
+  metadata.gz: b8b751aaa0cc21122743f4a2a6f7d166cac8cc7bb36942c631cae2343d382973fe2400282dc1c9e884dc4b9b4902ef8b42fa50a214c69b315a0168c29390b334
+  data.tar.gz: 7ee23f85b57d3ee86abe9002220b73a5138a950dc94406499d2fa59bd7824c56cab91682cd6dc94d8aa311a185e28e774ea2c09e139269c9866324eb5ae0cc15

data/lib/iiif_s3/builder.rb

@@ -7,7 +7,7 @@ module IiifS3
     include Utilities::Helpers
 
     HEADER_VAL = 'filename'
-    
+
     #
     # @!attribute [r] data
     #   @return [Array<Hash>] The raw data computed for the given set of images
@@ -27,7 +27,7 @@ module IiifS3
     # @param [Hash] config an optional configuration object.
     # @see IiifS3::Config
     # @return [Void]
-    # 
+    #
     def initialize(config = {})
       @manifests = []
       @config = IiifS3::Config.new(config)
@@ -35,23 +35,23 @@ module IiifS3
 
 
     #
-    # Load data into the IIIF builder. 
-    # 
+    # 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 
+    # @param [Array<ImageRecord>, ImageRecord] data
     #   Either a single ImageRecord or an Array of ImageRecords.
-    # @raise [IiifS3::Error::InvalidImageData] if any of the data does 
+    # @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| 
+      @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
@@ -64,16 +64,16 @@ module IiifS3
     # @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)
@@ -91,11 +91,11 @@ module IiifS3
 
       # Generate the manifests
       resources.each do |key, val|
-        manifests.push generate_manifest(val, @config) 
+        manifests.push generate_manifest(val, @config)
       end
 
       generate_collection
-    end    
+    end
 
     def generate_collection(label="top")
       collection = Collection.new(label,@config)
@@ -119,14 +119,14 @@ module IiifS3
     #
     # @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  
+      end
 
       raise Error::BlankCSV if vals.length == 0
       raise Error::InvalidCSV if vals[0].length != 3
@@ -141,7 +141,7 @@ module IiifS3
           "label"    => data[2]
         }
       end
-    end 
+    end
 
     protected
 
@@ -162,7 +162,7 @@ module IiifS3
       return {"full" => full, "thumbnail" => thumbnail}
     end
 
-    def generate_tiles(data, config) 
+    def generate_tiles(data, config)
       width = data.variants["full"].width
       tile_width = config.tile_width
       height = data.variants["full"].height
@@ -186,7 +186,7 @@ module IiifS3
               tile[:xSize]  = (tile[:width]/(s*1.0)).ceil
             end
             if (tile[:y] + tile[:height] > height)
-              tile[:height] = height - tile[:y] 
+              tile[:height] = height - tile[:y]
               tile[:ySize]  = (tile[:height]/(s*1.0)).ceil
             end
             tiles.push(tile)
@@ -202,14 +202,14 @@ module IiifS3
       "#{generate_image_location(data.id,data.page_number)}/info.json"
     end
 
-    def generate_image_json(data, config) 
+    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 
+       file.puts info.to_json
       end
       if @config.upload_to_s3
         add_file_to_s3(filename)
@@ -225,19 +225,6 @@ module IiifS3
         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 = {
@@ -246,9 +233,9 @@ module IiifS3
       }
 
       config.variants.each do |key,image_size|
-        obj[key] = ImageVariant.new(data, config, image_size, image_size)
+        obj[key] = ImageVariant.new(data, config, image_size)
       end
       return obj
     end
   end
-end
+end

data/lib/iiif_s3/config.rb

@@ -1,7 +1,7 @@
 module IiifS3
-  
+
   # Config provides a data structure for holding the configuration settings
-  # for the IiifS3 class.  
+  # for the IiifS3 class.
   #
   # @author David Newbury <david.newbury@gmail.com>
   #
@@ -9,7 +9,7 @@ module IiifS3
 
     # @return [String] The default URL to append to all IDs.
     DEFAULT_URL = "http://0.0.0.0"
-    # @return [String] The name of the subdirectory where generated images live 
+    # @return [String] The name of the subdirectory where generated images live
     DEFAULT_IMAGE_DIRECTORY_NAME = "images"
     # @return [String] The default path for writing generated image files
     DEFAULT_OUTPUT_DIRECTORY = "./build"
@@ -18,7 +18,7 @@ module IiifS3
     # @return [Array<Number>] The default tile scaling factors
     DEFAULT_TILE_SCALE_FACTORS = [1,2,4,8]
     # @return [Number] The default thumbnail size in pixels
-    DEFAULT_THUMBNAIL_SIZE = 250    
+    DEFAULT_THUMBNAIL_SIZE = 250
 
     #
     # @!attribute [r] base_url
@@ -87,7 +87,7 @@ module IiifS3
 
     # Initialize a new configuration option.
     #
-    # @param [Hash] opts 
+    # @param [Hash] opts
     # @option opts [Boolean] :upload_to_s3 if true, images and metadata will be
     #   uploaded to Amazon S3.  Defaults to False.
     # @option opts [Number] :tile_width The width in pixels for generated tiles.
@@ -99,11 +99,11 @@ module IiifS3
     # @option opts [String] :output_dir The name of the directory for generated files.
     #   image data. Defaults to {DEFAULT_OUTPUT_DIRECTORY}
     # @option opts [String] :base_url The base URL for the generated URIs.  Defaults to
-    #   {DEFAULT_URL} if not auto-uploading to S3 and to the s3 bucket if upload_to_s3 is enabled. 
+    #   {DEFAULT_URL} if not auto-uploading to S3 and to the s3 bucket if upload_to_s3 is enabled.
     # @option opts [Number] :thumbnail_size the size in pixels
     #   for the largest side of the thumbnail images.  Defaults to {DEFAULT_THUMBNAIL_SIZE}.
-    # @option opts [Bool] :use_extensions (true) should files have exensions appended?  
-    # @option opts [Bool] :verbose (false) Should debug information be printed to the console?  
+    # @option opts [Bool] :use_extensions (true) should files have exensions appended?
+    # @option opts [Bool] :verbose (false) Should debug information be printed to the console?
     # @option opts [String] :prefix ("") a prefix (read: subdirectory) for the generated URIs.
     # @option opts [Hash{String: String}] :variants
     def initialize(opts = {})
@@ -120,7 +120,7 @@ module IiifS3
       @verbose        = opts.fetch(:verbose, false)       ## false
       @prefix         = opts[:prefix]                     || ""
       if @prefix.length > 0 && @prefix[0] != "/"
-        @prefix = "/#{@prefix}" 
+        @prefix = "/#{@prefix}"
       end
     end
 
@@ -130,7 +130,7 @@ module IiifS3
     # @param [IiifS3::Config] other_config The configuration file to compare
     #
     # @return [Bool] True if they are the same, false otherwise
-    # 
+    #
     def ==(other_config)
       valid = true
       self.instance_variables.each do |v|
@@ -139,4 +139,4 @@ module IiifS3
       valid
     end
   end
-end
+end

data/lib/iiif_s3/full_image.rb

@@ -9,12 +9,12 @@ module IiifS3
   class FullImage < ImageVariant
 
     protected
-    
+
     def filestring
       "/full/full/0"
     end
 
-    def resize(width, height); end
+    def resize(width); end
 
   end
-end
+end

data/lib/iiif_s3/image_variant.rb

@@ -9,7 +9,7 @@ module IiifS3
 
   #
   # Class ImageVariant represents a single image file within a manifest.
-  # 
+  #
   #
   # @author David Newbury <david.newbury@gmail.com>
   #
@@ -18,10 +18,10 @@ module IiifS3
     include MiniMagick
 
     #
-    # Initializing an ImageVariant will create the actual image file 
-    # on the file system.  
-    # 
-    # To initialize an image, you will need the 
+    # 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.
@@ -29,15 +29,15 @@ module IiifS3
     # @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)
+    #
+    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" 
+        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." 
+        raise IiifS3::Error::InvalidImageData, "Each image needs an path."
       end
 
       # open image
@@ -47,7 +47,8 @@ module IiifS3
         raise IiifS3::Error::InvalidImageData, "Cannot read this image file: #{data.image_path}. #{e}"
       end
 
-      resize(width, height)
+      width = size.nil? ? width : size
+      resize(width)
       @image.format "jpg"
 
       @id =   generate_image_id(data.id,data.page_number)
@@ -68,7 +69,7 @@ module IiifS3
 
     #
     # @!attribute [r] id
-    #   @return [String] The URI for the variant.  
+    #   @return [String] The URI for the variant.
     attr_reader :id
 
 
@@ -89,10 +90,10 @@ module IiifS3
     end
 
     #
-    # Get the MIME Content-Type of the image. 
+    # Get the MIME Content-Type of the image.
     #
     # @return [String] the MIME Content-Type (typically "image/jpeg")
-    # 
+    #
     def mime_type
       @image.mime_type
     end
@@ -103,7 +104,7 @@ module IiifS3
     # @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
@@ -114,8 +115,8 @@ module IiifS3
       "full"
     end
 
-    def resize(width, height)
-      @image.resize "#{width}x#{height}"
+    def resize(width)
+      @image.resize "#{width}"
     end
 
     def filestring
@@ -123,4 +124,4 @@ module IiifS3
     end
 
   end
-end
+end

data/lib/iiif_s3/thumbnail.rb

@@ -12,24 +12,23 @@ module IiifS3
   #
   class Thumbnail < ImageVariant
 
-    # Initialize a new thumbnail.  
+    # 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
+    #
+    def initialize(data, config, width=nil)
+      @width = width || config.thumbnail_size
       super(data,config)
     end
 
     protected
 
-    def resize(width, height)
-      @image.resize "#{@max_width}x#{@max_height}"
+    def resize(width)
+      @image.resize "#{@width}"
     end
-    
+
   end
-end
+end

data/spec/iiif_s3/image_variant_spec.rb

@@ -7,7 +7,7 @@ describe IiifS3::ImageVariant do
       "id" => 1,
       "page_number" => 1
     }) }
- 
+
   context "initialization errors" do
     it "raises if the image does not have an ID" do
       data.id =nil
@@ -33,23 +33,20 @@ describe IiifS3::ImageVariant do
         "page_number" => 1
       })
        config = IiifS3::Config.new
-       @img = IiifS3::ImageVariant.new(data, config, 100, 100)
+       @img = IiifS3::ImageVariant.new(data, config, 100)
     end
-    
+
     it "has a uri" do
-      expect(@img.uri).to eq("#{@img.generate_image_id(1,1)}/full/83,/0/default.jpg")
-    end     
+      expect(@img.uri).to eq("#{@img.generate_image_id(1,1)}/full/100,/0/default.jpg")
+    end
     it "has an id" do
       expect(@img.id).to eq("#{@img.generate_image_id(1,1)}")
-    end 
+    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 
+      expect(@img.width).to eq(100)
+    end
     it "has a mime type" do
-      expect(@img.mime_type).to eq("image/jpeg")   
+      expect(@img.mime_type).to eq("image/jpeg")
     end
   end
 
@@ -68,4 +65,4 @@ describe IiifS3::ImageVariant do
     end
 
   end
-end
+end

data/wax_iiif.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "wax_iiif"
-  spec.version       = "0.0.1"
+  spec.version       = "0.0.2"
   spec.authors       = ["Marii Nyrop", "David Newbury"]
   spec.email         = ["m.nyrop@columbia.edu"]
   spec.summary       = "Minimal iiif level 0 generator – i.e. David Newbury's iiif_s3 minus s3."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wax_iiif
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Marii Nyrop
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler