feste 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 780ca4e3f5539ccc209639ad6c74c73b13c273a5a7caf22b1775c36339606445
+  data.tar.gz: a4b6d5c3ffbc86aaf53d08c5ee767121a66b26d4959b1036b35d3c90ce8338f6
+SHA512:
+  metadata.gz: 8bb1dcf62ce31f4594b065cfd9ac5c8e4fc0df1fa7c83a345a2bf363432652469f84963f92b90fffe371ab429c760af824747889cf08601d45fade0b3b82f76f
+  data.tar.gz: 264e8a84f385e74f8f5cc0333546b6f2fa90b6bd30dab3ab72b0354ef8606124642bba0b314a73ccbdd7604d11adf0e999dd6190e4f8adaf6463fae811be0aa6

data/.gitignore

@@ -0,0 +1,35 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+/*.gem
+
+# rspec failure tracking
+.rspec_status
+
+# dummy app
+/spec/dummy/.bundle
+/spec/dummy/.byebug_history
+/spec/dummy/.env
+/spec/dummy/.yardoc
+/spec/dummy/coverage/
+/spec/dummy/doc/
+/spec/dummy/pkg/
+/spec/dummy/spec/reports/
+/spec/dummy/tags
+/spec/dummy/*.DS_STORE
+/spec/dummy/tmp/*
+/spec/dummy/log/*
+!/spec/dummy/log/.keep
+!/spec/dummy/tmp/.keep
+/spec/dummy/node_modules
+/spec/dummy/yarn-error.log
+/spec/dummy/public/system
+/spec/dummy/public/assets
+/spec/dummy/public/uploads

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in feste.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Josh Reinhardt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,155 @@
+:email: Feste is an easy way to give your users the ability to manage email subscriptions in your Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'feste'
+```
+
+And then execute:
+
+    $ bundle install
+    $ rails generate feste:install
+    $ rake db:migrate
+
+Once installed, you will need to mount Feste in your application.
+
+```ruby
+# config/routes.rb
+mount Feste::Engine => "/email-subscriptions", as: "feste"
+```
+
+## Configuration
+
+Feste organizes subscribable emails by separating them into categories that you define (see <a href="#mailer">Mailer</a> for more details).  This requires an array of available categories (represented by symbols) to be provided to the `categories` configuration.
+
+Out of the box, Feste allows your users to manage their subscriptions from a url in their email, which includes an identifying token.  If you would like for them to be able to do so from within your application, you will need to provide a method for identifying the currently logged in user.  Luckily, Feste provides authentication adapters for applications that use Devise and Clearance to manage user sessions.  Otherwise, you can provide a Proc to the `authenticate_with` option.
+
+Optionally, you can set the attribute your user model(s) use(s) to reference a user's email address (`email_source`) and the host that is used by the `subscriptions_url` helper (`host`).
+
+```ruby
+# initializers/feste.rb
+authentication_method = Proc.new do |controller|
+  ::User.find_by(id: controller.session[:user_id])
+end
+
+Feste.configure do |config|
+  # set your category names
+  config.categories = [:marketing_emails, :reminder_emails]
+  # for applications that use clearance
+  config.authenticate_with = :clearance
+  # for applications that use devise
+  config.authenticate_with = :devise
+  # for applications that use custom authentication
+  config.authenticate_with = authentication_method
+  # set the email attribute of your user model
+  config.email_source = :email
+  # set the host for subscription_url
+  config.host = ActionMailer::Base.default_url_options[:host]
+end
+```
+## Usage
+
+### Model
+
+In the model that holds your users' data, include `Feste::User`.
+
+```ruby
+class User < ApplicationRecord
+  include Feste::User
+end
+```
+
+This will give your user model a `has_many` relationship to `subscriptions`.  Since this relationship is polymorphic, your can include the `Feste::User` module in multiple models.  
+
+### Mailer
+
+In your mailer, include the `Feste::Mailer` module.
+
+Feste keeps track of email subscriptions by grouping mailer actions into categories that you define.  Your users will not be able to subscribe or unsubscribe to emails until you assign specific actions to a category.  In order to do this, you can call the `categorize` method within your mailer.  Doing so will automatically assign all actions in that mailer to the category you provide through the `as` option.
+
+When calling the `mail` method within an action, make sure to explicitly state which user the subscription should be applied to using the `subscriber` option.
+
+```ruby
+class CouponMailer < ApplicationMailer
+  include Feste::Mailer
+
+  categorize as: :marketing_emails
+
+  def send_coupon(user)
+    mail(to: user.email, from: "support@here.com", subscriber: user)
+  end
+end
+```
+
+If you only want to categorize specific actions in a mailer, you can do so by listing those actions in an array as your first arguement.
+
+```ruby
+class CouponMailer < ApplicationMailer
+  include Feste::Mailer
+
+  categorize [:send_coupon], as: :marketing_emails
+  categorize [:send_coupon_reminder], as: :reminder_emails
+
+  def send_coupon(user)
+    mail(to: user.email, from: "support@here.com", subscriber: user)
+  end
+
+  def send_coupon_reminder(user)
+    mail(to: user.email, from: "support@here.com", subscriber: user)
+  end
+end
+```
+
+### View
+
+#### Mailer View
+
+In our view file, you can use the helper method `subscription_url` to link to the page where users can manage their subscriptions.
+
+```html
+<a href="<%= subscription_url %>">click here to unsubscribe</a> 
+```
+
+When a user clicks this link, they are taken to a page that allows them to choose which emails (by category) they would like to keep receiving, and which ones they would like to unsubscribe to. 
+
+#### Application View
+
+The route to the subscriptions page is the root of the feste engine.  You can link to this page from anywhere in your app using the `feste.subscriptions_url` helper (assuming the engine is mounted as 'feste').  When a logged in user visits this page from your application, they will be authenticated through the method which you provide in the configuration, and shown their email subscriptions.
+
+### Human Readable Category Names
+
+In order to create category names that are human readable, add a `feste.categories`section to your i18n `locales` files.  Create keys in this section that correspond to the `categories` configuration.
+
+```yml
+# config/locales/en.yml
+
+en:
+  feste:
+    categories:
+      marketing_emails: Marketing Emails
+      reminder_emails: Reminder Emails
+```
+
+### When not to use
+
+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.
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jereinhardt/feste.
+
+
+## License
+
+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).

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require "bundler/gem_tasks"
+require "rspec/core"
+require "rspec/core/rake_task"
+require "pg"
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(spec: "app:db:test:prepare")
+
+task :default => :spec

data/app/assets/javascripts/feste/application.js

@@ -0,0 +1 @@
+//= require_tree .

data/app/assets/javascripts/feste/subscription-verification.js

@@ -0,0 +1,72 @@
+subscriptionVerification = (function () {
+  return function () {
+    var $form = document.getElementById("edit-subscriptions-form");
+    var $modal = document.getElementById("confirmation-modal");
+
+    $form.addEventListener("submit", handleMainFormSubmission);
+
+    function handleMainFormSubmission(event) {
+      event.preventDefault();
+      openModal($modal);
+    }
+
+    function openModal($modalContainer) {
+      $modalContainer.classList.remove("hidden");
+      bindModalEvents($modalContainer);
+    }
+
+    function closeModal($modalContainer) {
+      $modalContainer.className += " hidden";
+      unbindModalEvents($modalContainer);
+    }
+
+    function bindModalEvents($modalContainer) {
+      var $closeButtons = $modalContainer.querySelectorAll("[data-js-modal-close]");
+      for (var i = 0; i < $closeButtons.length; i ++) {
+        var $button = $closeButtons[i];
+        $button.addEventListener("click", function(event) {
+          if ( event.target == event.currentTarget ) {
+            event.preventDefault();
+            closeModal($modalContainer);  
+          }        
+        });
+      }
+
+      var $confirmForm = document.getElementById("cancel-subscription-form");
+      $confirmForm.addEventListener("submit", handleConfirmFormSubmission);
+    }
+
+    function unbindModalEvents($modalContainer) {
+      var $closeButtons = $modalContainer.querySelectorAll("[data-js-modal-close]");
+      for (var i = 0; i < $closeButtons.length; i ++) {
+        var $button = $closeButtons[i];
+        $button.removeEventListener("click", function(event) {
+          if ( event.target == event.currentTarget ) {
+            event.preventDefault();
+            closeModal($modalContainer);  
+          }        
+        });
+      }
+
+      var $confirmForm = document.getElementById("cancel-subscription-form");
+      $confirmForm.removeEventListener("submit", handleConfirmFormSubmission);
+    }
+
+    function handleConfirmFormSubmission(event) {
+      event.preventDefault();
+      var $form = event.target;
+      var $input = document.getElementById("email-confirmation-input");
+      var $required = $form.querySelectorAll("[data-js-required]")[0];
+      var $errorMessage = $required.querySelectorAll("[data-js-error]")[0];
+      var val = $required.querySelectorAll("input")[0].value;
+      var email = document.getElementById("subscriber-email").value
+      $errorMessage.className += " hidden";
+      if (!val || val != email) {
+        $errorMessage.classList.remove("hidden");
+      } else {
+        var $mainForm = document.getElementById("edit-subscriptions-form");
+        $mainForm.submit();
+      }
+    }
+  }   
+})();

data/app/assets/stylesheets/feste/application.css

@@ -0,0 +1,4 @@
+ /*
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/feste/base.css

@@ -0,0 +1,150 @@
+body {
+  background: transparent;
+  color: #4f4d4b;
+  font-family: "Whitney A", "Whitney B", "Helvetica Neue", "Helvetica", "Roboto", "Arial", sans-serif;
+  margin: 0;
+}
+
+.container {
+  padding: 0 1.25rem;
+}
+
+.main-body {
+  max-width: 750px;
+}
+
+.hidden {
+  display: none;
+}
+
+.flash-message {
+  border-radius: 30px;
+  color: white;
+  font-size: 1rem;
+  font-weight: 300;
+  margin-bottom: 3em;
+  padding: 15px;
+  text-align: center;
+}
+
+.flash-success {
+  background-color: #e6efc2;
+  color: #56651a;
+  display: block;
+  font-weight: 600;
+  margin-bottom: 0.625rem;
+  padding: 0.625rem;
+  text-align: center;
+}
+
+.flash-notice {
+  background-color: #e5edf8;
+  color: #244e87;
+  display: block;
+  font-weight: 600;
+  margin-bottom: 0.625rem;
+  padding: 0.625rem;
+  text-align: center;
+}
+
+.button {
+  -webkit-appearance: none;
+  -moz-appearance: none;
+  -ms-appearance: none;
+  -o-appearance: none;
+  appearance: none;
+  -webkit-font-smoothing: antialiased;
+  background-image: -webkit-gradient(linear, left top, left bottom, color-stop(20%, #ffffff), to(#f7f7f7));
+  background-image: linear-gradient(#ffffff 20%, #f7f7f7);
+  border-radius: 2px;
+  border: 1px solid #e4e4e3;
+  border-top-color: rgb(228, 228, 227);
+  border-top-style: solid;
+  border-top-width: 1px;
+  border-right-color: rgb(228, 228, 227);
+  border-right-style: solid;
+  border-right-width: 1px;
+  border-bottom-color: rgb(228, 228, 227);
+  border-bottom-style: solid;
+  border-bottom-width: 1px;
+  border-left-color: rgb(228, 228, 227);
+  border-left-style: solid;
+  border-left-width: 1px;
+  border-image-source: initial;
+  border-image-slice: initial;
+  border-image-width: initial;
+  border-image-outset: initial;
+  border-image-repeat: initial;
+  -webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
+  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
+  color: #4383c5;
+  cursor: pointer;
+  display: inline-block;
+  font-family: "Whitney A", "Whitney B", "Helvetica Neue", "Helvetica", "Roboto", "Arial", sans-serif;
+  font-size: 0.875rem;
+  font-weight: 600;
+  line-height: 2.3;
+  padding: 0 1.25rem;
+  text-align: center;
+  text-decoration: none;
+  text-decoration-line: none;
+  text-decoration-style: initial;
+  text-decoration-color: initial;
+  -webkit-transition: all 0.2s cubic-bezier(0.39, 0.575, 0.565, 1);
+  transition: all 0.2s cubic-bezier(0.39, 0.575, 0.565, 1);
+  -webkit-user-select: none;
+  -moz-user-select: none;
+  -ms-user-select: none;
+  user-select: none;
+  vertical-align: middle;
+  white-space: nowrap;
+}
+
+.button.button--submit {
+  background: -webkit-gradient(linear, left top, left bottom, color-stop(20%, #afca7d), to(#99bb59)), #99bb59;
+  background-image: linear-gradient(rgb(175, 202, 125) 20%, rgb(153, 187, 89)), initial;
+  background-position-x: initial, initial;
+  background-position-y: initial, initial;
+  background-size: initial, initial;
+  background-repeat-x: initial, initial;
+  background-repeat-y: initial, initial;
+  background-attachment: initial, initial;
+  background-origin: initial, initial;
+  background-clip: initial, initial;
+  background-color: rgb(153, 187, 89);
+  background: linear-gradient(#afca7d 20%, #99bb59), #99bb59;
+  background-image: linear-gradient(rgb(175, 202, 125) 20%, rgb(153, 187, 89)), initial;
+  background-position-x: initial, initial;
+  background-position-y: initial, initial;
+  background-size: initial, initial;
+  background-repeat-x: initial, initial;
+  background-repeat-y: initial, initial;
+  background-attachment: initial, initial;
+  background-origin: initial, initial;
+  background-clip: initial, initial;
+  background-color: rgb(153, 187, 89);
+  border: 1px solid #748e42;
+  border-top-color: rgb(116, 142, 66);
+  border-top-style: solid;
+  border-top-width: 1px;
+  border-right-color: rgb(116, 142, 66);
+  border-right-style: solid;
+  border-right-width: 1px;
+  border-bottom-color: rgb(116, 142, 66);
+  border-bottom-style: solid;
+  border-bottom-width: 1px;
+  border-left-color: rgb(116, 142, 66);
+  border-left-style: solid;
+  border-left-width: 1px;
+  border-image-source: initial;
+  border-image-slice: initial;
+  border-image-width: initial;
+  border-image-outset: initial;
+  border-image-repeat: initial;
+  -webkit-box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.3), 0 1px 3px rgba(0, 0, 0, 0.2);
+  box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.3), 0 1px 3px rgba(0, 0, 0, 0.2);
+  color: #ffffff;
+  display: inline-block;
+  font-size: 1rem;
+  text-shadow: 0 1px 1px rgba(0, 0, 0, 0.4);
+}

data/app/assets/stylesheets/feste/modal.css

@@ -0,0 +1,40 @@
+.modal-overlay {
+  background-color: #ffffff;
+  height: 100%;
+  width: 100%;
+}
+
+.confirmation-modal-container {
+  height: 100%;
+  left: 0;
+  position: fixed;
+  top: 0;
+  width: 100%;
+}
+
+.modal-content {
+  background-color: #ffffff;
+  border: 1px solid #cbcbc9;
+  border-radius: 2px;
+  box-shadow: 0 2px 4px rgba(0, 0, 0, 0.07);
+  box-sizing: border-box;
+  max-width: 500px;
+  margin: 0 auto;
+  padding: 1.875rem;
+  text-align: center;
+  position: relative;
+  top: 50px;
+  width: 100%;
+  -webkit-box-shadow: 0 2px 4px rgba(0, 0, 0, 0.07);
+}
+
+.modal-header {
+  font-size: 1.25rem;
+  margin: 0;
+}
+
+.modal-body {
+  color: #4f4d4b;
+  font-size: 1rem;
+  font-weight: 400;
+}

data/app/assets/stylesheets/feste/subscriptions.css

@@ -0,0 +1,40 @@
+input {
+  font-size: 1rem;
+}
+
+.subscription-category-container {
+  padding: 0.325rem 0;
+  width: 100%;
+}
+
+.subscription-submit-button {
+  margin-top: 1.25rem;
+}
+
+.error-label {
+  color: #aa1111;
+  font-weight: 600;
+}
+
+.form-submit-button {
+  background: #aa1111;
+  border: 0;
+  border-radius: 30px;
+  color: white;
+  font-size: 1.2em;
+  font-weight: 600;
+  padding: 15px;
+}
+
+.email-field-container {
+  margin-bottom: 1.2em;
+}
+
+.email-field-input {
+  box-sizing: border-box;
+  width: 100%;
+  padding: 5px;
+  font-size: 1em;
+  text-align: center;
+  font-weight: 300;
+}

data/app/controllers/concerns/feste/authenticatable.rb

@@ -0,0 +1,41 @@
+module Feste
+  module Authenticatable
+    extend ActiveSupport::Concern
+
+    included do
+      if Feste.options[:authenticate_with] == :clearance
+        include Feste::Authentication::Clearance
+      elsif Feste.options[:authenticate_with] == :devise
+        include Feste::Authentication::Devise
+      elsif Feste.options[:authenticate_with].is_a?(Proc)
+        include Feste::Authentication::Custom
+      else
+        include Feste::Authentication::DefaultInstanceMethods
+      end
+
+      before_action :get_user_data
+    end
+
+    def subscriber
+      @_subscriber ||= Feste::Subscription.find_by(token: params[:token])&.subscriber ||
+        current_user
+    end
+
+    def get_user_data
+      if subscriber.present?
+        find_or_create_subscriptions
+      else
+        render file: "#{Rails.root}/public/404.html",  status: 404
+      end
+    end
+
+    def find_or_create_subscriptions
+      Feste.options[:categories].each do |category|
+        Feste::Subscription.find_or_create_by(
+          subscriber: subscriber,
+          category: category
+        )
+      end
+    end
+  end
+end

data/app/controllers/feste/subscriptions_controller.rb

@@ -0,0 +1,43 @@
+module Feste
+  class SubscriptionsController < ActionController::Base
+    include Feste::Authenticatable
+
+    protect_from_forgery with: :exception
+
+    layout "feste/application"
+
+    def index
+      @subscriber = subscriber
+    end
+
+    def update
+      if update_subscriptions
+        flash[:success] = "You have successfully updated your subscriptions!"
+      else
+        flash[:notice] = "Something went wrong!  Please try again later."
+      end
+      redirect_back(
+        fallback_location: subscriptions_path(token: params[:token])
+      )
+    end
+
+    private
+
+    def user_params
+      params.require(subscriber.class.to_s.downcase.to_sym).
+        permit(subscriptions: [])
+    end
+
+    def subscriptions_params
+      user_params[:subscriptions]
+    end
+
+    def update_subscriptions
+      subscribed = subscriber.subscriptions.where(id: subscriptions_params)
+      unsubscribed = subscriber.subscriptions.where.
+        not(id: subscriptions_params)
+      subscribed.update_all(canceled: false) && 
+        unsubscribed.update_all(canceled: true)
+    end
+  end
+end