mail_rotator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8844d53a9f13746403464d17b09858ec6092cdab
+  data.tar.gz: 3affa2be85e4b3d8c25837176056c88510be5ceb
+SHA512:
+  metadata.gz: fb63803027bf31f95f8c6b0dc97f6ad74440b08fd114d581f64a0f2b6ad4ef6dd80b5fc9f319073d39f2b22f98fcbffdd4553656e9492c4589e9abd18608ee2d
+  data.tar.gz: 8689c918259849afad4107674bfc12057656eec851559d32e1ac04696416ada3b47ed578f0de857d3d0d2e729eb79bfa1c6eaa1d78fa1edcd8c17acb89fead6d

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--order random

data/.ruby-gemset

@@ -0,0 +1 @@
+mail_rotator

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 2.0.0
+env: RAKE_ENV=test RAILS_ENV=test
+before_install:
+  - 'gem install bundler'
+script:
+  - 'bundle exec rspec'
+notifications:
+  email:
+    recipients:
+      - humzashah+travis@gmail.com
+    on_success: never
+    on_failure: always

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mail_rotator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Syed Humza Shah
+
+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,43 @@
+# MailRotator :mailbox:
+
+### What is this?
+
+The short version: This is a Ruby gem intended to be used with Rails projects.
+
+The not-so-short version: [Mandrill](https://www.mandrill.com/), [SendGrid](http://sendgrid.com), and similar services are free for the first few emails. But once you've exhausted your period quota, you have to pay! :moneybag:
+
+So why not string such services together and use the free email quota each one of them provides? With this tool, you can assign different quotas to your mail service accounts. Once a particular account reaches its limit, the next one will kick in!
+
+Thus you can use this to not pay anything to send email or simply to rotate your email servers.
+
+### Usage
+
+Add like any other gem:
+
+```ruby
+gem 'mail_rotator'
+```
+
+followed by `bundle install`.
+
+The sent mails are tracked through a database table. So you will need to create a migration with the contents of [this file](https://raw.githubusercontent.com/humzashah/mail_rotator/master/samples/migration.rb.sample).
+
+Define the SMTP settings of each of your services in any initializer e.g. `config/initializers/mail_rotator.rb`. You can get a template for the initializer [here](https://raw.githubusercontent.com/humzashah/mail_rotator/master/samples/mail_rotator.rb.sample). Add the limits, settings, any, additional services, and run the following rake task:
+
+```ruby
+bundle exec rake db:migrate mail_rotator:update_rows
+```
+
+Go to the mailer you are using and prepend the `MailRotator` module:
+
+```ruby
+  class CustomMailer < ActionMailer::Base
+    prepend MailRotator # which implies that you should have Ruby 2.0.0+
+  end
+```
+
+You're done! :clap:
+
+### Get in touch
+
+You can report an issue if there is a bug; for collaborations, create pull-requests; to offer me pizza, email me! :pizza: humzashah [at] gmail [dot] com

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/models/mailer_store.rb

@@ -0,0 +1,43 @@
+require 'active_record'
+
+module MailRotator
+  class MailerStore < ActiveRecord::Base
+    self.table_name = "mail_rotator_mailer_stores"
+
+    validates :name, :limit, :sent_count, presence: true
+    validates :name, uniqueness: true
+
+    after_save :activate_next_mailer
+    after_save :deactivate_other_mailers
+
+    def activate
+      self.update_attributes(active: true)
+    end
+
+    def increment
+      new_count = self.sent_count + 1
+      self.update_attributes(sent_count: new_count, active: true)
+    end
+
+    def reset
+      self.update_attributes(sent_count: 0, active: false)
+    end
+
+    def over_limit?
+      sent_count >= limit
+    end
+
+    private
+
+    def activate_next_mailer
+      return if active
+      next_mailer = self.class.where("id > ?", id).first
+      next_mailer ||= self.class.first
+      next_mailer.update_attributes(sent_count: 0, active: true)
+    end
+
+    def deactivate_other_mailers
+      self.class.where("id != ?", id).update_all(active: false) unless self.active
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mail_rotator"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/db/schema.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Schema.define(version: 20150510144529) do
+  table_name = "mail_rotator_mailer_stores"
+
+  create_table table_name do |t|
+    t.string :name, null: false
+    t.integer :limit, null: false, default: 1
+    t.integer :sent_count, null: false, default: 0
+    t.boolean :active, default: false
+
+    t.timestamps null: false
+  end
+
+  add_index table_name, :name, unique: true
+end

data/lib/mail_rotator/switcher.rb

@@ -0,0 +1,54 @@
+require_relative "../../app/models/mailer_store"
+
+module MailRotator
+  module Switcher
+    module_function
+
+    def treat(klass)
+      validate_constant
+      validate_rows
+
+      mailer = current_mailer
+      mailer.public_send(mailer.over_limit? ? :reset : :increment)
+
+      assign_mailer(klass, current_mailer)
+    end
+
+    def validate_constant
+      return if Switcher.const_defined?("SMTP_SETTINGS")
+      raise "MailRotator: MailRotator::Switcher::SMTP_SETTINGS is not defined. Refer to the README."
+    end
+
+    private
+    module_function
+
+    def validate_rows
+      config_mailer_names = SMTP_SETTINGS.keys.sort
+      db_mailer_names = MailerStore.pluck(:name).sort
+
+      return if (config_mailer_names == db_mailer_names)
+      raise "Please run 'rake db:migrate mail_rotator:update_rows' for RAILS_ENV=#{ENV['RAILS_ENV']}."
+    end
+
+    def assign_mailer(klass, mailer)
+      hash = SMTP_SETTINGS[mailer.name]
+      klass.smtp_settings = hash[:settings] || hash['settings']
+    end
+
+    def current_mailer
+      mailer = active_mailer
+      return mailer if mailer
+      mailer = first_mailer
+      first_mailer.activate
+      first_mailer
+    end
+
+    def active_mailer
+      MailerStore.where(active: true).first
+    end
+
+    def first_mailer
+      MailerStore.first
+    end
+  end
+end

data/lib/mail_rotator/version.rb

@@ -0,0 +1,3 @@
+module MailRotator
+  VERSION = "0.1.0"
+end

data/lib/mail_rotator.rb

@@ -0,0 +1,10 @@
+require "mail_rotator/version"
+require "mail_rotator/switcher"
+load "tasks/tasks.rake"
+
+module MailRotator
+  def mail(options)
+    Switcher.treat(self.class)
+    super(options)
+  end
+end

data/lib/tasks/tasks.rake

@@ -0,0 +1,26 @@
+require 'rake'
+
+namespace :mail_rotator do
+  desc "creates rows MailRotator::MailerStore"
+  task update_rows: :environment do
+    MailRotator::Switcher.validate_constant
+    puts "MailRotator: Creating/updating mailer rows; please wait..."
+    count = 0
+
+    ActiveRecord::Base.transaction do
+      MailRotator::Switcher::SMTP_SETTINGS.each do |name, options|
+        mailer = MailRotator::MailerStore.where(name: name).first_or_initialize(sent_count: 0)
+        mailer.limit = options[:limit] || options['limit']
+        count += 1 if mailer.save!
+      end
+    end
+
+    # destroy rows no longer valid:
+    MailRotator::MailerStore.where("name NOT IN (?)", MailRotator::Switcher::SMTP_SETTINGS.keys).destroy_all
+
+    # set an active mailer:
+    MailRotator::MailerStore.where("").limit(1).update_all(active: true) unless MailRotator::MailerStore.where(active: true).exists?
+
+    puts "MailRotator: Successfully created/updated #{count} mailer rows."
+  end
+end

data/mail_rotator.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mail_rotator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mail_rotator"
+  spec.version       = MailRotator::VERSION
+  spec.authors       = ["Syed Humza Shah"]
+  spec.email         = ["humzashah+github@gmail.com"]
+
+  spec.summary       = "Rotate services used to send Rails emails."
+  spec.homepage      = "https://github.com/humzashah/mail_rotator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency "bundler", ">= 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "factory_girl_rails"
+  spec.add_development_dependency "shoulda-matchers"
+
+  spec.add_dependency "rails"
+end

data/samples/mail_rotator.rb.sample

@@ -0,0 +1,35 @@
+=begin
+smtp_settings must include the following information:
+{
+  user_name: username,
+  password:  password,
+  domain: domain,
+  address: address,
+  port: port_number,
+  authentication: :plain,
+  enable_starttls_auto: true
+}
+=end
+
+require "mail_rotator"
+
+module MailRotator
+  module Switcher
+    SMTP_SETTINGS = {
+      "SENDGRID" => {
+        limit: 400,
+        settings: sendgrid_smtp_settings
+      },
+
+      "MANDRILL" => {
+        limit: 1200,
+        settings: mandrill_smtp_settings
+      },
+
+      "GMAIL" => {
+        limit: 100,
+        settings: gmail_smtp_settings
+      }
+    }
+  end
+end

data/samples/migration.rb.sample

@@ -0,0 +1,19 @@
+class CreateMailRotatorMailerStores < ActiveRecord::Migration
+  def change
+    create_table table_name do |t|
+      t.string :name, null: false
+      t.integer :limit, null: false, default: 1
+      t.integer :sent_count, null: false, default: 0
+      t.boolean :active, default: false
+
+      t.timestamps null: false
+    end
+
+    add_index table_name, :name, unique: true
+  end
+
+  private
+  def table_name
+    MailRotator::MailerStore.table_name
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: mail_rotator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Syed Humza Shah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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_rails
+  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: shoulda-matchers
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- humzashah+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/models/mailer_store.rb
+- bin/console
+- bin/setup
+- db/schema.rb
+- lib/mail_rotator.rb
+- lib/mail_rotator/switcher.rb
+- lib/mail_rotator/version.rb
+- lib/tasks/tasks.rake
+- mail_rotator.gemspec
+- samples/mail_rotator.rb.sample
+- samples/migration.rb.sample
+homepage: https://github.com/humzashah/mail_rotator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Rotate services used to send Rails emails.
+test_files: []