trade_tracker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36b7d41431da7b4ca8cdae1ca5d19451c1411d16
+  data.tar.gz: 651ead1bd6058f2083e347e509183e997f130198
+SHA512:
+  metadata.gz: cd720bdea851c63d7474c0771c317b28bdfddbf9fe36ce3c0e0894e5f6c0206a074f5ed8c4a2daf50c289fa74c913def53f811cc0bbf4921b507f866504f8709
+  data.tar.gz: 752c9b0ebcfb57f2e19bbb80fb694d28a1aeaf533c606df3a296cd9ab7452ad47e17df39415dda8fd8f1c274773c203c1b6a4b54879ae929e1eb5f937ff22434

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trade_tracker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Blimp
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# TradeTracker on Rails
+
+This gem is for you if you're looking to integrate TradeTracker click/conversion tracking into your Rails app.
+
+This assumes basic knowledge of the TradeTracker tool.
+Refer to the official documentation if you have questions on the click/conversion process.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'trade_tracker', github: 'blimp/trade_tracker', branch: :master
+
+Then execute:
+
+    $ bundle
+
+And finally, generate your configuration file:
+
+    $ rails g trade_tracker:config
+
+## Usage
+
+### 1. Setup two routes
+```ruby
+  get 'my_click_page' => 'tradetracker#index'
+  get 'my_conversion_page' => 'tradetracker#conversion'
+```
+### 2. Create a basic controller (or map to your own)
+```ruby
+class TradetrackerController < ApplicationController
+  include TradeTracker::Concerns::Click
+  include TradeTracker::Concerns::Conversion
+
+  def index
+    set_p3p_header # Can comment out at will. It's still in the TT integration specs.
+    set_cookies # Stores the required cookie hash so TT knows we're legit.
+    send_click_to_tradetracker # Redirects to TTs trackback URL, and back to your redirect URL.
+  end
+
+  def conversion
+    send_conversion_to_tradetracker # Redirects to TTs trackback_URL
+  end
+end
+```
+### 3. Add the conversion image tag
+```ruby
+# app/controllers/my_fancy_conversion_page_controller.rb:
+class MyFancyConversionPageController < ApplicationController
+  include TradeTracker::Concerns::Conversion
+
+  def my_fancy_action
+    # Refer to the TradeTracker documentation to see which params are available.
+    set_conversion_image_parameters(
+      conversion_type: 'sales',
+      transaction_id: 1234,
+      price: 1337,
+      merchant_description: "Describe what you sold (IDs/names/...)",
+      email: 'customer@bought.it',
+    )
+  end
+end
+```
+```ruby
+# app/views/my_fancy_action.html.erb
+<%= conversion_image_tag %>
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/trade_tracker/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/lib/generators/trade_tracker/config_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators/base'
+
+module TradeTracker
+  class ConfigGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc 'generate yaml config for TradeTracker campaign_id and product_id'
+
+    def copy_files
+      say_status '', "Copying configuration file... \n", :blue
+      copy_file 'trade_tracker.yml', 'config/trade_tracker.yml'
+    end
+
+    def print_manual
+      say_status 'OK', 'Done.', :green
+      say "\nRemember to fill in your campaign_id and product_id in config/trade_tracker.yml", :yellow
+      say "Further implementation details can be found at http://github.com/blimp/trade_tracker\n", :yellow
+    end
+  end
+end

data/lib/generators/trade_tracker/templates/trade_tracker.yml

@@ -0,0 +1,10 @@
+production: &production
+  campaign_id: You receive this from TradeTracker
+  product_id: You receive this from TradeTracker
+
+development:
+  <<: *production
+
+test:
+  <<: *production
+

data/lib/trade_tracker.rb

@@ -0,0 +1,11 @@
+require 'active_support/dependencies'
+require 'active_support/concern'
+require 'trade_tracker/version'
+require 'trade_tracker/click'
+require 'trade_tracker/conversion'
+require 'trade_tracker/concerns/click.rb'
+require 'trade_tracker/concerns/conversion.rb'
+
+module TradeTracker
+  include ActiveSupport::Dependencies
+end

data/lib/trade_tracker/click.rb

@@ -0,0 +1,65 @@
+module TradeTracker
+  class Click
+    attr_reader :campaign_id, :material_id, :affiliate_id, :reference,
+                :redirect_url
+
+    def initialize(params)
+      if params[:campaignID]
+        self.campaign_id = params[:campaignID]
+        self.material_id = params[:material_id]
+        self.affiliate_id = params[:affiliate_id]
+        self.redirect_url = params[:redirect_url]
+      elsif params[:tt]
+        tracking_data = params[:tt].split('_')
+
+        self.campaign_id = tracking_data[0]
+        self.material_id = tracking_data[1]
+        self.affiliate_id = tracking_data[2]
+        self.reference = tracking_data[3]
+        self.redirect_url = params[:r]
+      end
+    end
+
+    def campaign_id=(value)
+      @campaign_id = value.to_s
+    end
+
+    def material_id=(value)
+      @material_id = value.to_s
+    end
+
+    def affiliate_id=(value)
+      @affiliate_id = value.to_s
+    end
+
+    def reference=(value)
+      @reference = CGI.escape value.to_s
+    end
+
+    def redirect_url=(value)
+      @redirect_url = CGI.escape value.to_s
+    end
+
+    def trackback_url
+      if campaign_id.present? || affiliate_id.present?
+        "http://tc.tradetracker.net/?c=#{campaign_id}&m=#{material_id}&a=#{affiliate_id}&r=#{reference}&u=#{redirect_url}"
+      end
+    end
+
+    def cookie_name
+      "TT2_#{campaign_id}"
+    end
+
+    def cookie_value
+      "#{material_id}::#{affiliate_id}::#{reference}::#{checksum}::#{Time.now.to_i}"
+    end
+
+    private
+
+    def checksum
+      Digest::MD5.hexdigest(
+        "CHK_#{campaign_id}::#{material_id}::#{affiliate_id}::#{reference}"
+      )
+    end
+  end
+end

data/lib/trade_tracker/concerns/click.rb

@@ -0,0 +1,35 @@
+module TradeTracker
+  module Concerns
+    module Click
+      extend ActiveSupport::Concern
+
+      def send_click_to_tradetracker
+        if tradetracker_click.trackback_url
+          redirect_to tradetracker_click.trackback_url
+        else
+          redirect_to root_path
+        end
+      end
+
+      private
+
+      def tradetracker_click
+        @click ||= TradeTracker::Click.new params
+      end
+
+      def set_cookies
+        # Apparently we need both a session/regular cookies, both with the same name/value
+        cookies[tradetracker_click.cookie_name] = {
+          value: tradetracker_click.cookie_value,
+          expires: Time.now + 31536000,
+          domain: request.host
+        }
+        session[tradetracker_click.cookie_name] = tradetracker_click.cookie_value
+      end
+
+      def set_p3p_header
+        response.headers['P3P'] = 'CP="ALL PUR DSP CUR ADMi DEVi CONi OUR COR IND"'
+      end
+    end
+  end
+end

data/lib/trade_tracker/concerns/conversion.rb

@@ -0,0 +1,50 @@
+require 'active_support/concern'
+
+module TradeTracker
+  module Concerns
+    module Conversion
+      extend ActiveSupport::Concern
+      attr_reader :conversion_image_parameters
+
+      included do
+        helper_method :conversion_image_tag
+      end
+
+      def conversion_image_tag
+        parameters = default_parameters.merge conversion_image_parameters
+        url = tradetracker_conversion_path parameters
+        ('<img src="%s" width="1" height="1" border="0" alt="" />' % url).html_safe
+      end
+
+      def send_conversion_to_tradetracker
+        redirect_to tradetracker_conversion.trackback_url
+      end
+
+      def set_conversion_image_parameters(parameters = {})
+        @conversion_image_parameters = parameters
+      end
+
+      private
+
+      def default_parameters
+        {
+          use_https: tradetracker_conversion.use_https,
+          campaign_id: tradetracker_conversion.campaign_id,
+          product_id: tradetracker_conversion.product_id,
+          conversion_type: tradetracker_conversion.conversion_type,
+          transaction_id: tradetracker_conversion.transaction_id,
+          transaction_amount: tradetracker_conversion.transaction_amount,
+          email: tradetracker_conversion.email,
+          quantity: tradetracker_conversion.quantity,
+          merchant_description: tradetracker_conversion.merchant_description,
+          affiliate_description: tradetracker_conversion.affiliate_description
+        }
+      end
+
+      def tradetracker_conversion
+        config = YAML.load_file('config/trade_tracker.yml')[Rails.env].symbolize_keys
+        @conversion ||= TradeTracker::Conversion.new params, config
+      end
+    end
+  end
+end

data/lib/trade_tracker/conversion.rb

@@ -0,0 +1,84 @@
+module TradeTracker
+  class Conversion
+    PARAMETERS = %w(use_https campaign_id product_id conversion_type tracking_data
+                tracking_type transaction_id transaction_amount quantity
+                email merchant_description affiliate_description)
+
+    def initialize(params, config = nil)
+      PARAMETERS.each do |p|
+        values = config && config.include?(p.to_sym) ? config : params
+        self.send "#{p}=", values[p.to_sym]
+
+        unless self.respond_to?(p)
+          self.class.send(:define_method, p, lambda {
+            instance_variable_get('@' + p)
+          })
+        end
+      end
+    end
+
+    def campaign_id=(value)
+      @campaign_id = value.to_s
+    end
+
+    def product_id=(value)
+      @product_id = value.to_s
+    end
+
+    def conversion_type=(value)
+      @conversion_type = value.to_s
+    end
+
+    def use_https
+      @use_https == 1
+    end
+
+    def use_https=(value)
+      @use_https = value.to_i
+    end
+
+    def tracking_data=(value)
+      @tracking_data = CGI.escape value.to_s
+    end
+
+    def tracking_type=(value)
+      @tracking_type = value.to_s
+    end
+
+    def transaction_id=(value)
+      @transaction_id = value.to_s
+    end
+
+    def transaction_amount=(value)
+      @transaction_amount = value.to_f
+    end
+
+    def quantity=(value)
+      @quantity = CGI.escape value.to_s
+    end
+
+    def email=(value)
+      @email = CGI.escape value.to_s
+    end
+
+    def merchant_description=(value)
+      @merchant_description = CGI.escape value.to_s
+    end
+
+    def affiliate_description=(value)
+      @affiliate_description = CGI.escape value.to_s
+    end
+
+    def trackback_url
+      if campaign_id.blank? || product_id.blank?
+        raise 'Wrong or missing parameters'
+      else
+        "#{use_https ? 'https' : 'http'}://#{conversion_type == 'lead' ? 'tl' : 'ts'}.tradetracker.net/?cid=#{campaign_id}&pid=#{product_id}&data=#{tracking_data}&type=#{tracking_type}&tid=#{transaction_id}&tam=#{transaction_amount}&qty=#{quantity}&eml=#{email}&descrMerchant=#{merchant_description}&descrAffiliate=#{affiliate_description}"
+      end
+    end
+
+    def cookie_name
+      "TT2_#{campaign_id}"
+    end
+  end
+end

data/lib/trade_tracker/version.rb

@@ -0,0 +1,3 @@
+module TradeTracker
+  VERSION = '0.1.0'
+end

data/spec/click_spec.rb

@@ -0,0 +1,94 @@
+require 'trade_tracker'
+
+describe TradeTracker::Click do
+  let(:instance) do
+    TradeTracker::Click.new(
+      campaignID: '14986',
+      material_id: '0',
+      affiliate_id: '18897',
+      reference: '',
+      r: 'http://www.google.be'
+    )
+  end
+
+  describe '#campaign_id' do
+    it 'result' do
+      instance.campaign_id = 1234
+      expect(instance.campaign_id).to eq '1234'
+    end
+
+    it 'blank' do
+      instance.campaign_id = 0
+      expect(instance.campaign_id).to eq '0'
+    end
+  end
+
+  describe '#affiliate_id' do
+    it 'result' do
+      instance.affiliate_id = 1234
+      expect(instance.affiliate_id).to eq '1234'
+    end
+
+    it 'blank' do
+      instance.affiliate_id = 0
+      expect(instance.affiliate_id).to eq '0'
+    end
+  end
+
+  describe '#material_id' do
+    it 'result' do
+      instance.material_id = 20
+      expect(instance.material_id).to eq '20'
+    end
+
+    it 'blank' do
+      instance.material_id = 0
+      expect(instance.material_id).to eq '0'
+    end
+  end
+
+  describe '#redirect_url' do
+    it 'filled' do
+      instance.redirect_url = 'http://www.google.be'
+      expect(instance.redirect_url).to eq 'http%3A%2F%2Fwww.google.be'
+    end
+
+    it 'blank' do
+      instance.redirect_url = nil
+      expect(instance.redirect_url).to eq ''
+    end
+  end
+
+  describe '#reference' do
+    it 'filled' do
+      instance.reference = 'X254'
+      expect(instance.reference).to eq 'X254'
+    end
+
+    it 'blank' do
+      instance.reference = nil
+      expect(instance.reference).to eq ''
+    end
+  end
+
+  it '#cookie_name' do
+    instance.campaign_id = 'foo'
+    expect(instance.cookie_name).to eq 'TT2_foo'
+  end
+
+  it '#cookie_value' do
+    expect(instance.cookie_value).to include '0::18897::::c83b23df3e4be73b2aa751dbd2fc248e::'
+  end
+
+  it '#trackback_url' do
+    expect(instance.trackback_url).to eq 'http://tc.tradetracker.net/?c=14986&m=0&a=18897&r=&u='
+  end
+
+  it '#respond_to?' do
+    expect(instance).to respond_to(
+      :campaign_id=, :campaign_id, :material_id=, :material_id, :affiliate_id=,
+      :affiliate_id, :reference=, :reference, :redirect_url=, :redirect_url,
+      :cookie_name, :cookie_value, :trackback_url
+    )
+  end
+end

data/spec/conversion_spec.rb

@@ -0,0 +1,91 @@
+require 'trade_tracker'
+
+describe TradeTracker::Conversion do
+  let(:instance) do
+    TradeTracker::Conversion.new(
+      campaign_id: '14986',
+      product_id: '22367',
+      conversion_type: 'sales',
+      use_https: '1'
+    )
+  end
+
+  describe '#campaign_id' do
+    it 'result' do
+      instance.campaign_id = 1234
+      expect(instance.campaign_id).to eq '1234'
+    end
+
+    it 'blank' do
+      instance.campaign_id = 0
+      expect(instance.campaign_id).to eq '0'
+    end
+  end
+
+  describe '#product_id' do
+    it 'result' do
+      instance.product_id = 20
+      expect(instance.product_id).to eq '20'
+    end
+
+    it 'blank' do
+      instance.product_id = 0
+      expect(instance.product_id).to eq '0'
+    end
+  end
+
+  describe '#conversion_type' do
+    it 'result' do
+      instance.conversion_type = 1234
+      expect(instance.conversion_type).to eq '1234'
+    end
+
+    it 'blank' do
+      instance.conversion_type = 0
+      expect(instance.conversion_type).to eq '0'
+    end
+  end
+
+  describe '#use_https' do
+    it 'true' do
+      expect(instance.use_https).to be true
+    end
+
+    it 'false' do
+      instance.use_https = '0'
+      expect(instance.use_https).to be false
+    end
+  end
+
+  it '#transaction_amount' do
+    instance.transaction_amount = '1234'
+    expect(instance.transaction_amount).to eq 1234.0
+  end
+
+  describe '#trackback_url' do
+    it 'no campaign ID' do
+      instance.campaign_id = nil
+      expect { instance.trackback_url }.to raise_error('Wrong or missing parameters')
+    end
+
+    it 'no product ID' do
+      instance.product_id = nil
+      expect { instance.trackback_url }.to raise_error('Wrong or missing parameters')
+    end
+
+    it 'result' do
+      expect(instance.trackback_url).to eq 'https://ts.tradetracker.net/?cid=14986&pid=22367&data=&type=&tid=&tam=0.0&qty=&eml=&descrMerchant=&descrAffiliate='
+    end
+  end
+
+  it '#respond_to?' do
+    expect(instance).to respond_to(
+      :campaign_id=, :campaign_id, :product_id=, :product_id, :conversion_type=,
+      :conversion_type, :use_https=, :use_https, :tracking_data=,
+      :tracking_data, :transaction_id=, :transaction_id, :transaction_amount=,
+      :transaction_amount, :quantity=, :quantity, :email=, :email,
+      :merchant_description=, :merchant_description, :affiliate_description=,
+      :affiliate_description, :trackback_url
+    )
+  end
+end

data/trade_tracker.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trade_tracker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'trade_tracker'
+  spec.version       = TradeTracker::VERSION
+  spec.authors       = ['Dave Lens']
+  spec.email         = ['dave@blimp.be']
+  spec.summary       = %q{This Rails gem wants to make the implementation of TradeTracker (click + conversion logging) easier.}
+  spec.description   = 'This Rails gem wants to make the implementation of TradeTracker (click + conversion logging) easier. It makes use of a few controller concerns and view helpers to provide conversion logging through an invisible image.'
+  spec.homepage      = 'https://github.com/blimp/trade_tracker'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rspec', '~> 2.6'
+
+  spec.add_dependency 'activesupport', '~> 4.2'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: trade_tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dave Lens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: This Rails gem wants to make the implementation of TradeTracker (click
+  + conversion logging) easier. It makes use of a few controller concerns and view
+  helpers to provide conversion logging through an invisible image.
+email:
+- dave@blimp.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/trade_tracker/config_generator.rb
+- lib/generators/trade_tracker/templates/trade_tracker.yml
+- lib/trade_tracker.rb
+- lib/trade_tracker/click.rb
+- lib/trade_tracker/concerns/click.rb
+- lib/trade_tracker/concerns/conversion.rb
+- lib/trade_tracker/conversion.rb
+- lib/trade_tracker/version.rb
+- spec/click_spec.rb
+- spec/conversion_spec.rb
+- trade_tracker.gemspec
+homepage: https://github.com/blimp/trade_tracker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: This Rails gem wants to make the implementation of TradeTracker (click +
+  conversion logging) easier.
+test_files:
+- spec/click_spec.rb
+- spec/conversion_spec.rb