config: Add support for auth.client-id

Author: dbarnett

data/config-schema.json

@@ -4,6 +4,26 @@
   "description": "User configuration for gcalcli command-line tool.\n\nSee https://pypi.org/project/gcalcli/.",
   "type": "object",
   "$defs": {
+    "AuthSection": {
+      "title": "Settings for authentication",
+      "description": "Configuration for settings like client-id used in auth flow.\n\nNote that client-secret can't be configured here and should be passed on\ncommand-line instead for security reasons.",
+      "type": "object",
+      "properties": {
+        "client-id": {
+          "title": "Client ID for Google auth token",
+          "description": "Google client ID for your auth client project.\n\nDetails: https://github.com/insanum/gcalcli/blob/HEAD/docs/api-auth.md",
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null
+        }
+      }
+    },
     "CalendarsSection": {
       "title": "Settings about the set of calendars gcalcli operates on",
       "type": "object",
@@ -45,6 +65,9 @@
     }
   },
   "properties": {
+    "auth": {
+      "$ref": "#/$defs/AuthSection"
+    },
     "calendars": {
       "$ref": "#/$defs/CalendarsSection"
     },

gcalcli/config.py

@@ -4,7 +4,7 @@
 from collections import OrderedDict
 from enum import Enum
 import sys
-from typing import Any, List, Mapping
+from typing import Any, List, Mapping, Optional
 
 if sys.version_info[:2] < (3, 11):
     import toml as tomllib
@@ -15,6 +15,24 @@
 from pydantic.json_schema import GenerateJsonSchema
 
 
+class AuthSection(BaseModel):
+    """Configuration for settings like client-id used in auth flow.
+
+    Note that client-secret can't be configured here and should be passed on
+    command-line instead for security reasons.
+    """
+
+    model_config = ConfigDict(title='Settings for authentication')
+
+    client_id: Optional[str] = Field(
+        alias='client-id',
+        title='Client ID for Google auth token',
+        description="""Google client ID for your auth client project.\n
+Details: https://github.com/insanum/gcalcli/blob/HEAD/docs/api-auth.md""",
+        default=None,
+    )
+
+
 class CalendarsSection(BaseModel):
     model_config = ConfigDict(
         title='Settings about the set of calendars gcalcli operates on'
@@ -48,7 +66,8 @@ class OutputSection(BaseModel):
     week_start: WeekStart = Field(
         alias='week-start',
         title='Weekday to treat as start of week',
-        default=WeekStart.SUNDAY)
+        default=WeekStart.SUNDAY,
+    )
 
 
 class Config(BaseModel):
@@ -62,6 +81,7 @@ class Config(BaseModel):
         json_schema_extra={'$schema': GenerateJsonSchema.schema_dialect},
     )
 
+    auth: AuthSection = Field(default_factory=AuthSection)
     calendars: CalendarsSection = Field(default_factory=CalendarsSection)
     output: OutputSection = Field(default_factory=OutputSection)
 
@@ -72,6 +92,8 @@ def from_toml(cls, config_file):
 
     def to_argparse_namespace(self) -> argparse.Namespace:
         kwargs = {}
+        if self.auth:
+            kwargs.update(vars(self.auth))
         if self.calendars:
             kwargs.update(vars(self.calendars))
         if self.output:

tests/cli/test.bats

@@ -13,31 +13,26 @@ function teardown() {
   temp_del "$TEST_HOME_DIR"
 }
 
-function run_gcalcli() {
-  # Kill any commands that hang for longer than 3s timeout.
-  run timeout 3 gcalcli "$@"
-}
-
 @test "can run" {
-  run_gcalcli
+  run gcalcli
   assert_failure 2
   assert_output --regexp 'usage: .*error:.*required: .*command'
 }
 
 @test "prints correct help" {
-  GCALCLI_CONFIG=/some/gcalcli/config COLUMNS=72 run_gcalcli -h
+  GCALCLI_CONFIG=/some/gcalcli/config COLUMNS=72 run gcalcli -h
   assert_success
   assert_snapshot
 }
 
 @test "can run init" {
-  run_gcalcli init --client-id=SOME_CLIENT <<< "SOME_SECRET
+  run gcalcli init --client-id=SOME_CLIENT <<< "SOME_SECRET
 "
   assert_snapshot
 }
 
 @test "can run add" {
-  run_gcalcli add <<< "sometitle
+  run gcalcli add <<< "sometitle
 
 tomorrow