digestifier 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27be6b151cd80d803e6c983feb87ea0e352bb61e
-  data.tar.gz: 7260331532953aaffeaa84f8d72ca492938aeb74
+  metadata.gz: 39498bf10b95798271d89f3db5eb5b871afe556e
+  data.tar.gz: 0d72ce2b9e333cde60c0c70bb172fecd17309f25
 SHA512:
-  metadata.gz: 98e6c3b0b4f8ba45f75dd767ffc4de7a8bdb78bf61381e301b41c56d3f0fba7786fbeb7dacfeea761bc2dce191cde02b197a34cb9a24918506da026845ec4faf
-  data.tar.gz: c504707b89804f761a826ae669e2ccf1f606183867b4be7e4ce4bbba6b78399fcd4904e02abb4f18ef6656a9df6227d58b00256926476f4347cf3d2f8f08d9e5
+  metadata.gz: b7fa6833c029c04c3e3ca31603058cbbad44422daebbb8d0dc7f6c0cb7a2070726c5d5ef703142ad8142134c390b182ebb533ca974c4bb662a1772b44822eb4b
+  data.tar.gz: 0f7693a1e3b202bbfc4e37ff82b6de376cc543dd9959acb6a0db163d9e1960d3de90ba165e13e683b6809a161a97e48ad372fdc03508cae31894639e44e2c610

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.1.0'
+    gem 'digestifier', '0.2.0'
 
 Don't forget to bundle:
 
@@ -28,11 +28,10 @@ Digestifier.sender = 'Hello <hello@inspire9.com>'
 
 # Set the digest object to a constant so it can be referred to elsewhere.
 DIGEST = Digestifier::Digest.new
-# Set the lambda that returns objects for the digest. This takes a single
-# argument - the time range - and should return a collection of objects. How
-# you get this collection is up to you, but the example below is a decent
-# starting point.
-DIGEST.contents = lambda { |range|
+# Set the lambda that returns objects for the digest. This takes two arguments # - the recipient in question, and the time range - and should return a
+# collection of objects. How you get this collection is up to you, but the
+# example below is a decent starting point.
+DIGEST.contents = lambda { |recipient, range|
   Article.where(created_at: range).order(:created_at)
 }
 # The digest recipients defaults to all User objects in your system. If you
@@ -118,6 +117,8 @@ Don't forget to include an unsubscribe link:
 
 ```erb
 <%= link_to 'Unsubscribe', unsubscribe_url_for(@recipient) %>
+<!-- Or, if you've given your digest a label: -->
+<%= link_to 'Unsubscribe', unsubscribe_url_for(@recipient, :news) %>
 ```
 
 Also: you'll very likely want to customise the email's subject - this is done via Rails' internationalisation:
@@ -151,6 +152,8 @@ class CustomMailer < ActionMailer::Base
 
 ### Contributing
 
+Please note that this project is released with [a Contributor Code of Conduct](http://contributor-covenant.org/version/1/2/0/). By participating in this project you agree to abide by its terms.
+
 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`)
@@ -160,4 +163,4 @@ class CustomMailer < ActionMailer::Base
 
 ## Licence
 
-Copyright (c) 2013-2014, Digestifier is developed and maintained by [Inspire9](http://inspire9.com), and is released under the open MIT Licence.
+Copyright (c) 2013-2015, Digestifier is developed and maintained by [Inspire9](http://inspire9.com), and is released under the open MIT Licence.

data/app/helpers/digestifier/unsubscribes_helper.rb

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

data/app/models/digestifier/setting.rb

@@ -12,11 +12,18 @@ class Digestifier::Setting < ActiveRecord::Base
   before_validation :set_identifier, on: :create
 
   def self.for(recipient, digest = :digest)
-    where(
-      digest:         digest,
-      recipient_type: recipient.class.name,
-      recipient_id:   recipient.id
-    ).first || create(digest: digest, recipient: recipient)
+    attempts = 0
+    begin
+      where(
+        digest:         digest,
+        recipient_type: recipient.class.name,
+        recipient_id:   recipient.id
+      ).first || create(digest: digest, recipient: recipient)
+    rescue ActiveRecord::RecordNotUnique
+      attempts += 1
+      retry if attempts < 2
+      raise
+    end
   end
 
   def set_identifier!

data/db/migrate/2_create_settings.rb

@@ -4,7 +4,7 @@ class CreateSettings < ActiveRecord::Migration
       t.string  :recipient_type, null: false
       t.integer :recipient_id,   null: false
       t.text    :preferences,    null: false, default: '{}'
-      t.timestamps
+      t.timestamps               null: false
     end
 
     add_index :digestifier_settings, [:recipient_type, :recipient_id],

data/db/migrate/3_add_enabled_to_settings.rb

@@ -2,5 +2,6 @@ class AddEnabledToSettings < ActiveRecord::Migration
   def change
     add_column :digestifier_settings, :enabled, :boolean, default: true,
       null: false
+    Digestifier::Setting.reset_column_information
   end
 end

data/db/migrate/4_add_identifier_to_settings.rb

@@ -1,6 +1,7 @@
 class AddIdentifierToSettings < ActiveRecord::Migration
   def up
     add_column :digestifier_settings, :identifier, :string
+    Digestifier::Setting.reset_column_information
 
     Digestifier::Setting.find_each do |setting|
       setting.set_identifier!
@@ -12,5 +13,6 @@ class AddIdentifierToSettings < ActiveRecord::Migration
 
   def down
     remove_column :digestifier_settings, :identifier
+    Digestifier::Setting.reset_column_information
   end
 end

data/db/migrate/5_add_digest_to_settings.rb

@@ -2,6 +2,7 @@ class AddDigestToSettings < ActiveRecord::Migration
   def up
     add_column :digestifier_settings, :digest, :string
     execute "UPDATE digestifier_settings SET digest = 'digest'"
+    Digestifier::Setting.reset_column_information
 
     change_column :digestifier_settings, :digest, :string, null: false
     add_index :digestifier_settings, :digest
@@ -14,6 +15,7 @@ class AddDigestToSettings < ActiveRecord::Migration
   def down
     remove_index :digestifier_settings, name: 'unique_recipients'
     remove_column :digestifier_settings, :digest
+    Digestifier::Setting.reset_column_information
 
     add_index :digestifier_settings, [:recipient_type, :recipient_id],
       unique: true

data/db/migrate/6_add_digest_to_receipts.rb

@@ -2,6 +2,7 @@ class AddDigestToReceipts < ActiveRecord::Migration
   def up
     add_column :digestifier_receipts, :digest, :string
     execute "UPDATE digestifier_receipts SET digest = 'digest'"
+    Digestifier::Receipt.reset_column_information
 
     change_column :digestifier_receipts, :digest, :string, null: false
     add_index :digestifier_receipts, :digest
@@ -14,6 +15,7 @@ class AddDigestToReceipts < ActiveRecord::Migration
   def down
     remove_index :digestifier_receipts, name: 'unique_digest_receipts'
     remove_column :digestifier_receipts, :digest
+    Digestifier::Receipt.reset_column_information
 
     add_index :digestifier_receipts, [:recipient_type, :recipient_id],
       unique: true

data/digestifier.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = 'digestifier'
-  spec.version       = '0.1.0'
+  spec.version       = '0.2.0'
   spec.authors       = ['Pat Allan']
   spec.email         = ['pat@freelancing-gods.com']
   spec.summary       = 'Digests as a Rails Engine'
@@ -17,6 +17,6 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_development_dependency 'rspec-rails', '~> 3.3.3'
+  spec.add_development_dependency 'sqlite3',     '~> 1.3.10'
 end

data/lib/digestifier/delivery.rb

@@ -1,7 +1,7 @@
 class Digestifier::Delivery
   def self.deliver(digest)
     digest.recipients.call.find_each do |recipient|
-      new(digest, recipient).deliver_and_capture
+      Digestifier::Delivery.new(digest, recipient).deliver_and_capture
     end
   end
 
@@ -31,7 +31,7 @@ class Digestifier::Delivery
   delegate :default_frequency, to: :digest
 
   def contents
-    digest.contents.call(last_sent..Time.zone.now)
+    digest.contents.call(recipient, last_sent..Time.zone.now)
   end
 
   def frequency
@@ -42,7 +42,7 @@ class Digestifier::Delivery
 
   def last_sent
     receipt = Digestifier::Receipt.last_for(recipient, digest.identifier)
-    receipt.nil? ? frequency.ago : receipt.captured_at
+    receipt.nil? ? frequency.to_i.seconds.ago : receipt.captured_at
   end
 
   def settings

data/spec/acceptance/custom_views_spec.rb

@@ -1,13 +1,13 @@
 require 'spec_helper'
 
-describe 'Custom digest partials' do
+RSpec.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 { |range|
+    digest.contents = lambda { |user, range|
       Book.where(created_at: range).order(:created_at)
     }
 

data/spec/acceptance/delivering_digests_spec.rb

@@ -1,13 +1,13 @@
 require 'spec_helper'
 
-describe 'Delivering digests' do
+RSpec.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 { |range|
+    digest.contents = lambda { |user, range|
       Article.where(created_at: range).order(:created_at)
     }
 

data/spec/acceptance/multiple_digests_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'Multiple Digests' do
+RSpec.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' }
@@ -8,10 +8,10 @@ describe 'Multiple Digests' do
   before :each do
     ActionMailer::Base.deliveries.clear
 
-    food_digest.contents = lambda { |range|
+    food_digest.contents = lambda { |user, range|
       Article.category('food').where(created_at: range).order(:created_at)
     }
-    tech_digest.contents = lambda { |range|
+    tech_digest.contents = lambda { |user, range|
       Article.category('tech').where(created_at: range).order(:created_at)
     }
 
@@ -85,16 +85,16 @@ describe 'Multiple Digests' do
 
     Digestifier::Delivery.deliver food_digest
 
-    ActionMailer::Base.deliveries.detect { |mail|
+    expect(ActionMailer::Base.deliveries.detect { |mail|
       mail.to.include?('me@somewhere.com')
-    }.should_not be_nil
+    }).not_to be_nil
 
     ActionMailer::Base.deliveries.clear
 
     Digestifier::Delivery.deliver tech_digest
 
-    ActionMailer::Base.deliveries.detect { |mail|
+    expect(ActionMailer::Base.deliveries.detect { |mail|
       mail.to.include?('me@somewhere.com')
-    }.should be_nil
+    }).to be_nil
   end
 end

data/spec/acceptance/recipient_preferences_spec.rb

@@ -1,13 +1,13 @@
 require 'spec_helper'
 
-describe 'Custom digest frequency' do
+RSpec.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 { |range|
+    digest.contents = lambda { |user, range|
       Article.where(created_at: range).order(:created_at)
     }
   end
@@ -39,8 +39,8 @@ describe 'Custom digest frequency' do
 
     Digestifier::Delivery.deliver digest
 
-    ActionMailer::Base.deliveries.detect { |mail|
+    expect(ActionMailer::Base.deliveries.detect { |mail|
       mail.to.include?('me@somewhere.com')
-    }.should be_nil
+    }).to be_nil
   end
 end

data/spec/acceptance/unsubscribing_spec.rb

@@ -1,15 +1,15 @@
 require 'spec_helper'
 
-describe 'Unsubscribing' do
+RSpec.describe 'Unsubscribing', type: :request 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
+    expect(setting.enabled).to eq(true)
 
     get "/digests/unsubscribe/#{setting.identifier}"
 
     setting.reload
-    expect(setting.enabled).to be_false
+    expect(setting.enabled).to eq(false)
   end
 end

data/spec/internal/db/schema.rb

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

data/spec/models/digestifier/setting_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+RSpec.describe Digestifier::Setting, type: :model do
+  describe '.for' do
+    let(:setting)   { double 'Setting' }
+    let(:recipient) { double 'Recipient', id: 389 }
+
+    it 'returns an existing setting' do
+      allow(Digestifier::Setting).to receive(:where).and_return([setting])
+
+      expect(Digestifier::Setting.for(recipient)).to eq(setting)
+    end
+
+    it 'creates a new setting if it does not exist' do
+      allow(Digestifier::Setting).to receive(:where).and_return([])
+      allow(Digestifier::Setting).to receive(:create).and_return(setting)
+
+      expect(Digestifier::Setting.for(recipient)).to eq(setting)
+    end
+
+    it 'retries find if create raises an exception' do
+      attempts = 0
+      allow(Digestifier::Setting).to receive(:where).and_return([])
+      allow(Digestifier::Setting).to receive(:create) do |attributes|
+        attempts += 1
+        raise ActiveRecord::RecordNotUnique, 'fail' if attempts <= 1
+        setting
+      end
+
+      expect(Digestifier::Setting.for(recipient)).to eq(setting)
+    end
+
+    it 'raises an error if create fails twice' do
+      attempts = 0
+      allow(Digestifier::Setting).to receive(:where).and_return([])
+      allow(Digestifier::Setting).to receive(:create) do |attributes|
+        attempts += 1
+        raise ActiveRecord::RecordNotUnique, 'fail' if attempts <= 2
+        setting
+      end
+
+      expect { Digestifier::Setting.for(recipient) }.
+        to raise_error(ActiveRecord::RecordNotUnique)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -13,7 +13,4 @@ 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,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: digestifier
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2015-08-11 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
+        version: 3.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: 3.3.3
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.8
+        version: 1.3.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.8
+        version: 1.3.10
 description: A Rails engine that lets you define and customise digest emails
 email:
 - pat@freelancing-gods.com
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -117,6 +117,7 @@ files:
 - spec/internal/db/schema.rb
 - spec/internal/log/.gitignore
 - spec/internal/public/favicon.ico
+- spec/models/digestifier/setting_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/inspire9/digestifier
 licenses:
@@ -128,17 +129,17 @@ 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.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Digests as a Rails Engine
@@ -159,4 +160,5 @@ test_files:
 - spec/internal/db/schema.rb
 - spec/internal/log/.gitignore
 - spec/internal/public/favicon.ico
+- spec/models/digestifier/setting_spec.rb
 - spec/spec_helper.rb