stripe-cli-ruby

A self-contained Stripe CLI executable, wrapped up in a ruby gem. Includes a puma plugin to forward Stripe webhook events to your web server.

The binary distribution part is lifted from https://github.com/flavorjones/tailwindcss-ruby.

Installation

This gem wraps the Stripe CLI executable. These executables are platform specific, so there are actually separate underlying gems per platform, but the correct gem will automatically be picked for your platform.

Supported platforms are:

• arm64-darwin (macos-arm64)
• x86_64-darwin (macos-x64)
• x86_64-linux (linux-x64)
• arm-linux (linux-armv7)

Install the gem and add to the application's Gemfile by executing:

bundle add stripe-cli-ruby --group development

If bundler is not being used to manage dependencies, install the gem by executing:

gem install stripe-cli-ruby

[!NOTE] Add the included puma plugin in order to listen for webhook events in development.

Usage

Ruby

The gem makes available StripeCLI.executable which is the path to the vendored standalone executable.

require "stripe-cli-ruby"
StripeCLI.executable
# => "/path/to/installs/ruby/3.3.5/lib/ruby/gems/3.3.0/gems/stripe-cli-ruby-0.1.0-x86_64-linux/exe/x86_64-linux/stripe"

Command line

This gem provides an executable stripe shim that will run the vendored standalone executable.

# where is the shim?
$ bundle exec which stripe
/path/to/installs/ruby/3.3/bin/stripe

# run the actual executable through the shim
$ bundle exec stripe --help
stripe version 1.25.1

Forwarding events to your web server

Make sure Stripe.api_key is set, e.g. in config/initializers/stripe.rb:

Stripe.api_key = "sk_test_..."

Add plugin :stripe to puma.rb configuration:

# Run stripe cli only in development.
plugin :stripe if ENV["RAILS_ENV"] == "development"

By default, events will be forwarded to /stripe_events, this can be configured using stripe_forward_to "/stripe/webhook" in puma.rb.

You can grab your signing secret using StripeCLI.signing_secret. For example:

# config/environments/development.rb
config.stripe_signing_secret = StripeCLI.signing_secret(Stripe.api_key)

# app/constrollers/stripe_events_controller.rb
class StripeEventsController < ActionController::API
  before_action :set_event

  def create
    case event.type
    when 'payment_intent.succeeded'
      payment_intent = event.data.object
      # ...
    end

    head :ok
  end

  private

    def event
      @event ||= Stripe::Webhook.construct_event(
        request.body.read,
        request.headers["stripe-signature"],
        Rails.configuration.stripe_signing_secret
      )
    rescue => error
      logger.error error
      head :bad_request
    end
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in stripe-cli-ruby.gemspec, and then run bin/cut, which will create a git tag for the version, push git commits and the created tag, and push the .gem files to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/zachasme/stripe-cli-ruby.

License

The gem is available as open source under the terms of the MIT License.