digestifier 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 124b6c9727a86330c188b08c7a59bc6c6e5afa8a
-  data.tar.gz: 2652ce7af8198739e74da047fe11b6e43af28375
+  metadata.gz: 27be6b151cd80d803e6c983feb87ea0e352bb61e
+  data.tar.gz: 7260331532953aaffeaa84f8d72ca492938aeb74
 SHA512:
-  metadata.gz: 78eaceb8ffe422ae4059f81ba64695a08161693f651af9847b713beeb2a6bbc517aa5961df522493a846e0b2a35bebb317b884f912bdfc5ba1487da461d0a1d0
-  data.tar.gz: dc32476a3b90c87862fc38f0371d65a47bbee0e8347dfd52b03ad5ad3625e4260724ea82053369dcd1b5842057a431936294a17c8f0f3ab59f942304375cf384
+  metadata.gz: 98e6c3b0b4f8ba45f75dd767ffc4de7a8bdb78bf61381e301b41c56d3f0fba7786fbeb7dacfeea761bc2dce191cde02b197a34cb9a24918506da026845ec4faf
+  data.tar.gz: c504707b89804f761a826ae669e2ccf1f606183867b4be7e4ce4bbba6b78399fcd4904e02abb4f18ef6656a9df6227d58b00256926476f4347cf3d2f8f08d9e5

data/.travis.yml

@@ -4,8 +4,8 @@ rvm:
   - 2.0.0
   - 2.1.0
 notifications:
-  campfire:
-    rooms:
-      - secure: "OmCCqj/S4Yj/KzSEN7BoL86l16LhydqcJqOGMB44A/7H9ExcMfv6prD1X7or/NKaqM3IWNZX7ElvCuc8u3R8QD377ry1L+d3vqgfXSbIjKhW/g4YgktRIzBEEH37Bs/3pfcU9qtZoeEeKAM3T2pduK7OVUV64jflHQyXK0NBgig="
+  notifications:
+    slack:
+      - secure: "bnE9IDeEsYScneTePwEBSW6YsgzS2AHb6EAQC7oTTB1Iv1dXdt1p/LU1mBrXBj/4eGSvZxIfuWXewBgxFgX6LQHTaCNRIfCmZ/JolayEKXs1b8lQNYpIFfbaBBFCMb/+SPsZNSJo3lBCW+xsiuHhho/5tIPHU8FMB/vwALlHJi4="
     on_success: change
     on_failure: change

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.5'
+    gem 'digestifier', '0.1.0'
 
 Don't forget to bundle:
 
@@ -42,6 +42,22 @@ DIGEST.recipients = lambda { User }
 DIGEST.default_frequency = 24.hours
 ```
 
+### Multiple Digests
+
+If you have more than one digest, then you must provide each configured digest with a unique identifier:
+
+```ruby
+NEWS_DIGEST    = Digestifier::Digest.new :news
+CHATTER_DIGEST = Digestifier::Digest.new :chatter
+```
+
+The default identifier is `:digest`, so if you are changing the name of an existing digest, you'll want to update your data (perhaps in a migration) with something like this:
+
+```ruby
+Digestifier::Receipt.update_all digest: 'chatter'
+Digestifier::Setting.update_all digest: 'chatter'
+```
+
 ### Sending emails
 
 This will likely go in a rake task - but it's up to you.
@@ -135,12 +151,13 @@ class CustomMailer < ActionMailer::Base
 
 ### Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+1. Fork this repository.
+2. Install [git-flow](https://github.com/nvie/gitflow/wiki/Installation) if you don't have it already, then initialise it within your local copy of this repository (`git flow init` - we stick with the defaults).
+3. Create your feature branch (`git flow feature start my-new-feature`)
+4. Commit your changes to the feature branch.
+5. Push to the branch (`git push origin feature/my-new-feature`)
+6. Create new Pull Request against our `develop` branch.
 
 ## Licence
 
-Copyright (c) 2013, Digestifier is developed and maintained by [Inspire9](http://inspire9.com), and is released under the open MIT Licence.
+Copyright (c) 2013-2014, Digestifier is developed and maintained by [Inspire9](http://inspire9.com), and is released under the open MIT Licence.

data/app/models/digestifier/receipt.rb

@@ -5,21 +5,23 @@ class Digestifier::Receipt < ActiveRecord::Base
 
   validates :recipient,   presence: true
   validates :captured_at, presence: true
+  validates :digest,      presence: true
 
-  def self.capture(recipient)
-    receipt = last_for recipient
+  def self.capture(recipient, digest)
+    receipt = last_for recipient, digest
 
     if receipt.nil?
-      create recipient: recipient, captured_at: Time.zone.now
+      create recipient: recipient, captured_at: Time.zone.now, digest: digest
     else
       receipt.update_attributes captured_at: Time.zone.now
     end
   end
 
-  def self.last_for(recipient)
+  def self.last_for(recipient, digest)
     where(
+      digest:         digest,
       recipient_type: recipient.class.name,
-      recipient_id: recipient.id
+      recipient_id:   recipient.id
     ).order('captured_at DESC').first
   end
 end

data/app/models/digestifier/setting.rb

@@ -7,14 +7,16 @@ class Digestifier::Setting < ActiveRecord::Base
 
   validates :recipient,  presence: true
   validates :identifier, presence: true, uniqueness: true
+  validates :digest,     presence: true
 
   before_validation :set_identifier, on: :create
 
-  def self.for(recipient)
+  def self.for(recipient, digest = :digest)
     where(
+      digest:         digest,
       recipient_type: recipient.class.name,
       recipient_id:   recipient.id
-    ).first || create(recipient: recipient)
+    ).first || create(digest: digest, recipient: recipient)
   end
 
   def set_identifier!

data/db/migrate/5_add_digest_to_settings.rb

@@ -0,0 +1,21 @@
+class AddDigestToSettings < ActiveRecord::Migration
+  def up
+    add_column :digestifier_settings, :digest, :string
+    execute "UPDATE digestifier_settings SET digest = 'digest'"
+
+    change_column :digestifier_settings, :digest, :string, null: false
+    add_index :digestifier_settings, :digest
+
+    remove_index :digestifier_settings, [:recipient_type, :recipient_id]
+    add_index :digestifier_settings, [:recipient_type, :recipient_id, :digest],
+      name: 'unique_recipients', unique: true
+  end
+
+  def down
+    remove_index :digestifier_settings, name: 'unique_recipients'
+    remove_column :digestifier_settings, :digest
+
+    add_index :digestifier_settings, [:recipient_type, :recipient_id],
+      unique: true
+  end
+end

data/db/migrate/6_add_digest_to_receipts.rb

@@ -0,0 +1,21 @@
+class AddDigestToReceipts < ActiveRecord::Migration
+  def up
+    add_column :digestifier_receipts, :digest, :string
+    execute "UPDATE digestifier_receipts SET digest = 'digest'"
+
+    change_column :digestifier_receipts, :digest, :string, null: false
+    add_index :digestifier_receipts, :digest
+
+    remove_index :digestifier_receipts, [:recipient_type, :recipient_id]
+    add_index :digestifier_receipts, [:recipient_type, :recipient_id, :digest],
+      name: 'unique_digest_receipts', unique: true
+  end
+
+  def down
+    remove_index :digestifier_receipts, name: 'unique_digest_receipts'
+    remove_column :digestifier_receipts, :digest
+
+    add_index :digestifier_receipts, [:recipient_type, :recipient_id],
+      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.5'
+  spec.version       = '0.1.0'
   spec.authors       = ['Pat Allan']
   spec.email         = ['pat@freelancing-gods.com']
   spec.summary       = 'Digests as a Rails Engine'

data/lib/digestifier/delivery.rb

@@ -10,7 +10,7 @@ class Digestifier::Delivery
   end
 
   def capture
-    Digestifier::Receipt.capture recipient
+    Digestifier::Receipt.capture recipient, digest.identifier
   end
 
   def deliver
@@ -41,11 +41,11 @@ class Digestifier::Delivery
   end
 
   def last_sent
-    receipt = Digestifier::Receipt.last_for(recipient)
+    receipt = Digestifier::Receipt.last_for(recipient, digest.identifier)
     receipt.nil? ? frequency.ago : receipt.captured_at
   end
 
   def settings
-    @settings ||= Digestifier::Setting.for recipient
+    @settings ||= Digestifier::Setting.for recipient, digest.identifier
   end
 end

data/lib/digestifier/digest.rb

@@ -1,7 +1,8 @@
 class Digestifier::Digest
-  attr_accessor :contents, :default_frequency, :recipients
+  attr_accessor :identifier, :contents, :default_frequency, :recipients
 
-  def initialize
+  def initialize(identifier = :digest)
+    @identifier        = identifier
     @default_frequency = 24.hours
     @recipients        = lambda { User.order(:id) }
   end

data/spec/acceptance/multiple_digests_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe 'Multiple Digests' do
+  let(:food_digest) { Digestifier::Digest.new :food }
+  let(:tech_digest) { Digestifier::Digest.new :tech }
+  let(:user)   { User.create! email: 'me@somewhere.com' }
+
+  before :each do
+    ActionMailer::Base.deliveries.clear
+
+    food_digest.contents = lambda { |range|
+      Article.category('food').where(created_at: range).order(:created_at)
+    }
+    tech_digest.contents = lambda { |range|
+      Article.category('tech').where(created_at: range).order(:created_at)
+    }
+
+    user
+  end
+
+  it 'sends an email of posts within the past day' do
+    Article.create! name: 'Recent Food Post', category: 'food'
+    Article.create! name: 'Recent Tech Post', category: 'tech'
+    Article.create!(name: 'Old Food Post', category: 'food').
+      update_attribute :created_at, 25.hours.ago
+    Article.create!(name: 'Old Tech Post', category: 'tech').
+      update_attribute :created_at, 25.hours.ago
+
+    Digestifier::Delivery.deliver food_digest
+
+    mail = ActionMailer::Base.deliveries.detect { |mail|
+      mail.to.include?('me@somewhere.com')
+    }
+    expect(mail.body).to match(/Recent Food Post/)
+    expect(mail.body).to_not match(/Old Food Post/)
+    expect(mail.body).to_not match(/Tech Post/)
+    expect(mail.body).to_not match(/Old Tech Post/)
+  end
+
+  it 'respects distinct frequency preferences' do
+    Article.create! name: 'Recent Food Post', category: 'food'
+    Article.create! name: 'Recent Tech Post', category: 'tech'
+    Article.create!(name: 'Old Food Post', category: 'food').
+      update_attribute :created_at, 13.hours.ago
+    Article.create!(name: 'Old Tech Post', category: 'tech').
+      update_attribute :created_at, 13.hours.ago
+
+    setting = Digestifier::Setting.for(user, :food)
+    setting.preferences['frequency'] = 12.hours.to_i
+    setting.save
+
+    setting = Digestifier::Setting.for(user, :tech)
+    setting.preferences['frequency'] = 24.hours.to_i
+    setting.save
+
+    Digestifier::Delivery.deliver food_digest
+
+    mail = ActionMailer::Base.deliveries.detect { |mail|
+      mail.to.include?('me@somewhere.com')
+    }
+    expect(mail.body).to match(/Recent Food Post/)
+    expect(mail.body).to_not match(/Old Food Post/)
+
+    ActionMailer::Base.deliveries.clear
+    Digestifier::Delivery.deliver tech_digest
+
+    mail = ActionMailer::Base.deliveries.detect { |mail|
+      mail.to.include?('me@somewhere.com')
+    }
+    expect(mail.body).to match(/Recent Tech Post/)
+    expect(mail.body).to match(/Old Tech Post/)
+  end
+
+  it 'respects disabled digest preferences' do
+    Article.create! name: 'Recent Food Post', category: 'food'
+    Article.create! name: 'Recent Tech Post', category: 'tech'
+
+    setting = Digestifier::Setting.for(user, :food)
+    setting.enabled = true
+    setting.save!
+
+    setting = Digestifier::Setting.for(user, :tech)
+    setting.enabled = false
+    setting.save!
+
+    Digestifier::Delivery.deliver food_digest
+
+    ActionMailer::Base.deliveries.detect { |mail|
+      mail.to.include?('me@somewhere.com')
+    }.should_not be_nil
+
+    ActionMailer::Base.deliveries.clear
+
+    Digestifier::Delivery.deliver tech_digest
+
+    ActionMailer::Base.deliveries.detect { |mail|
+      mail.to.include?('me@somewhere.com')
+    }.should be_nil
+  end
+end

data/spec/internal/app/models/article.rb

@@ -1,3 +1,3 @@
 class Article < ActiveRecord::Base
-  #
+  scope :category, lambda { |category| where category: category }
 end

data/spec/internal/db/schema.rb

@@ -1,6 +1,7 @@
 ActiveRecord::Schema.define do
   create_table :articles, :force => true do |table|
     table.string :name
+    table.string :category
     table.timestamps
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: digestifier
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -94,6 +94,8 @@ files:
 - db/migrate/2_create_settings.rb
 - db/migrate/3_add_enabled_to_settings.rb
 - db/migrate/4_add_identifier_to_settings.rb
+- db/migrate/5_add_digest_to_settings.rb
+- db/migrate/6_add_digest_to_receipts.rb
 - digestifier.gemspec
 - lib/digestifier.rb
 - lib/digestifier/delivery.rb
@@ -101,6 +103,7 @@ files:
 - lib/digestifier/engine.rb
 - spec/acceptance/custom_views_spec.rb
 - spec/acceptance/delivering_digests_spec.rb
+- spec/acceptance/multiple_digests_spec.rb
 - spec/acceptance/recipient_preferences_spec.rb
 - spec/acceptance/unsubscribing_spec.rb
 - spec/internal/app/controllers/application_controller.rb
@@ -135,13 +138,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Digests as a Rails Engine
 test_files:
 - spec/acceptance/custom_views_spec.rb
 - spec/acceptance/delivering_digests_spec.rb
+- spec/acceptance/multiple_digests_spec.rb
 - spec/acceptance/recipient_preferences_spec.rb
 - spec/acceptance/unsubscribing_spec.rb
 - spec/internal/app/controllers/application_controller.rb