djatoka 0.0.2

data/test/test_common.rb

@@ -0,0 +1,64 @@
+require 'helper'
+
+class TestDjatokaCommon < Test::Unit::TestCase
+
+context 'A Djatoka Resolver' do
+    with_a_resolver do
+      setup do
+        @region = Djatoka::Region.new(@resolver, @identifier)
+      end
+      should 'create a query for a 75x75 version of the image' do
+        assert_equal '0,874,105,105', @region.smallbox.query.region
+        assert_equal '75', @region.smallbox.query.scale
+      end
+
+      should 'return a String for a smallbox URL' do
+        assert @region.smallbox_url.is_a? String
+        assert @region.smallbox_url.include? 'http://african.lanl.gov'
+        assert @region.smallbox_url.include? 'svc.region=0%2C874%2C105%2C105'
+      end
+
+      should 'return a uri for a small square version of the image' do
+        assert_equal '0,874,105,105', @region.smallbox.uri.query_values['svc.region']
+      end
+
+      should 'create a query for a square version of the image' do
+        assert_equal '0,874,3372,3372', @region.square.query.region
+        assert_equal nil, @region.square.query.scale
+      end
+      should 'return a uri for a square version of the image' do
+        assert_equal '0,874,3372,3372', @region.square_uri.query_values['svc.region']
+        assert_equal nil, @region.square_uri.query_values['svc.scale']
+      end
+      should 'return a url for a square version of the image' do
+        assert @region.square_url.is_a? String
+        assert @region.square_url.include? 'http://african.lanl.gov'
+        assert @region.square_url.include? 'svc.region=0%2C874%2C3372%2C3372'
+      end
+      should 'create a query for a square version of the image at a good level' do
+        @region.scale('555')
+        assert_equal '0,874,843,843', @region.square.query.region
+        assert_equal '555', @region.square.query.scale
+        assert_equal '4', @region.square.query.level
+      end
+
+      should 'pick the best level' do
+        metadata = Djatoka::Metadata.new(@resolver, @identifier).perform
+        @region.scale('200')
+        best_level = @region.pick_best_level(metadata)
+        assert_equal 2, best_level
+      end
+
+      context 'an image which is higher than it is wider' do
+        setup do
+          @region = Djatoka::Region.new(@resolver, 'info:lanl-repo/ds/b820f537-26a1-4af8-b86a-e7a4cac6187a')
+        end
+        should 'crop appropriately into a square' do
+          assert_equal '513,0,4093,4093', @region.square.query.region
+        end
+      end
+    end
+
+  end
+end
+

data/test/test_djatoka.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class TestDjatoka < Test::Unit::TestCase
+  should 'allow Djatoka.use_curb to be set' do
+    Djatoka.use_curb=true
+    assert Djatoka.use_curb?
+  end
+
+  with_a_resolver do
+    should 'be able to set Djatoka.resolver to a Djatoka::Resolver' do
+      Djatoka.resolver = @resolver
+      assert Djatoka.resolver.is_a? Djatoka::Resolver
+    end
+
+    should 'be able to set Djatoka.resolver to a URL and get a Djatoka::Resolver' do
+      Djatoka.resolver = 'http://african.lanl.gov/adore-djatoka/resolver'
+      assert Djatoka.resolver.is_a? Djatoka::Resolver
+      assert_equal 'http://african.lanl.gov/adore-djatoka/resolver', Djatoka.resolver.url
+    end
+
+    should_eventually 'not be able to set a Djatoka.resolver to a bad string' do
+      Djatoka.resolver = 'asdf'
+      assert Djatoka.resolver.nil?
+    end
+  end
+
+end
+

data/test/test_metadata.rb

@@ -0,0 +1,84 @@
+require 'helper'
+
+class TestDjatokaMetadata < Test::Unit::TestCase
+  with_a_resolver do
+    context 'a metadata object' do
+      setup do
+        @metadata_obj = @resolver.metadata(@identifier)
+        @metadata = @metadata_obj.perform
+      end
+
+      should 'create a metadata object' do
+        assert @metadata.is_a? Djatoka::Metadata
+      end
+
+      should "create a metadata URL for an identifier" do
+        assert @metadata.url.include? 'http://african.lanl.gov/adore-djatoka/resolver?'
+        assert @metadata.url.include? 'url_ver=Z39.88-2004'
+        assert @metadata.url.include? '&svc_id=info%3Alanl-repo%2Fsvc%2FgetMetadata'
+        assert @metadata.url.include? '&rft_id=info%3Alanl-repo%2Fds%2F5aa182c2-c092-4596-af6e-e95d2e263de3'
+      end
+
+      should 'create a metadata uri for an identifier' do
+        uri = @metadata.uri
+        assert_equal 'african.lanl.gov', uri.host
+      end
+
+      should "return imagefile metadata for an identifier" do
+        assert_equal '/lanl/data/loc/cc5fc4f7-e50a-455f-b3ce-a6a8b54824e6/WEJLNXSBWO7LPLC7Z6DITFX7A45XR3GS.jp2',
+          @metadata.imagefile
+      end
+
+      should 'return an identifier for a good request' do
+        assert_equal @identifier,
+          @metadata.identifier
+      end
+
+      should 'return a height for a good request' do
+        assert_equal '3372', @metadata.height
+      end
+
+      should 'return a width for a good request' do
+        assert_equal '5120', @metadata.width
+      end
+
+      should 'return an OK status for a good request' do
+        metadata = @metadata.status
+      end
+
+      should 'return a nil for a bad request' do
+        metadata = @resolver.metadata('asdf')
+        assert_equal nil, metadata.status
+      end
+    end #context metadata response
+
+    context 'using net::http' do
+      should 'return a height for a good request' do
+        Djatoka.use_curb=false
+        assert_equal '3372', Djatoka::Metadata.new(@resolver, @identifier).perform.height
+        Djatoka.use_curb=true
+      end
+    end
+
+    context 'determining all the levels for a particular metadata response' do
+      setup do
+        @metadata_obj = @resolver.metadata(@identifier)
+        @metadata = @metadata_obj.perform
+        @levels = @metadata.all_levels
+      end
+      should 'return height and width for all levels' do
+        levels = { "0"=>{"height"=>52, "width"=>80},
+                   "1"=>{"height"=>105, "width"=>160},
+                   "2"=>{"height"=>210, "width"=>320},
+                   "3"=>{"height"=>421, "width"=>640},
+                   "4"=>{"height"=>843, "width"=>1280},
+                   "5"=>{"height"=>1686, "width"=>2560},
+                   "6"=>{"height"=>3372, "width"=>5120},}
+        assert_equal levels, @levels
+      end
+    end # levels
+
+  end #with_a_resolver
+
+end
+

data/test/test_region.rb

@@ -0,0 +1,151 @@
+require 'helper'
+
+class TestDjatokaMetadata < Test::Unit::TestCase
+  with_a_resolver do
+    context 'creates image URLs for a region' do
+      setup do
+        @region = Djatoka::Region.new(@resolver, @identifier)
+      end
+
+      should 'create good region parameters' do
+        good_params = {'rft_id'=>"info:lanl-repo/ds/5aa182c2-c092-4596-af6e-e95d2e263de3",
+                        "svc_val_fmt"=>"info:ofi/fmt:kev:mtx:jpeg2000",
+                        "svc_id"=>"info:lanl-repo/svc/getRegion",
+                        'url_ver'=>"Z39.88-2004"}
+        assert_equal good_params, @region.region_params
+      end
+
+      context 'create a new region if given a string as a resolver' do
+        should 'create a resolver object' do
+          region = Djatoka::Region.new('http://african.lanl.gov/adore-djatoka/resolver', @identifier)
+          assert region.resolver.is_a? Djatoka::Resolver
+          assert_equal 'http://african.lanl.gov/adore-djatoka/resolver', region.resolver.to_s
+          assert_equal 'african.lanl.gov', region.resolver.host
+        end
+      end
+
+      context 'create a default region uri' do
+        setup do
+          @region_uri = @region.uri
+          @query_values = @region.uri.query_values
+        end
+        should 'create a default region uri' do
+          assert_equal @identifier, @query_values['rft_id']
+          assert_equal nil, @query_values['svc.scale']
+        end
+        should 'output a region url' do
+          assert @region.url.is_a? String
+          assert @region.url.include? 'http://african.lanl.gov'
+        end
+      end
+
+      context 'add query parameters' do
+        should 'accept a scale as a String' do
+          scale_region = @region.scale('96')
+          assert_equal '96', scale_region.query.scale
+        end
+        should 'accept a scale as a single Integer' do
+          assert_equal '96', @region.scale(96).query.scale
+        end
+        should 'accept a scale as a Float' do
+          assert_equal '0.5', @region.scale(0.5).query.scale
+        end
+        should 'accept a scale as an Array of 2' do
+          assert_equal '1024,768', @region.scale([1024,768]).query.scale
+          assert_equal '10,60', @region.scale(['10', '60']).query.scale
+        end
+
+        should 'accept a level as a String' do
+          level_region = @region.level('2')
+          assert_equal '2', level_region.query.level
+        end
+        should 'accept a level as an Integer' do
+          assert_equal '3', @region.level(3).query.level
+        end
+
+        should 'accept a rotate as a String' do
+          assert_equal '180', @region.rotate('180').query.rotate
+        end
+        should 'accept a rotate as an Integer' do
+          assert_equal '180', @region.rotate(180).query.rotate
+        end
+
+        should 'accept a region as a String' do
+          assert_equal '0,0,256,256', @region.region('0,0,256,256').query.region
+        end
+        should 'accept a region as an Array of Strings' do
+          assert_equal '0,0,256,256', @region.region(['0','0','256','256']).query.region
+        end
+        should 'accept a region as an Array of Integers and/or Floats' do
+          assert_equal '0.1,0.1,5,5', @region.region([0.1, 0.1, 5, 5]).query.region
+        end
+
+        should 'accept a format as a String' do
+          assert_equal 'image/png', @region.format('image/png').query.format
+        end
+        should 'accept a clayer as a String' do
+          assert_equal '0', @region.clayer('0').query.clayer
+        end
+      end
+
+      context 'add empty or null query parameters' do
+        should 'have no value in the uri' do
+          assert_equal nil, @region.level(nil).uri.query_values['svc.level']
+        end
+      end
+
+      context 'create a query uri with svc values' do
+        should 'have a svc.scale paramter' do
+          assert_equal '96', @region.scale('96').uri.query_values['svc.scale']
+        end
+        context 'and method chaining' do
+          setup do
+            @region2 = @region.dup.scale('96').level('3')
+            @region2_query_values = @region2.uri.query_values
+          end
+          should 'have svc.scale and svc.level parameters after method chaining' do
+            assert_equal '96', @region2_query_values['svc.scale']
+            assert_equal '3', @region2_query_values['svc.level']
+          end
+          should 'have default values after method chaining svc values' do
+            assert_equal 'info:lanl-repo/svc/getRegion', @region2_query_values['svc_id']
+          end
+        end
+      end #context create a query uri with svc values
+
+      context 'create a new region and pass in query parameters' do
+        should 'accept param keys as symbols' do
+          params = {:level=> 3, :rotate=>180, :region => '0,0,500,500',
+            :scale => 75, :format => 'image/png'
+          }
+          region = Djatoka::Region.new(@resolver,@identifier,params)
+          assert_equal '3', region.query.level
+          assert_equal '180', region.query.rotate
+          assert_equal '0,0,500,500', region.query.region
+          assert_equal '75', region.query.scale
+          assert_equal 'image/png', region.query.format
+        end
+        should 'accept param keys as strings' do
+          params = {'level'=> 3, 'rotate'=>180, 'region' => '0,0,500,500',
+            'scale' => 75, 'format' => 'image/png'
+          }
+          region = Djatoka::Region.new(@resolver,@identifier,params)
+          assert_equal '3', region.query.level
+          assert_equal '180', region.query.rotate
+          assert_equal '0,0,500,500', region.query.region
+          assert_equal '75', region.query.scale
+          assert_equal 'image/png', region.query.format
+        end
+        should 'not choke on params it responds to but are not instance methods' do
+          region = Djatoka::Region.new(@resolver,@identifier,{:class => 'djatoka_image'})
+          assert region.is_a? Djatoka::Region
+          assert_equal nil, region.uri.query_values['svc.class']
+        end
+      end
+
+    end #context
+
+  end #with_a_resolver
+
+end
+

data/test/test_resolver.rb

@@ -0,0 +1,88 @@
+require 'helper'
+
+class TestDjatokaResolver < Test::Unit::TestCase
+  with_a_resolver do
+    context 'A Djatoka Resolver' do
+
+      should 'hold a good host from a base_url' do
+        assert_equal 'african.lanl.gov', @resolver.host
+      end
+
+      should 'hold a good path from a base_url' do
+        assert_equal '/adore-djatoka/resolver', @resolver.path
+      end
+
+      should 'create a ping url' do
+        assert_equal 'http://african.lanl.gov/adore-djatoka/resolver?url_ver=Z39.88-2004&svc_id=info:lanl-repo/svc/ping&rft_id=info%3Alanl-repo%2Fds%2F5aa182c2-c092-4596-af6e-e95d2e263de3',
+          @resolver.ping_url(@identifier)
+      end
+
+      context 'a ping request' do
+        setup do
+          @ping_response = @resolver.ping(@identifier)
+        end
+
+        should 'return an OK status for a good request' do
+          assert_equal 'OK', @ping_response['status']
+        end
+
+        should 'return the identifier for a good request' do
+          assert_equal @identifier, @ping_response['identifier']
+        end
+
+        should 'return a nil for a bad request' do
+          ping_response = @resolver.ping('asdf')
+          assert_equal nil, ping_response
+        end
+      end
+
+      context 'a ping request using net::http' do
+        setup do
+          Djatoka.use_curb=false
+        end
+        should 'return an OK status for a good request' do
+          assert_equal 'OK', @resolver.ping(@identifier).status
+          Djatoka.use_curb=true
+        end
+        should 'return a nil for a bad request' do
+          ping_response = @resolver.ping('asdf')
+          assert_equal nil, ping_response
+          Djatoka.use_curb=true
+        end
+      end
+
+      should 'create a region from a resolver' do
+        assert @resolver.region(@identifier).is_a? Djatoka::Region
+      end
+      should 'create a region uri from a resolver' do
+        assert @resolver.region_uri(@identifier).is_a? Addressable::URI
+      end
+
+    end #context a Djatoka::Resolver
+
+    context 'a resolver with a port number' do
+      setup do
+        @resolver_port = Djatoka::Resolver.new('http://example.com:8080/adore-djatoka/resolver')
+      end
+      should 'hold good uri data' do
+        assert_equal 'example.com', @resolver_port.host
+        assert_equal 8080, @resolver_port.port
+        assert_equal '/adore-djatoka/resolver', @resolver_port.path
+      end
+      should 'create a good metadata uri' do
+        metadata_url = Djatoka::Metadata.new(@resolver_port, 'asdf').uri
+        assert_equal 8080, metadata_url.port
+      end
+      should 'create a metadata url' do
+        metadata_url = @resolver_port.metadata_url(@identifier)
+        assert metadata_url.is_a? String
+        assert metadata_url.include?('getMetadata')
+      end
+      should 'create a good url' do
+        assert_equal 'http://example.com:8080/adore-djatoka/resolver', @resolver_port.url
+      end
+    end #context: resolver with a port number
+
+  end #with_a_resolver
+end
+

data/test/test_view_helpers.rb

@@ -0,0 +1,15 @@
+require 'helper'
+
+class TestDjatokaViewHelpers < Test::Unit::TestCase
+  with_a_resolver do
+    context 'Rails view helpers' do
+      should 'be true' do
+        assert true
+      end
+      should_eventually 'Test the Rails view helpers' do
+        assert_equal '', djatoka_image_tag(@identifier)
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification 
+name: djatoka
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Jason Ronallo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-15 00:00:00 -04:00
+default_executable: djatoka_url
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: addressable
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mash
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: The djatoka library provides some simple methods for creation of the OpenURLs needed to communicate with the Djatoka image server.
+email: jronallo@gmail.com
+executables: 
+- djatoka_url
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/djatoka_url
+- generators/djatoka/djatoka_generator.rb
+- generators/djatoka/templates/OpenLayers.js
+- generators/djatoka/templates/OpenURL.js
+- generators/djatoka/templates/blank.gif
+- generators/djatoka/templates/djatoka-initializer.rb
+- generators/djatoka/templates/djatoka.js
+- generators/djatoka/templates/east-mini.png
+- generators/djatoka/templates/north-mini.png
+- generators/djatoka/templates/south-mini.png
+- generators/djatoka/templates/west-mini.png
+- generators/djatoka/templates/zoom-minus-mini.png
+- generators/djatoka/templates/zoom-plus-mini.png
+- generators/djatoka/templates/zoom-world-mini.png
+- lib/djatoka.rb
+- lib/djatoka/common.rb
+- lib/djatoka/metadata.rb
+- lib/djatoka/net.rb
+- lib/djatoka/region.rb
+- lib/djatoka/resolver.rb
+- lib/djatoka/view_helpers.rb
+has_rdoc: true
+homepage: http://github.com/jronallo/djatoka
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Djatoka image server helpers for Ruby and Rails.
+test_files: 
+- test/test_metadata.rb
+- test/test_djatoka.rb
+- test/test_resolver.rb
+- test/test_view_helpers.rb
+- test/test_region.rb
+- test/helper.rb
+- test/test_common.rb