Stripe Event 项目教程

Stripe Event 项目教程

stripe_eventStripe webhook integration for Rails applications.项目地址:https://gitcode.com/gh_mirrors/st/stripe_event

1. 项目的目录结构及介绍

Stripe Event 是一个用于 Rails 应用程序的 Stripe webhook 集成库。以下是其基本的目录结构：

stripe_event/
├── app/
│   ├── controllers/
│   │   └── stripe_event/
│   │       └── webhook_controller.rb
├── config/
│   ├── initializers/
│   │   └── stripe.rb
│   └── routes.rb
├── lib/
│   ├── stripe_event/
│   │   ├── engine.rb
│   │   └── version.rb
├── spec/
│   ├── controllers/
│   │   └── stripe_event/
│   │       └── webhook_controller_spec.rb
├── Gemfile
├── LICENSE
├── README.md
└── stripe_event.gemspec

目录结构介绍

• app/controllers/stripe_event/webhook_controller.rb: 处理 Stripe webhook 请求的控制器。
• config/initializers/stripe.rb: 配置 Stripe API 密钥和事件订阅器的初始化文件。
• config/routes.rb: 配置路由，将 Stripe webhook 路径映射到控制器。
• lib/stripe_event/engine.rb: Stripe Event 引擎的定义文件。
• lib/stripe_event/version.rb: 版本信息文件。
• spec/controllers/stripe_event/webhook_controller_spec.rb: 控制器的测试文件。
• Gemfile: 项目的依赖管理文件。
• LICENSE: 项目的许可证文件。
• README.md: 项目说明文档。
• stripe_event.gemspec: 项目的 gemspec 文件。

2. 项目的启动文件介绍

Stripe Event 项目的启动文件主要是 config/initializers/stripe.rb，该文件用于配置 Stripe API 密钥和事件订阅器。

# config/initializers/stripe.rb
Stripe.api_key = ENV['STRIPE_SECRET_KEY']
StripeEvent.signing_secret = ENV['STRIPE_SIGNING_SECRET']

StripeEvent.configure do |events|
  events.subscribe 'charge.failed' do |event|
    # 定义订阅器行为，例如发送邮件通知
  end

  events.all do |event|
    # 处理所有事件类型，例如日志记录
  end
end

启动文件介绍

• Stripe.api_key: 设置 Stripe API 密钥。
• StripeEvent.signing_secret: 设置 Stripe webhook 签名密钥。
• StripeEvent.configure: 配置事件订阅器，可以订阅特定事件或处理所有事件。

3. 项目的配置文件介绍

Stripe Event 项目的配置文件主要包括 config/routes.rb 和 config/initializers/stripe.rb。

config/routes.rb

# config/routes.rb
Rails.application.routes.draw do
  mount StripeEvent::Engine, at: '/webhook'
end

config/initializers/stripe.rb

# config/initializers/stripe.rb
Stripe.api_key = ENV['STRIPE_SECRET_KEY']
StripeEvent.signing_secret = ENV['STRIPE_SIGNING_SECRET']

StripeEvent.configure do |events|
  events.subscribe 'charge.failed' do |event|
    # 定义订阅器行为，例如发送邮件通知
  end

  events.all do |event|
    # 处理所有事件类型，例如日志记录
  end
end

配置文件介绍

• config/routes.rb: 配置路由，将 Stripe webhook 路径映射到控制器。
• config/initializers/stripe.rb: 配置 Stripe API 密钥和事件订阅器。

通过以上配置，可以确保 Stripe Event 项目正确地处理 Stripe webhook 事件，并根据需要执行相应的订阅器行为。

stripe_eventStripe webhook integration for Rails applications.项目地址:https://gitcode.com/gh_mirrors/st/stripe_event