lsdr-authlogic-connect 0.0.3.9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Lance Pollard (lancejpollard@gmail.com)
+ 
+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.markdown

@@ -0,0 +1,240 @@
+# AuthlogicConnect
+
+AuthlogicConnect is an extension of the Authlogic library to add extensive Oauth and OpenID support.
+
+It allows you to login through any of the 30+ Oauth and OpenID providers on the Internet.
+
+That makes life easy and gives you a lot of power.
+
+Here's a **[live example](http://authlogic-connect.heroku.com)** on Heroku ([with source](http://github.com/viatropos/authlogic-connect-example)).
+
+## Supported Providers
+
+AuthlogicConnect currently allows you to login with 7 Oauth providers and all the OpenID providers.  Feel free to add support for more as you need them.
+
+### Oauth
+
+- Twitter
+- Facebook
+- Google
+- LinkedIn
+- MySpace
+- Vimeo
+- Yahoo
+
+### OpenID
+
+- MyOpenID
+
+### Lists of all known providers here:
+
+- [Oauth Providers](http://wiki.oauth.net/ServiceProviders)
+- [OpenID Providers](http://en.wikipedia.org/wiki/List_of_OpenID_providers)
+- [More OpenID](http://openid.net/get-an-openid/)
+
+## Install and use
+
+### 1. Install AuthlogicConnect
+
+    sudo gem install authlogic-connect
+
+### 2. Add the gem dependencies in your config:
+
+Rails 2.3.x: `config/environment.rb`
+
+    config.gem "json"
+    config.gem "authlogic"
+    config.gem "oauth"
+    config.gem "oauth2"
+    config.gem "authlogic-connect"
+
+Rails 3: `Gemfile`
+
+    gem "ruby-openid"
+    gem "rack-openid", ">=0.2.1", :require => "rack/openid"
+    gem "authlogic", :git => "git://github.com/odorcicd/authlogic.git", :branch => "rails3"
+    gem "oauth"
+    gem "oauth2"
+    gem "authlogic-connect"
+    
+### 3.  Add the `OpenIdAuthentication.store`
+
+Do to [some strange problem](http://github.com/openid/ruby-openid/issues#issue/1) I have yet to really understand, Rails 2.3.5 doesn't like when `OpenIdAuthentication.store` is null, which means it uses the "in memory" store and for some reason fails.
+
+So as a fix, if you are using Rails < 3, add these at the end of your `config/environment.rb` files:
+
+In development mode:
+
+    OpenIdAuthentication.store = :file
+    
+In production (on Heroku primarily)
+
+    OpenIdAuthentication.store = :memcache
+
+### 4. Add the Migrations
+
+See the [Rails 2 Example](http://github.com/viatropos/authlogic-connect-example-rails2) and [Rails 3 Example](http://github.com/viatropos/authlogic-connect-example) projects to see what you need.  Will add a generator sometime.
+
+Files needed are:
+
+- models: User, UserSession
+- controllers: UsersController, UserSessionsController, ApplicationController
+- migrations: create\_users, create\_sessions, create\_tokens
+- initializers: config/authlogic.example.yml, config/initializers/authlogic_connect_config.rb
+- routes
+    
+### 5. Configure your keys
+
+In `config/authlogic.yml`, write your keys and secrets for each service you would like to support.  You have to manually go to the websites and register with the service provider (list of those links coming soon, in token classes for now).
+
+    connect:
+      twitter:
+        key: "my_key"
+        secret: "my_secret"
+        label: "Twitter"
+      facebook:
+        key: "my_key"
+        secret: "my_secret"
+        label: "Facebook"
+      google:
+        key: "my_key"
+        secret: "my_secret"
+        label: "Google"
+      yahoo:
+        key: "my_key"
+        secret: "my_secret"
+        label: "Yahoo"
+      myspace:
+        key: "my_key"
+        secret: "my_secret"
+      vimeo:
+        key: "my_key"
+        secret: "my_secret"
+      linked_in:
+        key: "my_key"
+        secret: "my_secret"
+
+These are then loaded via the initializer script in `config/initializers/authlogic_connect_config.rb`:
+
+    AuthlogicConnect.config = YAML.load_file("config/authlogic.yml")
+
+### 6. Make sure you save your objects properly
+
+Because of the redirects involved in Oauth and OpenID, you MUST pass a block to the `save` method in your UsersController and UserSessionsController:
+
+    @user_session.save do |result|
+      if result
+        flash[:notice] # "Login successful!"
+        redirect_back_or_default account_url
+      else
+        render :action => :new
+      end
+    end
+
+If you don't use the block, we will get a DoubleRender error.  We need the block to jump out of the rendering while redirecting.
+  
+### 7. Add Parameters to Forms in your Views
+
+There are 3 things to include in your views.
+
+First, you must specify whether this is for _registration_ or _login_.  This is stored in the `authentication_type` key with a value of `user` for registration and `session` for login:
+
+    %input{:type => :hidden, :name => :authentication_type, :value => :user}
+    
+Second, if you are using Oauth, you must include an input with name `oauth_provider` and value `twitter` or whatever other provider you might want (see example apps for dynamic example).
+
+    %input{:type => :radio, :id => :twitter_oauth_provider, :name => :oauth_provider, :value => :twitter}
+    
+Finally, if you are using OpenID, you must include an input with name `openid_identifier`, which is a text field with the value the user types in for their address:
+
+    %input.nice{:type => :text, :name => :openid_identifier}
+
+Those are passed as parameters to Authlogic, and the complicated details are abstracted away.
+
+## Overview of the User Experience
+
+There are 3 ways you a user can login with AuthlogicConnect:
+
+1. Clicking an Oauth Provider
+2. Clicking an OpenID Provider and entering in their username
+3. Manually typing in a full OpenID address
+
+Oauth is very different from OpenID, but this aims to make them work the same.
+
+## Examples
+
+These are examples of what you can get from a User.  Code is placed in controller for demo purposes, it should be abstracted into the model.
+
+### API
+
+User model has the following public accessors and methods.  This example assumes:
+
+- You've associated your Google, OpenID, and Twitter accounts with this app.
+- You're currently logged in via Google.
+
+Inside the `show` method in a controller...
+
+    def show
+      @user = @current_user
+      
+      puts @user.tokens #=> [
+        #<OpenidToken id: 12, user_id: 9, type: "OpenidToken", key: "http://my-openid-login.myopenid.com/", token: nil, secret: nil, active: nil, created_at: "2010-05-24 14:52:19", updated_at: "2010-05-24 14:52:19">,
+        #<TwitterToken id: 13, user_id: 9, type: "TwitterToken", key: "my-twitter-id-123", token: "twitter-token", secret: "twitter-secret", active: nil, created_at: "2010-05-24 15:03:05", updated_at: "2010-05-24 15:03:05">,
+        #<GoogleToken id: 14, user_id: 9, type: "GoogleToken", key: "my-email@gmail.com", token: "google-token", secret: "google-secret", active: nil, created_at: "2010-05-24 15:09:04", updated_at: "2010-05-24 15:09:04">]
+          
+      puts @user.tokens.length #=> 3
+      
+      # currently logged in with...
+      puts @user.active_token #=> #<GoogleToken id: 14, user_id: 9, type: "GoogleToken", key: "my-email@gmail.com", token: "google-token", secret: "google-secret", active: nil, created_at: "2010-05-24 15:09:04", updated_at: "2010-05-24 15:09:04">
+        
+      puts @user.authenticated_with #=> ["twitter", "openid", "google"]
+      puts @user.authenticated_with?(:twitter) #=> true
+      puts @user.authenticated_with?(:facebook) #=> false
+      
+      puts @user.has_token?(:google) #=> true
+      
+      puts @user.get_token(:google) #=> #<GoogleToken id: 14, user_id: 9, type: "GoogleToken", key: "my-email@gmail.com", token: "google-token", secret: "google-secret", active: nil, created_at: "2010-05-24 15:09:04", updated_at: "2010-05-24 15:09:04">
+      
+      # change active_token
+      @user.active_token = @user.get_token(:twitter)
+      puts @user.active_token #=> #<TwitterToken id: 13, user_id: 9, type: "TwitterToken", key: "my-twitter-id-123", token: "twitter-token", secret: "twitter-secret", active: nil, created_at: "2010-05-24 15:03:05", updated_at: "2010-05-24 15:03:05">
+      
+      # access oauth api
+      @twitter = @user.active_token
+      @twitter_profile = JSON.parse(@twitter.get("/account/verify_credentials.json").body) #=> twitter api stuff
+      # ...
+    end
+
+### Get Facebook Data
+
+If they've associated their Facebook account with your site, you can access Facebook data.
+
+    def show
+      @user = @current_user
+      token = @user.active_token # assuming this is FacebookToken
+      facebook = JSON.parse(token.get("/me"))
+      @profile = {
+        :id     => facebook["id"],
+        :name   => facebook["name"],
+        :photo  => "https://graph.facebook.com/#{facebook["id"]}/picture",
+        :link   => facebook["link"],
+        :title  => "Facebook"
+      }
+      @profile = @user.profile
+    end
+
+## Helpful links
+
+*	**Authlogic:** [http://github.com/binarylogic/authlogic](http://github.com/binarylogic/authlogic)
+*	**AuthlogicConnect Example Project:** [http://github.com/viatropos/authlogic-connect-example](http://github.com/viatropos/authlogic-connect-example)
+*	**Live example with Twitter and Facebook using Rails 3:** [http://authlogic-connect.heroku.com](http://authlogic-connect.heroku.com)
+* **Rails 2.3.5 Example:** [http://github.com/viatropos/authlogic-connect-example-rails2](http://github.com/viatropos/authlogic-connect-example-rails2)
+* **Rubygems Repository:** [http://rubygems.org/gems/authlogic-connect](http://rubygems.org/gems/authlogic-connect)
+
+## Rest...
+
+Thanks for the people that are already extending the project, all the input making things move much faster.
+
+Feel free to add to the wiki if you figure things out or make new distinctions.
+
+https://rpxnow.com/features

data/Rakefile

@@ -0,0 +1,71 @@
+require 'rake'
+require "rake/rdoctask"
+require 'rake/gempackagetask'
+
+# http://docs.rubygems.org/read/chapter/20
+spec = Gem::Specification.new do |s|
+  s.name              = "lsdr-authlogic-connect"
+  s.author            = "Lance Pollard"
+  s.version           = "0.0.3.9"
+  s.summary           = "Authlogic Connect: Let your app use all of Oauth and OpenID"
+  s.homepage          = "http://github.com/lsdr/authlogic-connect"
+  s.email             = "lsdrocha@gmail.com"
+  s.description       = "authlogic-connect fork to solve a few nagging issues, while an update is not (business-)viable"
+  s.has_rdoc          = true
+  s.rubyforge_project = "lsdr-authlogic-connect"
+  s.platform          = Gem::Platform::RUBY
+  s.files             = %w(README.markdown Rakefile init.rb MIT-LICENSE) + Dir["{lib,rails,test}/**/*"] - Dir["test/tmp"]
+  s.require_path      = "lib"
+  s.add_dependency("activesupport", "2.3.5")
+  s.add_dependency("activerecord", "2.3.5")
+  s.add_dependency("json", "1.4.3")
+  s.add_dependency("ruby-openid", "2.1.7")
+  s.add_dependency("rack-openid", "1.0.3")
+  s.add_dependency("oauth", "0.4.0")
+  s.add_dependency("oauth2", "0.0.8")
+  s.add_dependency("authlogic", "2.1.3")
+end
+
+desc "Create .gemspec file (useful for github)"
+task :gemspec do
+  File.open("pkg/#{spec.name}.gemspec", "w") do |f|
+    f.puts spec.to_ruby
+  end
+end
+
+desc "Build the gem into the current directory"
+task :gem => :gemspec do
+  `gem build pkg/#{spec.name}.gemspec`
+end
+
+desc "Publish gem to rubygems"
+task :publish => [:package] do
+  %x[gem push pkg/#{spec.name}-#{spec.version}.gem]
+end
+
+desc "Print a list of the files to be put into the gem"
+task :manifest do
+  File.open("Manifest", "w") do |f|
+    spec.files.each do |file|
+      f.puts file
+    end
+  end
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec    = spec
+  pkg.package_dir = "pkg"
+end
+
+desc "Install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{spec.name}-#{spec.version} --no-ri --no-rdoc}
+end
+
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  files = ["README.markdown", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.markdown"
+  rdoc.title = spec.summary
+end

data/init.rb

@@ -0,0 +1 @@
+File.dirname(__FILE__) + "/rails/init.rb"

data/lib/authlogic-connect.rb

@@ -0,0 +1,27 @@
+require 'active_record'
+require "rubygems"
+require 'authlogic'
+require 'oauth'
+require 'oauth2'
+
+this = File.dirname(__FILE__)
+library = "#{this}/authlogic_connect"
+
+require "#{this}/open_id_authentication"
+require "#{library}/ext"
+require "#{library}/authlogic_connect"
+require "#{library}/callback_filter"
+require "#{library}/token"
+require "#{library}/openid"
+require "#{library}/oauth"
+require "#{library}/common"
+require "#{library}/engine" if defined?(Rails) && Rails::VERSION::MAJOR == 3
+
+custom_models =   ["#{library}/token"]
+custom_models +=  Dir["#{library}/oauth/tokens"]
+custom_models +=  Dir["#{library}/openid/tokens"]
+
+custom_models.each do |path|
+  $LOAD_PATH << path
+  ActiveSupport::Dependencies.load_paths << path
+end

data/lib/authlogic_connect/authlogic_connect.rb

@@ -0,0 +1,46 @@
+module AuthlogicConnect
+  KEY = "connect" unless defined?(KEY)
+  OAUTH = "oauth" unless defined?(OAUTH)
+  OPEN_ID = "open_id" unless defined?(OPEN_ID)
+  
+  class << self
+    
+    attr_accessor :config
+    
+    def config=(value)
+      value.recursively_symbolize_keys!
+      @config = value
+    end
+    
+    def key(path)
+      result = self.config
+      path.to_s.split(".").each { |node| result = result[node.to_sym] if result }
+      result
+    end
+    
+    def credentials(service)
+      key("#{KEY}.#{service.to_s}")
+    end
+    
+    def services
+      key(KEY)
+    end
+    
+    def service_names
+      services.keys.collect(&:to_s)
+    end
+    
+    def include?(service)
+      !credentials(service).nil?
+    end
+    
+    def token(key)
+      raise "can't find key '#{key.to_s}' in AuthlogicConnect.config" unless AuthlogicConnect.include?(key) and !key.to_s.empty?
+      "#{key.to_s.camelcase}Token".constantize
+    end
+    
+    def consumer(key)
+      token(key).consumer
+    end
+  end
+end

data/lib/authlogic_connect/callback_filter.rb

@@ -0,0 +1,19 @@
+class AuthlogicConnect::CallbackFilter
+  def initialize(app)
+    @app = app
+  end
+  
+  # this intercepts how the browser interprets the url.
+  # so we override it and say,
+  # "if we've stored a variable in the session called :auth_callback_method,
+  # then convert that into a POST call so we re-call the original method"
+  def call(env)
+    if env["rack.session"].nil?
+      raise "Make sure you are setting the session in Rack too!  Place this in config/application.rb"
+    end
+    unless env["rack.session"][:auth_callback_method].blank?
+      env["REQUEST_METHOD"] = env["rack.session"].delete(:auth_callback_method).to_s.upcase
+    end
+    @app.call(env)
+  end
+end

data/lib/authlogic_connect/common.rb

@@ -0,0 +1,10 @@
+module AuthlogicConnect::Common
+end
+
+require File.dirname(__FILE__) + "/common/state"
+require File.dirname(__FILE__) + "/common/variables"
+require File.dirname(__FILE__) + "/common/user"
+require File.dirname(__FILE__) + "/common/session"
+
+ActiveRecord::Base.send(:include, AuthlogicConnect::Common::User)
+Authlogic::Session::Base.send(:include, AuthlogicConnect::Common::Session)

data/lib/authlogic_connect/common/session.rb

@@ -0,0 +1,27 @@
+module AuthlogicConnect::Common
+  module Session
+    
+    def self.included(base)
+      base.class_eval do
+        include Variables
+        include InstanceMethods
+      end
+    end
+    
+    module InstanceMethods
+      
+      # core save method coordinating how to save the session
+      def save(&block)
+        block_destroyed = false
+        if authenticating_with_openid?
+          block_destroyed = save_with_openid(&block)
+        elsif authenticating_with_oauth?
+          block_destroyed = save_with_oauth(&block)
+        end
+        block = nil if block_destroyed
+        super(&block)
+      end
+    end
+    
+  end
+end