Build response with headers

[miclain]

What was done:
Change the response format for some clients (emails, analytics and landing_pages) to include headers. Without the headers, it was not possible to get the pagination information.

[m3nd3s]

🎯 suggestion: I noticed that we've used the past form to list the changes, so I think we can rewrite this sentence to:

‏

Suggested change

	Change the response format for some clients (emails, analytics and landing_pages) to include headers.
	Changed the response format for some clients (emails, analytics, and landing pages) to include headers.

[m3nd3s]

🎯 suggestion: ‏What do you think about changing the RdStation::ApiResponse.build to accept an option argument to indicate whether is necessary to return with headers?

Something like this:

# frozen_string_literal: true

module RDStation
  module ApiResponse
    def self.build(response, options={})
      successful = response.code.between?(200, 299)
      RDStation::ErrorHandler.new(response).raise_error unless successful

      if options[:headers]
        response
      else
        JSON.parse(response.body)
      end
    end
  end
end

# usage
RDStation::ApiResponse.build(response, headers: true)

[m3nd3s]

But, let me ask something, what is returned with the response object? The original (current) build method returns a JSON and the new one returns an object "response".

I guess we're changing the API contract, don't we?

What do you think @angeliski ?