Issues and pull requests from archived upstream repository

[tarsius]

@pashky, the original author of restclient has archived his repository https://github.com/pashky/restclient.el. He has not requested that the package be removed from Melpa, other packages exist that depend on this package, and this package seem quite popular (300'000 downloads on Melpa) -- making it undesirable to just remove this from Melpa.

Unfortunately he did not respond to our requests to transfer his package to a new maintainer (whether that be an individual or this organization). It does not look like that is going to change, so we are forking, as discussed at melpa/melpa#9004.

One disadvantage of using a fork is that topic references such as #1 are now ambiguous, so please use either pashky/restclient.el#1 or emacsorphanage/restclient#1. Unfortunately there's also the risk that the original author eventually deletes his repository, which would cause all old topics to become permanently inaccessible.

Because the upstream repository has been archived, it is no longer possible to discuss the old topics there. For some old topics it may be sufficient to tick their check box once they have been resolved. For other topics it might be enough to post one or two comments to this tracker issue. For topics that require further discussion, you might have to create a new issue or pull-request within this repository.

Unresolved pull request

• WebDAV: Add PROPFIND as an accepted HTTP method (fixes #300). pashky/restclient.el#301 - merged
• Translate readme to spanish pashky/restclient.el#265 - wontfix, will become outdated immediately
• fix: requests can be indented ( by spaces or tabs) pashky/restclient.el#251 - merged
• Fix typos and remove trailing whitespace pashky/restclient.el#250 - superseded
• Allow file reading in the middle of request body pashky/restclient.el#245 - merged
• Replace variables in file paths pashky/restclient.el#213 - superseded by Allow file reading in the middle of request body pashky/restclient.el#245
• Add Homepage pashky/restclient.el#211 - rejected, proposed link no longer correct
• Fix unbalanced parens in Readme pashky/restclient.el#185 - superseded
• Typos: spelling, missing closing paren pashky/restclient.el#175 - superseded
• Add imenu support pashky/restclient.el#87 - reimplemented

Unresolved issues

• HTTP/2 support pashky/restclient.el#302 - wontfix, not supported by url.el
• [FR] WebDAV: Add PROPFIND HTTP method pashky/restclient.el#300 - merged
• Variables set via hooks (jq-set-var) always override variables set in a file pashky/restclient.el#299 - wontfix, works as intended
• Support streaming response? pashky/restclient.el#298 - wontfix, not supported by url.el
• POSTing files not working as an upload pashky/restclient.el#297 - should have been closed in pashky
• GET being sent with a body pashky/restclient.el#296 - implemented
• Feature request: support for server sent events pashky/restclient.el#292 - wontfix, not supported by url.el
• Prismjs syntax highlighter for this mode pashky/restclient.el#291 - added to wiki
• Feature request: convert a multi-line curl command to request block inplace pashky/restclient.el#290
• Load Variables from a Different File pashky/restclient.el#289 - implemented
• Feature request: generate curl command with quotes instead of backslashes pashky/restclient.el#288 - implemented
• Set variable from response header pashky/restclient.el#284 - implemented
• Unknown restclient hook type jq-set-var With Latest Version pashky/restclient.el#282 - should have been closed in pashky
• Binary at start of cached response from ASP.NET server pashky/restclient.el#280
• How do you set multiple variables? pashky/restclient.el#276 - implemented
• Feature request: save body of GET result to file pashky/restclient.el#275 - implemented
• error in process sentinel: peculiar error: "connect", :host, "identity.xero.com", :service, 443 pashky/restclient.el#272
• Is it possible to define variales for different environments pashky/restclient.el#271 - implemented
• Attaching binary files to requests doesn't work pashky/restclient.el#269 - worksforme/wontfix, see comment below.
• [Question] Pass jenkins token pashky/restclient.el#264 - should have been closed in pashky
• Emacs >= 26.2 required for restclient-jq pashky/restclient.el#259 - fixed
• restclient-jq missing on MELPA pashky/restclient.el#257 - should have been closed in pashky
• [enhancement] Introduce timeout options pashky/restclient.el#256
• restclient-mark-current not mark the whole query pashky/restclient.el#253 - fixed in pashky
• Cannot turn off request logging pashky/restclient.el#252 - fixed in pashky
• Does not parse cookie fields always correclty! pashky/restclient.el#249 - fixed in pashky
• Many requests to the same endpoint pashky/restclient.el#247 - answered below
• Running these in CICD pashky/restclient.el#246 - check out https://github.com/simenheg/restclient-test.el
• and: Symbol’s function definition is void: lexical-let pashky/restclient.el#244 - fixed in pashky
• Emacs 27 install warning pashky/restclient.el#243 - fixed in pashky
• Extract all contents from a file pashky/restclient.el#233 - fixed, if I understood the request correctly
• Ignoring headers for redirection pashky/restclient.el#231 - added redirect chain log and comments about url-max-redirections
• restclient-http-do direct call fail? pashky/restclient.el#229 - not supported usecase (needs three more arguments, nil will do.)
• Convert Postman snippet to Restclient pashky/restclient.el#228 - should have been closed in pashky
• Narrowing and variables do not send full request  pashky/restclient.el#227 - should have been closed in pashky
• Escaping seems to lead to incorrect syntax pashky/restclient.el#226 - fixed in pashky
• Is it possible to execute two consecutive (synchronous) requests and pass params? pashky/restclient.el#224 - should have been closed in pashky
• AWS auth pashky/restclient.el#223
• buffer-disable-undo for response buffer pashky/restclient.el#222 - wontfix, works as designed
• restclient-mode on remote hosts (Tramp) pashky/restclient.el#221
• Request syntax highlighting? pashky/restclient.el#220 - should have been closed in pashky
• How not url encode query params? pashky/restclient.el#219 - fixed in pashky
• Hash in variable value pashky/restclient.el#217 - fixed in pashky
• Headers of requests are bleeding into other plugins pashky/restclient.el#214 - fixed in pashky
• GET https://api.github.com returns "error in process sentinel: peculiar error" pashky/restclient.el#212 - emacs bug 34341
• Is this a correct way to pass arrays in body request? pashky/restclient.el#207 - answer: "no". One can test for oneself with http://httpbin.org/post
• async for API request pashky/restclient.el#206 - should have been closed in pashky
• error in process filter: Invalid coding system: utf8 pashky/restclient.el#205 - can't reproduce
• User-Agent header is required pashky/restclient.el#202 - implemented
• Gzip plain text problem pashky/restclient.el#201 - should have been closed in pashky
• line for url parameters? pashky/restclient.el#199 - implemented
• Output result in view mode? pashky/restclient.el#197 - implemented
• Mangled output when making requests to .net core web apis pashky/restclient.el#195
• Add support for certs, keys and cacert.  pashky/restclient.el#194 - should have been closed in pashky
• Should restclient.el trim trailing space on urls? pashky/restclient.el#193 - fixed in pashky
• [[feature]] Add the Ability to Run Elisp Code Based Off of Request Response pashky/restclient.el#191 - fixed in pashky
• not working with local custom domains pashky/restclient.el#190 - can't reproduce
• Command to inspect and clear cookies pashky/restclient.el#189 - should have been closed in pashky
• Multipart POST pashky/restclient.el#187 - see [bug?] "Did not find CR at end of boundary" #4
• Theme pashky/restclient.el#186 - should have been closed in pashky
• Hide Authentication credentials with a prompt hook pashky/restclient.el#184 - nothing to fix
• Download file. How specify where to download file? pashky/restclient.el#172 - fixed by fix for Feature request: save body of GET result to file pashky/restclient.el#275
• Get content from file for HTTP request body. pashky/restclient.el#171 - should have been closed in pashky
• How see result HTTP request? pashky/restclient.el#170 - wontfix, not supported by url.el
• json {} display as null pashky/restclient.el#169 - worksforme, fixed in pashky or emacs
• basic auth pashky/restclient.el#167 - see comment below
• improve docs pashky/restclient.el#166 - should have been closed in pashky
• Consider hiding message in the echo area when the request completes pashky/restclient.el#165 - implemented
• Can I insert dynamic content (e.g. current date) in post request? pashky/restclient.el#164 - should have been closed in pashky
• add option to display response headers, status_code pashky/restclient.el#163 - fixed in pashky
• How create POST request in Submit form with parameters? pashky/restclient.el#162 - should have been closed in pashky
• Integrate json-navigator pashky/restclient.el#155 - fixed
• Can not set Host: header for requests? pashky/restclient.el#154 - wontfix, not supported by url.el
• How can I use restclient with Kerberos authentication? pashky/restclient.el#153
• Bind response to a variable? pashky/restclient.el#149 - fixed in pashky
• Transform api call to function pashky/restclient.el#148 - should have been closed in pashky
• Server being weird manifests as "C stack overflow" pashky/restclient.el#146 - can't reproduce
• multipart/form-data support (request) pashky/restclient.el#145 - fixed, examples added
• Question: json response without request info in comments to ease parsing pashky/restclient.el#141 - fixed in pashky
• Disable 302 redirect pashky/restclient.el#139 - fixed
• file upload not stripping new lines pashky/restclient.el#136 - should work now, file upload has been reworked.
• not recognizing IPv6 addresses? pashky/restclient.el#131 - should have been closed in pashky
• Warning (bytecomp): assignment to free variable ‘success' pashky/restclient.el#129 - should have been closed in pashky
• Make restclient available on stable.melpa.org pashky/restclient.el#127 - should have been closed in pashky
• Performing a multipart file upload pashky/restclient.el#125 - see examples/httpbin
• websocket client pashky/restclient.el#111 - should have been closed in pashky
• Feature request: Customizing content-type -> emacs mode mapping + hooks for formatting pashky/restclient.el#103 - fixed in pashky
• peculiar error on POST with no description pashky/restclient.el#95 - fixed
• Log requests and responses in a buffer like magit does. pashky/restclient.el#93
• Integrate some type of narrow-to-region to edit json post bodies automatically pashky/restclient.el#85
• A suggestion about documentation pashky/restclient.el#82
• 302 redirects pashky/restclient.el#77 - fixed
• POST to https endpoint fails? pashky/restclient.el#74 - should have been closed in pashky
• Usage of json mode instead of js-mode? pashky/restclient.el#64 - response buffer mode is customizable. For Emacs 29 and above I recommend json-ts-mode
• Feature request: add option to capture fields of responses as variables pashky/restclient.el#50 - should have been closed in pashky

[pederkl]

pashky#231

Restclient uses the Emacs library url.el to fetch urls. url.el has its own set of customizations. For redirects, they will automatically be followed up to url-max-redirections times (default 30). If you set this to 0, redirects will not be followed, and you can see the Location-header.

For simplicity, as of today restclient.el will automatically print a quasi-header Redirect for each redirection it follows, with the location of each redirect, so we can see the chain. Unfortunately, the status code of each redirect is dropped by url.el, so can't be included in this trace.

[pederkl]

pashky#229

I don't think calling restclient-http-do programmatically is the intended use case, so the calling convention is odd, specialized for the internal use in restclient. However, this is Emacs, so nobody's stopping you.

restclient-http-do sets up a call to url-retrieve, specifying restclient-http-handle-response as the callback function. The issue in this case is that the callback function restclient-http-handle-response needs three flags (raw, stay-in-window and suppress-response-buffer) that you didn't provide in your call.

They are easy to miss, as they are simply collected in the &rest argument to restclient-http-do, but they are not optional. They are passed as &rest because none of the previous methods in the normal call chain from restclient-http-send-current care about the details of them.

Simply adding three nils to the call to restclient-http-do makes it complete successfully:

(restclient-http-do
 "POST"
 "https://httpbin.org/post"
 '(("Content-Type" . "application/json"))
 "{\"username\":\"AAAA\":\"password\":\"BBBB\"}"
 nil nil nil)

[pederkl]

pashky#247

Straightforward use of variables. Define your target url in a variable, and POST to it repeatedly. You can reuse any necessary headers by sticking them in a variable too:

# My definitions
:target = https://httpbin.org/post
:common-headers = <<
Authorization: asdfasfd
Content-Type: application/json
User-Agent: SomeApp/1.0
# 

# Query 1
POST :target
:common-headers
{"body": 1}

# Query 2
POST :target
:common-headers
{"body": 2}

[pederkl]

pashky#167

While elisp can't access restclient variables as symbols, elisp can call (restclient-get-var ":my-var"). The example from pashky#15 linked to pashky#167 becomes

:user = username-could-be-very-long
:pass = password-may-also-be-very-long-with-all-kinds-of-weird-characters
:auth_basic := (base64-encode-string (format "%s:%s" (restclient-get-var ":user") (restclient-get-var ":pass")) t)

Authentication: Basic :auth_basic

[pederkl]

pashky#269

Sending gzipped files from restclient.el just works for me. Copying to a curl command does not support Curl's "@file/ref"-syntax, restclient has already expanded the file contents at that point. Using --data-binary or similar instead of --data is possible, but I'm not sure it's worth it. It would have to be made configurable to support existing use cases. I'm open to PR's if anyone sees it as a pressing need.