Merge pull request #52 from jleechpe/sx-request-make-update

Updated `sx-request-make` to use a consistent format for both `POST` and `GET` methods

3 files changed, 76 insertions, 44 deletions

diff --git a/sx-auth.el b/sx-auth.el
index f32e7aa..b470523 100644
--- a/sx-auth.el
+++ b/sx-auth.el
@@ -28,7 +28,7 @@
 (require 'sx-cache)
 
 (defconst sx-auth-root
-  "https://stackexchange.com/oauth/")
+  "https://stackexchange.com/oauth/dialog")
 (defconst sx-auth-redirect-uri
   "http://vermiculus.github.io/stack-mode/auth/auth.htm")
 (defconst sx-auth-client-id
@@ -50,15 +50,17 @@ questions)."
   (interactive)
   (setq
    sx-auth-access-token
-   (let ((url (sx-request-build
-               "dialog"
-               `((client_id . ,sx-auth-client-id)
-                 (scope . (read_inbox
-                           no_expiry
-                           write_access))
-                 (redirect_uri . ,(url-hexify-string
-                                   sx-auth-redirect-uri)))
-               "," sx-auth-root)))
+   (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)
diff --git a/sx-method.el b/sx-method.el
index 6f0a36b..e9c4f60 100644
--- a/sx-method.el
+++ b/sx-method.el
@@ -29,9 +29,16 @@
 (require 'sx-filter)
 
 (defun sx-method-call
-    (method &optional keyword-arguments filter silent)
+    (method &optional keyword-arguments filter need-auth use-post silent)
   "Call METHOD with KEYWORD-ARGUMENTS using FILTER.
 
+If NEED-AUTH is non-nil, an auth-token is required.  If 'WARN,
+warn the user `(user-error ...)' if they do not have an AUTH
+token set.
+
+If USE-POST is non-nil, use `POST' rather than `GET' for passing
+arguments.
+
 If SILENT is non-nil, no messages will be printed.
 
 Return the entire response as a complex alist."
@@ -41,7 +48,9 @@ Return the entire response as a complex alist."
                (sx-filter-get-var
                 (cond (filter filter)
                       ((boundp 'stack-filter) stack-filter))))
-         keyword-arguments)))
+         keyword-arguments)
+   need-auth
+   use-post))
 
 (provide 'sx-method)
 ;;; sx-method.el ends here
diff --git a/sx-request.el b/sx-request.el
index 6dc54e7..d982057 100644
--- a/sx-request.el
+++ b/sx-request.el
@@ -71,19 +71,19 @@ number of requests left every time it finishes a call.")
 ;;; Making Requests
 
 (defun sx-request-make
-    (method &optional args silent)
+    (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))
-        (call (sx-request-build
-               method
-               (cons (cons 'key sx-request-api-key)
-                     args))))
-    (unless silent (sx-message "Request: %S" call))
-    (let ((response-buffer (cond
-                            ((equal '(24 . 4) (cons emacs-major-version emacs-minor-version))
-                             (url-retrieve-synchronously call silent))
-                            (t (url-retrieve-synchronously call)))))
+        (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
@@ -120,33 +120,54 @@ number of requests left every time it finishes a call.")
 
 ;;; Support Functions
 
-(defun sx-request-build (method keyword-arguments &optional kv-value-sep root)
-  "Build the request string that will be used to process REQUEST
-with the given KEYWORD-ARGUMENTS."
-  (let ((base (concat (or root sx-request-api-root) method))
-	(args (sx-request--build-keyword-arguments
-               keyword-arguments kv-value-sep)))
-    (if (string-equal "" args)
-	base
-      (concat base "?" args))))
-
-(defun sx-request--build-keyword-arguments (alist &optional kv-value-sep)
+(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'."
-  (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))
-   "&"))
+  ;; Add API key to list of arguments, this allows for increased quota
+  ;; automatically.
+  (let* ((warn (equal need-auth 'warn))
+         (api-key (cons "key" sx-request-api-key))
+         (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)))))
+    (push api-key alist)
+    (if (and need-auth auth)
+        (push auth alist))
+    (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