feste 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 780ca4e3f5539ccc209639ad6c74c73b13c273a5a7caf22b1775c36339606445
-  data.tar.gz: a4b6d5c3ffbc86aaf53d08c5ee767121a66b26d4959b1036b35d3c90ce8338f6
+  metadata.gz: 2f1e50a574b4f37ee451f00c0865e6448dc38550d5a703ee66fe1428856b73a5
+  data.tar.gz: 840fe1442af14cc7a173320310c7d6ebcd33818a9c938bd0e0abdf0a493f3fe4
 SHA512:
-  metadata.gz: 8bb1dcf62ce31f4594b065cfd9ac5c8e4fc0df1fa7c83a345a2bf363432652469f84963f92b90fffe371ab429c760af824747889cf08601d45fade0b3b82f76f
-  data.tar.gz: 264e8a84f385e74f8f5cc0333546b6f2fa90b6bd30dab3ab72b0354ef8606124642bba0b314a73ccbdd7604d11adf0e999dd6190e4f8adaf6463fae811be0aa6
+  metadata.gz: c959555736853d7309b6cd8d96ef90f807aabf2e5b5f7a4319ba9e18261a7e4bbcee1b62a9e27d1e2b6a4a761faa28fa43a8b5e979cc095cff34ae81cdfefd62
+  data.tar.gz: bee0cb29c3aa769c3bdd6dd3fa3ad830f69c4ace1ed1ff6c2a6453530d79f178140af1a972a3fe63aad1e264b3bb393bc42482a7ae0f7b1b66c008ed1eceae94

data/README.md

@@ -48,6 +48,8 @@ Feste.configure do |config|
   config.email_source = :email
   # set the host for subscription_url
   config.host = ActionMailer::Base.default_url_options[:host]
+  # set callbacks
+  config.callback_handler = FesteCallbackHandler.new
 end
 ```
 ## Usage
@@ -137,6 +139,30 @@ en:
 
 It is recommended you DO NOT include any important emails, such as password reset emails, into a subscribable category.  It is also recommended you do not include the subscription link in any email that is sent to multiple recipients.  Though Feste comes with some security measures, it is assumed that each email is intended for only one recipient, and the `subscription_url` helper leads to a subsciption page meant only for that recipient.  Exposing this page to other users may allow them to change subscription preferences for someone else's account.
 
+## Callbacks
+
+If you would like to create callbacks for when a user unsubscribes or resubscribes to a mailing list, you can do so by creating a callback handler.  Callback handlers should be objects with two instance methods: `unsubscribe` and `resubscribe`.  You can register an instance of this object as your callback handler with the `callback_handler` configuration option.
+
+```ruby
+# config/initializers/feste.rb
+
+class CallbackHandler
+  def unsubscribe(event)
+    # This method is called whenever a user unsubscribes from an mailing list they were previously subscribed to.
+    event[:controller] # the instance of the controller
+    event[:subscriber] # the user that unsubscribed
+  end
+
+  def resubscribe(event)
+    # This method is called whenever a user subscribes to a mailing list they were previously unsubscribed to.
+  end
+end
+
+Feste.configure do |config|
+  config.callback_handler = CallbackHandler.new
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -152,4 +178,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jerein
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
-l create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+l create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/app/controllers/feste/subscriptions_controller.rb

@@ -11,7 +11,9 @@ module Feste
     end
 
     def update
+      events = set_callback_events
       if update_subscriptions
+        publish_callback_events(events)
         flash[:success] = "You have successfully updated your subscriptions!"
       else
         flash[:notice] = "Something went wrong!  Please try again later."
@@ -39,5 +41,54 @@ module Feste
       subscribed.update_all(canceled: false) && 
         unsubscribed.update_all(canceled: true)
     end
+
+    def set_callback_events
+      events = []
+      if Feste.options[:callback_handler].present?
+        events << unsubscribe_event if user_unsubscribing_from_emails?
+        events << resubscribe_event if user_resubscribing_to_emails?
+      end
+      events
+    end
+
+    def user_unsubscribing_from_emails?
+      subscription_ids = user_params[:subscriptions]&.map(&:to_i) || []
+      subscriber.subscriptions.where(canceled: false).pluck(:id).any? do |id|
+        !subscription_ids.include?(id)
+      end
+    end
+
+    def user_resubscribing_to_emails?
+      subscription_ids = user_params[:subscriptions]&.map(&:to_i) || []
+      subscriber.subscriptions.where(canceled: true).pluck(:id).any? do |id|
+        subscription_ids.include?(id)
+      end
+    end
+
+    def unsubscribe_event
+      {
+        name: :unsubscribe,
+        subscriber: subscriber,
+        controller: self
+      }
+    end
+
+    def resubscribe_event
+      {
+        name: :resubscribe,
+        subscriber: subscriber,
+        controller: self
+      }
+    end
+
+    def publish_callback_events(events)
+      if Feste.options[:callback_handler].present?
+        events.each do |event|
+          if Feste.options[:callback_handler].respond_to?(event[:name])
+            Feste.options[:callback_handler].public_send(event[:name], event)
+          end
+        end
+      end
+    end
   end
-end
+end

data/lib/feste.rb

@@ -21,7 +21,8 @@ module Feste
     categories: [],
     host: nil,
     email_source: :email,
-    authenticate_with: nil
+    authenticate_with: nil,
+    callback_handler: nil
   }
 
   def self.configure

data/lib/feste/version.rb

@@ -1,3 +1,3 @@
 module Feste
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feste
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Josh Reinhardt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-23 00:00:00.000000000 Z
+date: 2018-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails