rodauth-omniauth 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b983cad17d20d291428c75e8efd5d59b313e83ac68f7998d7d1ec6c508db0ac4
-  data.tar.gz: e5db5f29f5d2897312d9dc4eca1cc34718ff56bd024bf2f79473a230a9e3cfbc
+  metadata.gz: c6cc26306c21226fb3b6f07fcc3bfcc6390160f78aa0c8cbf87ff3e3b1fd2fd4
+  data.tar.gz: 9f3d0493b66cdb851e1b8af0e1d85e57544fcdaa6504509072a4edfdcde24d5f
 SHA512:
-  metadata.gz: d371d95667924f9e6ea1da68ab3e59471d794230de35eefa7d816edba211c734c981e1ef8ce724987cf58e0e10bf52773bad671dbb352dbbcd6b2762725bba1d
-  data.tar.gz: 78feadd9466089523ec85e021c980fc90af051c92d6c981e04476888546524f4bcd010321bd89d0f5a4f788c68221ac87dfa6112ea97e67074c9c3ca532daadd
+  metadata.gz: c10572574a109db2a9d28ea84239154f7c380b23d4f48f543c3084ae6528c5b2878ed98adab2c9d489ced01ca106cd354b7f5dfa177e496b048c744082ddeb31
+  data.tar.gz: 60cf2d25aa82ccb6a6a9f69c01fca040912df718d952a7ad830e443b89589a11d9855d042298c34c1220548b1a4a3eb96252e992de0d8214b1e43f0f4add08f4

data/README.md

@@ -43,7 +43,7 @@ end
 Then enable the `omniauth` feature and register providers in your Rodauth configuration:
 
 ```sh
-$ bundle add omniauth-facebook omniauth-twitter, omniauth-google_oauth2
+$ bundle add omniauth-facebook omniauth-twitter, omniauth-google-oauth2
 ```
 ```rb
 plugin :rodauth do
@@ -55,6 +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.
+
 You can now add authentication links to your login form:
 
 ```erb
@@ -185,14 +187,14 @@ Account.first.identities #=>
 
 ## Base
 
-The `omniauth` feature builds on top of the `omniauth_base` feature, which sets up OmniAuth and routes its requests, but has no interaction with the database. So, if you would prefer to handle external logins differently, you can load just the `omniauth_base` feature, and implement your own callbacks.
+The `omniauth` feature builds on top of the `omniauth_base` feature, which sets up OmniAuth and routes its requests, but has no interaction with the database. So, if you would prefer to handle external logins differently, you can load just the `omniauth_base` feature, and implement your own callback phase.
 
 ```rb
 plugin :rodauth do
   enable :omniauth_base
 
-  omniauth_provider :github, ENV["GITHUB_KEY"], ENV["GITHUB_SECRET"], scope: "user"
-  omniauth_provider :apple, ENV["CLIENT_ID"], { scope: "email name", ... }
+  omniauth_provider :github, ENV["GITHUB_CLIENT_ID"], ENV["GITHUB_CLIENT_SECRET"], scope: "user"
+  omniauth_provider :apple, ENV["APPLE_CLIENT_ID"], ENV["APPLE_CLIENT_SECRET"], scope: "email name"
 end
 
 route do |r|
@@ -355,7 +357,7 @@ Content-Type: application/json
 { "authorize_url": "https://github.com/login/oauth/authorize?..." }
 ```
 
-When you redirect the user to the authorize URL, and they authorize the OAuth app, the callback endpoint they're redirected to will contain query parameters that need to passed for the callback request to the backend.
+When you redirect the user to the authorize URL, and they authorize the OAuth app, the callback endpoint they're redirected to will contain query parameters that need to be included in the callback request to the backend.
 
 ```http
 GET /auth/github/callback?code=...&state=...
@@ -369,13 +371,8 @@ Content-Type: application/json
 { "success": "You have been logged in" }
 ```
 
-If there was a login failure, the error type will be included in the response:
+If there was an OmniAuth failure, the error type will be included in the response:
 
-```http
-POST /auth/facebook/callback
-Accept: application/json
-Content-Type: application/json
-```
 ```http
 500 Internal Server Error
 Content-Type: application/json
@@ -383,7 +380,7 @@ Content-Type: application/json
 { "error_type": "some_error", "error": "There was an error logging in with the external provider" }
 ```
 
-In this flow, you'll need to configure the callback URL on the OAuth app to point to the frontend app. On the OmniAuth strategy, you'll need to configure the same for GitHub requests, but keep the backend callback endpoint. For strategies based on [omniauth-oauth2], you can achieve this as follows:
+In this flow, you'll need to configure the callback URL on the OAuth app to point to the frontend app. In the OmniAuth strategy, you'll need to configure the same redirect URL for OAuth requests, but keep the backend callback endpoint. For strategies based on [omniauth-oauth2], you can achieve this as follows:
 
 ```rb
 omniauth_provider :github, ENV["GITHUB_CLIENT_ID"], ENV["GITHUB_CLIENT_SECRET"],

data/lib/rodauth/features/omniauth.rb

@@ -203,7 +203,7 @@ module Rodauth
 end
 
 if defined?(Rodauth::Model)
-  Rodauth::Model.register_association(:identities) do
+  Rodauth::Model.register_association(:omniauth) do
     { name: :identities, type: :many, table: omniauth_identities_table, key: omniauth_identities_id_column }
   end
 end

data/lib/rodauth/features/omniauth_base.rb

@@ -36,6 +36,8 @@ module Rodauth
       self.class.send(:define_method, :omniauth_app) { omniauth_app }
 
       self.class.roda_class.plugin :run_handler
+
+      i18n_register File.expand_path("#{__dir__}/../../../locales") if features.include?(:i18n)
     end
 
     def route!

data/locales/en.yml

@@ -0,0 +1,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

data/rodauth-omniauth.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "rodauth-omniauth"
-  spec.version       = "0.3.0"
+  spec.version       = "0.3.2"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko@hey.com"]
 
@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
 
-  spec.files         = Dir["README.md", "LICENSE.txt", "*.gemspec", "lib/**/*"]
+  spec.files         = Dir["README.md", "LICENSE.txt", "*.gemspec", "lib/**/*", "locales/**/*"]
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rodauth", "~> 2.13"
@@ -28,4 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "net-smtp"
   spec.add_development_dependency "capybara"
   spec.add_development_dependency "jwt"
+  spec.add_development_dependency "rodauth-i18n"
+  spec.add_development_dependency "rodauth-model"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-omniauth
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rodauth
@@ -150,6 +150,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rodauth-i18n
+  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'
+- !ruby/object:Gem::Dependency
+  name: rodauth-model
+  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: Rodauth extension for logging in and creating account via OmniAuth authentication.
 email:
 - janko@hey.com
@@ -161,6 +189,7 @@ files:
 - README.md
 - lib/rodauth/features/omniauth.rb
 - lib/rodauth/features/omniauth_base.rb
+- locales/en.yml
 - rodauth-omniauth.gemspec
 homepage: https://github.com/janko/rodauth-omniauth
 licenses:
@@ -183,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Rodauth extension for logging in and creating account via OmniAuth authentication.