google_analytics_mailer 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fabio Napoleoni
+
+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,87 @@
+# GoogleAnalyticsMailer
+
+This gem automatically rewrites **absolute** links generated by ActionMailer. It intercepts all'`url_for` calls (so `link_to` calls are intercepted as well) and change the final url to add [Custom Campaign parameters](http://support.google.com/analytics/bin/answer.py?hl=en&answer=1033867) to your URLs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'google_analytics_mailer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google_analytics_mailer
+
+## Usage
+
+There are three level of customization for rewritten links:
+
+ * **Class level:** Params specified at class level will appear on every link of every message generated by that class
+ * **Method level:** Params specified at method level will appear only on that message
+ * **View level:** Views level parameters will take the highest precedence and they will always override all the others
+
+In order to enable Google Analytics params for a given mailer you should simply add a line to a given mailer as in:
+
+```ruby
+class UserMailer < ActionMailer::Base
+  default :from => 'no-reply@example.com'
+
+  # declare url parameters for this mailer
+  google_analytics_mailer utm_source: 'newsletter', utm_medium: 'email' # etc
+
+  # Links in this email will have all links with GA params automatically inserted
+  def welcome
+    mail(to: 'user@example.com')
+  end
+end
+```
+
+Then in your view generate links as usual:
+
+```erb
+<!-- this will produce your-url?utm_medium=email&utm_source=newsletter because of class default params -->
+<%= link_to('Read online', newsletter_url) -%>
+<!-- local parameters are not overridden, so this produces ?utm_medium=email&utm_source=my_newsletter -->
+<%= link_to('Read online', newsletter_url(utm_source: 'my_newsletter')) -%>
+```
+
+In order to override params for a specific message you can override params in the method which defines
+the message as in:
+
+```ruby
+class UserMailer < ActionMailer::Base
+  default :from => 'no-reply@example.com'
+
+  # declare url parameters for this mailer
+  google_analytics_mailer utm_source: 'newsletter', utm_medium: 'email' # etc
+
+  # Links in this email will have utm_source equal to second_newsletter
+  def welcome
+    google_analytics_params(utm_source: 'second_newsletter', utm_term: 'welcome2')
+    mail(to: 'user@example.com')
+  end
+end
+```
+
+At view level you can override generated parameters using the `with_google_analytics_params` method
+
+```erb
+<div class="footer">
+  <%- with_google_analytics_params(utm_term: 'footer') do -%>
+    <!-- this will override other params and produces ?utm_medium=email&utm_source=newsletter&utm_term=footer -->
+    <%= link_to('Read online', newsletter_url) -%>
+  <%- end -%>
+</div>
+```
+
+## Contributing
+
+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

data/Rakefile

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

data/google_analytics_mailer.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google_analytics_mailer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "google_analytics_mailer"
+  gem.version       = GoogleAnalyticsMailer::VERSION
+  gem.authors       = ["Fabio Napoleoni"]
+  gem.email         = ["f.napoleoni@gmail.com"]
+  gem.description   = %q{This gem add google analytics campagin tags to every link in your action mailer}
+  gem.summary       = %q{This gem provides automatic Google Analytics tagged links in ActionMailer generated emails}
+  gem.homepage      = "https://github.com/fabn/google_analytics_mailer"
+
+  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.require_paths = ["lib"]
+
+  # gem dependencies for runtime
+  gem.add_runtime_dependency "addressable", "~> 2.3.0"
+  gem.add_runtime_dependency "actionmailer", "~> 3.2.0"
+
+  # gem dependencies for development
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 2.12.0"
+  gem.add_development_dependency "email_spec", "~> 1.2.0"
+end

data/lib/google_analytics_mailer/url_for.rb

@@ -0,0 +1,40 @@
+require "addressable/uri"
+
+module GoogleAnalyticsMailer # :nodoc:
+
+  # This module is added as helper to ActionMailer objects and override
+  # the url_for default implementation to insert GA params into generated links
+  module UrlFor
+
+    # Override default url_for method to insert ga params
+    #
+    # @return [String] the modified url
+    def url_for(original_url)
+      # Fetch final parameters calling private method
+      params_to_add = controller.computed_analytics_params.with_indifferent_access
+      # temporary override coming from with_google_analytics_params method
+      params_to_add.merge!(@_override_ga_params) if @_override_ga_params.try(:any?)
+      # if there are no parameters return super value
+      if params_to_add.empty?
+        super(original_url)
+      else
+        # else parse the url and append given parameters
+        ::Addressable::URI.parse(super(original_url)).tap do |url|
+          url.query_values = (url.query_values || {}).reverse_merge(params_to_add) if url.absolute?
+        end.to_s.html_safe
+      end
+    end
+
+    # Allow to override Google Analytics params for a given block in views
+    # @return [String]
+    def with_google_analytics_params(params)
+      raise ArgumentError, "Missing block" unless block_given?
+      @_override_ga_params = params
+      yield
+      @_override_ga_params = nil
+      nil # do not return any value
+    end
+
+  end
+
+end

data/lib/google_analytics_mailer/version.rb

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

data/lib/google_analytics_mailer.rb

@@ -0,0 +1,56 @@
+require "google_analytics_mailer/version"
+require "google_analytics_mailer/url_for"
+require "action_mailer"
+require "active_support/concern"
+
+# This module declares the main class method which is then callable from every
+# ActionMailer class
+module GoogleAnalyticsMailer
+
+  # These are the currently GA allowed get params for link tagging
+  VALID_ANALYTICS_PARAMS = [:utm_source, :utm_medium, :utm_campaign,
+                            :utm_term, :utm_content]
+
+  # Enable google analytics link tagging for the mailer which call this method
+  def google_analytics_mailer params = {}
+    if (params.keys - VALID_ANALYTICS_PARAMS).any?
+      raise ArgumentError, "Invalid parameters keys #{params.keys - VALID_ANALYTICS_PARAMS}"
+    end
+
+    # add accessor for class level parameters
+    cattr_accessor(:google_analytics_class_params) { params }
+
+    # include the module which provides the actual functionality
+    include GoogleAnalytics
+
+  end
+
+  # This module provides methods to deal with parameter merging and similar stuff
+  module GoogleAnalytics
+
+    # uses concern to include it
+    extend ActiveSupport::Concern
+
+    # this code is evaluated in class context
+    included do
+      helper GoogleAnalyticsMailer::UrlFor
+    end
+
+    # This method return the actual parameters to use when building links
+    # @return [Hash] computed parameters
+    def computed_analytics_params
+      @_computed_ga_params ||= self.class.google_analytics_class_params.merge(@_ga_instance_params || {})
+    end
+
+    private
+    # Instance level parameters, used only for the given message
+    def google_analytics_params params
+      @_ga_instance_params = params
+    end
+
+  end
+
+end
+
+# Add the class method to ActionMailer::Base
+ActionMailer::Base.send :extend, GoogleAnalyticsMailer

data/spec/lib/google_analytics_mailer_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe GoogleAnalyticsMailer do
+
+  it "ActionMailer::Base should extend GoogleAnalyticsMailer" do
+    (class << ActionMailer::Base; self end).included_modules.should include(GoogleAnalyticsMailer)
+  end
+
+  describe ".google_analytics_mailer" do
+
+    class TestMailer1 < ActionMailer::Base
+    end
+
+    it "should raise on invalid options for GA params" do
+      expect {
+        ActionMailer::Base.google_analytics_mailer(foo: 'bar')
+      }.to raise_error(ArgumentError, /:foo/)
+    end
+
+    it "should assign given parameters to a class variable" do
+      params = {utm_source: 'newsletter', utm_medium: 'email'}
+      TestMailer1.google_analytics_mailer(params)
+      TestMailer1.google_analytics_class_params.should == params
+    end
+
+  end
+
+  class UserMailer < ActionMailer::Base
+    default :from => 'no-reply@example.com'
+
+    # declare url parameters for this mailer
+    google_analytics_mailer utm_source: 'newsletter', utm_medium: 'email' # etc
+
+    # simulate url helper
+    helper do
+      def newsletter_url params = {}
+        'http://www.example.com/newsletter'.tap do |u|
+          u << "?#{params.to_param}" if params.any?
+        end.html_safe
+      end
+    end
+
+    # Links in this email will have all links with GA params automatically inserted
+    def welcome
+      mail(to: 'user@example.com')
+    end
+
+    def welcome2
+      google_analytics_params(utm_source: 'second_newsletter', utm_term: 'welcome2')
+      mail(to: 'user@example.com')
+    end
+
+    def welcome3
+      mail(to: 'user@example.com')
+    end
+
+  end
+
+  describe UserMailer do
+
+    # see view in spec/support/views/user_mailer/welcome.html.erb
+    describe "#welcome" do
+
+      subject { UserMailer.welcome }
+
+      it "should have analytics link with params taken from class definition" do
+        subject.should have_body_text 'http://www.example.com/newsletter?utm_medium=email&utm_source=newsletter'
+      end
+
+      it "should have analytics link with overridden params" do
+        subject.should have_body_text 'http://www.example.com/newsletter?utm_medium=email&utm_source=my_newsletter'
+      end
+
+    end
+
+    # see view in spec/support/views/user_mailer/welcome2.html.erb
+    describe "#welcome2" do
+
+      subject { UserMailer.welcome2 }
+
+      it "should have analytics link with params taken from instance" do
+        subject.should have_body_text 'http://www.example.com/newsletter?utm_medium=email&utm_source=second_newsletter&utm_term=welcome2'
+      end
+
+      it "should have analytics link with overridden params" do
+        subject.should have_body_text 'http://www.example.com/newsletter?utm_medium=email&utm_source=my_newsletter&utm_term=welcome2'
+      end
+
+    end
+
+    # see view in spec/support/views/user_mailer/welcome3.html.erb
+    describe "#welcome3" do
+
+      subject { UserMailer.welcome3 }
+
+      it "should have analytics link with params taken from view" do
+        subject.should have_body_text 'http://www.example.com/newsletter?utm_medium=email&utm_source=newsletter&utm_term=footer'
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+
+# Gem main file
+require 'google_analytics_mailer'
+require 'active_support/all'
+require 'email_spec'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |f| require f }
+
+# Configure action mailer for test deliveries
+ActionMailer::Base.delivery_method = :test
+# Configure action mailer view path
+ActionMailer::Base.view_paths = File.join(File.dirname(__FILE__), 'support', 'views')
+
+RSpec.configure do |config|
+
+  config.include EmailSpec::Helpers
+  config.include EmailSpec::Matchers
+
+end

data/spec/support/views/user_mailer/welcome.html.erb

@@ -0,0 +1,7 @@
+<h1>Newsletter title</h1>
+<div class="body">
+  <!-- this will produce ?utm_medium=email&utm_source=newsletter because of class default params -->
+  <%= link_to('Read online', newsletter_url) -%>
+  <!-- local parameters are not overridden, so this produces ?utm_medium=email&utm_source=my_newsletter -->
+  <%= link_to('Read online', newsletter_url(utm_source: 'my_newsletter')) -%>
+</div>

data/spec/support/views/user_mailer/welcome2.html.erb

@@ -0,0 +1,7 @@
+<h1>Newsletter title</h1>
+<div class="body">
+  <!-- this will produce ?utm_medium=email&utm_source=second_newsletter because of instance params -->
+  <%= link_to('Read online', newsletter_url) -%>
+  <!-- local parameters are not overridden, so this produces ?utm_medium=email&utm_source=my_newsletter -->
+  <%= link_to('Read online', newsletter_url(utm_source: 'my_newsletter')) -%>
+</div>

data/spec/support/views/user_mailer/welcome3.html.erb

@@ -0,0 +1,12 @@
+<h1>Newsletter title</h1>
+<div class="body">
+  <p>Lorem ipsum</p>
+</div>
+<div class="footer">
+  <%- with_google_analytics_params(utm_term: 'footer') do -%>
+    <!-- this will override params and produces ?utm_medium=email&utm_source=newsletter&utm_term=footer -->
+    <%= link_to('Read online', newsletter_url) -%>
+  <%- end -%>
+</div>
+
+

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: google_analytics_mailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Fabio Napoleoni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !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: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: email_spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: This gem add google analytics campagin tags to every link in your action
+  mailer
+email:
+- f.napoleoni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- google_analytics_mailer.gemspec
+- lib/google_analytics_mailer.rb
+- lib/google_analytics_mailer/url_for.rb
+- lib/google_analytics_mailer/version.rb
+- spec/lib/google_analytics_mailer_spec.rb
+- spec/spec_helper.rb
+- spec/support/views/user_mailer/welcome.html.erb
+- spec/support/views/user_mailer/welcome2.html.erb
+- spec/support/views/user_mailer/welcome3.html.erb
+homepage: https://github.com/fabn/google_analytics_mailer
+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'
+      segments:
+      - 0
+      hash: -1090596754510685876
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1090596754510685876
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem provides automatic Google Analytics tagged links in ActionMailer
+  generated emails
+test_files:
+- spec/lib/google_analytics_mailer_spec.rb
+- spec/spec_helper.rb
+- spec/support/views/user_mailer/welcome.html.erb
+- spec/support/views/user_mailer/welcome2.html.erb
+- spec/support/views/user_mailer/welcome3.html.erb