ahoy_email 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ca8c4b534c78c9790f7f5d1a3c33138301b7123
-  data.tar.gz: 6131456a218ea53314bed0a6837b6c3b0701b69b
+  metadata.gz: 8d7461d3588d651ab3d225a8a599d9d09fb04cec
+  data.tar.gz: d39ee0ffe62f926206113aa73fd3afe622fd535d
 SHA512:
-  metadata.gz: 535f24ba504347ba5a86ecb78fbd837963d99cc50e88d396c6a9c703565964d2debd91e40a345cb4c3159d4a1c3c440d3dd9faf73869912f5ea2489dac941cfe
-  data.tar.gz: 17e044817fe7a3860d14a62f079c9aaca38803671eee9f6412506422653f37474aca70091efcc8f6fc3a4451c5a1ddb24241231970277ce98bc88461439e2211
+  metadata.gz: 1fb90d1b9f2615095e6ece4c9228ca7ea37092844861aef591b45abea856885ba8a1304ab657b2fc8b5479ffa74f72fe9f94861a05d06e11b0c8c930fd7666b6
+  data.tar.gz: c34afcb5fff0ff0054e9c62b30a884f735b0aef4e7ce3aa7150c3d80469ff1bc5cb673de1e5c2c9a975ecb629b6448685c84115f7e000a1d47832fe41d5671cf

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.3
+
+- Added `to` and `mailer` fields
+- Added subscribers for open and click events
+
 ## 0.1.2
 
 - Added `AhoyEmail.track` (fix)

data/README.md

@@ -142,6 +142,30 @@ end
 AhoyEmail.track open: false
 ```
 
+## Events
+
+Subscribe to open and click events. Create an initializer `config/initializers/ahoy_email.rb` with:
+
+```ruby
+class EmailSubscriber
+
+  def open(event)
+    # :message and :controller keys
+    ahoy = event[:controller].ahoy
+    ahoy.track "Email opened", message_id: event[:message].id
+  end
+
+  def click(event)
+    # same keys as above, plus :url
+    ahoy = event[:controller].ahoy
+    ahoy.track "Email clicked", message_id: event[:message].id, url: event[:url]
+  end
+
+end
+
+AhoyEmail.subscribers << EmailSubscriber.new
+```
+
 ## Reference
 
 You can use a `Proc` for any option.

data/app/controllers/ahoy/messages_controller.rb

@@ -7,16 +7,19 @@ module Ahoy
         @message.opened_at = Time.now
         @message.save!
       end
+      publish :open
       send_data Base64.decode64("R0lGODlhAQABAPAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="), type: "image/gif", disposition: "inline"
     end
 
     def click
       if @message and !@message.clicked_at
         @message.clicked_at = Time.now
+        @message.opened_at ||= @message.clicked_at
         @message.save!
       end
       url = params[:url]
       signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha1"), AhoyEmail.secret_token, url)
+      publish :click, url: params[:url]
       if secure_compare(params[:signature], signature)
         redirect_to url
       else
@@ -30,6 +33,16 @@ module Ahoy
       @message = AhoyEmail.message_model.where(token: params[:id]).first
     end
 
+    def publish(name, event = {})
+      AhoyEmail.subscribers.each do |subscriber|
+        if subscriber.respond_to?(name)
+          event[:message] = @message
+          event[:controller] = self
+          subscriber.send name, event
+        end
+      end
+    end
+
     # from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/message_verifier.rb
     # constant-time comparison algorithm to prevent timing attacks
     def secure_compare(a, b)

data/lib/ahoy_email.rb

@@ -9,7 +9,7 @@ require "ahoy_email/mailer"
 require "ahoy_email/engine"
 
 module AhoyEmail
-  mattr_accessor :secret_token, :options
+  mattr_accessor :secret_token, :options, :subscribers
 
   self.options = {
     message: true,
@@ -21,9 +21,12 @@ module AhoyEmail
     utm_term: nil,
     utm_content: nil,
     utm_campaign: proc {|message, mailer| mailer.action_name },
-    user: proc{|message, mailer| User.where(email: message.to.first).first rescue nil }
+    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}" }
   }
 
+  self.subscribers = []
+
   def self.track(options)
     self.options = self.options.merge(options)
   end

data/lib/ahoy_email/processor.rb

@@ -13,14 +13,16 @@ module AhoyEmail
       if options[:message]
         @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]
 
-        # save
+        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=)
+
         ahoy_message.save
         message["Ahoy-Message-Id"] = ahoy_message.id
       end

data/lib/ahoy_email/version.rb

@@ -1,3 +1,3 @@
 module AhoyEmail
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

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

@@ -4,11 +4,13 @@ class <%= migration_class_name %> < ActiveRecord::Migration
       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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-02 00:00:00.000000000 Z
+date: 2014-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails