aboutsummaryrefslogtreecommitdiff
path: root/oneliners.api-client.lisp
blob: d66ce65e196922b2ce9c320f188cd290dfb3401c (plain)
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289

(defpackage #:lazybones-client.shared 
   (:intern #:req-string)
   (:export #:*host* #:*body* #:*headers* #:*cookies*))
(defpackage #:ONELINERS.API-CLIENT 
   (:use :cl :lazybones-client.shared) 
   (:export #:*host* #:*body* #:*headers* #:*cookies* #:request-with
 #:GET--SEARCH
#:PATCH--FLAG-ONELINER
#:PATCH--EDIT-ONELINER
#:PATCH--UNLOCK-ONELINER
#:PATCH--LOCK-ONELINER
#:POST--ADD-ONELINER
#:POST--MAKE-INVITE
#:POST--REVOKE-CONTRIBUTOR
#:POST--TOKEN-CONTRIBUTOR
#:POST--REDEEM-INVITE))
(in-package :ONELINERS.API-CLIENT)


(defvar *host* nil
       "The host to which the client will send its requests.")

  (defvar *body* nil
    "Body passed to client post, put, and patch requests")

  (defvar *cookies* nil
    "An instance of CL-COOKIE:COOKIE-JAR.")

  (defvar *headers* nil
    "A liist of (header-name . header-value) pairs.")

  (defmacro request-with ((&key host body headers content-type cookies) &body forms)
    "Make a request in a specific context.

HOST is a string, the hostname where the request will be sent. Defaults
to *HOST*.

BODY should be a string, an alist, or a pathname. Default to *BODY*

HEADERS should be an ALIST of (header-name . header-value) string
pairs. Defaults to *HEADERS*.

CONTENT-TYPE is a convenience for supplying just the Content-Type
header.

COOKIES should be an instance of CL-COOKIE:COOKIE-JAR. Defaults to
*COOKIES*.
"
    (let ((content-type-var (gensym)) 
          (http-error-var (gensym))) 
      `(let ((*host* (or ,host *host*))
             (*body* (or ,body *body*))
             (*headers* (or ,headers *headers*))
             (*cookies* (or ,cookies *cookies*))
             (,content-type-var ,content-type))
         (when ,content-type-var
           (push (cons "Content-Type" ,content-type-var) *headers*))
           (handler-case (progn ,@forms)
              (dex:http-request-failed (,http-error-var)
                   (format *error-output* "~a -- ~a" 
                           (dex:response-status ,http-error-var)
                           (dex:response-body ,http-error-var)))))))


(DEFUN GET--SEARCH (&KEY TAGS LIMIT NOTFLAGGED)
  "A search endpoint returning a JSON encoded array of Oneliner
Entries. TAGS cannot be empty. Returns a [Search
Result](#search-result) object."
  (LET ((LAZYBONES-CLIENT.SHARED::REQ-STRING
         (APPLY #'CONCATENATE 'STRING LAZYBONES-CLIENT.SHARED:*HOST*
                (FORMAT NIL "/search")
                (WHEN (OR TAGS LIMIT NOTFLAGGED)
                  (LIST "?"
                        (IF TAGS
                            (CONCATENATE 'STRING (SYMBOL-NAME 'TAGS) "="
                                         (FORMAT NIL "~a" TAGS))
                            "")
                        (IF LIMIT
                            (CONCATENATE 'STRING "&" (SYMBOL-NAME 'LIMIT) "="
                                         (FORMAT NIL "~a" LIMIT))
                            "")
                        (IF NOTFLAGGED
                            (CONCATENATE 'STRING "&" (SYMBOL-NAME 'NOTFLAGGED)
                                         "=" (FORMAT NIL "~a" NOTFLAGGED))
                            ""))))))
    (DEXADOR:GET LAZYBONES-CLIENT.SHARED::REQ-STRING :COOKIE-JAR
     LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
     LAZYBONES-CLIENT.SHARED:*HEADERS*))) 


(DEFUN PATCH--FLAG-ONELINER (ONELINER &KEY TOKEN)
  "Flag the oneliner for review. Open to anyone."
  (LET ((LAZYBONES-CLIENT.SHARED::REQ-STRING
         (APPLY #'CONCATENATE 'STRING LAZYBONES-CLIENT.SHARED:*HOST*
                (FORMAT NIL "/flag/~a" ONELINER)
                (WHEN (OR TOKEN)
                  (LIST "?"
                        (IF TOKEN
                            (CONCATENATE 'STRING (SYMBOL-NAME 'TOKEN) "="
                                         (FORMAT NIL "~a" TOKEN))
                            ""))))))
    (IF LAZYBONES-CLIENT.SHARED:*BODY*
        (DEXADOR:PATCH LAZYBONES-CLIENT.SHARED::REQ-STRING :CONTENT
         LAZYBONES-CLIENT.SHARED:*BODY* :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)
        (DEXADOR:PATCH LAZYBONES-CLIENT.SHARED::REQ-STRING :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)))) 


(DEFUN PATCH--EDIT-ONELINER (ONELINER &KEY TOKEN)
  "Edit the fields of a oneliner."
  (LET ((LAZYBONES-CLIENT.SHARED::REQ-STRING
         (APPLY #'CONCATENATE 'STRING LAZYBONES-CLIENT.SHARED:*HOST*
                (FORMAT NIL "/edit/~a" ONELINER)
                (WHEN (OR TOKEN)
                  (LIST "?"
                        (IF TOKEN
                            (CONCATENATE 'STRING (SYMBOL-NAME 'TOKEN) "="
                                         (FORMAT NIL "~a" TOKEN))
                            ""))))))
    (IF LAZYBONES-CLIENT.SHARED:*BODY*
        (DEXADOR:PATCH LAZYBONES-CLIENT.SHARED::REQ-STRING :CONTENT
         LAZYBONES-CLIENT.SHARED:*BODY* :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)
        (DEXADOR:PATCH LAZYBONES-CLIENT.SHARED::REQ-STRING :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)))) 


(DEFUN PATCH--UNLOCK-ONELINER (ONELINER &KEY TOKEN)
  "Unlocks a oneliner."
  (LET ((LAZYBONES-CLIENT.SHARED::REQ-STRING
         (APPLY #'CONCATENATE 'STRING LAZYBONES-CLIENT.SHARED:*HOST*
                (FORMAT NIL "/unlock/~a" ONELINER)
                (WHEN (OR TOKEN)
                  (LIST "?"
                        (IF TOKEN
                            (CONCATENATE 'STRING (SYMBOL-NAME 'TOKEN) "="
                                         (FORMAT NIL "~a" TOKEN))
                            ""))))))
    (IF LAZYBONES-CLIENT.SHARED:*BODY*
        (DEXADOR:PATCH LAZYBONES-CLIENT.SHARED::REQ-STRING :CONTENT
         LAZYBONES-CLIENT.SHARED:*BODY* :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)
        (DEXADOR:PATCH LAZYBONES-CLIENT.SHARED::REQ-STRING :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)))) 


(DEFUN PATCH--LOCK-ONELINER (ONELINER &KEY TOKEN)
  "Locks a oneliner. Locked oneliners cannot be edited or flagged."
  (LET ((LAZYBONES-CLIENT.SHARED::REQ-STRING
         (APPLY #'CONCATENATE 'STRING LAZYBONES-CLIENT.SHARED:*HOST*
                (FORMAT NIL "/lock/~a" ONELINER)
                (WHEN (OR TOKEN)
                  (LIST "?"
                        (IF TOKEN
                            (CONCATENATE 'STRING (SYMBOL-NAME 'TOKEN) "="
                                         (FORMAT NIL "~a" TOKEN))
                            ""))))))
    (IF LAZYBONES-CLIENT.SHARED:*BODY*
        (DEXADOR:PATCH LAZYBONES-CLIENT.SHARED::REQ-STRING :CONTENT
         LAZYBONES-CLIENT.SHARED:*BODY* :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)
        (DEXADOR:PATCH LAZYBONES-CLIENT.SHARED::REQ-STRING :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)))) 


(DEFUN POST--ADD-ONELINER (&KEY TOKEN)
  "Make a new [oneliner](#oneliner)."
  (LET ((LAZYBONES-CLIENT.SHARED::REQ-STRING
         (APPLY #'CONCATENATE 'STRING LAZYBONES-CLIENT.SHARED:*HOST*
                (FORMAT NIL "/add-oneliner")
                (WHEN (OR TOKEN)
                  (LIST "?"
                        (IF TOKEN
                            (CONCATENATE 'STRING (SYMBOL-NAME 'TOKEN) "="
                                         (FORMAT NIL "~a" TOKEN))
                            ""))))))
    (IF LAZYBONES-CLIENT.SHARED:*BODY*
        (DEXADOR:POST LAZYBONES-CLIENT.SHARED::REQ-STRING :CONTENT
         LAZYBONES-CLIENT.SHARED:*BODY* :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)
        (DEXADOR:POST LAZYBONES-CLIENT.SHARED::REQ-STRING :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)))) 


(DEFUN POST--MAKE-INVITE (&KEY TOKEN)
  "On success, return an object containing a new [invite token](#invite-token)."
  (LET ((LAZYBONES-CLIENT.SHARED::REQ-STRING
         (APPLY #'CONCATENATE 'STRING LAZYBONES-CLIENT.SHARED:*HOST*
                (FORMAT NIL "/make-invite")
                (WHEN (OR TOKEN)
                  (LIST "?"
                        (IF TOKEN
                            (CONCATENATE 'STRING (SYMBOL-NAME 'TOKEN) "="
                                         (FORMAT NIL "~a" TOKEN))
                            ""))))))
    (IF LAZYBONES-CLIENT.SHARED:*BODY*
        (DEXADOR:POST LAZYBONES-CLIENT.SHARED::REQ-STRING :CONTENT
         LAZYBONES-CLIENT.SHARED:*BODY* :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)
        (DEXADOR:POST LAZYBONES-CLIENT.SHARED::REQ-STRING :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)))) 


(DEFUN POST--REVOKE-CONTRIBUTOR (CONTRIBUTOR &KEY TOKEN)
  "A contributor can revoke their own access (if for some reason their
  API key ends up out of their control), or an admin can revoke
  anybody's access token, forcing the  to re-authenticate."
  (LET ((LAZYBONES-CLIENT.SHARED::REQ-STRING
         (APPLY #'CONCATENATE 'STRING LAZYBONES-CLIENT.SHARED:*HOST*
                (FORMAT NIL "/revoke/~a" CONTRIBUTOR)
                (WHEN (OR TOKEN)
                  (LIST "?"
                        (IF TOKEN
                            (CONCATENATE 'STRING (SYMBOL-NAME 'TOKEN) "="
                                         (FORMAT NIL "~a" TOKEN))
                            ""))))))
    (IF LAZYBONES-CLIENT.SHARED:*BODY*
        (DEXADOR:POST LAZYBONES-CLIENT.SHARED::REQ-STRING :CONTENT
         LAZYBONES-CLIENT.SHARED:*BODY* :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)
        (DEXADOR:POST LAZYBONES-CLIENT.SHARED::REQ-STRING :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)))) 


(DEFUN POST--TOKEN-CONTRIBUTOR (CONTRIBUTOR &KEY PASSWORD)
  "Authenticate a contributor and reply with an [api token](#access-token)"
  (LET ((LAZYBONES-CLIENT.SHARED::REQ-STRING
         (APPLY #'CONCATENATE 'STRING LAZYBONES-CLIENT.SHARED:*HOST*
                (FORMAT NIL "/token/~a" CONTRIBUTOR)
                (WHEN (OR PASSWORD)
                  (LIST "?"
                        (IF PASSWORD
                            (CONCATENATE 'STRING (SYMBOL-NAME 'PASSWORD) "="
                                         (FORMAT NIL "~a" PASSWORD))
                            ""))))))
    (IF LAZYBONES-CLIENT.SHARED:*BODY*
        (DEXADOR:POST LAZYBONES-CLIENT.SHARED::REQ-STRING :CONTENT
         LAZYBONES-CLIENT.SHARED:*BODY* :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)
        (DEXADOR:POST LAZYBONES-CLIENT.SHARED::REQ-STRING :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)))) 


(DEFUN POST--REDEEM-INVITE (INVITE &KEY USERNAME PASSWORD1 PASSWORD2)
  "Redeem an [invite code](#invite-code) and create a new [contributor](#new-contributor-post-body)"
  (LET ((LAZYBONES-CLIENT.SHARED::REQ-STRING
         (APPLY #'CONCATENATE 'STRING LAZYBONES-CLIENT.SHARED:*HOST*
                (FORMAT NIL "/redeem/~a" INVITE)
                (WHEN (OR USERNAME PASSWORD1 PASSWORD2)
                  (LIST "?"
                        (IF USERNAME
                            (CONCATENATE 'STRING (SYMBOL-NAME 'USERNAME) "="
                                         (FORMAT NIL "~a" USERNAME))
                            "")
                        (IF PASSWORD1
                            (CONCATENATE 'STRING "&" (SYMBOL-NAME 'PASSWORD1)
                                         "=" (FORMAT NIL "~a" PASSWORD1))
                            "")
                        (IF PASSWORD2
                            (CONCATENATE 'STRING "&" (SYMBOL-NAME 'PASSWORD2)
                                         "=" (FORMAT NIL "~a" PASSWORD2))
                            ""))))))
    (IF LAZYBONES-CLIENT.SHARED:*BODY*
        (DEXADOR:POST LAZYBONES-CLIENT.SHARED::REQ-STRING :CONTENT
         LAZYBONES-CLIENT.SHARED:*BODY* :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*)
        (DEXADOR:POST LAZYBONES-CLIENT.SHARED::REQ-STRING :COOKIE-JAR
         LAZYBONES-CLIENT.SHARED:*COOKIES* :HEADERS
         LAZYBONES-CLIENT.SHARED:*HEADERS*))))