omniauth-rtm 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nickolay Abdrafikov
+
+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,53 @@
+# Omniauth RTM Strategy
+
+This gem provides a simple way to authenticate to [remember the milk](http://rememberthemilk.com) using OmniAuth.
+
+## Usage
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth'
+gem 'omniauth-rtm'
+```
+
+Then integrate the strategy into your middleware:
+
+```ruby
+use OmniAuth::Builder do
+  provider :rtm, ENV['RTM_KEY'], ENV['RTM_SECRET']
+end
+```
+
+In Rails, you'll want to add to the middleware stack:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :rtm, ENV['RTM_KEY'], ENV['RTM_SECRET']
+end
+```
+
+## Auth Hash Schema
+
+The following information is provided back to you for this provider:
+
+```ruby
+{
+  uid: '12345',
+  info: {
+    nickname: 'name',
+    name: 'Full Name'
+  },
+  credentials: {
+    token: 'thetoken' # can be used to auth to the API
+  }
+}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new

data/lib/omniauth-rtm.rb

@@ -0,0 +1,2 @@
+require "omniauth-rtm/version"
+require "omniauth/strategies/rtm"

data/lib/omniauth-rtm/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module RTM
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth/strategies/rtm.rb

@@ -0,0 +1,80 @@
+require 'omniauth'
+require 'moocow'
+
+module OmniAuth
+  module Strategies
+    class RTM
+      include OmniAuth::Strategy
+
+      args [:consumer_key, :consumer_secret]
+
+      option :consumer_key, nil
+      option :consumer_secret, nil
+
+      def request_phase
+        auth_url = rtm_auth.url :delete, :web #, "http://localhost:3000/auth/rtm/callback"
+
+        session['oauth'] ||= {}
+        session['oauth']['rtm'] = {}
+
+        redirect(auth_url)
+      rescue ::Timeout::Error => e
+        fail!(:timeout, e)
+      rescue ::Net::HTTPFatalError => e
+        fail!(:service_unavailable, e)
+      end
+
+      def callback_phase
+        raise OmniAuth::NoSessionError.new("Session Expired") if session['oauth'].nil?
+
+        rtm_auth.frob = request.params['frob']
+
+        @token = rtm_auth.get_token
+        rtm.token = @token
+
+        resp = rtm.check_token
+
+        @uid      = resp['auth']['user']['id']
+        @nickname = resp['auth']['user']['username']
+        @fullname = resp['auth']['user']['fullname']
+
+        super
+      rescue ::Timeout::Error => e
+        fail!(:timeout, e)
+      rescue ::Net::HTTPFatalError, ::OpenSSL::SSL::SSLError => e
+        fail!(:service_unavailable, e)
+      rescue ::RTM::VerificationException => e
+        fail!(:invalid_credentials, e)
+      rescue ::OmniAuth::NoSessionError => e
+        fail!(:session_expired, e)
+      end
+
+      uid { @uid }
+
+      info do
+        {
+          :name => @fullname,
+          :nickname => @nickname
+        }
+      end
+
+      credentials do
+        {
+          :token => @token
+        }
+      end
+
+      private
+
+      def rtm
+        @rtm ||= ::RTM::RTM.new(::RTM::Endpoint.new(options.consumer_key, options.consumer_secret))
+      end
+
+      def rtm_auth
+        @auth ||= rtm.auth
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'rtm', 'RTM'

data/omniauth-rtm.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-rtm/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nickolay Abdrafikov"]
+  gem.email         = ["nicck.olay@gmail.com"]
+  gem.description   = %q{OmniAuth strategy for Remember The Milk}
+  gem.summary       = %q{OmniAuth strategy for Remember The Milk}
+  gem.homepage      = "http://github.com/nicck/omniauth-rtm"
+
+  gem.add_runtime_dependency     'omniauth', '~> 1.0'
+  gem.add_runtime_dependency     'moocow', '~> 1.1.0'
+
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'rack-test'
+
+  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.name          = "omniauth-rtm"
+  gem.require_paths = ["lib"]
+  gem.version       = Omniauth::RTM::VERSION
+end

data/spec/omniauth/strategies/rtm_spec.rb

@@ -0,0 +1,190 @@
+require "spec_helper"
+
+describe "OmniAuth::Strategies::RTM" do
+  def app
+    Rack::Builder.new {
+      use OmniAuth::Test::PhonySession
+      use OmniAuth::Builder do
+        provider :rtm, 'apikey', 'apisec'
+      end
+      run lambda { |env| [404, {'Content-Type' => 'text/plain'}, [env.key?('omniauth.auth').to_s]] }
+    }.to_app
+  end
+
+  def session
+    last_request.env['rack.session']
+  end
+
+  it 'should add a camelization for itself' do
+    OmniAuth::Utils.camelize('rtm').should == 'RTM'
+  end
+
+  let(:rtm){ double 'rtm' }
+  let(:rtm_auth){ double 'rtm_auth' }
+  let(:auth_url){ double 'auth_url' }
+
+  before do
+    RTM::RTM.stub(:new).and_return(rtm)
+    rtm.stub(:auth).and_return(rtm_auth)
+    rtm_auth.stub(:url).and_return(auth_url)
+  end
+
+  describe '/auth/rtm' do
+    context 'successful' do
+      it 'should redirect to authorize_url' do
+        rtm_auth.should_receive(:url).with(:delete, :web).and_return(auth_url)
+
+        get '/auth/rtm'
+
+        last_response.should be_redirect
+        last_response.headers['Location'].should == auth_url
+      end
+    end
+
+    context 'unsuccessful' do
+      it 'should call fail! with :timeout' do
+        rtm_auth.stub(:url).and_raise(::Timeout::Error)
+
+        get '/auth/rtm'
+
+        last_request.env['omniauth.error'].should be_kind_of(::Timeout::Error)
+        last_request.env['omniauth.error.type'] = :timeout
+      end
+
+      it 'should call fail! with :service_unavailable' do
+        rtm_auth.stub(:url).and_raise(::Net::HTTPFatalError.new(%Q{502 "Bad Gateway"}, nil))
+
+        get '/auth/rtm'
+
+        last_request.env['omniauth.error'].should be_kind_of(::Net::HTTPFatalError)
+        last_request.env['omniauth.error.type'] = :service_unavailable
+      end
+    end
+  end
+
+  describe '/auth/rtm/callback' do
+    before do
+      rtm_auth.stub(:frob=)
+      rtm_auth.stub(:get_token).and_return('rtmaccesstoken')
+      rtm.stub(:token=)
+      rtm.stub(:check_token).and_return({
+        'auth' => {'user' => {
+          'id' => 123456,
+          'username' => 'nicck',
+          'fullname' => 'Nickolay Abdrafikov',
+        }}
+      })
+    end
+
+    it 'should call through to the master app' do
+      get '/auth/rtm/callback', {:frob => '123frob456'}, {'rack.session' => {'oauth' => {"rtm" => {}}}}
+      last_response.body.should == 'true'
+    end
+
+    it 'should pass uid to env' do
+      get '/auth/rtm/callback', {:frob => '123frob456'}, {'rack.session' => {'oauth' => {"rtm" => {}}}}
+      last_request.env['omniauth.auth']['uid'].should == 123456
+    end
+
+    it 'should pass token to env' do
+      get '/auth/rtm/callback', {:frob => '123frob456'}, {'rack.session' => {'oauth' => {"rtm" => {}}}}
+      last_request.env['omniauth.auth']['provider'].should == 'rtm'
+      last_request.env['omniauth.auth']['credentials']['token'].should == 'rtmaccesstoken'
+    end
+
+    it 'should pass info to env' do
+      get '/auth/rtm/callback', {:frob => '123frob456'}, {'rack.session' => {'oauth' => {"rtm" => {}}}}
+      last_request.env['omniauth.auth']['info']['name'].should == 'Nickolay Abdrafikov'
+      last_request.env['omniauth.auth']['info']['nickname'].should == 'nicck'
+    end
+
+    describe 'rtm_api' do
+      after do
+        get '/auth/rtm/callback', {:frob => '123frob456'}, {'rack.session' => {'oauth' => {"rtm" => {}}}}
+      end
+
+      it 'should pass frob to rtm_auth' do
+        rtm_auth.should_receive(:frob=).with('123frob456')
+      end
+
+      it 'should get token from rtm_auth' do
+        rtm_auth.should_receive(:get_token)
+      end
+
+      it 'should pass token to rtm' do
+        rtm.should_receive(:token=).with('rtmaccesstoken')
+      end
+
+      it 'should fetch user info from rtm' do
+        rtm.should_receive(:check_token)
+      end
+    end
+
+    context "bad gateway (or any 5xx) for access_token" do
+      before do
+        rtm_auth.stub(:get_token).
+          and_raise(::Net::HTTPFatalError.new(%Q{502 "Bad Gateway"}, nil))
+
+        get '/auth/rtm/callback', {:frob => '123frob456'}, {'rack.session' => {'oauth' => {"rtm" => {}}}}
+      end
+
+      it 'should call fail! with :service_unavailable' do
+        last_request.env['omniauth.error'].should be_kind_of(::Net::HTTPFatalError)
+        last_request.env['omniauth.error.type'] = :service_unavailable
+      end
+    end
+
+    context "SSL failure" do
+      before do
+        rtm_auth.stub(:get_token).
+          and_raise(::OpenSSL::SSL::SSLError.new("SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed"))
+
+        get '/auth/rtm/callback', {:frob => '123frob456'}, {'rack.session' => {'oauth' => {"rtm" => {'callback_confirmed' => true, 'request_token' => 'yourtoken', 'request_secret' => 'yoursecret'}}}}
+      end
+
+      it 'should call fail! with :service_unavailable' do
+        last_request.env['omniauth.error'].should be_kind_of(::OpenSSL::SSL::SSLError)
+        last_request.env['omniauth.error.type'] = :service_unavailable
+      end
+    end
+
+    context "Timeout failure" do
+      before do
+        rtm_auth.stub(:get_token).
+          and_raise(::Timeout::Error)
+
+        get '/auth/rtm/callback', {:frob => '123frob456'}, {'rack.session' => {'oauth' => {"rtm" => {'callback_confirmed' => true, 'request_token' => 'yourtoken', 'request_secret' => 'yoursecret'}}}}
+      end
+
+      it 'should call fail! with :timeout' do
+        last_request.env['omniauth.error'].should be_kind_of(::Timeout::Error)
+        last_request.env['omniauth.error.type'] = :timeout
+      end
+    end
+
+    context "Invalid frob failure" do
+      before do
+        rtm_auth.stub(:get_token).
+          and_raise(::RTM::VerificationException)
+
+        get '/auth/rtm/callback', {:frob => '123frob456'}, {'rack.session' => {'oauth' => {"rtm" => {'callback_confirmed' => true, 'request_token' => 'yourtoken', 'request_secret' => 'yoursecret'}}}}
+      end
+
+      it 'should call fail! with :invalid_credentials' do
+        last_request.env['omniauth.error'].should be_kind_of(::RTM::VerificationException)
+        last_request.env['omniauth.error.type'] = :invalid_credentials
+      end
+    end
+  end
+
+  describe '/auth/rtm/callback with expired session' do
+    before do
+      get '/auth/rtm/callback', {:from => '123frob456'}, {'rack.session' => {}}
+    end
+
+    it 'should call fail! with :session_expired' do
+      last_request.env['omniauth.error'].should be_kind_of(::OmniAuth::NoSessionError)
+      last_request.env['omniauth.error.type'] = :session_expired
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+if ENV["COVERAGE"]
+  require 'simplecov'
+
+  SimpleCov.start {
+    add_filter "/vendor/"
+    add_filter "/spec/"
+  }
+end
+
+require 'rspec'
+require 'rack/test'
+require 'omniauth'
+require 'omniauth-rtm'
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+
+  config.mock_with :rspec
+  config.fail_fast
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-rtm
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nickolay Abdrafikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: &2193240960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2193240960
+- !ruby/object:Gem::Dependency
+  name: moocow
+  requirement: &2193240460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2193240460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2193240000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *2193240000
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2193239620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2193239620
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &2193239160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2193239160
+description: OmniAuth strategy for Remember The Milk
+email:
+- nicck.olay@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-rtm.rb
+- lib/omniauth-rtm/version.rb
+- lib/omniauth/strategies/rtm.rb
+- omniauth-rtm.gemspec
+- spec/omniauth/strategies/rtm_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/nicck/omniauth-rtm
+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'
+      segments:
+      - 0
+      hash: -2558610393677787504
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2558610393677787504
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: OmniAuth strategy for Remember The Milk
+test_files:
+- spec/omniauth/strategies/rtm_spec.rb
+- spec/spec_helper.rb