barx 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2007 Victor Grey and Kermit Snelson
+
+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

@@ -0,0 +1,11 @@
+The barx gem provides XRI resolution libraries for use in other applications.
+
+The basic API is as follows:
+  require 'barx'
+  xri = XriParser::AuthorityParser.parse(QXRI)
+  inputs = XriResolver::ParseInputParameters.new(params_hash)
+  xrds = XriResolver::AuthorityResolver.resolve(xri, inputs)
+  
+In the above example, QXRI refers to qxri as defined in section 7 of <http://www.oasis-open.org/committees/download.php/25741/xri-resolution-v2.0-wd-11-ed-06.pdf>, and params_hash is a Ruby hash of the keys and values in the Query String part of the QXRI or the relevant HTTP Accept header. 
+
+See examples/README for more information. There is also a full featured XRI proxy resolver, barx-proxy, available at <http://rubyforge.org/projects/barx/>. 

data/examples/README

@@ -0,0 +1,78 @@
+:::
+::: API Examples
+:::
+
+For a Ruby script to use the BARX API, the barx gem must first
+be installed. Consult http://www.rubygems.org for instructions.
+
+Once this is done, a Ruby application uses the API as follows:
+
+  require 'barx'
+
+  ap = XriParser::AuthorityParser.parse(xri)
+  ip = XriResolver::ParseInputParameters.new
+  ar = XriResolver::AuthorityResolver.resolve(ap, ip)
+
+This directory contains three examples of applications written
+using the BARX API which might also be of practical use.
+
+:::
+::: dix
+:::
+
+dix is a command-line XRI resolver inspired by the DNS/BIND
+utility "dig".
+
+Usage: dix [options] xri
+    -r, --resmed string              resolution media type
+    -t, --svctyp string              service type
+    -m, --medtyp string              service media type
+    -s, --doseps                     perform SEP resolution
+
+Examples:
+
+  dix =kermit
+  dix "=kermit*business"
+  dix --resmed application/xrds+xml =kermit
+  dix --doseps --resmed application/xrds+xml =kermit
+  dix -t http://openid.net/signon/1.0 -s "=kermit*business"
+
+:::
+::: proxri
+:::
+
+proxri is an XRI proxy resolver implemented as a CGI script.
+
+To install, simply copy it to Apache's cgi-bin directory and
+make it executable. A standard XRI proxy resolver interface
+can be made available to end users via Apache's mod_rewrite
+directives in the Web server's .htaccess file.
+
+For example, to make your proxy resolver available in a standard
+way as follows:
+
+http://xri.example.com/=kermit
+http://xri.example.com/=kermit?_xrd_r=application/xrds+xml [etc.]
+
+the .htaccess file at example.com could contain the following
+mod_rewrite directives:
+
+RewriteCond %{HTTP_HOST} ^xri\..*
+RewriteRule ^([=@].*)$ /cgi-bin/proxri?qxri=$1&%{QUERY_STRING}
+
+:::
+::: xrioid
+:::
+
+xrioid is a special XRI service that converts i-names into valid
+OpenIDs. They may be used to log in at any OpenID Relying Party,
+even if that site's OpenID libraries do not natively support XRI.
+
+It is an implementation of the OpenID Discovery Proxy Service idea
+proposed by Drummond Reed in June 2007 and described on the i-names
+Development Wiki:
+
+  http://dev.inames.net/wiki/OpenID_Discovery_Proxy_Service
+
+Like proxri, xrioid is implemented as a CGI script and may be
+installed in a similar way.

data/examples/dix

@@ -0,0 +1,47 @@
+#!/usr/local/bin/ruby
+
+require 'optparse'
+require 'barx'
+
+opts = Struct.new(:r, :t, :m, :sep).new
+
+op = OptionParser.new
+op.on("-r", "--resmed string", String, "resolution media type") { |val| opts.r = val }
+op.on("-t", "--svctyp string", String, "service type") { |val| opts.t = val }
+op.on("-m", "--medtyp string", String, "service media type") { |val| opts.m = val }
+op.on("-s", "--doseps", TrueClass, "perform SEP resolution") { |val| opts.sep = true }
+
+if op.parse(*ARGV).empty?
+  puts op.to_s
+  exit 1
+end
+
+xri = op.parse(*ARGV).first
+
+begin
+  ap = XriParser::AuthorityParser.parse(xri)
+
+  rp = XriResolver::ParseInputParameters.new
+  rp.resolution_media_type = opts.r
+  rp.service_type = opts.t
+  rp.service_media_type = opts.m
+  rp.sep = opts.sep
+
+  ar = XriResolver::AuthorityResolver.resolve(ap, rp)
+
+  case rp.resolution_media_type
+  when 'application/xrds+xml'
+    ar.to_xrds.write $stdout, indent=0; puts
+  when 'application/xrd+xml'
+    ar.last_xrd.write $stdout, indent=0; puts
+  else
+    unless ar.to_urilist.empty?
+      puts ar.to_urilist.join("\n") << "\n"
+    else
+      puts "no services selected for this XRI"
+    end
+  end
+
+rescue Exception => e
+  puts e.message
+end

data/examples/proxri

@@ -0,0 +1,41 @@
+#!/usr/local/bin/ruby
+
+require 'barx'
+
+cgi = CGI.new
+
+begin
+  pms = Hash.new; cgi.params.keys.each { |key| pms[key] = cgi.params[key].join.tr(' ', '+') }
+
+  ap = XriParser::AuthorityParser.parse(pms['qxri'])
+  ip = XriResolver::ParseInputParameters.new(pms, cgi.accept)
+  ar = XriResolver::AuthorityResolver.resolve(ap, ip)
+
+  unless ip.resolution_media_type.nil? or ip.resolution_media_type.empty?
+    case ip.resolution_media_type
+    when 'application/xrds+xml'
+      cgi.out(pms['demo'] ? 'application/xml' : ip.resolution_media_type) do
+        ar.to_s
+      end
+    when 'application/xrd+xml'
+      cgi.out(pms['demo'] ? 'application/xml' : ip.resolution_media_type) do
+        ar.last_xrd_doc.to_s
+      end
+    when 'text/uri-list'
+      cgi.out(pms['demo'] ? 'text/plain' : ip.resolution_media_type) do
+        ar.to_urilist.join("\n") << "\n"
+      end
+    else
+      cgi.out("text/plain") { "invalid media type" }
+    end
+  else
+    unless ar.to_urilist.empty?
+      cgi.out("Location" => ar.to_urilist.first) { ar.to_urilist.first }
+    else
+      cgi.out("text/plain") { "no services selected for this XRI" }
+    end
+  end
+
+rescue Exception => e
+  cgi.out("text/plain") { e.message }
+end

data/examples/xrioid

@@ -0,0 +1,66 @@
+#!/usr/local/bin/ruby
+
+require 'barx'
+
+cgi = CGI.new
+
+begin
+  ap = XriParser::AuthorityParser.parse(CGI.unescape(cgi.params['iname'].first))
+  ip = XriResolver::ParseInputParameters.new
+  ip.sep = true
+  ip.nodefault_t = true
+  ip.service_type = 'http://openid.net/signon/1.0'
+  ip.resolution_media_type = 'application/xrds+xml'
+  ar = XriResolver::AuthorityResolver.resolve(ap, ip)
+
+  if idp = ar.to_urilist.first
+    unless REXML::XPath.match(xrd = ar.last_xrd, "//*[local-name()='Delegate']").first
+      dlg = REXML::Element.new('openid:Delegate')
+      dlg.add_namespace('openid', 'http://openid.net/xmlns/1.0')
+      dlg.text = "xri://#{ap.authority}"
+      xrd.elements['Service'].add_element(dlg)
+    end
+  
+    xrds = ar.to_xrds.root.clone
+    xrds.add_element(xrd)
+  
+    oid = Struct.new(:xri, :dlg, :idp).new
+    oid.xri = ap.authority
+    oid.dlg = REXML::XPath.match(xrd, "//*[local-name()='Delegate']").first.text
+    oid.idp = idp
+  
+    if (cgi.accept and cgi.accept.include?('application/xrds+xml')) or ap.path == '/xrds'
+      cgi.out("application/xrds+xml") { xrds.to_s }
+    else
+      out = String.new
+      out << "<html>\n"
+      out << "<head>\n"
+      out << "<meta http-equiv=\"content-type\" content=\"text/html; charset=UTF-8\" />\n"
+      out << "<title>xri://#{oid.xri} OpenID</title>\n"
+      out << "<style type=\"text/css\">.variable {color: red}</style>\n"
+      out << "<link rel=\"openid.server\" href=\"#{oid.idp}\" />\n"
+      out << "<link rel=\"openid.delegate\" href=\"#{oid.dlg}\" />\n"
+      out << "<meta http-equiv=\"X-XRDS-Location\" content=\"http://#{cgi.server_name}/#{oid.xri}/xrds\" />\n"
+      out << "<meta http-equiv=\"X-Yadis-Location\" content=\"http://#{cgi.server_name}/#{oid.xri}/xrds\" />\n"
+      out << "</head>\n"
+      out << "<body>\n"
+      out << "<h2>Here is your XRI-powered OpenID!</h2>\n"
+      out << "<p>The URL of this page may be used to access the "
+      out << "<a href=\"http://openid.net\">OpenID</a> service configured "
+      out << "at <span class=\"variable\">xri://#{oid.xri}</span>.</p>\n"
+      out << "<p>Use it as your username on any Web sites that support "
+      out << "OpenID, including those that do not natively support the "
+      out << "<a href=\"http://xdi.org\">XRI</a> standard.</p>\n"
+      out << "<p><b>Identity Provider:</b> <span class=\"variable\">#{oid.idp}</span><br/>\n"
+      out << "<b>Claimed Identifier:</b> <span class=\"variable\">#{oid.dlg}</span></p>\n"
+      out << "</body>\n"
+      out << "</html>\n"
+      cgi.out("text/html") { out }
+    end
+  else
+    cgi.out("text/plain") { "no OpenID service configured at this XRI" }
+  end
+
+rescue Exception => e
+  cgi.out("text/plain") { e.message }
+end

data/lib/barx.rb

@@ -0,0 +1,9 @@
+require 'cgi'
+require 'yaml'
+require 'rexml/document'
+require 'uri'
+
+require File.dirname(__FILE__) + '/httpclient' ## make sure we get -our- httpclient
+require 'xri_parser'
+require 'xri_resolver'
+