stripe 13.0.0 → 13.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93281cf4747b2cf59d647ef17cbe034031435578c8729c0bf06eab21cfc04c37
-  data.tar.gz: a4e618140b391965e3a8deae7055416435a3cfccd3eaabd8b415d27e38beb4f9
+  metadata.gz: 8703e26f6493e135c48ab421eb1c197c297e287d1fb89870e949a6267baabc6a
+  data.tar.gz: 7a423d816ee6b63331e5c54c2c4ea7f236ae1e1af5b7dedbb151530360ae4830
 SHA512:
-  metadata.gz: 1099c298d6ff0fc5ed0db7064679d88c3fe5a48eafa9575a9220404f8d42d3a06b85f61228446c11fce3f06556fa1049f82f78dfd1bd2b0ae25c4e9bd9e73679
-  data.tar.gz: c9f18b4b29441bae95f73d20787c4fa24f0534a38721e2bf4192956ef7f6ee95ad9f5e83235dba538065e31ea76bdf5fe7340faa7e079b54fe4d7a360a567d42
+  metadata.gz: b6d1aa02657c0e6b5a866797f696271e8e26aadf66a05a92fef3e1e814498d3ea540718377d54409f535071af206061acaaa2457052b26a1cee44c4b822ad226
+  data.tar.gz: 632f4d3fa56137d1878351cd9892794110723e5289df308fbc0b3e662e0f53279e75836f7237e209c50860424cd3a3e7fcdb633f6375fa4f13cd4b682235af2f

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 # Changelog
+## 13.0.1 - 2024-10-18
+* [#1471](https://github.com/stripe/stripe-ruby/pull/1471) update object tags for meter-related classes
+  
+  - fixes a bug where the `object` property of the `MeterEvent`, `MeterEventAdjustment`, and `MeterEventSession` didn't match the server.
+* [#1470](https://github.com/stripe/stripe-ruby/pull/1470) Cleaned up examples and added documentation
+
 ## 13.0.0 - 2024-10-01
 * [#1458](https://github.com/stripe/stripe-ruby/pull/1458) Support for APIs in the new API version 2024-09-30.acacia
   

data/VERSION

@@ -1 +1 @@
-13.0.0
+13.0.1

data/examples/README.md

@@ -3,9 +3,14 @@
 From the examples folder, run:
 `RUBYLIB=../lib ruby your_example.rb`
 
+e.g.
+
+`RUBYLIB=../lib ruby thinevent_webhook_handler.rb`
+
 ## Adding a new example
 
 1. Clone new_example.rb
 2. Implement your example
-3. Run it (as per above)
-4. 👍
+3. Fill out the file comment. Include a description and key steps that are being demonstrated.
+4. Run it (as per above)
+5. 👍

data/examples/example_template.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# example_template.py - This is a template for defining new examples.  It is not intended to be used directly.
+#
+# <describe what this example does>
+#
+# In this example, we:
+#   - <key step 1>
+#   - <key step 2
+#   - ...
+#
+# <describe assumptions about the user's stripe account, environment, or configuration;
+# or things to watch out for when running>
+
+require "stripe"
+require "date"
+
+class ExampleTemplate
+  attr_accessor :api_key
+
+  def initialize(api_key)
+    @api_key = api_key
+  end
+
+  def do_something_great
+    puts "Hello World"
+    # client = Stripe::StripeClient.new(api_key)
+    # client.v1
+  end
+end
+
+# Send meter events
+api_key = "{{API_KEY}}"
+
+example = ExampleTemplate.new(api_key)
+example.do_something_great

data/examples/meter_event_stream.rb

@@ -1,5 +1,15 @@
 # frozen_string_literal: true
 
+# meter_event_stream.py - use the high-throughput meter event stream to report create billing meter events.
+#
+# In this example, we:
+#   - create a meter event session and store the session's authentication token
+#   - define an event with a payload
+#   - use the meter_event_stream service accessor in StripeClient to create an event stream that reports this event
+#
+# This example expects a billing meter with an event_name of 'alpaca_ai_tokens'.  If you have
+# a different meter event name, you can change it before running this example.
+
 require "stripe"
 require "date"
 

data/examples/{stripe_webhook_handler.rb → thinevent_webhook_handler.rb}

@@ -1,6 +1,17 @@
 # frozen_string_literal: true
 # typed: false
 
+# thinevent_webhook_handler.rb - receive and process thin events like the
+# v1.billing.meter.error_report_triggered event.
+#
+# In this example, we:
+#     - create a StripeClient called client
+#     - use client.parse_thin_event to parse the received thin event webhook body
+#     - call client.v2.core.events.retrieve to retrieve the full event object
+#     - if it is a V1BillingMeterErrorReportTriggeredEvent event type, call
+#       event.fetchRelatedObject to retrieve the Billing Meter object associated
+#       with the event.
+
 require "stripe"
 require "sinatra"
 

data/lib/stripe/resources/v2/billing/meter_event.rb

@@ -6,9 +6,9 @@ module Stripe
     module Billing
       # Fix me empty_doc_string.
       class MeterEvent < APIResource
-        OBJECT_NAME = "billing.meter_event"
+        OBJECT_NAME = "v2.billing.meter_event"
         def self.object_name
-          "billing.meter_event"
+          "v2.billing.meter_event"
         end
       end
     end

data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb

@@ -5,9 +5,9 @@ module Stripe
   module V2
     module Billing
       class MeterEventAdjustment < APIResource
-        OBJECT_NAME = "billing.meter_event_adjustment"
+        OBJECT_NAME = "v2.billing.meter_event_adjustment"
         def self.object_name
-          "billing.meter_event_adjustment"
+          "v2.billing.meter_event_adjustment"
         end
       end
     end

data/lib/stripe/resources/v2/billing/meter_event_session.rb

@@ -5,9 +5,9 @@ module Stripe
   module V2
     module Billing
       class MeterEventSession < APIResource
-        OBJECT_NAME = "billing.meter_event_session"
+        OBJECT_NAME = "v2.billing.meter_event_session"
         def self.object_name
-          "billing.meter_event_session"
+          "v2.billing.meter_event_session"
         end
       end
     end

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "13.0.0"
+  VERSION = "13.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 13.0.0
+  version: 13.0.1
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-01 00:00:00.000000000 Z
+date: 2024-10-18 00:00:00.000000000 Z
 dependencies: []
 description: Stripe is the easiest way to accept payments online.  See https://stripe.com
   for details.
@@ -30,9 +30,9 @@ files:
 - Rakefile
 - VERSION
 - examples/README.md
+- examples/example_template.rb
 - examples/meter_event_stream.rb
-- examples/new_example.rb
-- examples/stripe_webhook_handler.rb
+- examples/thinevent_webhook_handler.rb
 - exe/stripe-console
 - lib/data/ca-certificates.crt
 - lib/stripe.rb

data/examples/new_example.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require "stripe"
-require "date"
-
-class NewExample
-  attr_accessor :api_key
-
-  def initialize(api_key)
-    @api_key = api_key
-  end
-
-  def do_something_great
-    puts "Hello World"
-    # client = Stripe::StripeClient.new(api_key)
-    # client.v1
-  end
-end
-
-# Send meter events
-api_key = "{{API_KEY}}"
-
-example = NewExample.new(api_key)
-example.do_something_great