digestifier 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc2bff6ead8753dd54d921694f2b63d050a75c04
-  data.tar.gz: e12e3a4577b2402543f642a8f912fb391888d9e8
+  metadata.gz: 5fcb93bc3737caf909198e84c7036bcfe97fa359
+  data.tar.gz: f247da3dc55a3e53727490af3aeda9d84a7bd341
 SHA512:
-  metadata.gz: 0caf0b5098f15efe9f3c3778a45e67c6fa981f9e35f7623023c8dfb80c1e5828f5938ae1d2f2d9563e07e2f27b1b304b09f68c2169334325327b3c5266d6f803
-  data.tar.gz: d8a0bc60a634fde41e4cfdd03f36d71d4ce606647df4f3fd954706ab9001bef5a5073626b22bfd5cef71b0e38116942d65a87691b03cc99f820667956561cfe9
+  metadata.gz: 4dc884079205a4ed124142ac3a3af11a66eddaa631298121f01b9ed853c31ab86de129fcc809799738d8e21dc10ac797ce89a98c2499404e2e45b9f797a71766
+  data.tar.gz: 415cf49937d222676065da06b7ef87827b5f31549dd8d4f9385e4917ff18168bb245883511dfa4cd6d369fa8e09e0c02037207b6dda8739574b5e4b8ea7b129c

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
 notifications:
   campfire:
     rooms:

data/README.md

@@ -6,7 +6,7 @@ A simple Rails engine for sending out email digests of activity.
 
 Add this line to your application's Gemfile:
 
-    gem 'digestifier', '0.0.3'
+    gem 'digestifier', '0.0.4'
 
 Don't forget to bundle:
 
@@ -64,6 +64,16 @@ You can test sending an email to a specific recipient using the following code:
 Digestifier::Delivery.new(DIGEST, recipient).deliver
 ```
 
+### Unsubscribing
+
+The default emails will include an unsubscribe link at the bottom - but this requires you to mount the engine in your `config/routes.rb` file:
+
+```ruby
+mount Digestifier::Engine => '/digests'
+```
+
+You can mount it to wherever you like, of course.
+
 ### Customising partial templates
 
 This step is almost certainly essential: you'll want to customise how each item in your digest is presented. The partials for this should be located in `app/views/digestifier/mailer`, and use the item's class name, downcased and underscored (for example: `_article.html.erb` or `_comment.html.haml`).
@@ -88,6 +98,12 @@ The two instance variables you have access to are `@recipient` and `@content_ite
 <% end %>
 ```
 
+Don't forget to include an unsubscribe link:
+
+```erb
+<%= link_to 'Unsubscribe', unsubscribe_url_for(@recipient) %>
+```
+
 Also: you'll very likely want to customise the email's subject - this is done via Rails' internationalisation:
 
 ```yaml
@@ -106,7 +122,16 @@ If you want to put your own Mailer, then this is certainly possible:
 Digestifier.mailer = CustomMailer
 ```
 
-Your new mailer class should respond to `digest` and accept the following arguments: recipient and content_items.
+Your new mailer class should respond to `digest` and accept the following arguments: recipient and content_items. If you're using the `unsubscribe_url_for` method, you'll want to include the helper that provides it:
+
+```ruby
+class CustomMailer < ActionMailer::Base
+  helper 'digestifier/unsubscribes'
+  # And for partial matchers, if desired:
+  helper 'digestifier/partial'
+
+  # ...
+```
 
 ### Contributing
 

data/app/controllers/digestifier/unsubscribes_controller.rb

@@ -0,0 +1,7 @@
+class Digestifier::UnsubscribesController < ApplicationController
+  def change
+    setting = Digestifier::Setting.find_by_identifier params[:id]
+    setting.enabled = false
+    setting.save
+  end
+end

data/app/helpers/digestifier/unsubscribes_helper.rb

@@ -0,0 +1,11 @@
+module Digestifier::UnsubscribesHelper
+  def unsubscribe_path_for(user)
+    setting = Digestifier::Setting.for(user)
+    digestifier.unsubscribe_path(setting.identifier)
+  end
+
+  def unsubscribe_url_for(user)
+    setting = Digestifier::Setting.for(user)
+    digestifier.unsubscribe_url(setting.identifier)
+  end
+end

data/app/mailers/digestifier/mailer.rb

@@ -1,5 +1,6 @@
 class Digestifier::Mailer < ActionMailer::Base
   helper 'digestifier/partial'
+  helper 'digestifier/unsubscribes'
 
   def digest(recipient, content_items)
     @recipient     = recipient

data/app/models/digestifier/setting.rb

@@ -5,7 +5,10 @@ class Digestifier::Setting < ActiveRecord::Base
 
   serialize :preferences, JSON
 
-  validates :recipient, presence: true
+  validates :recipient,  presence: true
+  validates :identifier, presence: true, uniqueness: true
+
+  before_validation :set_identifier, on: :create
 
   def self.for(recipient)
     where(
@@ -13,4 +16,17 @@ class Digestifier::Setting < ActiveRecord::Base
       recipient_id:   recipient.id
     ).first || create(recipient: recipient)
   end
+
+  def set_identifier!
+    set_identifier
+    save
+  end
+
+  private
+
+  def set_identifier
+    self.identifier = SecureRandom.hex(12)
+
+    set_identifier if self.class.where(identifier: identifier).any?
+  end
 end

data/app/views/digestifier/mailer/digest.html.erb

@@ -7,3 +7,5 @@
     <li><%= render_digest_partial item %></li>
   <% end %>
 </ul>
+
+<%= link_to 'Unsubscribe', unsubscribe_url_for(@recipient) %>

data/app/views/digestifier/unsubscribes/change.html.erb

@@ -0,0 +1,3 @@
+<h1>Unsubscribed</h1>
+
+<p>You have now unsubscribed from the digest.</p>

data/config/routes.rb

@@ -0,0 +1,4 @@
+Digestifier::Engine.routes.draw do
+  get 'unsubscribe/:id', to: 'digestifier/unsubscribes#change',
+    as: :unsubscribe
+end

data/db/migrate/4_add_identifier_to_settings.rb

@@ -0,0 +1,12 @@
+class AddIdentifierToSettings < ActiveRecord::Migration
+  def up
+    add_column :digestifier_settings, :identifier, :string
+
+    Digestifier::Setting.find_each do |setting|
+      setting.set_identifier!
+    end
+
+    change_column :digestifier_settings, :identifier, :string, null: false
+    add_index :digestifier_settings, :identifier, unique: true
+  end
+end

data/digestifier.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = 'digestifier'
-  spec.version       = '0.0.3'
+  spec.version       = '0.0.4'
   spec.authors       = ['Pat Allan']
   spec.email         = ['pat@freelancing-gods.com']
   spec.summary       = 'Digests as a Rails Engine'

data/lib/digestifier/delivery.rb

@@ -14,7 +14,7 @@ class Digestifier::Delivery
   end
 
   def deliver
-    return unless settings.enabled?
+    return unless settings.enabled? && contents.any?
 
     Digestifier.mailer.digest(recipient, contents).deliver
   end

data/spec/acceptance/delivering_digests_spec.rb

@@ -59,4 +59,13 @@ describe 'Delivering digests' do
     expect(mail.body).to match(/Recent Post/)
     expect(mail.body).to_not match(/Old Post/)
   end
+
+  it "does not send an email if there's no items to send" do
+    Digestifier::Delivery.deliver digest
+
+    mail = ActionMailer::Base.deliveries.detect { |mail|
+      mail.to.include?('me@somewhere.com')
+    }
+    expect(mail).to be_nil
+  end
 end

data/spec/acceptance/unsubscribing_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'Unsubscribing' do
+  let(:user) { User.create! email: 'me@somewhere.com' }
+
+  it "marks a user as unsubscribed" do
+    setting = Digestifier::Setting.for(user)
+    expect(setting.enabled).to be_true
+
+    get "/digests/unsubscribe/#{setting.identifier}"
+
+    setting.reload
+    expect(setting.enabled).to be_false
+  end
+end

data/spec/internal/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/internal/config/routes.rb

@@ -1,3 +1,3 @@
 Rails.application.routes.draw do
-  #
+  mount Digestifier::Engine => '/digests'
 end

data/spec/spec_helper.rb

@@ -13,4 +13,7 @@ Dir["./spec/support/**/*.rb"].each { |file| require file }
 
 RSpec.configure do |config|
   config.use_transactional_fixtures = true
+
+  config.include RSpec::Rails::RequestExampleGroup, type: :request,
+    example_group: {file_path: /spec\/acceptance/}
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: digestifier
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-23 00:00:00.000000000 Z
+date: 2014-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -79,16 +79,21 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/digestifier/unsubscribes_controller.rb
 - app/helpers/digestifier/partial_helper.rb
+- app/helpers/digestifier/unsubscribes_helper.rb
 - app/mailers/digestifier/mailer.rb
 - app/models/digestifier/receipt.rb
 - app/models/digestifier/setting.rb
 - app/views/digestifier/mailer/_digest_item.html.erb
 - app/views/digestifier/mailer/digest.html.erb
+- app/views/digestifier/unsubscribes/change.html.erb
 - config.ru
+- config/routes.rb
 - db/migrate/1_create_receipts.rb
 - db/migrate/2_create_settings.rb
 - db/migrate/3_add_enabled_to_settings.rb
+- db/migrate/4_add_identifier_to_settings.rb
 - digestifier.gemspec
 - lib/digestifier.rb
 - lib/digestifier/delivery.rb
@@ -97,6 +102,8 @@ files:
 - spec/acceptance/custom_views_spec.rb
 - spec/acceptance/delivering_digests_spec.rb
 - spec/acceptance/recipient_preferences_spec.rb
+- spec/acceptance/unsubscribing_spec.rb
+- spec/internal/app/controllers/application_controller.rb
 - spec/internal/app/models/article.rb
 - spec/internal/app/models/book.rb
 - spec/internal/app/models/user.rb
@@ -128,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.2
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Digests as a Rails Engine
@@ -136,6 +143,8 @@ test_files:
 - spec/acceptance/custom_views_spec.rb
 - spec/acceptance/delivering_digests_spec.rb
 - spec/acceptance/recipient_preferences_spec.rb
+- spec/acceptance/unsubscribing_spec.rb
+- spec/internal/app/controllers/application_controller.rb
 - spec/internal/app/models/article.rb
 - spec/internal/app/models/book.rb
 - spec/internal/app/models/user.rb