passwordless 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2bd29bf2161967805f8f2f6f470d99268b72153b
-  data.tar.gz: 694a98cedafae7bec575feea7c612f3b42b1f9b2
+SHA256:
+  metadata.gz: 482e11575373d9175f46bb4ad1d70bbad5297de2b9e732a84db9051a5ea493b9
+  data.tar.gz: 578348c9d8ea9dcac2eba8576ee0f110f698c519247882c39abe1e7c420a41a6
 SHA512:
-  metadata.gz: 275b8d92d2bbdf74bfc529f60bc4a5b610623e8b0fbb1d560f66aaf523d1611f09aed459c6abcd6d8bbe7b2c20af4e77499b045dc8232e273f0b572c056be311
-  data.tar.gz: 3b4c3974fceb403115c6494175e4e9a925ff4df795cf343f6ff7b610feca41097411e519e17d483d6d8ba19f2d4e4ba16f3c1fceb1d4d82122a83ae1b92cb0bb
+  metadata.gz: e82a891d207b39e8b6dd3641f9091a7f16c082947ebb787b25bcd126135cade72f6a098405dc424c73e16431a6ded7f97f55ef2298a870bdcf01698f97083347
+  data.tar.gz: 01d409c746efa765165947fd7bf83dd15371ac55559fa881535242fcab12b333bb9d7bce1a50c3d6eb2ef0fac3bd8e3d52dbf9a9d3719ca22bf6ff4dc0cb14a7

data/README.md

@@ -10,6 +10,17 @@ Add authentication to your Rails app without all the icky-ness of passwords.
 
 ---
 
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+     * [Getting the current user, restricting access, the usual](#getting-the-current-user-restricting-access-the-usual)
+     * [Providing your own templates](#providing-your-own-templates)
+     * [Registering new users](#registering-new-users)
+     * [Generating tokens](#generating-tokens)
+     * [Redirecting back after sign-in](#redirecting-back-after-sign-in)
+* [License](#license)
+
 ## Installation
 
 Add the `passwordless` gem to your `Gemfile`:
@@ -25,6 +36,8 @@ $ bundle
 $ bin/rails passwordless:install:migrations
 ```
 
+## Usage
+
 Passwordless creates a single model called `Passwordless::Session`. It doesn't come with its own `User` model, it expects you to create one, eg.:
 
 ```
@@ -49,7 +62,7 @@ Rails.application.routes.draw do
 end
 ```
 
-## Getting the current user, restricting access, the usual
+### Getting the current user, restricting access, the usual
 
 Passwordless doesn't give you `current_user` automatically -- it's dead easy to add it though:
 
@@ -86,7 +99,7 @@ class VerySecretThingsController < ApplicationController
 end
 ```
 
-## Providing your own templates
+### Providing your own templates
 
 Override `passwordless`' bundled views by adding your own. `passwordless` has 2 action views and 1 mailer view:
 
@@ -101,7 +114,7 @@ app/views/passwordless/mailer/magic_link.text.erb
 
 See [the bundled views](https://github.com/mikker/passwordless/tree/master/app/views/passwordless).
 
-## Registering new users
+### Registering new users
 
 Because your `User` record is like any other record, you create one like you normally would. Passwordless provides a helper method you can use to sign in the created user after it is saved like so:
 
@@ -125,7 +138,7 @@ class UsersController < ApplicationController
 end
 ```
 
-## Generating tokens
+### Generating tokens
 
 By default Passwordless generates tokens using Rails' `SecureRandom.urlsafe_base64` but you can change that by setting `Passwordless.token_generator` to something else that responds to `call(session)` eg.:
 
@@ -137,6 +150,26 @@ Passwordless.token_generator = -> (session) {
 
 Session is going to keep generating tokens until it finds one that hasn't been used yet. So be sure to use some kind of method where matches are unlikely.
 
+### Redirecting back after sign-in
+
+By default Passwordless will redirect back to where the user wanted to go **if** it knows where that is, so you'll have to help it. `Passwordless::ControllerHelpers` provide a method for this:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Passwordless::ControllerHelpers # <-- Probably already have this!
+  
+  # ...
+  
+  def require_user!
+    return if current_user
+    save_passwordless_redirect_location! # <-- here we go!
+    redirect_to root_path, flash: {error: 'You are not worthy!'}
+  end
+end
+```
+
+This can be turned off with `Passwordless.redirect_back_after_sign_in = false` but if you just don't save the previous destination, you'll be fine.
+
 # License
 
 MIT

data/app/controllers/passwordless/application_controller.rb

@@ -1,5 +1,7 @@
 module Passwordless
-  class ApplicationController < ActionController::Base
-    protect_from_forgery with: :exception
+  class ApplicationController < ::ApplicationController
+    def passwordless_controller?
+      true
+    end
   end
 end

data/app/controllers/passwordless/sessions_controller.rb

@@ -42,7 +42,14 @@ module Passwordless
 
       sign_in session.authenticatable
 
-      redirect_to main_app.root_path
+      enabled = Passwordless.redirect_back_after_sign_in
+      destination = dest = reset_passwordless_redirect_location!
+
+      if enabled && destination
+        redirect_to dest
+      else
+        redirect_to main_app.root_path
+      end
     end
 
     def destroy

data/lib/passwordless.rb

@@ -6,4 +6,5 @@ module Passwordless
   mattr_accessor(:token_generator) do
     UrlSafeBase64Generator.new
   end
+  mattr_accessor(:redirect_back_after_sign_in) { true }
 end

data/{app/lib → lib}/passwordless/controller_helpers.rb

@@ -20,6 +20,14 @@ module Passwordless
       cookies.delete(key)
     end
 
+    def save_passwordless_redirect_location!
+      session[:destination_when_rejected] = request.original_url
+    end
+
+    def reset_passwordless_redirect_location!
+      session.delete :destination_when_rejected
+    end
+
     private
 
     def cookie_name(authenticatable_class)

data/lib/passwordless/engine.rb

@@ -7,6 +7,7 @@ module Passwordless
       ActionDispatch::Routing::Mapper.include RouterHelpers
       require 'passwordless/model_helpers'
       ActiveRecord::Base.extend ModelHelpers
+      require 'passwordless/controller_helpers'
     end
   end
 end

data/lib/passwordless/version.rb

@@ -1,3 +1,3 @@
 module Passwordless
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passwordless
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-11 00:00:00.000000000 Z
+date: 2017-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -64,7 +64,6 @@ files:
 - Rakefile
 - app/controllers/passwordless/application_controller.rb
 - app/controllers/passwordless/sessions_controller.rb
-- app/lib/passwordless/controller_helpers.rb
 - app/mailers/passwordless/mailer.rb
 - app/models/passwordless/application_record.rb
 - app/models/passwordless/session.rb
@@ -74,6 +73,7 @@ files:
 - config/routes.rb
 - db/migrate/20171104221735_create_passwordless_sessions.rb
 - lib/passwordless.rb
+- lib/passwordless/controller_helpers.rb
 - lib/passwordless/engine.rb
 - lib/passwordless/model_helpers.rb
 - lib/passwordless/router_helpers.rb
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: Summary of Passwordless.