iiif-image-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a37336c486475446d723312acff027b317dba79
+  data.tar.gz: 255166f9899b76d6906bdcedb11debfa3edbc968
+SHA512:
+  metadata.gz: 86e7bf0d8bb3de17656616531ea9c379211a04dd75b01e9516ae78bef381f36abbab91368c932d6f6acca10a2a7a91074655303b351df33989c6fa042348c3b8
+  data.tar.gz: 2259209956d2ba02c041ed70dbf957d6fbe4486f626a4f4110aaba7ff6e74f862408406cc8433db1c2c569269379755e08b00955a6f74a620082941ffd72acd9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.4

data/Gemfile

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

data/README.md

@@ -0,0 +1,28 @@
+# IIIF
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'iiif'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iiif
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cbeer/iiif.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "iiif"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/iiif-image-api.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iiif/image/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'iiif-image-api'
+  spec.version       = IIIF::Image::VERSION
+  spec.authors       = ['Justin Coyne']
+  spec.email         = ['jcoyne@justincoyne.com']
+
+  spec.summary       = %(Ruby APIs for working with IIIF)
+  spec.description   = %(Ruby APIs for working with IIIF)
+  spec.homepage      = 'https://github.com/cbeer/iiif'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 4.0'
+
+  spec.add_development_dependency 'bundler', "~> 1.10"
+  spec.add_development_dependency 'rake', "~> 10.0"
+  spec.add_development_dependency 'rspec'
+end

data/lib/iiif.rb

@@ -0,0 +1,3 @@
+require 'iiif/image'
+module IIIF
+end

data/lib/iiif/image.rb

@@ -0,0 +1,21 @@
+require 'active_support/all'
+require 'iiif/image/version'
+
+module IIIF
+  module Image
+    extend ActiveSupport::Autoload
+    autoload :Region
+    autoload :Size
+
+    autoload_under 'models' do
+      autoload :URI
+      autoload :Transformation
+      autoload :ImageRequestUri
+      autoload :Dimension
+    end
+
+    autoload_under 'services' do
+      autoload :OptionDecoder
+    end
+  end
+end

data/lib/iiif/image/models/dimension.rb

@@ -0,0 +1,30 @@
+module IIIF::Image
+  # Represents the size of a rectangle
+  class Dimension
+    def initialize(height:, width:)
+      @height = height
+      @width = width
+    end
+
+    attr_reader :height, :width
+
+    # @param scale [Float] scale factor between 0 and 1
+    # @return [Dimension]
+    def scale(scale)
+      Dimension.new(height: height * scale, width: width * scale)
+    end
+
+    # Return true if both dimensions of other are greater
+    def enclosed_by?(other)
+      width <= other.width && height <= other.height
+    end
+
+    def ==(other)
+      width == other.width && height == other.height
+    end
+
+    def aspect
+      Rational(width, height)
+    end
+  end
+end

data/lib/iiif/image/models/image_request_uri.rb

@@ -0,0 +1,25 @@
+module IIIF::Image
+  # Class to represent IIIF Image Request URI
+  class ImageRequestUri < IIIF::Image::URI
+    # @param base_uri [String]
+    # @param identifier [String]
+    # @param transformation [Transformation]
+    def initialize(base_uri:, identifier:, transformation:)
+      @base_uri = base_uri
+      @identifier = identifier
+      @transformation = transformation
+    end
+
+    def to_s
+      "#{base_uri}#{identifier}/#{region}/#{size}/#{rotation}/#{quality}.#{format}"
+    end
+
+    delegate :valid?, to: :transformation
+
+    # I think this is unnecessary in later versions https://github.com/bbatsov/rubocop/pull/3883
+    # rubocop:disable Lint/UselessAccessModifier
+    private
+
+    delegate :region, :size, :rotation, :quality, :format, to: :transformation
+  end
+end

data/lib/iiif/image/models/transformation.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module IIIF::Image
+  # A data object that describes the IIIF request
+  class Transformation
+    def initialize(region:, size:, rotation: '0', quality: 'default', format: 'jpg')
+      @region = region
+      @size = size
+      @rotation = rotation
+      @quality = quality
+      @format = format
+    end
+
+    attr_reader :region, :size, :rotation, :quality, :format
+
+    def to_params
+      { region: region,
+        size: size,
+        rotation: rotation,
+        quality: quality,
+        format: format }
+    end
+
+    def valid?
+      %w(color gray bitonal default).include? quality
+    end
+
+    def ==(other)
+      other.class == self.class &&
+        other.region == region &&
+        other.size == size &&
+        other.rotation == rotation &&
+        other.quality == quality &&
+        other.format == format
+    end
+  end
+end

data/lib/iiif/image/models/uri.rb

@@ -0,0 +1,31 @@
+module IIIF::Image
+  # Represents a URI to a IIIF image endpoint
+  class URI
+    # @param base_uri [String]
+    # @param identifier [String]
+    # @param transformation [Transformation]
+    def initialize(base_uri:, identifier:, transformation: nil)
+      @base_uri = base_uri
+      @identifier = identifier
+      @transformation = transformation
+    end
+
+    attr_reader :base_uri, :transformation, :identifier
+
+    def to_s
+      return to_image_request_uri.to_s if transformation
+      base_uri + identifier + '/info.json'
+    end
+
+    def valid?
+      return true unless transformation
+      to_image_request_uri.valid?
+    end
+
+    private
+
+    def to_image_request_uri
+      ImageRequestUri.new(base_uri: base_uri, identifier: identifier, transformation: transformation)
+    end
+  end
+end

data/lib/iiif/image/region.rb

@@ -0,0 +1,9 @@
+module IIIF::Image
+  module Region
+    extend ActiveSupport::Autoload
+    autoload :Absolute
+    autoload :Full
+    autoload :Percent
+    autoload :Square
+  end
+end

data/lib/iiif/image/region/absolute.rb

@@ -0,0 +1,27 @@
+module IIIF::Image
+  module Region
+    # Represents an absolute specified region
+    class Absolute
+      # @param [Integer] x
+      # @param [Integer] y
+      # @param [Integer] width
+      # @param [Integer] height
+      def initialize(x, y, width, height)
+        @offset_x = x
+        @offset_y = y
+        @width = width
+        @height = height
+      end
+
+      attr_reader :offset_x, :offset_y, :width, :height
+
+      def dimensions
+        Dimension.new(width: width, height: height)
+      end
+
+      def to_s
+        "pct:#{offset_x},#{offset_y},#{width},#{height}"
+      end
+    end
+  end
+end

data/lib/iiif/image/region/full.rb

@@ -0,0 +1,11 @@
+module IIIF::Image
+  module Region
+    # Represents the image or region requested at its full size.
+    # This is a nil crop operation.
+    class Full
+      def to_s
+        'full'
+      end
+    end
+  end
+end

data/lib/iiif/image/region/percent.rb

@@ -0,0 +1,23 @@
+module IIIF::Image
+  module Region
+    # represents request cooridnates specified as percentage
+    class Percent
+      # @param x [Float]
+      # @param y [Float]
+      # @param width [Float]
+      # @param height [Float]
+      def initialize(x, y, width, height)
+        @x_pct = x
+        @y_pct = y
+        @width_pct = width
+        @height_pct = height
+      end
+
+      attr_reader :x_pct, :y_pct, :width_pct, :height_pct
+
+      def to_s
+        "pct:#{x_pct},#{y_pct},#{width_pct},#{height_pct}"
+      end
+    end
+  end
+end

data/lib/iiif/image/region/square.rb

@@ -0,0 +1,10 @@
+module IIIF::Image
+  module Region
+    # Represents requested square cooridnates
+    class Square
+      def to_s
+        'square'
+      end
+    end
+  end
+end

data/lib/iiif/image/services/option_decoder.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module IIIF::Image
+  # Decodes the URL parameters into a Transformation object
+  class OptionDecoder
+    OUTPUT_FORMATS = %w(jpg png).freeze
+
+    # a helper method for instantiating the OptionDecoder
+    # @param [ActiveSupport::HashWithIndifferentAccess] options
+    def self.decode(options)
+      new(options).decode
+    end
+
+    # @param [ActiveSupport::HashWithIndifferentAccess] options
+    def initialize(options)
+      @options = options
+    end
+
+    ##
+    # @return [Transformation]
+    def decode
+      IIIF::Image::Transformation.new(region: decode_region(@options.delete(:region)),
+                               size: decode_size(@options.delete(:size)),
+                               quality: decode_quality(@options[:quality]),
+                               rotation: decode_rotation(@options[:rotation]),
+                               format: decode_format(@options[:format]))
+    end
+
+    def decode_quality(quality)
+      return quality if %w(bitonal grey default color).include?(quality)
+      return 'default' if quality.nil?
+      raise InvalidAttributeError, "Unsupported quality: #{quality}"
+    end
+
+    def decode_rotation(rotation)
+      return 0 if rotation.nil? || rotation == '0'
+      begin
+        Float(rotation)
+      rescue ArgumentError
+        raise InvalidAttributeError, "Unsupported rotation: #{rotation}"
+      end
+    end
+
+    def decode_format(format)
+      format ||= 'jpg'
+      return format if OUTPUT_FORMATS.include?(format)
+      raise InvalidAttributeError, "Unsupported format: #{format}"
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def decode_region(region)
+      if region.nil? || region == 'full'
+        Region::Full.new
+      elsif md = /^pct:(\d+(?:.\d+)?),(\d+(?:.\d+)?),(\d+(?:.\d+)?),(\d+(?:.\d+)?)$/.match(region)
+        Region::Percentage
+          .new(md[1].to_f, md[2].to_f, md[3].to_f, md[4].to_f)
+      elsif md = /^(\d+),(\d+),(\d+),(\d+)$/.match(region)
+        Region::Absolute.new(md[1].to_i, md[2].to_i, md[3].to_i, md[4].to_i)
+      elsif region == 'square'
+        Region::Square.new
+      else
+        raise InvalidAttributeError, "Invalid region: #{region}"
+      end
+    end
+
+    def decode_size(size)
+      if size.nil? || size == 'max'
+        Size::Max.new
+      elsif size == 'full'
+        Size::Full.new # Deprecated
+      elsif md = /^,(\d+)$/.match(size)
+        Size::Height.new(md[1].to_i)
+      elsif md = /^(\d+),$/.match(size)
+        Size::Width.new(md[1].to_i)
+      elsif md = /^pct:(\d+(?:.\d+)?)$/.match(size)
+        Size::Percent.new(md[1].to_f)
+      elsif md = /^(\d+),(\d+)$/.match(size)
+        Size::Absolute.new(md[1].to_i, md[2].to_i)
+      elsif md = /^!(\d+),(\d+)$/.match(size)
+        Size::BestFit.new(md[1].to_i, md[2].to_i)
+      else
+        raise InvalidAttributeError, "Invalid size: #{size}"
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+end

data/lib/iiif/image/size.rb

@@ -0,0 +1,12 @@
+module IIIF::Image
+  module Size
+    extend ActiveSupport::Autoload
+    autoload :Absolute
+    autoload :BestFit
+    autoload :Full
+    autoload :Height
+    autoload :Max
+    autoload :Percent
+    autoload :Width
+  end
+end

data/lib/iiif/image/size/absolute.rb

@@ -0,0 +1,21 @@
+module IIIF::Image
+  module Size
+    # The width and height of the returned image are exactly w and h.
+    # The aspect ratio of the returned image may be different than the extracted
+    # region, resulting in a distorted image.
+    class Absolute
+      # @param [Integer] width
+      # @param [Integer] height
+      def initialize(width, height)
+        @width = width
+        @height = height
+      end
+
+      attr_reader :height, :width
+
+      def to_s
+        "#{width},#{height}"
+      end
+    end
+  end
+end

data/lib/iiif/image/size/best_fit.rb

@@ -0,0 +1,20 @@
+module IIIF::Image
+  module Size
+    # The image content is scaled for the best fit such that the resulting width and
+    # height are less than or equal to the requested width and height.
+    class BestFit
+      # @param [Integer] width
+      # @param [Integer] height
+      def initialize(width, height)
+        @width = width
+        @height = height
+      end
+
+      attr_reader :height, :width
+
+      def to_s
+        "!#{width},#{height}"
+      end
+    end
+  end
+end

data/lib/iiif/image/size/full.rb

@@ -0,0 +1,10 @@
+module IIIF::Image
+  module Size
+    # represents requested full size. Full is deprecated in favor of Max in the IIIF spec
+    class Full
+      def to_s
+        "full"
+      end
+    end
+  end
+end

data/lib/iiif/image/size/height.rb

@@ -0,0 +1,24 @@
+module IIIF::Image
+  module Size
+    # The image or region should be scaled so that its height is exactly equal
+    # to the provided parameter, and the width will be a calculated value that
+    # maintains the aspect ratio of the extracted region
+    class Height
+      # @param [Integer] height
+      def initialize(height)
+        @height = height
+      end
+
+      attr_reader :height
+
+      # @param ratio [Rational] the aspect ratio
+      def width_for_aspect_ratio(ratio)
+        (ratio * height).round
+      end
+
+      def to_s
+        ",#{height}"
+      end
+    end
+  end
+end

data/lib/iiif/image/size/max.rb

@@ -0,0 +1,10 @@
+module IIIF::Image
+  module Size
+    # represents requested max size
+    class Max
+      def to_s
+        "max"
+      end
+    end
+  end
+end

data/lib/iiif/image/size/percent.rb

@@ -0,0 +1,24 @@
+module IIIF::Image
+  module Size
+    # The width and height of the returned image is scaled to n% of the width and height
+    # of the extracted region. The aspect ratio of the returned image is the same as that
+    # of the extracted region.
+    class Percent
+      # @param percentage [Float]
+      def initialize(percentage)
+        @percentage = percentage
+      end
+
+      attr_reader :percentage
+
+      # @return [Float] scale factor between 0 and 1
+      def scale
+        percentage / 100
+      end
+
+      def to_s
+        "pct:#{percentage}"
+      end
+    end
+  end
+end

data/lib/iiif/image/size/width.rb

@@ -0,0 +1,24 @@
+module IIIF::Image
+  module Size
+    # The image or region should be scaled so that its width is exactly equal
+    # to the provided parameter, and the height will be a calculated value that
+    # maintains the aspect ratio of the extracted region
+    class Width
+      # @param [Integer] width
+      def initialize(width)
+        @width = width
+      end
+
+      attr_reader :width
+
+      # @param ratio [Rational] the aspect ratio
+      def height_for_aspect_ratio(ratio)
+        (width / ratio).round
+      end
+
+      def to_s
+        "#{width},"
+      end
+    end
+  end
+end

data/lib/iiif/image/version.rb

@@ -0,0 +1,5 @@
+module IIIF
+  module Image
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: iiif-image-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Coyne
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby APIs for working with IIIF
+email:
+- jcoyne@justincoyne.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- iiif-image-api.gemspec
+- lib/iiif.rb
+- lib/iiif/image.rb
+- lib/iiif/image/models/dimension.rb
+- lib/iiif/image/models/image_request_uri.rb
+- lib/iiif/image/models/transformation.rb
+- lib/iiif/image/models/uri.rb
+- lib/iiif/image/region.rb
+- lib/iiif/image/region/absolute.rb
+- lib/iiif/image/region/full.rb
+- lib/iiif/image/region/percent.rb
+- lib/iiif/image/region/square.rb
+- lib/iiif/image/services/option_decoder.rb
+- lib/iiif/image/size.rb
+- lib/iiif/image/size/absolute.rb
+- lib/iiif/image/size/best_fit.rb
+- lib/iiif/image/size/full.rb
+- lib/iiif/image/size/height.rb
+- lib/iiif/image/size/max.rb
+- lib/iiif/image/size/percent.rb
+- lib/iiif/image/size/width.rb
+- lib/iiif/image/version.rb
+homepage: https://github.com/cbeer/iiif
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Ruby APIs for working with IIIF
+test_files: []