xrd 0.1.0

data/lib/xrd/resource_descriptor.rb

@@ -0,0 +1,122 @@
+require 'time'
+require 'sax-machine'
+require 'addressable/uri'
+require 'httpadapter'
+require 'httpadapter/adapters/net_http'
+require 'xrd/properties'
+require 'xrd/link'
+
+module XRD
+  NAMESPACE = 'http://docs.oasis-open.org/ns/xri/xrd-1.0'
+
+  class ResourceDescriptor
+    include SAXMachine
+    include XRD::Properties
+
+    element "XRD", :as => :xml_id, :value => "xml:id"
+    element "Expires", :as => :expires
+    element "Subject", :as => :subject
+    elements "Alias", :as => :aliases
+    elements "Link", :as => :links, :class => XRD::Link
+
+    remove_method :expires, :expires=
+    remove_method :subject, :subject=
+    remove_method :aliases, :add_aliases
+    remove_method :links
+
+    def self.fetch_and_parse(
+        uri, adapter=HTTPAdapter::NetHTTPRequestAdapter, connection=nil)
+      resource_descriptor = XRD::ResourceDescriptor.new
+      resource_descriptor.base_uri = uri
+      request = [
+        'GET', resource_descriptor.base_uri.to_str,
+        [['Accept', 'application/xrd+xml,application/xml;q=0.9,*/*;q=0.9']],
+        ['']
+      ]
+      response = HTTPAdapter.transmit(request, adapter, connection)
+      status, headers, body = response
+      xrd_content = ""
+      body.each do |chunk|
+        xrd_content += chunk
+      end
+      return self.parse(xrd_content)
+    end
+
+    def base_uri
+      return @base_uri ||= nil
+    end
+
+    def base_uri=(new_base_uri)
+      @base_uri = Addressable::URI.parse(new_base_uri)
+    end
+
+    attr_reader :expires
+
+    def expires=(new_expires)
+      if new_expires.kind_of?(Time)
+        @expires = new_expires
+      else
+        @expires = Time.parse(new_expires.to_s)
+      end
+    end
+
+    attr_reader :subject
+
+    def subject=(new_subject)
+      @subject = Addressable::URI.parse(new_subject)
+    end
+
+    def aliases
+      return @aliases ||= []
+    end
+
+    def add_aliases(new_alias)
+      return self.aliases << Addressable::URI.parse(new_alias)
+    end
+
+    def links(query={})
+      @links ||= []
+      if query.empty?
+        return @links
+      else
+        result_set = []
+        for link in @links
+          matched = query.all? do |field, condition|
+            case field
+            when :rel
+              condition === link.rel
+            when :media_type, :type
+              if link.media_type.kind_of?(String) &&
+                  !condition.include?('/')
+                link.media_type.to_s.index(condition) == 0
+              else
+                condition === link.media_type
+              end
+            when :href, :uri
+              if condition.respond_to?(:match)
+                condition.match(link.href)
+              else
+                condition === link.href
+              end
+            end
+          end
+          result_set << link if matched
+        end
+        return result_set
+      end
+    end
+
+    ##
+    # Returns a <code>String</code> representation of the resource descriptor
+    # object's state.
+    #
+    # @return [String]
+    #   The resource descriptor object's state, as a <code>String</code>.
+    def inspect
+      sprintf(
+        "#<%s:%#0x SUBJECT:%s>",
+        self.class.to_s, self.object_id, self.subject
+      )
+    end
+  end
+end

data/lib/xrd/title.rb

@@ -0,0 +1,18 @@
+require 'sax-machine'
+
+module XRD
+  class Title < String
+    include SAXMachine
+
+    element 'Title', :as => :title
+    element 'Title', :as => :lang, :value => 'xml:lang'
+
+    remove_method :title, :title=
+
+  protected
+    def title=(new_title)
+      # Replace self with new title
+      self[0..-1] = new_title
+    end
+  end
+end

data/lib/xrd/version.rb

@@ -0,0 +1,26 @@
+# Copyright 2010 Google, Inc.
+# 
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+# 
+#        http://www.apache.org/licenses/LICENSE-2.0
+# 
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# Used to prevent the class/module from being loaded more than once
+unless defined? XRD::VERSION
+  module XRD
+    module VERSION
+      MAJOR = 0
+      MINOR = 1
+      TINY  = 0
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# Copyright 2010 Google, Inc.
+# 
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+# 
+#        http://www.apache.org/licenses/LICENSE-2.0
+# 
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+spec_dir = File.expand_path(File.dirname(__FILE__))
+lib_dir = File.expand_path(File.join(spec_dir, '../lib'))
+
+$:.unshift(lib_dir)
+$:.uniq!
+
+require 'xrd'

data/spec/xrd/link_spec.rb

@@ -0,0 +1,111 @@
+# Copyright (C) 2010 Google Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'spec_helper'
+
+require 'xrd/link'
+
+describe XRD::Link do
+  describe 'when attempting to parse an XRD document' do
+    describe 'with a Link element containing an auth link' do
+      before do
+        @xml = <<-XML
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+  <Link rel="http://spec.example.net/auth/1.0"
+        href="http://services.example.com/auth" />
+</XRD>
+        XML
+        @xrd = XRD::ResourceDescriptor.parse(@xml)
+      end
+
+      it 'should return the correct rel value' do
+        @xrd.links.first.rel.should == 'http://spec.example.net/auth/1.0'
+      end
+
+      it 'should return the correct href value' do
+        @xrd.links.first.href.should == 'http://services.example.com/auth'
+      end
+
+      it 'should be inspectable' do
+        @xrd.links.first.inspect.should be_kind_of(String)
+        @xrd.links.first.inspect.should include(
+          'http://services.example.com/auth'
+        )
+      end
+    end
+
+    describe 'with a Link element containing an image link' do
+      before do
+        @xml = <<-XML
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+  <Link rel="http://spec.example.net/photo/1.0" type="image/jpeg"
+        href="http://photos.example.com/gpburdell.jpg">
+</XRD>
+        XML
+        @xrd = XRD::ResourceDescriptor.parse(@xml)
+      end
+
+      it 'should return the correct rel value' do
+        @xrd.links.first.rel.should == 'http://spec.example.net/photo/1.0'
+      end
+
+      it 'should return the correct media type value' do
+        @xrd.links.first.media_type.should == 'image/jpeg'
+      end
+
+      it 'should return the correct href value' do
+        @xrd.links.first.href.should ==
+          'http://photos.example.com/gpburdell.jpg'
+      end
+
+      it 'should be inspectable' do
+        @xrd.links.first.inspect.should be_kind_of(String)
+        @xrd.links.first.inspect.should include(
+          'http://photos.example.com/gpburdell.jpg'
+        )
+      end
+    end
+
+    describe 'with a Link element containing a template value' do
+      before do
+        @xml = <<-XML
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+  <Link type="text/html"
+        template="http://people.example.com/{user}">
+</XRD>
+        XML
+        @xrd = XRD::ResourceDescriptor.parse(@xml)
+      end
+
+      it 'should return the correct media type value' do
+        @xrd.links.first.media_type.should == 'text/html'
+      end
+
+      it 'should return the correct href value' do
+        @xrd.links.first.href.should == nil
+      end
+
+      it 'should return the correct template value' do
+        @xrd.links.first.template.should == 'http://people.example.com/{user}'
+      end
+
+      it 'should be inspectable' do
+        @xrd.links.first.inspect.should be_kind_of(String)
+        @xrd.links.first.inspect.should include(
+          'http://people.example.com/{user}'
+        )
+      end
+    end
+  end
+end

data/spec/xrd/xrd_spec.rb

@@ -0,0 +1,431 @@
+# Copyright (C) 2010 Google Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'spec_helper'
+
+require 'httpadapter/adapters/mock'
+require 'addressable/uri'
+require 'addressable/template'
+
+require 'xrd'
+
+describe XRD::ResourceDescriptor do
+  describe 'with an initialized resource descriptor' do
+    before do
+      @xrd = XRD::ResourceDescriptor.new
+    end
+
+    it 'should allow expiration dates to be set to Time objects' do
+      now = Time.now
+      @xrd.expires = now
+      @xrd.expires.should == now
+    end
+
+    it 'should allow expiration dates to be set to String objects' do
+      now = Time.now
+      @xrd.expires = now.to_s
+      @xrd.expires.to_s.should == now.to_s
+    end
+
+    it 'should allow subject values to be set to URI objects' do
+      @xrd.subject = Addressable::URI.parse('http://example.com/subject')
+      @xrd.subject.should == Addressable::URI.parse(
+        'http://example.com/subject'
+      )
+    end
+
+    it 'should allow subject values to be set to String objects' do
+      @xrd.subject = 'http://example.com/subject'
+      @xrd.subject.should == Addressable::URI.parse(
+        'http://example.com/subject'
+      )
+    end
+
+    it 'should not allow direct access to the property_keys' do
+      (lambda do
+        @xrd.property_keys
+      end).should raise_error(NoMethodError)
+      (lambda do
+        @xrd.property_keys = []
+      end).should raise_error(NoMethodError)
+    end
+
+    it 'should not allow direct access to the property_values' do
+      (lambda do
+        @xrd.property_values
+      end).should raise_error(NoMethodError)
+      (lambda do
+        @xrd.property_values = []
+      end).should raise_error(NoMethodError)
+    end
+
+    it 'should be inspectable' do
+      @xrd.inspect.should be_kind_of(String)
+    end
+  end
+
+  describe 'when attempting to parse an empty XRD document' do
+    before do
+      @xml = <<-XML
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+</XRD>
+      XML
+      @xrd = XRD::ResourceDescriptor.parse(@xml)
+    end
+
+    it 'should return a blank resource descriptor' do
+      @xrd.xml_id.should == nil
+      @xrd.expires.should == nil
+      @xrd.subject.should == nil
+      @xrd.aliases.should == []
+      @xrd.properties.should == []
+      @xrd.links.should == []
+    end
+  end
+
+  describe 'when attempting to parse an XRD document with an id' do
+    before do
+      @xml = <<-XML
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0" xml:id="identifier">
+</XRD>
+      XML
+      @xrd = XRD::ResourceDescriptor.parse(@xml)
+    end
+
+    it 'should return the correct id' do
+      @xrd.xml_id.should == "identifier"
+    end
+  end
+
+  describe 'when attempting to parse an XRD document with an Expires value' do
+    before do
+      @xml = <<-XML
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+  <Expires>1970-01-01T00:00:00Z</Expires>
+</XRD>
+      XML
+      @xrd = XRD::ResourceDescriptor.parse(@xml)
+    end
+
+    it 'should return the correct expiration date' do
+      @xrd.expires.should == Time.gm(1970)
+    end
+  end
+
+  describe 'when attempting to parse an XRD document with a Subject value' do
+    before do
+      @xml = <<-XML
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+  <Subject>http://example.com/subject</Expires>
+</XRD>
+      XML
+      @xrd = XRD::ResourceDescriptor.parse(@xml)
+    end
+
+    it 'should return the correct subject' do
+      @xrd.subject.to_str.should == 'http://example.com/subject'
+    end
+
+    it 'should return a parsed subject URI' do
+      @xrd.subject.should be_kind_of(Addressable::URI)
+    end
+
+    it 'should be inspectable' do
+      @xrd.inspect.should be_kind_of(String)
+      @xrd.inspect.should include('http://example.com/subject')
+    end
+  end
+
+  describe 'when attempting to parse an XRD document with Alias values' do
+    before do
+      @xml = <<-XML
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+  <Alias>http://people.example.com/subject</Alias>
+  <Alias>acct:subject@example.com</Alias>
+</XRD>
+      XML
+      @xrd = XRD::ResourceDescriptor.parse(@xml)
+    end
+
+    it 'should return the correct aliases' do
+      (@xrd.aliases.map { |a| a.to_str }).should include(
+        'http://people.example.com/subject'
+      )
+      (@xrd.aliases.map { |a| a.to_str }).should include(
+        'acct:subject@example.com'
+      )
+    end
+
+    it 'should return parsed alias URIs' do
+      @xrd.aliases.each do |a|
+        a.should be_kind_of(Addressable::URI)
+      end
+    end
+  end
+
+  describe 'when attempting to parse an XRD document with Property values' do
+    before do
+      @xml = <<-XML
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+  <Property type="http://spec.example.net/version">1.0</Property>
+  <Property type="http://spec.example.net/version">2.0</Property>
+</XRD>
+      XML
+      @xrd = XRD::ResourceDescriptor.parse(@xml)
+    end
+
+    it 'should return the correct properties' do
+      (@xrd.properties.map { |k, v| [k.to_str, v] }).should include(
+        ['http://spec.example.net/version', '1.0']
+      )
+      (@xrd.properties.map { |k, v| [k.to_str, v] }).should include(
+        ['http://spec.example.net/version', '2.0']
+      )
+    end
+
+    it 'should return parsed property key URIs' do
+      @xrd.properties.each do |k, v|
+        k.should be_kind_of(Addressable::URI)
+        v.should be_kind_of(String)
+      end
+    end
+  end
+
+  shared_examples_for 'simple XRD example' do
+    it 'should return the correct expiration date' do
+      @xrd.expires.should == Time.gm(1970)
+    end
+
+    it 'should return the correct subject' do
+      @xrd.subject.to_str.should == 'http://example.com/subject'
+    end
+
+    it 'should return a parsed subject URI' do
+      @xrd.subject.should be_kind_of(Addressable::URI)
+    end
+
+    it 'should return the correct properties' do
+      (@xrd.properties.map { |k, v| [k.to_str, v] }).should include(
+        ['http://spec.example.net/type/person', nil]
+      )
+    end
+
+    it 'should return parsed property key URIs' do
+      @xrd.properties.each do |k, v|
+        k.should be_kind_of(Addressable::URI)
+        v.should be_kind_of(NilClass)
+      end
+    end
+
+    it 'should return the correct links' do
+      @xrd.links[0].rel.should == 'http://spec.example.net/auth/1.0'
+      @xrd.links[0].href.should == 'http://services.example.com/auth'
+      @xrd.links[1].rel.should == 'http://spec.example.net/photo/1.0'
+      @xrd.links[1].media_type.should == 'image/jpeg'
+      @xrd.links[1].href.should == 'http://photos.example.com/gpburdell.jpg'
+    end
+
+    it 'should return the correct link titles' do
+      @xrd.links[1].title.should == 'User Photo'
+      @xrd.links[1].title('en').should == 'User Photo'
+      @xrd.links[1].title('de').should == 'Benutzerfoto'
+
+      @xrd.links[1].title.lang.should == 'en'
+      @xrd.links[1].title('en').lang.should == 'en'
+      @xrd.links[1].title('de').lang.should == 'de'
+    end
+
+    it 'should return the correct link properties' do
+      @xrd.links[1].properties[0][0].should ===
+        'http://spec.example.net/created/1.0'
+      @xrd.links[1].properties[0][1].should == '1970-01-01'
+    end
+
+    it 'should allow links to be queried by rel value' do
+      links = @xrd.links(:rel => 'http://spec.example.net/auth/1.0')
+      links.length.should == 1
+      links[0].rel.should == 'http://spec.example.net/auth/1.0'
+    end
+
+    it 'should allow links to be queried by rel value' do
+      links = @xrd.links(:rel => 'alternate')
+      links.length.should == 0
+    end
+
+    it 'should allow links to be queried by media type' do
+      links = @xrd.links(:media_type => 'image/jpeg')
+      links.length.should == 1
+      links[0].media_type.should == 'image/jpeg'
+    end
+
+    it 'should allow links to be queried by media type' do
+      links = @xrd.links(:media_type => 'text/html')
+      links.length.should == 0
+    end
+
+    it 'should allow links to be queried by media type' do
+      links = @xrd.links(:media_type => 'image')
+      links.length.should == 1
+      links[0].media_type.should == 'image/jpeg'
+    end
+
+    it 'should allow links to be queried by media type' do
+      links = @xrd.links(:media_type => 'text')
+      links.length.should == 0
+    end
+
+    it 'should allow links to be queried by href' do
+      links = @xrd.links(:href => 'http://services.example.com/auth')
+      links.length.should == 1
+      links[0].href.should == 'http://services.example.com/auth'
+    end
+
+    it 'should allow links to be queried by href' do
+      links = @xrd.links(:href => 'http://www.example.org/')
+      links.length.should == 0
+    end
+
+    it 'should allow links to be queried by href' do
+      links = @xrd.links(
+        :href => Addressable::URI.parse('http://services.example.com/auth')
+      )
+      links.length.should == 1
+      links[0].href.should == 'http://services.example.com/auth'
+    end
+
+    it 'should allow links to be queried by href' do
+      links = @xrd.links(
+        :href => Addressable::URI.parse('http://www.example.org/')
+      )
+      links.length.should == 0
+    end
+
+    it 'should allow links to be queried by href' do
+      links = @xrd.links(:href => /services\.example\.com/)
+      links.length.should == 1
+      links[0].href.should == 'http://services.example.com/auth'
+    end
+
+    it 'should allow links to be queried by href' do
+      links = @xrd.links(:href => /www\.example\.org/)
+      links.length.should == 0
+    end
+
+    it 'should allow links to be queried by href' do
+      links = @xrd.links(
+        :href => Addressable::Template.new('http://{sub}.example.com/{path}')
+      )
+      links.length.should == 2
+      links[0].href.should == 'http://services.example.com/auth'
+      links[1].href.should == 'http://photos.example.com/gpburdell.jpg'
+    end
+
+    it 'should allow links to be queried by href' do
+      links = @xrd.links(
+        :href => Addressable::Template.new('http://www.example.org/{path}')
+      )
+      links.length.should == 0
+    end
+  end
+
+  describe 'when attempting to fetch and parse an XRD document' do
+    before do
+      @xml = <<-XML
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <Expires>1970-01-01T00:00:00Z</Expires>
+  <Subject>http://example.com/subject</Subject>
+  <Property type="http://spec.example.net/type/person" xsi:nil="true" />
+  <Link rel="http://spec.example.net/auth/1.0"
+    href="http://services.example.com/auth" />
+  <Link rel="http://spec.example.net/photo/1.0" type="image/jpeg"
+    href="http://photos.example.com/gpburdell.jpg">
+    <Title xml:lang="en">User Photo</Title>
+    <Title xml:lang="de">Benutzerfoto</Title>
+    <Property type="http://spec.example.net/created/1.0">1970-01-01</Property>
+  </Link>
+</XRD>
+      XML
+      @adapter = HTTPAdapter::MockAdapter.request_adapter do |request, conn|
+        [
+          200,
+          [['Content-Type', 'application/xrd+xml']],
+          [@xml],
+        ]
+      end
+      @xrd = XRD::ResourceDescriptor.fetch_and_parse(
+        'http://example.com/xrd', @adapter
+      )
+    end
+
+    it_should_behave_like 'simple XRD example'
+  end
+
+  describe 'when attempting to fetch and parse an XRD document' do
+    before do
+      @xml = <<-XML
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <Expires>1970-01-01T00:00:00Z</Expires>
+  <Subject>http://example.com/subject</Subject>
+  <Property type="http://spec.example.net/type/person" xsi:nil="true" />
+  <Link rel="http://spec.example.net/auth/1.0"
+    href="http://services.example.com/auth" />
+  <Link rel="http://spec.example.net/photo/1.0" type="image/jpeg"
+    href="http://photos.example.com/gpburdell.jpg">
+    <Title xml:lang="en">User Photo</Title>
+    <Title xml:lang="de">Benutzerfoto</Title>
+    <Property type="http://spec.example.net/created/1.0">1970-01-01</Property>
+  </Link>
+</XRD>
+      XML
+      @adapter = HTTPAdapter::MockAdapter.request_adapter do |request, conn|
+        [
+          200,
+          [['Content-Type', 'application/xrd+xml']],
+          [@xml],
+        ]
+      end
+      @xrd = XRD.fetch_and_parse('http://example.com/xrd', @adapter)
+    end
+
+    it_should_behave_like 'simple XRD example'
+  end
+
+  describe 'when attempting to parse an XRD document with no title lang' do
+    before do
+      @xml = <<-XML
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <Link rel="http://spec.example.net/photo/1.0" type="image/jpeg"
+    href="http://photos.example.com/gpburdell.jpg">
+    <Title>User Photo</Title>
+    <Title xml:lang="de">Benutzerfoto</Title>
+  </Link>
+</XRD>
+      XML
+      @xrd = XRD.parse(@xml)
+    end
+
+    it 'should return the correct link titles' do
+      @xrd.links[0].title.should == 'User Photo'
+      @xrd.links[0].title('en').should == 'User Photo'
+      @xrd.links[0].title('de').should == 'Benutzerfoto'
+
+      @xrd.links[0].title.lang.should == nil
+      @xrd.links[0].title('en').lang.should == nil
+      @xrd.links[0].title('de').lang.should == 'de'
+    end
+  end
+end