bundle_notification 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b046884fa40a09e53b7060881fc04a217669b1be
+  data.tar.gz: 493318dedbfa7f20d945e08c4c89a5050086fc66
+SHA512:
+  metadata.gz: b70c086cd7c621ee7a28537664f4abc61740200e1281b08265ff9e242969b7dedb5a9050239b4f35381d2e78098388bc12a204f4bf35a05ce87e23d7195c6243
+  data.tar.gz: 4ae21ba08bab367778aca463f57655e2d3e403d9b741aac6c5fb60500fadebe565682b4959e4a674f31794b63decd9243b636a1b8b64f483976b095b18274524

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.4

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bundle_notification.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rubocop-ci', git: 'https://github.com/ad2games/rubocop-ci'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Guilherme Goettems Schneider
+
+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,74 @@
+# BundleNotification
+
+BundleNotification bundles many ActionMailer messages for the same recipient into a single email
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bundle_notification'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bundle_notification
+    
+    
+Create bundle_notification_snippets table:
+
+    $ rails g migration CreateBundleNotificationSnippets mailer_class:string:index recipient:string data:text sent_at:datetime created_at:datetime
+    $ rake db:migrate
+
+## Usage
+
+1. Include `BundleNotification::MailerHelper` to a mailer class.
+2. Create any method you want and call `snippet` in the end passing the recipient email and any extra data you want.
+3. Implement `bundle_notify` method which receives a recipient_email and an array of data
+4. Call your method implemented in step 2 chained with `deliver_later` as you would do with a normal mailer method.
+5. Call `deliver_unsent_snippets` for your mailer
+
+Example: 
+
+```ruby
+class MyMailer < ActionMailer::Base
+  include BundleNotification::MailerHelper #1
+  
+  def message(recipient_email, snippet_data)
+    snippet(recipient_email, snippet_data) #2
+  end
+  
+  def bundle_notify(recipient_email, snippets_data) #3
+    @snippets_data = snippets_data
+    mail(to: recipient_email)
+  end
+end
+
+MyMailer.message('recipient_1@example.com', 'message 1').deliver_later #4
+MyMailer.message('recipient_1@example.com', 'message 2').deliver_later
+MyMailer.message('recipient_2@example.com', 'message 3').deliver_later
+
+MyMailer.deliver_unsent_snippets #5
+```
+
+This will send 2 emails: One to <recipient_1@example.com> with `['message 1', 'message 2']` and another to <recipient_2@example.com> with `['message 3']` 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ad2games/bundle_notification.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop-ci'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bundle_notification"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bundle_notification.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bundle_notification/version'
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name        = 'bundle_notification'
+  spec.version     = BundleNotification::VERSION
+  spec.authors     = ['ad2games GmbH']
+  spec.email       = ['developers@ad2games.com']
+
+  spec.summary     = 'Bundle ActionMailer notifications'
+  spec.description = 'Bundle many ActionMailer messages for the same recipient into a single email'
+  spec.homepage    = 'http://ad2games.com'
+  spec.license     = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'actionmailer', '>= 4.0', '< 5.2'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_dependency 'activerecord', '>= 4.0', '< 5.2'
+  spec.add_dependency 'activesupport', '>= 4.0', '< 5.2'
+end
+# rubocop:enable Metrics/BlockLength

data/circle.yml

@@ -0,0 +1,6 @@
+database:
+  override:
+    - "true"
+test:
+  post:
+    - bundle exec rake rubocop

data/lib/bundle_notification/deliver.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require 'active_support/time'
+require 'bundle_notification/snippet'
+
+module BundleNotification
+  class Deliver
+    attr_reader :mailer_class
+
+    def initialize(mailer_class)
+      @mailer_class = mailer_class
+    end
+
+    def deliver_unsent_snippets
+      Snippet.transaction do
+        return if unsent_snippets.empty?
+        unsent_snippets.group_by(&:recipient).each do |recipient, snippets|
+          bundle_notify(recipient, snippets.map(&:data)).deliver_later
+        end
+        mark_snippets_sent
+      end
+    end
+
+    private
+
+    def bundle_notify(bundle_data, snippets_data)
+      mailer_class.constantize.bundle_notify(bundle_data, snippets_data)
+    end
+
+    def unsent_snippets
+      @unsent_snippets ||= Snippet.unsent_for(mailer_class).order(:created_at, :id).lock.to_a
+    end
+
+    def mark_snippets_sent
+      Snippet.where(id: unsent_snippets).update_all(sent_at: (Time.zone || Time).now)
+      @unsent_snippets = nil
+    end
+  end
+end

data/lib/bundle_notification/mailer_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'active_support/concern'
+require 'bundle_notification/deliver'
+require 'bundle_notification/snippet_message'
+
+module BundleNotification
+  module MailerHelper
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def deliver_unsent_snippets
+        Deliver.new(to_s).deliver_unsent_snippets
+      end
+    end
+
+    def snippet(recipient, snippet_data)
+      # SnippetMessage will replace Mail::Message of ActionMailer::MessageDelivery
+      @_mail_was_called = true
+      @_message = SnippetMessage.new(self.class.to_s, recipient, snippet_data)
+    end
+  end
+end

data/lib/bundle_notification/snippet.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'active_record'
+
+module BundleNotification
+  class Snippet < ActiveRecord::Base
+    self.table_name = 'bundle_notification_snippets'
+
+    serialize :data
+
+    scope :unsent_for, ->(mailer_class) { where(mailer_class: mailer_class, sent_at: nil) }
+  end
+end

data/lib/bundle_notification/snippet_message.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'bundle_notification/snippet'
+
+module BundleNotification
+  class SnippetMessage
+    attr_reader :mailer_class, :recipient, :snippet_data
+
+    def initialize(mailer_class, recipient, snippet_data)
+      @mailer_class = mailer_class
+      @recipient = recipient
+      @snippet_data = snippet_data
+    end
+
+    def deliver
+      Snippet.create!(
+        mailer_class: mailer_class,
+        recipient: recipient,
+        data: snippet_data
+      )
+    end
+  end
+end

data/lib/bundle_notification/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module BundleNotification
+  VERSION = '0.1.0'
+end

data/lib/bundle_notification.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'bundle_notification/mailer_helper'
+require 'bundle_notification/version'
+
+module BundleNotification
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: bundle_notification
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ad2games GmbH
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description: Bundle many ActionMailer messages for the same recipient into a single
+  email
+email:
+- developers@ad2games.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bundle_notification.gemspec
+- circle.yml
+- lib/bundle_notification.rb
+- lib/bundle_notification/deliver.rb
+- lib/bundle_notification/mailer_helper.rb
+- lib/bundle_notification/snippet.rb
+- lib/bundle_notification/snippet_message.rb
+- lib/bundle_notification/version.rb
+homepage: http://ad2games.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Bundle ActionMailer notifications
+test_files: []