persist_campaign 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDM4YWQ4N2YyY2FiY2UzZjA0ZjkyZTYyM2IxNzFkMDE4ZTY5MGI2ZQ==
+  data.tar.gz: !binary |-
+    MjdhMGM2YzAxYTMzMTRkYTg2NzgxMzNmYTQ4NWMwMTg4NzM5NTM0Yw==
+SHA512:
+  metadata.gz: !binary |-
+    YWJmMmEzNGMxNDhjMDJmYTJjZTc5NjcxZTVmNjhiNjhjZDI5ZThmNGIxZDUw
+    MWE0ZDYwOTA2NGE0NDc5MjkwOWVhZWEyYWJkYTBjOWUyNjEwYzA0MWY5OWIw
+    MjY3NWJlOGU4MjM0ZGRhY2IzZWZjOGJkN2M4NTYzMDE1NWI5OTE=
+  data.tar.gz: !binary |-
+    NTJlMTkzZDgxZjAyN2UwZTZlODU4YjI2NDgzMDI0NjEwMTViZjM3MTFjNTI0
+    YzExNjMxYjIyMWU4NzQzNzEyMjI4ZDdmMWFmYzRmZWE4ZWJkYWIzZWQ1NTg5
+    OGIzY2NmYzc1ZjIxOWJiMjk1NjE4ZDc1MzVlZmQ3NmQzMmRjM2M=

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andy Dust
+
+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,59 @@
+# PersistCampaign
+
+Persist campaign parameters - such as utm_campaign, utm_source, etc - on Rails redirect_to.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'persist_campaign'
+```
+
+And then execute:
+```sh
+$ bundle
+```
+
+## Default persisted keys
+
+* utm_campaign
+* utm_source
+* utm_medium
+* utm_content
+* utm_term
+* gclid (for Google Adwords)
+
+## Configure additional keys
+
+You can append to the key array in a configuration block. There is an install generator to create
+the initializer file.
+
+```sh
+rails g persist_campaign:install
+```
+
+Edit the initializer to append other keys:
+
+```ruby
+PersistCampaign.configure do |config|
+  config.keys += ['foo']
+end
+```
+
+## Testing
+```sh
+rake
+```
+
+## Credits
+Thanks to [ndp](http://github.com/ndp)'s [save-the-campaign](http://github.com/save-the-campaign) gem for
+providing the solution to patching Rail's redirect_to implemention. His solution is reproduced here under the
+MIT license.
+
+## Contributing
+
+1. Fork it ( http://github.com/mubi/persist_campaign/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 new Pull Request

data/Rakefile

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

data/lib/generators/persist_campaign/install_generator.rb

@@ -0,0 +1,12 @@
+module PersistCampaign
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      argument :name, type: :string, default: 'persist_campaign'
+
+      def create_initializer_file
+        template 'initializer.rb', "config/initializers/#{name}.rb"
+      end
+    end
+  end
+end

data/lib/generators/persist_campaign/templates/initializer.rb

@@ -0,0 +1,4 @@
+PeristCampaign.configure do |config|
+  # add addtional param keys to persist
+  # config.keys += [:foo, :bar]
+end

data/lib/persist_campaign/config.rb

@@ -0,0 +1,10 @@
+module PersistCampaign
+  class Config
+    attr_accessor :keys
+    DEFAULT_KEYS = %w{utm_campaign utm_source utm_term utm_medium utm_content gclid}
+
+    def initialize
+      @keys = DEFAULT_KEYS
+    end
+  end
+end

data/lib/persist_campaign/controller.rb

@@ -0,0 +1,25 @@
+module PersistCampaign
+  module Controller
+    def self.included base
+      base.send :include, InstanceMethods
+      base.alias_method_chain :_compute_redirect_to_location, :persist_campaign_params
+    end
+
+    module InstanceMethods
+      # Solution provided by ndp's save-the-campaign gem (http://github.com/ndp/save-the-campaign),
+      # reproduced here under the MIT license
+      def _compute_redirect_to_location_with_persist_campaign_params(options = {})
+        keys = PersistCampaign.config.keys.map(&:to_s)
+        to_persist = request.params.slice(*keys)
+        url = _compute_redirect_to_location_without_persist_campaign_params(options)
+
+        unless to_persist.empty?
+          url << (url =~ /\?/ ? '&' : '?')
+          url << to_persist.to_param
+        end
+
+        url
+      end
+    end
+  end
+end

data/lib/persist_campaign/railtie.rb

@@ -0,0 +1,9 @@
+module PersistCampaign
+  class Railtie < ::Rails::Railtie
+    initializer 'persist_campaign.controller' do
+      ActiveSupport.on_load(:action_controller) do
+        include PersistCampaign::Controller
+      end
+    end
+  end
+end

data/lib/persist_campaign/version.rb

@@ -0,0 +1,3 @@
+module PersistCampaign
+  VERSION = "0.0.1"
+end

data/lib/persist_campaign.rb

@@ -0,0 +1,15 @@
+require 'persist_campaign/version'
+require 'persist_campaign/config'
+require 'persist_campaign/controller'
+
+module PersistCampaign
+  def self.config
+    @config ||= PersistCampaign::Config.new
+  end
+
+  def self.configure(&block)
+    yield(config) if block_given?
+  end
+end
+
+require 'persist_campaign/railtie' if defined?(Rails)

data/persist_campaign.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'persist_campaign/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "persist_campaign"
+  spec.version       = PersistCampaign::VERSION
+  spec.authors       = ["Andy Dust"]
+  spec.email         = ["adust@mubi.com"]
+  spec.summary       = %q{Persist campaign parameters - such as utm_campaign, utm_source, etc - on Rails redirect_to.}
+  spec.description   = %q{This Rails gem allows you to persist analytics parameters through redirects. By default its
+                          persists utm_campaign, utm_source, utm_term, utm_medium, utm_content and gclid (for Google Adwords).
+                          Additional param keys can be configured.}
+  spec.homepage      = "http://github.com/mubi/persist_campaign"
+  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_runtime_dependency 'rails', '>= 3.1.12'
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec-rails', '~> 2.14'
+  spec.add_development_dependency 'generator_spec', '~> 0.9.2'
+end

data/spec/dummy/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'rails', '~> 3.1.12'
+gem 'persist_campaign', :path => '../../'

data/spec/dummy/app/controllers/example_controller.rb

@@ -0,0 +1,13 @@
+class ExampleController < ActionController::Base
+  def foo
+    redirect_to controller: :example, action: :bar
+  end
+
+  def action_with_params
+    redirect_to controller: :example, action: :bar, hello: 'world'
+  end
+
+  def bar
+    render nothing: true
+  end
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,15 @@
+require File.expand_path('../boot', __FILE__)
+
+require "action_controller/railtie"
+require "action_mailer/railtie"
+
+Bundler.require(*Rails.groups)
+
+module Dummy
+  class Application < Rails::Application
+  end
+end
+
+Rails.application.configure do
+  config.eager_load = false
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get ':controller(/:action(/:id))(.:format)'
+end

data/spec/dummy/config/secrets.yml

@@ -0,0 +1,22 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+development:
+  secret_key_base: 94eaac6bd057e82a5abb95fdff9f9828cd7660267ee3435c97ab8a3aeb621ac375003b5ff1548bc8590ec5f63ea393783e755163e9308c0b87f3c01eb5553783
+
+test:
+  secret_key_base: e1d13d4b689d5ed95eb2b03236260a3dd1e6e2123f8cd2951964846f9ba004d1d25de47f897437c79f6b9e354b7a1b8400d1b0ac4b85dcb72c720964e6060792
+
+# Do not keep production secrets in the repository,
+# instead read values from the environment.
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/generators/persist_campaign/install_generator_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'generator_spec'
+require 'generators/persist_campaign/install_generator'
+
+describe PersistCampaign::Generators::InstallGenerator do
+  include GeneratorSpec::TestCase
+  destination File.expand_path('../tmp', File.dirname(__FILE__))
+
+  before(:all) do
+    prepare_destination
+  end
+
+  it 'creates an initializer' do
+    run_generator
+    assert_file 'config/initializers/persist_campaign.rb'
+  end
+
+  context 'when a custom file name is provided as an argument' do
+    it 'creates an initializer with the specified file name' do
+      run_generator %w(foobar)
+      assert_file 'config/initializers/foobar.rb'
+    end
+  end
+end

data/spec/persist_campaign/config_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe PersistCampaign::Config do
+  subject(:config) { PersistCampaign::Config.new }
+
+  describe '.initialize' do
+    it 'assigns default param keys' do
+      expect(config.keys).to eq config.class::DEFAULT_KEYS
+    end
+  end
+end

data/spec/persist_campaign/controller_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe ExampleController, type: :controller do
+  before(:each) do
+    PersistCampaign.configure { |c| c.keys = %w{alpha beta} }
+  end
+  let(:params) { { alpha: '1', beta: '2' } }
+
+  it 'should persist specified params' do
+    get 'foo', params
+    expect(response).to redirect_to('/example/bar?alpha=1&beta=2')
+  end
+
+  it 'does not overwrite existing params' do
+    get 'action_with_params', params
+    expect(response).to redirect_to('/example/bar?hello=world&alpha=1&beta=2')
+  end
+
+  it 'ignores unconfigured params' do
+    get 'foo', params.merge(colour: 'red')
+    expect(response).to redirect_to('/example/bar?alpha=1&beta=2')
+  end
+
+  context 'with no params to persist' do
+    it 'redirects normally' do
+      get 'foo'
+      expect(response).to redirect_to('/example/bar')
+    end
+  end
+end

data/spec/persist_campaign_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe PersistCampaign do
+  it 'should be valid' do
+    expect(PersistCampaign).to be_a(Module)
+  end
+
+  describe '.config' do
+    it 'returns the configuration instance' do
+      expect(PersistCampaign.config).to be_a(PersistCampaign::Config)
+    end
+  end
+
+  describe '.configure' do
+    it 'yields to the config instance' do
+      expect { |b| PersistCampaign.configure(&b) }.to yield_with_args(PersistCampaign::Config)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path("../dummy/config/environment.rb", __FILE__)
+require 'rspec/rails'
+
+Rails.backtrace_cleaner.remove_silencers!
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: persist_campaign
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andy Dust
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.12
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: ! "This Rails gem allows you to persist analytics parameters through
+  redirects. By default its\n                          persists utm_campaign, utm_source,
+  utm_term, utm_medium, utm_content and gclid (for Google Adwords).\n                          Additional
+  param keys can be configured."
+email:
+- adust@mubi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/persist_campaign/install_generator.rb
+- lib/generators/persist_campaign/templates/initializer.rb
+- lib/persist_campaign.rb
+- lib/persist_campaign/config.rb
+- lib/persist_campaign/controller.rb
+- lib/persist_campaign/railtie.rb
+- lib/persist_campaign/version.rb
+- persist_campaign.gemspec
+- spec/dummy/Gemfile
+- spec/dummy/app/controllers/example_controller.rb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/generators/persist_campaign/install_generator_spec.rb
+- spec/persist_campaign/config_spec.rb
+- spec/persist_campaign/controller_spec.rb
+- spec/persist_campaign_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/mubi/persist_campaign
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Persist campaign parameters - such as utm_campaign, utm_source, etc - on
+  Rails redirect_to.
+test_files:
+- spec/dummy/Gemfile
+- spec/dummy/app/controllers/example_controller.rb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/generators/persist_campaign/install_generator_spec.rb
+- spec/persist_campaign/config_spec.rb
+- spec/persist_campaign/controller_spec.rb
+- spec/persist_campaign_spec.rb
+- spec/spec_helper.rb