devise_capturable 0.0.12 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa713fc1f447c824492470413d64c1c75f853c17
-  data.tar.gz: 9090c336193d4110528b5e9fcd4318023f8baa63
+  metadata.gz: 777eeba95a9a9dddc942098012ac44ec70f8d8bf
+  data.tar.gz: c1d90aca571ef6e8c4b74946a1ddf88df82d3f77
 SHA512:
-  metadata.gz: 278fd200e8f9af1654a7b2e362d598f85376acb11077be4b3bf4e765e2dc4ae885edeeadc176fccc1944ac671cbfcce04ba5f843fb06c6d8a7da1c98f70f3205
-  data.tar.gz: baabd8d4040a9f97a0114a579cc79d914a378d5a4ddfc579124fd340d834c5eb867522b0b1af8865201bcbabf704489ffb0d8f1a0b679c68a6cb2035d7b7e4a1
+  metadata.gz: 2e2625bfcb0682298219ec4d658e1a342dd9c0df7a72168b7f67ba43848ab62d97142407e82201d247fefa684d18430ea02831f8b1abdd20eda4db53ebae1f7d
+  data.tar.gz: 8306ca02c040cef24457b3ec007b48eae80dd9ae299f45b7e9647729f874eb7066efa0658da097d7e7dda03d4819a4e6020feba85d6eb2f82ad93667db2d6536

data/README.md

@@ -1,6 +1,8 @@
 # Devise::Capturable
 
-`Devise::Capturable` is a gem that makes it possible to use the Janrain Engage user registration widget, while still having a Devise authentication setup with a Rails `User` model.
+`Devise::Capturable` is a gem that makes it possible to use the Janrain Engage user registration widget as a login system, while still having a Devise authentication setup with a Rails `User` model.
+
+It can be used right out of the box with automatic user creation, or can be configured to show a "second step form", to add extra values to your user model on top of Janrain.
 
 In the following I use the name `User` for the Devise user model, but it will work with any Devise-enabled model.
 
@@ -40,8 +42,9 @@ Devise.setup do |config|
   config.capturable_server = "https://myapp.janraincapture.com"  
   config.capturable_client_id = "myclientid"
   config.capturable_client_secret = "myclientsecret"
-  # Optional, see below to override config.capturable_redirect_uri
-  # config.capturable_redirect_uri = "http://sample.com"
+  config.capturable_redirect_uri = "http://sample.com" # Optional, see below
+  config.capturable_auto_create_account = false # Optional, see below
+  config.capturable_redirect_if_no_user = "/users/sign_up" # Optional, see below
 end
 ```
 
@@ -178,7 +181,7 @@ To do so, you'll need to write your own `janrainCaptureWidgetOnLoad` function an
     janrain.capture.ui.start();
 
     // afterJanrainLogin is provided by Devise::Capturable to assist with
-    // server-side login
+    // server-side login. It automatically makes a POST request to /users/sign_in if not configured.
     janrain.events.onCaptureLoginSuccess.addHandler(afterJanrainLogin);
     janrain.events.onCaptureRegistrationSuccess.addHandler(afterJanrainLogin);
   };

data/lib/assets/javascripts/devise_capturable.js

@@ -1,32 +1,30 @@
 function afterJanrainLogin(result, path, method)
 {
   path = path || "/users/sign_in";
-  method = method || "post"
+  method = method || "post";
 
   // create form
-  var form  = $('<form accept-charset="UTF-8" action="' + path + '" method="' + method +'" id="capturable-inject-form"></form>')
+  var form  = $('<form accept-charset="UTF-8" action="' + path + '" method="' + method +'" id="capturable-inject-form"></form>');
   
   // create hidden div in form
-  var hidden_els = $('<div style="margin:0;padding:0;display:inline"></div>')
+  var hidden_els = $('<div style="margin:0;padding:0;display:inline"></div>');
 
   // add utf
-  hidden_els.append('<input name="utf8" type="hidden" value="✓">')
+  hidden_els.append('<input name="utf8" type="hidden" value="✓">');
 
   // grab forgery token
-  var token_name = $("meta[name='csrf-param']").attr('content')
-  var token_val = $("meta[name='csrf-token']").attr('content')
+  var token_name = $("meta[name='csrf-param']").attr('content');
+  var token_val = $("meta[name='csrf-token']").attr('content');
   if(token_name && token_val)
   {
-    hidden_els.prepend('<input name="'+token_name +'" type="hidden" value="'+token_val+'">')
+    hidden_els.prepend('<input name="'+token_name +'" type="hidden" value="'+token_val+'">');
   }
 
   // append hidden els to form
-  form.append(hidden_els)
+  form.append(hidden_els);
 
   // add oauth code to form
-  form.append('<input id="authorization-code" name="code" type="hidden" value="'+result.authorizationCode+'">')
-
-  janrain.capture.ui.modal.close();
+  form.append('<input id="authorization-code" name="code" type="hidden" value="'+result.authorizationCode+'">');
   
   $('body').append(form);
   form.submit()

data/lib/devise_capturable/api.rb

@@ -7,19 +7,26 @@ module Devise
 
       include HTTParty
       format :json
-      #debug_output $stderr
-    
+      
       def self.token(code)
-        redirect_uri = Devise.capturable_redirect_uri || 'http://stupidsettings.com'
-
         post("#{Devise.capturable_server}/oauth/token", :query => {
           code: code,
-          redirect_uri: redirect_uri,
+          redirect_uri: Devise.capturable_redirect_uri || 'http://stupidsettings.com',
           grant_type: 'authorization_code',
           client_id: Devise.capturable_client_id,
           client_secret: Devise.capturable_client_secret,
         })
       end
+
+      def self.refresh_token(refresh_token)
+        post("#{Devise.capturable_server}/oauth/token", :query => {
+          refresh_token: refresh_token,
+          redirect_uri: Devise.capturable_redirect_uri || 'http://stupidsettings.com',
+          grant_type: 'refresh_token',
+          client_id: Devise.capturable_client_id,
+          client_secret: Devise.capturable_client_secret,
+        })
+      end
     
       def self.entity(token)
         post("#{Devise.capturable_server}/entity", headers: { 'Authorization' => "OAuth #{token}" })

data/lib/devise_capturable/locales/en.yml

@@ -2,4 +2,5 @@ en:
   devise:
     failure:
       user:
-        capturable_invalid: "Could not login. Invalid account."
+        capturable_user_missing: "This user does not exist."
+        capturable_user_error: "There was an error signing in."

data/lib/devise_capturable/strategy.rb

@@ -20,7 +20,7 @@ module Devise
 
             # get an access token from an OAUTH code
             token = Devise::Capturable::API.token(params[:code])
-            fail!(:capturable_invalid) unless token['stat'] == 'ok'
+            fail!(:capturable_user_error) unless token['stat'] == 'ok'
 
             # get the user info form the access token
             entity = Devise::Capturable::API.entity(token['access_token'])
@@ -28,21 +28,35 @@ module Devise
             # find user with the capturable params
             user = klass.find_with_capturable_params(entity["result"])
 
-            # if the user exists
+            # if the user exists, sign in
             if user
               user.before_capturable_sign_in(entity["result"], params)
-            # if the user does not exist
-            else
+              success!(user)
+            
+            # else if we want to auto create users
+            elsif Devise.capturable_auto_create_account
               user = klass.new
               user.before_capturable_create(entity["result"], params)
               user.save!
+              success!(user)
+            
+            # else redirect to a custom URL
+            elsif Devise.capturable_redirect_if_no_user
+              
+              new_token = Devise::Capturable::API.refresh_token(token['refresh_token'])
+              return fail!(:capturable_user_error) unless new_token['stat'] == 'ok'
+           
+              fail!(:capturable_user_missing)
+              redirect!(Devise.capturable_redirect_if_no_user, :token => new_token["access_token"])
+
+            # else fail
+            else
+              fail!(:capturable_user_missing)
             end
 
-            # sign in the user
-            success!(user)
-            
           rescue Exception => e
-            fail!("Login failed: #{e.to_s}")
+            puts "Devise Capturable Error: #{e}"
+            fail!(:capturable_user_error)
           end
         end
         

data/lib/devise_capturable/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module Capturable
-    VERSION = "0.0.12"
+    VERSION = "0.1.0"
   end
 end

data/lib/devise_capturable.rb

@@ -8,13 +8,16 @@ Warden::Strategies.add(:capturable, Devise::Capturable::Strategies::Capturable)
 require 'devise_capturable/view_helpers'
 
 module Devise
-	mattr_accessor :capturable_server
-	mattr_accessor :capturable_client_id
-	mattr_accessor :capturable_client_secret
-	mattr_accessor :capturable_redirect_uri
+  mattr_accessor :capturable_server
+  mattr_accessor :capturable_client_id
+  mattr_accessor :capturable_client_secret
+  mattr_accessor :capturable_redirect_uri
   mattr_accessor :capturable_auto_create_account
+  mattr_accessor :capturable_redirect_if_no_user
 end
 
+Devise.capturable_auto_create_account = true
+
 I18n.load_path.unshift File.join(File.dirname(__FILE__), *%w[devise_capturable locales en.yml])
 Devise.add_module(:capturable, :strategy => true, :controller => :sessions, :model => 'devise_capturable/model')
 

data/spec/strategy_spec.rb

@@ -22,39 +22,81 @@ describe 'Devise::Capturable' do
     allow(Devise::Capturable::API).to receive(:entity).and_return(ENTITY)
   end
 
-  describe "for an existing user" do
+  describe "if user exists" do
   
-    it "should authenticate" do
+    it "should sign in" do
       expect(User).to receive(:find_with_capturable_params).with(ENTITY["result"]).and_return(@user)
       expect(@user).to receive(:before_capturable_sign_in).with(ENTITY["result"], PARAMS)
       expect(@user).to_not receive(:save!)
       expect(@strategy).to receive(:success!).with(@user)
-      expect { @strategy.authenticate! }.to_not raise_error
+      @strategy.authenticate!
     end
 
   end
     
-  describe 'for a new user' do
+  describe "if user does not exist" do
     
     before(:each) do
       expect(User).to receive(:find_with_capturable_params).and_return(nil)
-      expect(User).to receive(:new).and_return(@user)
-      expect(@user).to receive(:before_capturable_create).with(ENTITY["result"], PARAMS)
     end
-              
-    it "should fail if unsuccessful" do
-      expect(@user).to receive(:save!).and_raise(Exception)
-      expect(@strategy).to_not receive(:success!)
-      expect(@strategy).to receive(:fail!).with("Login failed: Exception")
-      expect { @strategy.authenticate! }.to_not raise_error
+
+    describe "and capturable_auto_create_account is enabled" do
+
+      before(:each) do
+        Devise.stub(:capturable_auto_create_account).and_return(true)
+        expect(User).to receive(:new).and_return(@user)
+        expect(@user).to receive(:before_capturable_create).with(ENTITY["result"], PARAMS)
+      end
+
+      it "should fail if not saved" do
+        expect(@user).to receive(:save!).and_raise(Exception)
+        expect(@strategy).to_not receive(:success!)
+        expect(@strategy).to receive(:fail!).with(:capturable_user_error)
+        @strategy.authenticate!
+      end
+      
+      it "should succeed if saved" do
+        expect(@user).to receive(:save!).and_return(true)
+        expect(@strategy).to receive(:success!).with(@user)
+        expect(@strategy).to_not receive(:fail!)
+        @strategy.authenticate!
+      end
+
     end
-    
-    it "should succeed if successful" do
-      expect(@user).to receive(:save!).and_return(true)
-      expect(@strategy).to receive(:success!).with(@user)
-      expect(@strategy).to_not receive(:fail!)
-      expect { @strategy.authenticate! }.to_not raise_error
+
+    describe "and capturable_redirect_if_no_user is enabled" do
+
+      before(:each) do
+        Devise.stub(:capturable_auto_create_account).and_return(false)
+        Devise.stub(:capturable_redirect_if_no_user).and_return("/users/sign_up")
+      end
+
+      it "should redirect" do
+        expect(@user).to_not receive(:save!)
+        expect(@strategy).to_not receive(:success!)
+        expect(@strategy).to receive(:fail!).with(:capturable_user_missing)
+        expect(@strategy).to receive(:redirect!).with("/users/sign_up")
+        @strategy.authenticate!
+      end
+
+    end
+
+    describe "and nothing is enabled" do
+
+      before(:each) do
+        Devise.stub(:capturable_auto_create_account).and_return(false)
+        Devise.stub(:capturable_redirect_if_no_user).and_return(false)
+      end
+
+      it "should not call user save" do
+        expect(@user).to_not receive(:save!)
+        expect(@strategy).to_not receive(:success!)
+        expect(@strategy).to receive(:fail!).with(:capturable_user_missing)
+        @strategy.authenticate!
+      end
+
     end
+              
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_capturable
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.1.0
 platform: ruby
 authors:
 - Rune Skjoldborg Madsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty