首页
/ Rack::Affiliates 技术文档

Rack::Affiliates 技术文档

2024-12-27 00:41:11作者:贡沫苏Truman

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 命令进行安装。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8