rodauth-omniauth 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99f2cd5c47082f18ff2b0feeea0106c104edf6454e354fb04f8c74044b7796b2
-  data.tar.gz: 58c096a1176cce8c2aa1ef0741c35e0ec81a36fb1d3d7bf9350b01c143daffdb
+  metadata.gz: '09378dc7c637faa7d96d3945b5e0bb32fe9327b8e2c78ea86eb345b768ee5f25'
+  data.tar.gz: dd2f61b20ee67a9355cd94a81ccac34839550a6f3b41256a36d6d9af7f686188
 SHA512:
-  metadata.gz: 3ee9f500a18535a215d74d6cbc250561a7d0b61cc5818166e7bf481b74bf67dedf2547228ffbec177273715d1001cce2178e7590cadc8c21b102ef1b9585f9c5
-  data.tar.gz: fe0337fdc2ef82ea53c5b8514383df10d60433900deaa35fa519ffe0e846c3a5e79deead46b1e790e29a35ffac0a00a2301c6437376d8fd91832d8ee1cb49a8e
+  metadata.gz: bdd33ddd3adf2afd16bc0b91a46817368cfa6c66c7f3ad75b085af82f1b78901b0d06892397cbe2e30dbf0799de655e4066da58448a948005d1e1702ae1f25f4
+  data.tar.gz: f7adbf2ebc5d1bd922b65b4cb015d768744121b83ad60dc107f9545ea427f434b5815722dfbb5280a4bacb94c42a26dfccc4f5a9d0aa2efafc8a863af0e5887a

data/README.md

@@ -1,6 +1,6 @@
 # rodauth-omniauth
 
-[Rodauth] feature that offers login and registration via multiple external providers using [OmniAuth]. The external identities are automatically stored in the database, and associated to the main account record.
+[Rodauth] feature that offers login and registration via multiple external providers using [OmniAuth], together with the persistence of external identities.
 
 ## Installation
 
@@ -15,16 +15,28 @@ $ bundle add rodauth-omniauth
 You'll first need to create the table for storing external identities:
 
 ```rb
-Sequel.migration do                       # class CreateAccountIdentities < ActiveRecord::Migration
-  change do                               #   def change
-    create_table :account_identities do   #     create_table :account_identities do |t|
-      primary_key :id                     #       t.references :account, null: false, foreign_key: { on_delete: :cascade }
-      foreign_key :account_id, :accounts  #       t.string :provider, null: false
-      String :provider, null: false       #       t.string :uid, null: false
-      String :uid, null: false            #       t.index [:provider, :uid], unique: true
-      unique [:provider, :uid]            #     end
-    end                                   #   end
-  end                                     # end
+Sequel.migration do
+  change do
+    create_table :account_identities do
+      primary_key :id
+      foreign_key :account_id, :accounts
+      String :provider, null: false
+      String :uid, null: false
+      unique [:provider, :uid]
+    end
+  end
+end
+```
+```rb
+class CreateAccountIdentities < ActiveRecord::Migration
+  def change
+    create_table :account_identities do |t|
+      t.references :account, null: false, foreign_key: { on_delete: :cascade }
+      t.string :provider, null: false
+      t.string :uid, null: false
+      t.index [:provider, :uid], unique: true
+    end
+  end
 end
 ```
 
@@ -47,16 +59,11 @@ You can now add authentication links to your login form:
 
 ```erb
 <!-- app/views/rodauth/_login_form_footer.html.erb -->
-<%== rodauth.login_form_footer_links_heading %>
-
-<ul>
+<!-- ... -->
   <li><%= button_to "Login via Facebook", rodauth.omniauth_request_path(:facebook), method: :post, data: { turbo: false }, class: "btn btn-link p-0" %></li>
   <li><%= button_to "Login via Twitter", rodauth.omniauth_request_path(:twitter), method: :post, data: { turbo: false }, class: "btn btn-link p-0" %></li>
   <li><%= button_to "Login via Google", rodauth.omniauth_request_path(:google), method: :post, data: { turbo: false }, class: "btn btn-link p-0" %></li>
-  <% rodauth.login_form_footer_links.each do |_, link, text| %>
-    <li><%= link_to text, link %></li>
-  <% end %>
-</ul>
+<!-- ... -->
 ```
 
 Assuming you configured the providers correctly, you should now be able to authenticate via an external provider. The `omniauth` feature handles the callback request, automatically creating new identities and verified accounts from those identities as needed.
@@ -73,6 +80,8 @@ Currently, provider login is required to return the user's email address, and ac
 
 ### Login
 
+After provider login, if the external identity doesn't already exist, and there is an account with email matching the identity's, the new identity will be assigned to that account.
+
 If the local account associated to the external identity exists and is unverified (e.g. it was created through normal registration), the external login will abort during the callback phase. You can change the default error flash and redirect location in this case:
 
 ```rb
@@ -205,13 +214,13 @@ URL helpers are provided as well:
 rodauth.prefix #=> "/user"
 rodauth.omniauth_prefix #=> "/auth"
 
-rodauth.omniauth_request_route #=> "auth/facebook"
-rodauth.omniauth_request_path #=> "/user/auth/facebook"
-rodauth.omniauth_request_url #=> "https://example.com/user/auth/facebook"
+rodauth.omniauth_request_route(:facebook) #=> "auth/facebook"
+rodauth.omniauth_request_path(:facebook) #=> "/user/auth/facebook"
+rodauth.omniauth_request_url(:facebook) #=> "https://example.com/user/auth/facebook"
 
-rodauth.omniauth_callback_route #=> "auth/facebook/callback"
-rodauth.omniauth_callback_path #=> "/user/auth/facebook/callback"
-rodauth.omniauth_callback_url #=> "https://example.com/user/auth/facebook/callback"
+rodauth.omniauth_callback_route(:facebook) #=> "auth/facebook/callback"
+rodauth.omniauth_callback_path(:facebook) #=> "/user/auth/facebook/callback"
+rodauth.omniauth_callback_url(:facebook) #=> "https://example.com/user/auth/facebook/callback"
 ```
 
 The prefix for the OmniAuth app can be changed:
@@ -257,9 +266,9 @@ Or provide your own implementation:
 ```rb
 omniauth_on_failure do
   case omniauth_error_type
-  when :no_authorization_code then ...
-  when :uknown_signature_algorithm then ...
-  else ...
+  when :no_authorization_code then # ...
+  when :uknown_signature_algorithm then # ...
+  else # ...
   end
 end
 ```
@@ -314,9 +323,11 @@ JSON requests are supported for the request and callback phases. The request pha
 POST /auth/facebook
 Accept: application/json
 Content-Type: application/json
-
+```
+```http
 200 OK
 Content-Type: application/json
+
 { "authorize_url": "https://external.com/login" }
 ```
 
@@ -326,9 +337,11 @@ If there was a login failure, the error type will be included in the response:
 POST /auth/facebook/callback
 Accept: application/json
 Content-Type: application/json
-
+```
+```http
 500 Internal Server Error
 Content-Type: application/json
+
 { "error_type": "some_error", "error": "There was an error logging in with the external provider" }
 ```
 
@@ -351,6 +364,10 @@ Run tests with Rake:
 $ bundle exec rake test
 ```
 
+## Credits
+
+The implementation of this gem was inspired by [this OmniAuth guide](https://github.com/omniauth/omniauth/wiki/Managing-Multiple-Providers).
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/generators/rodauth/migration/sequel/omniauth.erb

@@ -0,0 +1,8 @@
+# Used by the omniauth feature
+create_table :account_identities do
+  primary_key :id
+  foreign_key :account_id, :accounts
+  String :provider, null: false
+  String :uid, null: false
+  unique [:provider, :uid]
+end

data/lib/rodauth/features/omniauth.rb

@@ -112,6 +112,11 @@ module Rodauth
 
     private
 
+    def before_confirm_password
+      authenticated_by.delete("omniauth")
+      super if defined?(super)
+    end
+
     def allow_email_auth?
       (defined?(super) ? super : true) && omniauth_account_identities_ds.empty?
     end

data/rodauth-omniauth.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "rodauth-omniauth"
-  spec.version       = "0.1.0"
+  spec.version       = "0.2.0"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko@hey.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-omniauth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-03 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rodauth
@@ -159,6 +159,8 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- lib/generators/rodauth/migration/active_record/omniauth.erb
+- lib/generators/rodauth/migration/sequel/omniauth.erb
 - lib/rodauth/features/omniauth.rb
 - lib/rodauth/features/omniauth_base.rb
 - rodauth-omniauth.gemspec