discodactyl 0.3.0

data/test/test_uri_template.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby -w
+libdir = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require "test/unit"
+require "discodactyl/uri_template"
+
+class TestURITemplate < Test::Unit::TestCase
+  def test_render_encode_uri
+    t = Discodactyl::URITemplate.new('http://example.org?q={uri}')
+    assert_equal('http://example.org?q=http%3A%2F%2Fexample.com%2Fr%3Ff%3D1', t.to_uri('uri' => URI.parse('http://example.com/r?f=1')))
+  end
+  # from http://tools.ietf.org/html/draft-hammer-hostmeta-05#section-3.2.1
+  def test_render_encode
+    t = Discodactyl::URITemplate.new('http://example.org?q={uri}')
+    assert_equal('http://example.org?q=http%3A%2F%2Fexample.com%2Fr%3Ff%3D1', t.to_uri('uri' => 'http://example.com/r?f=1'))
+  end
+  def test_render_single
+    t = Discodactyl::URITemplate.new('http://host.example/{%id}')
+    assert_equal('http://host.example/test', t.to_uri('id' => 'test'))
+  end
+
+  def test_render_many
+    t = Discodactyl::URITemplate.new('http://host.example/{%id}/{%name}')
+    assert_equal('http://host.example/test/bob', t.to_uri('id' => 'test', 'name' => 'bob'))
+  end
+
+  def test_equivalence
+    pattern = 'http://host.example/{%id}'
+    assert_equal(Discodactyl::URITemplate.new(pattern), Discodactyl::URITemplate.new(pattern))
+  end
+end

data/test/test_xrd_append.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby -w
+libdir = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+testdir = File.expand_path('../../test', __FILE__)
+$LOAD_PATH.unshift(testdir) unless $LOAD_PATH.include?(testdir)
+
+require 'test_helper'
+require 'discodactyl/xrd/document'
+
+module Discodactyl
+class XRDTestCase < ::Test::Unit::TestCase   #:nodoc:
+  # Placeholder so test/unit ignores test cases without any tests.
+  def default_test
+  end
+  def setup
+    @full_xrd_string =<<eos
+<?xml version=\"1.0\"?>
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+  <Subject>http://host.example/</Subject>
+  <Link rel="webfinger" href="http://host.example/endpoint"/>
+  <Link rel="describedby" href="http://host.example/endpoint"/>
+  <Link rel="feed" template="http://host.example/descriptor?q={%id}"/>
+  <Link rel="describedby" template="http://host.example/descriptor?q={%id}"/>
+</XRD>
+eos
+
+    @xrd = Discodactyl::XRD::Document.parse(@full_xrd_string)
+  end
+end
+end
+
+class TestXRDAppendWithId < Discodactyl::XRDTestCase
+  def setup
+    super
+    @raw_link = '<Link xml:id="foo" rel="http://oexchange.org/spec/0.8/rel/user-target" type="application/xrd+xml" href="http://www.example.com/linkeater/oexchange.xrd"/>'    
+    @link = @xrd.append(@raw_link)
+  end
+
+  def test_append_with_id_does_not_overwrite
+    assert_equal @raw_link, @link.to_s
+  end
+
+  def test_append_generates_id_on_duplicate
+    second = @xrd.append(@raw_link)
+    assert_not_equal @link.id, second.id
+  end
+end
+
+class TestXRDAppendWithoutID < Discodactyl::XRDTestCase
+  def setup
+    super
+    @raw_link = '<Link rel="http://oexchange.org/spec/0.8/rel/user-target" type="application/xrd+xml" href="http://www.example.com/linkeater/oexchange.xrd"/>'
+    @link = @xrd.append(@raw_link)
+  end
+
+  def test_inserts_link_in_raw
+    assert_include? @link.raw, @xrd.raw.search('//xrd:Link', Discodactyl::XRD::XMLNS)
+  end
+
+  def test_append_preserves_rel
+    assert_equal 'http://oexchange.org/spec/0.8/rel/user-target', @link.rel
+  end
+
+  def test_append_preserves_attributes
+    assert_equal 'http://oexchange.org/spec/0.8/rel/user-target', @link.rel
+    assert_equal 'application/xrd+xml', @link.type
+    assert_equal 'http://www.example.com/linkeater/oexchange.xrd', @link.href
+  end
+
+  def test_append_preserves_attributes
+    assert_equal 'http://oexchange.org/spec/0.8/rel/user-target', @link.rel
+    assert_equal 'application/xrd+xml', @link.type
+    assert_equal 'http://www.example.com/linkeater/oexchange.xrd', @link.href
+  end
+
+  def test_inserts_link
+    assert_include? @link, @xrd.links
+  end
+
+  def test_generates_id
+    assert_not_nil @link.id
+    assert !@link.id.empty?
+  end
+
+  def test_can_find_appended_link_by_returned_link_id
+    actual = @xrd.find_link_by_id(@link.id)
+
+    assert_equal 'http://oexchange.org/spec/0.8/rel/user-target', actual.rel
+    assert_equal 'application/xrd+xml', actual.type
+    assert_equal 'http://www.example.com/linkeater/oexchange.xrd', actual.href
+  end
+end
+

data/test/test_xrd_link_parse.rb

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby -w
+libdir = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require "test/unit"
+require "discodactyl/xrd"
+require "discodactyl/uri_template"
+
+class TestXRDLinkParsing < Test::Unit::TestCase
+  def test_parse_all
+    raw = '<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0"><Link rel="lrdd" type="text/html" href="http://host.example" template="http://www.google.com/s2/webfinger/?q={%id}"/></XRD>'
+    elem = Nokogiri(raw).xpath('/xrd:XRD/xrd:Link', Discodactyl::XRD::XMLNS).first
+
+    link = Discodactyl::XRD::Link.parse(elem)
+
+    assert_equal 'lrdd', link.rel
+    assert_equal 'text/html', link.type
+    assert_equal 'http://host.example', link.href
+    assert_nil link.template
+  end
+
+  def test_parse_empty
+    raw = '<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0"><Link></Link></XRD>'
+    elem = Nokogiri(raw).xpath('/xrd:XRD/xrd:Link', Discodactyl::XRD::XMLNS).first
+
+    link = Discodactyl::XRD::Link.parse(elem)
+
+    assert_not_nil(link)
+  end
+
+  def test_parse_rel
+    raw = '<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0"><Link rel="lrdd"/></XRD>'
+    elem = Nokogiri(raw).xpath('/xrd:XRD/xrd:Link', Discodactyl::XRD::XMLNS).first
+
+    link = Discodactyl::XRD::Link.parse(elem)
+
+    assert_equal 'lrdd', link.rel
+  end
+
+  def test_parse_type
+    raw = '<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0"><Link type="text/html"/></XRD>'
+    elem = Nokogiri(raw).xpath('/xrd:XRD/xrd:Link', Discodactyl::XRD::XMLNS).first
+
+    link = Discodactyl::XRD::Link.parse(elem)
+
+    assert_equal 'text/html', link.type
+  end
+
+  def test_parse_href
+    raw = '<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0"><Link href="http://host.example"/></XRD>'
+    elem = Nokogiri(raw).xpath('/xrd:XRD/xrd:Link', Discodactyl::XRD::XMLNS).first
+
+    link = Discodactyl::XRD::Link.parse(elem)
+
+    assert_equal 'http://host.example', link.href
+  end
+
+  def test_parse_template
+    raw = '<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0"><Link template="http://www.google.com/s2/webfinger/?q={%id}"/></XRD>'
+    elem = Nokogiri(raw).xpath('/xrd:XRD/xrd:Link', Discodactyl::XRD::XMLNS).first
+
+    link = Discodactyl::XRD::Link.parse(elem)
+
+    assert_equal Discodactyl::URITemplate.new('http://www.google.com/s2/webfinger/?q={%id}'), link.template
+    assert_nil link.href
+  end
+
+  def test_ignores_template_when_href_exists
+    raw = '<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0"><Link rel="lrdd" type="text/html" href="http://host.example" template="http://www.google.com/s2/webfinger/?q={%id}"/></XRD>'
+    elem = Nokogiri(raw).xpath('/xrd:XRD/xrd:Link', Discodactyl::XRD::XMLNS).first
+
+    link = Discodactyl::XRD::Link.parse(elem)
+
+    assert_equal 'http://host.example', link.href
+    assert_nil link.template
+  end
+
+  def test_to_uris_for_plain_uri
+    raw = '<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0"><Link href="http://host.example"/></XRD>'
+    elem = Nokogiri(raw).xpath('/xrd:XRD/xrd:Link', Discodactyl::XRD::XMLNS).first
+    link = Discodactyl::XRD::Link.parse(elem)
+
+    uri = link.to_uri
+
+    assert_equal 'http://host.example', uri
+  end
+
+  def test_to_uris_for_uri_template
+    raw = '<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0"><Link template="http://www.google.com/s2/webfinger/?q={%id}"/></XRD>'
+    elem = Nokogiri(raw).xpath('/xrd:XRD/xrd:Link', Discodactyl::XRD::XMLNS).first
+    link = Discodactyl::XRD::Link.parse(elem)
+
+    uri = link.to_uri 'id' => 'bob@gmail.com'
+
+    assert_equal 'http://www.google.com/s2/webfinger/?q=bob@gmail.com', uri
+  end
+end

data/test/test_xrd_parse.rb

@@ -0,0 +1,146 @@
+#!/usr/bin/env ruby -w
+libdir = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+testdir = File.expand_path('../../test', __FILE__)
+$LOAD_PATH.unshift(testdir) unless $LOAD_PATH.include?(testdir)
+
+require 'test_helper'
+require 'discodactyl/xrd/document'
+
+class TestXRDParsing < Test::Unit::TestCase
+  def setup
+    @minimal_xrd_string =<<eos
+<?xml version=\"1.0\"?>
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+  <Subject>http://host.example/</Subject>
+</XRD>
+eos
+
+    @full_xrd_string =<<eos
+<?xml version=\"1.0\"?>
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+  <Subject>http://host.example/</Subject>
+  <Link rel="webfinger" href="http://host.example/endpoint"/>
+  <Link rel="describedby" href="http://host.example/endpoint"/>
+  <Link rel="feed" template="http://host.example/descriptor?q={%id}"/>
+  <Link rel="describedby" template="http://host.example/descriptor?q={%id}"/>
+</XRD>
+eos
+
+    @raw_link_without_id = '<Link rel="http://oexchange.org/spec/0.8/rel/user-target" type="application/xrd+xml" href="http://www.example.com/linkeater/oexchange.xrd"/>'
+    @raw_link_with_id = '<Link xml:id="foo" rel="http://oexchange.org/spec/0.8/rel/user-target" type="application/xrd+xml" href="http://www.example.com/linkeater/oexchange.xrd"/>'
+
+    @xrd = Discodactyl::XRD::Document.parse(@full_xrd_string)
+  end
+  def test_parse
+    doc = Discodactyl::XRD::Document.parse(@full_xrd_string)
+    assert_not_nil(doc)
+  end
+  def test_parse_links
+    assert_equal(4, @xrd.links.length)
+  end
+
+  def test_linkelems_by_rel
+    link_elems = @xrd.linkelems_by_rel 'describedby'
+
+    assert_length(2, link_elems)
+
+    assert_equal 'http://host.example/endpoint', link_elems[0]['href']
+    assert_equal 'http://host.example/descriptor?q={%id}', link_elems[1]['template']
+  end
+
+  def test_linkelems_by_rel_with_multiple_rels
+    link_elems = @xrd.linkelems_by_rel 'describedby'
+
+    assert_length(2, link_elems)
+
+    assert_equal 'http://host.example/endpoint', link_elems[0]['href']
+    assert_equal 'http://host.example/descriptor?q={%id}', link_elems[1]['template']
+  end
+
+  def test_uris_by_rel
+    uris = @xrd.uris_by_rel 'describedby', 'id' => 'bradfitz@gmail.com'
+
+    assert_length(2, uris)
+
+    assert_equal 'http://host.example/endpoint', uris[0]
+    assert_equal 'http://host.example/descriptor?q=bradfitz@gmail.com', uris[1]
+  end
+
+  def test_to_s
+    assert_equal @full_xrd_string, @xrd.to_s
+  end
+
+  def test_links_by_rel
+    links = @xrd.links_by_rel('feed')
+
+    assert_length(1, links)
+    expected = Discodactyl::URITemplate.new('http://host.example/descriptor?q={%id}')
+    assert_equal(expected, links[0].template)
+  end
+
+  def test_uris_by_rel
+    links = @xrd.uris_by_rel('feed', 'id' => 'dclinton@gmail.com')
+
+    assert_length(1, links)
+    assert_include?('http://host.example/descriptor?q=dclinton@gmail.com', links)
+  end
+
+#   def test_update
+#     xrd_str =<<eos
+# <?xml version=\"1.0\"?>
+# <XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+#   <Subject>http://host.example/</Subject>
+#   <Link rel="webfinger" href="http://host.example/endpoint"/>
+#   <Link rel="describedby" href="http://host.example/endpoint"/>
+#   <Link rel="feed" template="http://host.example/descriptor?q={%id}"/>
+#   <Link rel="describedby" template="http://host.example/descriptor?q={%id}"/>
+#   <Link href="http://www.example.com/linkeater/oexchange.xrd" rel="http://oexchange.org/spec/0.8/rel/user-target" type="application/xrd+xml"/>
+#  </XRD>
+# eos
+#     doc = Discodactyl::XRD::Document.parse xrd_str
+#
+#     link = "<Link rel='http://oexchange.org/spec/0.8/rel/user-target' type='application/xrd+xml' href='updated' />"
+#
+#     doc.raw.xpath('//xrd:Link',Discodactyl::XRD::XMLNS).after(link)
+#
+#     expected =<<eos
+# <?xml version=\"1.0\"?>
+# <XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+#   <Subject>http://host.example/</Subject>
+#   <Link rel="webfinger" href="http://host.example/endpoint"/>
+#   <Link rel="describedby" href="http://host.example/endpoint"/>
+#   <Link rel="feed" template="http://host.example/descriptor?q={%id}"/>
+#   <Link rel="describedby" template="http://host.example/descriptor?q={%id}"/>
+#   <Link href="updated" rel="http://oexchange.org/spec/0.8/rel/user-target" type="application/xrd+xml"/>
+#  </XRD>
+# eos
+#
+#     assert_equal expected, doc.to_s
+#   end
+
+#   def test_delete
+#     xrd_str =<<eos
+# <?xml version=\"1.0\"?>
+# <XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+#   <Subject>http://host.example/</Subject>
+#   <Link xml:id='1' href="http://example.com/" rel="user-target" type="application/xrd+xml"/>
+#  </XRD>
+# eos
+#     doc = Discodactyl::XRD::Document.parse xrd_str
+#
+#     link = "<Link rel='http://oexchange.org/spec/0.8/rel/user-target' type='application/xrd+xml' href='updated' />"
+#
+#     doc.raw.xpath('//xrd:Link',Discodactyl::XRD::XMLNS).after(link)
+#
+#     expected =<<eos
+# <?xml version=\"1.0\"?>
+# <XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+#   <Subject>http://host.example/</Subject>
+#  </XRD>
+# eos
+#
+#     assert_equal expected, doc.to_s
+#     assert !doc.include?(link)
+#   end
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification 
+name: discodactyl
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Joseph Anthony Pasquale Holsten
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-08 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: feedzirra
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 23
+        version: 0.0.23
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mofo
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id004
+description: "Discodactyl is an experimental toolkit for XRD service discovery documents and related protocols. It includes implementations of XRD URITemplate Link-Patterns, basic site-meta support, HTTP Link header parsing, acct: URIs and a webfinger poking stick."
+email: joseph@josephholsten.com
+executables: 
+- webfinger
+extensions: []
+
+extra_rdoc_files: 
+- AUTHORS
+- CHANGELOG
+- COPYING
+- INSTALL
+- NEWS
+- README
+- TODO
+files: 
+- AUTHORS
+- CHANGELOG
+- COPYING
+- Gemfile
+- INSTALL
+- MANIFEST
+- NEWS
+- README
+- Rakefile
+- TODO
+- bin/webfinger
+- discodactyl.gemspec
+- lib/discodactyl.rb
+- lib/discodactyl/acct_uri.rb
+- lib/discodactyl/host_meta.rb
+- lib/discodactyl/link_header.rb
+- lib/discodactyl/resource_discovery.rb
+- lib/discodactyl/uri_template.rb
+- lib/discodactyl/xrd.rb
+- lib/discodactyl/xrd/document.rb
+- lib/discodactyl/xrd/link.rb
+- test/test_acct_uri.rb
+- test/test_helper.rb
+- test/test_host_meta.rb
+- test/test_link_header.rb
+- test/test_resource_discovery.rb
+- test/test_uri_template.rb
+- test/test_xrd_append.rb
+- test/test_xrd_link_parse.rb
+- test/test_xrd_parse.rb
+has_rdoc: true
+homepage: http://dactylo.us
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- --title
+- Discodactyl Documentation
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Discodactyl is an experimental toolkit for XRD service discovery documents and related protocols
+test_files: 
+- test/test_acct_uri.rb
+- test/test_helper.rb
+- test/test_host_meta.rb
+- test/test_link_header.rb
+- test/test_resource_discovery.rb
+- test/test_uri_template.rb
+- test/test_xrd_append.rb
+- test/test_xrd_link_parse.rb
+- test/test_xrd_parse.rb