Skip to content

Allow ticktick-client-secret to be a function #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tino415 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Allow ticktick-client-secret to be a function #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,14 @@ Add to your Emacs configuration:
ticktick-client-secret "your-client-secret")
```

Instead of hard-coding your client secret into your configuration, storing it with [auth-source](https://www.gnu.org/software/emacs/manual/html_mono/auth.html) is recommended.
Instead of hard-coding your client secret into your configuration, storing it with [auth-source](https://www.gnu.org/software/emacs/manual/html_mono/auth.html) is recommended. `ticktick-client-secret` accepts a function of no arguments in place of a string:

```elisp
(setq ticktick-client-id "your-client-id"
ticktick-client-secret
(lambda ()
(auth-source-pick-first-password :host "ticktick.com" :user ticktick-client-id)))
```
### 3. Authorize Application

```
Expand Down
22 changes: 17 additions & 5 deletions ticktick.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@
;; (setq ticktick-client-id "your-client-id")
;; (setq ticktick-client-secret "your-client-secret")
;;
;; `ticktick-client-secret' also accepts a function of no arguments,
;; to fetch it on demand from auth-source. See the README.
;;
;; 3. Authorize the application:
;; M-x ticktick-authorize
;;
Expand Down Expand Up @@ -124,8 +127,9 @@
:group 'ticktick)

(defcustom ticktick-client-secret ""
"TickTick client secret."
:type 'string
"TickTick client secret, or a function of no arguments returning it."
:type '(choice (string :tag "Secret")
(function :tag "Function returning the secret"))
:group 'ticktick)

(defcustom ticktick-auth-scopes "tasks:write tasks:read"
Expand Down Expand Up @@ -550,11 +554,18 @@ Deletes or archives them in Org if user confirms."

;;; Authorization functions ----------------------------------------------------

(defun ticktick--client-secret ()
"Return `ticktick-client-secret' as a string, calling it if it is a function."
(or (if (functionp ticktick-client-secret)
(funcall ticktick-client-secret)
ticktick-client-secret)
""))

(defun ticktick--authorization-header ()
"Create basic authentication header for TickTick API."
(concat "Basic "
(base64-encode-string
(concat ticktick-client-id ":" ticktick-client-secret) t)))
(concat ticktick-client-id ":" (ticktick--client-secret)) t)))

(defun ticktick--make-token-request (form-params)
"Make a token request with FORM-PARAMS and return the response data."
Expand Down Expand Up @@ -634,7 +645,8 @@ Deletes or archives them in Org if user confirms."
(interactive)
(message "=== TickTick OAuth Debug Info ===")
(message "Client ID: %s" (if (string-empty-p ticktick-client-id) "NOT SET" "SET"))
(message "Client Secret: %s" (if (string-empty-p ticktick-client-secret) "NOT SET" "SET"))
(message "Client Secret: %s"
(if (string-empty-p (ticktick--client-secret)) "NOT SET" "SET"))
(message "Redirect URI: %s" ticktick-redirect-uri)
(message "Auth Scopes: %s" ticktick-auth-scopes)
(message "Token file: %s" ticktick-token-file)
Expand All @@ -650,7 +662,7 @@ Deletes or archives them in Org if user confirms."
Starts local server, requests consent through browser, then captures redirect."
(interactive)
(unless (and (stringp ticktick-client-id) (not (string-empty-p ticktick-client-id))
(stringp ticktick-client-secret) (not (string-empty-p ticktick-client-secret)))
(not (string-empty-p (ticktick--client-secret))))
(user-error "Ticktick-client-id and ticktick-client-secret must be set"))
(ticktick--start-callback-server)
(setq ticktick-oauth-state (format "%06x" (random (expt 16 6))))
Expand Down