iiif_url 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0619253ce49f6b4de78e3743e69d2507ce5ae99d
+  data.tar.gz: c7c71e6ec3ddb6d6c349590e129ceb87f7e5f58e
+SHA512:
+  metadata.gz: 988c43d7edaa08efd7470329c58ebd2d2ecdedc2a9fa0f715d5b4cec2b2ab4cdadba01117e7361ae143004334bcc68af6a36ea56d6fd5e564a2b2c98c2f1cdc6
+  data.tar.gz: feec5e94df362c77e59a61f32a828c00ffd75be4b9b555a16b221894d4e78c6d7b43cdbebde73f63cddf5742a83d8bd1d96d2826ee258b5baa876d08ec4548d4

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 North Carolina State University
+
+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,257 @@
+# IIIF URL
+
+Create and parse IIIF Image API URLs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'iiif_url'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iiif_url
+
+## Usage
+
+Here's the simplest case of creating a IIIF URL with all options. By default only the path is given without the scheme, server, port, or IIIF prefix.
+
+```ruby
+iiif_base_url = "http://example.edu/prefix"
+options = {
+  identifier: 'abc',
+  region: 'full',
+  size: 'full',
+  rotation: 0,
+  quality: 'default',
+  format: 'jpg'
+}
+url = IiifUrl.from_options(options)
+# => "/abc/full/full/0/default.jpg"
+full_url = File.join(IIIF_BASE_URL, url)
+# => "http://example.edu/prefix/full/full/0/default.jpg"
+```
+
+If the constant `IIIF_URL_BASE_URL` is defined then it will form a full url automatically:
+
+```ruby
+IiifUrl.set_base_url("http://example.edu/prefix")
+options = {
+  identifier: 'abc',
+  region: 'full',
+  size: 'full',
+  rotation: 0,
+  quality: 'default',
+  format: 'jpg'
+}
+url = IiifUrl.from_options(options)
+# => "http://example.edu/prefix/abc/full/full/0/default.jpg"
+```
+
+You can also pass in the base URL in with the options, which will override any value set for the base URL.
+
+```ruby
+IiifUrl.set_base_url("http://example.edu/prefix")
+options = {
+  identifier: 'abc',
+  base_url: "http://example.org",
+  region: 'full',
+  size: 'full',
+  rotation: 0,
+  quality: 'default',
+  format: 'jpg'
+}
+url = IiifUrl.from_options(options)
+# => "http://example.org/abc/full/full/0/default.jpg"
+```
+
+If the base URL is set you can prevent it being used and just return the path portion by setting the `base_url` option key to `false`:
+
+```ruby
+IiifUrl.set_base_url("http://example.edu/prefix")
+options = {
+  identifier: 'abc',
+  base_url: false,
+  region: 'full',
+  size: 'full',
+  rotation: 0,
+  quality: 'default',
+  format: 'jpg'
+}
+url = IiifUrl.from_options(options)
+# => "/abc/full/full/0/default.jpg"
+```
+
+A more complicated region and size:
+
+```ruby
+options = {
+  identifier: 'abc',
+  region: {
+    x: 0,
+    y: 0,
+    w: 1000,
+    h: 1200
+  },
+  size: {w: 300},
+  rotation: 0,
+  quality: 'default',
+  format: 'jpg'
+}
+url = IiifUrl.from_options(options)
+# => "/abc/0,0,1000,1200/300,/0/default.jpg"
+```
+
+To use a percent region or percent size, you must prefix the keys like this:
+
+```ruby
+options = {
+  identifier: 'abc',
+  region: {
+    pctx: 10,
+    pcty: 10,
+    pctw: 80,
+    pcth: 80
+  },
+  size: {pct: 50}
+}
+url = IiifUrl.from_options(options)
+# => "/abc/pct:10,10,80,80/pct:50/0/default.jpg"
+```
+
+If no identifier is passed in, then only the IIIF URL path will be returned:
+
+```ruby
+options = {
+  size: {pct: 50}
+}
+url = IiifUrl.from_options(options)
+# => "/full/pct:50/0/default.jpg"
+```
+
+Even if a base_url is given if there is no identifier, then only the IIIF URL path will be returned:
+
+```ruby
+options = {
+  base_url: "http://example.org/prefix/",
+  size: {pct: 50}
+}
+url = IiifUrl.from_options(options)
+# => "/full/pct:50/0/default.jpg"
+```
+
+
+## Defaults
+
+You only need to specify values that are different from the defaults. The defaults are as specified:
+
+| parameter  | value     |
+|:-----------|:----------|
+| identifier | null      |
+| region     | "full"    |
+| size       | "full"    |
+| rotation   | "0"       |
+| quality    | "default" |
+| format     | "jpg"     |
+
+```ruby
+options = {
+  identifier: 'abc',
+  size: {w: 600}
+}
+url = IiifUrl.from_options(options)
+# => "/abc/full/600,/0/default.jpg"
+```
+
+And without an identifier:
+
+```ruby
+options = {
+  size: {w: 600}
+}
+url = IiifUrl.from_options(options)
+# => "/full/600,/0/default.jpg"
+```
+
+## Chainable
+
+There may be cases where you do not have all of the options you need so you want to pass around a IiifUrl to add more options.
+
+```ruby
+url = IiifUrl.new
+url.region({x:100, y:200, w: 300, h: 300})
+url.size({w: 150}).format('png')
+url.to_s
+# => "/100,200,300,300/150,/0/default.png"
+```
+
+You can also pass in some initial options and then add on others:
+
+```ruby
+url = IiifUrl.new({size: {w: 100}})
+url.identifier('abc')
+url.format('png')
+url.rotation(180)
+url.to_s
+# => "/abc/full/100,/180/default.png"
+```
+
+## Parser
+
+IIIF URLs are parsed by segments including: region, size, rotation, quality, and format. The region and size segments can also be parsed into a string or hash. Rotation is always parsed into a hash. Quality and format are always a string.
+
+Simple case for region and size parsed into strings:
+
+```ruby
+options = IiifUrl.parse("/full/full/0/default.png")
+# => {region: "full", size: "full", rotation: {degrees: 0, mirror: false}, quality: 'default', format: 'png'}
+```
+
+With an identifier:
+
+```ruby
+options = IiifUrl.parse("/abc/full/full/0/default.png")
+# => {identifier: "abc", region: "full", size: "full", rotation: {degrees: 0, mirror: false}, quality: 'default', format: 'png'}
+```
+
+Parameterized region and size:
+
+```ruby
+options = IiifUrl.parse("/0,100,200,300/75,/0/default.jpg")
+# => {identifier: nil, region: {x:0, y:100, w: 200, h: 300}, size: {w: 75, h: nil}, rotation: {degrees: 0, mirror: false}, quality: "default", format: "jpg" }
+```
+
+Parse a full URL:
+
+```ruby
+options = IiifUrl.parse("http://example.org/prefix/abc/0,100,200,300/75,/0/default.jpg")
+# => {identifier: abc, region: {x:0, y:100, w: 200, h: 300}, size: {w: 75, h: nil}, rotation: {degrees: 0, mirror: false}, quality: "default", format: "jpg" }
+```
+
+## Validation
+
+No validation is done for creating or parsing a URL. This allows for extensions to the IIIF Image API.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/NCSU-Libraries/iiif_url.
+
+## Authors
+
+Jason Ronallo
+
+## License
+
+The gem is copyright North Carolina State University and is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "iiif_url"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/iiif_url.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_url/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "iiif_url"
+  spec.version       = IiifUrl::VERSION
+  spec.authors       = ["Jason Ronallo"]
+  spec.email         = ["jronallo@gmail.com"]
+
+  spec.summary       = %q{Create and parse IIIF Image API URLs}
+  spec.description   = %q{Create IIIF Image API URLs from parameters; parse IIIF Image API URLs into parameters.}
+  spec.homepage      = "https://github.com/NCSU-Libraries/iiif_url"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "colorize"
+end

data/lib/iiif_url.rb

@@ -0,0 +1,147 @@
+require "iiif_url/version"
+
+class IiifUrl
+
+  @@base_url = ""
+
+  def initialize(options={})
+    @options = options
+  end
+
+  def identifier(identifier)
+    @options[:identifier] = identifier
+    self
+  end
+
+  def region(region)
+    @options[:region] = region
+    self
+  end
+
+  def size(size)
+    @options[:size] = size
+    self
+  end
+
+  def rotation(rotation)
+    @options[:rotation] = rotation
+    self
+  end
+
+  def quality(quality)
+    @options[:quality] = quality
+    self
+  end
+
+  def format(format)
+    @options[:format] = format
+    self
+  end
+
+  def to_s
+    IiifUrl.from_options(@options)
+  end
+
+  def self.set_base_url(base_url)
+    @@base_url = base_url
+  end
+
+  def self.from_options(options={})
+    base_url = options[:base_url]
+    if base_url == false
+      base_url = ''
+    elsif base_url.nil?
+      base_url = @@base_url
+    end
+
+    region = options[:region] || "full"
+    if region.is_a? Hash
+      if region[:x]
+        region = "#{region[:x]},#{region[:y]},#{region[:w]},#{region[:h]}"
+      elsif region[:pctx]
+        region = "pct:#{region[:pctx]},#{region[:pcty]},#{region[:pctw]},#{region[:pcth]}"
+      end
+    end
+
+    size = options[:size] || "full"
+    if size.is_a? Hash
+      if size[:w] || size[:h]
+        size = "#{size[:w]},#{size[:h]}"
+      elsif size[:pct]
+        size = "pct:#{size[:pct]}"
+      end
+    end
+
+    rotation = options[:rotation] || 0
+    if rotation.is_a? Hash
+      if rotation[:mirror]
+        rotation = "!#{rotation[:degrees]}"
+      else
+        rotation = "#{rotation[:degrees]}"
+      end
+    end
+
+    quality = options[:quality] || "default"
+    format = options[:format] || "jpg"
+
+    path = "/#{region}/#{size}/#{rotation}/#{quality}.#{format}"
+    if options[:identifier]
+      File.join(base_url, options[:identifier], path)
+    else
+      path
+    end
+  end
+
+  def self.parse(url)
+    url_parts = url.split('/')
+    quality_format = url_parts.pop
+    quality, format = quality_format.split('.')
+
+    rotation_string = url_parts.pop
+    rotation = if rotation_string.include?('!')
+      degrees = rotation_string.sub('!', '')
+      {degrees: degrees.to_i, mirror: true}
+    else
+      {degrees: rotation_string.to_i, mirror: false}
+    end
+
+    size_string = url_parts.pop
+    size = if size_string.include?(',')
+      w, h = size_string.split(',')
+      w = w.to_i if !w.nil?
+      h = h.to_i if !h.nil?
+      {w: w, h: h}
+    elsif size_string.include?('pct')
+      pct, size = size_string.split(':')
+      {pct: size.to_f}
+    else
+      size_string
+    end
+
+    region_string = url_parts.pop
+    region = if region_string.include?(',')
+      if region_string.include?('pct')
+        pctx, pcty, pctw, pcth = region_string.split(',')
+        pct, pctx = pctx.split(':')
+        {pctx: pctx.to_f, pcty: pcty.to_f, pctw: pctw.to_f, pcth: pcth.to_f}
+      else
+        x, y, w, h = region_string.split(',')
+        {x: x.to_i, y: y.to_i, w: w.to_i, h: h.to_i}
+      end
+    else
+      region_string
+    end
+
+    identifier = url_parts.pop
+    identifier = nil if identifier == ''
+
+    {
+      identifier: identifier,
+      region: region,
+      size: size,
+      rotation: rotation,
+      quality: quality,
+      format: format
+    }
+  end
+end

data/lib/iiif_url/version.rb

@@ -0,0 +1,3 @@
+class IiifUrl
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: iiif_url
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jason Ronallo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: Create IIIF Image API URLs from parameters; parse IIIF Image API URLs
+  into parameters.
+email:
+- jronallo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- iiif_url.gemspec
+- lib/iiif_url.rb
+- lib/iiif_url/version.rb
+homepage: https://github.com/NCSU-Libraries/iiif_url
+licenses:
+- MIT
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Create and parse IIIF Image API URLs
+test_files: []