iiif_url 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0619253ce49f6b4de78e3743e69d2507ce5ae99d
-  data.tar.gz: c7c71e6ec3ddb6d6c349590e129ceb87f7e5f58e
+  metadata.gz: d53ebf5b4faff0adc10e4c6c4eab1b536fefcb7f
+  data.tar.gz: eaf05909652d3e33da4402ac6c52a78c66ca1d93
 SHA512:
-  metadata.gz: 988c43d7edaa08efd7470329c58ebd2d2ecdedc2a9fa0f715d5b4cec2b2ab4cdadba01117e7361ae143004334bcc68af6a36ea56d6fd5e564a2b2c98c2f1cdc6
-  data.tar.gz: feec5e94df362c77e59a61f32a828c00ffd75be4b9b555a16b221894d4e78c6d7b43cdbebde73f63cddf5742a83d8bd1d96d2826ee258b5baa876d08ec4548d4
+  metadata.gz: 2a98fd31dad51dc0fff1f29ad1f5ac6432182b8c4f833da2bf47d2bfe8bc03a6ac03c18468da3bc589235997404bda7b97b514f88223abe08ca951d01afe4463
+  data.tar.gz: bd9c51c255f47aefded64f4aa4768a5dc03a74757aeb6ad31c2ef5ae4578b8c9e2d8026c36b61455273fac168188c1edcde23890a0fac292114cfc8c4c58a4bf

data/README.md

@@ -20,11 +20,11 @@ Or install it yourself as:
 
 ## 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.
+Here's the simplest case of creating a IIIF URL with all params. By default only the path is given without the scheme, server, port, or IIIF prefix.
 
 ```ruby
 iiif_base_url = "http://example.edu/prefix"
-options = {
+params = {
   identifier: 'abc',
   region: 'full',
   size: 'full',
@@ -32,17 +32,17 @@ options = {
   quality: 'default',
   format: 'jpg'
 }
-url = IiifUrl.from_options(options)
+url = IiifUrl.from_params(params)
 # => "/abc/full/full/0/default.jpg"
-full_url = File.join(IIIF_BASE_URL, url)
+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:
+If the base URL is set then it will form a full URL automatically:
 
 ```ruby
 IiifUrl.set_base_url("http://example.edu/prefix")
-options = {
+params = {
   identifier: 'abc',
   region: 'full',
   size: 'full',
@@ -50,15 +50,15 @@ options = {
   quality: 'default',
   format: 'jpg'
 }
-url = IiifUrl.from_options(options)
+url = IiifUrl.from_params(params)
 # => "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.
+You can also pass in the base URL in with the params, which will override any value set for the base URL.
 
 ```ruby
 IiifUrl.set_base_url("http://example.edu/prefix")
-options = {
+params = {
   identifier: 'abc',
   base_url: "http://example.org",
   region: 'full',
@@ -67,7 +67,7 @@ options = {
   quality: 'default',
   format: 'jpg'
 }
-url = IiifUrl.from_options(options)
+url = IiifUrl.from_params(params)
 # => "http://example.org/abc/full/full/0/default.jpg"
 ```
 
@@ -75,7 +75,7 @@ If the base URL is set you can prevent it being used and just return the path po
 
 ```ruby
 IiifUrl.set_base_url("http://example.edu/prefix")
-options = {
+params = {
   identifier: 'abc',
   base_url: false,
   region: 'full',
@@ -84,14 +84,14 @@ options = {
   quality: 'default',
   format: 'jpg'
 }
-url = IiifUrl.from_options(options)
+url = IiifUrl.from_params(params)
 # => "/abc/full/full/0/default.jpg"
 ```
 
 A more complicated region and size:
 
 ```ruby
-options = {
+params = {
   identifier: 'abc',
   region: {
     x: 0,
@@ -104,14 +104,14 @@ options = {
   quality: 'default',
   format: 'jpg'
 }
-url = IiifUrl.from_options(options)
+url = IiifUrl.from_params(params)
 # => "/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 = {
+params = {
   identifier: 'abc',
   region: {
     pctx: 10,
@@ -121,28 +121,28 @@ options = {
   },
   size: {pct: 50}
 }
-url = IiifUrl.from_options(options)
+url = IiifUrl.from_params(params)
 # => "/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 = {
+params = {
   size: {pct: 50}
 }
-url = IiifUrl.from_options(options)
+url = IiifUrl.from_params(params)
 # => "/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 = {
+params = {
   base_url: "http://example.org/prefix/",
   size: {pct: 50}
 }
-url = IiifUrl.from_options(options)
+url = IiifUrl.from_params(params)
 # => "/full/pct:50/0/default.jpg"
 ```
 
@@ -161,27 +161,27 @@ You only need to specify values that are different from the defaults. The defaul
 | format     | "jpg"     |
 
 ```ruby
-options = {
+params = {
   identifier: 'abc',
   size: {w: 600}
 }
-url = IiifUrl.from_options(options)
+url = IiifUrl.from_params(params)
 # => "/abc/full/600,/0/default.jpg"
 ```
 
 And without an identifier:
 
 ```ruby
-options = {
+params = {
   size: {w: 600}
 }
-url = IiifUrl.from_options(options)
+url = IiifUrl.from_params(params)
 # => "/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.
+There may be cases where you do not have all of the params you need so you want to pass around a IiifUrl to add more params.
 
 ```ruby
 url = IiifUrl.new
@@ -191,7 +191,7 @@ url.to_s
 # => "/100,200,300,300/150,/0/default.png"
 ```
 
-You can also pass in some initial options and then add on others:
+You can also pass in some initial params and then add on others:
 
 ```ruby
 url = IiifUrl.new({size: {w: 100}})
@@ -209,28 +209,28 @@ IIIF URLs are parsed by segments including: region, size, rotation, quality, and
 Simple case for region and size parsed into strings:
 
 ```ruby
-options = IiifUrl.parse("/full/full/0/default.png")
+params = 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")
+params = 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")
+params = 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")
+params = 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" }
 ```
 

data/lib/iiif_url/version.rb

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

data/lib/iiif_url.rb

@@ -4,57 +4,57 @@ class IiifUrl
 
   @@base_url = ""
 
-  def initialize(options={})
-    @options = options
+  def initialize(params={})
+    @params = params
   end
 
   def identifier(identifier)
-    @options[:identifier] = identifier
+    @params[:identifier] = identifier
     self
   end
 
   def region(region)
-    @options[:region] = region
+    @params[:region] = region
     self
   end
 
   def size(size)
-    @options[:size] = size
+    @params[:size] = size
     self
   end
 
   def rotation(rotation)
-    @options[:rotation] = rotation
+    @params[:rotation] = rotation
     self
   end
 
   def quality(quality)
-    @options[:quality] = quality
+    @params[:quality] = quality
     self
   end
 
   def format(format)
-    @options[:format] = format
+    @params[:format] = format
     self
   end
 
   def to_s
-    IiifUrl.from_options(@options)
+    IiifUrl.from_params(@params)
   end
 
   def self.set_base_url(base_url)
     @@base_url = base_url
   end
 
-  def self.from_options(options={})
-    base_url = options[:base_url]
+  def self.from_params(params={})
+    base_url = params[:base_url]
     if base_url == false
       base_url = ''
     elsif base_url.nil?
       base_url = @@base_url
     end
 
-    region = options[:region] || "full"
+    region = params[:region] || "full"
     if region.is_a? Hash
       if region[:x]
         region = "#{region[:x]},#{region[:y]},#{region[:w]},#{region[:h]}"
@@ -63,7 +63,7 @@ class IiifUrl
       end
     end
 
-    size = options[:size] || "full"
+    size = params[:size] || "full"
     if size.is_a? Hash
       if size[:w] || size[:h]
         size = "#{size[:w]},#{size[:h]}"
@@ -72,7 +72,7 @@ class IiifUrl
       end
     end
 
-    rotation = options[:rotation] || 0
+    rotation = params[:rotation] || 0
     if rotation.is_a? Hash
       if rotation[:mirror]
         rotation = "!#{rotation[:degrees]}"
@@ -81,12 +81,12 @@ class IiifUrl
       end
     end
 
-    quality = options[:quality] || "default"
-    format = options[:format] || "jpg"
+    quality = params[:quality] || "default"
+    format = params[:format] || "jpg"
 
     path = "/#{region}/#{size}/#{rotation}/#{quality}.#{format}"
-    if options[:identifier]
-      File.join(base_url, options[:identifier], path)
+    if params[:identifier]
+      File.join(base_url, params[:identifier], path)
     else
       path
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iiif_url
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jason Ronallo