rack-affiliates - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #ai #golang #android #deep-learning #linux #nodejs #kubernetes #awesome-list #pytorch #mcp #ios #openai

rack-affiliates

(★ 152)

No description available.

파일 탐색기

최종 버전 다운로드 (.zip)

- rack-affiliates.rb
- helper.rb
- rack_affiliates_spec.rb
.document
.gitignore
Gemfile
LICENSE.txt
rack-affiliates.gemspec
Rakefile
README.md
VERSION

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/alexlevin/rack-affiliates

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd rack-affiliates

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. 공식 설치 스크립트

쉬움 추천

사전 준비물

Ruby gem 명령어를 쓰려면 Ruby가 필요합니다.

gem install rack-affiliates

RubyGems에 배포된 패키지를 바로 설치합니다.

✅ 설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Ruby

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Ruby bundle 명령어를 쓰려면 Ruby가 필요합니다.

bundle install

Gemfile에 명시된 루비 라이브러리를 설치합니다.

✅ bundle install이 에러 없이 끝나면 README에 안내된 실행 명령어(예: rails server)로 마저 실행해보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Rack::Affiliates
================

Rack::Affiliates is a rack middleware that extracts information about the referrals came from an affiliated site. Specifically, it looks up for specific parameter (<code>ref</code> by default) in the request. If found, it persists affiliate tag, referring url and time in a cookie for later use.

Common Scenario
---------------

Affiliate links tracking is very common task if you want to promote your online business. This middleware helps you to do that.

1. You associate an affiliate tag (for eg. <code>ABC123</code>) with your partner.
2. The affiliate promotes your business at http://partner.org by linking to your site with like <code>http://yoursite.org?ref=ABC123</code>.
3. A user clicks through the link and lands on your site.
4. Rack::Affiliates middleware finds <code>ref</code> parameter in the request, extracts affiliate tag and saves it in a cookie
5. User signs up (now or later) and you mark it as a referral from your partner
6. PROFIT!

Installation
------------
Works with Rails version **> 2** (including Rails 5).

Include the gem in your Gemfile:

gem 'rack-affiliates'
    
or install it:

gem install rack-affiliates

Rails Example Usage
---------------------

Add the middleware to your application stack:

# Rails 3+ App - in config/application.rb
    class Application < Rails::Application
      ...
      config.middleware.use Rack::Affiliates
      ...
    end
    
    # Rails 2 App - in config/environment.rb
    Rails::Initializer.run do |config|
      ...
      config.middleware.use "Rack::Affiliates"
      ...
    end

Now you can check any request to see who came to your site via an affiliated link and use this information in your application. Affiliate tag is saved in the cookie and will come into play if user returns to your site later.

class ExampleController < ApplicationController
      def index
        str = if request.env['affiliate.tag'] && affiliate = User.find_by_affiliate_tag(request.env['affiliate.tag'])
          "Halo, referral! You've been referred here by #{affiliate.name} from #{request.env['affiliate.from']} @ #{Time.at(env['affiliate.time'])}"
        else
          "We're glad you found us on your own!"
        end
        
        render :text => str
      end
    end

Customization
-------------

You can customize parameter name by providing <code>:param</code> option (default is <code>ref</code>).
By default cookie is set for 30 days, you can extend time to live with <code>:ttl</code> option (default is 30 days).

#Rails 3+ in config/application.rb
    class Application < Rails::Application
      ...
      config.middleware.use Rack::Affiliates, {:param => 'aff_id', :ttl => 3.months}
      ...
    end

The <code>:domain</code> option allows to customize cookie domain.

#Rails 3+ in config/application.rb
    class Application < Rails::Application
      ...
      config.middleware.use Rack::Affiliates, :domain => '.example.org'
      ...
    end

The <code>:path</code> option allows to hardcode the cookie path allowing you to record affiliate links at any URL on your site.

#Rails 3+ in config/application.rb
    class Application < Rails::Application
      ...
      config.middleware.use Rack::Affiliates, { :path => '/' }
      ...
    end

Middleware will set cookie on <code>.example.org</code> so it's accessible on <code>www.example.org</code>, <code>app.example.org</code> etc.

The <code>:overwrite</code> option allows to set whether to overwrite the existing affiliate tag previously stored in cookies. By default it is set to `true`.

If you want to capture more attributes from the query string whenever it comes from an affiliate you can define those with the <code>extra_params</code> value.

#Rails 3+ in config/application.rb
    class Application < Rails::Application
      ...
      config.middleware.use Rack::Affiliates, { :extra_params => [:great_query_parameter] }
      ...
    end

These will be availble through <code>env['affiliate.extras']</code> as a hash with the same keys.

Credits
=======

Thanks goes to Rack::Referrals (https://github.com/deviantech/rack-referrals) for the inspiration.