Class: Stripe::StripeClient
- Inherits:
-
Object
- Object
- Stripe::StripeClient
- Extended by:
- Gem::Deprecate
- Defined in:
- lib/stripe/stripe_client.rb
Instance Attribute Summary collapse
-
#v1 ⇒ Object
readonly
attr_readers: The beginning of the section generated from our OpenAPI spec.
-
#v2 ⇒ Object
readonly
Returns the value of attribute v2.
Instance Method Summary collapse
- #deserialize(data, api_mode: :v1) ⇒ Object
-
#initialize(api_key, stripe_account: nil, stripe_context: nil, stripe_version: nil, api_base: nil, uploads_base: nil, connect_base: nil, meter_events_base: nil, client_id: nil) ⇒ StripeClient
constructor
Initializes a new StripeClient.
- #parse_thin_event(payload, sig_header, secret, tolerance: Webhook::DEFAULT_TOLERANCE) ⇒ Object
- #raw_request(method, url, base_address: :api, params: {}, opts: {}) ⇒ Object
- #request(&block) ⇒ Object
Constructor Details
#initialize(api_key, stripe_account: nil, stripe_context: nil, stripe_version: nil, api_base: nil, uploads_base: nil, connect_base: nil, meter_events_base: nil, client_id: nil) ⇒ StripeClient
Initializes a new StripeClient
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/stripe/stripe_client.rb', line 14 def initialize(api_key, # rubocop:todo Metrics/ParameterLists stripe_account: nil, stripe_context: nil, stripe_version: nil, api_base: nil, uploads_base: nil, connect_base: nil, meter_events_base: nil, client_id: nil) unless api_key raise AuthenticationError, "No API key provided. " \ 'Set your API key using "client = Stripe::StripeClient.new(<API-KEY>)". ' \ "You can generate API keys from the Stripe web interface. " \ "See https://stripe.com/api for details, or email " \ "[email protected] if you have any questions." end config_opts = { api_key: api_key, stripe_account: stripe_account, stripe_context: stripe_context, api_version: stripe_version, api_base: api_base, uploads_base: uploads_base, connect_base: connect_base, meter_events_base: meter_events_base, client_id: client_id, }.reject { |_k, v| v.nil? } @requestor = APIRequestor.new(config_opts) # top-level services: The beginning of the section generated from our OpenAPI spec @v1 = Stripe::V1Services.new(@requestor) @v2 = Stripe::V2Services.new(@requestor) # top-level services: The end of the section generated from our OpenAPI spec end |
Instance Attribute Details
#v1 ⇒ Object (readonly)
attr_readers: The beginning of the section generated from our OpenAPI spec
8 9 10 |
# File 'lib/stripe/stripe_client.rb', line 8 def v1 @v1 end |
#v2 ⇒ Object (readonly)
Returns the value of attribute v2.
9 10 11 |
# File 'lib/stripe/stripe_client.rb', line 9 def v2 @v2 end |
Instance Method Details
#deserialize(data, api_mode: :v1) ⇒ Object
77 78 79 80 |
# File 'lib/stripe/stripe_client.rb', line 77 def deserialize(data, api_mode: :v1) data = JSON.parse(data) if data.is_a?(String) Util.convert_to_stripe_object(data, {}, api_mode: api_mode, requestor: @requestor) end |
#parse_thin_event(payload, sig_header, secret, tolerance: Webhook::DEFAULT_TOLERANCE) ⇒ Object
57 58 59 60 61 62 63 64 65 66 |
# File 'lib/stripe/stripe_client.rb', line 57 def parse_thin_event(payload, sig_header, secret, tolerance: Webhook::DEFAULT_TOLERANCE) payload = payload.force_encoding("UTF-8") if payload.respond_to?(:force_encoding) # v2 events use the same signing mechanism as v1 events Webhook::Signature.verify_header(payload, sig_header, secret, tolerance: tolerance) parsed = JSON.parse(payload, symbolize_names: true) Stripe::ThinEvent.new(parsed) end |
#raw_request(method, url, base_address: :api, params: {}, opts: {}) ⇒ Object
68 69 70 71 72 73 74 75 |
# File 'lib/stripe/stripe_client.rb', line 68 def raw_request(method, url, base_address: :api, params: {}, opts: {}) opts = Util.normalize_opts(opts) req_opts = RequestOptions.extract_opts_from_hash(opts) resp, = @requestor.send(:execute_request_internal, method, url, base_address, params, req_opts, usage: ["raw_request"]) @requestor.interpret_response(resp) end |
#request(&block) ⇒ Object
51 52 53 |
# File 'lib/stripe/stripe_client.rb', line 51 def request(&block) @requestor.request(&block) end |