unsubscribe 0.1.0 → 1.0.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b90d08ba0979b64c7de3ec38af50fc8e39a5efb80d92218c9c9cac9b409b3cb9
-  data.tar.gz: ce95af4f4bb3ba2be36a11dce5fa62d960c9eedc0d23093acd6e3fa4c7113868
+  metadata.gz: 28f28f3bede2e59008c148b3262c718e621613bff193fcf8f22b0a6ad5302a50
+  data.tar.gz: 37b067207a3ed305fda44ca609f78e7d4307d10914ca2c2683f6df87bb978f43
 SHA512:
-  metadata.gz: efc5e6c92daacab73a5be06558db5c6fa2fa80b01d069f5eac91349a1fe1da37f2b4b080a35ca1502f7fbf9e7e1710cdc810709cc99f166187b50c28a2d031e3
-  data.tar.gz: 8eee60eac59948bef5731df07086797992585d4b246386495bf47938b57400d4752d425b8da0ccb42cff5376997c8c18bc656075d7529a2a64dfbbadfba98274
+  metadata.gz: b5881a6787fd24d5860a433a93094addf13a143b71b4784a08dfaa1700432ddcbf2e2237351d573cb0030ec472ed49d41242a7fd2d67c73bb309905d4a49c06d
+  data.tar.gz: 19bd2ff135befe0b3d5212f9b72b76a8db310df77b1d27eb7abb488443078619160bb6bc60af12a6ade697475855e8db265796676555c578830580170d24578d

data/README.md

@@ -1,10 +1,11 @@
-# Unsubscribe
-Automatically unsubscribe from emails in Rails. 
+# 📭 Unsubscribe
 
-## Usage
-TODO
+Automatically unsubscribe from emails in Rails.
+
+![Demo](./docs/demo.gif)
+
+## 🚀 Installation
 
-## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -21,8 +22,112 @@ Or install it yourself as:
 $ gem install unsubscribe
 ```
 
-## Contributing
-Contribution directions go here.
+Then run the installation commands:
+
+```bash
+rails g unsubscribe:install
+rails unsubscribe:install:migrations
+rails db:migrate
+```
+
+## 📚 Usage
+
+### Unsubscribe::Owner
+
+- Add `include Unsubscribe::Owner` to a `Model`. The `Model` must have an `email` column.
+
+```ruby
+class User < ApplicationRecord
+  include Unsubscribe::Owner
+end
+```
+
+#### Available Methods
+
+```ruby
+User.first.subscribed_to_mailer? "MarketingMailer"
+# => true/false
+
+User.first.to_sgid_for_mailer_subscription
+# => #<SignedGlobalID:123 ...>
+```
+
+### Unsubscribe::Mailer
+
+- Add `include Unsubscribe::Mailer` to a `Mailer`.
+- Optionally call `unsubscribe_settings` to set a `name` and `description`. This will be used in the unsubscribe page.
+- Set `mail to:` to `@recipient.email`. The `@recipient` is an instance of whatever Class `include Unsubscribe::Owner` was added to.
+
+```ruby
+class MarketingMailer < ApplicationMailer  
+  include Unsubscribe::Mailer
+
+  unsubscribe_settings name: "Marketing Emails", description: "Updates on promotions and sales."
+
+  def promotion
+    mail to: @recipient.email
+  end  
+end
+```
+
+- Call the `Mailer` with a `recipient` parameter.
+
+```ruby
+  MarketingMailer.with(
+    recipient: User.first
+  ).promotion.deliver_now
+```
+
+#### Available Methods
+
+```ruby
+Unsubscribe::MailerSubscription.first.action
+# => "Unsubscribe from"/"Subscribe to"
+
+Unsubscribe::MailerSubscription.first.call_to_action
+# => "Unsubscribe from Marketing Emails"/"Subscribe to Marketing Emails"
+
+Unsubscribe::MailerSubscription.first.description
+# => "Updates on promotions and sales."
+
+Unsubscribe::MailerSubscription.first.name
+# => "Marketing Emails"
+```
+
+### Unsubscribe Link
+
+- Add the `@unsubscribe_url` link to the `Mailer`.
+
+```html+erb
+<%= link_to "Unsubscribe", @unsubscribe_url %>
+```
+
+## ⚙️ Customize Templates
+
+Run `rails g unsubscribe:views` if you want to modify the existing templates.
+
+## 🌐 I18n
+
+The language used for `Unsubscribe::MailerSubscription#action` can be translated.
+
+```yml
+# config/locales/en.yml
+en:
+  unsubscribe:
+    action:
+      subscribe: "Subscribe to"
+      unsubscribe: "Unsubscribe from"
+```
+
+## 🙏 Contributing
+
+If you'd like to open a PR please make sure the following things pass:
+
+```ruby
+bin/rails test
+bundle exec standardrb
+```
+
+## 📜 License
 
-## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -10,8 +10,8 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 

data/app/assets/stylesheets/unsubscribe/mailer_subscriptions.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/unsubscribe/mailer_subscriptions_controller.rb

@@ -0,0 +1,66 @@
+require_dependency "unsubscribe/application_controller"
+
+module Unsubscribe
+  class MailerSubscriptionsController < ApplicationController
+    before_action :set_owner, only: [:show, :create, :update]
+    before_action :set_mailer, only: [:show]
+
+    def show
+    end
+
+    def create
+      @mailer = Unsubscribe::MailerSubscription.new(mailer_subscription_params)
+
+      if @owner != @mailer.owner
+        redirect_to(
+          mailer_subscription_path(@owner.to_sgid_for_mailer_subscription, mailer: params[:mailer_subscription][:mailer]),
+          alert: "You are not authorized to perform this action."
+        ) and return
+      end
+
+      if @mailer.save
+        redirect_to(
+          mailer_subscription_path(@owner.to_sgid_for_mailer_subscription, mailer: params[:mailer_subscription][:mailer]),
+          notice: "Settings updated."
+        )
+      else
+        redirect_to(
+          mailer_subscription_path(@owner.to_sgid_for_mailer_subscription, mailer: params[:mailer_subscription][:mailer]),
+          alert: @mailer.errors.full_messages.to_sentence
+        )
+      end
+    end
+
+    def update
+      @mailer = Unsubscribe::MailerSubscription.find(params[:mailer_subscription_id])
+
+      if @owner != @mailer.owner
+        redirect_to(
+          mailer_subscription_path(@owner.to_sgid_for_mailer_subscription, mailer: @mailer.mailer),
+          alert: "You are not authorized to perform this action."
+        ) and return
+      end
+
+      if @mailer.toggle!(:subscribed)
+        redirect_to mailer_subscription_path(@owner.to_sgid_for_mailer_subscription, mailer: @mailer.mailer), notice: "Settings updated."
+      else
+        redirect_to mailer_subscription_path(@owner.to_sgid_for_mailer_subscription, mailer: @mailer.mailer), alert: @mailer.errors.full_messages.to_sentence
+      end
+    end
+
+    private
+
+    def set_owner
+      @owner = GlobalID::Locator.locate_signed(params[:id], for: :mailer_subscription)
+      raise ActiveRecord::RecordNotFound if @owner.nil?
+    end
+
+    def set_mailer
+      @mailer = @owner.mailer_subscriptions.find_or_initialize_by(mailer: params[:mailer])
+    end
+
+    def mailer_subscription_params
+      params.require(:mailer_subscription).permit(:owner_id, :owner_type, :subscribed, :mailer)
+    end
+  end
+end

data/app/helpers/unsubscribe/mailer_subscriptions_helper.rb

@@ -0,0 +1,4 @@
+module Unsubscribe
+  module MailerSubscriptionsHelper
+  end
+end

data/app/mailers/unsubscribe/application_mailer.rb

@@ -1,6 +1,6 @@
 module Unsubscribe
   class ApplicationMailer < ActionMailer::Base
-    default from: 'from@example.com'
-    layout 'mailer'
+    default from: "from@example.com"
+    layout "mailer"
   end
 end

data/app/models/unsubscribe/mailer_subscription.rb

@@ -0,0 +1,45 @@
+module Unsubscribe
+  class MailerSubscription < ApplicationRecord
+    belongs_to :owner, polymorphic: true
+
+    validates :subscribed, inclusion: [true, false], allow_nil: true
+    validates :mailer, presence: true
+    validates :owner_id, uniqueness: {scope: [:mailer, :owner_type]}
+    validate :mailer_should_exist
+
+    def action
+      case subscribed
+      when nil
+        I18n.t("unsubscribe.action.unsubscribe")
+      else
+        subscribed? ? I18n.t("unsubscribe.action.unsubscribe") : I18n.t("unsubscribe.action.subscribe")
+      end
+    end
+
+    def call_to_action
+      "#{action} #{name}"
+    end
+
+    def description
+      details[:description]
+    end
+
+    def name
+      details[:name].present? ? details[:name] : mailer
+    end
+
+    def details
+      mailer.constantize.unsubscribe_settings
+    rescue NoMethodError
+      raise Unsubscribe::Error, "Make sure to include Unsubscribe::Mailer in #{mailer}"
+    end
+
+    private
+
+    def mailer_should_exist
+      errors.add(:mailer, "is not a enbled") unless mailer.constantize.enabled
+    rescue NameError
+      errors.add(:mailer, "is not a Mailer")
+    end
+  end
+end

data/app/views/unsubscribe/mailer_subscriptions/show.html.erb

@@ -0,0 +1,26 @@
+<h1><%= @mailer.name %></h1>
+<p><%= @mailer.description %></p>
+<% if @mailer.new_record? %>
+  <%= button_to(
+    @mailer.call_to_action,
+    mailer_subscriptions_path,
+    params: { 
+      id: @owner.to_sgid_for_mailer_subscription,
+      mailer_subscription: {
+        owner_id: @owner.id,
+        owner_type: @owner.class,
+        subscribed: false,
+        mailer: @mailer.mailer
+      }
+    }
+  ) %>
+<% else %>
+  <%= button_to(
+    @mailer.call_to_action,
+    mailer_subscription_path(@owner.to_sgid_for_mailer_subscription),
+    method: :put,
+    params: { 
+      mailer_subscription_id: @mailer.id
+    }
+  ) %>
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  unsubscribe:
+    action:
+      subscribe: "Subscribe to"
+      unsubscribe: "Unsubscribe from"

data/config/routes.rb

@@ -1,2 +1,3 @@
 Unsubscribe::Engine.routes.draw do
+  resources :mailer_subscriptions, only: [:create, :update, :show]
 end

data/db/migrate/20210918092925_create_unsubscribe_mailer_subscriptions.rb

@@ -0,0 +1,15 @@
+class CreateUnsubscribeMailerSubscriptions < ActiveRecord::Migration[6.0]
+  def change
+    create_table :unsubscribe_mailer_subscriptions do |t|
+      # Needs to be polymorphic to be flexible. Owner may not always be a User.
+      t.references :owner, polymorphic: true, null: false, index: { name: "unsubscribe_owner_index" }
+      t.boolean :subscribed
+      t.string :mailer, null: false
+
+      t.timestamps
+    end
+
+    # An owner should only have one Unsubscribe::MailerSubscription record per Mailer.
+    add_index :unsubscribe_mailer_subscriptions, [:owner_id, :owner_type, :mailer], unique: true, name: "unsubscribe_owner_mailer_index"
+  end
+end

data/lib/generators/unsubscribe/install/install_generator.rb

@@ -0,0 +1,25 @@
+require "rails/generators"
+
+module Unsubscribe
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("./../../../../../", __FILE__)
+
+      def link_manifest_js
+        inject_into_file "app/assets/config/manifest.js" do
+          <<~EOF
+            \n//= link unsubscribe_manifest.js
+          EOF
+        end
+      end
+
+      def mount_engine
+        inject_into_file "config/routes.rb", after: "Rails.application.routes.draw do" do
+          <<~EOF
+            \n\tmount Unsubscribe::Engine => "/unsubscribe"
+          EOF
+        end
+      end
+    end
+  end
+end

data/lib/generators/unsubscribe/views/views_generator.rb

@@ -0,0 +1,13 @@
+require "rails/generators"
+
+module Unsubscribe
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("./../../../../../", __FILE__)
+
+      def copy_views
+        directory "app/views/unsubscribe", "app/views/unsubscribe"
+      end
+    end
+  end
+end

data/lib/unsubscribe/error.rb

@@ -0,0 +1,4 @@
+module Unsubscribe
+  class Error < StandardError
+  end
+end

data/lib/unsubscribe/mailer.rb

@@ -0,0 +1,41 @@
+module Unsubscribe
+  module Mailer
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :set_recipient
+      before_action :set_unsubscribe_url, if: :should_unsubscribe?
+      before_action :set_headers, if: :should_unsubscribe?
+      after_action :prevent_delivery_if_recipient_opted_out, if: :should_unsubscribe?
+    end
+
+    class_methods do
+      def unsubscribe_settings(name: nil, description: nil)
+        cattr_accessor :unsubscribe_settings, default: {name: name, description: description}
+        cattr_accessor :enabled, default: true
+      end
+    end
+
+    private
+
+    def prevent_delivery_if_recipient_opted_out
+      mail.perform_deliveries = @recipient.subscribed_to_mailer? self.class.to_s
+    end
+
+    def set_recipient
+      @recipient = params[:recipient]
+    end
+
+    def set_unsubscribe_url
+      @unsubscribe_url = unsubscribe.mailer_subscription_url(@recipient.to_sgid_for_mailer_subscription, mailer: self.class)
+    end
+
+    def should_unsubscribe?
+      @recipient.present? && @recipient.respond_to?(:subscribed_to_mailer?)
+    end
+
+    def set_headers
+      headers["List-Unsubscribe"] = "<#{@unsubscribe_url}>"
+    end
+  end
+end

data/lib/unsubscribe/owner.rb

@@ -0,0 +1,21 @@
+module Unsubscribe
+  module Owner
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :mailer_subscriptions, class_name: "Unsubscribe::MailerSubscription", as: :owner, inverse_of: :owner, dependent: :destroy
+    end
+
+    def subscribed_to_mailer?(mailer)
+      Unsubscribe::MailerSubscription.find_by(
+        owner: self,
+        mailer: mailer,
+        subscribed: false
+      ).nil?
+    end
+
+    def to_sgid_for_mailer_subscription
+      to_sgid(for: :mailer_subscription)
+    end
+  end
+end

data/lib/unsubscribe/version.rb

@@ -1,3 +1,3 @@
 module Unsubscribe
-  VERSION = '0.1.0'
+  VERSION = "1.0.0.alpha.1"
 end

data/lib/unsubscribe.rb

@@ -1,6 +1,9 @@
 require "unsubscribe/version"
 require "unsubscribe/engine"
 
+require "unsubscribe/error"
+require "unsubscribe/mailer"
+require "unsubscribe/owner"
+
 module Unsubscribe
-  # Your code goes here...
 end

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: unsubscribe
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0.alpha.1
 platform: ruby
 authors:
 - Steve Polito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-17 00:00:00.000000000 Z
+date: 2021-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.4
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.4.1
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.4
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.4.1
+        version: 6.0.0
 description: 'Automatically unsubscribe from emails in Rails. '
 email:
 - stevepolito@hey.com
@@ -42,16 +36,28 @@ files:
 - Rakefile
 - app/assets/config/unsubscribe_manifest.js
 - app/assets/stylesheets/unsubscribe/application.css
+- app/assets/stylesheets/unsubscribe/mailer_subscriptions.css
 - app/controllers/unsubscribe/application_controller.rb
+- app/controllers/unsubscribe/mailer_subscriptions_controller.rb
 - app/helpers/unsubscribe/application_helper.rb
+- app/helpers/unsubscribe/mailer_subscriptions_helper.rb
 - app/jobs/unsubscribe/application_job.rb
 - app/mailers/unsubscribe/application_mailer.rb
 - app/models/unsubscribe/application_record.rb
+- app/models/unsubscribe/mailer_subscription.rb
 - app/views/layouts/unsubscribe/application.html.erb
+- app/views/unsubscribe/mailer_subscriptions/show.html.erb
+- config/locales/en.yml
 - config/routes.rb
+- db/migrate/20210918092925_create_unsubscribe_mailer_subscriptions.rb
+- lib/generators/unsubscribe/install/install_generator.rb
+- lib/generators/unsubscribe/views/views_generator.rb
 - lib/tasks/unsubscribe_tasks.rake
 - lib/unsubscribe.rb
 - lib/unsubscribe/engine.rb
+- lib/unsubscribe/error.rb
+- lib/unsubscribe/mailer.rb
+- lib/unsubscribe/owner.rb
 - lib/unsubscribe/version.rb
 homepage: https://github.com/stevepolitodesign/unsubscribe
 licenses:
@@ -71,9 +77,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: