ahoy_email 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 784f96fb14f9b6b23c849aa435ffbbf3acdac543
-  data.tar.gz: 6cc58343026c75ad6536665617838a5b593669ad
+  metadata.gz: 49c170ba212ecf55a91229da66bd709ae46845d3
+  data.tar.gz: 5c63a301d6ec6cb0d2f711a0398b3d0655eb2262
 SHA512:
-  metadata.gz: a19c3241eeaa13893da620b0eea2d35dda95948a5603591e33067de0805e0daad208929da1d6d6f86b26b1a6c93598e2c51536888d1a0215b93c9d6957651c84
-  data.tar.gz: cc06e0550beaff17574a3f57108cd444584c5d17eb7a91bc7efa8b81f7f2f42fe3cc8937c97110f8b1c09fa4a010cf60977d86c210d83730d7fbcc603c806d2f
+  metadata.gz: 5be291db638905583b8417f1a402083ae5c3d675b76acdc7a1115400510e2b9685ecbdea94d5ce6952daba528d4fff98e69650d95408e435aff6358ebe666439
+  data.tar.gz: 1f39a60bc2ec8a69c3584b0cbaa2888e5e055272d973f448aefa49dc7bb70d2c653dabccc15a7fdea01fed5cf493bba8b8f215918886acd6889d2a45fcb57a90

data/.gitignore

@@ -20,3 +20,5 @@ tmp
 *.o
 *.a
 mkmf.log
+*.log
+*.sqlite

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.3.0
+
+- Added safely for error reporting
+- Fixed error with `to`
+- Prevent duplicate records when mail called multiple times
+
 ## 0.2.4
 
 - Added `extra` option for extra attributes

data/README.md

@@ -116,7 +116,17 @@ Use `track utm_params: false` to skip tagging, or skip specific links with:
 
 ### Extra Attributes
 
-Create a migration to add extra attributes to the `ahoy_messages` table and use:
+Create a migration to add extra attributes to the `ahoy_messages` table, for example:
+
+```ruby
+class AddCampaignIdToAhoyMessages < ActiveRecord::Migration
+  def change
+    add_column :ahoy_messages, :campaign_id, :integer
+  end
+end
+```
+
+Then use:
 
 ```ruby
 track extra: {campaign_id: 1}

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: :test
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/ahoy_email.gemspec

@@ -18,10 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails"
-  spec.add_dependency "addressable"
-  spec.add_dependency "nokogiri"
+  spec.add_runtime_dependency "rails"
+  spec.add_runtime_dependency "addressable"
+  spec.add_runtime_dependency "nokogiri"
+  spec.add_runtime_dependency "safely_block"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "combustion"
+  spec.add_development_dependency "sqlite3"
 end

data/lib/ahoy_email.rb

@@ -1,8 +1,10 @@
 require "ahoy_email/version"
 require "action_mailer"
+require "rails"
 require "nokogiri"
 require "addressable/uri"
 require "openssl"
+require "safely_block"
 require "ahoy_email/processor"
 require "ahoy_email/interceptor"
 require "ahoy_email/mailer"

data/lib/ahoy_email/mailer.rb

@@ -21,6 +21,9 @@ module AhoyEmail
     end
 
     def mail_with_ahoy(headers = {}, &block)
+      # this mimics what original method does
+      return message if @_mail_was_called && headers.blank? && !block
+
       message = mail_without_ahoy(headers, &block)
       AhoyEmail::Processor.new(message, self).process
       message

data/lib/ahoy_email/processor.rb

@@ -10,44 +10,44 @@ module AhoyEmail
     end
 
     def process
-      action_name = mailer.action_name.to_sym
-      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] || options[:click]
-
-        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=)
-
-        UTM_PARAMETERS.each do |k|
-          ahoy_message.send("#{k}=", options[k.to_sym]) if ahoy_message.respond_to?("#{k}=")
-        end
+      safely do
+        action_name = mailer.action_name.to_sym
+        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 = Array(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] || options[:click]
+
+          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=)
+
+          UTM_PARAMETERS.each do |k|
+            ahoy_message.send("#{k}=", options[k.to_sym]) if ahoy_message.respond_to?("#{k}=")
+          end
 
-        ahoy_message.assign_attributes(options[:extra] || {})
+          ahoy_message.assign_attributes(options[:extra] || {})
 
-        ahoy_message.save
-        message["Ahoy-Message-Id"] = ahoy_message.id.to_s
+          ahoy_message.save
+          message["Ahoy-Message-Id"] = ahoy_message.id.to_s
+        end
       end
-    rescue => e
-      report_error(e)
     end
 
     def track_send
-      if (message_id = message["Ahoy-Message-Id"])
-        ahoy_message = AhoyEmail.message_model.where(id: message_id.to_s).first
-        if ahoy_message
-          ahoy_message.sent_at = Time.now
-          ahoy_message.save
+      safely do
+        if (message_id = message["Ahoy-Message-Id"])
+          ahoy_message = AhoyEmail.message_model.where(id: message_id.to_s).first
+          if ahoy_message
+            ahoy_message.sent_at = Time.now
+            ahoy_message.save
+          end
+          message["Ahoy-Message-Id"] = nil
         end
-        message["Ahoy-Message-Id"] = nil
       end
-    rescue => e
-      report_error(e)
     end
 
     protected
@@ -99,9 +99,10 @@ module AhoyEmail
 
         doc = Nokogiri::HTML(body.raw_source)
         doc.css("a[href]").each do |link|
+          uri = parse_uri(link["href"])
+          next unless trackable?(uri)
           # utm params first
           if options[:utm_params] && !skip_attribute?(link, "utm-params")
-            uri = Addressable::URI.parse(link["href"])
             params = uri.query_values || {}
             UTM_PARAMETERS.each do |key|
               params[key] ||= options[key.to_sym] if options[key.to_sym]
@@ -141,30 +142,28 @@ 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
 
+    # Filter trackable URIs, i.e. absolute one with http
+    def trackable?(uri)
+      uri && uri.absolute? && %w(http https).include?(uri.scheme)
+    end
+
+    # Parse href attribute
+    # Return uri if valid, nil otherwise
+    def parse_uri(href)
+      # to_s prevent to return nil from this method
+      Addressable::URI.parse(href.to_s) rescue nil
+    end
+
     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
-    # but tracking should *not* break
-    # email delivery in production
-    def report_error(e)
-      if Rails.env.production?
-        $stderr.puts e
-      else
-        raise e
-      end
-    end
   end
 end

data/lib/ahoy_email/version.rb

@@ -1,3 +1,3 @@
 module AhoyEmail
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

data/test/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/test/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/test/internal/db/schema.rb

@@ -0,0 +1,30 @@
+ActiveRecord::Schema.define do
+  create_table :ahoy_messages, force: true do |t|
+    t.string :token
+
+    # user
+    t.text :to
+    t.integer :user_id
+    t.string :user_type
+
+    # optional - feel free to remove
+    t.string :mailer
+    t.text :subject
+    t.text :content
+
+    # optional
+    t.string :utm_source
+    t.string :utm_medium
+    t.string :utm_term
+    t.string :utm_content
+    t.string :utm_campaign
+
+    # timestamps
+    t.timestamp :sent_at
+    t.timestamp :opened_at
+    t.timestamp :clicked_at
+  end
+
+  add_index :ahoy_messages, [:token]
+  add_index :ahoy_messages, [:user_id, :user_type]
+end

data/test/mailer_test.rb

@@ -0,0 +1,46 @@
+require_relative "test_helper"
+
+class UserMailer < ActionMailer::Base
+  after_action :prevent_delivery_to_guests, only: [:welcome2]
+
+  def welcome
+    mail to: "test@example.org", subject: "Hello", body: "World"
+  end
+
+  def welcome2
+    mail to: "test@example.org", subject: "Hello", body: "World"
+  end
+
+  private
+
+  def prevent_delivery_to_guests
+    mail.perform_deliveries = false
+  end
+end
+
+class MailerTest < Minitest::Test
+  def setup
+    Ahoy::Message.delete_all
+  end
+
+  def test_basic
+    assert_message :welcome
+  end
+
+  def test_prevent_delivery
+    assert_message :welcome2
+  end
+
+  def assert_message(method)
+    message = UserMailer.send(method)
+    message.to # trigger creation
+    ahoy_message = Ahoy::Message.first
+    assert_equal 1, Ahoy::Message.count
+    assert_equal "test@example.org", ahoy_message.to
+    assert_equal "UserMailer##{method}", ahoy_message.mailer
+    assert_equal "Hello", ahoy_message.subject
+    assert_equal "user_mailer", ahoy_message.utm_source
+    assert_equal "email", ahoy_message.utm_medium
+    assert_equal method.to_s, ahoy_message.utm_campaign
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require "bundler/setup"
+Bundler.require(:default)
+require "minitest/autorun"
+require "minitest/pride"
+require "combustion"
+
+Combustion.path = "test/internal"
+Combustion.initialize! :all

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2015-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: safely_block
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: combustion
+  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: sqlite3
+  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: Simple, powerful email tracking for Rails
 email:
 - andrew@chartkick.com
@@ -105,6 +161,11 @@ files:
 - lib/ahoy_email/version.rb
 - lib/generators/ahoy_email/install_generator.rb
 - lib/generators/ahoy_email/templates/install.rb
+- test/internal/config/database.yml
+- test/internal/config/routes.rb
+- test/internal/db/schema.rb
+- test/mailer_test.rb
+- test/test_helper.rb
 homepage: https://github.com/ankane/ahoy_email
 licenses:
 - MIT
@@ -125,9 +186,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Simple, powerful email tracking for Rails
-test_files: []
-has_rdoc: 
+test_files:
+- test/internal/config/database.yml
+- test/internal/config/routes.rb
+- test/internal/db/schema.rb
+- test/mailer_test.rb
+- test/test_helper.rb