Add API for encoding extra information in magic token

[elucid]

Hey there. We have some use cases where we want to store extra information in the token. i.e. an id of a resource the user can claim by clicking on the URL. I wanted to extend the API so that this information can be optionally passed along, and then subsequently made available somewhere on the request env upon successful decode.

Here is an example of using it, adapting the template generated controller code:

class Devise::Passwordless::MagicLinksController < DeviseController
  prepend_before_action :require_no_authentication, only: :show
  prepend_before_action :allow_params_authentication!, only: :show
  prepend_before_action(only: [:show]) { request.env['devise.skip_timeout'] = true }

  def show
    self.resource = warden.authenticate!(auth_options)
    set_flash_message!(:notice, :signed_in)
    sign_in(resource_name, resource)
    yield resource if block_given?

    # everything up to here is the standard code. the following is new:
    extra = request.env['warden.magic_link_extra']
    process_magic_link_extra(extra) if extra
  end

[elucid]

@abevoelker the fails look like container hiccups rather than code issues.

[abevoelker]

Yeah don’t worry about that, thanks very much for your contribution. Especially taking the time to include a spec 😀 Going to try to get to it in the next week as well as the rest of the backlog

…

On Fri, May 12, 2023 at 10:14 AM Justin Giancola ***@***.***> wrote: @abevoelker <https://github.com/abevoelker> the fails look like container hiccups rather than code issues. — Reply to this email directly, view it on GitHub <#27 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABFO4ZKEUGVZJDPDBDSOZLXFZHVDANCNFSM6AAAAAAX32HHAM> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[elucid]

That's great. Thanks as well.

[fastjames]

I'm currently using this feature in a local fork, and it works great. Thanks for taking the time to share it!

[dansteele]

Hey @elucid, this looks good! Can I ask how you're using it in your application? I'm not that familiar with the insides of Warden and Devise. Are you directly adding to the request.env from the controller that called authenticate_user!? Or is there another API that's better?

Cheers

[abevoelker]

Thanks for your thoughtful contribution @elucid! This has been merged into a new branch I'm working on for a 1.0.0 release. 🎉