rodauth-omniauth 0.3.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 294ad80d69ff7fd5fef2a1b2722ca716ae205df852a9398efc423ad350eb7e33
-  data.tar.gz: 7b5d75a069904a4a8780114c9eed4e03a8aa9c1533addfa458c91f77f9568cf8
+  metadata.gz: bcd1857e0bfd2329c4df0476d8f5091bac5f45c9bd47de6c8c3ef53a99bf0a64
+  data.tar.gz: 57ddd4e9b6e8baf00b66da1f580b01762a0c118f7c962f520a026f6ef94bbfc3
 SHA512:
-  metadata.gz: d4765fceb95ccd2808bf1d208d43cf42030b447688768017cb80f480b6e1a6302c382a4e47ce47cba75af03577f5904020529ad36a67355d919ba9252abe0186
-  data.tar.gz: 2c10c017f1bf7fd6813bf7d7aba71f3aa7975cd11e130308a804624441ef8119ca8dbc2a85095e9e9d668cb787b281ee150db4cf8768cdba04613d34cdf3d972
+  metadata.gz: 9bebec705884e246bd20bee55771711d3fff5d82c9c7f711099e09ac1196e2af8ce0c5d9e1456035da429e33c7439d7ae8c2350b6b33c6081c54f74a93992b74
+  data.tar.gz: 53be14c4e20dff0c17e988b46cc7e0c700b810c6fc7a4440eb94a63abeee9659f9ad880427ce7205dd0fe9c6757b6e48a6e1e99411b1304dba8f011327936246

data/README.md

@@ -55,7 +55,8 @@ plugin :rodauth do
 end
 ```
 
-It is important to note that `rodauth-omniauth` requires OmniAuth 2.x, and as such, is only compatible with omniauth gems that use the same.
+> [!NOTE]
+> It is important to note that `rodauth-omniauth` requires OmniAuth 2.x, so it's only compatible with providers gems that support it.
 
 You can now add authentication links to your login form:
 
@@ -107,7 +108,17 @@ end
 account_from_omniauth {} # disable finding existing accounts for new identities
 ```
 
-If the account associated to the external identity exists and is unverified (e.g. it was created through normal registration), the callback phase will return an error response, as only verified accounts can be logged into. You can change the default error flash and redirect location in this case:
+#### Account verification
+
+If the account associated to the external identity exists and is unverified (e.g. it was created through normal registration), the callback phase will automatically verify the account and login, assuming the `verify_account` feature is enabled and external email is the same.
+
+If you wish to disallow OmniAuth login into unverified accounts, set the following:
+
+```rb
+omniauth_verify_account? false
+```
+
+You can change the default error flash and redirect location in this case:
 
 ```rb
 omniauth_login_unverified_account_error_flash "The account matching the external identity is currently awaiting verification"
@@ -116,7 +127,7 @@ omniauth_login_failure_redirect { require_login_redirect }
 
 ### Account creation
 
-Accounts created via external login are automatically verified, because it's assumed your email address was verified by the external provider. If you want to use extra user information for account creation, you can do so via hooks:
+Accounts created via external login are automatically verified, because it's assumed your email address was verified by the external provider. If you want to add extra user information to created accounts, you can do so via hooks:
 
 ```rb
 before_omniauth_create_account { account[:name] = omniauth_name }
@@ -126,7 +137,16 @@ after_omniauth_create_account do
 end
 ```
 
-When the account is closed, its external identities are automatically deleted from the database.
+You might want to disable automatic account creation in certain cases. For example, if you're showing OmniAuth login links on both login and registration pages, you might want OmniAuth login on the login page to only log into existing accounts. You could configure this so that it's controlled via a query parameter:
+
+```rb
+# somewhere in your view template:
+rodauth.omniauth_request_path(:google, action: "login") #=> "/auth/github?action=login"
+```
+```rb
+# in your Rodauth configuration:
+omniauth_create_account? { omniauth_params["action"] != "login" }
+```
 
 ### Identity data
 

data/lib/rodauth/features/omniauth.rb

@@ -11,6 +11,7 @@ module Rodauth
     after :omniauth_create_account
 
     error_flash "The account matching the external identity is currently awaiting verification", :omniauth_login_unverified_account
+    error_flash "There is no existing account matching the external identity", :omniauth_login_no_matching_account
 
     redirect(:omniauth_login_failure) { require_login_redirect }
 
@@ -20,6 +21,11 @@ module Rodauth
     auth_value_method :omniauth_identities_provider_column, :provider
     auth_value_method :omniauth_identities_uid_column, :uid
 
+    auth_value_methods(
+      :omniauth_verify_account?,
+      :omniauth_create_account?,
+    )
+
     auth_methods(
       :create_omniauth_identity,
       :omniauth_identity_insert_hash,
@@ -38,7 +44,7 @@ module Rodauth
 
     def route_omniauth!
       result = super
-      handle_omniauth_callback if omniauth_request?
+      handle_omniauth_callback if omniauth_strategy&.on_callback_path?
       result
     end
 
@@ -62,17 +68,26 @@ module Rodauth
       end
 
       if account && !open_account?
-        set_response_error_reason_status(:unverified_account, unopen_account_error_status)
-        set_redirect_error_flash omniauth_login_unverified_account_error_flash
-        redirect omniauth_login_failure_redirect
+        if omniauth_verify_account?
+          omniauth_verify_account
+        else
+          set_response_error_reason_status(:unverified_account, unopen_account_error_status)
+          set_redirect_error_flash omniauth_login_unverified_account_error_flash
+          redirect omniauth_login_failure_redirect
+        end
       end
 
       transaction do
-        unless account
-          omniauth_new_account
-          before_omniauth_create_account
-          omniauth_save_account
-          after_omniauth_create_account
+        if !account
+          if omniauth_create_account?
+            omniauth_new_account
+            before_omniauth_create_account
+            omniauth_save_account
+            after_omniauth_create_account
+          else
+            set_redirect_error_flash omniauth_login_no_matching_account_error_flash
+            redirect omniauth_login_failure_redirect
+          end
         end
 
         if omniauth_identity
@@ -133,6 +148,21 @@ module Rodauth
 
     attr_reader :omniauth_identity
 
+    def omniauth_verify_account?
+      features.include?(:verify_account) && account[login_column] == omniauth_email
+    end
+
+    def omniauth_verify_account
+      transaction do
+        verify_account
+        remove_verify_account_key
+      end
+    end
+
+    def omniauth_create_account?
+      true
+    end
+
     def _omniauth_new_account(login)
       acc = { login_column => login }
       unless skip_status_checks?

data/lib/rodauth/features/omniauth_base.rb

@@ -66,19 +66,19 @@ module Rodauth
 
     %w[email name].each do |info_key|
       define_method(:"omniauth_#{info_key}") do
-        omniauth_info[info_key]
+        omniauth_info[info_key] if omniauth_info
       end
     end
 
     %w[provider uid info credentials extra].each do |auth_key|
       define_method(:"omniauth_#{auth_key}") do
-        omniauth_auth.fetch(auth_key)
+        omniauth_auth[auth_key] if omniauth_auth
       end
     end
 
     %w[auth params strategy origin error error_type error_strategy].each do |data|
       define_method(:"omniauth_#{data}") do
-        request.env.fetch("omniauth.#{data.tr("_", ".")}")
+        request.env["omniauth.#{data.tr("_", ".")}"]
       end
     end
 
@@ -194,10 +194,6 @@ module Rodauth
       end
     end
 
-    def omniauth_request?
-      request.env.key?("omniauth.strategy")
-    end
-
     def self.included(auth)
       auth.extend ClassMethods
       auth.instance_variable_set(:@omniauth_providers, [])

data/locales/en.yml

@@ -2,3 +2,4 @@ en:
   rodauth:
     omniauth_failure_error_flash: There was an error logging in with the external provider
     omniauth_login_unverified_account_error_flash: The account matching the external identity is currently awaiting verification
+    omniauth_login_no_matching_account_error_flash: There is no existing account matching the external identity

data/rodauth-omniauth.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "rodauth-omniauth"
-  spec.version       = "0.3.4"
+  spec.version       = "0.5.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.3.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-08 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rodauth
@@ -212,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Rodauth extension for logging in and creating account via OmniAuth authentication.