stripe-cli-ruby 1.33.0 → 1.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69ac7836061cff888e58409a5a95e2bc6b4ea287cf64acb02aa6102028ac1584
-  data.tar.gz: 0fb140beb5cd34cd3585f19d178aa36d257e8c98a14eb06aae3872a8787ee89d
+  metadata.gz: 3aa4eebf08caad52436074ab4db7021e660233b37abf6998caa6127aa7b713ec
+  data.tar.gz: 9ad8f738ef37e1d874d4b2dd93bc499a7953f35ccd2a21748e868c6dcd758afa
 SHA512:
-  metadata.gz: 1ef64b62031a0412f8dddf6c0e88f544a305d4960a16c5a8c02b4a925c8c2ce34610bb939d51f992412801103de41b91aab464d5ad22d035238e063bc25dd372
-  data.tar.gz: 996dd50e5f981d541b1ab475dded682909d40e14776d72b4ea5dcef6536f06457ff3b9035d252a7c706fa83f853767f357da7f54048f0af52ff6f70a43062dc5
+  metadata.gz: 33a5f1da95e56ba540338f8cd881ad5a237e7e82110982271b40f3196264155ad7fa494a411eb62e061fc308067822e350b4e94dfd7a76ba18950788b2cf8d50
+  data.tar.gz: f4511abc8659aaee87e3d6210dbd937ad4d2aad744af1f8931e99fefdbfe32109bc759a69adbbcb56ebadec69dc6445a69b771e0308ad886d0ea28d1267ba7c8

data/README.md

@@ -13,7 +13,7 @@ Supported platforms are:
 - `arm64-darwin` (macos-arm64)
 - `x86_64-darwin` (macos-x64)
 - `x86_64-linux` (linux-x64)
-- `arm-linux` (linux-armv7)
+- `aarch64-linux` (linux-arm64)
 
 Install the gem and add to the application's Gemfile by executing:
 
@@ -39,7 +39,7 @@ The gem makes available `StripeCLI.executable` which is the path to the vendored
 ```ruby
 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"
+# => "/path/to/gems/stripe-cli-ruby-1.33.0-x86_64-linux/exe/x86_64-linux/stripe"
 ```
 
 ### Command line
@@ -52,8 +52,8 @@ $ 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
+$ bundle exec stripe --version
+stripe version 1.33.0
 ```
 
 ## Forwarding events to your web server
@@ -71,7 +71,9 @@ Add `plugin :stripe` to `puma.rb` configuration:
 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`.
+By default, all events will be forwarded to `/stripe_events`, this can be configured using `stripe_forward_to "/stripe/webhook"` in `puma.rb`.
+
+To forward the events of the webhook endpoints set up in your Stripe dashboard instead, add `stripe_use_configured_webhooks` to `puma.rb`. Each endpoint's events go to that endpoint's path on your local server, so an endpoint at `https://example.com/stripe/webhook` gets forwarded to `http://localhost:3000/stripe/webhook`. Your test mode account needs at least one webhook endpoint.
 
 You can grab your *signing secret* using `StripeCLI.signing_secret`. For example:
 
@@ -79,7 +81,7 @@ 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
+# app/controllers/stripe_events_controller.rb
 class StripeEventsController < ActionController::API
   before_action :set_event
 
@@ -110,9 +112,17 @@ 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.
+Run `bin/setup` to install dependencies, `bundle exec rake download` to fetch the Stripe CLI binaries, and `bundle exec rake test` to run the tests. Set `TEST_STRIPE_API_KEY` to a test-mode key to run the tests that talk to Stripe.
+
+## Releases
+
+Releases are automatic:
+
+1. The `update` workflow checks for a new Stripe CLI release every day. When there is one, the workflow bumps `StripeCLI::VERSION` and `StripeCLI::Upstream::VERSION` and pushes the commit to `main`.
+2. The `ci` workflow tests every push to `main`, builds a gem per platform, and installs each one on its platform.
+3. When `StripeCLI::VERSION` isn't tagged yet, `ci` pushes the gems to rubygems.org with [trusted publishing](https://guides.rubygems.org/trusted-publishing/) and creates a GitHub release.
 
-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](https://rubygems.org).
+To ship a fix without a new Stripe CLI version, bump `StripeCLI::VERSION` to something like `1.33.0.1` and push to `main`.
 
 ## Contributing
 

data/lib/puma/plugin/stripe.rb

@@ -3,18 +3,21 @@
 require "puma"
 require "puma/plugin"
 require "stripe"
+require "stripe_cli"
 
 Puma::Plugin.create do
   def start(launcher)
     @launcher = launcher
 
     launcher.events.on_booted do
-      launcher.log_writer.log "Stripe: forwarding webhooks to #{forward_to}"
-      @pid = fork do
-        exec "#{StripeCLI.executable} listen --forward-to #{forward_to} --api-key #{Stripe.api_key}"
-      rescue Errno::ENOENT
-        launcher.log_writer.log "[Stripe] Not found. See https://docs.stripe.com/stripe-cli#install"
+      if use_configured_webhooks?
+        launcher.log_writer.log "Stripe: forwarding webhooks configured in the dashboard to #{forward_to}"
+      else
+        launcher.log_writer.log "Stripe: forwarding webhooks to #{forward_to}"
       end
+      @pid = spawn(StripeCLI.executable, "listen", "--all-snapshot", *("--use-configured-webhooks" if use_configured_webhooks?), "--forward-to", forward_to.to_s, "--api-key", Stripe.api_key.to_s)
+    rescue StripeCLI::UnsupportedPlatformException, StripeCLI::ExecutableNotFoundException, Errno::ENOENT => e
+      launcher.log_writer.log "[Stripe] Could not start the Stripe CLI: #{e.message}"
     end
 
     launcher.events.on_stopped { stop_stripe }
@@ -22,17 +25,26 @@ Puma::Plugin.create do
 
   private
     def stop_stripe
-      Process.waitpid(@pid, Process::WNOHANG)
+      return unless @pid
+
       @launcher.log_writer.log "[Stripe] Stopping..."
-      Process.kill(:INT, @pid) if @pid
+      Process.kill(:INT, @pid)
       Process.wait(@pid)
     rescue Errno::ECHILD, Errno::ESRCH
     end
 
+    def use_configured_webhooks?
+      @launcher.options[:stripe_use_configured_webhooks]
+    end
+
+    # Dashboard endpoints bring their own paths, so only the host and port are ours.
     def forward_to
-      path = @launcher.options.fetch(:stripe_forward_to, "/stripe_events")
       _, port, host = @launcher.binder.ios.first.addr
-      URI::HTTP.build(port:, host:, path:)
+      if use_configured_webhooks?
+        URI::HTTP.build(port:, host:)
+      else
+        URI::HTTP.build(port:, host:, path: @launcher.options.fetch(:stripe_forward_to, "/stripe_events"))
+      end
     end
 end
 
@@ -41,5 +53,9 @@ module Puma
     def stripe_forward_to(path)
       @options[:stripe_forward_to] = path
     end
+
+    def stripe_use_configured_webhooks(enabled = true)
+      @options[:stripe_use_configured_webhooks] = enabled
+    end
   end
 end

data/lib/stripe_cli/signing_secret.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
+require "open3"
+
 module StripeCLI
   def self.signing_secret(api_key)
-    secret = `#{executable} listen --api-key "#{api_key}" --print-secret`.chomp
-    return nil unless $?.success?
-    secret unless secret.empty?
+    secret, status = Open3.capture2(executable, "listen", "--api-key", api_key.to_s, "--print-secret", err: File::NULL)
+    secret.chomp if status.success? && !secret.strip.empty?
   rescue
     nil
   end

data/lib/stripe_cli/upstream.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module StripeCLI
-  # constants describing the upstream tailwindcss project
+  # constants describing the upstream stripe/stripe-cli project
   module Upstream
-    VERSION = "1.33.0"
+    VERSION = "1.55.0"
 
     # rubygems platform name => upstream release filename
     NATIVE_PLATFORMS = {
       "arm64-darwin" => "stripe_#{VERSION}_mac-os_arm64.tar.gz",
-      "arm64-linux" => "stripe_#{VERSION}_linux_arm64.tar.gz",
+      "aarch64-linux" => "stripe_#{VERSION}_linux_arm64.tar.gz",
       "x86_64-darwin" => "stripe_#{VERSION}_mac-os_x86_64.tar.gz",
       "x86_64-linux" => "stripe_#{VERSION}_linux_x86_64.tar.gz"
     }

data/lib/stripe_cli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StripeCLI
-  VERSION = "1.33.0"
+  VERSION = "1.55.0"
 end

data/lib/stripe_cli.rb

@@ -16,10 +16,6 @@ module StripeCLI
   class ExecutableNotFoundException < StandardError
   end
 
-  # raised when STRIPE_CLI_INSTALL_DIR does not exist
-  class DirectoryNotFoundException < StandardError
-  end
-
   class << self
     def platform
       [ :cpu, :os ].map { |m| Gem::Platform.local.send(m) }.join("-")
@@ -28,9 +24,8 @@ module StripeCLI
     def executable(exe_path: DEFAULT_DIR)
       if StripeCLI::Upstream::NATIVE_PLATFORMS.keys.none? { |p| Gem::Platform.match_gem?(Gem::Platform.new(p), GEM_NAME) }
         raise UnsupportedPlatformException, <<~MESSAGE
-          #{GEM_NAME} does not support the #{platform} platform
-          See https://github.com/flavorjones/tailwindcss-ruby#using-a-local-installation-of-tailwindcss
-          for more details.
+          #{GEM_NAME} does not support the #{platform} platform.
+          Install the Stripe CLI another way: https://docs.stripe.com/stripe-cli#install
         MESSAGE
       end
 
@@ -55,9 +50,7 @@ module StripeCLI
           See `bundle lock --help` output for details.
 
           If you're still seeing this message after taking those steps, try running
-          `bundle config` and ensure `force_ruby_platform` isn't set to `true`. See
-          https://github.com/flavorjones/tailwindcss-ruby#check-bundle_force_ruby_platform
-          for more details.
+          `bundle config` and ensure `force_ruby_platform` isn't set to `true`.
         MESSAGE
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe-cli-ruby
 version: !ruby/object:Gem::Version
-  version: 1.33.0
+  version: 1.55.0
 platform: ruby
 authors:
 - Zacharias Knudsen
@@ -73,7 +73,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/zachasme/stripe-cli-ruby
-  changelog_uri: https://github.com/zachasme/stripe-cli-ruby/blob/main/CHANGELOG.md
+  changelog_uri: https://github.com/zachasme/stripe-cli-ruby/releases
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -82,14 +82,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.20
 specification_version: 4
 summary: A self-contained `stripe` executable.
 test_files: []