authlogic_oauth2 1.0.2 → 1.1.0

data/README.rdoc

@@ -33,24 +33,19 @@ For information about how to set up and configure authlogic, please consult the
     end
   end
   
-IMPORTANT: make sure that you allow null values for email, crypted_password, and password_salt if they aren't required for OAuth2 users.
+IMPORTANT: make sure that you allow null values for crypted_password and password_salt if they aren't required for OAuth2 users.
   
-=== 4. Define the oauth2_client and oauth2_scope class methods in your UserSession model
+=== 4. Configure your OAuth2 client in the UserSession model
 
-The oauth2_client method should return an OAuth2::Client that is configured for your OAuth2 provider.
-
-The oauth2_scope method should return a string representing the extended permission you need to request from the OAuth2 provider.
+The oauth2_client_id, oauth2_client_secret and oauth2_site configuration values must be specified so we can initialize the connection with your OAuth2 provider. The oauth2_scope value is optional, and is used to request extended permissions from your provider.
 
 Here's an example for Facebook:
 
   class UserSession < Authlogic::Session::Base
-    def self.oauth2_client
-      OAuth2::Client.new("CLIENT_ID", "SECRET_KEY", :site => "https://graph.facebook.com")
-    end
-    
-    def self.oauth2_scope
-      'email,user_birthday'
-    end
+    oauth2_client_id      "APPLICATION_ID"
+    oauth2_client_secret  "APPLICATION_SECRET"
+    oauth2_site           "https://graph.facebook.com"
+    oauth2_scope          "email,user_birthday"
   end
   
 === 5. Make sure you save your objects properly
@@ -97,9 +92,9 @@ If you followed these steps correctly, then you should be able to register and l
 
 == Accessing API endpoints
 
-You can easily access any API endpoints that are exposed to an OAuth2 user by utilizing the oauth2 gem's "get" method on current_user#oauth2_client. For instance, you can access information about the currently logged in user's Facebook profile by doing the following:
+You can easily access any API endpoints that are exposed to an OAuth2 user by utilizing the oauth2 gem's "get" method on current_user#oauth2_access. For instance, you can access information about the currently logged in user's Facebook profile by doing the following:
 
-  current_user.oauth2_client.get('/me')
+  current_user.oauth2_access.get('/me')
   
 This will return a JSON string representing the user's profile information.
 
@@ -111,7 +106,7 @@ You can pre-populate user information by using the after_oauth2_authentication h
     ...
   
     def after_oauth2_authentication
-      json = oauth2_client.get('/me')
+      json = oauth2_access.get('/me')
 
       if user_data = JSON.parse(json)
         self.name = user_data['name']

data/authlogic_oauth2.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{authlogic_oauth2}
-  s.version = "1.0.2"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Hite"]

data/lib/authlogic_oauth2/acts_as_authentic.rb

@@ -58,7 +58,7 @@ module AuthlogicOauth2
         result
       end
 
-      # accessors for oauth2 fields
+      # Accessors for oauth2 fields
       def oauth2_token
         read_attribute(oauth2_token_field)
       end
@@ -67,7 +67,8 @@ module AuthlogicOauth2
         write_attribute(oauth2_token_field, value.blank? ? nil : value)
       end
       
-      def oauth2_client
+      # Provides access to an API exposed on the access_token object
+      def oauth2_access
         access_token
       end
 
@@ -87,11 +88,13 @@ module AuthlogicOauth2
         # Restore any attributes which were saved before redirecting to the oauth2 server
         self.attributes = session_class.controller.session.delete(:authlogic_oauth2_attributes)
         self.oauth2_token = generate_access_token.token
+        
+        # Execute callback if it's defined in the user model
         self.after_oauth2_authentication if self.respond_to?(:after_oauth2_authentication)
       end
 
       def access_token
-        OAuth2::AccessToken.new(oauth2, read_attribute(oauth2_token_field))
+        OAuth2::AccessToken.new(oauth2_client, read_attribute(oauth2_token_field))
       end
 
       def using_oauth2?
@@ -101,7 +104,8 @@ module AuthlogicOauth2
       def validate_password_with_oauth2?
         !using_oauth2? && require_password?
       end
-
+      
+      # Convenience methods for accessing configuration values
       def oauth2_token_field
         self.class.oauth2_token_field
       end

data/lib/authlogic_oauth2/oauth2_process.rb

@@ -18,7 +18,7 @@ module AuthlogicOauth2
     end
 
     def redirect_to_oauth2
-      authorize_url = oauth2.web_server.authorize_url(:redirect_uri => build_callback_url, :scope => oauth2_scope)
+      authorize_url = oauth2_client.web_server.authorize_url(:redirect_uri => build_callback_url, :scope => oauth2_scope)
 
       # Store the class which is redirecting, so we can ensure other classes
       # don't get confused and attempt to use the response
@@ -35,30 +35,41 @@ module AuthlogicOauth2
     end
 
     def generate_access_token
-      oauth2.web_server.get_access_token(oauth2_controller.params[:code], :redirect_uri => build_callback_url)
+      oauth2_client.web_server.get_access_token(oauth2_controller.params[:code], :redirect_uri => build_callback_url)
     end
 
     def oauth2_response
       oauth2_controller.params && oauth2_controller.params[:code]
     end
-
+    
+    def oauth2_client
+      OAuth2::Client.new(oauth2_client_id, oauth2_client_secret, :site => oauth2_site)
+    end
+    
+    # Convenience method for accessing the session controller
     def oauth2_controller
       is_auth_session? ? controller : session_class.controller
     end
 
-    def oauth2
-      is_auth_session? ? self.class.oauth2_client : session_class.oauth2_client
+    # Convenience methods for accessing session configuration values
+    def oauth2_client_id
+      is_auth_session? ? self.class.oauth2_client_id : session_class.oauth2_client_id
+    end
+    
+    def oauth2_client_secret
+      is_auth_session? ? self.class.oauth2_client_secret : session_class.oauth2_client_secret
+    end
+    
+    def oauth2_site
+      is_auth_session? ? self.class.oauth2_site : session_class.oauth2_site
     end
     
     def oauth2_scope
       is_auth_session? ? self.class.oauth2_scope : session_class.oauth2_scope
-    rescue NoMethodError
-      nil
     end
 
     def is_auth_session?
       self.is_a?(Authlogic::Session::Base)
     end
-
   end
 end

data/lib/authlogic_oauth2/session.rb

@@ -16,6 +16,34 @@ module AuthlogicOauth2
         rw_config(:find_by_oauth2_method, value, :find_by_oauth2_token)
       end
       alias_method :find_by_oauth2_method=, :find_by_oauth2_method
+      
+      # * <tt>Default:</tt> ''
+      # * <tt>Accepts:</tt> String
+      def oauth2_client_id(value = nil)
+        rw_config(:oauth2_client_id, value, '')
+      end
+      alias_method :oauth2_client_id=, :oauth2_client_id
+      
+      # * <tt>Default:</tt> ''
+      # * <tt>Accepts:</tt> String
+      def oauth2_client_secret(value = nil)
+        rw_config(:oauth2_client_secret, value, '')
+      end
+      alias_method :oauth2_client_secret=, :oauth2_client_secret
+      
+      # * <tt>Default:</tt> ''
+      # * <tt>Accepts:</tt> String
+      def oauth2_site(value = nil)
+        rw_config(:oauth2_site, value, '')
+      end
+      alias_method :oauth2_site=, :oauth2_site
+      
+      # * <tt>Default:</tt> ''
+      # * <tt>Accepts:</tt> String
+      def oauth2_scope(value = nil)
+        rw_config(:oauth2_scope, value, '')
+      end
+      alias_method :oauth2_scope=, :oauth2_scope
     end
 
     module Methods
@@ -67,9 +95,26 @@ module AuthlogicOauth2
         end
       end
 
+      # Convenience methods for accessing configuration values
       def find_by_oauth2_method
         self.class.find_by_oauth2_method
       end
+      
+      def oauth2_client_id
+        self.class.oauth2_client_id
+      end
+      
+      def oauth2_client_secret
+        self.class.oauth2_client_secret
+      end
+      
+      def oauth2_site
+        self.class.oauth2_site
+      end
+      
+      def oauth2_scope
+        self.class.oauth2_scope
+      end
     end
   end
 end

data/lib/authlogic_oauth2/version.rb

@@ -40,8 +40,8 @@ module AuthlogicOauth2
     end
 
     MAJOR = 1
-    MINOR = 0
-    TINY  = 2
+    MINOR = 1
+    TINY  = 0
 
     # The current version as a Version instance
     CURRENT = new(MAJOR, MINOR, TINY)

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 2
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors: 
 - Andrew Hite