mongo_mailer 0.0.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 1f28fa35aeba2febbdacacaa1c5ab93966d88bee4bd91d72106bb45f9ca38060
-  data.tar.gz: 86edf6e41fceec20af13046be6223b27af265528e870d0ae40b3eeb3a9660153
+SHA1:
+  metadata.gz: ae32a268782ce6659964b4f2e4730c04daa55f77
+  data.tar.gz: f080335933a7bb536e31018fa5d0fb867b13f453
 SHA512:
-  metadata.gz: b8cb494a687cb716aa47f8170219e9d3d875ebcb299070d2a5ef03c5d925cd131db2d4d4effe3e4ab3c58635c78ae4b12ea3698a51d6a6ff09f0d46a659593e1
-  data.tar.gz: 6df867865f4cd2ad758bceee71d2a94777c28c612c64eb67a05838fe615dc32ecab7615aeb0c0454504dc089811a280c918b516b97178220ef45ddf97c6df54b
+  metadata.gz: 2fde9a9f5b98b0ecf6df6024f98ea1a8e76700734bea9c104cb234dd29c3a3a04b9de0fd1b5be75523e969e6c2533dc49969b6ef62fe4b4e80d256b73a036cf7
+  data.tar.gz: 42f8b6b9d11754fd45a40d36de3d6cb5bfdaf9e0e621327a1fbeb3217c10a627aa2726937cbf643a9442c31504458299845ebe671f9cdbb6cdf0d126863ff38f

data/.gitignore

@@ -1,14 +1,11 @@
+.rvmrc
+.ruby-version
+.ruby-gemset
 *.gem
-.bundle
-.config
-.yardoc
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-tmp
-.coveralls.yml
-spec/examples.txt
+*.swp
+.DS_Store
+
+tmp/
+log/
+coverage/
+config/*.yml

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+services: mongodb
+rvm:
+  - "2.2"
+  - "2.3"
+  - "2.4"

data/Gemfile

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

data/Gemfile.lock

@@ -1,76 +1,127 @@
 PATH
   remote: .
   specs:
-    mongo_mailer (0.0.0)
-      mail
-      mongo (~> 2.15)
+    mongo_mailer (0.1.2)
+      activesupport (>= 4.2.8)
+      bson_ext (~> 1.9.2)
+      daemons (~> 1.1.9)
+      mail (~> 2.5.5)
+      mongo (~> 1.9.2)
 
 GEM
-  remote: https://rubygems.org/
+  remote: http://rubygems.org/
   specs:
-    ast (2.4.2)
-    bson (4.12.1)
-    coderay (1.1.3)
-    diff-lcs (1.4.4)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    method_source (1.0.0)
-    mini_mime (1.1.0)
-    mongo (2.15.0)
-      bson (>= 4.8.2, < 5.0.0)
-    parallel (1.20.1)
-    parser (3.0.2.0)
-      ast (~> 2.4.1)
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rainbow (3.0.0)
-    rake (13.0.6)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    actionmailer (4.2.9)
+      actionpack (= 4.2.9)
+      actionview (= 4.2.9)
+      activejob (= 4.2.9)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.9)
+      actionview (= 4.2.9)
+      activesupport (= 4.2.9)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.9)
+      activesupport (= 4.2.9)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (4.2.9)
+      activesupport (= 4.2.9)
+      globalid (>= 0.3.0)
+    activesupport (4.2.9)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    bson (1.9.2)
+    bson_ext (1.9.2)
+      bson (~> 1.9.2)
+    builder (3.2.3)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    daemons (1.1.9)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    erubis (2.7.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.4)
+    json (2.1.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.5.5)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    mini_portile2 (2.2.0)
+    minitest (5.10.2)
+    mongo (1.9.2)
+      bson (~> 1.9.2)
+    multi_json (1.12.1)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
+    polyglot (0.3.5)
+    rack (1.6.8)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.8)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    rake (10.1.1)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.18.4)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.8.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.8.0)
-      parser (>= 3.0.1.1)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
-    rubocop-rspec (2.4.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.0.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    thread_safe (0.3.6)
+    tins (0.13.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
 
 PLATFORMS
-  x86_64-darwin-20
+  ruby
 
 DEPENDENCIES
+  actionmailer (>= 4.2.8)
+  coveralls
   mongo_mailer!
-  pry
-  rake
-  rspec
-  rubocop
-  rubocop-rake
-  rubocop-rspec
+  rake (>= 10.0.4)
+  rspec (>= 2.14.0)
 
 BUNDLED WITH
-   2.2.24
+   1.15.1

data/README.md

@@ -0,0 +1,112 @@
+# MongoMailer
+
+[![Gem Version](https://badge.fury.io/rb/mongo_mailer.png)][gem_version]
+[![Build status](https://secure.travis-ci.org/infakt/mongo_mailer.png?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/infakt/mongo_mailer.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/infakt/mongo_mailer/badge.png?branch=master)][coveralls]
+
+[gem_version]: https://rubygems.org/gems/mongo_mailer
+[travis]: http://travis-ci.org/infakt/mongo_mailer
+[codeclimate]: https://codeclimate.com/github/infakt/mongo_mailer
+[coveralls]: https://coveralls.io/r/infakt/mongo_mailer
+
+
+## Asynchronous mail delivery with mongodb for Rails
+
+### Elements
+
+* Rails plugin containing delivery_method, generators, capistrano recipies
+* worker daemon fetching mails for queue and doing the final delivery using two methods: base and emergency, if base delivery fails, then emergency is being used.
+
+### Rails plugin
+
+Add mongo_mailer to your `Gemfile`:
+<pre>
+gem 'mongo_mailer', require: 'mongo_mailer/rails'
+</pre>
+
+Run the generator:
+<pre>
+bundle exec rails generate mongo_mailer
+</pre>
+which creates `config/mongo_mailer.yml.example`
+
+Based on example configuration file, create `mongo_mailer.yml` and add it to gitignored. 
+`mongo_mailer.yml` contains configuration of mongo database and final delivery methods used by worker.
+
+Set `ActionMailer::Base` delivery method in your environment file:
+<pre>
+config.action_mailer.delivery_method :mongo_queue
+</pre>
+
+Add mongo_mailer capistrano recipies, by adding:
+<pre>
+require 'mongo_mailer/capistrano'
+</pre>
+to your `deploy.rb`. Since then you have access to `cap mongo_mailer:start|stop|restart` recipies.
+
+### Standalone worker
+
+Worker can be used within a rails app or as a standalone application. In both cases only mongo_mailer related stuff is used - rails are never being loaded.
+
+Worker usees [daemons](https://rubygems.org/gems/daemons) to daemonize the process, continuously polls mongo queue for new mail and does the final delivery.
+
+* to start, stop or restart worker just run:
+<pre>
+bundle exec mongo_mailer start|stop|restart [rails_env]
+</pre>
+within a rails app, or:
+<pre>
+bundle exec worker start|stop|restart [app_env]
+</pre>
+in a standalone version.
+
+* by default workers activity and pids are being loged in the app's `log` directory:
+<pre>
+log/mongo_mailer.output
+log/mongo_mailer.log
+log/mongo_mailer.pid
+</pre>
+you can change it, by modifying proper daemon options in `mongo_mailer.yml`.
+
+* all sent mail are logged into:
+<pre>
+log/mongo_queue.log
+</pre>
+
+### Debugging & stats
+
+mongo_mailer doesn't have any web interface, so irb console is the only interface to get information :)
+
+#### Getting number of sent messages for each delivery method:
+
+<pre>
+MongoMailer::DeliveriesCounter.instance.by_type(:base)
+=> {"_id"=>BSON::ObjectId('5177ecb0df30cc350e3fbdf3'), "type"=>:base, "value"=>11}
+
+MongoMailer::DeliveriesCounter.instance.by_type(:emergency)
+=> {"_id"=>BSON::ObjectId('5178f501df30cc350e3fbdf4'), "type"=>:base, "value"=>1}
+
+MongoMailer::DeliveriesCounter.instance.all
+=> [{"_id"=>BSON::ObjectId('5177ecb0df30cc350e3fbdf3'), "type"=>:base, "value"=>11}, {"_id"=>BSON::ObjectId('5178f501df30cc350e3fbdf4'), "type"=>:emergency, "value"=>1}]
+</pre>
+
+#### Getting list of unsent message due to errors:
+
+<pre>
+MongoMailer::MailQueue.instance.invalid_items
+</pre>
+
+#### Clearing the list of unsent messages:
+
+<pre>
+MongoMailer::MailQueue.instance.clear_invalid_items!
+</pre>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,8 +1,11 @@
+#!/usr/bin/env rake
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
-RuboCop::RakeTask.new
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = './spec/**/*_spec.rb'
+  t.rspec_opts = ['--profile', '--color']
+end
 
-task default: %i[rubocop spec]
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "irb"
+require "irb/completion"
+require File.expand_path('../../config/boot', __FILE__)
+
+IRB.start

data/bin/mongo_mailer

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+ENV['RAILS_ENV'] = ENV['APP_ENV'] = ARGV[1] || 'development'
+
+require 'mongo_mailer/standalone'
+
+rails_root = File.dirname(ENV['BUNDLE_GEMFILE'])
+
+MongoMailer::Configuration.instance.root = rails_root
+MongoMailer::Configuration.instance.load!
+
+MongoMailer::Worker.new.run!

data/bin/worker

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+ENV['RAILS_ENV'] = ENV['APP_ENV'] = ARGV[1] || 'development'
+
+require File.expand_path('../../config/boot', __FILE__)
+
+MongoMailer::Worker.new.run!

data/config/boot.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+ENV['RAILS_ENV'] ||= 'development'
+
+require 'bundler/setup'
+Bundler.require
+
+require 'mongo_mailer/standalone'
+
+MongoMailer::Configuration.instance.root = File.expand_path("../..", __FILE__)
+MongoMailer::Configuration.instance.load!

data/config/mongo_mailer.yml.example

@@ -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