Giter VIP home page Giter VIP logo

rack-trade_tracker's Introduction

Rack::TradeTracker

The Rack::TradeTracker gem is for use with the Trade Tracker affiliate network.

The gem provides a Rack middleware component to handle Trade Tracker's redirect mechanism.

Installation

Add this line to your application's Gemfile:

gem 'rack-trade_tracker'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rack-trade_tracker

Usage

Note that domain: and path: are required options and you will get an error if you don't provide these:

  • Replace 'your-domain' with your domain name minus www; e.g. clickmechanic.com.
  • Replace 'your-path' with the target path you have agreed with Trade Tracker; e.g. /repair (note the leading /)

The gem makes no assumptions about where and how you implement the Trade Tracker JS script. You will need to do this yourself.

config.ru

If you are running a basic Rack app, you can configure the middleware in your config.ru file:

use Rack::TradeTracker, domain: 'your-domain', path: '/your_path'

Rails

If you are using Rails, you can configure the rack middleware in config/application.rb, or one of the config/environments/<environment>.rb files, using one of the provided helper methods:

config.middleware.use('Rack::TradeTracker', domain: 'your-domain', path: 'your-path')

# or
config.middleware.insert_before(existing_middleware, 'Rack::TradeTracker', domain: 'your-domain', path: 'your-path')

# or
config.middleware.insert_after(existing_middleware, 'Rack::TradeTracker', domain: 'your-domain', path: 'your-path')

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ClickMechanic/rack-trade_tracker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Rack::TradeTracker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

rack-trade_tracker's People

Contributors

silvabox avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar

rack-trade_tracker's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.