aboutsummaryrefslogtreecommitdiff
path: root/sx-auth.el
blob: 4299f3711c03edf854229c1872b4f4959433b8fb (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
;;; sx-auth.el --- user authentication  -*- lexical-binding: t; -*-

;; Copyright (C) 2014  Sean Allred

;; Author: Sean Allred <code@seanallred.com>

;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;;

;;; Code:

(require 'sx)
(require 'sx-request)
(require 'sx-cache)

(defconst sx-auth-root
  "https://stackexchange.com/oauth/dialog")
(defconst sx-auth-redirect-uri
  "http://vermiculus.github.io/stack-mode/auth/auth.htm")
(defconst sx-auth-client-id
  "3291")
(defvar sx-auth-access-token
  nil
  "Your access token.

This is needed to use your account to write questions, make
comments, and read your inbox.  Do not alter this unless you know
what you are doing!")

(defun sx-auth-authenticate ()
  "Authenticate this application.

Authentication is required to read your personal data (such as
notifications) and to write with the API (asking and answering
questions).

When this function is called, `browse-url' is used to send the
user to an authorization page managed by StackExchange.  The
following privileges are requested:

* read_inbox
    use SX to manage and visit items in your inbox

* write_acesss
    write comments, ask questions, and post answers on your
    behalf

* no_expiry
    do not pester you to reauthorize again

After authorization with StackExchange, the user is then
redirected to a website managed by SX.  The access token required
to use authenticated methods is included in the hash (which is
parsed and displayed prominently on the page)."
  (interactive)
  (setq
   sx-auth-access-token
   (let ((url (concat
               sx-auth-root
               "?"
               (sx-request--build-keyword-arguments
                `((client_id . ,sx-auth-client-id)
                  (scope . (read_inbox
                            no_expiry
                            write_access))
                  (redirect_uri . ,(url-hexify-string
                                    sx-auth-redirect-uri)))
                ","))))
     (browse-url url)
     (read-string "Enter the access token displayed on the webpage: ")))
  (if (string-equal "" sx-auth-access-token)
      (progn (setq sx-auth-access-token nil)
             (error "You must enter this code to use this client fully"))
    (sx-cache-set 'auth `((access_token . ,sx-auth-access-token)))))

(provide 'sx-auth)
;;; sx-auth.el ends here

;; Local Variables:
;; indent-tabs-mode: nil
;; End: