stripe 13.4.1 → 17.0.1

data/examples/meter_event_stream.rb

@@ -1,57 +0,0 @@
-# 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"
-
-class MeterEventManager
-  attr_accessor :api_key, :meter_event_session
-
-  def initialize(api_key)
-    @api_key = api_key
-    @meter_event_session = nil
-  end
-
-  def refresh_meter_event_session
-    return unless @meter_event_session.nil? || DateTime.parse(@meter_event_session.expires_at) <= DateTime.now
-
-    # Create a new meter event session in case the existing session expired
-    client = Stripe::StripeClient.new(api_key)
-    @meter_event_session = client.v2.billing.meter_event_session.create
-  end
-
-  def send_meter_event(meter_event)
-    # Refresh the meter event session if necessary
-    refresh_meter_event_session
-
-    # Create a meter event with the current session's authentication token
-    client = Stripe::StripeClient.new(meter_event_session.authentication_token)
-    client.v2.billing.meter_event_stream.create(
-      events: [meter_event]
-    )
-  end
-end
-
-# Send meter events
-api_key = "{{API_KEY}}"
-customer_id = "{{CUSTOMER_ID}}"
-
-manager = MeterEventManager.new(api_key)
-manager.send_meter_event(
-  {
-    event_name: "alpaca_ai_tokens",
-    payload: {
-      "stripe_customer_id" => customer_id,
-      "value" => "25",
-    },
-  }
-)

data/examples/thinevent_webhook_handler.rb

@@ -1,39 +0,0 @@
-# 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"
-
-api_key = ENV.fetch("STRIPE_API_KEY", nil)
-# Retrieve the webhook secret from the environment variable
-webhook_secret = ENV.fetch("WEBHOOK_SECRET", nil)
-
-client = Stripe::StripeClient.new(api_key)
-
-post "/webhook" do
-  webhook_body = request.body.read
-  sig_header = request.env["HTTP_STRIPE_SIGNATURE"]
-  thin_event = client.parse_thin_event(webhook_body, sig_header, webhook_secret)
-
-  # Fetch the event data to understand the failure
-  event = client.v2.core.events.retrieve(thin_event.id)
-  if event.instance_of? Stripe::V1BillingMeterErrorReportTriggeredEvent
-    meter = event.fetch_related_object
-    meter_id = meter.id
-    puts "Success!", meter_id
-  end
-
-  # Record the failures and alert your team
-  status 200
-end

data/justfile

@@ -1,43 +0,0 @@
-set quiet
-
-import? '../sdk-codegen/utils.just'
-
-_default:
-    just --list --unsorted
-
-install *args:
-    bundle install {{ if is_dependency() == "true" {"--quiet"} else {""} }} {{ args }}
-
-# ⭐ run all unit tests
-test: install
-    bundle exec rake test
-
-# check linting / formatting status of files
-format-check *args: install
-    bundle exec rubocop {{ args }}
-alias lint-check := format-check
-
-# ⭐ check style & formatting for all files, fixing what we can
-lint: (format-check "--autocorrect")
-
-# NOTE: "-o /dev/null" is vital - rubocop has super noisy output and codegen will crash when formatting ruby if everything gets printed
-# so, we send all its output to the void
-# copy of `lint` with less output
-format: (format-check "-o /dev/null --autocorrect")
-
-update-certs: install
-    bundle exec rake update_certs
-
-# run sorbet to check type definitions
-typecheck: install
-    {{ if semver_matches(`ruby -e "puts RUBY_VERSION"`, ">=2.7") == "true" { \
-        "bundle exec srb tc" \
-    } else { \
-        "echo \"Ruby version < 2.7, skipping srb tc\"" \
-    } }}
-
-# called by tooling
-[private]
-update-version version:
-    echo "{{ version }}" > VERSION
-    perl -pi -e 's|VERSION = "[.\-\w\d]+"|VERSION = "{{ version }}"|' lib/stripe/version.rb

data/lib/stripe/resources/usage_record.rb

@@ -1,17 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  # Usage records allow you to report customer usage and metrics to Stripe for
-  # metered billing of subscription prices.
-  #
-  # Related guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)
-  #
-  # This is our legacy usage-based billing API. See the [updated usage-based billing docs](https://docs.stripe.com/billing/subscriptions/usage-based).
-  class UsageRecord < APIResource
-    OBJECT_NAME = "usage_record"
-    def self.object_name
-      "usage_record"
-    end
-  end
-end

data/lib/stripe/resources/usage_record_summary.rb

@@ -1,12 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  # A usage record summary represents an aggregated view of how much usage was accrued for a subscription item within a subscription billing period.
-  class UsageRecordSummary < StripeObject
-    OBJECT_NAME = "usage_record_summary"
-    def self.object_name
-      "usage_record_summary"
-    end
-  end
-end

data/lib/stripe/resources/v2/event.rb

@@ -1,13 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module V2
-    class Event < APIResource
-      OBJECT_NAME = "v2.core.event"
-      def self.object_name
-        "v2.core.event"
-      end
-    end
-  end
-end

data/lib/stripe/resources/v2/event_destination.rb

@@ -1,13 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module V2
-    class EventDestination < APIResource
-      OBJECT_NAME = "v2.core.event_destination"
-      def self.object_name
-        "v2.core.event_destination"
-      end
-    end
-  end
-end

data/lib/stripe/services/invoice_upcoming_lines_service.rb

@@ -1,17 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  class InvoiceUpcomingLinesService < StripeService
-    # When retrieving an upcoming invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
-    def list(params = {}, opts = {})
-      request(
-        method: :get,
-        path: "/v1/invoices/upcoming/lines",
-        params: params,
-        opts: opts,
-        base_address: :api
-      )
-    end
-  end
-end

data/lib/stripe/services/subscription_item_usage_record_service.rb

@@ -1,23 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  class SubscriptionItemUsageRecordService < StripeService
-    # Creates a usage record for a specified subscription item and date, and fills it with a quantity.
-    #
-    # Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the [metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing) plan, Stripe helps you send accurate invoices to your customers.
-    #
-    # The default calculation for usage is to add up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan's aggregate_usage [parameter](https://stripe.com/docs/api/plans/create#create_plan-aggregate_usage). When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter.
-    #
-    # The default pricing model for metered billing is [per-unit pricing. For finer granularity, you can configure metered billing to have a <a href="https://stripe.com/docs/billing/subscriptions/tiers">tiered pricing](https://stripe.com/docs/api/plans/object#plan_object-billing_scheme) model.
-    def create(subscription_item, params = {}, opts = {})
-      request(
-        method: :post,
-        path: format("/v1/subscription_items/%<subscription_item>s/usage_records", { subscription_item: CGI.escape(subscription_item) }),
-        params: params,
-        opts: opts,
-        base_address: :api
-      )
-    end
-  end
-end

data/lib/stripe/services/subscription_item_usage_record_summary_service.rb

@@ -1,19 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  class SubscriptionItemUsageRecordSummaryService < StripeService
-    # For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that's been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).
-    #
-    # The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn't ended yet. Since new usage records can still be added, the returned summary information for the subscription item's ID should be seen as unstable until the subscription billing period ends.
-    def list(subscription_item, params = {}, opts = {})
-      request(
-        method: :get,
-        path: format("/v1/subscription_items/%<subscription_item>s/usage_record_summaries", { subscription_item: CGI.escape(subscription_item) }),
-        params: params,
-        opts: opts,
-        base_address: :api
-      )
-    end
-  end
-end

data/lib/stripe/thin_event.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Stripe
-  class EventReasonRequest
-    attr_reader :id, :idempotency_key
-
-    def initialize(event_reason_request_payload = {})
-      @id = event_reason_request_payload[:id]
-      @idempotency_key = event_reason_request_payload[:idempotency_key]
-    end
-  end
-
-  class EventReason
-    attr_reader :type, :request
-
-    def initialize(event_reason_payload = {})
-      @type = event_reason_payload[:type]
-      @request = EventReasonRequest.new(event_reason_payload[:request])
-    end
-  end
-
-  class ThinEvent
-    attr_reader :id, :type, :created, :context, :related_object, :livemode, :reason
-
-    def initialize(event_payload = {})
-      @id = event_payload[:id]
-      @type = event_payload[:type]
-      @created = event_payload[:created]
-      @context = event_payload[:context]
-      @livemode = event_payload[:livemode]
-      @related_object = event_payload[:related_object]
-      return if event_payload[:reason].nil?
-
-      @reason = EventReason.new(event_payload[:reason])
-    end
-  end
-end

data/stripe.gemspec

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
-
-require "stripe/version"
-
-Gem::Specification.new do |s|
-  s.name = "stripe"
-  s.version = Stripe::VERSION
-  s.required_ruby_version = ">= 2.3.0"
-  s.summary = "Ruby bindings for the Stripe API"
-  s.description = "Stripe is the easiest way to accept payments online.  " \
-                  "See https://stripe.com for details."
-  s.author = "Stripe"
-  s.email = "support@stripe.com"
-  s.homepage = "https://stripe.com/docs/api?lang=ruby"
-  s.license = "MIT"
-
-  s.metadata = {
-    "bug_tracker_uri" => "https://github.com/stripe/stripe-ruby/issues",
-    "changelog_uri" =>
-      "https://github.com/stripe/stripe-ruby/blob/master/CHANGELOG.md",
-    "documentation_uri" => "https://stripe.com/docs/api?lang=ruby",
-    "github_repo" => "ssh://github.com/stripe/stripe-ruby",
-    "homepage_uri" => "https://stripe.com/docs/api?lang=ruby",
-    "source_code_uri" => "https://github.com/stripe/stripe-ruby",
-    "rubygems_mfa_required" => "false",
-  }
-
-  ignored = Regexp.union(
-    /\A\.editorconfig/,
-    /\A\.git/,
-    /\A\.rubocop/,
-    /\A\.travis.yml/,
-    /\A\.vscode/,
-    /\Abin/,
-    /\Asorbet/,
-    /\Atest/
-  )
-  s.files = `git ls-files`.split("\n").grep_v(ignored)
-  s.bindir = "exe"
-  s.executables   = `git ls-files -- exe/*`.split("\n").map { |f| File.basename(f) }
-  s.require_paths = ["lib"]
-end