google_analytics_mailer 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c79ec78f1bb79fdbac0163b6994a2e05ccb7cca5
-  data.tar.gz: b7cf7d0a4b3aef2f5abc0cef62a9b4cc2d6464d7
+  metadata.gz: 0023fcfa943b89987bbb9cfcd2c03cbe6c42114b
+  data.tar.gz: 84184569fc5b4d6aa38a0af45a74a90a3779535e
 SHA512:
-  metadata.gz: 995215ff6e64cf073191cea14726d22591756bec030aa7a4c45e3c3f472076aa1f4f9357aca46494a3705f3034b348a16d186b8ae981028203763b47f1f6d2e0
-  data.tar.gz: 704551ca2d01c8d33e8017263f4c3bd0425e5620373b494d97ff6ddb920b00262064d623a7edb035ab77bd979fad3052c0d71d20b63a4cc85c460a39722db1d6
+  metadata.gz: c9c0ec1c40f51bedd55765f3407df00d98549483737b6c23e500d088716f48f3777401d42c0ff7577324b8b6f285922c5b99cf293f115e0ab4120954e10ef705
+  data.tar.gz: 693da6b38cc7853e945f38202c6b12a3282274e8ae6851d3bfed798b6afee0b15aa2ad5d0deaff669ec908c896733f1ac1e15e3f2056a904cb204b70e22cb33b

data/.travis.yml

@@ -8,3 +8,4 @@ gemfile:
   - gemfiles/actionmailer3_2.gemfile
   - gemfiles/actionmailer4_0.gemfile
   - gemfiles/actionmailer4_1.gemfile
+  - gemfiles/actionmailer4_2.gemfile

data/Appraisals

@@ -9,3 +9,7 @@ end
 appraise 'actionmailer4_1' do
   gem 'actionmailer', '~> 4.1.0'
 end
+
+appraise 'actionmailer4_2' do
+  gem 'actionmailer', '~> 4.2.0'
+end

data/Changelog.md

@@ -1,5 +1,10 @@
 Not released changes
 
+## 0.3.0, released 2015-19-06
+
+* Added `filter` option to optionally filter URLs to rewrite. Thanks [afn](https://github.com/afn)
+* Testing support for ActionMailer 4.2
+
 ## 0.2.1, released 2014-11-06
 
 * Testing support for ActionMailer 4.1

data/Rakefile

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

data/gemfiles/actionmailer4_2.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "redcarpet"
+gem "yard"
+gem "coveralls", :require => false
+gem "rake"
+gem "rails", ">= 3.2.0"
+gem "rspec-rails", "~> 2.14.0"
+gem "email_spec", ">= 1.5.0"
+gem "appraisal", "~> 1.0.2"
+gem "actionmailer", "~> 4.2.0"
+
+group :test do
+  gem "sqlite3"
+  gem "minitest"
+end
+
+gemspec :path => "../"

data/lib/google_analytics_mailer/uri_builder.rb

@@ -2,6 +2,9 @@ require 'addressable/uri'
 
 # Class used to do the actual insertion of parameters
 class GoogleAnalyticsMailer::UriBuilder
+  def initialize(filter=nil)
+    @filter = filter
+  end
 
   # Append google analytics params to the given uri
   # @param [String] uri the original uri
@@ -17,9 +20,11 @@ class GoogleAnalyticsMailer::UriBuilder
     # if no params return untouched url
     return uri if params.empty?
     # build the final url
-    ::Addressable::URI.parse(uri).tap do |parsed|
-      parsed.query_values = (parsed.query_values || {}).reverse_merge(params) if parsed.absolute?
-    end.to_s.html_safe
+    parsed = ::Addressable::URI.parse(uri)
+    return uri if @filter && !@filter.call(parsed)
+
+    parsed.query_values = (parsed.query_values || {}).reverse_merge(params) if parsed.absolute?
+    parsed.to_s.html_safe
   end
 
 end

data/lib/google_analytics_mailer/url_for.rb

@@ -74,7 +74,7 @@ module GoogleAnalyticsMailer # :nodoc:
     # Return a UriBuilder instance
     # @return [UriBuilder]
     def builder
-      @_builder ||= UriBuilder.new
+      @_builder ||= UriBuilder.new controller.class.google_analytics_filter
     end
 
   end

data/lib/google_analytics_mailer/version.rb

@@ -1,4 +1,4 @@
 module GoogleAnalyticsMailer
   # Application version
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/google_analytics_mailer.rb

@@ -9,7 +9,7 @@ require 'active_support/concern'
 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]
+  VALID_ANALYTICS_PARAMS = [:utm_source, :utm_medium, :utm_campaign, :utm_term, :utm_content, :filter]
 
   # Enable google analytics link tagging for the mailer (or controller) which call this method
   #
@@ -24,12 +24,14 @@ module GoogleAnalyticsMailer
       raise ArgumentError, "Invalid parameters keys #{params.keys - VALID_ANALYTICS_PARAMS}"
     end
 
+    filter = params.delete(:filter)
+
     # add accessor for class level parameters
     cattr_accessor(:google_analytics_class_params) { params }
+    cattr_accessor(:google_analytics_filter) { filter }
 
     # include the module which provides the actual functionality
     include GoogleAnalytics
-
   end
 
   # Allow usage also in controllers since they have the same structure of ActionMailer

data/spec/helpers/url_for_spec.rb

@@ -4,6 +4,7 @@ describe GoogleAnalyticsMailer::UrlFor do
 
   before(:each) do
     controller.stub(computed_analytics_params: {utm_source: 'foo'})
+    controller.class.stub(google_analytics_filter: nil)
   end
 
   describe '#with_google_analytics_params' do

data/spec/lib/google_analytics_mailer_spec.rb

@@ -29,12 +29,9 @@ describe GoogleAnalyticsMailer do
 
   end
 
-  class UserMailer < ActionMailer::Base
+  class AbstractMailer < 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 = {}
@@ -57,7 +54,37 @@ describe GoogleAnalyticsMailer do
     def welcome3
       mail(to: 'user@example.com')
     end
+  end
+
+  class UserMailer < AbstractMailer
+    # declare url parameters for this mailer
+    google_analytics_mailer utm_source: 'newsletter', utm_medium: 'email' # etc
+  end
+
+  class FilteredMailer < AbstractMailer
+    # declare url parameters for this mailer
+    google_analytics_mailer utm_source: 'newsletter', utm_medium: 'email', filter: ->(uri) { uri.host == 'www.example.com' }
+  end
+
+  describe FilteredMailer do
+
+    # see view in spec/support/views/user_mailer/welcome.html.erb
+    describe '#welcome' do
+
+      subject { FilteredMailer.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
+
+      it 'should have non-http link with no tracking' do
+        subject.should have_body_text '"http://www.external.com/"'
+      end
+    end
   end
 
   describe UserMailer do

data/spec/lib/uri_builder_spec.rb

@@ -20,6 +20,18 @@ describe GoogleAnalyticsMailer::UriBuilder do
       subject.build('http://www.example.com', {}).should == 'http://www.example.com'
     end
 
+    context 'with a filter' do
+      subject { GoogleAnalyticsMailer::UriBuilder.new ->(uri) { uri.host == 'www.example.com' } }
+
+      it 'should add GA parameters to URIs that match the filter' do
+        subject.build('http://www.example.com', utm_campaign: 'Foo Bar').should include 'utm_campaign=Foo%20Bar'
+      end
+
+      it 'should not add GA parameters to URIs that do not match the filter' do
+        subject.build('http://www.external.com', utm_campaign: 'Foo Bar').should_not include 'utm_campaign=Foo%20Bar'
+      end
+    end
+
   end
 
 end

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

@@ -0,0 +1,9 @@
+<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')) %>
+  <!-- this will get filtered -->
+  <%= link_to('External link', 'http://www.external.com/') %>
+</div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_analytics_mailer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Fabio Napoleoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-06 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -59,6 +59,7 @@ files:
 - gemfiles/actionmailer3_2.gemfile
 - gemfiles/actionmailer4_0.gemfile
 - gemfiles/actionmailer4_1.gemfile
+- gemfiles/actionmailer4_2.gemfile
 - google_analytics_mailer.gemspec
 - lib/google_analytics_mailer.rb
 - lib/google_analytics_mailer/uri_builder.rb
@@ -68,6 +69,7 @@ files:
 - spec/lib/google_analytics_mailer_spec.rb
 - spec/lib/uri_builder_spec.rb
 - spec/spec_helper.rb
+- spec/support/views/filtered_mailer/welcome.html.erb
 - spec/support/views/user_mailer/welcome.html.erb
 - spec/support/views/user_mailer/welcome2.html.erb
 - spec/support/views/user_mailer/welcome3.html.erb
@@ -91,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: This gem provides automatic Google Analytics tagged links in ActionMailer
@@ -101,6 +103,7 @@ test_files:
 - spec/lib/google_analytics_mailer_spec.rb
 - spec/lib/uri_builder_spec.rb
 - spec/spec_helper.rb
+- spec/support/views/filtered_mailer/welcome.html.erb
 - spec/support/views/user_mailer/welcome.html.erb
 - spec/support/views/user_mailer/welcome2.html.erb
 - spec/support/views/user_mailer/welcome3.html.erb