mailkick 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c06634c652c84b39afb65d63e54e58a57d212699
-  data.tar.gz: 30073ad89e0d42b83844a46822678058ca3b1bf2
+  metadata.gz: 58457207d32f0dd9a131524e0a6461133c0fb702
+  data.tar.gz: ef4854e607a9a99da6513dfa823bb23b2c2f0162
 SHA512:
-  metadata.gz: 018f990ddd1c587e4fcb791fc99b3d6767aeeb8b2eae51aa9e00017432172688bba7bc1adfab45071c540ad626953ccc6216513f4a6e74a7383858b06faebb2f
-  data.tar.gz: 62cd53b3f3395af21bf18086cf131d91b8625a4cd71a889792e7f053a96722b337928dbd0160b495d459717003dfdf50760d1484eb821b57cb22b3adb901d08a
+  metadata.gz: 253736c9f9387dd4703188189ace226a6aab066591a2a0091cfdc81e9dacc3d078219551b8a088974d0c6376e1ab472d9267a588a4951b463a38abb68b2b9264
+  data.tar.gz: 800b46251c5dc872ff2ae6eb95a437eb9dfe5ccc5fec8a23751d3f0a23fbc6b484b7ebea813eafbba2928821e64a2306278a74d86bdedb6c242d73f49ebe38b1

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.0.4
+
+- Added `email_key` option to `mailkick_user`
+
 ## 0.0.3
 
 - Added support for multiple lists

data/README.md

@@ -54,7 +54,7 @@ which copies the view into `app/views/mailkick`.
 
 Before sending marketing emails, make sure the user has not opted out.
 
-Add the following the method to your user model.
+Add the following method to models with email addresses.
 
 ```ruby
 class User < ActiveRecord::Base
@@ -68,7 +68,7 @@ Get all users who have opted out
 User.opted_out
 ```
 
-And those who have not (send to these people)
+And those who have not - send to these people
 
 ```ruby
 User.not_opted_out
@@ -80,18 +80,6 @@ Check one user
 user.opted_out?
 ```
 
-Unsubscribe
-
-```ruby
-user.opt_out
-```
-
-Resubscribe
-
-```ruby
-user.opt_in
-```
-
 ## Bounces and Spam Reports
 
 Fetch bounces, spam reports, and unsubscribes from your email service.
@@ -161,23 +149,8 @@ end
 Pass the `list` option to methods.
 
 ```ruby
-# scopes
 User.opted_out(list: "order_reminders")
 User.not_opted_out(list: "order_reminders")
-
-# instance methods
-user.opted_out?(list: "order_reminders")
-user.opt_out(list: "order_reminders")
-user.opt_in(list: "order_reminders")
-```
-
-Omitting list (`nil` list) means all lists - including future lists (think “Unsubscribe All”).
-
-```ruby
-# opted out of all lists?
-user.opted_out?
-
-# opted out of the order reminder list *or* all lists?
 user.opted_out?(list: "order_reminders")
 ```
 
@@ -185,17 +158,15 @@ user.opted_out?(list: "order_reminders")
 
 For opt-in lists, you’ll need to manage the subscribers yourself.
 
-Mailkick stores opt-outs, which you can combine with opt-ins.
+Check opt-ins against the opt-outs
 
 ```ruby
-# opt-ins minus opt-outs
 User.where(send_me_sales: true).not_opted_out(list: "sales")
 ```
 
 Check one user
 
 ```ruby
-# opted in and didn't opt out
 user.send_me_sales && !user.opted_out?(list: "sales")
 ```
 
@@ -214,6 +185,24 @@ Change how the user is determined
 Mailkick.user_method = proc {|email| User.where(email: email).first }
 ```
 
+Use a different email field
+
+```ruby
+mailkick_user email_key: :email_address
+```
+
+Unsubscribe
+
+```ruby
+user.opt_out
+```
+
+Resubscribe
+
+```ruby
+user.opt_in
+```
+
 ## History
 
 View the [changelog](https://github.com/ankane/mailkick/blob/master/CHANGELOG.md)

data/app/controllers/mailkick/subscriptions_controller.rb

@@ -6,27 +6,12 @@ module Mailkick
     end
 
     def unsubscribe
-      if !opted_out?
-        Mailkick::OptOut.create! do |o|
-          o.email = @email
-          o.user = @user
-          o.reason = "unsubscribe"
-          o.list = @list
-        end
-      end
-
+      Mailkick.opt_out(email: @email, user: @user, list: @list)
       redirect_to subscription_path(params[:id])
     end
 
     def subscribe
-      Mailkick::OptOut.where(email: @email, active: true).each do |opt_out|
-        opt_out.active = false
-        opt_out.save!
-      end
-      if @user and @user.respond_to?(:opt_in)
-        @user.opt_in(@options)
-      end
-
+      Mailkick.opt_in(email: @email, user: @user, list: @list)
       redirect_to subscription_path(params[:id])
     end
 
@@ -48,17 +33,7 @@ module Mailkick
     end
 
     def opted_out?(options = {})
-      options = @options.merge(options)
-      if @user and @user.respond_to?(:opted_out?)
-        @user.opted_out?(options)
-      else
-        relation = Mailkick::OptOut.where(email: @email, active: true)
-        if options[:list]
-          relation.where("list IS NULL OR list = ?", options[:list])
-        else
-          relation.where("list IS NULL")
-        end.any?
-      end
+      Mailkick.opted_out?(@options.merge(options))
     end
     helper_method :opted_out?
 

data/lib/mailkick/model.rb

@@ -2,53 +2,32 @@ module Mailkick
   module Model
 
     def mailkick_user(options = {})
+      email_key = options[:email_key] || :email
       class_eval do
         scope :opted_out, proc {|options = {}|
           binds = [self.class.name, true]
           if options[:list]
-            query = "(list IS NULL OR list = ?)"
+            query = "(mailkick_opt_outs.list IS NULL OR mailkick_opt_outs.list = ?)"
             binds << options[:list]
           else
-            query = "list IS NULL"
+            query = "mailkick_opt_outs.list IS NULL"
           end
-          where("#{options[:not] ? "NOT " : ""}EXISTS(SELECT * FROM mailkick_opt_outs WHERE (#{table_name}.email = mailkick_opt_outs.email OR (#{table_name}.id = mailkick_opt_outs.user_id AND mailkick_opt_outs.user_type = ?)) AND active = ? AND #{query})", *binds)
+          where("#{options[:not] ? "NOT " : ""}EXISTS(SELECT * FROM mailkick_opt_outs WHERE (#{table_name}.#{email_key} = mailkick_opt_outs.email OR (#{table_name}.#{primary_key} = mailkick_opt_outs.user_id AND mailkick_opt_outs.user_type = ?)) AND mailkick_opt_outs.active = ? AND #{query})", *binds)
         }
         scope :not_opted_out, proc {|options = {}|
           opted_out(options.merge(not: true))
         }
 
-        def opt_outs(options = {})
-          relation = Mailkick::OptOut.where("email = ? OR (user_id = ? AND user_type = ?)", email, id, self.class.name)
-          if options[:list]
-            relation.where("list IS NULL OR list = ?", options[:list])
-          else
-            relation.where(list: nil)
-          end
-        end
-
         def opted_out?(options = {})
-          opt_outs(options).where(active: true).any?
+          Mailkick.opted_out?({email: email, user: self}.merge(options))
         end
 
         def opt_out(options = {})
-          if !opted_out?(options)
-            OptOut.create! do |o|
-              o.email = email
-              o.user = self
-              o.reason = "unsubscribe"
-              o.list = options[:list]
-              o.save!
-            end
-          end
-          true
+          Mailkick.opt_out({email: email, user: self}.merge(options))
         end
 
         def opt_in(options = {})
-          opt_outs(options).where(active: true).each do |opt_out|
-            opt_out.active = false
-            opt_out.save!
-          end
-          true
+          Mailkick.opt_in({email: email, user: self}.merge(options))
         end
 
       end

data/lib/mailkick/service.rb

@@ -8,13 +8,12 @@ module Mailkick
 
         opt_out = Mailkick::OptOut.where(email: email).order("updated_at desc").first
         if !opt_out or (time > opt_out.updated_at and !opt_out.active)
-          Mailkick::OptOut.create! do |o|
-            o.email = email
-            o.user = Mailkick.user_method if Mailkick.user_method.call(email)
-            o.reason = api_data[:reason]
-            o.created_at = time
-            o.updated_at = time
-          end
+          Mailkick.opt_out(
+            email: email,
+            user: Mailkick.user_method ? Mailkick.user_method.call(email) : nil,
+            reason: api_data[:reason],
+            time: time
+          )
         end
       end
       true

data/lib/mailkick/version.rb

@@ -1,3 +1,3 @@
 module Mailkick
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/mailkick.rb

@@ -7,6 +7,7 @@ require "mailkick/service"
 require "mailkick/service/mailchimp"
 require "mailkick/service/mandrill"
 require "mailkick/service/sendgrid"
+require "set"
 
 module Mailkick
   mattr_accessor :services, :user_method, :secret_token
@@ -27,6 +28,69 @@ module Mailkick
     end
   end
 
+  def self.opted_out?(options)
+    opt_outs(options).any?
+  end
+
+  def self.opt_out(options)
+    if !opted_out?(options)
+      time = options[:time] || Time.now
+      Mailkick::OptOut.create! do |o|
+        o.email = options[:email]
+        o.user = options[:user]
+        o.reason = options[:reason] || "unsubscribe"
+        o.list = options[:list]
+        o.created_at = time
+        o.updated_at = time
+      end
+    end
+    true
+  end
+
+  def self.opt_in(options)
+    opt_outs(options).each do |opt_out|
+      opt_out.active = false
+      opt_out.save!
+    end
+    true
+  end
+
+  def self.opt_outs(options = {})
+    relation = Mailkick::OptOut.where(active: true)
+
+    parts = []
+    binds = []
+    if (email = options[:email])
+      parts << "email = ?"
+      binds << email
+    end
+    if (user = options[:user])
+      parts << "user_id = ? and user_type = ?"
+      binds.concat [user.id, user.class.name]
+    end
+    if parts.any?
+      relation = relation.where(parts.join(" OR "), *binds)
+    end
+
+    relation =
+      if options[:list]
+        relation.where("list IS NULL OR list = ?", options[:list])
+      else
+        relation.where("list IS NULL")
+      end
+
+    relation
+  end
+
+  def self.opted_out_emails(options = {})
+    Set.new(opt_outs(options).where("email IS NOT NULL").uniq.pluck(:email))
+  end
+
+  # does not take into account emails
+  def self.opted_out_users(options = {})
+    Set.new(opt_outs(options).where("user_id IS NOT NULL").map(&:user))
+  end
+
 end
 
 ActionMailer::Base.send :include, Mailkick::Mailer

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailkick
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Andrew Kane