feste 0.2.1

data/app/models/feste/subscription.rb

@@ -0,0 +1,64 @@
+module Feste
+  class Subscription < ActiveRecord::Base
+    belongs_to :subscriber, polymorphic: true
+
+    before_create :generate_token
+
+    # Return the propper subscription token based on the propper subscriber and
+    # email category
+    # @param [Subscriber, ActionMailer::Base, Symbol]
+    #
+    # If the subscription does not exist, one is created in order to return the
+    # token.  If the action is not categorized, then the subscription is not
+    # created, and nil is returned.
+    #
+    # @return [String, nil], the token or nil if a category cannot be found.
+    def self.get_token_for(subscriber, mailer, action)
+      transaction do
+        category = mailer.action_categories[action.to_sym] || 
+          mailer.action_categories[:all]
+        subscription = Feste::Subscription.find_or_create_by(
+          subscriber: subscriber,
+          category: category
+        )
+        subscription.token
+      end
+    end
+
+    # Return the subscriber based on an email address
+    # @param [String]
+    #
+    # @return [Subscriber, nil], the subscriber if one exists, or nil if none
+    # exists
+    def self.find_subscribed_user(email)
+      user_models.find do |model|
+        model.find_by(Feste.options[:email_source] => email)
+      end&.find_by(Feste.options[:email_source] => email)
+    end
+
+    # Return the human readable version of a category name.
+    #
+    # Checks to see if there is an i18n key corresponding to the category. If
+    # not, then the category is titleized.
+    #
+    # @return [String]
+    def category_name
+      I18n.t("feste.categories.#{category}", default: category.titleize)
+    end
+
+    private
+
+    def self.user_models
+      ActiveRecord::Base.descendants.select do |klass|
+        klass.included_modules.include?(Feste::User)
+      end
+    end
+
+    def generate_token
+      if !self.token
+        self.token = Base64.
+          urlsafe_encode64("#{category}|#{subscriber_id}|#{subscriber_type}")
+      end
+    end
+  end
+end

data/app/views/feste/subscriptions/index.html.erb

@@ -0,0 +1,42 @@
+<h3 class="subscriptions-tite">
+  Which emails would you like to keep receiving?
+</h3>
+<%= form_for @subscriber, url: subscriptions_path(token: params[:token]), method: :put, html: { id: "edit-subscriptions-form" } do |f| %>
+  <%= f.hidden_field Feste.options[:email_source], id: "subscriber-email" %>
+  <%= f.fields_for :subscriptions do |subscription_form| %>
+    <% @subscriber.subscriptions.order(category: :asc).each do |subscription| %>
+      <div class="subscription-category-container">
+        <%= label_tag do %>
+          <%= subscription_form.check_box(nil, {id: "subscription-#{subscription.category_name.parameterize}", checked: !subscription.canceled?}, subscription.id, nil) %>
+          <span class="subscription-category-name">
+            <%= subscription.category_name %>
+          </span>
+        <% end %>
+      </div>
+    <% end %>
+  <% end %>
+
+  <%= f.submit "Submit", class: "subscription-submit-button button button--submit" %>
+<% end %>
+
+<% if params[:token].present? %>
+  <div class="confirmation-modal-container hidden" id="confirmation-modal">
+    <div class="modal-overlay" data-js-modal-close="true">
+      <div class="modal-content">
+        <h4 class="modal-header">Please Confirm Your Email</h4>
+        <p class="modal-body">To continue, please verify your email address.</p>
+        <form action="#" class="cancel-subscription-form" id="cancel-subscription-form">
+          <div class="email-field-container" data-js-required="true">
+            <label class="error-label hidden" data-js-error="true">Please enter a valid email address</label>
+            <input type="text" name="email-confirmation-input" id="email-confirmation-input" class="email-field-input">
+          </div>
+          <button class="button button--submit" id="cofirm-submit-button">Confirm</button>
+        </form>
+      </div>
+    </div>
+  </div>
+
+  <script type="text/javascript">
+    subscriptionVerification();
+  </script>
+<% end %>

data/app/views/layouts/feste/application.html.erb

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Email Subscriptions</title>
+    <meta charset="utf-8" />
+    <%= stylesheet_link_tag "feste/application.css" %>
+    <%= javascript_include_tag "feste/application.js" %>
+  </head>
+
+  <body>
+    <div class="container">
+
+      <% if flash[:notice] || flash[:success] %>
+        <% message = flash[:notice] || flash[:success] %>
+          <h4 class="flash-message <%= flash[:notice].present? ? 'flash-notice' : 'flash-success' %>"><%= message %></h4>
+      <% end %>
+
+      <main class="main-body">
+        
+        <%= yield %>
+
+      </main>
+
+    </div>
+
+    <%= yield to: :javascript %>
+  </body>
+</html>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "feste"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,5 @@
+Feste::Engine.routes.draw do
+  get "/", to: "subscriptions#index", as: :subscriptions
+  put "/", to: "subscriptions#update"
+  patch "/", to: "subscriptions#update"
+end

data/feste.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'feste/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "feste"
+  spec.version       = Feste::VERSION
+  spec.authors       = ["Josh Reinhardt"]
+  spec.email         = ["joshua.e.reinhardt@gmail.com"]
+
+  spec.summary       = %q{Email subscription management for Rails applications.}
+  spec.description   = %q{Give your users the ability to manage their email subscriptions in your Rails application.}
+  spec.homepage      = "https://github.com/jereinhardt/feste"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", "~> 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "capybara-webkit"
+  spec.add_development_dependency "devise"
+  spec.add_development_dependency "factory_bot"
+  spec.add_development_dependency "factory_bot_rails"
+  spec.add_development_dependency "pg", "~> 0.18"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "shoulda-matchers"
+end

data/lib/feste/authentication/authentication.rb

@@ -0,0 +1,11 @@
+module Feste
+  module Authentication
+    module DefaultInstanceMethods
+      private
+      
+      def current_user
+        nil
+      end
+    end
+  end
+end

data/lib/feste/authentication/clearance.rb

@@ -0,0 +1,16 @@
+module Feste
+  module Authentication
+    module Clearance
+      private 
+
+      def current_user
+        ::Clearance.
+          configuration.
+          user_model.
+          where(remember_token: cookies[::Clearance.configuration.cookie_name]).
+          where.not(remember_token: nil).
+          first
+      end
+    end
+  end
+end

data/lib/feste/authentication/custom.rb

@@ -0,0 +1,11 @@
+module Feste
+  module Authentication
+    module Custom
+      private
+      
+      def current_user
+        Feste.options[:authenticate_with].call(self)
+      end
+    end
+  end
+end

data/lib/feste/authentication/devise.rb

@@ -0,0 +1,11 @@
+module Feste
+  module Authentication
+    module Devise
+      private
+
+      def current_user
+        main_app.scope.env['warden'].user
+      end
+    end
+  end
+end

data/lib/feste/engine.rb

@@ -0,0 +1,18 @@
+module Feste
+  class Engine < ::Rails::Engine
+    isolate_namespace Feste
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_bot, dir: "spec/factories"
+      g.assets false
+      g.helper false
+    end
+
+    initializer "feste" do |app|
+      app.config.assets.precompile << proc do |path| 
+        path =~ /\Afeste\/application\.(js|css)\z/
+      end
+    end
+  end
+end

data/lib/feste/mailer.rb

@@ -0,0 +1,127 @@
+module Feste
+  module Mailer    
+    def self.included(klass)
+      klass.include InstanceMethods
+      klass.extend ClassMethods
+      klass.send(:add_template_helper, TemplateHelper)
+      klass.class_eval do
+        class_attribute :action_categories
+        self.action_categories = {}
+      end
+    end
+
+    module InstanceMethods
+      # Returns a Mail object or nil based on if the action has been categorized
+      # and if the subscriber is unsubscribed
+      # @param [Hash, &block]
+      #
+      # The subscriber is supplied as an argument in the headers through the
+      # :subscriber key. The :subscriber key is stripped from the headers before
+      # they are given as an argument to the superclass.  If no subscriber is
+      # provided, then one will be inferred from the :to header.
+      #
+      # @return [Mail, nil], the Mail object or nil if the subscriber is
+      # unsubscribed
+      def mail(headers = {}, &block)
+        if current_action_category.present?
+          return message if @_mail_was_called && headers.blank? && !block
+
+          email = headers[:to].is_a?(String) ? headers[:to] : headers[:to].first
+          subscriber = headers[:subscriber] ||
+            Feste::Subscription.find_subscribed_user(email)
+          headers = headers.except(:subscriber)
+
+          if recipient_subscribed?(subscriber)
+            generate_subscription_token!(subscriber)
+            message = super(headers, &block)
+          else
+            nil
+          end          
+        else
+          super(headers, &block)
+        end
+      end
+
+      private
+
+      def current_action_category
+        self.action_categories[action_name.to_sym] || 
+          self.action_categories[:all]
+      end
+
+      def generate_subscription_token!(subscriber)
+        @_subscription_token ||= Feste::Subscription.
+          get_token_for(subscriber, self, action_name)
+      end
+
+      def recipient_subscribed?(subscriber)
+        !Feste::Subscription.find_or_create_by(
+          category: current_action_category,
+          subscriber: subscriber
+        )&.canceled?
+      end
+    end
+
+    module ClassMethods
+      # Assign action(s) to a category
+      # @param [Array, Symbol]
+      #
+      # The actions in the mailer that are included in the given category can be
+      # limited by listing them in an array of symbols.
+      #
+      #     class ReminderMailer < ActionMailer::Base
+      #       
+      #       categorize [:send_reminder, :send_update], as: :reminder_emails
+      #
+      #       def send_reminder(user)
+      #         ...
+      #       end
+      #
+      #       def send_update(user)
+      #         ...
+      #       end
+      #
+      #       def send_alert(user)
+      #         ...
+      #       end
+      #     end
+      #
+      #     ReminderMailer.action_categories => {
+      #       send_reminder: :reminder_emails,
+      #       send_update: :reminder_emails
+      #     }
+      #
+      # If no array is provided, all actions in the mailer will be categorized.
+      #
+      #     class ReminderMailer < ActionMailer::Base
+      #       
+      #       categorize as: :reminder_emails
+      #
+      #       def send_reminder(user)
+      #         ...
+      #       end
+      #
+      #       def send_update(user)
+      #         ...
+      #       end
+      #
+      #       def send_alert(user)
+      #         ...
+      #       end
+      #     end
+      #
+      #     ReminderMailer.action_categories => { all: :reminder_emails }
+      def categorize(meths = [], as:)
+        actions = meths.empty? ? [:all] : meths
+        actions.each { |action| self.action_categories[action.to_sym] = as }
+      end
+
+      def action_methods
+        feste_methods = %w[
+          action_categories action_categories= action_categories?
+        ]
+        Set.new(super - feste_methods)
+      end
+    end
+  end
+end

data/lib/feste/template_helper.rb

@@ -0,0 +1,16 @@
+module Feste
+  module TemplateHelper
+    # Return the absolute path to subscriptions#index with the proper
+    # subscription token to identify the subscriber.
+    #
+    # @return [String]
+    def subscription_url
+      host = Feste.options[:host] ||
+        ActionMailer::Base.default_url_options[:host]
+      Feste::Engine.routes.url_helpers.subscriptions_url(
+        token: @_subscription_token,
+        host: host
+      )
+    end
+  end
+end

data/lib/feste/user.rb

@@ -0,0 +1,23 @@
+module Feste
+  module User
+    def self.included(klass)
+      klass.include InstanceMethods
+      klass.class_eval do
+        has_many(
+          :subscriptions,
+          class_name: "Feste::Subscription",
+          as: :subscriber
+        )
+      end
+    end
+
+    module InstanceMethods
+      # Return the email address of the subscriber.
+      #
+      # @return [String]
+      def email_source
+        send(Feste.options[:email_source])
+      end
+    end
+  end
+end

data/lib/feste/version.rb

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

data/lib/feste.rb

@@ -0,0 +1,51 @@
+require "active_record"
+
+require "feste/version"
+require "feste/engine" if defined?(Rails)
+require "feste/authentication/authentication"
+require "feste/authentication/clearance"
+require "feste/authentication/custom"
+require "feste/authentication/devise"
+require "feste/user"
+require "feste/template_helper"
+require "feste/mailer"
+
+module Feste
+  mattr_accessor :options
+
+  def self.table_name_prefix
+    "feste_"
+  end
+
+  self.options = {
+    categories: [],
+    host: nil,
+    email_source: :email,
+    authenticate_with: nil
+  }
+
+  def self.configure
+    begin
+      yield(Config)
+    rescue NoConfigurationError => e
+      puts "FESTE CONFIGURATION WARNING: #{e}"
+    end
+  end
+
+  module Config
+    def self.method_missing(meth, *args, &block)
+      key = meth.to_s.slice(0, meth.to_s.length - 1).to_sym
+      if Feste.options.has_key?(key)
+        Feste.options[key] = args[0]
+      else
+        raise(
+          NoConfigurationError,
+          "There is no configuration option for #{key}"
+        )
+      end
+    end
+  end
+
+  class NoConfigurationError < StandardError
+  end
+end

data/lib/generators/feste/install_generator.rb

@@ -0,0 +1,40 @@
+require "rails/generators"
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+
+module Feste
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        if ActiveRecord::Base.timestamped_migrations
+          [
+            Time.now.utc.strftime("%Y%m%d%H%M%S"),
+            "%.14d" % next_migration_number
+          ].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      def copy_migration
+        migration_template(
+          "install.rb",
+          "db/migrate/install_feste.rb",
+          migration_version: migration_version
+        )
+      end
+
+      def migration_version
+        if ActiveRecord::VERSION::MAJOR >= 5
+          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :feste_subscriptions do |t|
+      t.integer :subscriber_id, null: false
+      t.string :subscriber_type, null: false
+      t.string :category, null: false
+      t.boolean :canceled, null: false, default: false
+      t.string :token, null: false
+    end
+  end
+end