ruby-yadis 0.3 → 0.3.1

data/lib/yadis/xrds.rb

@@ -4,13 +4,15 @@ require 'yadis/service'
 # Class that handles XRDS parsing and XRD Service element extraction.
 
 module XRDSUtil
-
-  @@default_namespace = 'xri://$xrd*($v*2.0)'
-  @@xrds_namespace = {'xrds' => 'xri://$xrds'}
+  
+  @@namespaces = {
+    'xrdsns' => 'xri://$xrds',
+    'xrdns' => 'xri://$xrd*($v*2.0)'
+  }
 
   def last_xrd(root_element)
-    REXML::XPath.match(root_element, '/xrds:XRDS/XRD',
-                       @@xrds_namespace)[-1]
+    REXML::XPath.match(root_element, '/xrdsns:XRDS/xrdns:XRD',
+                       @@namespaces)[-1]
   end
   
 end
@@ -22,7 +24,7 @@ class XRDS
 
   # Method for producing a valid XRDS object.  Accepts an XML
   # String. Returns an XRDS object on success, or nil on failure.
-  # Same as calling XRDS.new, but does not rails ArgumentErrors.
+  # Same as calling XRDS.new, but does not raise ArgumentErrors.
   def XRDS.parse(xml)
     begin
       return new(xml)
@@ -56,17 +58,14 @@ class XRDS
     if xml.root.nil?
       raise ArgumentError, "No document root"
     end
-    
-    xmlns = xml.root.attributes['xmlns']
-    if xmlns != @@default_namespace
-      raise ArgumentError, "Unknown XRID version #{xmlns.to_s}"
-    end
 
     xrd = self.last_xrd(xml.root)
     raise ArgumentError, "No XRD Elements found" if xrd.nil?
    
-    @services = {}  # keyed by [service_priority, uri_priority]    
-    xrd.elements.each('Service') {|s| _create_services(s)}
+    @services = {}  # keyed by [service_priority, uri_priority]
+    REXML::XPath.each(xrd, 'xrdns:Service', @@namespaces) do |s|
+      _create_services(s)
+    end
   end
 
 
@@ -98,7 +97,9 @@ class XRDS
     service.service_types = []
 
     service_element.elements.each('Type') do |t|
-      service.service_types << t.text.strip 
+      # XXX: If the Type element is empty, should we add an empty element
+      # to our list, or none at all?
+      service.service_types << t.text.strip unless t.text.nil?
     end
 
     sp = service_element.attributes['priority']

data/test/data/brianellin.mylid.xrds

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<XRDS xmlns="xri://$xrds" xmlns:xrd="xri://$xrd*($v*2.0)">
+ <xrd:XRD>
+  <xrd:Service priority="1">
+   <xrd:Type>http://lid.netmesh.org/minimum-lid/2.0b9</xrd:Type>
+   <xrd:URI>http://mylid.net/brianellin</xrd:URI>
+  </xrd:Service>
+  <xrd:Service priority="2">
+   <xrd:Type>http://lid.netmesh.org/sso/2.0b9</xrd:Type>
+   <xrd:URI>http://mylid.net/brianellin</xrd:URI>
+  </xrd:Service>
+  <xrd:Service priority="3">
+   <xrd:Type>http://lid.netmesh.org/sso/1.0</xrd:Type>
+   <xrd:URI>http://mylid.net/brianellin</xrd:URI>
+  </xrd:Service>
+  <xrd:Service priority="4">
+   <xrd:Type>http://lid.netmesh.org/relying-party/2.0b9</xrd:Type>
+   <xrd:URI>http://mylid.net/brianellin</xrd:URI>
+  </xrd:Service>
+  <xrd:Service priority="5">
+   <xrd:Type>http://lid.netmesh.org/traversal/2.0b9</xrd:Type>
+   <xrd:URI>http://mylid.net/brianellin</xrd:URI>
+  </xrd:Service>
+  <xrd:Service priority="6">
+   <xrd:Type>http://lid.netmesh.org/format-negotiation/2.0b9</xrd:Type>
+   <xrd:URI>http://mylid.net/brianellin</xrd:URI>
+  </xrd:Service>
+  <xrd:Service priority="7">
+   <xrd:Type>http://lid.netmesh.org/post/sender/2.0b9</xrd:Type>
+   <xrd:URI>http://mylid.net/brianellin</xrd:URI>
+  </xrd:Service>
+  <xrd:Service priority="8">
+   <xrd:Type>http://lid.netmesh.org/post/receiver/2.0b9</xrd:Type>
+   <xrd:URI>http://mylid.net/brianellin</xrd:URI>
+  </xrd:Service>
+  <xrd:Service priority="9">
+   <xrd:Type>http://openid.net/signon/1.0</xrd:Type>
+   <xrd:URI>http://mylid.net/brianellin</xrd:URI>
+   <openid:Delegate xmlns:openid="http://openid.net/xmlns/1.0">http://mylid.net/brianellin</openid:Delegate>
+  </xrd:Service>
+ </xrd:XRD>
+</XRDS>

data/test/data/proxy-june1.xrds

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<XRDS ref="xri://=keturn" xmlns="xri://$xrds">
+ <XRD xmlns="xri://$xrd*($v*2.0)">
+  <Query>*keturn</Query>
+  <Status code="100"/>
+  <Expires>2006-06-01T18:00:49.000Z</Expires>
+  <ProviderID>xri://=</ProviderID>
+  <LocalID priority="10">!2397.58EC.8F7D.D097</LocalID>
+  <CanonicalID priority="10">=!2397.58EC.8F7D.D097</CanonicalID>
+  <Service priority="10">
+   <Type/>
+   <Type>xri://+i-service*(+forwarding)*($v*1.0)</Type>
+   <ProviderID>xri://!!1003</ProviderID>
+   <URI priority="10">https://forwarding.godaddy.amsoftsystems.com</URI>
+  </Service>
+  <Service priority="10">
+   <Type>xri://+i-service*(+contact)*($v*1.0)</Type>
+   <ProviderID>xri://!!1003</ProviderID>
+   <Path>+contact</Path>
+   <MediaType/>
+   <MediaType>text/html</MediaType>
+   <URI priority="10">https://contact.godaddy.amsoftsystems.com</URI>
+  </Service>
+  <Service priority="10">
+   <Type>xri://+i-service*(+authn)*(+saml)*($v*1.0)</Type>
+   <ProviderID>xri://!!1003</ProviderID>
+   <Path>+login</Path>
+   <URI priority="10">https://isso.godaddy.amsoftsystems.com</URI>
+  </Service>
+ </XRD>
+</XRDS>

data/test/data/weirdver.xrds

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xrds:XRDS
+    xmlns:xrds="xri://$xrds"
+    xmlns:openid="http://openid.net/xmlns/1.0"
+    xmlns="xri://$xrd*($v*1.14121)">
+  <XRD>
+
+    <Service priority="0">
+      <Type>http://openid.net/signon/1.0</Type>
+      <URI>http://www.myopenid.com/server</URI>
+      <openid:Delegate>http://brian.myopenid.com/</openid:Delegate>
+    </Service>
+
+  </XRD>
+</xrds:XRDS>

data/test/test_xrds.rb

@@ -9,6 +9,12 @@ class XRDSTestCase < Test::Unit::TestCase
       assert_not_nil(xrds)
       assert_equal(xrds.services.length, 1)      
     end
+
+    File.open('data/brianellin.mylid.xrds') do |f|
+      xrds = XRDS.new(f.read)
+      assert_not_nil(xrds)
+      assert_equal(xrds.services.length, 9)
+    end
   end
 
   def test_xrds_good_multi
@@ -29,6 +35,22 @@ class XRDSTestCase < Test::Unit::TestCase
     end
   end
 
+  # This is like brian.multi, but uses namespaces a little differently.
+  def test_xrds_good_namespaces
+    File.open('data/proxy-june1.xrds') do |f|
+      xrds = XRDS.new(f.read)
+      assert_not_nil(xrds)
+      assert_equal(3, xrds.services.length)
+    end
+  end
+
+  def test_xrds_unknown_xrd_version
+    File.open('data/weirdver.xrds') do |f|
+      xrds = XRDS.parse(f.read)
+      assert_nil(xrds)
+    end
+ end
+
   def test_xrds_bad
     assert_nil(XRDS.parse(nil))
     assert_nil(XRDS.parse(5))

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: ruby-yadis
 version: !ruby/object:Gem::Version 
-  version: "0.3"
-date: 2006-05-10 00:00:00 -07:00
+  version: 0.3.1
+date: 2006-06-09 00:00:00 -07:00
 summary: A library for performing Yadis service discovery
 require_paths: 
 - lib
@@ -31,19 +31,13 @@ files:
 - examples/openid.rb
 - lib/yadis.rb
 - lib/yadis
-- lib/yadis.rb~
 - lib/yadis/parsehtml.rb
 - lib/yadis/xrds.rb
 - lib/yadis/yadis.rb
 - lib/yadis/fetcher.rb
 - lib/yadis/htmltokenizer.rb
 - lib/yadis/manager.rb
-- lib/yadis/yadis.rb~
 - lib/yadis/service.rb
-- lib/yadis/manager.rb~
-- lib/yadis/service.rb~
-- lib/yadis/xrds.rb~
-- lib/yadis/fetcher.rb~
 - test/test_parse.rb
 - test/data
 - test/test_discovery.rb
@@ -52,12 +46,15 @@ files:
 - test/runtests.rb
 - test/data/manifest.txt
 - test/data/brian.xrds
-- test/data/index.html
-- test/data/brian.multi.xrds
 - test/data/brian_priority.xrds
+- test/data/brian.multi.xrds
+- test/data/index.html
 - test/data/brian.multi_uri.xrds
-- test/data/index_xrds.html
 - test/data/index_yadis.html
+- test/data/index_xrds.html
+- test/data/proxy-june1.xrds
+- test/data/weirdver.xrds
+- test/data/brianellin.mylid.xrds
 - README
 - INSTALL
 - COPYING

data/lib/yadis.rb~

@@ -1 +0,0 @@
-require 'yadis/yadis'

data/lib/yadis/fetcher.rb~

@@ -1,79 +0,0 @@
-require "uri"
-
-begin
-  require "net/https"
-rescue LoadError
-  HAS_OPENSSL_ = false
-  require 'net/http'
-else  
-  HAS_OPENSSL_ = true
-end
-
-class NetHTTPFetcher
-    
-  attr_accessor :ca_path
-  
-  def initialize(read_timeout=20, open_timeout=20)
-    @read_timeout = read_timeout
-    @open_timeout = open_timeout
-    @ca_path = nil
-  end
-    
-  def get(url, params = nil)    
-    resp, final_url = do_get(url, params)
-    if resp.nil?
-      nil
-    else
-      [final_url, resp]
-    end
-  end
-  
-  protected
-    
-    # return a Net::HTTP object ready for use    
-    def get_http_obj(uri)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.read_timeout = @read_timeout
-      http.open_timeout = @open_timeout
-
-      if uri.scheme == 'https'        
-        if HAS_OPENSSL_
-          http.use_ssl = true
-          if @ca_path
-            http.ca_file = @ca_path
-            http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-          else
-            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-            STDERR.puts("Warning: fetching over https without verifying server certificate")
-          end
-        else
-          STDERR.puts('Warning: trying to fetch HTTPS URL without OpenSSL support')
-        end
-      end
-
-      return http
-    end
-    
-    # do a GET following redirects limit deep    
-    def do_get(url, params, limit=5)
-      if limit == 0
-        return nil
-      end
-      begin
-        uri = URI.parse(url)
-        http = get_http_obj(uri)
-        resp = http.request_get(uri.request_uri, params)
-      rescue
-        nil
-      else
-        case resp
-        when Net::HTTPSuccess then [resp, URI.parse(url).to_s]
-        when Net::HTTPRedirection then do_get(resp["location"], params, limit-1)
-        else
-          STDERR.puts("ERROR, what to do with #{resp}")
-          nil
-        end
-      end
-    end
-
-end

data/lib/yadis/manager.rb~

@@ -1,138 +0,0 @@
-require 'yadis/yadis'
-
-class YadisServiceManager
-
-  attr_reader :starting_url, :yadis_url, :services, :session_key, :current
-
-  def initialize(starting_url, yadis_url, services)
-    @starting_url = starting_url
-    @yadis_url = yadis_url
-    @services = services
-    @current = nil
-  end
-
-  def next
-    @current = @services.shift
-  end
-
-  def for_url?(url)
-    url == @starting_url or url == @yadis_url
-  end
-
-  def started?
-    not @current.nil?
-  end
-
-  def length
-    @services.length
-  end
-
-end
-
-class Discovery
-
-  @@default_suffix = nil
-  @@prefix = '_yadis_services_'
-
-  def initialize(session, url, session_key_siffix=nil)
-    @session = session
-    @url = url
-    @session_key = @@prefix + (session_key_suffix or @@default_suffix)
-  end
-
-  def next_service(discover_block)
-    manager = self.get_manager
-    if manager and manager.length <= 0
-      self.destroy_manager
-      manager = nil
-    end
-
-    unless manager
-      begin
-        yadis_url, services = self.discover
-      rescue YADISParseError, YADISHTTPError
-        manager = nil
-      else
-        manager = self.create_manager(services, yadis_url)   
-      end     
-    end
-
-    if manager
-      service = manager.next
-      self.store_manager(manager)
-    else
-      service = nil
-    end
-    
-    return service
-  end
-
-  def finish
-    manager = self.get_manager
-    return nil unless manager
-
-    service = manager.current
-    self.destroy_manager
-    return service
-  end
-
-  def get_manager
-    manager = @session[@session_key]
-
-    # make sure we've got the right manager here
-    if manager and manager.for_url?(@url)
-      return manager
-    end
-
-    return nil
-  end
-
-  def create_manager(services, yadis_url=nil)
-    if self.get_manager
-      raise ArgumentError, "There is already a manager for #{@url}"
-    end
-
-    if services.length > 0
-      manager = YadisServiceManager.new(@url, yadis_url, services)
-      self.store_manager(manager)
-    else
-      manager = nil
-    end
-
-    return manager
-  end
-
-  def destroy_manager
-    if self.get_manager
-      begin
-        @session.delete(@session_key)
-      rescue
-        # sometimes Hash like session objects don't have a delete
-        # method.  We handle that case by assigning nil to the session[key]
-        @session[@session_key] = nil
-      end
-    end
-  end
-
-  def store_manager(manager)
-    @session[@session_key] = manager
-  end
-
-  # The filter argument is a Proc that will be used to call
-  # YADIS.filter_services.  See the documentation for YADIS.filter_services
-  # for more information about writing filters.
-  def discover(filter=nil)
-    y = YADIS.new(@url)
-    
-    # a default filter which sends through everything.  you should
-    # probably consider writing a custom filter and passing it in.
-    unless filter
-      filter = lambda {|s| s}
-    end
-
-    return [y.url, y.filter_services(filter)]    
-  end
-
-end
-
-

data/lib/yadis/service.rb~

@@ -1,24 +0,0 @@
-require 'rexml/document'
-
-# Class representing an XRD Service element.  
-class ServiceEndpoint
-
-  attr_accessor :service_types, :uri, :yadis_uri, :element, :yadis
-
-  def initialize
-    @service_types = []
-    @uri = nil
-    @yadis_uri = nil
-    @element = nil
-    @yadis_uri = nil
-  end
-
-  def match_type_uris(type_uris)
-    type_uris.find_all {|t| @service_types.member?(t)}
-  end
-
-  def ==(other)
-    return self.instance_variables == other.instance_variables
-  end
-
-end

data/lib/yadis/xrds.rb~

@@ -1,128 +0,0 @@
-require 'rexml/document'
-require 'yadis/service'
-
-# Class that handles XRDS parsing and XRD Service element extraction.
-
-module XRDSUtil
-
-  @@default_namespace = 'xri://$xrd*($v*2.0)'
-  @@xrds_namespace = {'xrds' => 'xri://$xrds'}
-
-  def last_xrd(root_element)
-    REXML::XPath.match(root_element, '/xrds:XRDS/XRD',
-                       @@xrds_namespace)[-1]
-  end
-  
-end
-
-class XRDS
-
-  include XRDSUtil
-  attr_reader :xml
-
-  # Method for producing a valid XRDS object.  Accepts an XML
-  # String. Returns an XRDS object on success, or nil on failure.
-  # Same as calling XRDS.new, but does not rails ArgumentErrors.
-  def XRDS.parse(xml)
-    begin
-      return new(xml)
-    rescue
-      return nil
-    end
-  end
-
-  # Create a new XRDS object.  Raises ArgumentError if xml_text is
-  # malformed or invalid XRDS.
-  def initialize(xml_text)
-    parse_xml(xml_text)
-  end
-
-  def parse_xml(xml_text)   
-    begin
-      xml = @xml = REXML::Document.new(xml_text)
-    rescue
-      raise ArgumentError, "Can't parse XRDS"
-    end
-    
-    if xml.root.nil?
-      raise ArgumentError, "No document root"
-    end
-    
-    xmlns = xml.root.attributes['xmlns']
-    if xmlns != @@default_namespace
-      raise ArgumentError, "Unknown XRID version #{xmlns.to_s}"
-    end
-
-    xrd = self.last_xrd(xml.root)
-    raise ArgumentError, "No XRD Elements found" if xrd.nil?
-   
-    @services = {}  # keyed by [service_priority, uri_priority]    
-    xrd.elements.each('Service') {|s| _create_services(s)}
-  end
-
-
-  # Returns an Array of ServiceEndpoint objects, sorted by priority.  Highest
-  # priority is at element 0.
-  def services
-    s = []
-
-    @services.keys.sort.each do |key|
-      services_list = @services[key].dup
-
-      # randomize services with the same priority
-      while services_list.length > 0
-        s << services_list.delete_at((rand * services_list.length).to_i)
-      end
-
-    end
-    
-    return s
-  end
-
-  private
-
-  # create services objects
-  def _create_services(service_element)
-    service = ServiceEndpoint.new
-    service.element = service_element
-    service.uri = nil
-    service.service_types = []
-
-    service_element.elements.each('Type') do |t|
-      service.service_types << t.text.strip 
-    end
-
-    sp = service_element.attributes['priority']
-    service_priority = sp ? sp.to_i : -1
-
-    if service.element.elements['URI']
-      service.element.elements.each('URI') do |uri|
-        _service = service.dup
-        _service.uri = uri.text.strip
-        
-        up = uri.attributes['priority']
-        uri_priority = up ? up.to_i : -1
-        priority = [service_priority, uri_priority]
-        
-        _add_service(priority, _service)
-      end
-      
-    else
-      priority = [service_priority, -1]
-      _add_service(priority, service)
-
-    end
-
-  end
-
-  def _add_service(priority, service)
-    unless @services.has_key?(priority)
-      @services[priority] = []
-    end
-
-    # services with the same priority are appended to the list
-    @services[priority] << service
-  end
-
-end
-

data/lib/yadis/yadis.rb~

@@ -1,104 +0,0 @@
-require 'yadis/xrds'
-require 'yadis/fetcher'
-require 'yadis/parsehtml'
-
-class YADISParseError < StandardError; end
-class YADISHTTPError < StandardError; end
-
-class YADIS
-
-  @@ca_path = nil
-  attr_accessor :uri, :xrds_uri, :xrds
-
-  # Discover services for a given URI.  Please note that no normalization 
-  # will be done to the passed in URI, it should be a textually
-  # valid URI string before calling discover.
-  #
-  # Returns nil if no XRDS was found, or a YADIS object on success.  This
-  # method is essentially the same as YADIS.new, but does not raise any
-  # exceptions.
-  def YADIS.discover(uri)
-    return nil unless uri
-    begin
-      return YADIS.new(uri)
-    rescue
-      return nil
-    end
-  end
-
-  # Set the path to a certificate authority pem file, for verifying
-  # server certificates of HTTPS pages.  If you are interested in verifying
-  # certs like the mozilla web browser, have a look at the files here:
-  #
-  # http://curl.haxx.se/docs/caextract.html
-  def YADIS.ca_path=(ca_path)
-    ca_path = ca_path.to_s
-    if File.exists?(ca_path)
-      @@ca_path = ca_path
-    else
-      raise ArgumentError, "#{ca_path} is not a valid file path"
-    end
-  end
-
-  # Discover services for a URI using the Yadis protocol.  +uri+ should
-  # be a valid URI represented as a string.  This method may raise
-  # YADISParseError in the case of an invalid or unparsable XRDS file,
-  # or YADISHTTPError is the URI cannot be fetched.
-  def initialize(uri)
-    http = NetHTTPFetcher.new
-    http.ca_path = @@ca_path if @@ca_path    
-    headers = {'Accept' => 'application/xrds+xml'}
-
-    response = http.get(uri, headers)
-    raise YADISHTTPError, "Could not fetch #{uri}" if response.nil?
-
-    uri, resp_payload = response
-    xrds_uri = uri
-
-    header = resp_payload['x-xrds-location']
-    header = resp_payload['x-yadis-location'] if header.nil?
-
-    if header
-      xrds_uri = header
-      response = http.get(xrds_uri)
-      raise YADISHTTPError, "Could not fetch XRDS #{xrds_uri}" if response.nil?
-      resp_payload = response[1]
-    end
-
-    unless resp_payload['content-type'] == 'application/xrds+xml'
-      loc = html_yadis_location(resp_payload.body)
-      unless loc.nil?
-        xrds_uri, resp_payload = http.get(loc)
-      end
-    end
-
-    xrds = XRDS.parse(resp_payload.body)
-    raise YADISParseError, "Bad XRDS" if xrds.nil?
-
-    @uri = uri
-    @xrds_uri = xrds_uri
-    @xrds = xrds
-  end
-
-  # Returns an Array Service objects sorted by priority.
-  def services
-    @xrds.services.each {|s| s.yadis = self}
-    @xrds.services
-  end
-
-  # Returns a list of services, ordered by priority,
-  # that match the filter. filter is a Proc object that produces
-  # ServiceEnpoint objects, subclasses of ServiceEnpoint or nil.
-  # This method is useful for extracting several types of services while
-  # maintaining priority, for example you may write a filter Proc to extract
-  # OpenID and LID ServiceEnpoint objects.
-  def filter_services(filter)
-    # product a list of filtered ServiceEndpoint objects.  filtered
-    # will contain a list of nil or ServiceEnpoint (subclasses) objects.
-    filtered = self.services.collect {|s| filter.call(s)}
-    
-    # return all object in filtered that are not nil
-    return filtered.find_all {|s| s}
-  end
-
-end