gatleon-authform-rails 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3ca7bb6cbffefb551a1a745285cb28ad6ba451811565199278b462c899ff2b1
-  data.tar.gz: 790d1b536bf057cf929b5c7b975d9ecfdfa583477f51c1af15045ad5846ed795
+  metadata.gz: 685b07de50135a4e5370690768aa9d3c35ee9ec6d69067cb64bf8d7114a17e15
+  data.tar.gz: 4575c9167863052ef09dbf8485d9ae61d3d31a3ab6e398f5ff13f877e5b7da92
 SHA512:
-  metadata.gz: 6923b17d438ded1ed5fbc8ab8dbe8eecb475b7b760e6a7ed782aa672af8ebbb45cc71b84cfbea3ef49f057dea43a26fc61900e16f4fe2892521f88d96826015d
-  data.tar.gz: 3b890fb44898fbd97d919a06cd439c1459c31e5e590f23083b6cce3b8c42f2cb94c65c63c33090f9b5738cf398b9398dde831ce56469a9ca3c2a4e78f712136c
+  metadata.gz: 0faeb596324770954d58d7561a6269e2564e0c87bc46f5929a97a6af553787a6e2dfa04be77c7502ee9c3d8e13f02f46efcc92d6cc3af9114e846e0aa80a0318
+  data.tar.gz: d468569f24c293468138382d51d6eafa44d219307c2586daadd266a9dd22d3657651b2c6256635cb7f897e04b02ff5cfbfc338af43578f81fe091d1dfc8d2458

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+.byebug_history

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/Gemfile

@@ -7,3 +7,4 @@ gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
 gem "rails"
 gem "byebug"
+gem "yard"

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    gatleon-authform-rails (0.1.0)
+    gatleon-authform-rails (0.5.0)
+      xxhash
 
 GEM
   remote: https://rubygems.org/
@@ -143,6 +144,8 @@ GEM
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.4)
+    xxhash (0.4.0)
+    yard (0.9.24)
     zeitwerk (2.3.0)
 
 PLATFORMS
@@ -154,6 +157,7 @@ DEPENDENCIES
   rails
   rake (~> 12.0)
   rspec (~> 3.0)
+  yard
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,6 +1,4 @@
-![authform-rails](https://raw.githubusercontent.com/gatleon/gatleon-rails/master/gatleon-authform-rails.png)
-
-# authform-rails by gatleon
+# gatleon-authform-rails
 
 add authentication to your application - in 1 minute or less.
 
@@ -18,14 +16,25 @@ 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]
 
@@ -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="https://api.authform.io/v1/form/<%= Rails.application.credentials.dig(:authform, :public_key) %>" method="POST">
+        <input type="hidden" name="successPath" value="/profile">
         <input type="email" name="email">
         <button type="submit">Sign In</button>
       </form>
@@ -64,12 +74,12 @@ 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
 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/concern.rb

@@ -1,11 +1,14 @@
+require "xxhash"
+
 module Gatleon
   module Authform
     module Rails
       class Concern < Module
         def initialize(public_key:,
                        secret_key:,
+                       domain: nil,
                        current_user_method_name: "current_user",
-                       _authform_base_url: "https://authform.gatleon.com")
+                       _authform_base_url: "https://api.authform.io")
           super() do
             extend ActiveSupport::Concern
 
@@ -19,9 +22,11 @@ module Gatleon
             # defaults to current_user
             define_method current_user_method_name do
               begin
-                json = JSON.parse(cookies[_authform_user_cookie_key])["data"]
-
-                Gatleon::Authform::Rails::User.new(json: json, _form_secret_key: secret_key, _authform_base_url: _authform_base_url)
+                Gatleon::Authform::Rails::User.new(_cookies: cookies,
+                                                   _authform_user_cookie_key: _authform_user_cookie_key,
+                                                   _form_secret_key: secret_key,
+                                                   _domain: domain,
+                                                   _authform_base_url: _authform_base_url)
               rescue
                 nil
               end
@@ -34,18 +39,7 @@ module Gatleon
                 uri = URI("#{_authform_base_url}/v1/exchangeUserVoucherForUser/#{params[:_authformUserVoucher]}")
                 response = Net::HTTP.get_response(uri)
 
-                if response.code.to_i == 200
-                  # First attempt WITHOUT all - for setting on platforms like heroku that deny setting cookies across all subdomains
-                  cookies[_authform_user_cookie_key] = {
-                    value: response.body
-                  }
-
-                  # Then set all - desired behavior for hosting your own domain
-                  cookies[_authform_user_cookie_key] = {
-                    value: response.body,
-                    domain: :all
-                  }
-                end
+                cookies[_authform_user_cookie_key] = _cookie_attrs(response.body) if response.code.to_i == 200
 
                 q = Rack::Utils.parse_query(URI.parse(request.url).query)
                 q.delete("_authformUserVoucher")
@@ -57,7 +51,14 @@ 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|
+              {
+                value: value,
+                domain: domain
+              }.compact
             end
           end
         end

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

@@ -1,30 +1,45 @@
+require "json"
+
 module Gatleon
   module Authform
     module Rails
       class User
         PERMITTED_CHARS = /\A[a-zA-Z0-9_)]*\z/
 
-        def initialize(json:, _form_secret_key:, _authform_base_url:)
-          @json = json
-
+        def initialize(_cookies:,
+                       _authform_user_cookie_key:,
+                       _form_secret_key:,
+                       _domain:,
+                       _authform_base_url:)
+          @_cookies = _cookies
+          @_authform_user_cookie_key = _authform_user_cookie_key
           @_form_secret_key = _form_secret_key
+          @_domain = _domain
           @_authform_base_url = _authform_base_url
+
+          parse!
+        end
+
+        def parse!
+          !!_id
+        rescue
+          raise Gatleon::Authform::Rails::Error
         end
 
         # Getters
         #
         def _id
-          @json["_id"]
+          data["_id"]
         end
 
         def _email
-          @json["_email"]
+          data["_email"]
         end
 
         # Getters
         #
         def [](key)
-          @json[key.to_s]
+          data[key.to_s]
         end
 
         # Setters
@@ -38,8 +53,31 @@ module Gatleon
 
           raise Gatleon::Authform::Rails::Error, "only characters a-z, A-Z, 0-9, and _ permitted in field name" unless key.match?(PERMITTED_CHARS)
 
-          @json[key] = value.to_s
+          data[key] = value.to_s
+        end
+
+        def data
+          _json["data"]
+        end
+
+        def _json
+          @_json ||= JSON.parse(@_cookies[@_authform_user_cookie_key])
+        end
+
+        def signoff!
+          if @_domain
+            @_cookies.delete(@_authform_user_cookie_key, domain: @_domain)
+          else
+            @_cookies.delete(@_authform_user_cookie_key)
+          end
         end
+        alias_method :sign_off!, :signoff!
+        alias_method :signout!, :signoff!
+        alias_method :sign_out!, :signoff!
+        alias_method :logout!, :signoff!
+        alias_method :log_out!, :signoff!
+        alias_method :logoff!, :signoff!
+        alias_method :log_off!, :signoff!
 
         private
 

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

@@ -1,7 +1,7 @@
 module Gatleon
   module Authform
     module Rails
-      VERSION = "0.1.0"
+      VERSION = "0.5.0"
     end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: gatleon-authform-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - gatleon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-30 00:00:00.000000000 Z
-dependencies: []
+date: 2020-08-17 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:
 - ''
@@ -19,6 +33,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -28,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