swd 0.0.0

data/lib/swd.rb

@@ -0,0 +1,16 @@
+module SWD
+  def self.cache=(cache)
+    @@cache = cache
+  end
+  def self.cache
+    @@cache
+  end
+  def self.discover!(attributes = {})
+    Resource.new(attributes).discover!
+  end
+end
+
+require 'swd/cache'
+require 'swd/exception'
+require 'swd/resource'
+require 'swd/response'

data/lib/swd/cache.rb

@@ -0,0 +1,8 @@
+module SWD
+  class Cache
+    def self.fetch(cache_key, options = {})
+      yield
+    end
+  end
+  self.cache = Cache
+end

data/lib/swd/exception.rb

@@ -0,0 +1,36 @@
+module SWD
+  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/swd/resource.rb

@@ -0,0 +1,79 @@
+require 'digest/md5'
+require 'json'
+require 'httpclient'
+require 'active_support/core_ext'
+require 'attr_required'
+
+module SWD
+  class Resource
+    include AttrRequired
+    attr_required :principal, :service, :host, :path
+
+    class ContentExpired < Exception; end
+
+    def initialize(attributes = {})
+      required_attributes.each do |key|
+        self.send "#{key}=", attributes[key]
+      end
+      @path ||= '/.well-known/simple-web-discovery'
+      @cache_options = attributes[:cache] || {}
+      attr_missing!
+    end
+
+    def discover!
+      SWD.cache.fetch(cache_key, @cache_options) do
+        handle_response do
+          HTTPClient.get endpoint.to_s
+        end
+      end
+    end
+
+    def endpoint
+      URI::HTTPS.build [nil, host, 443, path, {
+        :principal => principal,
+        :service => service
+      }.to_query, nil]
+    end
+
+    private
+
+    def handle_response
+      res = yield
+      case res.status
+      when 200
+        res = JSON.parse(res.body).with_indifferent_access
+        if redirect = res[:SWD_service_redirect]
+          redirect_to redirect[:location], redirect[:expires]
+        else
+          Response.new res
+        end
+      when 400
+        raise BadRequest.new(res)
+      when 401
+        raise Unauthorized.new(res)
+      when 403
+        raise Forbidden.new(res)
+      when 404
+        raise NotFound.new(res)
+      else
+        raise HttpError.new(res.code, res)
+      end
+    end
+
+    def redirect_to(location, expires)
+      uri = URI.parse(location)
+      @host, @path = uri.host, uri.path
+      raise ContentExpired if expires && expires.to_i < Time.now.utc.to_i
+      discover!
+    end
+
+    def cache_key
+      md5 = Digest::MD5.hexdigest [
+        principal,
+        service,
+        host
+      ].join(' ')
+      "swd:resource:#{md5}"
+    end
+  end
+end

data/lib/swd/response.rb

@@ -0,0 +1,11 @@
+module SWD
+  class Response
+    attr_accessor :locations, :location, :raw
+
+    def initialize(hash)
+      @locations = hash[:locations]
+      @location = @locations.first
+      @raw = hash
+    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/redirect.json

@@ -0,0 +1,5 @@
+{
+  "SWD_service_redirect": {
+    "location": "https://swd.proseware.com/swd_server"
+  }
+}

data/spec/mock_json/redirect_expired.json

@@ -0,0 +1,6 @@
+{
+  "SWD_service_redirect": {
+    "location": "https://swd.proseware.com/swd_server",
+    "expires": 1300752001
+  }
+}

data/spec/mock_json/success.json

@@ -0,0 +1,3 @@
+{
+  "locations": ["http://calendars.proseware.com/calendars/joseph"]
+}

data/spec/spec_helper.rb

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

data/spec/swd/exception_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe SWD::HttpError do
+  subject do
+    SWD::HttpError.new 400, 'Bad Request', HTTP::Message.new_response('')
+  end
+
+  its(:status)   { should == 400 }
+  its(:message)  { should == 'Bad Request' }
+  its(:response) { should be_a HTTP::Message }
+end
+
+describe SWD::BadRequest do
+  its(:status)  { should == 400 }
+  its(:message) { should == 'SWD::BadRequest' }
+end
+
+describe SWD::Unauthorized do
+  its(:status)  { should == 401 }
+  its(:message) { should == 'SWD::Unauthorized' }
+end
+
+describe SWD::Forbidden do
+  its(:status)  { should == 403 }
+  its(:message) { should == 'SWD::Forbidden' }
+end

data/spec/swd/resource_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+describe SWD::Resource do
+  subject { resource }
+  let(:resource) { SWD::Resource.new attributes }
+  let(:attributes) do
+    {
+      :principal => 'mailto:joe@example.com',
+      :service => 'urn:adatum.com:calendar',
+      :host => 'example.com'
+    }
+  end
+
+  its(:path) { should == '/.well-known/simple-web-discovery' }
+
+  [:principal, :service, :host].each do |key|
+    it "should require #{key}" do
+      expect do
+        SWD::Resource.new attributes.merge(key => nil)
+      end.should raise_error AttrRequired::AttrMissing
+    end
+  end
+
+  describe '#discover!' do
+    context 'when succeeded' do
+      it 'should return SWD::Response' do
+        mock_json resource.endpoint, 'success' do
+          res = resource.discover!
+          res.should be_a SWD::Response
+          res.locations == ['http://calendars.proseware.com/calendars/joseph']
+          res.location == 'http://calendars.proseware.com/calendars/joseph'
+          res.raw == {
+            'locations' => ['http://calendars.proseware.com/calendars/joseph']
+          }
+        end
+      end
+    end
+
+    context 'when redirected' do
+      it 'should follow redirect' do
+        resource.should_receive(:redirect_to).with(
+          'https://swd.proseware.com/swd_server', nil
+        )
+        mock_json resource.endpoint, 'redirect' do
+          resource.discover!
+        end
+      end
+
+      context 'when expired' do
+        it 'should return SWD::Response' do
+          mock_json resource.endpoint, 'redirect_expired' do
+            expect { res = resource.discover! }.should raise_error SWD::Resource::ContentExpired
+          end
+        end
+      end
+
+      context 'otherwise' do
+        it 'should return SWD::Response' do
+          mock_json resource.endpoint, 'redirect' do
+            mock_json 'https://swd.proseware.com/swd_server', 'success', :query => {
+              :principal => 'mailto:joe@example.com',
+              :service => 'urn:adatum.com:calendar'
+            } do
+              res = resource.discover!
+              res.should be_a SWD::Response
+            end
+          end
+        end
+      end
+    end
+
+    context 'when bad request' do
+      it 'should raise SWD::BadRequest' do
+        mock_json resource.endpoint, 'blank', :status => 400 do
+          expect { res = resource.discover! }.should raise_error SWD::BadRequest
+        end
+      end
+    end
+
+    context 'when unauthorized' do
+      it 'should raise SWD::Unauthorized' do
+        mock_json resource.endpoint, 'blank', :status => 401 do
+          expect { res = resource.discover! }.should raise_error SWD::Unauthorized
+        end
+      end
+    end
+
+    context 'when forbidden' do
+      it 'should raise SWD::Forbidden' do
+        mock_json resource.endpoint, 'blank', :status => 403 do
+          expect { res = resource.discover! }.should raise_error SWD::Forbidden
+        end
+      end
+    end
+
+    context 'when not found' do
+      it 'should raise SWD::NotFound' do
+        mock_json resource.endpoint, 'blank', :status => 404 do
+          expect { res = resource.discover! }.should raise_error SWD::NotFound
+        end
+      end
+    end
+
+    context 'when other error happened' do
+      it 'should raise SWD::HttpError' do
+        mock_json resource.endpoint, 'blank', :status => 500 do
+          expect { res = resource.discover! }.should raise_error SWD::HttpError
+        end
+      end
+    end
+  end
+end

data/spec/swd_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe SWD do
+  its(:cache) { should == SWD::Cache }
+
+  describe '#discover!' do
+    it 'should return SWD::Response' do
+      mock_json "https://example.com/.well-known/simple-web-discovery", 'success', :query => {
+        :principal => 'mailto:joe@example.com',
+        :service => 'urn:adatum.com:calendar'
+      } do
+        SWD.discover!(
+          :principal => 'mailto:joe@example.com',
+          :service => 'urn:adatum.com:calendar',
+          :host => 'example.com'
+        ).should be_a SWD::Response
+      end
+    end
+  end
+end

data/swd.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = "swd"
+  s.version     = File.read("VERSION")
+  s.authors     = ["nov matake"]
+  s.email       = ["nov@matake.jp"]
+  s.homepage    = "https://github.com/nov/swd"
+  s.summary     = %q{SWD (Simple Web Discovery) Client Library}
+  s.description = %q{SWD (Simple Web Discovery) Client Library}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_runtime_dependency "json", ">= 1.4.3"
+  s.add_runtime_dependency "httpclient", ">= 2.2.1"
+  s.add_runtime_dependency "activesupport", ">= 3"
+  s.add_runtime_dependency "i18n"
+  s.add_runtime_dependency "attr_required", ">= 0.0.3"
+  s.add_development_dependency "rake", ">= 0.8"
+  s.add_development_dependency "rcov", ">= 0.9"
+  s.add_development_dependency "rspec", ">= 2"
+  s.add_development_dependency "webmock", ">= 1.6.2"
+end

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification 
+name: swd
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- nov matake
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 4
+        - 3
+        version: 1.4.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httpclient
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 2
+        - 1
+        version: 2.2.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        version: "3"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: attr_required
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 0
+        - 3
+        version: 0.0.3
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  type: :development
+  version_requirements: *id009
+description: SWD (Simple Web Discovery) Client Library
+email: 
+- nov@matake.jp
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- VERSION
+- coverage/index.html
+- coverage/jquery-1.3.2.min.js
+- coverage/jquery.tablesorter.min.js
+- coverage/lib-swd-cache_rb.html
+- coverage/lib-swd-exception_rb.html
+- coverage/lib-swd-resource_rb.html
+- coverage/lib-swd-response_rb.html
+- coverage/lib-swd_rb.html
+- coverage/print.css
+- coverage/rcov.js
+- coverage/screen.css
+- lib/swd.rb
+- lib/swd/cache.rb
+- lib/swd/exception.rb
+- lib/swd/resource.rb
+- lib/swd/response.rb
+- spec/helpers/webmock_helper.rb
+- spec/mock_json/blank.json
+- spec/mock_json/redirect.json
+- spec/mock_json/redirect_expired.json
+- spec/mock_json/success.json
+- spec/spec_helper.rb
+- spec/swd/exception_spec.rb
+- spec/swd/resource_spec.rb
+- spec/swd_spec.rb
+- swd.gemspec
+homepage: https://github.com/nov/swd
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: SWD (Simple Web Discovery) Client Library
+test_files: 
+- spec/helpers/webmock_helper.rb
+- spec/mock_json/blank.json
+- spec/mock_json/redirect.json
+- spec/mock_json/redirect_expired.json
+- spec/mock_json/success.json
+- spec/spec_helper.rb
+- spec/swd/exception_spec.rb
+- spec/swd/resource_spec.rb
+- spec/swd_spec.rb