discodactyl 0.4.1 → 0.5.0

data/MANIFEST

@@ -12,6 +12,8 @@ bin/webfinger
 discodactyl.gemspec
 lib/discodactyl.rb
 lib/discodactyl/acct_uri.rb
+lib/discodactyl/cli.rb
+lib/discodactyl/cli/format.rb
 lib/discodactyl/host_meta.rb
 lib/discodactyl/host_meta_jrd.rb
 lib/discodactyl/jrd.rb
@@ -30,6 +32,7 @@ test/test_helper.rb
 test/test_host_meta.rb
 test/test_host_meta_jrd.rb
 test/test_jrd_document.rb
+test/test_known_accounts.rb
 test/test_link_header.rb
 test/test_resource_discovery.rb
 test/test_uri_template.rb

data/NEWS

@@ -1,3 +1,34 @@
+=== 0.5.0 / 2010-11-17
+
+Brought Out of Retirement!
+
+Now using ISC licence instead of AGPL
+
+New Features
+
+* Support pluggable formatters for rel types
+
+Breaking Changes
+
+* Discodactyl::KNOWN_RELS has switched its keys and values
+
+Bug Fixes
+
+* Replace mofo with prism
+
+=== 0.4.1 / 2011-03-14
+
+Bug Fixes
+
+* Handle missing JRD hostmeta
+
+=== 0.4.0 / 2010-11-17
+
+New Features
+
+* JRD parsing, querying
+* Support many known rel formats
+
 === 0.3.0 / 2010-07-08
 
 New Features

data/README.rdoc

@@ -1,14 +1,15 @@
 = Discodactyl
 
-Code :: http://github.com/josephholsten/discodactyl
-Bugs :: http://josephholsten.lighthouseapp.com/projects/36040-discodactyl
-Tests :: http://discodactyl-ci.heroku.com/
-Docs :: http://rdoc.info/projects/josephholsten/discodactyl
-Author :: mailto:joseph@josephholsten.com
+{<img src="https://secure.travis-ci.org/josephholsten/discodactyl.png" alt="Build Status" />}[http://travis-ci.org/josephholsten/discodactyl] | {<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/josephholsten/discodactyl] | {<img src="https://gemnasium.com/josephholsten/discodactyl.png" alt="Dependency Status" />}[https://gemnasium.com/josephholsten/discodactyl]
+
+{Docs}[http://rdoc.info/projects/josephholsten/discodactyl] | {Code}[https:/github.com/josephholsten/discodactyl] | {Bugs}[http://github.com/josephholsten/discodactyl/issues]
 
 == 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.
+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.
 
 == FEATURES/PROBLEMS:
 
@@ -18,9 +19,10 @@ Discodactyl is an experimental toolkit for XRD service discovery documents and r
 * HTTP Link header parsing.
 * acct: URI parsing.
 * Minimal URI Template parsing and application.
-* Probably filled with bugs. Don't forget your bug powder.
 * JRD parsing, querying.
-* Yahoo 'webfinger' doesn't work. Sadly, they need to update their format to the most recent one.
+* Probably filled with bugs. Don't forget your bug powder.
+* Yahoo 'webfinger' doesn't work. Sadly, they need to update their
+  format to the most recent one.
 
 == SYNOPSIS:
 
@@ -46,9 +48,9 @@ For ruby mongers:
 == REQUIREMENTS:
 
 * nokogiri 1.4
-* actionpack 2.3
+* actionpack 3.0
 * feedzirra 0.0.23
-* mofo 0.2
+* prism 0.1
 
 == INSTALLING:
 
@@ -56,22 +58,17 @@ See the INSTALL file for details.
 
 == LICENSE:
 
-This software is also available in a permissive license. Please contact Joseph Holsten <joseph@josephholsten.com> for more information.
-
-(The GNU Affero General Public License)
-
-Copyright (c) 2009, 2010, 2011 Joseph Anthony Pasquale Holsten
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Affero General Public License for more details.
+Copyright (c) 2009, 2010, 2011, 2012 Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
 
-You should have received a copy of the GNU Affero General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+Permission to use, copy, modify, and/or distribute this software for
+any purpose with or without fee is hereby granted, provided that the
+above copyright notice and this permission notice appear in all copies.
 
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/Rakefile

@@ -1,5 +1,8 @@
 #!/usr/bin/env rake
 
+require 'bundler'
+Bundler.setup
+
 require "rake/testtask"
 Rake::TestTask.new do |test|
   test.test_files = Dir['test/**/test_*.rb']

data/TODO

@@ -25,16 +25,6 @@ Reference Specs
 * link header http://tools.ietf.org/html/rfc5988
 * versioning-rels http://tools.ietf.org/html/rfc5829
 
-Interesting webfinger variants
-* joseph@josephholsten.com
-* romeda@gmail.com
-* will@willmeyer.com
-* dclinton@gmail.com
-* bradfitz@gmail.com
-* dclinton@yahoo.com
-* beestage@yahoo.com
-* gffletch@aol.com
-
 other clients
 * webfingerclient-dclinton.appspot.com/
 * webfinger.org/lookup/darron@froese.org

data/bin/webfinger

@@ -3,13 +3,14 @@ libdir = File.expand_path('../../lib', __FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
 require 'discodactyl'
+require 'discodactyl/cli'
 require 'open-uri'
 require 'action_view'
-require 'mofo'
+require 'prism'
 require 'feedzirra'
 require 'logger'
 
-log = Logger.new(STDOUT)
+log = Logger.new(STDERR)
 Discodactyl.log = log
 
 if ARGV.length == 0
@@ -76,32 +77,13 @@ else
   log.warn("Disco doc didn't list a subject. Assuming everything is well.")
 end
 
-hcard_uri = disco.uris_by_rel('http://microformats.org/profile/hcard').first
-hcard = hCard.find(:first => hcard_uri) rescue
-if hcard
-  puts "Name: #{hcard.fn.gsub(/\s+/, ' ')}" if hcard.properties.include?('fn')
-  puts "Title: #{hcard.title}" if hcard.properties.include?('title')
-  puts "Organization: #{hcard.org}" if hcard.properties.include?('org')
-end
-
 links_with_titles = disco.links.select{|l| l.title.present? }
 links_with_titles.each do |link|
   puts "#{link.title}: #{link.to_uri}"
 end
 
-Discodactyl::KNOWN_RELS.each do |name, rel|
+Discodactyl::KNOWN_RELS.each do |rel, name|
   uri = disco.uris_by_rel(rel).first
-  puts "#{name}: #{uri}" if uri
-end
-
-activities = disco.uris_by_rel('http://schemas.google.com/g/2010#updates-from').first
-if activities
-  feed = Feedzirra::Feed.fetch_and_parse(activities)
-  entry = feed.entries.first
-  if entry
-    include ActionView::Helpers::DateHelper
-    silence_warnings do
-      puts "Status: #{Loofah::Helpers.strip_tags(entry.content)} #{time_ago_in_words(entry.published)} ago"
-    end
-  end
+  formatter = Discodactyl::CLI::Format.for_rel(rel)
+  formatter.call(uri, STDOUT)
 end

data/discodactyl.gemspec

@@ -16,10 +16,10 @@ Gem::Specification.new do |spec|
   spec.files = File.read("MANIFEST").split(/\r?\n\r?/)
   spec.executables = spec.files.grep(/^bin/) { |f| File.basename(f) }
   spec.test_files = spec.files.grep(/^test\/.*test_.*\.rb$/)
-  spec.add_runtime_dependency 'nokogiri', '~>1.4.2'
-  spec.add_runtime_dependency 'actionpack', '~>3.0.0'
-  spec.add_runtime_dependency 'feedzirra', '~>0.0.23'
-  spec.add_runtime_dependency 'mofo', '~>0.2.16'
-  spec.add_development_dependency 'rr', '~>0.10.11'
-  spec.add_development_dependency 'rake', '~>0.8.7'
+  spec.add_runtime_dependency 'nokogiri', '>= 1.4.2'
+  spec.add_runtime_dependency 'actionpack', '>= 3.0.8'
+  spec.add_runtime_dependency 'feedzirra', '>= 0.0.22'
+  spec.add_runtime_dependency 'prism', '>= 0.1.0'
+  spec.add_development_dependency 'mocha', '>= 0.12.7'
+  spec.add_development_dependency 'rake', '>= 0.9.2.2'
 end

data/lib/discodactyl.rb

@@ -9,5 +9,5 @@ require 'discodactyl/uri_template'
 require 'discodactyl/xrd'
 
 module Discodactyl # :nodoc:
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/lib/discodactyl/cli.rb

@@ -0,0 +1 @@
+require 'discodactyl/cli/format'

data/lib/discodactyl/cli/format.rb

@@ -0,0 +1,69 @@
+module Discodactyl # :nodoc
+module CLI # :nodoc
+# Formatting helpers for various rels
+class Format
+  def self.for_rel(rel)
+    case rel
+    when 'http://microformats.org/profile/hcard' then
+      lambda {|uri, io| Discodactyl::CLI::Format.hcard_from_uri(uri, io) }
+    when 'http://schemas.google.com/g/2010#updates-from' then
+      lambda {|uri, io| Discodactyl::CLI::Format.activities_from_uri(uri, io) }
+    else
+      if name = Discodactyl::KNOWN_RELS[rel]
+        lambda {|uri, io| io.puts "#{name}: #{uri}" if uri }
+      else
+        lambda {|uri, io| }
+      end
+    end
+  end
+
+  def self.hcard_adr(adr)
+    segments = []
+    segments << adr.street_address if adr.properties.include?(:street_address)
+    segments << adr.locality if adr.properties.include?(:locality)
+    segments << adr.region if adr.properties.include?(:region)
+    segments << adr.postal_code if adr.properties.include?(:postal_code)
+    segments << adr.country_name if adr.properties.include?(:country_name)
+    segments.join(' ')
+  end
+
+  def self.hcard_from_uri(uri, io)
+    begin
+      Discodactyl.log.debug("hCard lookup for #{uri}") if Discodactyl.log
+      if hcards = Prism.find(uri, :hcard)
+        hcards.each do |hcard|
+          if hcard
+            io << "Name: #{hcard.fn.gsub(/\s+/, ' ')}\n" if hcard.properties.include?(:fn)
+            io << "Title: #{hcard.title}\n" if hcard.properties.include?(:title)
+            io << "Organization: #{hcard.org}\n" if hcard.properties.include?(:org)
+            io << "Address: #{hcard_adr(hcard.adr)}\n" if hcard.properties.include?(:adr)
+          end
+        end
+      end
+    rescue RuntimeError => e
+      Discodactyl.log.warn(e.message) if Discodactyl.log
+      Discodactyl.log.debug(e) if Discodactyl.log
+    end
+  end
+
+  def self.activities_from_uri(uri, io)
+    Discodactyl.log.debug("Activity feed lookup for #{uri}") if Discodactyl.log
+    begin
+      if uri && (feed = Feedzirra::Feed.fetch_and_parse(uri)) && feed.respond_to?(:entries)
+        Array(feed.entries).each do |entry|
+          include ActionView::Helpers::DateHelper
+          silence_warnings do
+            io.puts "Status: #{Loofah::Helpers.strip_tags(entry.content)} #{time_ago_in_words(entry.published)} ago"
+          end
+        end
+      else
+        Discodactyl.log.debug("Failed activity feed lookup with uri: #{uri.inspect} feed: #{feed.inspect}") if Discodactyl.log
+      end
+    rescue
+      Discodactyl.log.warn($!) if Discodactyl.log
+    end
+  end
+
+end
+end
+end

data/lib/discodactyl/known_rels.rb

@@ -1,12 +1,14 @@
 module Discodactyl # :nodoc:
   KNOWN_RELS = {
-    'OpenID' => 'http://specs.openid.net/auth/',
-    'OpenID Provider' => 'http://specs.openid.net/auth/2.0/provider',
-    'OpenID Provider' => 'openid2.provider',
-    "Profile" => 'http://webfinger.net/rel/profile-page',
-    "Profile data" => 'http://portablecontacts.net/spec/1.0#me',
-    "Contacts" => 'http://portablecontacts.net/spec/1.0',
-    "describedby" => 'describedby', # from POWDER
-    "Webfinger/LRDD" => 'lrdd'
+    'http://microformats.org/profile/hcard' => 'hcard',
+    'http://specs.openid.net/auth/' => 'OpenID',
+    'http://specs.openid.net/auth/2.0/provider' => 'OpenID Provider',
+    'openid2.provider' => 'OpenID Provider',
+    'http://webfinger.net/rel/profile-page' => 'Profile',
+    'http://portablecontacts.net/spec/1.0#me' => 'Profile data',
+    'http://portablecontacts.net/spec/1.0' => 'Contacts',
+    'describedby' => 'describedby', # from POWDER
+    'lrdd' => 'Webfinger/LRDD',
+    'http://schemas.google.com/g/2010#updates-from' => 'activities'
   }
-end
+end

data/test/test_helper.rb

@@ -1,4 +1,6 @@
 require "test/unit"
+require "mocha"
+
 module Test::Unit::Assertions
   def assert_length(expected, enum, message = nil)
     message = build_message message, '<?> is not length <?>', enum, expected
@@ -10,8 +12,3 @@ module Test::Unit::Assertions
     assert enum.include?(atom), message
   end
 end
-
-class Test::Unit::TestCase
-  require 'rr'
-  include RR::Adapters::TestUnit
-end

data/test/test_host_meta_jrd.rb

@@ -1,12 +1,22 @@
 #!/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/unit"
-require "discodactyl/host_meta_jrd"
+require 'test/unit'
+require 'test_helper'
+require 'discodactyl/host_meta_jrd'
 require 'discodactyl/acct_uri'
 
 class TestHostMetaJRD < Test::Unit::TestCase
+  def setup
+    @json = <<JSON
+{ "links": {
+    "lrdd": [{
+      "href":"http://host.example/discovery.jrd" }]}}
+JSON
+  end
   def test_get_uri_from_host
     uri = 'host.example'
     expected = URI.parse 'http://host.example/.well-known/host-meta.json'
@@ -27,20 +37,16 @@ class TestHostMetaJRD < Test::Unit::TestCase
   
   def test_from_uri
     uri = URI.parse 'acct:josephholsten@localhost'
-    assert_equal({"links"=>{"lrdd"=>[{"href"=>"http://localhost/discovery.jrd"}]}}, Discodactyl::HostMetaJRD.from_uri(uri))
+    URI::HTTP.any_instance.stubs(:open).returns(StringIO.new(@json))
+    assert_equal({'links'=>{'lrdd'=>[{'href'=>'http://host.example/discovery.jrd'}]}}, Discodactyl::HostMetaJRD.from_uri(uri))
   end
 
   def test_parse
-    json = <<JSON
-{ "links": {
-    "lrdd": [{
-      "href":"http://host.example/discovery.jrd" }]}}
-JSON
-    assert_equal({"links"=>{"lrdd"=>[{"href"=>"http://host.example/discovery.jrd"}]}}, Discodactyl::HostMetaJRD.parse(json))
+    assert_equal({'links'=>{'lrdd'=>[{'href'=>'http://host.example/discovery.jrd'}]}}, Discodactyl::HostMetaJRD.parse(@json))
   end
 
   def test_links_by_rel
-    jrd = Discodactyl::HostMetaJRD[{"links"=>{"lrdd"=>[{"href"=>"http://host.example/discovery.jrd"}]}}]
+    jrd = Discodactyl::HostMetaJRD[{'links'=>{'lrdd'=>[{'href'=>'http://host.example/discovery.jrd'}]}}]
     expected = [Discodactyl::JRD::Link.parse({'href'=>'http://host.example/discovery.jrd', 'rel' => 'lrdd'})]
     assert_equal(expected, jrd.links_by_rel('lrdd'))
   end
@@ -52,12 +58,12 @@ JSON
   end
 
   def test_uris_by_rel
-    jrd = Discodactyl::HostMetaJRD[{"links"=>{"lrdd"=>[{"href"=>"http://host.example/discovery.jrd"}]}}]
+    jrd = Discodactyl::HostMetaJRD[{'links'=>{'lrdd'=>[{'href'=>'http://host.example/discovery.jrd'}]}}]
     assert_equal(['http://host.example/discovery.jrd'], jrd.uris_by_rel('lrdd'))
   end
 
   def test_uris_by_rel_with_template
-    jrd = Discodactyl::HostMetaJRD[{"links"=>{"lrdd"=>[{"template"=>"http://host.example/{id}"}]}}]
+    jrd = Discodactyl::HostMetaJRD[{'links'=>{'lrdd'=>[{'template'=>'http://host.example/{id}'}]}}]
     assert_equal(['http://host.example/foo'], jrd.uris_by_rel('lrdd', 'id' => 'foo'))
   end
 end

data/test/test_known_accounts.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby -w
+libdir = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require "test/unit"
+
+class TestKnownAccounts < Test::Unit::TestCase
+
+  def test_dclinton
+    expected =<<EOF
+OpenID Provider: http://www.google.com/profiles/dclinton
+Profile: http://www.google.com/profiles/dclinton
+Profile data: http://www-opensocial.googleusercontent.com/api/people/117377434815709898403/
+Contacts: http://www-opensocial.googleusercontent.com/api/people/
+describedby: http://www.google.com/profiles/dclinton
+EOF
+    assert_equal expected, `bin/webfinger dclinton@gmail.com`
+  end
+
+  def test_romeda
+    expected =<<EOF
+OpenID Provider: http://www.google.com/profiles/romeda
+Profile: http://www.google.com/profiles/romeda
+Profile data: http://www-opensocial.googleusercontent.com/api/people/113651174506128852447/
+Contacts: http://www-opensocial.googleusercontent.com/api/people/
+describedby: http://www.google.com/profiles/romeda
+EOF
+    assert_equal expected, `bin/webfinger romeda@gmail.com`
+  end
+
+  def test_bradfitz
+    expected =<<EOF
+OpenID Provider: http://www.google.com/profiles/bradfitz
+Profile: http://www.google.com/profiles/bradfitz
+Profile data: http://www-opensocial.googleusercontent.com/api/people/115863474911002159675/
+Contacts: http://www-opensocial.googleusercontent.com/api/people/
+describedby: http://www.google.com/profiles/bradfitz
+EOF
+    assert_equal expected, `bin/webfinger bradfitz@gmail.com`
+  end
+
+  def test_willmeyer
+    expected =<<EOF
+describedby: http://www.google.com/profiles/willmeyer
+EOF
+    assert_equal expected, `bin/webfinger will@willmeyer.com`
+  end
+
+  def test_josephholsten
+    expected =<<EOF
+Name: Joseph Anthony Pasquale Holsten
+Address: 5813 East 64th Place Tulsa Oklahoma 74136-2132 USA
+OpenID Provider: https://www.myopenid.com/server
+Profile: http://josephholsten.com
+describedby: http://josephholsten.com
+EOF
+    assert_equal expected, `bin/webfinger joseph@josephholsten.com`
+  end
+
+  # Yahoo webfinger causes my ruby to segfault!
+  # def test_gffletch
+  #   expected =<<EOF
+  #   assert_equal expected, `bin/webfinger dclinton@yahoo.com`
+  #   assert_equal expected, `bin/webfinger beestage@yahoo.com`
+  # end
+
+  # AOL webfinger now dies at http://www.aol.com/.well-known/host-meta with 503
+  # RIP
+  # def test_gffletch
+  #   expected =<<EOF
+  #   assert_equal expected, `bin/webfinger gffletch@aol.com`
+  # end
+end