redfinger 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Intridea, Inc. and Michael Bleigh
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,43 @@
+= Redfinger
+
+Redfinger is a simple Ruby library built to consume the Webfinger protocol. It's simple!
+
+== Usage
+
+Just call it with an e-mail address of a domain that provides the Webfinger protocol:
+
+    require 'redfinger'
+    
+    Redfinger.finger('youraccount@gmail.com')
+    
+From there, you have access to the links provided in the response as well as some shortcuts for common uses:
+
+    finger = Redfinger.finger('youraccount@gmail.com)
+    finger.open_id.first.to_s # => "http://www.google.com/profiles/youraccount"
+    
+Links are simple hash based objects that store the 'rel' URI (such as that for hCard, OpenID, etc.), the 'href' (the actual destination URI), and the content type if specified. Note you can also just use <tt>#to_s</tt> on a link to get the destination URI.
+
+So how can you use Webfinger to your advantage? Let's take the example of hCard. If you install the `mofo` library you can do this:
+
+    require 'mofo'
+    require 'redfinger'
+    
+    hcard_uri = Redfinger.finger('example@gmail.com').hcard.first
+    hcard = hCard.find(hcard_uri)
+    hcard.fn    # => "Example Guy"
+    hcard.title # => "Title guy gave himself on Google profile"
+    
+Note that the Webfinger protocol is still in its alpha/infancy and there will likely be many changes as time progresses. This library will do its best to stay up-to-date and current with these changes over time.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Intridea, Inc. and Michael Bleigh. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "redfinger"
+    gem.summary = %Q{A Ruby WebFinger client.}
+    gem.description = %Q{A Ruby Webfinger client}
+    gem.email = "michael@intridea.com"
+    gem.homepage = "http://github.com/mbleigh/redfinger"
+    gem.authors = ["Michael Bleigh"]
+    gem.add_dependency "rest-client"
+    gem.add_dependency "nokogiri"
+    gem.add_dependency "hashie"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "webmock"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "redfinger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/redfinger.rb

@@ -0,0 +1,17 @@
+require 'redfinger/link_helpers'
+require 'redfinger/link'
+require 'redfinger/finger'
+require 'redfinger/client'
+
+module Redfinger
+  class ResourceNotFound < StandardError; end
+  # A SecurityException occurs when something in the
+  # webfinger process does not appear safe, such as
+  # mismatched domains or an unverified XRD signature.
+  class SecurityException < StandardError; end
+  
+  # Finger the provided e-mail address.
+  def self.finger(email)
+    Redfinger::Client.new(email).finger
+  end
+end

data/lib/redfinger/client.rb

@@ -0,0 +1,50 @@
+require 'restclient'
+require 'nokogiri'
+require 'uri'
+
+module Redfinger
+  class Client
+    attr_accessor :account, :domain, :uri_template
+    
+    def initialize(email, uri_template = nil)
+      self.account = urify(email)
+      self.domain = account.split('@').last
+    end
+    
+    def finger
+      self.uri_template ||= retrieve_template_from_xrd
+      Finger.new RestClient.get(swizzle)
+    end
+    
+    def xrd_url(ssl = true)
+      "http#{'s' if ssl}://#{domain}/.well-known/host-meta"
+    end
+    
+    private
+    
+    def swizzle
+      uri_template.gsub '{uri}', URI.escape(self.account)
+    end
+    
+    def retrieve_template_from_xrd(ssl = true)
+      doc = Nokogiri::XML::Document.parse(RestClient.get(xrd_url(ssl)))
+      
+      unless doc.at_xpath('.//hm:Host').content == self.domain
+        raise Redfinger::SecurityException, "The XRD document's host did not match the account's host."
+      end
+      
+      doc.at('Link[rel=lrdd]').attribute('template').value
+    rescue Errno::ECONNREFUSED, RestClient::ResourceNotFound
+      if ssl
+        retrieve_template_from_xrd(false)
+      else
+        raise Redfinger::ResourceNotFound, "Unable to find the host XRD file."
+      end
+    end
+    
+    def urify(email)
+      email = "acct:#{email}" unless email.include?("acct:")
+      email
+    end
+  end
+end

data/lib/redfinger/finger.rb

@@ -0,0 +1,24 @@
+require 'nokogiri'
+
+module Redfinger
+  # The result of a Webfinger. For more information about
+  # special helpers that are availale to pull specific types
+  # of URLs, see Redfinger::LinkHelpers
+  class Finger
+    def initialize(xml) # :nodoc:
+      @doc = Nokogiri::XML::Document.parse(xml)
+      @subject = @doc.at_css('Subject').content
+    end
+    
+    # All of the links provided by the Webfinger response.
+    def links
+      @links ||= @doc.css('Link').map{|l| Link.new(l)}
+    end
+    
+    def inspect # :nodoc:
+      "<#Redfinger::Finger subject=\"#{@subject}\">"
+    end
+    
+    include Redfinger::LinkHelpers
+  end
+end

data/lib/redfinger/link.rb

@@ -0,0 +1,18 @@
+require 'nokogiri'
+require 'hashie'
+
+module Redfinger
+  class Link < Hashie::Mash
+    def initialize(xml_link)
+      self[:rel] = xml_link['rel']
+      self[:href] = xml_link['href']
+      self[:type] = xml_link['type']
+    end
+    
+    # Outputs the URL of the link, useful for using 
+    # a Link directly in other libraries.
+    def to_s
+      self.href
+    end
+  end
+end

data/lib/redfinger/link_helpers.rb

@@ -0,0 +1,31 @@
+require 'nokogiri'
+
+module Redfinger
+  module LinkHelpers
+    # An array of links with hCard information about this e-mail address.
+    def hcard
+      relmap('http://microformats.org/profile/hcard')
+    end
+    
+    # An array of links of OpenID providers for this e-mail address.
+    def open_id
+      relmap('http://specs.openid.net/auth/', true)
+    end
+    
+    # An array of links to profile pages belonging to this e-mail address.
+    def profile_page
+      relmap('http://webfinger.net/rel/profile-page')
+    end
+    
+    # An array of links to XFN compatible URLs for this e-mail address.
+    def xfn
+      relmap('http://gmpg.org/xfn/', true)
+    end
+    
+    protected
+    
+    def relmap(uri, substring=false)
+      @doc.css("Link[rel#{'^' if substring}=\"#{uri}\"]").map{|e| Link.new(e)}
+    end
+  end
+end

data/redfinger.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{redfinger}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Bleigh"]
+  s.date = %q{2010-02-12}
+  s.description = %q{A Ruby Webfinger client}
+  s.email = %q{michael@intridea.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/redfinger.rb",
+     "lib/redfinger/client.rb",
+     "lib/redfinger/finger.rb",
+     "lib/redfinger/link.rb",
+     "lib/redfinger/link_helpers.rb",
+     "redfinger.gemspec",
+     "spec/redfinger/client_spec.rb",
+     "spec/redfinger_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mbleigh/redfinger}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Ruby WebFinger client.}
+  s.test_files = [
+    "spec/redfinger/client_spec.rb",
+     "spec/redfinger_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+    else
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+  end
+end
+

data/spec/redfinger/client_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class HaltSuccessError < StandardError; end
+
+describe Redfinger::Client do
+  describe '#new' do
+    it 'should add acct: if it is not in URI form' do
+      Redfinger::Client.new('abc@example.com').account.should == 'acct:abc@example.com'
+    end
+    
+    it 'should not add acct: if it is already in URI form' do
+      Redfinger::Client.new('acct:abc@example.com').account.should == 'acct:abc@example.com'
+    end
+    
+    it 'should set the domain to whatevers after the @ sign' do
+      Redfinger::Client.new('abc@example.com').domain.should == 'example.com'
+      Redfinger::Client.new('abc@frog.co.uk').domain.should == 'frog.co.uk'
+    end
+  end
+  
+  describe '#retrieve_template_from_xrd' do
+    it 'should make an SSL request to get the host XRD document' do
+      stub_request(:get, 'https://example.com/.well-known/host-meta').to_raise(HaltSuccessError)
+      lambda{Redfinger::Client.new('acct:abc@example.com').send(:retrieve_template_from_xrd)}.should raise_error(HaltSuccessError)
+    end
+    
+    it 'should make an HTTP request if HTTPS cannot connect' do
+      stub_request(:get, 'https://example.com/.well-known/host-meta').to_raise(Errno::ECONNREFUSED)
+      stub_request(:get, 'http://example.com/.well-known/host-meta').to_raise(HaltSuccessError)
+      lambda{Redfinger::Client.new('acct:abc@example.com').send(:retrieve_template_from_xrd)}.should raise_error(HaltSuccessError)
+    end
+    
+    it 'should raise Redfinger::ResourceNotFound if HTTP fails as well' do
+      stub_request(:get, 'https://example.com/.well-known/host-meta').to_raise(Errno::ECONNREFUSED)
+      stub_request(:get, 'http://example.com/.well-known/host-meta').to_raise(Errno::ECONNREFUSED)
+      lambda{Redfinger::Client.new('acct:abc@example.com').send(:retrieve_template_from_xrd)}.should raise_error(Redfinger::ResourceNotFound)
+    end
+    
+    it 'should raise Redfinger::ResourceNotFound on 404 as well as HTTP fail' do
+      stub_request(:get, /.well-known\/host-meta/).to_return(:status => 404, :body => '404 Not Found')
+      lambda{Redfinger::Client.new('acct:abc@example.com').send(:retrieve_template_from_xrd)}.should raise_error(Redfinger::ResourceNotFound)
+    end
+    
+    it 'should return the template' do
+      stub_request(:get, 'https://example.com/.well-known/host-meta').to_return(:status => 200, :body => host_xrd)
+      Redfinger::Client.new('acct:abc@example.com').send(:retrieve_template_from_xrd).should == 'http://example.com/webfinger/?q={uri}'
+    end
+    
+    it 'should raise a SecurityException if there is a host mismatch' do
+      stub_request(:get, 'https://franklin.com/.well-known/host-meta').to_return(:status => 200, :body => host_xrd)
+      lambda{Redfinger::Client.new('acct:abc@franklin.com').send(:retrieve_template_from_xrd)}.should raise_error(Redfinger::SecurityException)
+    end
+  end
+  
+  describe '#finger' do
+    it 'should fetch the URI template if is not set' do
+      stub_success
+      @client = Redfinger::Client.new('abc@example.com')
+      @client.should_receive(:retrieve_template_from_xrd).and_raise(HaltSuccessError)
+      lambda{@client.finger}.should raise_error(HaltSuccessError)
+    end
+    
+    it 'should NOT fetch the URI template if it is already set' do
+      stub_success
+      @client = Redfinger::Client.new('abc@example.com')
+      @client.should_not_receive(:retrieve_template_from_xrd)
+      @client.uri_template = 'http://example.com/webfinger/?q={uri}'
+      @client.finger
+    end
+    
+    it 'should return a Finger' do
+      stub_success
+      Redfinger::Client.new('abc@example.com').finger.should be_kind_of(Redfinger::Finger)
+    end
+  end
+end

data/spec/redfinger_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Redfinger do
+  describe '#finger' do
+    it 'should initialize a new client' do
+      Redfinger::Client.should_receive(:new).with('abc@example.com').and_return(mock("Redfinger::Client", :finger => nil))
+      Redfinger.finger('abc@example.com')
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'redfinger'
+require 'spec'
+require 'spec/autorun'
+require 'webmock/rspec'
+
+include WebMock
+
+def host_xrd
+  <<-XML
+  <?xml version='1.0' encoding='UTF-8'?>
+  <!-- NOTE: this host-meta end-point is a pre-alpha work in progress.   Don't rely on it. -->
+  <!-- Please follow the list at http://groups.google.com/group/webfinger -->
+  <XRD xmlns='http://docs.oasis-open.org/ns/xri/xrd-1.0' 
+       xmlns:hm='http://host-meta.net/xrd/1.0'>
+    <hm:Host xmlns='http://host-meta.net/xrd/1.0'>example.com</hm:Host>
+    <Link rel='lrdd' 
+          template='http://example.com/webfinger/?q={uri}'>
+      <Title>Resource Descriptor</Title>
+    </Link>
+  </XRD>
+  XML
+end
+
+def finger_xrd
+  <<-XML
+  <?xml version='1.0'?>
+  <XRD xmlns='http://docs.oasis-open.org/ns/xri/xrd-1.0'>
+  	<Subject>acct:abc@example.com</Subject>
+  	<Alias>http://www.google.com/profiles/abc</Alias>
+  	<Link rel='http://portablecontacts.net/spec/1.0' href='http://www-opensocial.googleusercontent.com/api/people/'/>
+  	<Link rel='http://webfinger.net/rel/profile-page' href='http://www.google.com/profiles/abc' type='text/html'/>
+  	<Link rel='http://microformats.org/profile/hcard' href='http://www.google.com/profiles/abc' type='text/html'/>
+  	<Link rel='http://gmpg.org/xfn/11' href='http://www.google.com/profiles/abc' type='text/html'/>
+  	<Link rel='http://specs.openid.net/auth/2.0/provider' href='http://www.google.com/profiles/abc'/>
+  	<Link rel='describedby' href='http://www.google.com/profiles/abc' type='text/html'/>
+  	<Link rel='describedby' href='http://s2.googleusercontent.com/webfinger/?q=acct%3Aabc%example.com&amp;fmt=foaf' type='application/rdf+xml'/>
+  	<Link rel='http://schemas.google.com/g/2010#updates-from' href='http://buzz.googleapis.com/feeds/100660544095714416357/public/posted' type='application/atom+xml'/>
+  </XRD>
+  XML
+end
+
+def stub_success
+  stub_request(:get, 'https://example.com/.well-known/host-meta').to_return(:status => 200, :body => host_xrd)
+  stub_request(:get, /webfinger\/\?q=.*/).to_return(:status => 200, :body => finger_xrd)
+end
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: redfinger
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A Ruby Webfinger client
+email: michael@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/redfinger.rb
+- lib/redfinger/client.rb
+- lib/redfinger/finger.rb
+- lib/redfinger/link.rb
+- lib/redfinger/link_helpers.rb
+- redfinger.gemspec
+- spec/redfinger/client_spec.rb
+- spec/redfinger_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mbleigh/redfinger
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Ruby WebFinger client.
+test_files: 
+- spec/redfinger/client_spec.rb
+- spec/redfinger_spec.rb
+- spec/spec_helper.rb