webfinger 0.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage*
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in webfinger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 nov matake
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Webfinger
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'webfinger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install webfinger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :cover_me do
+  desc "Generates and opens code coverage report."
+  task :report do
+    require 'cover_me'
+    CoverMe.complete!
+  end
+end
+
+task :spec do
+  Rake::Task['cover_me:report'].invoke
+end
+
+task default: :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/webfinger.rb

@@ -0,0 +1,70 @@
+require 'digest/md5'
+require 'httpclient'
+require 'multi_json'
+require 'active_support/core_ext'
+
+module WebFinger
+  VERSION = File.read(
+    File.join(File.dirname(__FILE__), '../VERSION')
+  ).delete("\n\r")
+
+  module_function
+
+  def discover!(resource, options = {})
+    Request.new(resource, options).discover!(options[:cache])
+  end
+
+  def cache=(cache)
+    @cache = cache
+  end
+  def cache
+    @cache
+  end
+
+  def logger
+    @logger
+  end
+  def logger=(logger)
+    @logger = logger
+  end
+  self.logger = ::Logger.new(STDOUT)
+  logger.progname = 'WebFinger'
+
+  def debugging?
+    @debugging
+  end
+  def debugging=(boolean)
+    @debugging = boolean
+  end
+  def debug!
+    self.debugging = true
+  end
+  self.debugging = false
+
+  def url_builder
+    @url_builder ||= URI::HTTPS
+  end
+  def url_builder=(builder)
+    @url_builder = builder
+  end
+
+  def http_client
+    _http_client_ = HTTPClient.new(
+      agent_name: "WebFinger (#{VERSION})"
+    )
+    _http_client_.request_filter << Debugger::RequestFilter.new if debugging?
+    http_config.try(:call, _http_client_)
+    _http_client_
+  end
+  def http_config(&block)
+    @http_config ||= block
+  end
+end
+
+require 'webfinger/debugger'
+require 'webfinger/exception'
+require 'webfinger/cache'
+require 'webfinger/request'
+require 'webfinger/response'
+
+WebFinger.cache = WebFinger::Cache.new

data/lib/webfinger/cache.rb

@@ -0,0 +1,12 @@
+module WebFinger
+  class Cache
+    def read(cache_key)
+      nil
+    end
+
+    def write(cache_key, object, options = {})
+      # do nothing
+      true
+    end
+  end
+end

data/lib/webfinger/debugger.rb

@@ -0,0 +1,3 @@
+Dir[File.dirname(__FILE__) + '/debugger/*.rb'].each do |file|
+  require file
+end

data/lib/webfinger/debugger/request_filter.rb

@@ -0,0 +1,20 @@
+module WebFinger
+  module Debugger
+    class RequestFilter
+      # Callback called in HTTPClient (before sending a request)
+      # request:: HTTP::Message
+      def filter_request(request)
+        started = "======= [WebFinger] HTTP REQUEST STARTED ======="
+        WebFinger.logger.info [started, request.dump].join("\n")
+      end
+
+      # Callback called in HTTPClient (after received a response)
+      # request::  HTTP::Message
+      # response:: HTTP::Message
+      def filter_response(request, response)
+        finished = "======= [WebFinger] HTTP REQUEST FINISHED ======="
+        WebFinger.logger.info ['-' * 50, response.dump, finished].join("\n")
+      end
+    end
+  end
+end

data/lib/webfinger/exception.rb

@@ -0,0 +1,36 @@
+module WebFinger
+  class Exception < StandardError; end
+
+  class HttpError < Exception
+    attr_accessor :status, :response
+    def initialize(status, message = nil, response = nil)
+      super message
+      @status = status
+      @response = response
+    end
+  end
+
+  class BadRequest < HttpError
+    def initialize(message = nil, response = nil)
+      super 400, message, response
+    end
+  end
+
+  class Unauthorized < HttpError
+    def initialize(message = nil, response = nil)
+      super 401, message, response
+    end
+  end
+
+  class Forbidden < HttpError
+    def initialize(message = nil, response = nil)
+      super 403, message, response
+    end
+  end
+
+  class NotFound < HttpError
+    def initialize(message = nil, response = nil)
+      super 404, message, response
+    end
+  end
+end

data/lib/webfinger/request.rb

@@ -0,0 +1,72 @@
+module WebFinger
+  class Request
+    attr_accessor :resource, :relations, :path
+
+    def initialize(resource, options = {})
+      self.resource = resource
+      self.relations = Array(options[:rel] || options[:relations])
+      self.path ||= '/.well-known/webfinger'
+    end
+
+    def discover!(cache_options = nil)
+      cached = WebFinger.cache.read cache_key
+      if cached.blank? || cached.expired?
+        fetched = handle_response do
+          WebFinger.http_client.get_content endpoint.to_s
+        end
+        cache_options ||= {}
+        cache_options[:expires_in] ||= fetched.expires_in
+        WebFinger.cache.write cache_key, fetched, cache_options
+        fetched
+      else
+        cached
+      end
+    end
+
+    private
+
+    def cache_key
+      "webfinger:resource:#{Digest::MD5.hexdigest query_string}"
+    end
+
+    def endpoint
+      host = URI.parse(resource).host || resource.split(':').last.split('@').last
+      WebFinger.url_builder.build [nil, host, nil, path, query_string, nil]
+    rescue URI::Error => e
+      raise Exception.new(e.message)
+    end
+
+    def query_string
+      query_params.join('&')
+    end
+
+    def query_params
+      _query_params_ = [{resource: resource}.to_query]
+      relations.each do |relation|
+        _query_params_ << {rel: relation}.to_query
+      end
+      _query_params_
+    end
+
+    def handle_response
+      raw_jrd = yield
+      jrd = MultiJson.load raw_jrd, symbolize_keys: true
+      Response.new jrd
+    rescue HTTPClient::BadResponseError => e
+      case e.res.try(:status)
+      when nil
+        raise Exception.new(e.message)
+      when 400
+        raise BadRequest.new('Bad Request', res)
+      when 401
+        raise Unauthorized.new('Unauthorized', res)
+      when 403
+        raise Forbidden.new('Forbidden', res)
+      when 404
+        raise NotFound.new('Not Found', res)
+      else
+        raise HttpError.new(e.res.status, e.res.reason, res)
+      end
+    end
+  end
+end

data/lib/webfinger/response.rb

@@ -0,0 +1,33 @@
+# NOTE:
+#  Make a JSON Resource Descriptor (JRD) gem as separate one and use it as superclass?
+
+module WebFinger
+  class Response < Hash
+    def initialize(hash)
+      replace hash
+    end
+
+    [:subject, :aliases, :properties, :links].each do |method|
+      define_method method do
+        self[method]
+      end
+    end
+
+    def expired?
+      expires.try(:past?)
+    end
+    def expires
+      @expires ||= case self[:expires]
+      when Time
+        self[:expires]
+      when String
+        Time.parse self[:expires]
+      end
+    end
+    def expires_in
+      if expires.present?
+        (Time.now - expires).to_i
+      end
+    end
+  end
+end

data/spec/helpers/webmock_helper.rb

@@ -0,0 +1,38 @@
+require 'webmock/rspec'
+
+module WebMockHelper
+  def mock_json(endpoint, response_file, options = {})
+    endpoint = endpoint.to_s
+    stub_request(:get, endpoint).with(
+      request_for(options)
+    ).to_return(
+      response_for(response_file, options)
+    )
+    yield
+    a_request(:get, endpoint).with(
+      request_for(options)
+    ).should have_been_made.once
+  end
+
+  private
+
+  def request_for(options = {})
+    request = {}
+    if options[:query]
+      request[:query] = options[:query]
+    end
+    request
+  end
+
+  def response_for(response_file, options = {})
+    response = {}
+    response[:body] = File.new(File.join(File.dirname(__FILE__), '../mock_json', "#{response_file}.json"))
+    if options[:status]
+      response[:status] = options[:status]
+    end
+    response
+  end
+end
+
+include WebMockHelper
+WebMock.disable_net_connect!

data/spec/mock_json/all.json

@@ -0,0 +1,27 @@
+{
+  "expires": "2012-11-16T19:41:35Z",
+  "subject": "acct:nov@example.com",
+  "aliases": ["http://nov.example.com/"],
+  "properties": {
+    "http://example.com/rel/role/": "employee"
+  },
+  "links": [{
+    "rel": "http://webfinger.net/rel/avatar",
+    "type": "image/jpeg",
+    "href": "http://nov.example.com/profile_picture.png"
+  }, {
+    "rel": "http://webfinger.net/rel/profile-page",
+    "href": "http://nov.example.com/"
+  }, {
+    "rel": "blog",
+    "type": "text/html",
+    "href": "http://blogs.nov.example.com/",
+    "titles": {
+      "en-us": "Nov's Blog",
+      "ja": "Novのブログ"
+    }
+  }, {
+    "rel": "vcard",
+    "href": "http://nov.example.com/me.vcf"
+  }]
+}

data/spec/mock_json/device_info.json

@@ -0,0 +1,7 @@
+{
+  "subject": "device:p1.example.com",
+  "links": [{
+    "rel": "http://example.com/rel/tipsi",
+    "href": "http://192.168.1.5/npap/"
+  }]
+}

data/spec/mock_json/email_config.json

@@ -0,0 +1,19 @@
+{
+  "subject": "mailto:nov@example.com",
+  "links": [{
+    "rel": "http://example.net/rel/smtp-server",
+    "properties": {
+      "http://example.net/email/host": "smtp.example.com",
+      "http://example.net/email/port": "587",
+      "http://example.net/email/login-required": "yes",
+      "http://example.net/email/transport": "starttls"
+    }
+  }, {
+    "rel": "http://example.net/rel/imap-server",
+    "properties": {
+      "http://example.net/email/host": "imap.example.com",
+      "http://example.net/email/port": "993",
+      "http://example.net/email/transport": "ssl"
+    }
+  }]
+}

data/spec/mock_json/open_id.json

@@ -0,0 +1,12 @@
+{
+  "expires": "2012-11-16T19:41:35Z",
+  "subject": "acct:nov@example.com",
+  "aliases": ["http://nov.example.com/"],
+  "properties": {
+    "http://example.com/rel/role/": "employee"
+  },
+  "links": [{
+    "rel": "http://openid.net/specs/connect/1.0/issuer",
+    "href": "https://openid.example.com/"
+  }]
+}

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'cover_me'
+require 'rspec'
+require 'webfinger'
+require 'helpers/webmock_helper'

data/spec/webfinger/debugger/request_filter_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe WebFinger::Debugger::RequestFilter do
+  let(:resource_endpoint) { 'https://example.com/resources' }
+  let(:request) { HTTP::Message.new_request(:get, URI.parse(resource_endpoint)) }
+  let(:response) { HTTP::Message.new_response({:hello => 'world'}.to_json) }
+  let(:request_filter) { WebFinger::Debugger::RequestFilter.new }
+
+  describe '#filter_request' do
+    it 'should log request' do
+      WebFinger.logger.should_receive(:info).with(
+        "======= [WebFinger] HTTP REQUEST STARTED =======\n" +
+        request.dump
+      )
+      request_filter.filter_request(request)
+    end
+  end
+
+  describe '#filter_response' do
+    it 'should log response' do
+      WebFinger.logger.should_receive(:info).with(
+        "--------------------------------------------------\n" +
+        response.dump +
+        "\n======= [WebFinger] HTTP REQUEST FINISHED ======="
+      )
+      request_filter.filter_response(request, response)
+    end
+  end
+end

data/spec/webfinger/request_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe WebFinger::Request do
+
+end

data/spec/webfinger_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe WebFinger do
+  let(:resource) { "acct:nov@example.com" }
+  describe '#discover' do
+    it 'should return WebFinger::Response' do
+      mock_json "https://example.com/.well-known/webfinger", 'all', query: {resource: resource} do
+        response = WebFinger.discover! resource
+        response.should be_instance_of WebFinger::Response
+      end
+    end
+  end
+
+  describe '#cache' do
+    subject { WebFinger.cache }
+
+    context 'as default' do
+      it { should be_instance_of WebFinger::Cache }
+    end
+
+    context 'when specified' do
+      let(:cacher) { 'Rails.cache or something' }
+      before { WebFinger.cache = cacher }
+      it { should == cacher }
+    end
+  end
+
+  describe '#logger' do
+    subject { WebFinger.logger }
+
+    context 'as default' do
+      it { should be_instance_of Logger }
+    end
+
+    context 'when specified' do
+      let(:logger) { 'Rails.logger or something' }
+      before { WebFinger.logger = logger }
+      it { should == logger }
+    end
+  end
+
+  describe '#debugging?' do
+    subject { WebFinger.debugging? }
+
+    context 'as default' do
+      it { should be_false }
+    end
+
+    context 'when debugging' do
+      before { WebFinger.debug! }
+      it { should be_true }
+
+      context 'when debugging mode canceled' do
+        before { WebFinger.debugging = false }
+        it { should be_false }
+      end
+    end
+  end
+
+  describe '#url_builder' do
+    subject { WebFinger.url_builder }
+
+    context 'as default' do
+      it { should == URI::HTTPS }
+    end
+
+    context 'when specified' do
+      let(:url_builder) { 'URI::HTTP or something' }
+      before { WebFinger.url_builder = url_builder }
+      it { should == url_builder }
+    end
+  end
+
+  describe '#http_client' do
+    subject { WebFinger.http_client }
+
+    describe '#request_filter' do
+      subject { WebFinger.http_client.request_filter.collect(&:class) }
+
+      context 'as default' do
+        it { should_not include WebFinger::Debugger::RequestFilter }
+      end
+
+      context 'when debugging' do
+        before { WebFinger.debug! }
+        it { should include WebFinger::Debugger::RequestFilter }
+      end
+    end
+  end
+end

data/webfinger.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |gem|
+  gem.name          = "webfinger"
+  gem.version       = File.read("VERSION").delete("\n\r")
+  gem.authors       = ["nov matake"]
+  gem.email         = ["nov@matake.jp"]
+  gem.description   = %q{Ruby WebFinger client library}
+  gem.summary       = %q{Ruby WebFinger client library, following IETF WebFinger WG spec updates.}
+  gem.homepage      = "https://github.com/nov/webfinger"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_runtime_dependency "httpclient", ">= 2.2.0.2"
+  gem.add_runtime_dependency "multi_json"
+  gem.add_runtime_dependency "activesupport", ">= 3"
+  gem.add_development_dependency "rspec", ">= 2"
+  gem.add_development_dependency "cover_me", ">= 1.2.0"
+  gem.add_development_dependency "webmock", ">= 1.6.2"
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: webfinger
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- nov matake
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0.2
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: cover_me
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+description: Ruby WebFinger client library
+email:
+- nov@matake.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/webfinger.rb
+- lib/webfinger/cache.rb
+- lib/webfinger/debugger.rb
+- lib/webfinger/debugger/request_filter.rb
+- lib/webfinger/exception.rb
+- lib/webfinger/request.rb
+- lib/webfinger/response.rb
+- spec/helpers/webmock_helper.rb
+- spec/mock_json/all.json
+- spec/mock_json/device_info.json
+- spec/mock_json/email_config.json
+- spec/mock_json/open_id.json
+- spec/spec_helper.rb
+- spec/webfinger/debugger/request_filter_spec.rb
+- spec/webfinger/request_spec.rb
+- spec/webfinger_spec.rb
+- webfinger.gemspec
+homepage: https://github.com/nov/webfinger
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby WebFinger client library, following IETF WebFinger WG spec updates.
+test_files:
+- spec/helpers/webmock_helper.rb
+- spec/mock_json/all.json
+- spec/mock_json/device_info.json
+- spec/mock_json/email_config.json
+- spec/mock_json/open_id.json
+- spec/spec_helper.rb
+- spec/webfinger/debugger/request_filter_spec.rb
+- spec/webfinger/request_spec.rb
+- spec/webfinger_spec.rb