mongo_mailer 0.0.0 → 0.1.3

data/lib/generators/mongo_mailer/mongo_mailer_generator.rb

@@ -0,0 +1,10 @@
+require 'rails/generators'
+
+class MongoMailerGenerator < Rails::Generators::Base
+
+  self.source_paths << File.join(File.dirname(__FILE__), 'templates')
+
+  def create_config_files
+    template 'mongo_mailer.yml', 'config/mongo_mailer.yml.example'
+  end
+end

data/lib/generators/mongo_mailer/templates/mongo_mailer.yml

@@ -0,0 +1,38 @@
+development: &development
+  mongodb:
+    host: localhost
+    port: 27017
+    name: mongo_mailer
+  base_delivery_method: smtp
+  base_delivery_settings:
+    user_name: "username"
+    password: "apikey"
+    domain: "example.com"
+    address: "smtp1.example.com"
+    port: 587
+    authentication: plain
+    enable_starttls_auto: true
+  emergency_delivery_method: smtp
+  emergency_delivery_settings:
+    user_name: "username"
+    password: "apikey"
+    domain: "example.com"
+    address: "smtp2.example.com"
+    port: 587
+    authentication: plain
+    enable_starttls_auto: true
+  log_level: info
+  daemon_options:
+    dir_mode: !ruby/symbol normal
+    log_dir: log
+    dir: log
+    log_output: true
+    backtrace: true
+    multiple: false
+production:
+  <<: *development
+test:
+  <<: *development
+  base_delivery_method: test1
+  emergency_delivery_method: test2
+  log_level: error

data/lib/mongo_mailer.rb

@@ -1,5 +1,12 @@
+require 'active_support/all'
 require 'mail'
 require 'mongo'
+require 'daemons'
+require 'singleton'
+require 'mongo_mailer/version'
+require 'mongo_mailer/configuration'
 
-module MongoMailer
-end
+require 'mongo_mailer/common/has_mongo_collection'
+Dir[File.expand_path('../mongo_mailer/common/*', __FILE__)].each do |lib|
+  require lib
+end

data/lib/mongo_mailer/capistrano.rb

@@ -0,0 +1,33 @@
+Capistrano::Configuration.instance.load do
+  after "deploy", "mongo_mailer:consider_restarting"
+
+  namespace :mongo_mailer do
+    def roles
+      fetch(:mongo_mailer_server_role, :app)
+    end
+
+    def command_prefix
+      "cd #{current_path} && bundle exec mongo_mailer"
+    end
+
+    desc "Stop the mongo_mailer process"
+    task :stop, :roles => lambda { roles } do
+      run "#{command_prefix} stop #{rails_env}"
+    end
+
+    desc "Start the mongo_mailer process"
+    task :start, :roles => lambda { roles } do
+      run "#{command_prefix} start #{rails_env}"
+    end
+
+    desc "Restart the mongo_mailer process"
+    task :restart, :roles => lambda { roles } do
+      run "#{command_prefix} restart #{rails_env}"
+    end
+
+    desc "Restart the mongo_mailer process"
+    task :consider_restarting, :roles => lambda { roles } do
+      logger.info "Consider restarting mongo_mailer after deploy: `bundle exec cap #{fetch(:stage)} mongo_mailer:restart`"
+    end
+  end
+end

data/lib/mongo_mailer/capistrano3.rb

@@ -0,0 +1,49 @@
+after "deploy", "mongo_mailer:consider_restarting"
+
+namespace :load do
+  task :defaults do
+    set :mongo_mailer_server_role, -> { :app }
+    # Rbenv, Chruby, and RVM integration
+    set :rbenv_map_bins, fetch(:rbenv_map_bins).to_a.concat(%w(mongo_mailer))
+    set :rvm_map_bins, fetch(:rvm_map_bins).to_a.concat(%w(mongo_mailer))
+    set :chruby_map_bins, fetch(:chruby_map_bins).to_a.concat(%w(mongo_mailer))
+    # Bundler integration
+    set :bundle_bins, fetch(:bundle_bins).to_a.concat(%w(mongo_mailer))
+  end
+end
+
+namespace :mongo_mailer do
+  desc "Stop the mongo_mailer process"
+  task :stop do
+    on roles fetch(:mongo_mailer_server_role) do
+      within(current_path) do
+        execute :mongo_mailer, :stop, fetch(:rails_env)
+      end
+    end
+  end
+
+  desc "Start the mongo_mailer process"
+  task :start do
+    on roles fetch(:mongo_mailer_server_role) do
+      within(current_path) do
+        execute :mongo_mailer, :start, fetch(:rails_env)
+      end
+    end
+  end
+
+  desc "Restart the mongo_mailer process"
+  task :restart do
+    on roles fetch(:mongo_mailer_server_role) do
+      within(current_path) do
+        execute :mongo_mailer, :restart, fetch(:rails_env)
+      end
+    end
+  end
+
+  desc "Consider restarting the mongo_mailer process"
+  task :consider_restarting do
+    on roles fetch(:mongo_mailer_server_role) do
+      info "Consider restarting mongo_mailer after deploy: `bundle exec cap #{fetch(:stage)} mongo_mailer:restart`"
+    end
+  end
+end

data/lib/mongo_mailer/common/deliveries_counter.rb

@@ -0,0 +1,18 @@
+module MongoMailer
+  class DeliveriesCounter
+    include Singleton
+    include ::MongoMailer::HasMongoCollection
+
+    def increment(type)
+      collection.update({ type: type }, { '$inc' => { value: 1 } }, {upsert: true})
+    end
+
+    def by_type(type)
+      collection.find_one({type: type})
+    end
+
+    def all
+      collection.find.to_a
+    end
+  end
+end

data/lib/mongo_mailer/common/has_mongo_collection.rb

@@ -0,0 +1,36 @@
+module MongoMailer
+  module HasMongoCollection
+    def self.included(klass)
+      klass.send :extend, ClassMethods
+      klass.send :include, InstanceMethods
+    end
+
+    module InstanceMethods
+      def collection
+        self.class.collection
+      end
+
+      def configuration
+        self.class.configuration
+      end
+    end
+
+    module ClassMethods
+      def collection_name=(name)
+        @collection_name = name
+      end
+
+      def collection_name
+        @collection_name ||= self.name.demodulize.underscore.pluralize
+      end
+
+      def collection
+        @collection ||= Configuration.instance.mongodb.collection(collection_name)
+      end
+
+      def configuration
+        Configuration.instance
+      end
+    end
+  end
+end

data/lib/mongo_mailer/common/mail_queue.rb

@@ -0,0 +1,49 @@
+module MongoMailer
+  class MailQueue
+    include Singleton
+    include MongoMailer::HasMongoCollection
+
+    MAX_RETIRES_COUNT = 5
+
+    def find_and_deliver!
+      item = get_oldest
+    
+      return unless item
+
+      deliver!(item)
+    end
+
+    def get_oldest
+      collection.find_and_modify(
+        query: { invalid: nil },
+        remove: true,
+        sort: { :'$natural' => 1 })
+    end
+
+    def invalid_items
+      collection.all(
+        { invalid: true },
+        sort: { :'$natural' => 1 })
+    end
+
+    def clear_invalid_items!
+      collection.remove({ invalid: true })
+    end
+
+    private
+
+    def deliver!(item)
+      begin
+        ::MongoMailer::FinalDeliverer.new(item['encoded']).deliver!
+        collection.remove(item)
+        return true
+      rescue => e
+        configuration.log_error(e)
+        item['retries_count'] = (item['retries_count'] || 0) + 1
+        item['invalid'] = true if item['retries_count'] > MAX_RETIRES_COUNT
+        collection.insert(item)
+        return false
+      end
+    end
+  end
+end

data/lib/mongo_mailer/configuration.rb

@@ -0,0 +1,127 @@
+require 'singleton'
+require 'mongo_mailer/core_ext/hash'
+
+module MongoMailer
+  class Configuration
+    include Singleton
+
+    class MissingConfigurationFile < StandardError; end
+    class MissingConfigurationData < StandardError; end
+    class MissingConfigurationVariables < StandardError; end
+
+    REQUIRED_KEYS = [:mongodb, :base_delivery_method, :emergency_delivery_method]
+
+    def env
+      @env ||= defined?(Rails) ? Rails.env.to_s : ENV['RAILS_ENV']
+    end
+
+    def root
+      return @root if @root
+      @root = Rails.root if defined?(Rails)
+    end
+
+    def root=(path)
+      @root = Pathname.new(path)
+    end
+
+    def configuration
+      @configuration ||= load!
+    end
+
+    def load!
+      unless root
+        warn "`MongoMailer::Configuration.instance.root` does not seem to be set!"
+        return false
+      end
+
+      @configuration = begin
+        load_yml('config/mongo_mailer.yml')
+      rescue MissingConfigurationFile
+        warn "`config/mongo_mailer.yml` seems to be missing, loading `config/mongo_mailer.yml.example` file instead."
+        load_yml('config/mongo_mailer.yml.example')
+      end
+    end
+
+    def verify!
+      missing_keys = REQUIRED_KEYS - configuration.keys
+      unless missing_keys.empty?
+        raise MissingConfigurationVariables("Following variables are missing in your configuration file: #{missing_keys.join(',')}")
+      end
+      return true
+    end
+
+    def mongodb
+      configuration[:mongodb][:name] ||= 'mongo_mailer'
+      @mongodb ||= ::Mongo::MongoClient.new(configuration[:mongodb][:host], configuration[:mongodb][:port]).db("#{configuration[:mongodb][:name]}_#{env}")
+    end
+
+    def lookup_delivery_method(method)
+      method = ::Mail::Configuration.instance.lookup_delivery_method(method.to_s)
+      return method unless method.is_a?(String)
+
+      case method.to_sym
+      when :test1 then MongoMailer::DeliveryMethods::Test1Mailer
+      when :test2 then MongoMailer::DeliveryMethods::Test2Mailer
+      else
+        raise "Unknown delivery method: #{method}"
+      end
+    end
+
+    def base_delivery
+      @base_delivery ||= [
+        lookup_delivery_method(configuration[:base_delivery_method]),
+        configuration[:base_delivery_settings]
+      ]
+    end
+
+    def emergency_delivery
+      @emergency_delivery ||= [
+        lookup_delivery_method(configuration[:emergency_delivery_method]),
+        configuration[:emergency_delivery_settings]
+      ]
+    end
+
+    def full_daemon_options
+      opts = configuration[:daemon_options]
+      opts[:log_dir] = root.join(opts[:log_dir]).to_s if opts[:log_dir]
+      opts[:dir]     = root.join(opts[:dir]).to_s if opts[:dir]
+      return opts
+    end
+
+    def logger
+      @logger ||= init_logger
+    end
+
+    def log_error(e)
+      msg = [e.inspect, e.backtrace].flatten.join("\n")
+      logger.error("[ERROR] #{msg}")
+    end
+
+    private
+
+    def init_logger
+      logger = Logger.new(File.join(self.root, 'log/mongo_queue.log'), 'weekly')
+      logger.formatter = Logger::Formatter.new
+
+      log_level     = (configuration[:log_level] || :info)
+      logger.level  = Logger.const_get(log_level.to_s.upcase)
+      logger
+    end
+
+    def load_yml(file)
+      path = File.join(self.root, file)
+
+      unless File.exists?(path)
+        raise MissingConfigurationFile.new("File #{path} was found")
+      end
+
+      yml = ::YAML.load_file(path)
+
+      if yml[self.env].is_a?(Hash)
+        return yml[self.env].deep_symbolize_keys
+      else
+        raise MissingConfigurationData.new("Configuration data for #{self.env} was not found in #{path}")
+      end
+    end
+  end
+end

data/lib/mongo_mailer/core_ext/hash.rb

@@ -0,0 +1,12 @@
+class Hash
+  # Hash#deep_symbolize_keys 
+  # based on
+  # https://github.com/svenfuchs/i18n/blob/master/lib/i18n/core_ext/hash.rb
+  def deep_symbolize_keys
+    inject({}) { |result, (key, value)|
+      value = value.deep_symbolize_keys if value.is_a?(self.class)
+      result[(key.to_sym rescue key) || key] = value
+      result
+    }
+  end unless self.method_defined?(:deep_symbolize_keys)
+end

data/lib/mongo_mailer/delivery_methods/mongo_queue.rb

@@ -0,0 +1,28 @@
+require 'mail/check_delivery_params'
+
+module MongoMailer
+  module DeliveryMethods
+    class MongoQueue
+      attr_accessor :settings
+
+      def initialize(options = {})
+        @settings = options.merge(return_response: true)
+      end
+
+      def deliver!(mail)
+        Mail::CheckDeliveryParams.check(mail)
+        collection.insert({encoded: mail.encoded, uuid: get_uuid})
+      end
+
+      private
+
+      def get_uuid
+        ::SecureRandom.hex(8)
+      end
+
+      def collection
+        @collection ||= ::MongoMailer::MailQueue.instance.collection
+      end
+    end
+  end
+end

data/lib/mongo_mailer/delivery_methods/test.rb

@@ -0,0 +1,38 @@
+require 'mail/check_delivery_params'
+
+module MongoMailer
+  module DeliveryMethods
+    module CommonTestMailer
+      def self.included(klass)
+        klass.send :extend,  ClassMethods
+        klass.send :include, InstanceMethods
+        klass.send :attr_accessor, :settings
+      end
+
+      module InstanceMethods
+        def initialize(*args)
+          @settings = {}
+        end
+
+        def deliver!(mail)
+          Mail::CheckDeliveryParams.check(mail)
+          self.class.deliveries << mail
+        end
+      end
+
+      module ClassMethods
+        def deliveries
+          @deliveries ||= []
+        end
+      end
+    end
+
+    class Test1Mailer
+      include CommonTestMailer
+    end
+
+    class Test2Mailer
+      include CommonTestMailer
+    end
+  end
+end