unapi 0.0.5 → 0.0.6

data/lib/unapi/format.rb

@@ -3,17 +3,11 @@ module UnAPI
   class Format
     attr_accessor :name, :type, :docs, :namespace_uri, :schema_location
 
-    def Format.new_from_element(formats)
+    def Format.new_from_element(element)
       format = Format.new
-      formats.elements.each do |e|
-        case e.name
-          when 'name'            : format.name = e.text
-          when 'type'            : format.type = e.text
-          when 'docs'            : format.docs = e.text
-          when 'namespace_uri'   : format.namespace_uri = e.text
-          when 'schema_location' : format.schema_location = e.text
-        end
-      end
+      format.name = element.attributes['name']
+      format.type = element.attributes['type']
+      format.docs = element.attributes['docs']
       return format
     end
   end

data/lib/unapi/page.rb

@@ -19,7 +19,7 @@ module UnAPI
       return nil if not @document or not @document.head
       link_url = nil
       @document.head.find_all('link') do |link|
-        link_url = link['href'] if link['title'] == 'unAPI'
+        link_url = link['href'] if link['rel'] == 'unapi-server'
       end
       return nil if not link_url
 
@@ -43,19 +43,19 @@ module UnAPI
       return nil
     end
 
-    # get a list of uris for the page
-    def uris
-      uris = []
-      return uris if not @document
-      @document.find_all('span') do |span|
-        next unless span['class'] and span['title']
+    # get a list of ids for the page
+    def ids
+      ids = []
+      return ids if not @document
+      @document.find_all('abbr') do |abbr|
+        next unless abbr['class'] and abbr['title']
         # can have multiple css classes
-        classes = span['class'].split(/\s+/)
-        if classes.member? 'unapi-uri'
-          uris << span['title']
+        classes = abbr['class'].split(/\s+/)
+        if classes.member? 'unapi-id'
+          ids << abbr['title']
         end
       end
-      return uris
+      return ids
     end
   end
 

data/lib/unapi/service.rb

@@ -25,9 +25,9 @@ module UnAPI
       return formats
     end
 
-    def formats_for_uri(uri)
+    def formats_for_id(id)
       formats = []
-      request_url = @url + "?uri=#{CGI.escape(uri)}"
+      request_url = @url + "?id=#{CGI.escape(id)}"
       @status_code, @document, @content_type = Utils.get_document request_url
       @document.elements.each('.//formats/format') do |e|
         formats << Format.new_from_element(e)
@@ -36,10 +36,10 @@ module UnAPI
       return formats
     end
 
-    def get_uri_in_format(uri, format)
-      uri_esc = CGI.escape(uri)
+    def get_id_in_format(id, format)
+      id_esc = CGI.escape(id)
       format_esc = CGI.escape(format)
-      request_url = @url + "?uri=#{uri_esc}&format=#{format_esc}"
+      request_url = @url + "?id=#{id_esc}&format=#{format_esc}"
       @document = nil
       @status_code, body, @content_type = Utils.get request_url
       @last_url = request_url

data/lib/unapi/validator.rb

@@ -107,7 +107,7 @@ module UnAPI
     def validate_page(page_url)
       page = UnAPI::Page.new page_url
       check_service page
-      check_uris page
+      check_ids page
     end
 
     private
@@ -132,53 +132,51 @@ module UnAPI
       check_formats(formats, service, 'unapi service')
     end
 
-    def check_uris(page)
+    def check_ids(page)
       service = page.service
       return if not service 
 
-      # look for unap-uris on the page
-      uris = page.uris
-      @handler.test uris.length > 0, 
-        "page should > 0 elements with class unapi-uri", 
-        uris.length, 
+      # look for unap-ids on the page
+      ids = page.ids
+      @handler.test ids.length > 0, 
+        "page should > 0 elements with class unapi-id", 
+        ids.length, 
         page.uri 
 
       # go through each identifier
-      uris.each do |uri|
+      ids.each do |id|
 
         # verify it has formats available
-        formats = service.formats_for_uri(uri)
-        check_formats(formats, service, uri)
+        formats = service.formats_for_id(id)
+        check_formats(formats, service, id)
 
         # request an invalid format 
-        content = service.get_uri_in_format(uri, 'thisformatdoesnotexist')
-        @handler.check service.status_code == 415, 
-          "request for uri #{uri} with bad format should return with " +
-          "status code 415",
+        content = service.get_id_in_format(id, 'thisformatdoesnotexist')
+        @handler.check service.status_code == 406, 
+          "request for id #{id} with bad format should return with " +
+          "status code 406",
           service.status_code,
           service.last_url
 
         # verify that each format is available
         content = ''
         formats.each do |format|
-          content = service.get_uri_in_format(uri, format.name)
-          @handler.check service.status_code == 200,
-            "request for #{uri} content should return with 200 status code",
-            service.status_code,
-            service.last_url
+          next if format.name == nil
+          content = service.get_id_in_format(id, format.name)
           @handler.test((content != nil and content.length > 0),
-            "request for #{uri} should return data",
+            "request for id #{id} in format #{format.name} should return data",
             "#{content.length} bytes",
             service.last_url)
           @handler.test service.content_type.include?(format.type),
-            "request for #{uri} should return with content-type #{format.type}",
+            "request for id #{id} in format #{format.name} should return " +
+            "with content-type #{format.type}",
             service.content_type,
             service.last_url
 
-          # request an invalid uri with a valid format
-          service.get_uri_in_format('invaliduriinvaliduri', format.name)
+          # request an invalid id with a valid format
+          service.get_id_in_format('invalidrughdinvalid', format.name)
           @handler.check service.status_code == 404,
-            "request for invalid uri with valid format #{format.name} " + 
+            "request for invalid id with valid format #{format.name} " + 
             "should return with 404 status code", 
             service.status_code, 
             service.last_url
@@ -193,12 +191,9 @@ module UnAPI
         service.content_type,
         service.last_url
 
-      if target == 'unapi service' 
-        @handler.check service.status_code == 200,
-          "formats request for #{target} should return with 200 status code", 
-          service.status_code,
-          service.last_url
-      else 
+      # requesting formats on a server shouldn't return 300 apparently
+      # unless a specific identifier was requested 
+      unless target == 'unapi service'
         @handler.check service.status_code == 300,
           "formats request for #{target} should return with 300 status code",
           service.status_code,

data/test/index.html

@@ -3,7 +3,7 @@
 <title>
 Amazon.com: Online Shopping for Electronics, Apparel, Computers, Books, DVDs & more
 </title>
-<link rel="meta" type="application/xml" title="unAPI" href="http://localhost:9000/unapi" />
+<link rel="unapi-server" type="application/xml" title="unAPI" href="http://localhost:9000/unapi" />
 <meta name="description" content="Online shopping from the earth's biggest selection of books, magazines, music, DVDs, videos, electronics, computers, software, apparel & accessories, shoes, jewelry, tools & hardware, housewares, furniture, sporting goods, beauty & personal care, gourmet food & just about anything else.">
 <meta name="keywords" content="Amazon, Amazon.com, Books, Online Shopping, Book Store, Magazine, Subscription, Music, CDs, DVDs, Videos, Electronics, Video Games, Computers, Cell Phones, Toys, Games, Apparel, Accessories, Shoes, Jewelry, Watches, Office Products, Sports & Outdoors, Sporting Goods, Baby Products, Health, Personal Care, Beauty, Home, Garden, Bed & Bath, Furniture, Tools, Hardware, Vacuums, Outdoor Living, Automotive Parts, Pet Supplies">
 <style type="text/css"><!-- .serif { font-family: times,serif; font-size: small; }
@@ -490,21 +490,21 @@ Sign in to get <a href=/exec/obidos/flex-sign-in?opt=a&page=recs/sign-in-secure.
 <br><br>
 <div class="small">
   <b class="h1">2006 Spring Preview: What to Read Next</b><br clear=left>
-  <span class="unapi-uri display" title="urn:isbn:0553804790">
+  <abbr class="unapi-id display" title="urn:isbn:0553804790">
 <a href="http://www.amazon.com/exec/obidos/ASIN/0553804790">
 <img src="http://images.amazon.com/images/P/0553804790.01.37TRZZZZ.jpg" width=81 height=121 align=left valign=top hspace=5 vspace=3 border=0 border=0>
 </a>
-</span>
-<span class="unapi-uri" title="urn:isbn:030723827X">
+</abbr>
+<abbr class="unapi-id" title="urn:isbn:030723827X">
 <a href="http://www.amazon.com/exec/obidos/ASIN/030723827X">
 <img src="http://images.amazon.com/images/P/030723827X.01.37TRZZZZ.jpg" width=94 height=121 align=left valign=top hspace=5 vspace=3 border=0 border=0>
 </a>
-</span>
-<span class="unapi-uri" title="urn:isbn:0307236579">
+</abbr>
+<abbr class="unapi-id" title="urn:isbn:0307236579">
 <a href="http://www.amazon.com/exec/obidos/ASIN/0307236579">
 <img src="http://images.amazon.com/images/P/0307236579.01.35TRZZZZ.jpg" width=93 height=121 align=left valign=top hspace=5 vspace=3 border=0 border=0>
 </a>
-</span>
+</abbr>
 See what's coming up this spring in our 2006 sneak preview, including a thriller from <a href="http://www.amazon.com/exec/obidos/ASIN/0553804790">Dean Koontz</a>, a new cookbook from <a href="http://www.amazon.com/exec/obidos/ASIN/030723827X">Giada De Laurentiis</a>, and a <a href="http://www.amazon.com/exec/obidos/ASIN/0307236579">little knitting book</a> that will get you ready for summer. <br clear=all>
 <ul>
 <li>Top Releases: <a href="http://www.amazon.com/gp/richpub/listmania/fullview/R3PET96BPF14S4">Fiction</a> | <a href="http://www.amazon.com/gp/richpub/listmania/fullview/R1DTUMBWJP7PN1">Nonfiction</a>

data/test/unapi_servlet.rb

@@ -9,29 +9,29 @@ require 'net/http'
 class UnAPIServlet < WEBrick::HTTPServlet::AbstractServlet
 
   def service(request, response)
-    uri = request.query.fetch('uri', nil)
+    id = request.query.fetch('id', nil)
     format = request.query.fetch('format', nil)
 
-    if not uri and not format 
+    if not id and not format 
       doc = REXML::Document.new
       doc.add_element get_formats
       response['Content-Type'] = 'application/xml'
       response.status = 300
       response.body = doc.to_s
 
-    elsif uri and not format
-      if not has_record(uri)
+    elsif id and not format
+      if not has_record(id)
         response.status = 404
       else
         doc = REXML::Document.new
-        doc.add_element get_formats(uri)
+        doc.add_element get_formats(id)
         response['Content-Type'] = 'application/xml'
         response.status = 300
         response.body = doc.to_s
       end
 
-    elsif uri and format
-      record = get_record(uri, format)
+    elsif id and format
+      record = get_record(id, format)
       if not ok_format? format
         response.status = 415
       elsif not record 
@@ -54,11 +54,11 @@ class UnAPIServlet < WEBrick::HTTPServlet::AbstractServlet
     return(['mods','dc'].member? format)
   end
 
-  def get_formats(uri=nil)
+  def get_formats(id=nil)
     formats = REXML::Element.new 'formats'
-    if uri
-      uri_element = REXML::Element.new 'uri', formats
-      uri_element.text = uri
+    if id 
+      id_element = REXML::Element.new 'id', formats
+      id_element.text = id
     end
     formats.add_element get_format('dc', 'text/xml')
     formats.add_element get_format('mods', 'text/xml')
@@ -67,20 +67,18 @@ class UnAPIServlet < WEBrick::HTTPServlet::AbstractServlet
 
   def get_format(name, type)
     format = REXML::Element.new 'format'
-    name_element = REXML::Element.new 'name', format
-    name_element.text = name 
-    type_element = REXML::Element.new 'type', format
-    type_element.text = type
+    format.attributes['name'] = name
+    format.attributes['type'] = type
     return format
   end
 
-  def has_record(uri)
+  def has_record(id)
     ids = ['urn:isbn:0553804790', 'urn:isbn:030723827X', 'urn:isbn:0307236579']
-    return(ids.member? uri)
+    return(ids.member? id)
   end
 
-  def get_record(uri, format)
-    if has_record(uri)
+  def get_record(id, format)
+    if has_record(id)
       case format
       when 'dc'   : return(REXML::Element.new 'dc')
       when 'mods' : return(REXML::Element.new 'mods')

data/test/unapi_test.rb

@@ -7,10 +7,10 @@ class UnAPITest < Test::Unit::TestCase
     assert_equal page.service_url, 'http://localhost:9000/unapi'
   end
 
-  def test_uris
+  def test_ids
     page = UnAPI::Page.new 'http://localhost:9000/index.html'
     assert_equal [ 'urn:isbn:0553804790', 'urn:isbn:030723827X',
-      'urn:isbn:0307236579'], page.uris
+      'urn:isbn:0307236579'], page.ids
   end
 
   def test_service
@@ -38,9 +38,9 @@ class UnAPITest < Test::Unit::TestCase
     assert_equal nil, service.status_code
   end
 
-  def test_uri_formats
+  def test_id_formats
     service = UnAPI::Service.new 'http://localhost:9000/unapi'
-    formats = service.formats_for_uri('urn:isbn:0553804790')
+    formats = service.formats_for_id('urn:isbn:0553804790')
     assert_equal 2, formats.length
     assert_equal formats[0].name, 'dc'
     assert_equal formats[0].type, 'text/xml'
@@ -49,32 +49,32 @@ class UnAPITest < Test::Unit::TestCase
     assert_equal 300, service.status_code
   end
 
-  def test_bad_uri_formats
+  def test_bad_id_formats
     service = UnAPI::Service.new 'http://localhost:9000/unapi'
-    formats = service.formats_for_uri('urn:isbn:foobarf')
+    formats = service.formats_for_id('urn:isbn:foobarf')
     assert_equal 0, formats.length
     assert_equal 404, service.status_code
   end
 
-  def test_get_uri_in_format
+  def test_get_id_in_format
     service = UnAPI::Service.new 'http://localhost:9000/unapi'
-    uri = 'urn:isbn:0553804790'
-    assert_equal '<dc/>', service.get_uri_in_format(uri, 'dc')
+    id = 'urn:isbn:0553804790'
+    assert_equal '<dc/>', service.get_id_in_format(id, 'dc')
     assert_equal 200, service.status_code
-    assert_equal '<mods/>', service.get_uri_in_format(uri, 'mods')
+    assert_equal '<mods/>', service.get_id_in_format(id, 'mods')
     assert_equal 200, service.status_code
   end
 
-  def test_get_bad_uri
+  def test_get_bad_id_
     service = UnAPI::Service.new 'http://localhost:9000/unapi'
-    assert_equal nil, service.get_uri_in_format('foobar', 'dc')
+    assert_equal nil, service.get_id_in_format('foobar', 'dc')
     assert_equal 404, service.status_code
   end
 
-  def test_get_bad_uri_in_format
-    uri = 'urn:isbn:0553804790'
+  def test_get_bad_id_in_format
+    id = 'urn:isbn:0553804790'
     service = UnAPI::Service.new 'http://localhost:9000/unapi'
-    assert_equal nil, service.get_uri_in_format(uri, 'cheese')
+    assert_equal nil, service.get_id_in_format(id, 'cheese')
     assert_equal 415, service.status_code
   end
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: unapi
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
-date: 2006-04-30 00:00:00 -05:00
+  version: 0.0.6
+date: 2006-07-02 00:00:00 -04:00
 summary: A library for working with the unapi protocol
 require_paths: 
   - lib