devise_meetup_authenticatable 0.1.0 → 0.2.0

data/lib/devise_meetup_authenticatable.rb

@@ -1,12 +1,54 @@
-require 'devise'
 
-require 'devise_meetup_authenticatable/schema'
-require 'devise_meetup_authenticatable/strategy'
-require 'devise_meetup_authenticatable/routes'
+  require 'devise'
+  require 'oauth'
+  require 'devise_meetup_authenticatable/model'
+  require 'devise_meetup_authenticatable/strategy'
+  require 'devise_meetup_authenticatable/schema'
+  require 'devise_meetup_authenticatable/routes'
+  require 'devise_meetup_authenticatable/view_helpers'
+
+
+module Devise
+  
+  mattr_accessor :meetup_uid_field
+  @@meetup_uid_field = :meetup_uid
+
+  # Specifies the name of the database column name used for storing
+  # the user Facebook session key. Useful if this info should be saved in a
+  # generic column if different authentication solutions are used.
+  mattr_accessor :meetup_token_field
+  @@meetup_token_field = :meetup_token
+
+  # Specifies if account should be created if no account exists for
+  # a specified Facebook UID or not.
+  mattr_accessor :meetup_auto_create_account
+  @@meetup_auto_create_account = true
+  
+  def self.meetup_client
+    @@meetup_client ||= OAuth::Consumer.new("ABDAE5ED0962D3332A0B546174997828", "856263601BB15FA05D1062AA082FF6CD", :site => "http://www.meetup.com/", :request_token_url => "http://www.meetup.com/oauth/request/", :authorize_path => 'authorize/', :access_token_path => 'oauth/access/', :oauth_callback => "oob", :http_method => :post)
+    
+  end
+  
+  
+  def self.session_sign_in_url(request, mapping)
+    url = URI.parse(request.url)
+    # url.path = "#{mapping.parsed_path}/#{mapping.path_names[:sign_in]}"
+    url.path = "#{mapping.full_path}/#{mapping.path_names[:meetup]}"
+    url.query = nil
+    url.to_s
+  end
+  
+  def self.requested_scope
+    @@requested_scope ||= 'meetup'
+  end
+  
+end 
+  
+
+
 
 Devise.add_module(:meetup_authenticatable,
   :strategy => true,
-  :model => 'devise_meetup_authenticatable/model',
   :controller => :sessions,
-  :route => :meetup)
-
+  :route => :meetup,
+  :model => 'devise_meetup_authenticatable/model')

data/lib/devise_meetup_authenticatable/model.rb

@@ -1,16 +1,185 @@
-module Devise
-  module Models
-    module MeetupAuthenticatable
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
-      module ClassMethods
-        def find_by_meetup_token(meetup_token)
-          find(:first, :conditions => {:meetup_token => meetup_token})
-        end
-      end
-    end
-  end
-end
+  
+  module MeetupAuthenticatable
 
+   module Models
+     # Adds MeetupAuthenticatable support to your model. The whole workflow is deeply discussed in the
+     # README. This module adds just a class +oauth_access_token+ helper to your model
+     # which assists you on creating an access token. All the other OAuth hooks in
+     # Devise must be implemented by yourself in your application.
+     #
+     # == Options
+     #
+     # Oauthable adds the following options to devise_for:
+     #
+     #   * +oauth_providers+: Which providers are avaialble to this model. It expects an array:
+     #
+     #       devise_for :database_authenticatable, :meetup_authenticatable, :oauth_providers => [:twitter]
+     #
+     module MeetupAuthenticatable
+       
+         def self.included(base) #:nodoc:
+           base.class_eval do
+             extend ClassMethods
+           end
+         end
+
+         # Store meetup Connect account/session credentials.
+         #
+         def store_meetup_credentials!(attributes = {})
+           self.send(:"#{self.class.meetup_uid_field}=", attributes[:uid])
+           self.send(:"#{self.class.meetup_token_field}=", attributes[:token])
+
+           # Confirm without e-mail - if confirmable module is loaded.
+           self.skip_confirmation! if self.respond_to?(:skip_confirmation!)
+
+           # Only populate +email+ field if it's available (e.g. if +authenticable+ module is used).
+           self.email = attributes[:email] || '' if self.respond_to?(:email)
+
+           # Lazy hack: These database fields are required if +authenticable+/+confirmable+
+           # module(s) is used. Could be avoided with :null => true for authenticatable
+           # migration, but keeping this to avoid unnecessary problems.
+           self.password_salt = '' if self.respond_to?(:password_salt)
+           self.encrypted_password = '' if self.respond_to?(:encrypted_password)
+         end
+
+         # Checks if meetup Connected.
+         #
+         def meetup_connected?
+           self.send(:"#{self.class.meetup_uid_field}").present?
+         end
+         alias :is_meetup_connected? :meetup_connected?
+
+         # Hook that gets called *before* connect (only at creation). Useful for
+         # specifiying additional user info (etc.) from meetup.
+         #
+         # Default: Do nothing.
+         #
+         # == Examples:
+         #
+         #   # Overridden in meetup Connect:able model, e.g. "User".
+         #   #
+         #   def before_meetup_auto_create(meetup_user_attributes)
+
+         #     self.profile.first_name = meetup_user_attributes.first_name
+
+         #
+         #   end
+         #
+         # == For more info:
+         #
+         #   * http://oauth2er.pjkh.com/user/populate
+         #
+         def on_before_meetup_auto_create(meetup_user_attributes)
+
+           if self.respond_to?(:before_meetup_auto_create)
+             self.send(:before_meetup_auto_create, meetup_user_attributes) rescue nil
+           end
+         end
+
+         # Hook that gets called *after* a connection (each time). Useful for
+         # fetching additional user info (etc.) from meetup.
+         #
+         # Default: Do nothing.
+         #
+         # == Example:
+         #
+         #   # Overridden in meetup Connect:able model, e.g. "User".
+         #   #
+         #   def after_meetup_connect(meetup_user_attributes)
+         #     # See "on_before_meetup_connect" example.
+         #   end
+         #
+         def on_after_meetup_connect(meetup_user_attributes)
+
+           if self.respond_to?(:after_meetup_auto_create)
+             self.send(:after_meetup_auto_create, meetup_user_attributes) rescue nil
+           end
+         end
+
+         # Optional: Store session key.
+         #
+         def store_session(using_token)
+           if self.token != using_token
+             self.update_attribute(self.send(:"#{self.class.meetup_token_field}"), using_token)
+           end
+         end
+
+       protected
+
+       # Passwords are always required if it's a new rechord and no oauth_id exists, or if the password
+       # or confirmation are being set somewhere.
+       def password_required?
+
+         ( new_record? && meetup_uid.nil? ) || !password.nil? || !password_confirmation.nil?
+       end
+
+         module ClassMethods
+
+           # Configuration params accessible within +Devise.setup+ procedure (in initalizer).
+           #
+           # == Example:
+           #
+           #   Devise.setup do |config|
+           #     config.meetup_uid_field = :meetup_uid
+           #     config.meetup_token_field = :meetup_token
+           #     config.meetup_auto_create_account = true
+           #   end
+           #
+           ::Devise::Models.config(self,
+               :meetup_uid_field,
+               :meetup_token_field,
+               :meetup_auto_create_account
+             )
+
+           # Alias don't work for some reason, so...a more Ruby-ish alias
+           # for +meetup_auto_create_account+.
+           #
+           def meetup_auto_create_account?
+             self.meetup_auto_create_account
+           end
+
+           # Authenticate a user based on meetup UID.
+           #
+           def authenticate_with_meetup(meetup_id, meetup_token)
+
+               # find user and update access token 
+               returning(self.find_for_meetup(meetup_id)) do |user|
+                 user.update_attributes(:meetup_token => meetup_token) unless user.nil?
+               end
+
+           end
+
+           protected
+
+
+
+             # Find first record based on conditions given (meetup UID).
+             # Overwrite to add customized conditions, create a join, or maybe use a
+             # namedscope to filter records while authenticating.
+             #
+             # == Example:
+             #
+             #   def self.find_for_meetup(uid, conditions = {})
+             #     conditions[:active] = true
+             #     self.find_by_meetup_uid(uid, :conditions => conditions)
+             #   end
+             #
+             def find_for_meetup(uid, conditions = {})
+
+               self.find_by_meetup_uid(uid, :conditions => conditions)
+             end
+
+
+
+             # Contains the logic used in authentication. Overwritten by other devise modules.
+             # In the meetup Connect case; nothing fancy required.
+             #
+             def valid_for_meetup(resource, attributes)
+               true
+             end
+
+         end
+
+       end
+   end
+end

data/lib/devise_meetup_authenticatable/routes.rb

@@ -1,7 +1,15 @@
-  ActionDispatch::Routing::Mapper.class_eval do
-    
-   # map.after_login 'oauth_complete', :controller => 'meetup_callback', :action => 'after_login'
-   alias_method :oauth_complete, :devise_session
+ActionDispatch::Routing::Mapper.class_eval do
+  protected
+  
+  def devise_meetup(mapping, controllers)
+    scope mapping.full_path do
+      map.meetup '/meetup',:controller=>'oauth',:action=>'index'
+      map.authorize '/meetup/authorize',:controller=>'oauth',:action=>'authorize'
+      map.request_token '/meetup/request_token',:controller=>'oauth',:action=>'request_token'
+      map.access_token '/meetup/access_token',:controller=>'oauth',:action=>'access_token'
+      map.test_request '/meetup/test_request',:controller=>'oauth',:action=>'test_request'
+      
+    end
   end
+end
 
-end

data/lib/devise_meetup_authenticatable/schema.rb

@@ -1,9 +1,22 @@
-Devise::Schema.class_eval do
-  def meetup_authenticatable
-    if respond_to?(:apply_devise_schema)
-      apply_devise_schema :meetup_token, String
-    else
-      apply_schema :meetup_token, String
+# encoding: utf-8
+require 'devise/schema'
+
+module Devise #:nodoc:
+  module MeetupAuthenticatable #:nodoc:
+
+    module Schema
+
+      # Database migration schema for meetup Connect.
+      #
+      def meetup_authenticatable
+        apply_devise_schema ::Devise.meetup_uid_field, Integer, :limit => 8 # BIGINT unsigned / 64-bit int
+        apply_devise_schema ::Devise.meetup_token_field, String, :limit => 149 # [128][1][20] chars
+      end
+
     end
   end
+end
+
+Devise::Schema.module_eval do
+  include ::Devise::MeetupAuthenticatable::Schema
 end

data/lib/devise_meetup_authenticatable/strategy.rb

@@ -1,32 +1,103 @@
+# encoding: utf-8
 require 'devise/strategies/base'
-require 'rack/oauth'
 
-module Devise
-  module Strategies
-    class MeetupAuthenticatable < Base
-      
-      include Rack::OAuth::Methods
-      
-      
-      def valid?
-        get_access_token.present?
+
+module Devise #:nodoc:
+  module MeetupAuthenticatable #:nodoc:
+    module Strategies #:nodoc:
+
+      # Default strategy for signing in a user using Facebook Connect (a Facebook account).
+      # Redirects to sign_in page if it's not authenticated
+      #
+      class MeetupAuthenticatable < ::Devise::Strategies::Base
+        
         
-      end
 
-      def authenticate!
-        logger.debug("Authenticating with Meetup for mapping #{mapping.to}")
-        session[:info] = get_access_token.get('/account/verify_credentials.json').body
-      end
-      
-      private
-   
+        # Without a oauth session authentication cannot proceed.
+        #
+        def valid?
+          
+         valid_controller? && valid_params? && mapping.to.respond_to?('authenticate_with_meetup')
+          
+        end
+
+        # Authenticate user with meetup
+        #
+        def authenticate!
+          klass = mapping.to
+          begin
+
+
+            # Verify User Auth code and get access token from auth server: will error on failue
+            access_token = Devise::meetup_client.request_token.get_access_token
+            
+                  
+            # retrieve user attributes
+            
+            # Get user details from meetup Service
+            # NOTE: Facebook Graph Specific
+            # TODO: break this out into separate model or class to handle
+            # different meetup providers
+            meetup_user_attributes = JSON.parse(access_token.get('/me'))
       
-      def logger
-        @logger ||= ((Rails && Rails.logger) || RAILS_DEFAULT_LOGGER)
+            user = klass.authenticate_with_meetup(meetup_user_attributes['id'], access_token.token)
+
+
+
+            if user.present?
+              user.on_after_meetup_connect(meetup_user_attributes)
+              success!(user)
+            else
+              if klass.meetup_auto_create_account?
+                
+                
+                
+                user = returning(klass.new) do |u|
+                  u.store_meetup_credentials!(
+                      :token => access_token.token,
+                      :uid => meetup_user_attributes['id']
+                    )
+                  u.on_before_meetup_auto_create(meetup_user_attributes)
+                end
+
+                begin
+                  
+                  
+                  user.save(true)
+                  user.on_after_meetup_connect(meetup_user_attributes)
+                  
+                  
+                  success!(user)
+                rescue
+                  fail!(:meetup_invalid)
+                end
+              else
+                fail!(:meetup_invalid)
+              end
+            end
+          
+          rescue => e
+            fail!(e.message)
+          end
+        end
+        
+
+        
+        
+        protected
+          def valid_controller?
+            # params[:controller] == 'sessions'
+            mapping.controllers[:sessions] == params[:controller]
+          end
+
+          def valid_params?
+            params[:code].present?
+          end
+
       end
     end
   end
 end
 
-Warden::Strategies.add(:meetup_authenticatable, Devise::Strategies::MeetupAuthenticatable)
+Warden::Strategies.add(:meetup_authenticatable, Devise::MeetupAuthenticatable::Strategies::MeetupAuthenticatable)
 

data/lib/devise_meetup_authenticatable/view_helpers.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require 'devise/mapping'
+
+module Devise #:nodoc:
+  module MeetupAuthenticatable #:nodoc:
+
+    # OAuth2 view helpers to easily add the link to the OAuth2 connection popup and also the necessary JS code.
+    #
+    module Helpers
+      
+      # Creates the link to
+      def link_to_meetup(link_text, options={})
+        
+        
+        session_sign_in_url = Devise::session_sign_in_url(request,::Devise.mappings[:user])
+      
+        link_to link_text, Devise::meetup_client.request_token.authorize_url
+        
+      end
+
+
+      
+    end
+  end
+end
+
+::ActionView::Base.send :include, Devise::MeetupAuthenticatable::Helpers

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_meetup_authenticatable
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - matthew jording
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-31 00:00:00 -04:00
+date: 2010-09-07 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -40,6 +42,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -55,22 +58,15 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
-- .document
-- .gitignore
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
-- features/devise_meetup_authenticatable.feature
-- features/step_definitions/devise_meetup_authenticatable_steps.rb
-- features/support/env.rb
 - lib/devise_meetup_authenticatable.rb
 - lib/devise_meetup_authenticatable/model.rb
 - lib/devise_meetup_authenticatable/routes.rb
 - lib/devise_meetup_authenticatable/schema.rb
 - lib/devise_meetup_authenticatable/strategy.rb
+- lib/devise_meetup_authenticatable/view_helpers.rb
+- LICENSE
+- README.rdoc
 - spec/devise_meetup_authenticatable_spec.rb
-- spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/OpenGotham/devise_meetup_authenticatable
@@ -86,6 +82,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -94,6 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC

data/Rakefile

@@ -1,70 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "devise_meetup_authenticatable"
-    gem.summary = %Q{meetups oauth strategy captured for devise}
-    gem.description = %Q{meetups oauth strategy captured for devise}
-    gem.email = "mjording@opengotham.com"
-    gem.homepage = "http://github.com/OpenGotham/devise_meetup_authenticatable"
-    gem.authors = ["matthew jording"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_development_dependency "cucumber", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :spec => :check_dependencies
-
-begin
-  require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new(:features)
-
-  task :features => :check_dependencies
-rescue LoadError
-  task :features do
-    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
-  end
-end
-
-begin
-  require 'reek/adapters/rake_task'
-  Reek::RakeTask.new do |t|
-    t.fail_on_error = true
-    t.verbose = false
-    t.source_files = 'lib/**/*.rb'
-  end
-rescue LoadError
-  task :reek do
-    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
-  end
-end
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "devise_meetup_authenticatable #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-0.1.0

data/features/devise_meetup_authenticatable.feature

@@ -1,9 +0,0 @@
-Feature: something something
-  In order to something something
-  A user something something
-  something something something
-
-  Scenario: something something
-    Given inspiration
-    When I create a sweet new gem
-    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -1,4 +0,0 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'devise_meetup_authenticatable'
-
-require 'spec/expectations'

data/spec/spec.opts

@@ -1 +0,0 @@
---color