module ConsoleUtils::RequestUtils
Request Utils¶ ↑
Provides the collection of tools to make JSON API requests and get formatted output. To use system-installed jq
utility to format json, change json_formatter
option in the config.
Constants
- RequestParams
Public Instance Methods
autoken(id)
click to toggle source
autoken(:any)
Returns user's token by primary key. Use :any
to get random user.
# File lib/console_utils/request_utils.rb, line 24 def autoken(id) ConsoleUtils.auto_token_for(id) end
exap(.get|.post|.put|...)(url, user_id = nil, **params)
click to toggle source
Local API requester context. See also: ConsoleUtils::RequestUtils::Exap
Examples:¶ ↑
Appends auth token of default user to params, makes request and prints formatted response:
exap.get("api/posts.json").preview
Authorize user #42, also copy formatted response to the pasteboard:
exap.get("api/posts.json", 42).preview(&:pbcopy)
Authorize random user:
exap.get("api/comments.json", :any).preview
Use additional request params (skip the second parameter to use default user), don't print response body:
exap.put("api/account.json", 42, user: { name: "Anton" })
Skip auto-fetching user's token:
exap.post("api/signup.json", nil, user: { name: "Guest" }).preview
# File lib/console_utils/request_utils.rb, line 57 def exap Exap.new(self) end