blob: 91c4db4adf84e5ab3f89bb874eaf2397e103e3a8 (
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
;;; sx-request.el --- requests and url manipulation -*- 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 'url)
(require 'json)
(require 'sx)
(require 'sx-encoding)
;;; Variables
(defconst sx-request-api-key
"0TE6s1tveCpP9K5r5JNDNQ(("
"When passed, this key provides a higher request quota.")
(defconst sx-request-api-version
"2.2"
"The current version of the API.")
(defconst sx-request-api-root
(format "https://api.stackexchange.com/%s/" sx-request-api-version)
"The base URL to make requests from.")
(defcustom sx-request-silent-p
t
"When `t', requests default to being silent.")
(defcustom sx-request-cache-p
t
"Cache requests made to the StackExchange API.")
(defcustom sx-request-unzip-program
"gunzip"
"program used to unzip the response")
(defvar sx-request-remaining-api-requests
nil
"The number of API requests remaining according to the most
recent call. Set by `sx-request-make'.")
(defcustom sx-request-remaining-api-requests-message-threshold
50
"After `sx-request-remaining-api-requests' drops below this
number, `sx-request-make' will begin printing out the
number of requests left every time it finishes a call.")
;;; Making Requests
(defun sx-request-make
(method &optional args need-auth use-post silent)
(let ((url-automatic-caching sx-request-cache-p)
(url-inhibit-uncompression t)
(silent (or silent sx-request-silent-p))
(request-method (if use-post "POST" "GET"))
(request-args
(sx-request--build-keyword-arguments args nil need-auth))
(request-url (concat sx-request-api-root method)))
(unless silent (sx-message "Request: %S" request-url))
(let ((response-buffer (sx-request--request request-url
request-args
request-method
silent)))
(if (not response-buffer)
(error "Something went wrong in `url-retrieve-synchronously'")
(with-current-buffer response-buffer
(let* ((data (progn
(goto-char (point-min))
(if (not (search-forward "\n\n" nil t))
(error "Response headers missing; response corrupt")
(delete-region (point-min) (point))
(buffer-string))))
(response-zipped-p (sx-encoding-gzipped-p data))
(data (if (not response-zipped-p) data
(shell-command-on-region
(point-min) (point-max)
sx-request-unzip-program
nil t)
(buffer-string)))
(response (with-demoted-errors "`json' error: %S"
(json-read-from-string data))))
(when (and (not response) (string-equal data "{}"))
(sx-message "Unable to parse response: %S" response)
(error "Response could not be read by `json-read-from-string'"))
;; If we get here, the response is a valid data structure
(sx-assoc-let response
(when .error_id
(error "Request failed: (%s) [%i %s] %S"
.method .error_id .error_name .error_message))
(when (< (setq sx-request-remaining-api-requests
.quota_remaining)
sx-request-remaining-api-requests-message-threshold)
(sx-message "%d API requests reamining"
sx-request-remaining-api-requests))
(sx-encoding-clean-content-deep .items))))))))
;;; Support Functions
(defun sx-request--request (url args method silent)
(let ((url-request-method method)
(url-request-extra-headers
'(("Content-Type" . "application/x-www-form-urlencoded")))
(url-request-data args))
(cond
((equal '(24 . 4) (cons emacs-major-version emacs-minor-version))
(url-retrieve-synchronously url silent))
(t (url-retrieve-synchronously url)))))
(defun sx-request--build-keyword-arguments (alist &optional
kv-value-sep need-auth)
"Build a \"key=value&key=value&...\"-style string with the elements
of ALIST. If any value in the alist is `nil', that pair will not
be included in the return. If you wish to pass a notion of
false, use the symbol `false'. Each element is processed with
`sx--thing-as-string'."
;; Add API key to list of arguments, this allows for increased quota
;; automatically.
(let* ((warn (equal need-auth 'warn))
(auth
(let ((auth (car (sx-cache-get 'auth))))
(cond
(auth)
;; Pass user error when asking to warn
(warn
(user-error
"This query requires authentication. Please run `M-x sx-auth-authenticate' and try again."))
((not auth)
(lwarn "stack-mode" :debug
"This query requires authentication")
nil)))))
(add-to-list 'alist (cons "key" sx-request-api-key))
(if (and need-auth auth)
(add-to-list 'alist auth))
(mapconcat
(lambda (pair)
(concat
(sx--thing-as-string (car pair))
"="
(sx--thing-as-string (cdr pair) kv-value-sep)))
(delq nil (mapcar
(lambda (pair)
(when (cdr pair) pair))
alist))
"&")))
(provide 'sx-request)
;;; sx-request.el ends here
|
