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
|
;;; sx-method.el --- method calls
;; 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:
;;; This file is effectively a common-use wrapper for
;;; `sx-request-make'. It provides higher-level handling such as
;;; (authentication, filters, ...) that `sx-request-make' doesn't need
;;; to handle.
;;; Code:
(require 'json)
(require 'url)
(require 'sx)
(require 'sx-auth)
(require 'sx-request)
(require 'sx-filter)
(cl-defun sx-method-call (method &key id
submethod
keywords
(filter 'none)
auth
(url-method "GET")
site)
"Call METHOD with additional keys.
:ID is the id associated with a question, answer, comment, post or
user.
:SUBMETHOD is the additional segments of the method.
:KEYWORDS are the api parameters.
:FILTER is the set of filters to control the returned information
:AUTH defines how to act if the method or filters require
authentication.
:URL-METHOD is either \"POST\" or \"GET\"
:SITE is the api parameter specifying the site.
Return the entire response as a complex alist."
(let ((access-token (sx-cache-get 'auth))
(method-auth (sx-auth--method-p method submethod))
(filter-auth (sx-auth--filter-p filter))
(full-method (concat (format "%s" method)
(when id
(format "/%s" id))
(when submethod
(format "/%s" submethod))))
(call 'sx-request-make))
(lwarn "sx-call-method" :debug "A: %S T: %S. M: %S,%s. F: %S" (equal 'warn auth)
access-token method-auth full-method filter-auth)
(unless access-token
(cond
;; 1. Need auth and warn user (interactive use)
((and method-auth (equal 'warn auth))
(user-error
"This request requires authentication. Please run `M-x sx-auth-authenticate' and try again."))
;; 2. Need auth to populate UI, cannot provide subset
((and method-auth auth)
(setq call 'sx-request-fallback))
;; 3. Need auth for type. Use auth-less filter.
((and filter-auth auth)
(setq filter filter-auth))
;; 4. Requires auth but no value set for auth
((and (or filter-auth method-auth) (not auth))
(error "This request requires authentication."))))
;; Concatenate all parameters now that filter is ensured.
(setq parameters
(cons `(site . ,site)
(cons (cons 'filter
(sx-filter-get-var filter))
keywords)))
(funcall call
full-method
parameters
url-method)))
(provide 'sx-method)
;;; sx-method.el ends here
|
