aboutsummaryrefslogtreecommitdiff
path: root/lisp/mastodon-auth.el
diff options
context:
space:
mode:
Diffstat (limited to 'lisp/mastodon-auth.el')
-rw-r--r--lisp/mastodon-auth.el22
1 files changed, 19 insertions, 3 deletions
diff --git a/lisp/mastodon-auth.el b/lisp/mastodon-auth.el
index 5a52f8c..06d7685 100644
--- a/lisp/mastodon-auth.el
+++ b/lisp/mastodon-auth.el
@@ -9,6 +9,9 @@
(defvar mastodon--api-token-string nil)
(defun mastodon--register-client-app-triage (status)
+ "Callback function to triage `mastodon--register-client-app' response.
+
+STATUS is passed by `url-retrieve'."
(mastodon--http-response-triage status
(lambda () (let ((client-data (mastodon--json-hash-table)))
(setq mastodon--client-app-plist
@@ -18,9 +21,7 @@
,(gethash "client_secret" client-data)))))))
(defun mastodon--register-client-app ()
- "Adds client_id and client_secret to `mastodon--client-plist'.
-
- Returns a `plist' with CLIENT_ID and CLIENT_SECRET."
+ "Adds `:client_id' and `client_secret' to `mastodon--client-plist'."
(mastodon--http-post (mastodon--api-for "apps")
'mastodon--register-client-app-triage
'(("client_name" . "mastodon.el")
@@ -28,11 +29,13 @@
("scopes" . "read write follow"))))
(defun mastodon--register-and-return-client-app ()
+ "Registers `mastodon' with an instance. Returns `mastodon--client-app-plist'."
(progn
(mastodon--register-client-app)
mastodon--client-app-plist))
(defun mastodon--store-client-id-and-secret ()
+ "Stores `:client_id' and `:client_secret' in a plstore."
(let ((client-plist (mastodon--register-and-return-client-app))
(plstore (plstore-open mastodon-token-file)))
(plstore-put plstore "mastodon" `(:client_id
@@ -44,6 +47,10 @@
client-plist))
(defun mastodon--client-app ()
+ "Returns `mastodon--client-app-plist'.
+
+If not set, retrieves client data from `mastodon-token-file'.
+If no data can be found in the token file, registers the app and stores its data via `mastodon--store-client-id-and-secret'."
(if (plist-get mastodon--client-app-plist :client_secret)
mastodon--client-app-plist
(let* ((plstore (plstore-open mastodon-token-file))
@@ -57,6 +64,9 @@
mastodon--client-app-plist)))))
(defun mastodon--get-access-token-triage (status)
+ "Callback function to triage `mastodon--get-access-token' response.
+
+STATUS is passed by `url-retrieve'."
(mastodon--http-response-triage status
(lambda ()
(let ((token-data (mastodon--json-hash-table)))
@@ -65,6 +75,9 @@
mastodon--api-token-string)))))
(defun mastodon--get-access-token ()
+ "Retrieves access token from instance. Authenticates with email address and password.
+
+Email address and password are not stored."
(mastodon--http-post (concat mastodon-instance-url "/oauth/token")
'mastodon--get-access-token-triage
`(("client_id" . ,(plist-get (mastodon--client-app) :client_id))
@@ -74,6 +87,9 @@
("password" . ,(read-passwd "Password: ")))))
(defun mastodon--access-token ()
+ "Returns `mastodon--api-token-string'.
+
+If not set, retrieves token with `mastodon--get-access-token'."
(if mastodon--api-token-string
mastodon--api-token-string
(progn