devise_capturable 0.0.5 → 0.0.6

data/README.md

@@ -20,7 +20,7 @@ You will need to perform these steps to setup the gem.
 #### Add gem to Gemfile
 
 ```ruby
-gem "devise_capturable", :git => "git://github.com/runemadsen/devise-capturable.git"
+gem "devise_capturable"
 ```
 
 #### Add `:capturable` to your `User` model
@@ -113,21 +113,34 @@ You can delete these settings from your embed code, as the gem will set them for
 ## Changing defaults
 
 
-#### Overriding `set_capturable_params`
+#### Overriding `before_capturable_create`
 
-There are times where you might want to save more than the `email` of your user in the Rails `User` model. You can override the `set_capturable_params` instance method to do this. Here's an example where I'm also saving the `uuid`. The `capture_data` parameter passed to the function is the Janrain Capture `entity` JSON result that has a bunch of information about the user.
+There are times where you might want to save more than the `email` of your user in the Rails `User` model. You can override the `before_capturable_create` instance method to do this. Here's an example where I'm also saving the `uuid`. The `capture_data` parameter passed to the function is the Janrain Capture `entity` JSON result that has a bunch of information about the user, and the `params` parameter is the controller parameters.
 
 ```ruby
 class User < ActiveRecord::Base
   devise ..., :capturable
-  attr_accessible ..., :email, uuid
-  def set_capturable_params(capture_data)
+  def before_capturable_create(capture_data, params)
   	self.email = capture_data["email"]
   	self.uuid = capture_data["uuid"]
   end
 end
 ```
 
+#### Overriding `before_capturable_sign_in`
+
+You might also want to update your Rails model if the data changes on the Janrain side. You can use the `before_capturable_sign_in` method for this. This method is empty by default, but can be defined in your model to update certain attributes. Here's an example where we update the fake "is_awesome" attribute.
+
+```ruby
+class User < ActiveRecord::Base
+  devise ..., :capturable
+  def before_capturable_sign_in(capture_data, params)
+    self.is_awesome = capture_data["is_awesome"]
+    self.save!
+  end
+end
+```
+
 #### Overriding `find_with_capturable_params`
 
 When a user logs in, Devise will call the Capture API and try to find a user with the email returned by the API. You can change this by overriding the `find_with_capturable_params` instance method in your `User` model. Here's an example where I'm telling Devise to find the user by the `uuid` instead.

data/lib/devise_capturable/model.rb

@@ -10,24 +10,18 @@ module Devise
         end
       end
 
-      # This is called from strategy and is used to fill a user model before saving
-      # It defaults to just setting the uuid, but you can override this in your user model
-      def set_capturable_params(capture_data)
+      # This is called from strategy and is used to fill a user model before creating it
+      # It defaults to just setting the email, but you can override this in your user model
+      def before_capturable_create(capture_data, params)
         self.email = capture_data["email"]
       end
 
-      module ClassMethods
-
-        # Configuration params accessible within +Devise.setup+ procedure (in initalizer).
-        #
-        #   Devise.setup do |config|
-        #     config.capturable_auto_create_account = true
-        #   end
-        ::Devise::Models.config(self, :capturable_auto_create_account)
+      # This is called from strategy and *can* be used to update an existing user model if 
+      # the data changes on the janrain side. It defaults to doing nothing.
+      def before_capturable_sign_in(capture_data, params)
+      end
 
-        def capturable_auto_create_account?
-          self.capturable_auto_create_account
-        end
+      module ClassMethods
 
         # This is called from strategy and is used to find a user when returning from janrain
         # It defaults to find_by_uuid, but you can override this in your user model

data/lib/devise_capturable/strategy.rb

@@ -9,7 +9,7 @@ module Devise
       class Capturable < ::Devise::Strategies::Base
 
         def valid?
-          valid_controller? && valid_params? && mapping.to.respond_to?(:find_with_capturable_params) && mapping.to.method_defined?(:set_capturable_params)
+          valid_controller? && valid_params? && mapping.to.respond_to?(:find_with_capturable_params) && mapping.to.method_defined?(:before_capturable_create) && mapping.to.method_defined?(:before_capturable_sign_in)
         end
 
         def authenticate!
@@ -21,17 +21,18 @@ module Devise
             fail!(:capturable_invalid) unless token['stat'] == 'ok'
               
             entity = Devise::Capturable::API.entity(token['access_token'])
-            user = klass.find_with_capturable_params(entity["result"]) 
-
-            unless klass.capturable_auto_create_account?
-              fail!(:capturable_invalid)
-              return
+            user = klass.find_with_capturable_params(entity["result"])
+
+            if user
+              user.before_capturable_sign_in(entity["result"], params)
+            else
+              user = klass.new
+              user.before_capturable_create(entity["result"], params)
+              user.save
             end
-            
-            user ||= klass.new
-            user.set_capturable_params(entity["result"])            
-            user.save(:validate => false)
+
             success!(user)
+
           rescue Exception => e
             fail!(:capturable_invalid)
           end

data/lib/devise_capturable/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module Capturable
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/lib/devise_capturable.rb

@@ -11,8 +11,6 @@ module Devise
 	mattr_accessor :capturable_server
 	mattr_accessor :capturable_client_id
 	mattr_accessor :capturable_client_secret
-  mattr_accessor :capturable_auto_create_account
-  @@capturable_auto_create_account = true
 end
 
 I18n.load_path.unshift File.join(File.dirname(__FILE__), *%w[devise_capturable locales en.yml])

data/spec/spec_helper.rb

@@ -9,4 +9,5 @@ end
 
 RSpec.configure do |config|
   config.mock_with :rspec
+  config.color_enabled = true
 end

data/spec/strategy_spec.rb

@@ -18,37 +18,38 @@ describe 'Devise::Capturable' do
     @strategy.should_receive(:mapping).and_return(@mapping)
     @strategy.should_receive(:params).at_least(1).and_return(PARAMS)
     @user = User.new
-    @user.stub(:set_capturable_params)
     Devise::Capturable::API.stub(:token).and_return(TOKEN)
     Devise::Capturable::API.stub(:entity).and_return(ENTITY)
   end
+
+  describe "for an existing user" do
   
-  it "should authenticate and set capturable params if a user exists in database" do
-    User.stub(:capturable_auto_create_account?).and_return(true)
-    @user.stub(:save).and_return(true)
-    User.should_receive(:find_with_capturable_params).with(ENTITY["result"]).and_return(@user)
-    @user.should_receive(:set_capturable_params).with(ENTITY["result"]).and_return(true)
-    @strategy.should_receive(:"success!").with(@user).and_return(true)
-    lambda { @strategy.authenticate! }.should_not raise_error
+    it "should call #before_capturable_sign_in and authenticate" do
+      @user.stub(:save).and_return(true)
+      User.should_receive(:find_with_capturable_params).with(ENTITY["result"]).and_return(@user)
+      @user.should_receive(:before_capturable_sign_in).with(ENTITY["result"], PARAMS).and_return(true)
+      @strategy.should_receive(:"success!").with(@user).and_return(true)
+      lambda { @strategy.authenticate! }.should_not raise_error
+    end
+
   end
     
-  describe 'when no user exists in database' do
+  describe 'for a new user' do
     
     before(:each) do
       User.should_receive(:find_with_capturable_params).and_return(nil)
+      User.should_receive(:new).and_return(@user)
     end
               
-    it "should fail unless capturable_auto_create_account" do
-      User.should_receive(:"capturable_auto_create_account?").and_return(false)
+    it "should call #before_capturable_create and fail is unsuccessful" do
+      @user.should_receive(:"before_capturable_create").with(ENTITY["result"], PARAMS).and_return(false)
       @strategy.should_receive(:"fail!").with(:capturable_invalid).and_return(true)
       lambda { @strategy.authenticate! }.should_not raise_error
     end
     
-    it "should create a new user and success if capturable_auto_create_account" do
-      User.should_receive(:"capturable_auto_create_account?").and_return(true)
-      User.should_receive(:new).and_return(@user)
-      @user.should_receive(:"set_capturable_params").with(ENTITY["result"]).and_return(true)
-      @user.should_receive(:save).with({ :validate => false }).and_return(true)
+    it "should call #before_capturable_create and succeed if successful" do
+      @user.should_receive(:"before_capturable_create").with(ENTITY["result"], PARAMS).and_return(true)
+      @user.should_receive(:save).and_return(true)
       @strategy.should_receive(:"success!").with(@user).and_return(true)
       lambda { @strategy.authenticate! }.should_not raise_error
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise_capturable
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-26 00:00:00.000000000 Z
+date: 2013-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty