ahoy_email 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d178d2bd4a2631bad0bce962cd35daecc019034270530f350596d14172e46ca0
-  data.tar.gz: af5eb88ec75a4100c5215a71e39fb825d7c7e4823fd601c3cd6473b7409db3dd
+  metadata.gz: 69eb9c77891a37c75ef7f7683211c90159cbb8aefd64fa14a0b1b35d2e16d0eb
+  data.tar.gz: a937ba8e9362d1c2551f5c193b9a3bbf1b4132f3df9ddb77f3f838f633fb2f07
 SHA512:
-  metadata.gz: bcc3ac25d9a8323a4da3a4331a338ca377a375033886c9e447945654897ea3b89e178ffe7a4e02336838ba27e1b8f8dda0aef0f5261f1adb8c66167dbe758f98
-  data.tar.gz: b433434716662eb90d9309c6dfdefe61752496777206e43d1d1d9ddadfee9aa664cf1daa1272d4df62a393d6e979e62932194829dd68b84720fd47661fada6e0
+  metadata.gz: 4b12c970be432d7db95fdb8eaade5766f69fc7826a94f41474ba5c2a35da1ea85b6317f83250cb1c8f41c7fe876028b1377958709d2c84ff9bd303926ac8ab5a
+  data.tar.gz: 96dcc647ee3777e27b14d7628025d96ea92efce7160d36da0b066b72d9dc5aac8196008699a93673d81d0fdcb909aa69874b349dffdbaf0e32e4d7511a32df5a

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.0.1 (2021-03-08)
+
+- Added database subscriber
+
 ## 2.0.0 (2021-03-06)
 
 - Made `to` field encrypted by default for new installations

data/README.md

@@ -200,7 +200,23 @@ Skip specific links with:
 
 ## Click Analytics
 
-You can track click-through rate to see how well campaigns are performing. Stats can be stored in any data store, and there’s a built-in integration with Redis.
+You can track click-through rate to see how well campaigns are performing. Stats can be stored in your database, Redis, or any other data store.
+
+#### Database
+
+Run:
+
+```sh
+rails generate ahoy:clicks
+rails db:migrate
+```
+
+And create `config/initializers/ahoy_email.rb` with:
+
+```ruby
+AhoyEmail.subscribers << AhoyEmail::DatabaseSubscriber
+AhoyEmail.api = true
+```
 
 #### Redis
 
@@ -232,7 +248,7 @@ class EmailSubscriber
     # your code
   end
 
-  def stats(campaign = nil)
+  def stats(campaign)
     # optional, for AhoyEmail.stats
   end
 end
@@ -241,7 +257,7 @@ AhoyEmail.subscribers << EmailSubscriber
 AhoyEmail.api = true
 ````
 
-### Setup
+### Usage
 
 Add to mailers you want to track
 
@@ -251,6 +267,8 @@ class CouponMailer < ApplicationMailer
 end
 ```
 
+If storing stats in the database, the mailer should also use `has_history`
+
 Use only and except to limit actions
 
 ```ruby
@@ -287,13 +305,7 @@ AhoyEmail.default_options[:url_options] = {host: "mydomain.com"}
 
 ### Stats
 
-Get stats for all campaigns
-
-```ruby
-AhoyEmail.stats
-```
-
-Get stats for a specific campaign
+Get stats for a campaign
 
 ```ruby
 AhoyEmail.stats("my-campaign")

data/app/models/ahoy/click.rb

@@ -0,0 +1,5 @@
+module Ahoy
+  class Click < ActiveRecord::Base
+    self.table_name = "ahoy_clicks"
+  end
+end

data/lib/ahoy_email.rb

@@ -16,6 +16,7 @@ require "ahoy_email/utils"
 require "ahoy_email/version"
 
 # subscribers
+require "ahoy_email/database_subscriber"
 require "ahoy_email/message_subscriber"
 require "ahoy_email/redis_subscriber"
 

data/lib/ahoy_email/database_subscriber.rb

@@ -0,0 +1,31 @@
+module AhoyEmail
+  class DatabaseSubscriber
+    def track_send(event)
+      # use has_history to store on Ahoy::Messages
+    end
+
+    def track_click(event)
+      Ahoy::Click.create!(campaign: event[:campaign], token: event[:token])
+    end
+
+    def stats(campaign)
+      sends = Ahoy::Message.where(campaign: campaign).count
+      result = Ahoy::Click.where(campaign: campaign).select("COUNT(*) AS clicks, COUNT(DISTINCT token) AS unique_clicks").to_a[0]
+      clicks = result.clicks
+      unique_clicks = result.unique_clicks
+
+      if sends > 0 || clicks > 0
+        {
+          sends: sends,
+          clicks: clicks,
+          unique_clicks: unique_clicks,
+          ctr: 100 * unique_clicks / sends.to_f
+        }
+      end
+    end
+
+    def campaigns
+      Ahoy::Message.where.not(campaign: nil).distinct.pluck(:campaign)
+    end
+  end
+end

data/lib/ahoy_email/redis_subscriber.rb

@@ -72,7 +72,7 @@ module AhoyEmail
         sends: sends.value.to_i,
         clicks: clicks.value.to_i,
         unique_clicks: unique_clicks.value,
-        ctr: (100.0 * unique_clicks.value / sends.value.to_f).round(1)
+        ctr: 100 * unique_clicks.value / sends.value.to_f
       }
     end
   end

data/lib/ahoy_email/version.rb

@@ -1,3 +1,3 @@
 module AhoyEmail
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/lib/generators/ahoy/clicks/activerecord_generator.rb

@@ -0,0 +1,20 @@
+require "rails/generators/active_record"
+
+module Ahoy
+  module Generators
+    module Clicks
+      class ActiverecordGenerator < Rails::Generators::Base
+        include ActiveRecord::Generators::Migration
+        source_root File.join(__dir__, "templates")
+
+        def copy_migration
+          migration_template "migration.rb", "db/migrate/create_ahoy_clicks.rb", migration_version: migration_version
+        end
+
+        def migration_version
+          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+        end
+      end
+    end
+  end
+end

data/lib/generators/ahoy/clicks/templates/migration.rb.tt

@@ -0,0 +1,11 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :ahoy_clicks do |t|
+      t.string :campaign, index: true
+      t.string :token
+    end
+
+    add_column :ahoy_messages, :campaign, :string
+    add_index :ahoy_messages, :campaign
+  end
+end

data/lib/generators/ahoy/clicks_generator.rb

@@ -0,0 +1,11 @@
+require "rails/generators"
+
+module Ahoy
+  module Generators
+    class ClicksGenerator < Rails::Generators::Base
+      def copy_templates
+        invoke "ahoy:clicks:activerecord"
+      end
+    end
+  end
+end

data/lib/generators/ahoy/messages_generator.rb

@@ -3,8 +3,6 @@ require "rails/generators"
 module Ahoy
   module Generators
     class MessagesGenerator < Rails::Generators::Base
-      source_root File.join(__dir__, "templates")
-
       class_option :unencrypted, type: :boolean
 
       def copy_templates

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-06 00:00:00.000000000 Z
+date: 2021-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -77,9 +77,11 @@ files:
 - LICENSE.txt
 - README.md
 - app/controllers/ahoy/messages_controller.rb
+- app/models/ahoy/click.rb
 - app/models/ahoy/message.rb
 - config/routes.rb
 - lib/ahoy_email.rb
+- lib/ahoy_email/database_subscriber.rb
 - lib/ahoy_email/engine.rb
 - lib/ahoy_email/mailer.rb
 - lib/ahoy_email/message_subscriber.rb
@@ -89,6 +91,9 @@ files:
 - lib/ahoy_email/tracker.rb
 - lib/ahoy_email/utils.rb
 - lib/ahoy_email/version.rb
+- lib/generators/ahoy/clicks/activerecord_generator.rb
+- lib/generators/ahoy/clicks/templates/migration.rb.tt
+- lib/generators/ahoy/clicks_generator.rb
 - lib/generators/ahoy/messages/activerecord_generator.rb
 - lib/generators/ahoy/messages/mongoid_generator.rb
 - lib/generators/ahoy/messages/templates/migration.rb.tt