gatleon-authform-rails 0.3.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b75dc2e45b5f446a8bf28e95e4d48eb096d5acef5de2b2cb453c3cc5ceaa626a
-  data.tar.gz: 8568b98d4cfb5e26b3c3d6d9d0bc5a0591d47a4a4e31dbfeb89bc0d9fd15757d
+  metadata.gz: 653570cc8138e798a9404b727ac68ec1f7351953cd59a7e7ece1f08284bffcff
+  data.tar.gz: a6ebd4fc079dd0d383e21201cd58e71adc23eed8de1759786b9813b57390688e
 SHA512:
-  metadata.gz: 990f100b99d36e4c6b005a18dc270176fe25a86ce753731b3958bdaba10b74bf2fdd34813facd7768a25be4671f27d22cf4ca5993a6760d26714d4af30816e80
-  data.tar.gz: 507266798a6df6e2cea497455779d7a1e888dcaf0a697db6d5fe7f73a593866659de8eca4eb0ce789760cb710afb6d5fe067d3a20314f7c1ac06c58a8a5c5d80
+  metadata.gz: c01f61589cfc34bdccd07d1ae70789d78a378d9fd3d8665a67cedfd997a2532121f9d020f294575097bf49e73d88e85aeb58d5ddba1bf988488cd6ab7fc15aac
+  data.tar.gz: b7d9365cd368eaa4ccda1985dfe1e33f4ff36b124304a17dfdb364ca8b0de77edee9d6b75265bb06bba45b6cc506d87fa7a55e37bbc25c1f0a04c1c7d31018da

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    gatleon-authform-rails (0.3.0)
+    gatleon-authform-rails (0.7.0)
+      xxhash
 
 GEM
   remote: https://rubygems.org/
@@ -86,7 +87,7 @@ GEM
     nio4r (2.5.2)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    rack (2.2.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails (6.0.2.2)
@@ -142,7 +143,8 @@ GEM
       thread_safe (~> 0.1)
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
+    websocket-extensions (0.1.5)
+    xxhash (0.4.0)
     yard (0.9.24)
     zeitwerk (2.3.0)
 

data/README.md

@@ -1,6 +1,4 @@
-![authform-rails](https://raw.githubusercontent.com/gatleon/gatleon-authform-rails/master/gatleon-authform-rails.png)
-
-# authform-rails by gatleon
+# gatleon-authform-rails
 
 add authentication to your application - in 1 minute or less.
 
@@ -18,22 +16,33 @@ and then execute:
 $ bundle install
 ```
 
-add a profile controller
+open rails credentials:
+
+```
+$ EDITOR=vim rails credentials:edit
+```
+
+set authform credentials:
+
+```
+authform:
+  public_key: "Available at https://authform.gatleon.com"
+  secret_key: "Available at https://authform.gatleon.com"
+```
+
+add a profile controller:
 
 ```ruby
 class ProfileController < ActionController::Base
-  AUTHFORM_FORM_SECRET_KEY = "" # Available at https://authform.gatleon.com. coming soon!
-  AUTHFORM_FORM_PUBLIC_KEY = "" # Available at https://authform.gatleon.com. coming soon!
-
-  include Gatleon::Authform::Rails::Concern.new(public_key: AUTHFORM_FORM_PUBLIC_KEY, secret_key: AUTHFORM_FORM_SECRET_KEY)
+  include Gatleon::Authform::Rails::Concern.new(Rails.application.credentials.dig(:authform))
 
   before_action :require_login, only: [:index]
 
   def index
     erb = <<~ERB
       <h1>Profile</h1>
-      <p style="color: green;">You are signed in.</p>
-      <p><%= current_user %></p>
+      <p style="color: green;">You are signed in. (<a href="/profile/signoff">sign off</a>)</p>
+      <p><%= current_user._id %> <%= current_user._email %></p>
     ERB
 
     render inline: erb
@@ -43,7 +52,8 @@ class ProfileController < ActionController::Base
     erb = <<~ERB
       <p style="color: red;"><%= flash[:error] %></p>
       <h1>Sign In</h1>
-      <form action="https://authform.gatleon.com/v1/form/<%= ProfileController::AUTHFORM_FORM_PUBLIC_KEY %>" method="POST">
+      <form action="<%= signon_url %>" method="POST">
+        <input type="hidden" name="successPath" value="/profile">
         <input type="email" name="email">
         <button type="submit">Sign In</button>
       </form>
@@ -52,6 +62,12 @@ class ProfileController < ActionController::Base
     render inline: erb
   end
 
+  def signoff
+    current_user.signoff!
+
+    redirect_to(profile_signin_path) and return
+  end
+
   private
 
   def require_login
@@ -64,12 +80,13 @@ class ProfileController < ActionController::Base
 end
 ```
 
-add profile routes to routes.rb
+add profile routes to routes.rb:
 
 ```ruby
 Rails.application.routes.draw do
-  get '/profile', to: 'profile#index', as: 'profile'
-  get '/profile/signin', to: 'profile#signin', as: 'profile_signin'
+  get "/profile", to: "profile#index", as: :profile
+  get "/profile/signin", to: "profile#signin", as: :profile_signin
+  get "/profile/signoff", to: "profile#signoff", as: :profile_signoff
 end
 ```
 

data/gatleon-authform-rails.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "xxhash"
 end

data/lib/gatleon/authform/rails.rb

@@ -7,7 +7,6 @@ module Gatleon
   module Authform
     module Rails
       class Error < StandardError; end
-      # Your code goes here...
     end
   end
 end

data/lib/gatleon/authform/rails/concern.rb

@@ -1,4 +1,4 @@
-require "json"
+require "xxhash"
 
 module Gatleon
   module Authform
@@ -8,22 +8,30 @@ module Gatleon
                        secret_key:,
                        domain: nil,
                        current_user_method_name: "current_user",
-                       _authform_base_url: "https://authform.gatleon.com")
+                       signon_url_method_name: "signon_url",
+                       _authform_base_url: "https://authformapi.gatleon.com")
           super() do
             extend ActiveSupport::Concern
 
             included do
               helper_method "#{current_user_method_name}".to_sym
+              helper_method "#{signon_url_method_name}".to_sym
+
               before_action :_exchange_user_voucher_for_user
             end
 
             private
 
+            # defaults to signon_url
+            define_method signon_url_method_name do
+              "#{_authform_base_url}/v1/form/#{public_key}"
+            end
+
             # defaults to current_user
             define_method current_user_method_name do
               begin
                 Gatleon::Authform::Rails::User.new(_cookies: cookies,
-                                                   _form_public_key: public_key,
+                                                   _authform_user_cookie_key: _authform_user_cookie_key,
                                                    _form_secret_key: secret_key,
                                                    _domain: domain,
                                                    _authform_base_url: _authform_base_url)
@@ -51,7 +59,7 @@ module Gatleon
             end
 
             define_method :_authform_user_cookie_key do
-              public_key # allows for multiple forms per site
+             "#{public_key}_#{XXhash.xxh32(domain)}"
             end
 
             define_method :_cookie_attrs do |value|

data/lib/gatleon/authform/rails/user.rb

@@ -7,12 +7,12 @@ module Gatleon
         PERMITTED_CHARS = /\A[a-zA-Z0-9_)]*\z/
 
         def initialize(_cookies:,
-                       _form_public_key:,
+                       _authform_user_cookie_key:,
                        _form_secret_key:,
                        _domain:,
                        _authform_base_url:)
           @_cookies = _cookies
-          @_form_public_key = _form_public_key
+          @_authform_user_cookie_key = _authform_user_cookie_key
           @_form_secret_key = _form_secret_key
           @_domain = _domain
           @_authform_base_url = _authform_base_url
@@ -61,14 +61,14 @@ module Gatleon
         end
 
         def _json
-          @_json ||= JSON.parse(@_cookies[@_form_public_key])
+          @_json ||= JSON.parse(@_cookies[@_authform_user_cookie_key])
         end
 
         def signoff!
           if @_domain
-            @_cookies.delete(@_form_public_key, domain: @_domain)
+            @_cookies.delete(@_authform_user_cookie_key, domain: @_domain)
           else
-            @_cookies.delete(@_form_public_key)
+            @_cookies.delete(@_authform_user_cookie_key)
           end
         end
         alias_method :sign_off!, :signoff!

data/lib/gatleon/authform/rails/version.rb

@@ -1,7 +1,7 @@
 module Gatleon
   module Authform
     module Rails
-      VERSION = "0.3.0"
+      VERSION = "0.7.0"
     end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: gatleon-authform-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.7.0
 platform: ruby
 authors:
 - gatleon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-02 00:00:00.000000000 Z
-dependencies: []
+date: 2020-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xxhash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: add authentication to your application - in 1 minute or less
 email:
 - ''
@@ -29,7 +43,6 @@ files:
 - bin/console
 - bin/setup
 - gatleon-authform-rails.gemspec
-- gatleon-authform-rails.png
 - lib/gatleon/authform/rails.rb
 - lib/gatleon/authform/rails/concern.rb
 - lib/gatleon/authform/rails/user.rb