Access to Response Headers

[restforce]

Access to Response Headers

[aaronbbrown]

I had this exact same problem and used a Middleware to solve it:

module Thing
  module Middleware
    class APIUsage < Faraday::Response::Middleware
      def initialize(app, options = {})
        @app = app
        @options = options
      end

      def call(env)
        ap api_usage(env[:response_headers])
        @app.call(env)
      end

      def api_usage(response)
        return nil unless response['sforce-limit-info']
        matches = response['sforce-limit-info'].match(%r{api-usage=(?<used>\d+)/(?<max>\d+)})
        { used: matches['used'].to_i, max: matches['max'].to_i } if matches
      end
    end
  end
end

# ...

Faraday::Response.register_middleware :api_usage => lambda { Thing::Middleware::APIUsage }
client = Restforce.new
client.middleware.response :api_usage

I'm open to suggetions on how to improve this.

[ejholmes]

I think a configuration option that determines whether or not the client
should return the full faraday response or just the body would make sense.

On Friday, October 4, 2013, Anton Litvinenko wrote:

Salesforce returns API usage rate in Sforce-Limit-Info header:
api-usage=49/5000000.

I would like to have access to that information. Is it possible with
current implementation? If not, any ideas how this could be implemented in
a most reasonable way?

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/88
.

[antonlitvinenko]

That would have effect on all requests. Which means that I would need to process the whole response manually. Couple of other ideas:

1. to have some sort of back reference to original response or only its headers in Restforce::Collection or Restforce::Mash objects
2. Another idea is to have an attribute on the client (e.g. api_rates) that would be updated with each response through middleware (I noticed that Restforce::Middleware has a proxy back to a client)

Wouldn't one of these work better?