webfinger 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20903f1ccf0e5605a976381cdbb8d97a0a810b84
+  data.tar.gz: 57304dadd541de3ff4b15561d469a9ceea73feca
+SHA512:
+  metadata.gz: 5c4031213d7a1a145b377e1e4c87b2433904202c468009bdee24d8c016298df1c51244ba435ab23ca809ed14fb6010b674773234e9777a69c98cf6b359c2384f
+  data.tar.gz: 182b375638a9dbc3b201a1992aafae95a0d1903b52a97c5959281c34abd1ce2742474da53e85932791f3607939ef34eabb57c294e32ac82b00d33804abeb2b62

data/README.rdoc

@@ -23,17 +23,45 @@ Or install it yourself as:
 
 == Usage
 
-  # Basic
-  WebFinger.discover! 'acct:nov@gmail.com'
+=== Basic
 
-  # Only specific relations
-  WebFinger.discover! 'acct:nov@gmail.com', rel: 'http://openid.net/specs/connect/1.0/issuer'
-  WebFinger.discover! 'acct:nov@gmail.com', rel: ['http://openid.net/specs/connect/1.0/issuer', 'vcard']
+You can discover resource metadata.
 
-  # Specify host
-  WebFinger.discover! 'acct:nov@gmail.com', host: 'mail.google.com'
+  WebFinger.discover! 'acct:nov@connect-op.heroku.com'
+  WebFinger.discover! 'connect-op.heroku.com'
+  WebFinger.discover! 'http://connect-op.heroku.com'
 
-For more detailed usage, read <code>spec/webfinger_spec.rb</code>.
+You can also specify link relations via "rel" option.
+
+  WebFinger.discover! 'acct:nov@connect-op.heroku.com', rel: 'http://openid.net/specs/connect/1.0/issuer'
+  WebFinger.discover! 'acct:nov@connect-op.heroku.com', rel: ['http://openid.net/specs/connect/1.0/issuer', 'vcard']
+
+=== Caching
+
+Caching is important in HTTP-based discovery.
+
+If you set your own cache object to <code>WebFinger.cache</code>, this gem caches the discovery result until it expires.
+(the expiry is calculated based on the "expires" value in JRD response)
+
+  # Set Cache
+  WebFinger.cache = Rails.cache
+
+  WebFinger.discover! 'acct:nov@connect-op.heroku.com' # do HTTP request
+  WebFinger.discover! 'acct:nov@connect-op.heroku.com' # use cache, no HTTP request
+
+=== Debugging
+
+Once you turn-on debugging, you can see all HTTP request/response in your log.
+
+  # Turn on debugging
+  WebFinger.debug!
+
+  # Set logger (OPTIONAL, ::Logger.new(STDOUT) is used as default)
+  WebFinger.logger = Rails.logger
+
+You can also specify URL builder to force non-HTTPS access. (NOTE: allow non-HTTPS access only for debugging, not on your production.)
+
+  WebFinger.url_builder = URI::HTTP # default URI::HTTPS
 
 == Contributing
 
@@ -45,4 +73,4 @@ For more detailed usage, read <code>spec/webfinger_spec.rb</code>.
 
 == Copyright
 
-Copyright (c) 2010 nov matake. See LICENSE for details.
+Copyright (c) 2012 nov matake. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/webfinger/request.rb

@@ -8,27 +8,14 @@ module WebFinger
       @options = options
     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
+    def discover!
+      handle_response do
+        WebFinger.http_client.get_content endpoint.to_s
       end
     end
 
     private
 
-    def cache_key
-      "webfinger:resource:#{Digest::MD5.hexdigest query_string}"
-    end
-
     def endpoint
       path = '/.well-known/webfinger'
       host, port = host_and_port
@@ -64,7 +51,7 @@ module WebFinger
 
     def handle_response
       raw_response = yield
-      jrd = MultiJson.load raw_response, symbolize_keys: true
+      jrd = MultiJson.load(raw_response).with_indifferent_access
       Response.new jrd
     rescue HTTPClient::BadResponseError => e
       case e.res.try(:status)

data/lib/webfinger/response.rb

@@ -3,8 +3,8 @@
 
 module WebFinger
   class Response < Hash
-    def initialize(hash)
-      replace hash
+    def initialize(jrd)
+      replace jrd
     end
 
     [:subject, :aliases, :properties, :links].each do |method|
@@ -13,20 +13,9 @@ module WebFinger
       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?
-        (expires - Time.now).to_i
+    def link_for(rel)
+      links.detect do |link|
+        link[:rel] == rel
       end
     end
   end

data/lib/webfinger.rb

@@ -11,14 +11,7 @@ module WebFinger
   module_function
 
   def discover!(resource, options = {})
-    Request.new(resource, options).discover!(options[:cache])
-  end
-
-  def cache=(cache)
-    @cache = cache
-  end
-  def cache
-    @cache
+    Request.new(resource, options).discover!
   end
 
   def logger
@@ -63,8 +56,5 @@ end
 
 require 'webfinger/debugger'
 require 'webfinger/exception'
-require 'webfinger/cache'
 require 'webfinger/request'
-require 'webfinger/response'
-
-WebFinger.cache = WebFinger::Cache.new
+require 'webfinger/response'

data/spec/webfinger/response_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe WebFinger::Response do
-  let(:expires) { 10.minutes.from_now }
   let(:_subject_) { 'acct:nov@matake.jp' }
   let(:aliases) { ['mailto:nov@matake.jp'] }
   let(:properties) do
@@ -15,7 +14,6 @@ describe WebFinger::Response do
   end
   subject do
     WebFinger::Response.new(
-      expires: expires,
       subject: _subject_,
       aliases: aliases,
       properties: properties,
@@ -23,11 +21,22 @@ describe WebFinger::Response do
     )
   end
 
-  its(:expired?)   { should be_false }
-  its(:expires)    { should == expires }
-  its(:expires_in) { should == (expires - Time.now).to_i }
-  its(:subject)    { should == subject }
+  its(:subject)    { should == _subject_ }
   its(:aliases)    { should == aliases }
   its(:properties) { should == properties }
   its(:links)      { should == links }
+
+  describe '#link_for' do
+    context 'when unknown' do
+      it do
+        subject.link_for('unknown').should be_nil
+      end
+    end
+
+    context 'otherwise' do
+      it do
+        subject.link_for('http://openid.net/specs/connect/1.0/issuer').should == links.first
+      end
+    end
+  end
 end

data/spec/webfinger_spec.rb

@@ -108,20 +108,6 @@ describe WebFinger do
     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 }
 

data/webfinger.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |gem|
   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 "rake"
   gem.add_development_dependency "rspec", ">= 2"
   gem.add_development_dependency "cover_me", ">= 1.2.0"
   gem.add_development_dependency "webmock", ">= 1.6.2"

metadata

@@ -1,110 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: webfinger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - nov matake
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-23 00:00:00.000000000 Z
+date: 2013-03-02 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !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
@@ -121,7 +122,6 @@ files:
 - Rakefile
 - VERSION
 - lib/webfinger.rb
-- lib/webfinger/cache.rb
 - lib/webfinger/debugger.rb
 - lib/webfinger/debugger/request_filter.rb
 - lib/webfinger/exception.rb
@@ -139,27 +139,26 @@ files:
 - webfinger.gemspec
 homepage: https://github.com/nov/webfinger
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby WebFinger client library, following IETF WebFinger WG spec updates.
 test_files:
 - spec/helpers/webmock_helper.rb

data/lib/webfinger/cache.rb

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