mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-10-04 00:00:47 -04:00
863da48398
Adds the magic `frozen_string_literal: true` comment to every file and enables a Rubocop rule to make sure that it's always going to be there going forward as well. See here for more background [1], but the basic idea is that unlike many other languages, static strings in code are mutable by default. This has since been acknowledged as not a particularly good idea, and the intention is to rectify the mistake when Ruby 3 comes out, where all string literals will be frozen. The `frozen_string_literal` magic comment was introduced in Ruby 2.3 as a way of easing the transition, and allows libraries and projects to freeze their literals in advance. I don't think this is breaking in any way: it's possible that users might've been pulling out one of are literals somehow and mutating it, but that would probably not have been useful for anything and would certainly not be recommended, so I'm quite comfortable pushing this change through as a minor version. As discussed in #641. [1] https://stackoverflow.com/a/37799399
51 lines
1.6 KiB
Ruby
51 lines
1.6 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Stripe
|
|
# StripeResponse encapsulates some vitals of a response that came back from
|
|
# the Stripe API.
|
|
class StripeResponse
|
|
# The data contained by the HTTP body of the response deserialized from
|
|
# JSON.
|
|
attr_accessor :data
|
|
|
|
# The raw HTTP body of the response.
|
|
attr_accessor :http_body
|
|
|
|
# A Hash of the HTTP headers of the response.
|
|
attr_accessor :http_headers
|
|
|
|
# The integer HTTP status code of the response.
|
|
attr_accessor :http_status
|
|
|
|
# The Stripe request ID of the response.
|
|
attr_accessor :request_id
|
|
|
|
# Initializes a StripeResponse object from a Hash like the kind returned as
|
|
# part of a Faraday exception.
|
|
#
|
|
# This may throw JSON::ParserError if the response body is not valid JSON.
|
|
def self.from_faraday_hash(http_resp)
|
|
resp = StripeResponse.new
|
|
resp.data = JSON.parse(http_resp[:body], symbolize_names: true)
|
|
resp.http_body = http_resp[:body]
|
|
resp.http_headers = http_resp[:headers]
|
|
resp.http_status = http_resp[:status]
|
|
resp.request_id = http_resp[:headers]["Request-Id"]
|
|
resp
|
|
end
|
|
|
|
# Initializes a StripeResponse object from a Faraday HTTP response object.
|
|
#
|
|
# This may throw JSON::ParserError if the response body is not valid JSON.
|
|
def self.from_faraday_response(http_resp)
|
|
resp = StripeResponse.new
|
|
resp.data = JSON.parse(http_resp.body, symbolize_names: true)
|
|
resp.http_body = http_resp.body
|
|
resp.http_headers = http_resp.headers
|
|
resp.http_status = http_resp.status
|
|
resp.request_id = http_resp.headers["Request-Id"]
|
|
resp
|
|
end
|
|
end
|
|
end
|