ahoy_email 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 578ee3a9017fb411299f65ca92e63d99f62ba5c9
-  data.tar.gz: 4ac755f40d9b70edd52996057b0b090bb0187e16
+  metadata.gz: d6c59b97a0029bef3d6070fc62b01b4c6f79b476
+  data.tar.gz: 6cbc7dec76e337280204d5cb420e71a0b20b6a19
 SHA512:
-  metadata.gz: 12e9c5ff140a53e27945b82dff0f8175b452332b03d1fdf3745dc5039dc183c234f74463a5ec05f52ad50373f989b852eb640346ad57205fd75d966f9299854f
-  data.tar.gz: 2294b76fdd392c8fdd5472682db14aa7bc8bed7ad8bf017ab688ef5752b8fd22830daf185f2fb642253eb8f3763f892314ca88a99badd9381bad0cca69cac8a5
+  metadata.gz: 346a685b5fc9f4a3e743b845eb1d74faf69993e7a04c01ab01a971d4d7045f621c0699f311603f8b0f7d9704ca834cd6d20ecb249d71b55c93079886a96d7e9e
+  data.tar.gz: 4261c2b50159e022b7ec6875b27cfc37006702385771329446664be6cf17c5ba4ae1c9c7e2869b33b5127b76c81957a069c411b9207fd21072efd2a2123ce0ca

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.2.3
+
+- Save utm parameters
+- Added `url_options`
+- Skip tracking for `mailto` links
+- Only set secret token if not already set
+
 ## 0.2.2
 
 - Fixed secret token for Rails 4.1

data/Gemfile

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

data/README.md

@@ -206,6 +206,12 @@ Or by default
 AhoyEmail.track message: false
 ```
 
+Customize domain
+
+```ruby
+track url_options: {host: "mydomain.com"}
+```
+
 Use a different model
 
 ```ruby

data/Rakefile

@@ -1,2 +1 @@
 require "bundler/gem_tasks"
-

data/ahoy_email.gemspec

@@ -1,15 +1,15 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ahoy_email/version'
+require "ahoy_email/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "ahoy_email"
   spec.version       = AhoyEmail::VERSION
   spec.authors       = ["Andrew Kane"]
   spec.email         = ["andrew@chartkick.com"]
-  spec.summary       = %q{Simple, powerful email tracking for Rails}
-  spec.description   = %q{Simple, powerful email tracking for Rails}
+  spec.summary       = "Simple, powerful email tracking for Rails"
+  spec.description   = "Simple, powerful email tracking for Rails"
   spec.homepage      = "https://github.com/ankane/ahoy_email"
   spec.license       = "MIT"
 

data/app/controllers/ahoy/messages_controller.rb

@@ -3,7 +3,7 @@ module Ahoy
     before_filter :set_message
 
     def open
-      if @message and !@message.opened_at
+      if @message && !@message.opened_at
         @message.opened_at = Time.now
         @message.save!
       end
@@ -12,12 +12,12 @@ module Ahoy
     end
 
     def click
-      if @message and !@message.clicked_at
+      if @message && !@message.clicked_at
         @message.clicked_at = Time.now
         @message.opened_at ||= @message.clicked_at
         @message.save!
       end
-      url = params[:url]
+      url = params[:url].to_s
       signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha1"), AhoyEmail.secret_token, url)
       publish :click, url: params[:url]
       if secure_compare(params[:signature], signature)
@@ -54,6 +54,5 @@ module Ahoy
       b.each_byte { |byte| res |= byte ^ l.shift }
       res == 0
     end
-
   end
 end

data/lib/ahoy_email.rb

@@ -16,13 +16,14 @@ module AhoyEmail
     open: true,
     click: true,
     utm_params: true,
-    utm_source: proc {|message, mailer| mailer.mailer_name },
+    utm_source: proc { |message, mailer| mailer.mailer_name },
     utm_medium: "email",
     utm_term: nil,
     utm_content: nil,
-    utm_campaign: proc {|message, mailer| mailer.action_name },
-    user: proc{|message, mailer| (message.to.size == 1 ? User.where(email: message.to.first).first : nil) rescue nil },
-    mailer: proc{|message, mailer| "#{mailer.class.name}##{mailer.action_name}" }
+    utm_campaign: proc { |message, mailer| mailer.action_name },
+    user: proc { |message, mailer| (message.to.size == 1 ? User.where(email: message.to.first).first : nil) rescue nil },
+    mailer: proc { |message, mailer| "#{mailer.class.name}##{mailer.action_name}" },
+    url_options: {}
   }
 
   self.subscribers = []
@@ -31,14 +32,13 @@ module AhoyEmail
     self.options = self.options.merge(options)
   end
 
-  def self.message_model=(message_model)
-    @message_model = message_model
+  class << self
+    attr_writer :message_model
   end
 
   def self.message_model
     @message_model || Ahoy::Message
   end
-
 end
 
 ActionMailer::Base.send :include, AhoyEmail::Mailer

data/lib/ahoy_email/engine.rb

@@ -1,10 +1,8 @@
 module AhoyEmail
   class Engine < ::Rails::Engine
-
     initializer "ahoy_email" do |app|
       secrets = app.respond_to?(:secrets) ? app.secrets : app.config
-      AhoyEmail.secret_token = secrets.respond_to?(:secret_key_base) ? secrets.secret_key_base : secrets.secret_token
+      AhoyEmail.secret_token ||= secrets.respond_to?(:secret_key_base) ? secrets.secret_key_base : secrets.secret_token
     end
-
   end
 end

data/lib/ahoy_email/interceptor.rb

@@ -1,11 +1,9 @@
 module AhoyEmail
   class Interceptor
     class << self
-
       def delivering_email(message)
         AhoyEmail::Processor.new(message).track_send
       end
-
     end
   end
 end

data/lib/ahoy_email/mailer.rb

@@ -1,6 +1,5 @@
 module AhoyEmail
   module Mailer
-
     def self.included(base)
       base.extend ClassMethods
       base.class_eval do
@@ -26,6 +25,5 @@ module AhoyEmail
       AhoyEmail::Processor.new(message, self).process
       message
     end
-
   end
 end

data/lib/ahoy_email/processor.rb

@@ -9,15 +9,18 @@ module AhoyEmail
 
     def process
       action_name = mailer.action_name.to_sym
-      if options[:message] and (!options[:only] or options[:only].include?(action_name)) and !options[:except].to_a.include?(action_name)
+      if options[:message] && (!options[:only] || options[:only].include?(action_name)) && !options[:except].to_a.include?(action_name)
         @ahoy_message = AhoyEmail.message_model.new
         ahoy_message.token = generate_token
         ahoy_message.to = message.to.join(", ") if ahoy_message.respond_to?(:to=)
         ahoy_message.user = options[:user]
 
         track_open if options[:open]
-        track_links if options[:utm_params] or options[:click]
+        track_links if options[:utm_params] || options[:click]
 
+        ahoy_message.utm_source = options[:utm_source] if ahoy_message.respond_to?(:utm_source=)
+        ahoy_message.utm_medium = options[:utm_medium] if ahoy_message.respond_to?(:utm_medium=)
+        ahoy_message.utm_campaign = options[:utm_campaign] if ahoy_message.respond_to?(:utm_campaign=)
         ahoy_message.mailer = options[:mailer] if ahoy_message.respond_to?(:mailer=)
         ahoy_message.subject = message.subject if ahoy_message.respond_to?(:subject=)
         ahoy_message.content = message.to_s if ahoy_message.respond_to?(:content=)
@@ -92,17 +95,17 @@ module AhoyEmail
         doc = Nokogiri::HTML(body.raw_source)
         doc.css("a[href]").each do |link|
           # utm params first
-          if options[:utm_params] and !skip_attribute?(link, "utm-params")
+          if options[:utm_params] && !skip_attribute?(link, "utm-params")
             uri = Addressable::URI.parse(link["href"])
             params = uri.query_values || {}
-            %w[utm_source utm_medium utm_term utm_content utm_campaign].each do |key|
+            %w(utm_source utm_medium utm_term utm_content utm_campaign).each do |key|
               params[key] ||= options[key.to_sym] if options[key.to_sym]
             end
             uri.query_values = params
             link["href"] = uri.to_s
           end
 
-          if options[:click] and !skip_attribute?(link, "click")
+          if options[:click] && !skip_attribute?(link, "click")
             signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha1"), AhoyEmail.secret_token, link["href"])
             link["href"] =
               url_for(
@@ -133,13 +136,19 @@ module AhoyEmail
       elsif link["href"].to_s =~ /unsubscribe/i
         # try to avoid unsubscribe links
         true
+      elsif link["href"].to_s.start_with?("mailto:")
+        # mailto's shouldn't go through a redirect
+        true
       else
         false
       end
     end
 
-    def url_for(options)
-      AhoyEmail::Engine.routes.url_helpers.url_for((ActionMailer::Base.default_url_options || {}).merge(options))
+    def url_for(opt)
+      opt = (ActionMailer::Base.default_url_options || {})
+            .merge(options[:url_options])
+            .merge(opt)
+      AhoyEmail::Engine.routes.url_helpers.url_for(opt)
     end
 
     # not a fan of quiet errors
@@ -152,6 +161,5 @@ module AhoyEmail
         raise e
       end
     end
-
   end
 end

data/lib/ahoy_email/version.rb

@@ -1,3 +1,3 @@
 module AhoyEmail
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/lib/generators/ahoy_email/install_generator.rb

@@ -24,7 +24,6 @@ module AhoyEmail
       def copy_migration
         migration_template "install.rb", "db/migrate/create_ahoy_messages.rb"
       end
-
     end
   end
 end

data/lib/generators/ahoy_email/templates/install.rb

@@ -13,6 +13,9 @@ class <%= migration_class_name %> < ActiveRecord::Migration
       t.string :mailer
       t.text :subject
       t.text :content
+      t.string :utm_source
+      t.string :utm_medium
+      t.string :utm_campaign
 
       # timestamps
       t.timestamp :sent_at

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-31 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Simple, powerful email tracking for Rails