fix(OAuth2)!: Reflect assent site -> base_url change.

I considered just rewriting it behind the scenes, but I think it's probably better in the long run if we just emit a deprecation.
team-alembic · Nov 21, 2023 · 37670f0 · 37670f0
1 parent b90985b
commit 37670f0
Show file tree

Hide file tree

Showing 15 changed files with 348 additions and 221 deletions.
diff --git a/.formatter.exs b/.formatter.exs
@@ -8,6 +8,7 @@ spark_locals_without_parens = [
   auth_method: 1,
   authorization_params: 1,
   authorize_url: 1,
+  base_url: 1,
   client_authentication_method: 1,
   client_id: 1,
   client_secret: 1,

diff --git a/config/dev.exs b/config/dev.exs
@@ -31,7 +31,7 @@ config :ash_authentication,
         client_id: System.get_env("OAUTH2_CLIENT_ID"),
         redirect_uri: "http://localhost:4000/auth",
         client_secret: System.get_env("OAUTH2_CLIENT_SECRET"),
-        site: System.get_env("OAUTH2_SITE"),
+        base_url: System.get_env("OAUTH2_SITE"),
         authorize_url: "#{System.get_env("OAUTH2_SITE")}/authorize",
         token_url: "#{System.get_env("OAUTH2_SITE")}/oauth/token",
         user_url: "#{System.get_env("OAUTH2_SITE")}/userinfo"
@@ -40,7 +40,7 @@ config :ash_authentication,
         client_id: System.get_env("OAUTH2_CLIENT_ID"),
         redirect_uri: "http://localhost:4000/auth",
         client_secret: System.get_env("OAUTH2_CLIENT_SECRET"),
-        site: System.get_env("OAUTH2_SITE")
+        base_url: System.get_env("OAUTH2_SITE")
       ],
       github: [
         client_id: System.get_env("GITHUB_CLIENT_ID"),
@@ -52,7 +52,7 @@ config :ash_authentication,
         client_id: System.get_env("OAUTH2_CLIENT_ID"),
         client_secret: System.get_env("OAUTH2_CLIENT_SECRET"),
         redirect_uri: "http://localhost:4000/auth",
-        site: System.get_env("OAUTH2_SITE"),
+        base_url: System.get_env("OAUTH2_SITE"),
         token_url: "#{System.get_env("OAUTH2_SITE")}/oauth/token"
       ]
     ],

diff --git a/config/test.exs b/config/test.exs
@@ -21,7 +21,7 @@ config :ash_authentication,
         client_id: "pretend client id",
         redirect_uri: "http://localhost:4000/auth",
         client_secret: "pretend client secret",
-        site: "https://example.com/",
+        base_url: "https://example.com/",
         authorize_url: "https://example.com/authorize",
         token_url: "https://example.com/oauth/token",
         user_url: "https://example.com/userinfo"

diff --git a/documentation/dsls/DSL:-AshAuthentication.Strategy.Auth0.cheatmd b/documentation/dsls/DSL:-AshAuthentication.Strategy.Auth0.cheatmd
@@ -63,7 +63,7 @@ The following defaults are applied:
   end
   ```
 
-* `:site` - Required. The base URL of the OAuth2 server - including the leading protocol
+* `:base_url` - The base URL of the OAuth2 server - including the leading protocol
   (ie `https://`).  
   Takes either a module which implements the `AshAuthentication.Secret`
   behaviour, a 2 arity anonymous function or a string.  
@@ -72,13 +72,15 @@ The following defaults are applied:
 
   Example:  
   ```elixir
-  site fn _, resource ->
+  base_url fn _, resource ->
     :my_app
     |> Application.get_env(resource, [])
     |> Keyword.fetch(:oauth_site)
   end
   ```
 
+* `:site` - Deprecated: Use `base_url` instead.
+
 * `:auth_method` - The authentication strategy used, optional. If not set, no
   authentication will be used during the access token request. The
   value may be one of the following:  
@@ -331,9 +333,9 @@ end
 
 <tr>
   <td style="text-align: left">
-    <a id="authentication-strategies-auth0-site" href="#authentication-strategies-auth0-site">
+    <a id="authentication-strategies-auth0-authorize_url" href="#authentication-strategies-auth0-authorize_url">
       <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
-        site
+        authorize_url
       </span>
     </a>
       <sup style="color: red">*</sup>
@@ -346,8 +348,9 @@ end
 
   </td>
   <td style="text-align: left" colspan=2>
-    The base URL of the OAuth2 server - including the leading protocol
-(ie `https://`).
+    The API url to the OAuth2 authorize endpoint.
+
+Relative to the value of `site`.
 
 Takes either a module which implements the `AshAuthentication.Secret`
 behaviour, a 2 arity anonymous function or a string.
@@ -359,21 +362,17 @@ information.
 Example:
 
 ```elixir
-site fn _, resource ->
-  :my_app
-  |> Application.get_env(resource, [])
-  |> Keyword.fetch(:oauth_site)
-end
+authorize_url fn _, _ -> {:ok, "https://exampe.com/authorize"} end
 ```
 
   </td>
 </tr>
 
 <tr>
   <td style="text-align: left">
-    <a id="authentication-strategies-auth0-authorize_url" href="#authentication-strategies-auth0-authorize_url">
+    <a id="authentication-strategies-auth0-token_url" href="#authentication-strategies-auth0-token_url">
       <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
-        authorize_url
+        token_url
       </span>
     </a>
       <sup style="color: red">*</sup>
@@ -386,7 +385,7 @@ end
 
   </td>
   <td style="text-align: left" colspan=2>
-    The API url to the OAuth2 authorize endpoint.
+    The API url to access the token endpoint.
 
 Relative to the value of `site`.
 
@@ -400,17 +399,17 @@ information.
 Example:
 
 ```elixir
-authorize_url fn _, _ -> {:ok, "https://exampe.com/authorize"} end
+token_url fn _, _ -> {:ok, "https://example.com/oauth_token"} end
 ```
 
   </td>
 </tr>
 
 <tr>
   <td style="text-align: left">
-    <a id="authentication-strategies-auth0-token_url" href="#authentication-strategies-auth0-token_url">
+    <a id="authentication-strategies-auth0-user_url" href="#authentication-strategies-auth0-user_url">
       <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
-        token_url
+        user_url
       </span>
     </a>
       <sup style="color: red">*</sup>
@@ -423,7 +422,7 @@ authorize_url fn _, _ -> {:ok, "https://exampe.com/authorize"} end
 
   </td>
   <td style="text-align: left" colspan=2>
-    The API url to access the token endpoint.
+    The API url to access the user endpoint.
 
 Relative to the value of `site`.
 
@@ -437,17 +436,17 @@ information.
 Example:
 
 ```elixir
-token_url fn _, _ -> {:ok, "https://example.com/oauth_token"} end
+user_url fn _, _ -> {:ok, "https://example.com/userinfo"} end
 ```
 
   </td>
 </tr>
 
 <tr>
   <td style="text-align: left">
-    <a id="authentication-strategies-auth0-user_url" href="#authentication-strategies-auth0-user_url">
+    <a id="authentication-strategies-auth0-redirect_uri" href="#authentication-strategies-auth0-redirect_uri">
       <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
-        user_url
+        redirect_uri
       </span>
     </a>
       <sup style="color: red">*</sup>
@@ -460,9 +459,14 @@ token_url fn _, _ -> {:ok, "https://example.com/oauth_token"} end
 
   </td>
   <td style="text-align: left" colspan=2>
-    The API url to access the user endpoint.
+    The callback URI base.
 
-Relative to the value of `site`.
+Not the whole URI back to the callback endpoint, but the URI to your
+`AuthPlug`.  We can generate the rest.
+
+Whilst not particularly secret, it seemed prudent to allow this to be
+configured dynamically so that you can use different URIs for
+different environments.
 
 Takes either a module which implements the `AshAuthentication.Secret`
 behaviour, a 2 arity anonymous function or a string.
@@ -471,24 +475,17 @@ See the module documentation for `AshAuthentication.Secret` for more
 information.
 
 
-Example:
-
-```elixir
-user_url fn _, _ -> {:ok, "https://example.com/userinfo"} end
-```
-
   </td>
 </tr>
 
 <tr>
   <td style="text-align: left">
-    <a id="authentication-strategies-auth0-redirect_uri" href="#authentication-strategies-auth0-redirect_uri">
+    <a id="authentication-strategies-auth0-base_url" href="#authentication-strategies-auth0-base_url">
       <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
-        redirect_uri
+        base_url
       </span>
     </a>
-      <sup style="color: red">*</sup>
-
+
   </td>
   <td style="text-align: left">
     <code class="inline">(any, any -> any) | module | String.t</code>
@@ -497,14 +494,8 @@ user_url fn _, _ -> {:ok, "https://example.com/userinfo"} end
 
   </td>
   <td style="text-align: left" colspan=2>
-    The callback URI base.
-
-Not the whole URI back to the callback endpoint, but the URI to your
-`AuthPlug`.  We can generate the rest.
-
-Whilst not particularly secret, it seemed prudent to allow this to be
-configured dynamically so that you can use different URIs for
-different environments.
+    The base URL of the OAuth2 server - including the leading protocol
+(ie `https://`).
 
 Takes either a module which implements the `AshAuthentication.Secret`
 behaviour, a 2 arity anonymous function or a string.
@@ -513,6 +504,36 @@ See the module documentation for `AshAuthentication.Secret` for more
 information.
 
 
+Example:
+
+```elixir
+base_url fn _, resource ->
+  :my_app
+  |> Application.get_env(resource, [])
+  |> Keyword.fetch(:oauth_site)
+end
+```
+
+  </td>
+</tr>
+
+<tr>
+  <td style="text-align: left">
+    <a id="authentication-strategies-auth0-site" href="#authentication-strategies-auth0-site">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        site
+      </span>
+    </a>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">(any, any -> any) | module | String.t</code>
+  </td>
+  <td style="text-align: left">
+
+  </td>
+  <td style="text-align: left" colspan=2>
+    Deprecated: Use `base_url` instead.
   </td>
 </tr>