mailkick 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 902719cffa741b74a8efa92f326e98c5d359d610
-  data.tar.gz: 0a15d25bf9ea0201eabc5eeace46cba06b878596
+  metadata.gz: c06634c652c84b39afb65d63e54e58a57d212699
+  data.tar.gz: 30073ad89e0d42b83844a46822678058ca3b1bf2
 SHA512:
-  metadata.gz: b9e635f1f60c3eb5043450aea43133e6a9feb3cccaa1116ca4dfc769c73e1d0f51ecd7dec73d7fc5793f2893e08c4b66f8d774774ac5e2fd8326d890286a9b8b
-  data.tar.gz: f21ad8fed634b2e4bec5801df0a5d8b305656e4ff4922894461df36700fedb5f2f8704ad00c42e6b11ee2f2b6cd2f85affd3235038e0ff1ef2cd5a9600ceb1c2
+  metadata.gz: 018f990ddd1c587e4fcb791fc99b3d6767aeeb8b2eae51aa9e00017432172688bba7bc1adfab45071c540ad626953ccc6216513f4a6e74a7383858b06faebb2f
+  data.tar.gz: 62cd53b3f3395af21bf18086cf131d91b8625a4cd71a889792e7f053a96722b337928dbd0160b495d459717003dfdf50760d1484eb821b57cb22b3adb901d08a

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.0.3
+
+- Added support for multiple lists
+- Changed `mailkick_user` method names - sorry early adopters :(
+
 ## 0.0.2
 
 - Added Mailchimp service

data/README.md

@@ -62,33 +62,39 @@ class User < ActiveRecord::Base
 end
 ```
 
-Get all users who have not unsubscribed
+Get all users who have opted out
 
 ```ruby
-User.subscribed
+User.opted_out
+```
+
+And those who have not (send to these people)
+
+```ruby
+User.not_opted_out
 ```
 
 Check one user
 
 ```ruby
-user.subscribed?
+user.opted_out?
 ```
 
 Unsubscribe
 
 ```ruby
-user.unsubscribe
+user.opt_out
 ```
 
-Subscribe
+Resubscribe
 
 ```ruby
-user.subscribe
+user.opt_in
 ```
 
 ## Bounces and Spam Reports
 
-Pull bounces, spam reports, and unsubscribes from your email service.
+Fetch bounces, spam reports, and unsubscribes from your email service.
 
 ```ruby
 Mailkick.fetch_opt_outs
@@ -126,7 +132,7 @@ Will gladly accept pull requests.
 
 ### Advanced
 
-For more control over the services, set them by hand.
+For more control over services, set them by hand.
 
 ```ruby
 Mailkick.services = [
@@ -137,7 +143,61 @@ Mailkick.services = [
 
 ## Multiple Lists
 
-Coming soon
+You may want to split your emails into multiple categories, like sale emails and order reminders.
+
+Set the list in the mailer.
+
+```ruby
+class UserMailer < ActionMailer::Base
+
+  def order_reminder(user)
+    header[:mailkick_list] = "order_reminders"
+    # ...
+  end
+
+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")
+```
+
+### Opt-In Lists
+
+For opt-in lists, you’ll need to manage the subscribers yourself.
+
+Mailkick stores opt-outs, which you can combine with opt-ins.
+
+```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")
+```
 
 ## Bonus
 

data/app/controllers/mailkick/subscriptions_controller.rb

@@ -6,11 +6,12 @@ module Mailkick
     end
 
     def unsubscribe
-      if subscribed?
+      if !opted_out?
         Mailkick::OptOut.create! do |o|
           o.email = @email
           o.user = @user
           o.reason = "unsubscribe"
+          o.list = @list
         end
       end
 
@@ -22,8 +23,8 @@ module Mailkick
         opt_out.active = false
         opt_out.save!
       end
-      if @user and @user.respond_to?(:subscribe)
-        @user.subscribe
+      if @user and @user.respond_to?(:opt_in)
+        @user.opt_in(@options)
       end
 
       redirect_to subscription_path(params[:id])
@@ -34,24 +35,32 @@ module Mailkick
     def set_email
       verifier = ActiveSupport::MessageVerifier.new(Mailkick.secret_token)
       begin
-        @email, user_id, user_type = verifier.verify(params[:id])
+        @email, user_id, user_type, @list = verifier.verify(params[:id])
         if user_type
           # on the unprobabilistic chance user_type is compromised, not much damage
           @user = user_type.constantize.find(user_id)
         end
+        @options = {}
+        @options[:list] = @list if @list
       rescue ActiveSupport::MessageVerifier::InvalidSignature
         render text: "Subscription not found", status: :bad_request
       end
     end
 
-    def subscribed?
-      if @user and @user.respond_to?(:subscribed?)
-        @user.subscribed?
+    def opted_out?(options = {})
+      options = @options.merge(options)
+      if @user and @user.respond_to?(:opted_out?)
+        @user.opted_out?(options)
       else
-        Mailkick::OptOut.where(email: @email, active: true).empty?
+        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
     end
-    helper_method :subscribed?
+    helper_method :opted_out?
 
     def subscribe_url(options = {})
       subscribe_subscription_path(params[:id], options)

data/app/views/mailkick/subscriptions/show.html.erb

@@ -24,12 +24,12 @@
   </head>
   <body>
     <div class="container">
-      <% if subscribed? %>
-        <p>You are subscribed.</p>
-        <p><%= link_to "Unsubscribe", unsubscribe_url %></p>
-      <% else %>
+      <% if opted_out? %>
         <p>You are unsubscribed.</p>
         <p><%= link_to "Resubscribe", subscribe_url %></p>
+      <% else %>
+        <p>You are subscribed.</p>
+        <p><%= link_to "Unsubscribe", unsubscribe_url %></p>
       <% end %>
     </div>
   </body>

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

@@ -6,6 +6,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration
       t.string :user_type
       t.boolean :active, null: false, default: true
       t.string :reason
+      t.string :list
       t.timestamps
     end
 

data/lib/mailkick/model.rb

@@ -3,36 +3,54 @@ module Mailkick
 
     def mailkick_user(options = {})
       class_eval do
-        scope :subscribed, proc{ joins(sanitize_sql_array(["LEFT JOIN mailkick_opt_outs ON #{table_name}.email = mailkick_opt_outs.email OR (#{table_name}.id = mailkick_opt_outs.user_id AND mailkick_opt_outs.user_type = ?)", name])).where("active != ?", true).uniq }
-
-        def opt_outs
-          Mailkick::OptOut.where("email = ? OR (user_id = ? AND user_type = ?)", email, id, self.class.name)
-        end
+        scope :opted_out, proc {|options = {}|
+          binds = [self.class.name, true]
+          if options[:list]
+            query = "(list IS NULL OR list = ?)"
+            binds << options[:list]
+          else
+            query = "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)
+        }
+        scope :not_opted_out, proc {|options = {}|
+          opted_out(options.merge(not: true))
+        }
 
-        def subscribed?
-          opt_outs.where(active: true).empty?
+        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 subscribe
-          opt_outs.where(active: true).each do |opt_out|
-            opt_out.active = false
-            opt_out.save!
-          end
-          true
+        def opted_out?(options = {})
+          opt_outs(options).where(active: true).any?
         end
 
-        def unsubscribe
-          if subscribed?
+        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
         end
 
+        def opt_in(options = {})
+          opt_outs(options).where(active: true).each do |opt_out|
+            opt_out.active = false
+            opt_out.save!
+          end
+          true
+        end
+
       end
     end
 

data/lib/mailkick/processor.rb

@@ -9,9 +9,14 @@ module Mailkick
     def process
       email = message.to.first
       user = Mailkick.user_method.call(email) if Mailkick.user_method
+      list = message[:mailkick_list].try(:value)
+      if list
+        # remove header
+        message[:mailkick_list] = nil
+      end
 
       verifier = ActiveSupport::MessageVerifier.new(Mailkick.secret_token)
-      token = verifier.generate([email, user.try(:id), user.try(:class).try(:name)])
+      token = verifier.generate([email, user.try(:id), user.try(:class).try(:name), list])
 
       parts = message.parts.any? ? message.parts : [message]
       parts.each do |part|

data/lib/mailkick/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailkick
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-04 00:00:00.000000000 Z
+date: 2014-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler