warden-salesforce 0.1.0

data/.gitignore

@@ -0,0 +1,8 @@
+coverage
+.bundle
+pkg
+.DS_Store
+Gemfile.lock
+vendor/gems
+*.gem
+.rbenv-version

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--order rand

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - ree
+  - ruby-head

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+
+gem 'ruby-debug19',     :platforms => :ruby_19
+gem 'ruby-debug',       :platforms => :ruby_18
+
+# Specify your gem's dependencies in warden-github.gemspec
+gemspec
+
+# vim:ft=ruby

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Corey Donohoe
+
+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,14 @@
+warden-salesforce
+=============
+
+A [warden](http://github.com/hassox/warden) strategy that provides oauth authentication to salesforce.
+
+To test it out on localhost set your callback url to 'http://localhost:9292/auth/salesforce/callback'
+
+There's an example app in [spec/app.rb](/ejholmes/warden-salesforce/blob/master/spec/app.rb).
+
+The Extension in Action
+=======================
+    % gem install bundler
+    % bundle install
+    % SALESFORCE_CLIENT_ID="<from SF>" SALESFORCE_CLIENT_SECRET="<from GH>" bundle exec rackup -p9393 -E none

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems/package_task'
+require 'rubygems/specification'
+require 'date'
+require 'bundler'
+
+task :default => [:spec]
+
+require 'rspec/core/rake_task'
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/config.ru

@@ -0,0 +1,17 @@
+ENV['RACK_ENV'] ||= 'development'
+
+begin
+  require File.expand_path('../.bundle/environment', __FILE__)
+rescue LoadError
+  require "rubygems"
+  require "bundler"
+  Bundler.setup
+end
+
+$LOAD_PATH << File.dirname(__FILE__) + '/lib'
+require File.expand_path(File.join(File.dirname(__FILE__), 'lib', 'warden-salesforce'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec', 'app'))
+
+run Example.app
+
+# vim:ft=ruby

data/lib/warden-salesforce.rb

@@ -0,0 +1,13 @@
+require 'warden'
+require 'oauth2'
+require 'yajl'
+
+module Warden
+  module Salesforce
+    class SalesforceMisconfiguredError < StandardError; end
+  end
+end
+
+require 'warden-salesforce/version'
+require 'warden-salesforce/user'
+require 'warden-salesforce/strategy'

data/lib/warden-salesforce/strategy.rb

@@ -0,0 +1,88 @@
+Warden::Strategies.add(:salesforce) do
+  # Need to make sure that we have a pure representation of the query string.
+  # Rails adds an "action" parameter which causes the openid gem to error
+  def params
+    @params ||= Rack::Utils.parse_query(request.query_string)
+  end
+
+  def authenticate!
+    if(params['code'] && params['state'] &&
+       env['rack.session']['salesforce_oauth_state'] &&
+       env['rack.session']['salesforce_oauth_state'].size > 0 &&
+       params['state'] == env['rack.session']['salesforce_oauth_state'])
+      begin
+        access_token = access_token(params['code'])
+
+        success!(Warden::Salesforce::User.new(access_token))
+      rescue OAuth2::Error
+        %(<p>Outdated ?code=#{params['code']}:</p><p>#{$!}</p><p><a href="/auth/salesforce">Retry</a></p>)
+      end
+    else
+      env['rack.session']['salesforce_oauth_state'] = state
+      env['rack.session']['return_to'] = env['REQUEST_URI']
+      throw(:warden, [ 302, {'Content-Type' => 'text/html', 'Location' => authorize_url}, [ ]])
+    end
+  end
+
+private
+
+  def client
+    @client ||= OAuth2::Client.new client_id, secret, {
+      :site          => oauth_domain,
+      :token_url     => '/services/oauth2/token',
+      :authorize_url => '/services/oauth2/authorize'
+    }
+  end
+
+  def authorize_url
+    client.auth_code.authorize_url(
+      :state        => state,
+      :scope        => scopes,
+      :redirect_uri => callback_url
+    )
+  end
+
+  def access_token(code)
+    client.auth_code.get_token(code, :redirect_uri => callback_url)
+  end
+
+  def state
+    @state ||= Digest::SHA1.hexdigest(rand(36**8).to_s(36))
+  end
+
+  def oauth_domain
+    config[:salesforce_oauth_domain]
+  end
+
+  def client_id
+    config[:salesforce_client_id]
+  end
+
+  def secret
+    config[:salesforce_secret]
+  end
+
+  def scopes
+    config[:salesforce_scopes]
+  end
+
+  def config
+    env['warden'].config
+  end
+
+  def callback_url
+    absolute_url(request, env['warden'].config[:salesforce_callback_url], env['HTTP_X_FORWARDED_PROTO'])
+  end
+
+  def absolute_url(request, suffix = nil, proto = "http")
+    port_part = case request.scheme
+                when "http"
+                  request.port == 80 ? "" : ":#{request.port}"
+                when "https"
+                  request.port == 443 ? "" : ":#{request.port}"
+                end
+
+    proto = "http" if proto.nil?
+    "#{proto}://#{request.host}#{port_part}#{suffix}"
+  end
+end

data/lib/warden-salesforce/user.rb

@@ -0,0 +1,22 @@
+module Warden
+  module Salesforce
+    class User
+      attr_reader :token
+      attr_reader :refresh_token
+      attr_reader :instance_url
+      attr_reader :raw_info
+
+      def initialize(access_token)
+        @token         = access_token.token
+        @refresh_token = access_token.refresh_token
+        @instance_url  = access_token.params['instance_url']
+        @raw_info      = access_token.post(access_token['id']).parsed
+      end
+
+      def username
+        raw_info['username']
+      end
+
+    end
+  end
+end

data/lib/warden-salesforce/version.rb

@@ -0,0 +1,5 @@
+module Warden
+  module Salesforce
+    VERSION = "0.1.0"
+  end
+end

data/spec/app.rb

@@ -0,0 +1,70 @@
+require 'sinatra'
+
+module Example
+  class App < Sinatra::Base
+    enable  :sessions
+    enable  :raise_errors
+    disable :show_exceptions
+
+    use Warden::Manager do |manager|
+      manager.default_strategies :salesforce
+      manager.failure_app = BadAuthentication
+
+      manager[:salesforce_client_id]    = ENV['SALESFORCE_CLIENT_ID']     || 'ee9aa24b64d82c21535a'
+      manager[:salesforce_secret]       = ENV['SALESFORCE_CLIENT_SECRET'] || 'ed8ff0c54067aefb808dab1ca265865405d08d6f'
+
+      manager[:salesforce_scopes]       = 'api'
+      manager[:salesforce_oauth_domain] = ENV['SALESFORCE_OAUTH_DOMAIN'] || 'https://login.salesforce.com'
+      manager[:salesforce_callback_url] = '/auth/salesforce/callback'
+    end
+
+    helpers do
+      def ensure_authenticated
+        unless env['warden'].authenticate!
+          throw(:warden)
+        end
+      end
+
+      def user
+        env['warden'].user
+      end
+    end
+
+    get '/' do
+      ensure_authenticated
+      <<-EOS
+      <h2>Token, #{user.username}!</h2>
+      <h3>Instance URL, #{user.instance_url}</h3>
+      #{user.raw_info}
+      EOS
+    end
+
+    get '/redirect_to' do
+      ensure_authenticated
+      "Hello There, #{user.name}! return_to is working!"
+    end
+
+    get '/auth/salesforce/callback' do
+      ensure_authenticated
+      redirect '/'
+    end
+
+    get '/logout' do
+      env['warden'].logout
+      "Peace!"
+    end
+  end
+
+  class BadAuthentication < Sinatra::Base
+    get '/unauthenticated' do
+      status 403
+      "Unable to authenticate, sorry bud."
+    end
+  end
+
+  def self.app
+    @app ||= Rack::Builder.new do
+      run App
+    end
+  end
+end

data/spec/oauth_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Warden::Salesforce" do
+  it "requesting an url that requires authentication redirects to salesforce" do
+    response = get "/"
+
+    uri = Addressable::URI.parse(response.headers["Location"])
+
+    uri.scheme.should eql('https')
+    uri.host.should eql('login.salesforce.com')
+
+    params = uri.query_values
+    params['response_type'].should eql('code')
+    params['scope'].should eql('api')
+    params['client_id'].should match(/\w{20}/)
+    params['redirect_uri'].should eql('http://example.org/auth/salesforce/callback')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+Bundler.require(:default, :runtime, :test)
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'warden-salesforce')
+require File.join(File.dirname(__FILE__), 'app')
+require 'rack/test'
+require 'webrat'
+require 'addressable/uri'
+require 'pp'
+
+Webrat.configure do |config|
+  config.mode = :rack
+  config.application_port = 4567
+end
+
+RSpec.configure do |config|
+  config.include(Rack::Test::Methods)
+  config.include(Webrat::Methods)
+  config.include(Webrat::Matchers)
+
+  config.before(:each) do
+  end
+
+  def app
+    Example.app
+  end
+end

data/warden-salesforce.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'warden-salesforce/version'
+
+Gem::Specification.new do |s|
+  s.name        = "warden-salesforce"
+  s.version     = Warden::Salesforce::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Eric Holmes"]
+  s.email       = ["eric@ejholmes.net"]
+  s.homepage    = "http://github.com/ejholmes/warden-salesforce"
+  s.summary     = "A warden strategy for easy oauth integration with Salesforce.com and Databasedot.com"
+  s.description = s.summary
+
+  s.rubyforge_project = "warden-salesforce"
+
+  s.add_dependency "json",   "~>1.5"
+  s.add_dependency "warden", "~>1.0"
+  s.add_dependency "oauth2", "~>0.5.2"
+  s.add_dependency "rest-client", "~>1.6.1"
+  s.add_dependency "yajl-ruby",     "~>1.1"
+
+  s.add_development_dependency "rack",      "~>1.4.0"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec",     "~>2.8.0"
+  s.add_development_dependency "webrat"
+  s.add_development_dependency "sinatra"
+  s.add_development_dependency "shotgun"
+  s.add_development_dependency "addressable", "~>2.2.0"
+  s.add_development_dependency "rack-test",   "~>0.5.3"
+
+  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"]
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: warden-salesforce
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Eric Holmes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70105052691400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70105052691400
+- !ruby/object:Gem::Dependency
+  name: warden
+  requirement: &70105052690900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70105052690900
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: &70105052690440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70105052690440
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70105052689980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70105052689980
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &70105052689520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70105052689520
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70105052689060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *70105052689060
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70105052688680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70105052688680
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70105052688140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70105052688140
+- !ruby/object:Gem::Dependency
+  name: webrat
+  requirement: &70105052687720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70105052687720
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70105052687260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70105052687260
+- !ruby/object:Gem::Dependency
+  name: shotgun
+  requirement: &70105052686840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70105052686840
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: &70105052686340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: *70105052686340
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70105052685840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: *70105052685840
+description: A warden strategy for easy oauth integration with Salesforce.com and
+  Databasedot.com
+email:
+- eric@ejholmes.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- config.ru
+- lib/warden-salesforce.rb
+- lib/warden-salesforce/strategy.rb
+- lib/warden-salesforce/user.rb
+- lib/warden-salesforce/version.rb
+- spec/app.rb
+- spec/oauth_spec.rb
+- spec/spec_helper.rb
+- warden-salesforce.gemspec
+homepage: http://github.com/ejholmes/warden-salesforce
+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: warden-salesforce
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A warden strategy for easy oauth integration with Salesforce.com and Databasedot.com
+test_files:
+- spec/app.rb
+- spec/oauth_spec.rb
+- spec/spec_helper.rb
+has_rdoc: