Add hostname as oauth token name

ericmj · ericmj · commit b2771fa2f7d7 · 2025-09-22T21:12:12.000+02:00
diff --git a/lib/hex/api/oauth.ex b/lib/hex/api/oauth.ex
@@ -9,10 +9,11 @@ defmodule Hex.API.OAuth do
   Initiates the OAuth device authorization flow.
 
   Returns device code, user code, and verification URIs for user authentication.
+  Optionally accepts a name parameter to identify the token.
 
   ## Examples
 
-      iex> Hex.API.OAuth.device_authorization()
+      iex> Hex.API.OAuth.device_authorization("api")
       {:ok, {200, _headers, %{
         "device_code" => "...",
         "user_code" => "ABCD-1234",
@@ -22,9 +23,10 @@ defmodule Hex.API.OAuth do
         "interval" => 5
       }}}
   """
-  def device_authorization(scopes \\ "api repositories") do
+  def device_authorization(scopes, name \\ nil) do
     config = Client.config()
-    :mix_hex_api_oauth.device_authorization(config, @client_id, scopes)
+    opts = if name, do: [name: name], else: []
+    :mix_hex_api_oauth.device_authorization(config, @client_id, scopes, opts)
   end
 
   @doc """
diff --git a/lib/mix/tasks/hex.ex b/lib/mix/tasks/hex.ex
@@ -125,6 +125,13 @@ defmodule Mix.Tasks.Hex do
     auth_device(opts)
   end
 
+  defp get_hostname() do
+    case :inet.gethostname() do
+      {:ok, hostname} -> to_string(hostname)
+      {:error, _} -> nil
+    end
+  end
+
   @doc false
   def auth_device(_opts \\ []) do
     # Clean up any existing authentication
@@ -133,7 +140,9 @@ defmodule Mix.Tasks.Hex do
 
     Hex.Shell.info("Starting OAuth device flow authentication...")
 
-    case Hex.API.OAuth.device_authorization() do
+    name = get_hostname()
+
+    case Hex.API.OAuth.device_authorization("api repositories", name) do
       {:ok, {200, _, device_response}} ->
         perform_device_flow(device_response)
 
diff --git a/src/mix_hex_api.erl b/src/mix_hex_api.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% Hex HTTP API
diff --git a/src/mix_hex_api_auth.erl b/src/mix_hex_api_auth.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% Hex HTTP API - Authentication.
diff --git a/src/mix_hex_api_key.erl b/src/mix_hex_api_key.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% Hex HTTP API - Keys.
diff --git a/src/mix_hex_api_oauth.erl b/src/mix_hex_api_oauth.erl
@@ -1,10 +1,11 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% Hex HTTP API - OAuth.
 -module(mix_hex_api_oauth).
 -export([
     device_authorization/3,
+    device_authorization/4,
     poll_device_token/3,
     exchange_token/4,
     refresh_token/3,
@@ -33,11 +34,32 @@
 %% @end
 -spec device_authorization(mix_hex_core:config(), binary(), binary()) -> mix_hex_api:response().
 device_authorization(Config, ClientId, Scope) ->
+    device_authorization(Config, ClientId, Scope, []).
+
+%% @doc
+%% Initiates the OAuth device authorization flow with optional parameters.
+%%
+%% Options:
+%%   * name - A name to identify the token (e.g., hostname of the device)
+%%
+%% Examples:
+%%
+%% ```
+%% 1> Config = mix_hex_core:default_config().
+%% 2> mix_hex_api_oauth:device_authorization(Config, <<"cli">>, <<"api:write">>, [{name, <<"MyMachine">>}]).
+%% '''
+%% @end
+-spec device_authorization(mix_hex_core:config(), binary(), binary(), proplists:proplist()) -> mix_hex_api:response().
+device_authorization(Config, ClientId, Scope, Opts) ->
     Path = <<"oauth/device_authorization">>,
-    Params = #{
+    Params0 = #{
         <<"client_id">> => ClientId,
         <<"scope">> => Scope
     },
+    Params = case proplists:get_value(name, Opts) of
+        undefined -> Params0;
+        Name -> Params0#{<<"name">> => Name}
+    end,
     mix_hex_api:post(Config, Path, Params).
 
 %% @doc
diff --git a/src/mix_hex_api_organization.erl b/src/mix_hex_api_organization.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% Hex HTTP API - Organizations.
diff --git a/src/mix_hex_api_organization_member.erl b/src/mix_hex_api_organization_member.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% Hex HTTP API - Organization Members.
diff --git a/src/mix_hex_api_package.erl b/src/mix_hex_api_package.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% Hex HTTP API - Packages.
diff --git a/src/mix_hex_api_package_owner.erl b/src/mix_hex_api_package_owner.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% Hex HTTP API - Package Owners.
diff --git a/src/mix_hex_api_release.erl b/src/mix_hex_api_release.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% Hex HTTP API - Releases.
diff --git a/src/mix_hex_api_short_url.erl b/src/mix_hex_api_short_url.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% Hex HTTP API - Short URLs.
diff --git a/src/mix_hex_api_user.erl b/src/mix_hex_api_user.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% Hex HTTP API - Users.
diff --git a/src/mix_hex_core.erl b/src/mix_hex_core.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% `hex_core' entrypoint module.
diff --git a/src/mix_hex_core.hrl b/src/mix_hex_core.hrl
@@ -1,3 +1,3 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 -define(HEX_CORE_VERSION, "0.11.0").
diff --git a/src/mix_hex_erl_tar.erl b/src/mix_hex_erl_tar.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @private
 %% Copied from https://github.com/erlang/otp/blob/OTP-20.0.1/lib/stdlib/src/erl_tar.erl
diff --git a/src/mix_hex_erl_tar.hrl b/src/mix_hex_erl_tar.hrl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 % Copied from https://github.com/erlang/otp/blob/OTP-20.0.1/lib/stdlib/src/erl_tar.hrl
 
diff --git a/src/mix_hex_filename.erl b/src/mix_hex_filename.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 % @private
 % Excerpt from https://github.com/erlang/otp/blob/OTP-20.0.1/lib/stdlib/src/filename.erl#L761-L788
diff --git a/src/mix_hex_http.erl b/src/mix_hex_http.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% HTTP contract.
diff --git a/src/mix_hex_http_httpc.erl b/src/mix_hex_http_httpc.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% httpc-based implementation of {@link mix_hex_http} contract.
diff --git a/src/mix_hex_licenses.erl b/src/mix_hex_licenses.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% Hex Licenses.
diff --git a/src/mix_hex_pb_names.erl b/src/mix_hex_pb_names.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% -*- coding: utf-8 -*-
 %% % this file is @generated
diff --git a/src/mix_hex_pb_package.erl b/src/mix_hex_pb_package.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% -*- coding: utf-8 -*-
 %% % this file is @generated
diff --git a/src/mix_hex_pb_signed.erl b/src/mix_hex_pb_signed.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% -*- coding: utf-8 -*-
 %% % this file is @generated
diff --git a/src/mix_hex_pb_versions.erl b/src/mix_hex_pb_versions.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% -*- coding: utf-8 -*-
 %% % this file is @generated
diff --git a/src/mix_hex_registry.erl b/src/mix_hex_registry.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% Functions for encoding and decoding Hex registries.
diff --git a/src/mix_hex_repo.erl b/src/mix_hex_repo.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% Repo API.
diff --git a/src/mix_hex_tarball.erl b/src/mix_hex_tarball.erl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %% @doc
 %% Functions for creating and unpacking Hex tarballs.
diff --git a/src/mix_safe_erl_term.xrl b/src/mix_safe_erl_term.xrl
@@ -1,4 +1,4 @@
-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually
+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually
 
 %%% Author  : Robert Virding
 %%% Purpose : Token definitions for Erlang.
diff --git a/test/hex/api/oauth_test.exs b/test/hex/api/oauth_test.exs
@@ -17,7 +17,7 @@ defmodule Hex.API.OAuthTest do
     end
 
     test "defaults to api repositories scope" do
-      assert {:ok, {200, _headers, response}} = Hex.API.OAuth.device_authorization()
+      assert {:ok, {200, _headers, response}} = Hex.API.OAuth.device_authorization("api")
 
       # Should return valid device authorization data
       assert is_binary(response["device_code"])
@@ -32,12 +32,32 @@ defmodule Hex.API.OAuthTest do
       # Server may return 200 (accepted), 400 (invalid scope), or 401 (invalid client)
       assert status in [200, 400, 401]
     end
+
+    test "sends name parameter when provided" do
+      name = "TestMachine"
+
+      assert {:ok, {200, _headers, response}} =
+               Hex.API.OAuth.device_authorization("api repositories", name)
+
+      # Verify the response has the expected structure
+      assert is_binary(response["device_code"])
+      assert is_binary(response["user_code"])
+    end
+
+    test "works without name parameter" do
+      assert {:ok, {200, _headers, response}} =
+               Hex.API.OAuth.device_authorization("api repositories", nil)
+
+      # Should still return valid device authorization data
+      assert is_binary(response["device_code"])
+      assert is_binary(response["user_code"])
+    end
   end
 
   describe "poll_device_token/1" do
     test "returns authorization_pending for valid device code" do
       # First get a valid device code
-      {:ok, {200, _headers, device_response}} = Hex.API.OAuth.device_authorization()
+      {:ok, {200, _headers, device_response}} = Hex.API.OAuth.device_authorization("api")
       device_code = device_response["device_code"]
 
       # Polling should return authorization_pending since user hasn't authorized
diff --git a/test/mix/tasks/hex.user_test.exs b/test/mix/tasks/hex.user_test.exs
@@ -10,7 +10,7 @@ defmodule Mix.Tasks.Hex.UserTest do
       Hex.OAuth.clear_tokens()
 
       # Test that device authorization works but don't try to complete the flow
-      assert {:ok, {200, _headers, response}} = Hex.API.OAuth.device_authorization()
+      assert {:ok, {200, _headers, response}} = Hex.API.OAuth.device_authorization("api")
 
       assert %{
                "device_code" => device_code,
@@ -39,12 +39,53 @@ defmodule Mix.Tasks.Hex.UserTest do
 
       # Test device authorization
       assert {:ok, {200, _headers, %{"device_code" => device_code}}} =
-               Hex.API.OAuth.device_authorization()
+               Hex.API.OAuth.device_authorization("api")
 
       assert is_binary(device_code)
     end)
   end
 
+  test "auth with custom name parameter" do
+    in_tmp(fn ->
+      set_home_cwd()
+
+      Hex.OAuth.clear_tokens()
+
+      # Test device authorization with a custom name
+      custom_name = "MyTestDevice"
+
+      assert {:ok, {200, _headers, response}} =
+               Hex.API.OAuth.device_authorization("api repositories", custom_name)
+
+      assert %{
+               "device_code" => device_code,
+               "user_code" => user_code
+             } = response
+
+      assert is_binary(device_code)
+      assert is_binary(user_code)
+
+      # Verify the flow works with the name parameter
+      assert {:ok, {400, _headers, %{"error" => "authorization_pending"}}} =
+               Hex.API.OAuth.poll_device_token(device_code)
+    end)
+  end
+
+  test "auth with nil name parameter" do
+    in_tmp(fn ->
+      set_home_cwd()
+
+      Hex.OAuth.clear_tokens()
+
+      # Test device authorization with nil name (should work)
+      assert {:ok, {200, _headers, response}} =
+               Hex.API.OAuth.device_authorization("api repositories", nil)
+
+      assert %{"device_code" => device_code} = response
+      assert is_binary(device_code)
+    end)
+  end
+
   test "auth handles device flow errors gracefully" do
     in_tmp(fn ->
       set_home_cwd()
@@ -67,7 +108,7 @@ defmodule Mix.Tasks.Hex.UserTest do
 
       # Test that repeated polling gets proper response
       assert {:ok, {200, _headers, %{"device_code" => device_code}}} =
-               Hex.API.OAuth.device_authorization()
+               Hex.API.OAuth.device_authorization("api")
 
       # Immediate polling should get authorization_pending
       assert {:ok, {400, _headers, %{"error" => "authorization_pending"}}} =
@@ -82,7 +123,7 @@ defmodule Mix.Tasks.Hex.UserTest do
       Hex.OAuth.clear_tokens()
 
       # Test device authorization returns proper structure
-      assert {:ok, {200, _headers, response}} = Hex.API.OAuth.device_authorization()
+      assert {:ok, {200, _headers, response}} = Hex.API.OAuth.device_authorization("api")
 
       assert %{
                "device_code" => _,
diff --git a/test/setup_hexpm.exs b/test/setup_hexpm.exs
@@ -9,7 +9,7 @@ config = Hex.API.Client.config()
 body = %{
   "client_id" => "78ea6566-89fd-481e-a1d6-7d9d78eacca8",
   "client_type" => "public",
-  "name" => "Mix Hex"
+  "name" => "Hex CLI"
 }
 
 :mix_hex_api.post(config, ["oauth_client"], body)

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-%% Vendored from hex_core v0.11.0 (75e889f), do not edit manually`
	`1`	`+%% Vendored from hex_core v0.11.0 (94a912d), do not edit manually`
`2`	`2`
`3`	`3`	`%% @doc`
`4`	`4`	`%% Hex HTTP API`