discodactyl 0.3.0

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+gem 'actionpack', '~>2.3.8'
+gem 'feedzirra', '~>0.0.23'
+gem 'mofo', '~>0.2.16'
+gem 'nokogiri', '~>1.4.2'
+gem 'rake', '~>0.8.7'
+gem 'rr', '~>0.10.11'

data/INSTALL

@@ -0,0 +1,26 @@
+= Installing Discodactyl
+
+RubyGems is the preferred easy install method for Discodactyl.
+
+== Installing the Gem
+
+Discodactyl is intended to be installed via the
+RubyGems[http://rubygems.org/] system.  To get the latest
+version, simply enter the following into your command prompt:
+
+	$ gem install discodactyl
+
+You must have RubyGems[http://rubygems.org/] installed for
+the above to work.
+
+If you want to build the gem locally, run the following command:
+
+  $ gem build discodactyl.gemspec
+
+== Running the Tests
+
+If you would like to run Discodactyl's test suite on your system before
+installing and you have Rake installed, just issue the following command from
+the root of the project directory:
+
+  $ rake

data/MANIFEST

@@ -0,0 +1,30 @@
+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

data/NEWS

@@ -0,0 +1,31 @@
+=== 0.3.0 / 2010-07-08
+
+New Features
+
+* Gem installation
+* XRD support for adding & removing links
+* Useful, plain text output from webfinger script
+
+Breaking Changes
+
+* Webfinger script no longer outputs raw XRD
+
+=== 0.2.0 / 2010-03-19
+
+New Features
+
+* URI.parse support for acct: URIs
+* URI Template parsing
+* XRD parsing and query support
+* Host Meta and in-document discovery
+* Webfinger example script
+
+Breaking Changes
+
+* XRD format has completely changed to comply with new specifications
+
+=== 0.0.0 / 2009-07-25
+
+New Features
+
+  * Add Link Header discovery

data/README

@@ -0,0 +1,63 @@
+= Discodactyl
+
+* http://dactylo.us
+* http://github.com/josephholsten/discodactyl
+* http://josephholsten.lighthouseapp.com/projects/36040-discodactyl
+* mailto:joseph@josephholsten.com
+
+== 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.
+
+== FEATURES/PROBLEMS:
+
+* Webfinger client.
+* XRD parsing, querying and modification.
+* LRDD discovery.
+* HTTP Link header parsing.
+* acct: URI parsing.
+* Minimal URI Template parsing and application.
+* Probably filled with bugs. Don't forget your bug powder.
+
+== SYNOPSIS:
+
+  # All of WebFinger! In very few, if long and pointy, lines!
+  require 'discodactyl'
+
+  acct = URI.parse 'acct:bradfitz@gmail.com'
+
+  webfinger_uris = Discodactyl::ResourceDiscovery.get_uris_by_rel(acct, 'lrdd', 'uri' => acct)
+  disco_doc = Discodactyl::XRD::Document.parse(open(webfinger_uris.first))
+
+== REQUIREMENTS:
+
+* nokogiri 1.4
+* actionpack 2.3
+* feedzirra 0.0.23
+* mofo 0.2
+
+== INSTALLING:
+
+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 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.
+
+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/>.
+

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+
+require "rake/testtask"
+Rake::TestTask.new do |test|
+  test.test_files = Dir['test/**/test_*.rb']
+  test.verbose = true
+end
+task :default => :test
+
+require "rake/clean"
+file 'MANIFEST.tmp' do
+  sh %{find . -type f | sed 's/\\.\\///' | grep -v '.git' | sort > MANIFEST.tmp}
+end
+CLEAN << 'MANIFEST.tmp'
+
+desc "Check the manifest against current files"
+task :check_manifest => [:clean, 'MANIFEST', 'MANIFEST.tmp'] do
+  puts `diff -du MANIFEST MANIFEST.tmp`
+end
+
+CLEAN << '.rake_tasks'
+
+# vim: syntax=ruby

data/TODO

@@ -0,0 +1,24 @@
+* release as rip
+* write man page  webfinger.1
+* add CONTRIBUTING
+* play nice with gem man
+* semver
+* document everything as tested
+* nodoc everything without docs
+* see if redfinger's docs map at all
+* prettify the script output
+* ensure security
+* check hm:Host
+* check final /XRD/Subject
+* test 3** redirects
+* REXML support
+* collect common rel values into a enum module
+* put license info in every file
+
+Reference Specs
+* host meta http://tools.ietf.org/html/draft-hammer-hostmeta-05
+* webfinger
+* xrd http://www.oasis-open.org/committees/download.php/36542/xrd-1.0-wd15.html
+* lrdd http://tools.ietf.org/html/draft-hammer-discovery-04
+* link header http://tools.ietf.org/html/draft-nottingham-http-link-header-08
+* versioning-rels http://tools.ietf.org/html/draft-brown-versioning-link-relations-07

data/bin/webfinger

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+libdir = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require 'discodactyl'
+require 'open-uri'
+require 'action_view'
+require 'mofo'
+require 'feedzirra'
+
+if ARGV.length == 0
+	puts "Usage: #{__FILE__} user@host"
+	exit 0
+end
+
+# parse identifier
+acct = URI::ACCT.parse(ARGV[0])
+
+# Perform LRDD discovery on acct with the webfinger relation
+finger_rel = "lrdd"
+begin
+  webfinger_uris = Discodactyl::ResourceDiscovery.get_uris_by_rel(acct, finger_rel, 'uri' => acct)
+rescue Discodactyl::HostMetaHTTPError => error
+  if error.io.status[1] == 'Not Found'
+    abort "No host meta webfinger information found at #{error.io.base_uri}"
+  else
+    raise
+  end
+end
+
+abort "URI didn't have any linked webfinger URIs" if webfinger_uris.empty?
+
+# retrieve user disco doc
+disco_res = open(webfinger_uris.first)
+
+# parse disco doc
+disco = Discodactyl::XRD::Document.parse(disco_res)
+
+hcard_uri = disco.uris_by_rel('http://microformats.org/profile/hcard').first
+hcard = hCard.find(:first => hcard_uri)
+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
+
+openid = disco.uris_by_rel('http://specs.openid.net/auth/').first
+puts "OpenID: #{openid}" if openid
+
+profile = disco.uris_by_rel('http://webfinger.net/rel/profile-page').first
+puts "Profile: #{profile}" if profile
+
+contacts = disco.uris_by_rel('http://portablecontacts.net/spec/1.0').first
+puts "Contacts: #{contacts}" if contacts
+
+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
+  include ActionView::Helpers::DateHelper
+  puts "Status: #{Loofah::Helpers.strip_tags(entry.content)} #{time_ago_in_words(entry.published)} ago" 
+end

data/discodactyl.gemspec

@@ -0,0 +1,23 @@
+lib     = File.expand_path("../lib/discodactyl.rb", __FILE__)
+version = File.read(lib)[/^\s*VERSION\s*=\s*(['"])(\d\.\d\.\d)\1/, 2]
+
+Gem::Specification.new do |spec|
+  spec.name = "discodactyl"
+  spec.author = "Joseph Anthony Pasquale Holsten"
+  spec.email = "joseph@josephholsten.com"
+  spec.homepage = "http://dactylo.us"
+  spec.description = %q{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.}
+  spec.extra_rdoc_files = %w[ AUTHORS CHANGELOG COPYING INSTALL NEWS README TODO ]
+  spec.rdoc_options << "--charset=UTF-8" <<
+                       "--title" << "Discodactyl Documentation" <<
+                       "--main"  << "README"
+  spec.version = version
+  spec.summary = spec.description.split(/\.\s+/).first
+  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.0'
+  spec.add_runtime_dependency 'actionpack', '~>2.3.0'
+  spec.add_runtime_dependency 'feedzirra', '~>0.0.23'
+  spec.add_runtime_dependency 'mofo', '~>0.2.0'
+end

data/lib/discodactyl.rb

@@ -0,0 +1,9 @@
+require 'discodactyl/acct_uri'
+require 'discodactyl/host_meta'
+require 'discodactyl/resource_discovery'
+require 'discodactyl/uri_template'
+require 'discodactyl/xrd'
+
+module Discodactyl # :nodoc:
+  VERSION = '0.3.0'
+end

data/lib/discodactyl/acct_uri.rb

@@ -0,0 +1,82 @@
+require 'uri'
+
+module URI # :nodoc:
+  class ACCT < Generic
+
+
+    COMPONENT = [
+      :scheme,
+      :local_part, :host
+    ].freeze
+
+    def self.parse(str)
+      /^(acct:)?(.*)$/ =~ str
+      scheme = 'acct'
+      opaque = $2
+      self.new(scheme, nil, nil, nil, nil, nil, opaque, nil, nil)
+    end
+
+
+    #
+    # == Description
+    #
+    # Create a new URI::ACCT object from components, with syntax checking.
+    #
+    # The components accepted are local-part and host.
+    #
+    # The components should be provided either as an Array, or as a Hash
+    # with keys formed by preceding the component names with a colon.
+    #
+    # If an Array is used, the components must be passed in the order
+    # [local-part, host].
+    #
+    # Example:
+    #
+    #     newuri = URI::ACCT.build({:host => 'example.com',
+    #       :local_part> => 'bob'})
+    #
+    #     newuri = URI::ACCT.build(['bob', "example.com"])
+    #
+    def self.build(args)
+      tmp = Util::make_components_hash(self, args)
+      if tmp[:local_part] && tmp[:host]
+        tmp[:opaque] = tmp[:local_part]+'@'+tmp[:host]
+        tmp[:host] = nil
+      end
+      return super(tmp)
+    end
+
+    def initialize(*arg)
+      super(*arg)
+      parse_opaque
+    end
+
+    def parse_opaque
+      if /^([^@]*)@(.*)$/ =~ @opaque
+        @local_part = $1
+        @host = $2
+      end
+    end
+
+    attr_reader :local_part
+
+    def set_local_part(val)
+      @local_part = val
+    end
+    protected :set_local_part
+
+    def to_s
+      "#{@scheme}:#{@local_part}@#{@host}"
+    end
+
+    def id
+      "#{@local_part}@#{@host}"
+    end
+
+    def heirarchical?
+      false
+    end
+  end
+
+  @@schemes['ACCT'] = ACCT
+end

data/lib/discodactyl/host_meta.rb

@@ -0,0 +1,34 @@
+require 'discodactyl/xrd'
+require 'open-uri'
+
+module Discodactyl # :nodoc
+  # Convienient access to host metadata and individual resources controlled by 
+  # the host. See also: http://tools.ietf.org/html/draft-hammer-hostmeta
+  class HostMeta < XRD::Document
+    class << self
+      # Take a URI and return the URI for its HostMeta document
+      def get_uri_from_uri(uri)
+        host = uri.respond_to?('host') ? uri.host : uri
+        URI.parse('http://'+ host + '/.well-known/host-meta')
+      end
+
+      # Take a URI and retrieve its HostMeta document
+      def from_uri(uri)
+        uri = get_uri_from_uri(uri)
+        begin
+          raw = uri.open
+        rescue OpenURI::HTTPError => error
+          if error.io.status[1] == 'Not Found'
+            error.io.base_uri = uri
+            raise HostMetaHTTPError.new(error.message, error.io)
+          else
+            raise
+          end
+        end
+        self.parse raw
+      end
+    end
+  end
+  class HostMetaHTTPError < OpenURI::HTTPError # :nodoc:
+  end
+end

data/lib/discodactyl/link_header.rb

@@ -0,0 +1,45 @@
+require 'active_support/core_ext/object/misc'
+
+module Discodactyl # :nodoc:
+  # Access to web links stored in HTTP Link header-fields. See also: 
+  # http://tools.ietf.org/html/draft-nottingham-http-link-header
+  class LinkHeader < Hash
+    class << self
+      # Take the link header value as a string and parse it into a Hash
+      #
+      # For example, the raw link header
+      #   Link: </>; rel="http://example.net/foo"
+      # is parsed by saying
+      #   link = LinkHeader.parse('</>; rel="http://example.net/foo"')
+      #   link[:href] # '/'
+      #   link[:rel] # ['http://example.net/foo']
+      def parse(string)
+        returning(params = LinkHeader.new) do
+          if string =~ /^<([^>]+)>(.*)$/
+            params[:href] = $1
+            $2.split(/;\s*/).each do |part|
+              param, value = part.split '='
+              value = value[1...-1] if value =~ /^".*"$/
+              if param =~ /rel/i
+                  insert_name_into_hash(params, param.to_sym, value)
+              elsif !param.nil?
+                  params[param.to_sym] = value
+              end
+            end
+          else
+            raise "malformed link header: #{string}"
+          end
+        end
+      end
+
+    private
+      def insert_name_into_hash(hash, name, value)
+          value = value.split(/\s+/)
+          hash[name] ||= []
+          hash[name] << value
+          hash[name].flatten!
+          hash
+      end
+    end
+  end
+end