diff options
| author | Johnson Denen <johnson.denen@gmail.com> | 2017-04-08 13:34:45 -0400 |
|---|---|---|
| committer | jdenen <Johnson.Denen@ascenaretail.com> | 2017-04-09 08:55:37 -0400 |
| commit | cce134294df7021e94b414ced616741ee6a4ffcb (patch) | |
| tree | 61452cf06f031e6a3cab3f06dfa96ff3ff4c3c34 /lisp/mastodon-auth.el | |
| parent | b3faec5e80687b1c944e39dc2290922d133b5e65 (diff) | |
Update DOCSTRINGs
Diffstat (limited to 'lisp/mastodon-auth.el')
| -rw-r--r-- | lisp/mastodon-auth.el | 22 |
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 |