Chargify API Ruby Wrapper 使用指南

本文档旨在帮助用户安装和使用 Chargify API 的 Ruby Wrapper，该 Wrapper 利用 ActiveResource 简化了与 Chargify API 的交互过程。以下是详细的安装指南、使用说明以及 API 使用文档。

1. 安装指南

首先，确保您已经安装了 Ruby 环境。接下来，可以通过以下命令将 Chargify API Wrapper 安装为 gem：

$ gem install chargify_api_ares

如果您使用的是 Rails 3.x 环境，可以在 Gemfile 中添加以下内容：

gem 'chargify_api_ares'

然后执行 bundle install 命令来安装 gem。

对于 Rails 2 环境，您可以在 environment.rb 文件中配置 gem：

config.gem 'chargify_api_ares'

在配置 gem 后，您需要设置 API 密钥和子域名等配置信息。以下是一个配置示例：

Chargify.configure do |c|
  c.api_key   = "your_key_goes_here"
  c.subdomain = "test-site"
end

2. 项目的使用说明

在开始使用之前，确保已经正确配置了 API 密钥和其他必要信息。以下是如何使用 Wrapper 与 Chargify API 交互的示例：

require 'chargify_api_ares'

# 创建订阅
subscription = Chargify::Subscription.create(
  :customer_reference => 'moklett',
  :product_handle => 'chargify-api-ares-test',
  :credit_card_attributes => {
    :first_name => "Michael",
    :last_name => "Klett",
    :expiration_month => 1,
    :expiration_year => 2010,
    :full_number => "1234-1234-1234-1234"
  }
)

# 更新订阅信息
subscription.credit_card_attributes = { :expiration_year => 2013 }
subscription.save

# 取消订阅
subscription.cancel

请注意，更新嵌套资源（如订阅中的客户信息）不建议使用，应直接更新客户对象。

3. 项目API使用文档

Chargify API Wrapper 提供了多个类来与 Chargify API 交互，包括 Chargify::Product、Chargify::Customer 和 Chargify::Subscription 等。以下是一些常见操作的示例：

• 创建订阅：

Chargify::Subscription.create(...)

• 更新订阅：

subscription.save

• 取消订阅：

subscription.cancel

• 获取订阅的 PDF 对账单：

File.open(file_path, 'wb+') do |f|
  f.write Chargify::Statement.find_pdf(statement.id)
end

• 防止重复创建：

subscription = Chargify::Subscription.create(
  :uniqueness_token => "abc-123-def-456"
)

4. 项目安装方式

项目安装方式已在安装指南部分详细描述，此处不再赘述。

通过以上指南，用户应能顺利安装和使用 Chargify API Ruby Wrapper。如果您在使用过程中遇到任何问题，可以查看项目 Wiki 或在 GitHub 上提问题。