digestifier 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6571f35b67e51f1547d094219716e4545cf9a635
+  data.tar.gz: 0768e76da9516ffca6a432db97a5ff484df60444
+SHA512:
+  metadata.gz: 6c54ef82d778a0e4dfda4b7608f1ac382c1dfaa8b00c9c47382433a6fd185e272a989f58a49fd368f8c32ae9d9904f56a73a7a9d86d5fb79f56e4468516404cf
+  data.tar.gz: c474429545bc4fc5600df7c69ebb346fb4443da12cf52cdfd4b2c91aaeff4650aa2706b07ea6076a8a617255d4009886efc29065c6a25879a5cf6e379a0495d0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/internal/db/*.sqlite
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+notifications:
+  campfire:
+    rooms:
+      - secure: "OmCCqj/S4Yj/KzSEN7BoL86l16LhydqcJqOGMB44A/7H9ExcMfv6prD1X7or/NKaqM3IWNZX7ElvCuc8u3R8QD377ry1L+d3vqgfXSbIjKhW/g4YgktRIzBEEH37Bs/3pfcU9qtZoeEeKAM3T2pduK7OVUV64jflHQyXK0NBgig="
+    on_success: change
+    on_failure: change

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Inspire9
+
+MIT License
+
+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,29 @@
+# Digestifier
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'digestifier'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install digestifier
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/app/helpers/digestifier/partial_helper.rb

@@ -0,0 +1,19 @@
+module Digestifier::PartialHelper
+  def render_digest_partial(item)
+    render partial: digest_partial_path(item), object: item,
+      locals: {digest_item: item}
+  end
+
+  private
+
+  def digest_partial_path(item)
+    if lookup_context.exists?(
+      item.class.name.underscore, [:digestifier, 'mailer'].compact.join('/'),
+      true
+    )
+      [:digestifier, 'mailer', item.class.name.underscore].compact.join('/')
+    else
+      [:digestifier, 'mailer', 'digest_item'].compact.join('/')
+    end
+  end
+end

data/app/mailers/digestifier/mailer.rb

@@ -0,0 +1,13 @@
+class Digestifier::Mailer < ActionMailer::Base
+  helper 'digestifier/partial'
+
+  def digest(recipient, content_items)
+    @recipient     = recipient
+    @content_items = content_items
+
+    mail(
+      from: Digestifier.sender,
+      to:   recipient.email
+    )
+  end
+end

data/app/models/digestifier/receipt.rb

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

data/app/models/digestifier/setting.rb

@@ -0,0 +1,17 @@
+class Digestifier::Setting < ActiveRecord::Base
+  self.table_name = 'digestifier_settings'
+
+  belongs_to :recipient, polymorphic: true
+
+  serialize :preferences, JSON
+
+  validates :recipient,   presence: true
+  validates :preferences, presence: true
+
+  def self.for(recipient)
+    where(
+      recipient_type: recipient.class.name,
+      recipient_id:   recipient.id
+    ).first || create(recipient: recipient)
+  end
+end

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

@@ -0,0 +1 @@
+<%= digest_item.name %>

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

@@ -0,0 +1,9 @@
+<p>Hi <%= @recipient.email %></p>
+
+<p>Here's the latest news:</p>
+
+<ul>
+  <% @content_items.each do |item| %>
+    <li><%= render_digest_partial item %></li>
+  <% end %>
+</ul>

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :action_controller, :active_record, :action_mailer
+run Combustion::Application

data/db/migrate/1_create_receipts.rb

@@ -0,0 +1,12 @@
+class CreateReceipts < ActiveRecord::Migration
+  def change
+    create_table :digestifier_receipts do |t|
+      t.string   :recipient_type, null: false
+      t.integer  :recipient_id,   null: false
+      t.datetime :captured_at,    null: false
+    end
+
+    add_index :digestifier_receipts, [:recipient_type, :recipient_id],
+      unique: true
+  end
+end

data/db/migrate/2_create_settings.rb

@@ -0,0 +1,13 @@
+class CreateSettings < ActiveRecord::Migration
+  def change
+    create_table :digestifier_settings do |t|
+      t.string  :recipient_type, null: false
+      t.integer :recipient_id,   null: false
+      t.text    :preferences,    null: false, default: '{}'
+      t.timestamps
+    end
+
+    add_index :digestifier_settings, [:recipient_type, :recipient_id],
+      unique: true
+  end
+end

data/digestifier.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = 'digestifier'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Pat Allan']
+  spec.email         = ['pat@freelancing-gods.com']
+  spec.summary       = 'Digests as a Rails Engine'
+  spec.description   = 'A Rails engine that lets you define and customise digest emails'
+  spec.homepage      = 'https://github.com/inspire9/digestifier'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rails', '>= 3.2'
+
+  spec.add_development_dependency 'combustion',  '~> 0.5.1'
+  spec.add_development_dependency 'rspec-rails', '~> 2.14.0'
+  spec.add_development_dependency 'sqlite3',     '~> 1.3.8'
+end

data/lib/digestifier/delivery.rb

@@ -0,0 +1,40 @@
+class Digestifier::Delivery
+  def self.deliver(digest)
+    digest.recipients.call.find_each do |recipient|
+      new(digest, recipient).deliver
+    end
+  end
+
+  def initialize(digest, recipient)
+    @digest, @recipient = digest, recipient
+  end
+
+  def deliver
+    Digestifier.mailer.digest(recipient, contents).deliver
+    Digestifier::Receipt.capture recipient
+  end
+
+  private
+
+  attr_reader :digest, :recipient
+
+  delegate :default_frequency, to: :digest
+
+  def contents
+    digest.contents.call.where(
+      created_at: last_sent..Time.zone.now
+    )
+  end
+
+  def frequency
+    settings = Digestifier::Setting.for recipient
+    return default_frequency unless settings.preferences['frequency']
+
+    settings.preferences['frequency']
+  end
+
+  def last_sent
+    receipt = Digestifier::Receipt.last_for(recipient)
+    receipt.nil? ? frequency.ago : receipt.captured_at
+  end
+end

data/lib/digestifier/digest.rb

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

data/lib/digestifier/engine.rb

@@ -0,0 +1,7 @@
+class Digestifier::Engine < Rails::Engine
+  engine_name :digestifier
+
+  config.after_initialize do
+    Digestifier.mailer = Digestifier::Mailer
+  end
+end

data/lib/digestifier.rb

@@ -0,0 +1,7 @@
+module Digestifier
+  mattr_accessor :mailer, :sender
+end
+
+require 'digestifier/delivery'
+require 'digestifier/digest'
+require 'digestifier/engine'

data/spec/acceptance/custom_views_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe 'Custom digest partials' do
+  let(:digest) { Digestifier::Digest.new }
+  let(:user)   { User.create! email: 'me@somewhere.com' }
+
+  before :each do
+    ActionMailer::Base.deliveries.clear
+
+    digest.contents = lambda { Book }
+
+    user
+  end
+
+  it 'respects object-specific partials' do
+    Book.create! title: 'Recent Book'
+
+    Digestifier::Delivery.deliver digest
+
+    mail = ActionMailer::Base.deliveries.detect { |mail|
+      mail.to.include?('me@somewhere.com')
+    }
+    expect(mail.body).to match(/Recent Book/)
+  end
+end

data/spec/acceptance/delivering_digests_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe 'Delivering digests' do
+  let(:digest) { Digestifier::Digest.new }
+  let(:user)   { User.create! email: 'me@somewhere.com' }
+
+  before :each do
+    ActionMailer::Base.deliveries.clear
+
+    digest.contents = lambda { Article }
+
+    user
+  end
+
+  it 'sends an email of posts within the past day' do
+    Article.create! name: 'Recent Post'
+    Article.create!(name: 'Old Post').
+      update_attribute :created_at, 25.hours.ago
+
+    Digestifier::Delivery.deliver digest
+
+    mail = ActionMailer::Base.deliveries.detect { |mail|
+      mail.to.include?('me@somewhere.com')
+    }
+    expect(mail.body).to match(/Recent Post/)
+    expect(mail.body).to_not match(/Old Post/)
+  end
+
+  it "allows the digest to have a different frequency" do
+    digest.default_frequency = 12.hours
+
+    Article.create! name: 'Recent Post'
+    Article.create!(name: 'Old Post').
+      update_attribute :created_at, 13.hours.ago
+
+    Digestifier::Delivery.deliver digest
+
+    mail = ActionMailer::Base.deliveries.detect { |mail|
+      mail.to.include?('me@somewhere.com')
+    }
+    expect(mail.body).to match(/Recent Post/)
+    expect(mail.body).to_not match(/Old Post/)
+  end
+
+  it "does not include already sent items if sending sooner than expected" do
+    Article.create!(name: 'Old Post').
+      update_attribute :created_at, 13.hours.ago
+    Digestifier::Delivery.deliver digest
+    ActionMailer::Base.deliveries.clear
+
+    Article.create! name: 'Recent Post'
+    Digestifier::Delivery.deliver digest
+
+    mail = ActionMailer::Base.deliveries.detect { |mail|
+      mail.to.include?('me@somewhere.com')
+    }
+    expect(mail.body).to match(/Recent Post/)
+    expect(mail.body).to_not match(/Old Post/)
+  end
+end

data/spec/acceptance/recipient_preferences_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe 'Custom digest frequency' do
+  let(:digest) { Digestifier::Digest.new }
+  let(:user)   { User.create! email: 'me@somewhere.com' }
+
+  before :each do
+    ActionMailer::Base.deliveries.clear
+
+    digest.contents = lambda { Article }
+  end
+
+  it 'respects receipient frequency preferences' do
+    Article.create! name: 'Recent Post'
+    Article.create!(name: 'Old Post').
+      update_attribute :created_at, 13.hours.ago
+
+    setting = Digestifier::Setting.for(user)
+    setting.preferences['frequency'] = 12.hours.to_i
+    setting.save
+
+    Digestifier::Delivery.deliver digest
+
+    mail = ActionMailer::Base.deliveries.detect { |mail|
+      mail.to.include?('me@somewhere.com')
+    }
+    expect(mail.body).to match(/Recent Post/)
+    expect(mail.body).to_not match(/Old Post/)
+  end
+end

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

@@ -0,0 +1,3 @@
+class Article < ActiveRecord::Base
+  #
+end

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

@@ -0,0 +1,3 @@
+class Book < ActiveRecord::Base
+  #
+end

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

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  #
+end

data/spec/internal/app/views/digestifier/mailer/_book.html.erb

@@ -0,0 +1 @@
+<%= book.title %>

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/initializers/digestifier.rb

@@ -0,0 +1 @@
+Digestifier.sender = 'hello@inspire9.com'

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Schema.define do
+  create_table :articles, :force => true do |table|
+    table.string :name
+    table.timestamps
+  end
+
+  create_table :books, :force => true do |table|
+    table.string :title
+    table.timestamps
+  end
+
+  create_table :users, :force => true do |table|
+    table.string :email
+    table.timestamps
+  end
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler'
+
+Bundler.setup :default, :development
+
+require 'combustion'
+require 'digestifier'
+
+Combustion.initialize! :action_controller, :active_record, :action_mailer
+
+require 'rspec/rails'
+
+Dir["./spec/support/**/*.rb"].each { |file| require file }
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: digestifier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+description: A Rails engine that lets you define and customise digest emails
+email:
+- pat@freelancing-gods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/helpers/digestifier/partial_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
+- config.ru
+- db/migrate/1_create_receipts.rb
+- db/migrate/2_create_settings.rb
+- digestifier.gemspec
+- lib/digestifier.rb
+- lib/digestifier/delivery.rb
+- lib/digestifier/digest.rb
+- lib/digestifier/engine.rb
+- spec/acceptance/custom_views_spec.rb
+- spec/acceptance/delivering_digests_spec.rb
+- spec/acceptance/recipient_preferences_spec.rb
+- spec/internal/app/models/article.rb
+- spec/internal/app/models/book.rb
+- spec/internal/app/models/user.rb
+- spec/internal/app/views/digestifier/mailer/_book.html.erb
+- spec/internal/config/database.yml
+- spec/internal/config/initializers/digestifier.rb
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb
+homepage: https://github.com/inspire9/digestifier
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.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/recipient_preferences_spec.rb
+- spec/internal/app/models/article.rb
+- spec/internal/app/models/book.rb
+- spec/internal/app/models/user.rb
+- spec/internal/app/views/digestifier/mailer/_book.html.erb
+- spec/internal/config/database.yml
+- spec/internal/config/initializers/digestifier.rb
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb