magic-link 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d9cdcff5bac8ba5789ac41f1b297408a4fba83f063d3afbb3bd585549996be9
+  data.tar.gz: 6e7cf401d907dcdb65421a2fac94084b1749b3bd84e5d0e0ac334e82738ef96d
+SHA512:
+  metadata.gz: 58db75b1fed54635bdc015e83a7f170c5c3193b054d94a35270a58f269045925c5a26004edc7ce5f9218057a72bec54d4d3095bf66aab19fce6b9ff1801a55df
+  data.tar.gz: b06b4740c460825a17e969ff4cc0d9272463c028dd6b855f49d2dff8767a6e62277601065416cc6a3d55d1b9512172d99b3d1cb6517198a1a6d987c49a028b38

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 David Van Der Beek
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Magic::Link
+Short description and motivation.
+
+## Usage
+configure the gem
+```ruby
+# config/initializers/magic_link.rb
+Magic::Link.configure do |config|
+  config.user_class = "Customer" # Default is User
+  config.email_from = "test@yourapp.com"
+  config.token_expiration_hours = 6 # Default is 6
+end
+```
+
+Add `sign_in_token` and `sign_in_token_sent_at` to your Devise class
+
+mount the engine
+```ruby
+mount Magic::Link::Engine, at: '/'
+```
+
+Now users can visit `/magic_links/new` to enter their email and have a sign in
+link sent to them via email. Tokens are cleared after use and expire after the
+configured number of hours
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'magic-link'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install magic-link
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Magic::Link'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/magic_link_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/magic/link .js
+//= link_directory ../stylesheets/magic/link .css

data/app/assets/javascripts/magic/link/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/app/assets/stylesheets/magic/link/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/magic/link/magic_links_controller.rb

@@ -0,0 +1,29 @@
+module Magic
+  module Link
+    class MagicLinksController < ::ApplicationController
+      before_action :check_user, only: :new
+
+      def new
+        @magic_link = MagicLink.new
+      end
+
+      def create
+        @magic_link = MagicLink.new(permitted_params)
+        @magic_link.send_login_instructions
+        redirect_to main_app.root_path, notice: "Check your email for a sign in link!"
+      end
+
+      private
+
+        def check_user
+          if send("#{Magic::Link.user_class.name.underscore}_signed_in?")
+            redirect_to main_app.root_path, notice: "You are already signed in"
+          end
+        end
+
+        def permitted_params
+          params.fetch(:magic_link, {}).permit(:email)
+        end
+    end
+  end
+end

data/app/helpers/magic/link/application_helper.rb

@@ -0,0 +1,29 @@
+module Magic
+  module Link
+    module ApplicationHelper
+      def method_missing method, *args, &block
+        if method.to_s.end_with?('_path') or method.to_s.end_with?('_url')
+          if main_app.respond_to?(method)
+            main_app.send(method, *args)
+          else
+            super
+          end
+        else
+          super
+        end
+      end
+
+      def respond_to?(method, include_all = false)
+        if method.to_s.end_with?('_path') or method.to_s.end_with?('_url')
+          if main_app.respond_to?(method)
+            true
+          else
+            super
+          end
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/app/jobs/magic/link/application_job.rb

@@ -0,0 +1,6 @@
+module Magic
+  module Link
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/magic/link/application_mailer.rb

@@ -0,0 +1,8 @@
+module Magic
+  module Link
+    class ApplicationMailer < ::ApplicationMailer
+      default from: Magic::Link.email_from
+      layout 'mailer'
+    end
+  end
+end

data/app/mailers/magic/link/magic_link_mailer.rb

@@ -0,0 +1,9 @@
+module Magic::Link
+  class MagicLinkMailer < ApplicationMailer
+    def send_magic_link(email, token)
+      @email = email
+      @token = token
+      mail(to: email, subject: "Your sign in link")
+    end
+  end
+end

data/app/models/magic/link/application_record.rb

@@ -0,0 +1,7 @@
+module Magic
+  module Link
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/magic/link/magic_link.rb

@@ -0,0 +1,34 @@
+module Magic
+  module Link
+    class MagicLink
+      include ActiveModel::Model
+      attr_accessor :email
+
+      def send_login_instructions
+        token = set_sign_in_token
+        send_magic_link_email(token) if token
+        token
+      end
+
+      private
+
+        def user
+          @user ||= Magic::Link.user_class.find_by(email: email.downcase)
+        end
+
+        def send_magic_link_email(token)
+          MagicLinkMailer.send_magic_link(email, token).deliver_later
+        end
+
+        def set_sign_in_token(force: false)
+          if user && (force || (user.sign_in_token.blank? || user.sign_in_token_sent_at < Magic::Link.token_expiration_hours.hours.ago))
+            raw, enc = Devise.token_generator.generate(Magic::Link.user_class, :sign_in_token)
+            user.sign_in_token = enc
+            user.sign_in_token_sent_at = Time.current
+            user.save(validate: false)
+            raw
+          end
+        end
+    end
+  end
+end

data/app/views/magic/link/magic_link_mailer/send_magic_link.html.erb

@@ -0,0 +1,5 @@
+<p>Hey there! Here is your sign in link (you can only use it once):</p>
+
+<p><%= link_to "Sign In", main_app.root_url(email: @email, sign_in_token: @token) %></p>
+
+<p>Thanks!</p>

data/app/views/magic/link/magic_link_mailer/send_magic_link.text.erb

@@ -0,0 +1,5 @@
+Hey there! Here is your sign in link (you can only use it once):
+
+<%= main_app.root_url(email: @email, sign_in_token: @token) %>
+
+Thanks!

data/app/views/magic/link/magic_links/new.html.erb

@@ -0,0 +1,10 @@
+<div class="row">
+  <div class="col-md-6 offset-md-3">
+    <%= simple_form_for @magic_link do |f| %>
+      <%= f.input :email, label: "Enter your email", autofocus: true %>
+      <%= f.submit "Email me a sign in link", class: "btn btn-primary btn-block" %>
+    <% end %>
+    <br>
+    <%= link_to "Back", :back %>
+  </div>
+</div>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Magic::Link::Engine.routes.draw do
+  resources :magic_links, only: [:new, :create]
+end

data/lib/magic/link.rb

@@ -0,0 +1,26 @@
+require "magic/link/engine"
+require "magic/link/controller_extensions"
+require "magic/link/railtie"
+
+module Magic
+  module Link
+    mattr_accessor :user_class
+    @@user_class = "User"
+
+    mattr_accessor :email_from
+    @@email_from = "please-change-me@magic-link.com"
+
+    mattr_accessor :token_expiration_hours
+    @@token_expiration_hours = 6
+
+    class << self
+      def configure
+        yield self
+      end
+
+      def user_class
+        @@user_class.constantize
+      end
+    end
+  end
+end

data/lib/magic/link/controller_extensions.rb

@@ -0,0 +1,39 @@
+module Magic
+  module Link
+    module ControllerExtensions
+      def self.included(base)
+        base.send(:include, InstanceMethods)
+      end
+
+      module InstanceMethods
+        def authenticate_user_from_token!
+          email = params[:email].presence
+          token = params[:sign_in_token].presence
+          user  = email && token && Magic::Link.user_class.find_by(email: email)
+
+          if token && send("#{Magic::Link.user_class.name.underscore}_signed_in?")
+            flash.now[:alert] = "You are already signed in"
+          elsif user && token_matches?(user) && token_not_expired?(user)
+            flash[:notice] = "You have signed in successfully"
+            user.update_columns(sign_in_token: nil, sign_in_token_sent_at: nil)
+            sign_in user
+          elsif email && token
+            flash[:alert] = "Your sign in token is invalid"
+            redirect_to main_app.root_path
+          end
+        end
+
+        def token_matches?(user)
+          Devise.secure_compare(
+            user.sign_in_token,
+            Devise.token_generator.digest(Magic::Link.user_class, :sign_in_token, params[:sign_in_token])
+          )
+        end
+
+        def token_not_expired?(user)
+          user.sign_in_token_sent_at >= Magic::Link.token_expiration_hours.hours.ago
+        end
+      end
+    end
+  end
+end

data/lib/magic/link/engine.rb

@@ -0,0 +1,7 @@
+module Magic
+  module Link
+    class Engine < ::Rails::Engine
+      isolate_namespace Magic::Link
+    end
+  end
+end

data/lib/magic/link/railtie.rb

@@ -0,0 +1,11 @@
+module Magic
+  module Link
+    class Railtie < ::Rails::Railtie
+      config.to_prepare do
+        ::ApplicationController.send(:include, Magic::Link::ControllerExtensions)
+        ::ApplicationController.send(:helper, Magic::Link::ApplicationHelper)
+        ::ApplicationController.send(:before_action, :authenticate_user_from_token!)
+      end
+    end
+  end
+end

data/lib/magic/link/version.rb

@@ -0,0 +1,5 @@
+module Magic
+  module Link
+    VERSION = '0.1.0'
+  end
+end

data/lib/tasks/magic/link_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :magic_link do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: magic-link
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Van Der Beek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Devise magic sign in links
+email:
+- earlynovrock@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/magic_link_manifest.js
+- app/assets/javascripts/magic/link/application.js
+- app/assets/stylesheets/magic/link/application.css
+- app/controllers/magic/link/magic_links_controller.rb
+- app/helpers/magic/link/application_helper.rb
+- app/jobs/magic/link/application_job.rb
+- app/mailers/magic/link/application_mailer.rb
+- app/mailers/magic/link/magic_link_mailer.rb
+- app/models/magic/link/application_record.rb
+- app/models/magic/link/magic_link.rb
+- app/views/magic/link/magic_link_mailer/send_magic_link.html.erb
+- app/views/magic/link/magic_link_mailer/send_magic_link.text.erb
+- app/views/magic/link/magic_links/new.html.erb
+- config/routes.rb
+- lib/magic/link.rb
+- lib/magic/link/controller_extensions.rb
+- lib/magic/link/engine.rb
+- lib/magic/link/railtie.rb
+- lib/magic/link/version.rb
+- lib/tasks/magic/link_tasks.rake
+homepage: https://github.com/dvanderbeek/magic-link
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Devise magic sign in links
+test_files: []