urchin_tracking_module 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3c243cb81d5e5a138bd70ae987d62c4bb6e577b
+  data.tar.gz: 12297e38face069f651f34ab7242b6908e8e9ca9
+SHA512:
+  metadata.gz: b333ab5a7088bbc1c373570bf6caf1a105c9dd7edc1827a0148b95ad6e0a1d59bd4af742d792e43868d09a2ca84d72abb449598feb498bb134bebecbcc575a22
+  data.tar.gz: 05d8a8a0c5c3e3be0c61c9c2e6065e5c63a684bcca392e868d9481c62965d76c2aa252af400cd230fd4600d3eb58d179b80091220252789d9dd7839c1f87ba5b

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/
+tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+urchin_tracking_module

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+- 2.0.0

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'active_support'
+
+group :test do
+  gem 'rspec'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    urchin_tracking_module (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    ffi (1.9.0)
+    formatador (0.2.4)
+    guard (1.8.3)
+      formatador (>= 0.2.4)
+      listen (~> 1.3)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-bundler (0.1.3)
+      bundler (>= 1.0.0)
+      guard (>= 0.2.2)
+    guard-rspec (3.0.3)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    listen (1.3.1)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.2)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    slop (3.4.6)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_support
+  bundler (~> 1.3)
+  guard-bundler
+  guard-rspec
+  rake
+  rspec
+  urchin_tracking_module!

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'bundler' do
+  watch('Gemfile')
+  # Uncomment next line if Gemfile contain `gemspec' command
+  # watch(/^.+\.gemspec/)
+end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -0,0 +1,58 @@
+# Urchin Tracking Module
+
+Add google analytics params to your URLs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'utm'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install utm
+
+## Usage
+
+    require 'utm'
+
+    UTM("http://example.com/#/welcome",
+      utm_source: "newsletter_de",
+      utm_medium: "email",
+      utm_term:   "fashion+leather",
+      utm_content: "Could be the subject line of your email",
+      utm_campaign: "winter_2013" )
+    => "http://example.com/?utm_source=newsletter_de&utm_medium=email&utm_term=fashion+leather&utm_content=Could+be+the+subject+line+of+your+email&utm_campaign=winter_2013#/welcome"
+
+## Contributing
+
+Your thought's/improvements are welcome :)
+
+1. Fork it
+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 new Pull Request
+
+## TODOs
+
+  * remove dependency to Rails
+  * remove bonusbox specific `src` param or make this kind of
+  additions configurable.
+  * `Utm.configure {|c| c[:utm_source] => nil }` would generate
+  invalid params. It should pick up defaults instead.
+  * `Utm.configure {|c| c[:utm_source] => 'my_app' }` could have a
+  configuration object instead of a hash, to become
+  `Utm.configure {|c| c.utm_source = 'my_app' }`
+
+## Code status
+
+* [![Build Status](https://api.travis-ci.org/bonusboxme/urchin_tracking_module.png)](https://travis-ci.org/bonusboxme/urchin_tracking_module)
+
+## License
+
+This `urchin_tracking_module` project is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/urchin_tracking_module/version.rb

@@ -0,0 +1,3 @@
+class UrchinTrackingModule
+  VERSION = "1.0.0"
+end

data/lib/urchin_tracking_module.rb

@@ -0,0 +1,91 @@
+require 'urchin_tracking_module/version'
+require 'singleton'
+require 'active_support/core_ext/hash/slice'
+
+def UTM(url, params={})
+  Utm.new(url).tracking(params)
+end
+
+class UrchinTrackingModule
+  TRACKING_PARAMETERS = %i(utm_source utm_medium utm_term utm_content utm_campaign)
+
+  def initialize(url)
+    @url = url
+  end
+
+  def tracking(params=defaults)
+    filtered_params(params).inject(@url) do |url,(name,value)|
+      url = add_param(url, "#{name}", value)
+      url = add_param(url, "src", value) if name == :utm_source
+      url
+    end
+  end
+
+  def defaults
+    Utm::Defaults.config
+  end
+  private :defaults
+
+  def filtered_params(params)
+    defaults.merge(params.slice(*TRACKING_PARAMETERS))
+  end
+  private :filtered_params
+
+  def add_param(url, param_name, param_value)
+    uri = URI(url)
+    params = url_params(uri).merge(param_name => param_value)
+    uri.query = URI.encode_www_form(params)
+    uri.to_s
+  end
+  private :add_param
+
+  def url_params(uri)
+    # conversion to hash e.g. to get rid of duplicate src params
+    params = URI.decode_www_form(uri.query || [])
+    params.inject(Hash.new) { |h,(k,v)| h.merge(k => v) }
+  end
+  private :url_params
+
+  def self.configure(&block)
+    Defaults.configure(&block)
+  end
+
+  def self.source
+    Defaults.config[:utm_source]
+  end
+
+  def self.medium
+    Defaults.config[:utm_medium]
+  end
+
+  class Defaults
+    include Singleton
+    attr_accessor :defaults
+
+    def self.configure(&block)
+      instance.configure(&block)
+    end
+
+    def self.config
+      instance.defaults
+    end
+
+    def initialize
+      self.defaults = { utm_source: default_source, utm_medium: default_medium  }
+    end
+
+    def configure
+      yield self.defaults
+    end
+
+    def default_source
+      Rails.application.class.parent_name
+    end
+    private :default_source
+
+    def default_medium
+      'mail'
+    end
+    private :default_medium
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+Dir["./support/**/*.rb"].each { |f| require f }
+
+unless defined?(Rails)
+  module Rails
+    class Application
+      def self.parent_name; "urchin_tracking_module" end
+    end
+    def self.application; Application.new end
+  end
+end
+
+RSpec.configure do |config|
+  config.order = "random"
+end

data/spec/urchin_tracking_module_spec.rb

@@ -0,0 +1,74 @@
+# Urchin Tracking Module
+require 'urchin_tracking_module'
+require 'uri'
+require 'spec_helper'
+
+describe UrchinTrackingModule do
+  Utm = UrchinTrackingModule
+  let(:params) {{}}
+  let(:url) { 'http://example.com?src=fba_blooming/#/shops' }
+  subject { Utm.new(url) }
+
+  context 'basic tracking' do
+    let(:params) {{
+        utm_source: 'transactional_emails',
+        utm_medium: 'email',
+        utm_term:   'electronics',
+        utm_content: 'variant_guy',
+        utm_campaign: 'xmas_2013' }}
+
+    Utm::TRACKING_PARAMETERS.each do |tracking_param|
+      it "tracks #{tracking_param}" do
+        uri = subject.tracking(params)
+        expect(uri).to match(/#{tracking_param}=#{params[tracking_param]}/)
+      end
+    end
+  end
+
+  describe '.configure' do
+    EXAMPLE_CONFIG = {
+      utm_source:   'b2b_application',
+      utm_medium:   'banner300',
+      utm_term:     'fashion',
+      utm_content:  'luxury_goods',
+      utm_campaign: 'spring_2014'
+    }
+
+    EXAMPLE_CONFIG.each do |(name,value)|
+      it "configures #{name}" do
+        Utm.configure { |utm| utm[name]= value }
+        expect(subject.tracking).to match(/#{name}=#{value}/)
+      end
+    end
+
+    it 'configures src' do
+      # checking for side effects and overrides
+      Utm.configure { |utm| utm[:utm_source]= 'funnel_source_for_bi' }
+      expect(subject.tracking).to match(/src=funnel_source_for_bi/)
+      expect(UTM(url, utm_source: 'pewpew')).to match(/src=pewpew/)
+      expect(UTM(url, utm_source: 'pewpew')).to match(/utm_source=pewpew/)
+      expect(subject.tracking).not_to match(/src=fba_blooming/)
+      expect(subject.tracking).to match(/utm_source=funnel_source_for_bi/)
+    end
+  end
+
+  it 'configures Utm.source' do
+    Utm.configure { |utm| utm[:utm_source]= EXAMPLE_CONFIG[:utm_source] }
+    expect(Utm.source).to eq EXAMPLE_CONFIG[:utm_source]
+  end
+
+  it 'configures Utm.medium' do
+    Utm.configure { |utm| utm[:utm_medium]= EXAMPLE_CONFIG[:utm_medium] }
+    expect(Utm.medium).to eq EXAMPLE_CONFIG[:utm_medium]
+  end
+
+  describe 'UTM helper' do
+    let(:utm) { double }
+
+    it 'invokes Utm' do
+      Utm.should_receive(:new).with(url).and_return(utm)
+      utm.should_receive(:tracking).with(params)
+      UTM(url,params)
+    end
+  end
+end

data/urchin_tracking_module.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'urchin_tracking_module/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "urchin_tracking_module"
+  spec.version       = UrchinTrackingModule::VERSION
+  spec.authors       = ["Jan Riethmayer"]
+  spec.email         = ["jan@riethmayer.de"]
+  spec.description   = %q{Add google analytics urchin tracking module params to your URL.}
+  spec.summary       = %q{utm params for your URL.}
+  spec.homepage      = "http://github.com/bonusboxme/urchin_tracking_module"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: urchin_tracking_module
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Riethmayer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add google analytics urchin tracking module params to your URL.
+email:
+- jan@riethmayer.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- lib/urchin_tracking_module.rb
+- lib/urchin_tracking_module/version.rb
+- spec/spec_helper.rb
+- spec/urchin_tracking_module_spec.rb
+- urchin_tracking_module.gemspec
+homepage: http://github.com/bonusboxme/urchin_tracking_module
+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.0.3
+signing_key: 
+specification_version: 4
+summary: utm params for your URL.
+test_files:
+- spec/spec_helper.rb
+- spec/urchin_tracking_module_spec.rb
+has_rdoc: