Make Web API response headers accessible

Open
#378 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
ruby
Domain
api

Research direction

Start with lib/slack/web/faraday/request.rb at the linked return statement, then read the issue discussion about exposing successful-response headers. A complete change would make headers accessible without polluting the response body, but the issue does not settle the API shape or name tests to run.

Written by the indexing model from the issue text.

Description

new feature

The response headers in Slack's Web API contain information that is sometimes useful. For example x-oauth-scopes is a list of scopes that the token has. This is the only way (that I know of) to check the scopes on an existing token through the API. My use case is I'd like to be able to use auth.test to check the scopes on a token via x-oauth-scopes.

The current implementation doesn't give a way to access the response headers on a successful request, since it returns only the body:
https://github.com/slack-ruby/slack-ruby-client/blob/ebf98319cf9d89ad4e75dbca0ae8ecf94a855aa3/lib/slack/web/faraday/request.rb#L36

The headers are accessible on the error object raised on failed requests since the entire response object is on the error:

slack_error.response.headers

I'm trying to think how we could make the headers accessible on successful responses. Some bad ideas:

  1. Shove them into the body object under the key response_headers. This object is then wrapped in Slack::Messages::Message and returned. I don't like this because it pollutes the body.
  2. An option that can be passed to any request (possibly also set on a client) that causes it to return something different:
    1. The entire raw response object, giving access to the body as well as the headers (and much else).
    2. [body, response_headers]
    3. etc.
Dominant language
Ruby
Stars
1.3k
Forks
222
Avg merge
1d 14h
Merged PRs (30d)
3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from slack-ruby/slack-ruby-client

All issues in slack-ruby/slack-ruby-client

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.