barx 0.1.3 → 0.2.0

data/CHANGELOG

@@ -0,0 +1,27 @@
+0.2.0 April 1 2008
+  - The REXML stdlib in Ruby 1.8.6 deprecated Document#write but we still like it. Monkey-patched it back in as #simple_write.
+  
+  - XriParser::AuthorityParser
+     - Added #appendable_query which removes XRI control parameters (and our barxdemo param) from the returned query string, per XRI Resolution 2.0 CD 02 Section 11.3.3.
+     - We now assemble @qxri using #appendable_query.
+     - Fixed @path regex to handle multiple '?'s at beginning of query string.
+     - Added #to_hash method to provide parser output convertible to JSON.
+     - Added #to_xml method to provide parser output as XML.
+     
+  - XriResolver::AuthorityResolver
+      - Copied the CGI stdlib #escape and #unescape methods into AuthorityResolver, so we don't need to require CGI.
+      - Fixed all references to CGI.escape and CGI.unescape to use our local methods instead.
+      - Changed #build_xrds to add the XML prologue to the beginning of its output, and to strip out all return characters, giving a compact XML response.
+      - Added #to_pretty to return the XRDS as formatted XML using #simple_write.
+      - Added #last_xrd_to_s to return the last XRD as compact XML.
+      - Added #last_xrd_to_pretty to return the last XRD as formatted XML.
+      - Changed #doappend to use #appendable_query.
+      - We now rescue Cache.add exceptions.
+      
+  - Added CacheError class
+  
+  - XriResolver::ParseInputParameters#parse_query_params now removes any extra '?'s at beginning of query string.
+  
+  - Removed XriResolver::XRIRoot class, and replaced it with XriResolver::XRIAuthorities hash. It's now easy for an app, having required the barx gem, to use the Hash []= or delete methods on XriResolver::XRIAuthorities to modify the available XRI root authorities. 
+ 
+

data/MIT-LICENSE

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

data/README

@@ -9,3 +9,5 @@ The basic API is as follows:
 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/>. 
+
+Author contact information and more examples are available at <http://xrisoft.org>.

data/lib/barx.rb

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

data/lib/simple_write.rb

@@ -0,0 +1,16 @@
+## The REXML stdlib in Ruby 1.8.6 deprecated Document#write but we still like it.
+## So monkey-patching it back in as simple_write.
+## =vg
+module REXML
+  class Document
+		def simple_write( output=$stdout, indent=-1, transitive=false, ie_hack=false )
+			output = Output.new( output, xml_decl.encoding ) if xml_decl.encoding != "UTF-8" && !output.kind_of?(Output)
+			@children.each { |node|
+				indent( output, indent ) if node.node_type == :element
+				if node.write( output, indent, transitive, ie_hack )
+          output << "\n" unless indent<0 or node == @children[-1]
+        end
+			}
+		end
+  end
+end

data/lib/xri_parser.rb

@@ -8,7 +8,7 @@ module XriParser
       end
     end
     
-    attr_reader :root, :subsegments, :authority, :local, :query, :qxri
+    attr_reader :root, :subsegments, :authority, :local, :query, :appendable_query, :qxri
     attr_accessor :path
 
     def initialize(xri, get_root=true)
@@ -16,7 +16,6 @@ module XriParser
       @subsegments = Array.new
       xri = xri.strip rescue nil
       xri = xri_strip_scheme(xri) rescue nil
-      @qxri = xri
       raise 'No XRI Received' if xri.nil? or xri.empty?
       #get root
       if get_root
@@ -97,9 +96,12 @@ module XriParser
 
       @subsegments << segment_buf # flush buffer at the end
       @local = xri[@subsegments.to_s.length..-1] # the rest of xri
-      @path = @local.index('?') ? @local[/^(.*)\?/, 1] : @local # path is everything up to a question mark
+      @path = @local.index('?') ? @local[/^(.*?)\?/, 1] : @local # path is everything up to a question mark
       @query = @local.index('?') ? @local[/\?(.*)$/, 1] : '' # query is everything after a question mark
       @authority = self.normalized
+      @appendable_query = make_appendable_query(@query)
+      @qxri = "#{@authority}#{@path}"
+      @qxri << "?#{@appendable_query}" unless  @appendable_query.empty?
       true
     end
 
@@ -157,6 +159,49 @@ module XriParser
       end
     end
     
+    def make_appendable_query(query)
+      q = Array.new
+      #extract leading extra "?"s
+      if query =~ /^([\?]+)(.*)$/ 
+        q << $1 
+        query = $2
+      end
+      ## remove XRI control params (and our barxdemo param)
+      query.scan(/[^&]+/).each {|tok| q << tok unless tok =~ /^(barxdemo=|_xrd_r=|_xrd_t=|_xrd_m=)/}
+      q.to_s
+    end
+    
+    def to_hash
+      h = Hash.new
+      h[:authority] = @authority
+      h[:local] = @local
+      h[:path] = @path
+      h[:query] = @query
+      h[:qxri] = @qxri
+      h[:root] = @root
+      h[:subsegments] = @subsegments
+      h
+    end
+    
+    def to_xml
+      xml = %Q{<?xml version="1.0" encoding="UTF-8"?>}
+      xml << %Q{<parsed req="#{@qxri}">}
+      xml << %Q{<root>#{@root}</root>}
+      xml << %Q{<subsegments>}
+      @subsegments.each {|sub| xml << %Q{<subsegment>#{sub}</subsegment>} } 
+      xml << %Q{</subsegments>}
+    	xml << %Q{<authority>#{@authority}</authority>}
+    	xml << %Q{<local>#{@local}</local>}
+    	xml << %Q{<path>#{@path}</path>}
+    	xml << %Q{<query>#{@query}</query>}
+    	xml << %Q{<qxri>#{@qxri}</qxri>}
+    	xml << %Q{</parsed>}
+    	output = ""
+    	doc = REXML::Document.new(xml)
+    	doc.simple_write(output, 0)
+    	output
+    end
+    
   end
   
   class XRIRootMissing < RuntimeError; end

data/lib/xri_resolver.rb

@@ -2,14 +2,9 @@ module XriResolver
   XRDNS = {"xrd"=>"xri://$xrd*($v*2.0)"} # XRD xml namespace
   XRDType = "xri://$res*auth*($v*2.0)"
   
-  class XRIRoot
-    class <<self
-      def authorities
-        { "@"=>{:authority_uris=>["https://at.xri.net/", "http://at.xri.net/"], :verify_server_cert=>true},
-          "="=>{:authority_uris=>["https://equal.xri.net/", "http://equal.xri.net/"], :verify_server_cert=>true}}
-      end
-    end
-  end
+  ## default authorities -- add or remove from this Hash as desired
+  XRIAuthorities = { "@"=>{:authority_uris=>["https://at.xri.net/", "http://at.xri.net/"], :verify_server_cert=>true},
+                     "="=>{:authority_uris=>["https://equal.xri.net/", "http://equal.xri.net/"], :verify_server_cert=>true}}
   
   class AuthorityResolver
     ## usage: 
@@ -55,9 +50,9 @@ module XriResolver
         return
       end
       
-      raise UNKNOWN_ROOT, @xri.root unless Hash === XRIRoot.authorities[@xri.root]
+      raise UNKNOWN_ROOT, @xri.root unless Hash === XRIAuthorities[@xri.root]
       @client = HTTPClient.new
-      @client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE unless XRIRoot.authorities[@xri.root][:verify_server_cert]
+      @client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE unless XRIAuthorities[@xri.root][:verify_server_cert]
       @accept_header = 'application/xrds+xml'
       @accept_header << ';https=true' if @req.https
       
@@ -66,7 +61,7 @@ module XriResolver
       @status_code = String.new ## status code of the last resolved subsegment
       subsegments_resolved = 0
       
-      @authority_uris = XRIRoot.authorities[@xri.root][:authority_uris].map {|u| URI.parse(u)}
+      @authority_uris = XRIAuthorities[@xri.root][:authority_uris].map {|u| URI.parse(u)}
 
       errorcode = '220'
       errortext = ResponseStatus[errorcode]
@@ -110,7 +105,7 @@ module XriResolver
         sts.add_attribute('code', errorcode)
         sts.text = errortext
         qry = REXML::Element.new('Query')
-        qry.text = CGI.unescape(@xri.subsegments[subsegments_resolved]).unpack('C*').pack('U*')
+        qry.text = unescape(@xri.subsegments[subsegments_resolved]).unpack('C*').pack('U*')
         xrd = REXML::Element.new('XRD')
         xrd << qry
         xrd << sts
@@ -126,13 +121,20 @@ module XriResolver
     end
     
     def resolved_successfully?
-      @resolved == CGI.unescape(@xri.fully_qualified) and @status_code === '100'
+      @resolved == unescape(@xri.fully_qualified) and @status_code === '100'
     end
     
     def to_s
       build_xrds(@xrd_array)
     end
     
+    def	to_pretty
+    	output = ""
+    	doc = REXML::Document.new(self.to_s)
+    	doc.simple_write(output, 0) ## REXML::Document monkey-patched with simple_write at bottom of this file
+    	output
+    end
+    
     def to_xrds
       REXML::Document.new(self.to_s)
     end
@@ -149,6 +151,17 @@ module XriResolver
       REXML::Document.new(self.last_xrd.to_s.unpack('U*').pack('C*'))
     end
     
+    def last_xrd_to_s
+      %Q{<?xml version='1.0' encoding='UTF-8'?>#{last_xrd.to_s.unpack('U*').pack('C*').gsub(/\n/, '')}}
+    end
+    
+    def last_xrd_to_pretty
+      output = ""
+    	doc = REXML::Document.new(last_xrd_to_s)
+    	doc.simple_write(output, 0)
+    	output
+    end
+    
     def doappend(uri, inplace=nil)
       uri_txt = uri.text
       uri_app = uri.attribute('append').value rescue 'none'
@@ -166,7 +179,7 @@ module XriResolver
       when 'path'
         uri_txt << @xri.path
       when 'query'
-        uri_txt << @xri.query
+        uri_txt << @xri.appendable_query
       when 'qxri'
         uri_txt << @xri.qxri
       end
@@ -252,8 +265,8 @@ module XriResolver
       begin
         uri = @authority_uris.shift
         uri.path << '/'
-        if subsegment[1..-1] == CGI.unescape(subsegment[1..-1])
-          hxri = uri.merge("#{subsegment[0,1]}#{CGI.escape(subsegment[1..-1])}")
+        if subsegment[1..-1] == unescape(subsegment[1..-1])
+          hxri = uri.merge("#{subsegment[0,1]}#{escape(subsegment[1..-1])}")
         else
           hxri = uri.merge(subsegment)
         end
@@ -263,7 +276,7 @@ module XriResolver
         unless @authority_uris.empty?
           retry
         else
-          raise XRIResolutionFailure, "Unable to resolve #{subsegment} because: #{e.message}"
+          raise XRIResolutionFailure, "Unable to resolve #{subsegment} because: #{e.class}: #{e.message}"
         end
       end
       
@@ -308,7 +321,11 @@ module XriResolver
         exp = Time.now.to_i + 3600
       end
       key = hxri.host + hxri.path + @accept_header
-      Cache.add(key, xml, exp)
+      begin
+        Cache.add(key, xml, exp)
+      rescue Exception => e
+        raise CacheError, e.message
+      end
     end
     
     def get_header_exp(hdr)
@@ -339,8 +356,8 @@ module XriResolver
     end
     
     def build_xrds(xrd_array)
-      xrds = %Q{<XRDS xmlns="xri://$xrds" ref="xri://#{CGI.unescape(@xri.normalized)}">\n}
-      xrd_array.each {|xrd| xrds << "#{xrd.to_s.unpack('U*').pack('C*')}\n" }
+      xrds = %Q{<?xml version='1.0' encoding='UTF-8'?><XRDS xmlns="xri://$xrds" ref="xri://#{unescape(@xri.normalized)}">}
+      xrd_array.each {|xrd| xrds << xrd.to_s.unpack('U*').pack('C*').gsub(/\n/, '')}
       xrds << "</XRDS>"
     end
     
@@ -632,6 +649,19 @@ module XriResolver
       @xrd_array << seplist.to_xrd
       @xrd_array << chosenxrds if chosenxrds
     end
+    
+    # from CGI.escape and CGI.unescape
+    def escape(str)
+      str.gsub(/([^ a-zA-Z0-9_.-]+)/n) {
+  	'%' + $1.unpack('H2' * $1.size).join('%').upcase
+      }.tr(' ', '+')
+    end
+    
+    def unescape(string)
+      string.tr('+', ' ').gsub(/((?:%[0-9a-fA-F]{2})+)/n) do
+        [$1.delete('%')].pack('H*')
+      end
+    end
   end
 
   ResponseStatus = {
@@ -674,6 +704,7 @@ module XriResolver
   class XRIResolutionFailure < RuntimeError; end
   class INVALID_XRDS < XRIResolutionFailure; end
   class UNKNOWN_ROOT < XRIResolutionFailure; end
+  class CacheError < RuntimeError; end
 
   class SEPSelector
     ## usage: 
@@ -1006,6 +1037,13 @@ module XriResolver
     end
     
     def parse_query_params(params)
+      ## remove any extra leading "?"s
+      params.each do |k,v|
+        if k =~ /^[\?]+(.*)$/
+          params.delete(k)
+          params[$1] = v
+        end
+      end
       inputs = {:res_media_type => ""}
       ## get Resolution Media type
       if params.has_key?(:_xrd_r)
@@ -1099,4 +1137,5 @@ module XriResolver
       (x.to_i == y.to_i) ? (rand(3) - 1) : (x.to_i <=> y.to_i)
     end
   end
+  
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.4
 specification_version: 1
 name: barx
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
-date: 2007-11-06 00:00:00 +00:00
+  version: 0.2.0
+date: 2008-04-04 00:00:00 -07:00
 summary: Provides XRI resolution services. Read more about XRI resolution at http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=xri.
 require_paths: 
 - lib
@@ -29,35 +29,37 @@ post_install_message:
 authors: 
 - Victor Grey and Kermit Snelson
 files: 
-- test
-- lib
 - bin
+- CHANGELOG
 - examples
+- lib
 - MIT-LICENSE
 - README
+- test
+- lib/barx.rb
 - lib/httpclient
-- lib/httpclient/cacert.p7s
-- lib/httpclient/http.rb
-- lib/httpclient/cookie.rb
 - lib/httpclient.rb
+- lib/simple_write.rb
 - lib/xri_parser.rb
 - lib/xri_resolver.rb
-- lib/barx.rb
+- lib/httpclient/cacert.p7s
+- lib/httpclient/cookie.rb
+- lib/httpclient/http.rb
+- test/authority_parser_profile.rb
+- test/test_helper.rb
 - test/unit
+- test/xrds_sources
 - test/unit/all.rb
-- test/unit/multi_stage_resolution_test.rb
 - test/unit/authority_parser_test.rb
 - test/unit/input_param_parser_test.rb
+- test/unit/multi_stage_resolution_test.rb
 - test/unit/sep_selection_test.rb
-- test/xrds_sources
-- test/xrds_sources/second_stage1
-- test/xrds_sources/sep1
-- test/xrds_sources/empty_sels_sep
 - test/xrds_sources/empty_sels_no_append_qxri_sep
+- test/xrds_sources/empty_sels_sep
 - test/xrds_sources/first_stage1
 - test/xrds_sources/no_svc_sep
-- test/test_helper.rb
-- test/authority_parser_profile.rb
+- test/xrds_sources/second_stage1
+- test/xrds_sources/sep1
 - examples/proxri
 - examples/README
 - examples/xrioid