source_track 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rbenv-version

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Bryan Rehbein
+
+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,29 @@
+# SourceTrack
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'source_track'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install source_track
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/source_track.rb

@@ -0,0 +1,34 @@
+require 'source_track/version'
+require 'source_track/configuration'
+require 'source_track/token_parser'
+
+require 'source_track/railtie' if defined?(Rails::Railtie)
+
+module SourceTrack
+  class << self
+
+    # Configuration object. Must act like a hash and return sensible
+    # values for all configuration options.
+    attr_writer :configuration
+
+    # Call this method to modify defaults in your initializers.
+    #
+    # @example
+    #   SourceTrack.configure do |config|
+    #     config.use_dates      = true
+    #     config.signed_cookies = false
+    #   end
+    def configure(silent = false)
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def parser
+      @parser ||= TokenParser.new
+    end
+
+  end
+end

data/lib/source_track/configuration.rb

@@ -0,0 +1,76 @@
+require 'date'
+
+module SourceTrack
+  # Used to set up and modify settings for the notifier.
+  class Configuration
+
+    DEFAULT_SEPARATOR = "|"
+    DEFAULT_EPOCH = Date.new(2012,1,1)
+    DEFAULT_DATE_LENGTH = 4
+    OPTIONS = [:use_dates, :separator, :epoch, :date_length, :cookie_name, :http_only_cookies,
+               :cookie_path, :environment, :app_root, :logger].freeze
+
+    # Add a date component to the source token stored
+    attr_writer :use_dates
+
+    # Separator (can't be 0-9 A-F or other undesireables in cookies), default to pipe (|)
+    attr_writer :separator
+    
+
+    # Epoch date to use for hexdates
+    attr_accessor :epoch
+
+    # Length of hexdate (defaults to 4)
+    attr_accessor :date_length
+
+    # HTTP cookies
+    attr_accessor :cookie_name
+    attr_accessor :http_only_cookies
+    attr_accessor :cookie_path
+
+    # Application specifics
+    attr_accessor :environment
+    attr_accessor :app_root
+    attr_accessor :logger
+    
+    def initialize
+      @epoch = DEFAULT_EPOCH
+      @date_length = DEFAULT_DATE_LENGTH
+      @cookie_name = 'sct'
+      @http_only_cookies = true
+      @cookie_path = '/'
+    end
+
+    # Track data along with the source token
+    def use_dates
+      @use_dates || true
+    end
+    alias_method :use_dates?, :use_dates
+
+    def separator
+      @separator || DEFAULT_SEPARATOR
+    end
+
+    # Allows config options to be read like a hash
+    #
+    # @param [Symbol] option Key for a given attribute
+    def [](option)
+      send(option)
+    end
+
+    # Returns a hash of all configurable options
+    def to_hash
+      OPTIONS.inject({}) do |hash, option|
+        hash[option.to_sym] = self.send(option)
+        hash
+      end
+    end
+
+    # Returns a hash of all configurable options merged with +hash+
+    #
+    # @param [Hash] hash A set of configuration options that will take precedence over the defaults
+    def merge(hash)
+      to_hash.merge(hash)
+    end
+  end
+end

data/lib/source_track/rails.rb

@@ -0,0 +1,26 @@
+require 'source_track'
+require 'source_track/rails/controller_methods'
+
+module SourceTrack
+  module Rails
+
+    def self.initialize
+      if defined?(ActionController::Base)
+        ActionController::Base.send(:include, SourceTrack::Rails::ControllerMethods)
+      end
+
+      track_logger = if defined?(::Rails.logger)
+                       ::Rails.logger
+                     elsif defined?(RAILS_DEFAULT_LOGGER)
+                       RAILS_DEFAULT_LOGGER
+                     end
+
+      SourceTrack.configure(true) do |config|
+        config.logger = track_logger
+      end
+    end
+
+  end
+end
+
+SourceTrack::Rails.initialize

data/lib/source_track/rails/controller_methods.rb

@@ -0,0 +1,51 @@
+module SourceTrack
+  module Rails
+    module ControllerMethods
+
+      # TODO: It would be nice on page load (or before filter) to load an array of tokens accessible
+      #  inside the controller (maybe with extra methods like has_token?)
+      #  it would get parsed at the start of the request cycle (in the controller), any modifications would be
+      #  stored in an instance variable (i.e. track, clear, etc), state of dirty? would become true, then
+      #  when response is being generated, set the cookie if dirty? is true
+
+      # it would look similar to this (we would send a cookie with A9212 source token with today's date)
+      # before_filter :scene_track
+      # def show
+      #   track_source("A9212")
+      # end
+      #
+      # def signup
+      #   @user.sources = source_tokens
+      #   @user.super_important_person = true if source_tokens.has_source("VIP")  (should we also be able to filter by date?)
+      #   @user.save!
+      #   source_tokens.clear
+      #   redirect root_url
+      # end
+
+      # TODO - make sure the cookie is a far future expires
+      def track_source(token, options = {})
+        tokens = source_tokens
+        tokens << {:token => token, :date => Date.today}
+        cookies[SourceTrack.configuration.cookie_name] = {
+          :value => SourceTrack.parser.encode(tokens),
+          :http_only => SourceTrack.configuration.http_only_cookies,
+          :expires => 10.years.from_now
+        }
+      end
+
+      def source_tokens
+        @tokens ||= SourceTrack.parser.parse(cookies[SourceTrack.configuration.cookie_name])
+      end
+
+      def clear_tokens
+        cookies.delete SourceTrack.configuration.cookie_name
+      end
+
+      def has_source(token)
+        source_tokens.map{|m| m[:token]}.include?(token)
+      end
+      alias_method :has_source?, :has_source
+
+    end
+  end
+end

data/lib/source_track/railtie.rb

@@ -0,0 +1,25 @@
+require 'airbrake'
+require 'rails'
+
+module SourceTrack
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      #require 'source_track/rails/rake_tasks'
+    end
+
+    config.after_initialize do
+      SourceTrack.configure(true) do |config|
+        config.logger           ||= ::Rails.logger
+        config.environment      ||= ::Rails.env
+        config.app_root         ||= ::Rails.root
+      end
+
+      ActiveSupport.on_load(:action_controller) do
+        # Lazily load action_controller methods
+        #
+        require 'source_track/rails/controller_methods'
+        include SourceTrack::Rails::ControllerMethods
+      end
+    end
+  end
+end

data/lib/source_track/token_parser.rb

@@ -0,0 +1,70 @@
+require 'date'
+require 'open-uri'
+
+module SourceTrack
+  class TokenParser
+
+    # Take the string from the cookie and return the source tokens (token and optional date)
+    # ABC12300FA|CODE2300FB|CD2380    #( with dates, last 4 characters are hex )
+    # ABBC123|CODE23|CD       #( no dates )
+    # we MUST preserve order
+    def parse(v)
+      return [] if v.nil? || v.strip.empty?
+
+      tokens = []
+      v.split(config.separator).each do |t|
+        # validate the token is valid
+
+        if config.use_dates?
+          token, token_date = split_token_date(t, config.date_length)
+          tokens << {:token => token, :date => get_date(token_date, config.epoch)}
+        else
+          tokens << {:token => t}
+        end
+      end
+
+      tokens
+    end
+
+    # returns a string that can be set in the cookie
+    # we may or may not need to encode so the cookies work in all situations
+    def encode(tokens)
+      return nil if tokens.nil?
+      tokens = [tokens] unless tokens.is_a?(Array)
+
+      # TODO: tokens need to be unique (duplicates need to remain at the end), remember
+      #       the order from left to right is oldest to newest - any duplicates should always be newest
+      #       (i.e. if we 'track' a user using the same token on the same day 2x - the second visit's position
+      #       should be meaningful) -- i.e.  order of tracking => A, F, B, F, C  should encode as A|B|F|C, NOT A|F|B|C
+      tokens.map{|t| encode_token(t) }.join(config.separator)
+    end
+
+    private
+
+    def encode_token(token)
+      encoded_token = token[:token]
+      encoded_token += get_hex_date(token[:date], config.epoch) if (!token[:date].nil? && config.use_dates?)
+      encoded_token
+    end
+
+    def split_token_date(v, n)
+      # validate token
+      date_part = v[-n,n]
+      tok_part = v[0..(-n - 1)]
+      [tok_part, date_part]
+    end
+
+    def get_date(hex_date, epoch)
+      # validate hex_date
+      epoch + hex_date.hex
+    end
+
+    def get_hex_date(date, epoch)
+      sprintf("%04X", (date - epoch))
+    end
+
+    def config
+      SourceTrack.configuration
+    end
+  end
+end

data/lib/source_track/version.rb

@@ -0,0 +1,3 @@
+module SourceTrack
+  VERSION = "0.1.0"
+end

data/source_track.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/source_track/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Bryan Rehbein"]
+  gem.email         = ["bryan@siliconsea.net"]
+  gem.description   = %q{Gem to help understand a user's interaction with your site 
+                         and the influence of various referrals, promos, campaigns, etc.}
+  gem.summary       = %q{Track the influence that your marketing campaigns and referrals 
+                         have on your users.}
+  gem.homepage      = "https://github.com/redbeard0x0a/source_track"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "source_track"
+  gem.require_paths = ["lib"]
+  gem.version       = SourceTrack::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/spec/lib/configuration_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe SourceTrack::Configuration do
+  let(:config) { SourceTrack.configuration }
+
+  it "should initialize with the defaults" do
+    config.use_dates.should         be_true
+    config.separator.should         eq '|'
+    config.epoch.should             eq Date.new(2012,1,1)
+    config.date_length.should       eq 4
+    config.cookie_name.should       eq 'sct'
+    config.http_only_cookies.should be_true
+    config.cookie_path.should       eq '/'
+  end
+end

data/spec/lib/source_track_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe SourceTrack do
+  it "should initialize" do
+    SourceTrack.parser.should_not be_nil
+    SourceTrack.configuration.should_not be_nil
+  end
+end

data/spec/lib/token_parser_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe SourceTrack::TokenParser do
+
+  context "with use_dates" do
+    before(:each) do 
+      @parser = SourceTrack.parser
+    end
+
+    it "should encode a single token value" do
+      @parser.encode({:token => "ABC", :date => Date.new(2012,9,7)}).should eq "ABC00FA"
+    end
+
+    it "should encode an array of tokens" do
+      @parser.encode([
+        {:token => "BBC", :date => Date.new(2012,9,7)}, 
+        {:token => "WOWZA9828", :date => Date.new(2012,10,9)}
+        ]).should eq "BBC00FA|WOWZA9828011A"
+    end
+  end
+
+  context "without use_dates" do
+    before(:each) do 
+      @parser = SourceTrack.parser
+    end
+
+    it "encode a single token value" do
+      @parser.encode({:token => "ABC"}).should eq "ABC"
+    end
+
+    it "should encode an array of tokens" do
+      @parser.encode([
+        {:token => "39828ABO"}, {:token => "HOLF392"}
+        ]).should eq "39828ABO|HOLF392"
+    end
+
+    it "should encode an array of tokens" do
+      # @parser.encode([
+      #   {:token => "39828ABO", :date => Date.new(2012,9,7)}, 
+      #   {:token => "HOLF392", :date => Date.new(2012,10,9)}
+      #   ]).should eq "39828ABO|HOLF392"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'source_track'
+
+ENV["RAILS_ENV"] ||= 'test'
+ENV["RACK_ENV"]  ||= 'test'
+
+RSpec.configure do |config|
+  config.mock_with :rspec 
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: source_track
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bryan Rehbein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "Gem to help understand a user's interaction with your site \n                         and
+  the influence of various referrals, promos, campaigns, etc."
+email:
+- bryan@siliconsea.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/source_track.rb
+- lib/source_track/configuration.rb
+- lib/source_track/rails.rb
+- lib/source_track/rails/controller_methods.rb
+- lib/source_track/railtie.rb
+- lib/source_track/token_parser.rb
+- lib/source_track/version.rb
+- source_track.gemspec
+- spec/lib/configuration_spec.rb
+- spec/lib/source_track_spec.rb
+- spec/lib/token_parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/redbeard0x0a/source_track
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Track the influence that your marketing campaigns and referrals  have on
+  your users.
+test_files:
+- spec/lib/configuration_spec.rb
+- spec/lib/source_track_spec.rb
+- spec/lib/token_parser_spec.rb
+- spec/spec_helper.rb