Rack::Affiliates 技术文档

1. 安装指南

Rack::Affiliates 是一个 Rack 中间件，用于提取来自合作网站推荐的信息。首先确保您使用的 Rails 版本大于 2（包括 Rails 5）。

将以下代码添加到您的 Gemfile 中：

gem 'rack-affiliates'

然后执行以下命令安装：

gem install rack-affiliates

2. 项目使用说明

在您的 Rails 应用中添加 Rack::Affiliates 中间件。以下是在不同版本 Rails 中配置中间件的示例代码：

Rails 3+ 使用示例

在 config/application.rb 文件中：

class Application < Rails::Application
  ...
  config.middleware.use Rack::Affiliates
  ...
end

Rails 2 使用示例

在 config/environment.rb 文件中：

Rails::Initializer.run do |config|
  ...
  config.middleware.use "Rack::Affiliates"
  ...
end

现在您可以在任何请求中查看是否有人通过合作链接访问您的网站，并在应用中使用这些信息。合作标记将保存在 cookies 中，当用户稍后返回您的网站时，该标记将发挥作用。

以下是一个使用示例：

class ExampleController < ApplicationController
  def index
    str = if request.env['affiliate.tag'] && affiliate = User.find_by_affiliate_tag(request.env['affiliate.tag'])
      "您好，推荐者！您是由 #{affiliate.name} 从 #{request.env['affiliate.from']} 在 #{Time.at(env['affiliate.time'])} 推荐到这里"
    else
      "我们很高兴您自己找到了我们！"
    end
    
    render :text => str
  end
end

3. 项目 API 使用文档

以下是一些可用的配置选项：

• :param：用于自定义查询参数名称，默认为 ref。
• :ttl：用于设置 cookie 的有效期，默认为 30 天。
• :domain：用于自定义 cookie 的域名。
• :path：用于设置 cookie 的路径。
• :overwrite：用于设置是否覆盖 cookies 中已存在的合作标记，默认为 true。
• :extra_params：用于捕获来自合作网站查询字符串的额外属性。

以下是一个配置示例：

class Application < Rails::Application
  ...
  config.middleware.use Rack::Affiliates, {:param => 'aff_id', :ttl => 3.months, :domain => '.example.org', :path => '/', :overwrite => true, :extra_params => [:great_query_parameter]}
  ...
end

这些配置选项将使您能够更好地定制 Rack::Affiliates 的行为。

4. 项目安装方式

项目的安装方式已在“安装指南”部分中说明，您可以通过 Gemfile 添加依赖并执行 gem install 命令进行安装。