ses_machine 0.0.1.dev

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b1b83c2af26a6179d2161b61e2d6cbef89e3d93
+  data.tar.gz: 3cbee7e7443a3bf2231efad0215a560d40c4cb91
+SHA512:
+  metadata.gz: c632d7ea1e812b517003713666a4b55ba4fb2960115cd067858653033151262d798c9bac4eae153a462d5d02715d1008adfee019237fc0549f8d70065db64d0d
+  data.tar.gz: cb106e7c84abc41418ccb2b04ab416e338952062f0bceb27b036a179b7c84ce5cd8160f84b42c421af4dba571d3c16a41514d22eb8d61b659545ae617669ec99

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    ses_machine (0.0.1.dev)
+      aws-ses (>= 0.4.2)
+      mail (>= 2.2.15)
+      mongo (>= 1.3.0)
+      rubydkim (>= 0.3.1)
+      will_paginate (>= 2.3.15)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-ses (0.4.4)
+      builder
+      mail (> 2.2.5)
+      mime-types
+      xml-simple
+    bson (1.6.4)
+    builder (3.2.2)
+    dnsruby (1.53)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.24)
+    mongo (1.6.4)
+      bson (~> 1.6.4)
+    polyglot (0.3.3)
+    rubydkim (0.3.1)
+      dnsruby
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    will_paginate (3.0.3)
+    xml-simple (1.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ses_machine!

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Heiaheia.com
+
+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.rdoc

@@ -0,0 +1,13 @@
+Ses Machine
+==========
+
+Introduction goes here.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Copyright (c) 2011 Heiaheia.com, released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake/testtask'
+require 'rdoc/task'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the ses_machine plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the ses_machine plugin.'
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.rdoc'
+  rdoc.title = 'SES Machine'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_files.include('README.rdoc', 'lib/**/*.rb')
+end

data/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+# -*- encoding : utf-8 -*-
+
+class ApplicationController < ActionController::Base; end

data/app/controllers/ses_machine_controller.rb

@@ -0,0 +1,64 @@
+# -*- encoding : utf-8 -*-
+
+class SesMachineController < Admin::ApplicationController
+  unloadable
+
+  unless ENV['RAILS_ENV'].eql?('test')
+    include SesMachineAuthHooks
+    before_filter :ses_machine_authorize!
+  end
+
+  helper :ses_machine
+  before_filter :assign_database
+  layout 'ses_machine/application'
+
+  def index
+    @date = (params[:date] || Date.current).to_date.beginning_of_month
+    monthly_stats = @db['monthly_stats'].find().sort([['_id.year', Mongo::DESCENDING], ['_id.month', Mongo::DESCENDING]]).to_a
+    @monthly_stats = monthly_stats.map do |e|
+      date = Date.new(e['_id']['year'], e['_id']['month'])
+      [date.strftime("%B %Y"), date.to_s]
+    end
+    @stats = @db['monthly_stats'].find_one('_id.year' => @date.year, '_id.month' => @date.month)
+    @count_mails_sent = @stats.blank? ? 0 : @stats['value']['total'].to_i
+    @count_mails_bounced = @stats.blank? ? 0 : (@count_mails_sent - @stats['value'][SesMachine::Bounce::TYPES[:email_sent].to_s]).to_i
+  end
+
+  def activity
+    page = params[:page].to_i
+    page = 1 if page < 1
+    per_page = 25
+    @bounce_type = ''
+    @q = ''
+    conditions = {}
+    unless params[:type].blank?
+      @bounce_type = params[:type].to_i
+      conditions.merge!('bounce_type' => @bounce_type)
+    end
+    unless params[:q].blank?
+      @q = SesMachine::DB.get_keywords(params[:q].to_s.split)
+      conditions.merge!('_keywords' =>  {'$all' => @q}) unless @q.blank?
+    end
+    @messages = @mails.find(conditions).sort('date', -1).skip((page-1) * per_page).limit(per_page).to_a
+    messages_count = @mails.find(conditions).count
+    @bounce_types = SesMachine::Bounce::TYPES.map{|k, v| [k.to_s.humanize, v]}
+    @bounce_types.unshift(['All emails', ''])
+    @pager = WillPaginate::Collection.new(page, per_page, messages_count)
+  end
+
+  def show_message
+    begin
+      @mail = @mails.find_one('_id' => BSON::ObjectId(params[:id]))
+      @mail['body'] = Mail.read_from_string(@mail['raw_source']).body
+    rescue
+      flash[:error] = 'Mail not found'
+      redirect_to ses_machine_path
+    end
+  end
+
+  private
+    def assign_database
+      @db = SesMachine.database
+      @mails = @db['mails']
+    end
+end

data/app/helpers/ses_machine_helper.rb

@@ -0,0 +1,8 @@
+# -*- encoding : utf-8 -*-
+
+module SesMachineHelper
+  
+  def bounce_type(type)
+    SesMachine::Bounce::TYPES.invert[type].to_s
+  end
+end

data/app/views/layouts/ses_machine/application.html.erb

@@ -0,0 +1,20 @@
+<!doctype html>
+<html>
+<head>
+  <title>Ses Machine</title>
+  <%= stylesheet_link_tag('ses_machine') unless ENV['RAILS_ENV'].eql?('test') %>
+</head>
+<body>
+  <div id="ses-machine-wrapper">
+    <h1>Ses Machine</h1>
+    <ul>
+      <li><%= link_to_unless_current 'Overview',  url_for(:controller => 'ses_machine', :action => 'index') %></li>
+      <li><%= link_to_unless_current 'Activity', url_for(:controller => 'ses_machine', :action => 'activity') %></li>
+    </ul>
+    <%- flash.each do |k, v| -%>
+     <div class="flash-<%= k %>"><%= v %></div>
+    <%- end -%>
+    <%= yield -%>
+  </div>
+</body>
+</html>

data/app/views/ses_machine/activity.html.erb

@@ -0,0 +1,37 @@
+<h2>Activity</h2>
+
+<%= form_tag request.path, :method => :get do %>
+  <%= select_tag :type, options_for_select(@bounce_types, @bounce_type), :onchange => "this.form.submit();" %>
+  <%= text_field_tag "q", params[:q], :placeholder => 'Search by email or subject…' %>
+  <%= submit_tag 'Search', :disable_with => 'Searching...' -%>
+<% end %>
+
+
+<%- if !@messages.blank? -%>
+  <%- date = nil -%>
+  <%- @messages.each do |message| -%>
+    <%- if date.blank? || date.to_date != message['date'].to_date -%>
+      <div class="activity-date">
+        <%- if message['date'].today? -%>
+          Today
+        <%- else -%>
+          <%= message['date'].strftime('%B %d, %Y') %>
+        <%- end -%>
+      </div>
+      <hr class="black"/>
+      <%- date = message['date'] -%>
+    <%- end -%>
+    <div class="activity-item <%= bounce_type(message['bounce_type']).dasherize %>">
+      <span class="address"><%= link_to message['address'], url_for(:controller => 'ses_machine', :action => 'show_message', :id => message['_id']) %></span>
+      <br/>
+      <div class="status">
+        <%= bounce_type(message['bounce_type']).humanize %> &mdash; <%= message['date'].strftime('%d.%m.%Y %l:%M %p') %>
+      </div>
+      <div class="subject"><%= message['subject'] %></div>
+      <div class="clear"></div>
+    </div>
+  <%- end -%>
+  <%= will_paginate @pager %>
+<%- else -%>
+  No messages
+<%- end -%>

data/app/views/ses_machine/index.html.erb

@@ -0,0 +1,17 @@
+<h2>Mails Sent</h2>
+<div>
+  <% form_tag url_for(:controller => 'ses_machine', :action => 'index'), :method => :get do %>
+    <%= select_tag 'date', options_for_select(@monthly_stats, @date.to_s), :onchange => "this.form.submit();" %>
+  <%- end -%>
+</div>
+
+<div>
+  TRUE CHART
+</div>
+
+<h2>Mail Stats</h2>
+<div>
+  <p><%= @count_mails_sent %> mails sent</p>
+  <p><%= @count_mails_bounced %> mails bounced</p>
+</div>
+

data/app/views/ses_machine/show_message.html.erb

@@ -0,0 +1,76 @@
+<%- if !request.env["HTTP_REFERER"].blank? && request.env["HTTP_REFERER"] != request.env["REQUEST_URI"] -%>
+  <div style="float:right;"><%= link_to "&larr; Back", :back %></div>
+<%- end -%>
+<h2>Message Status</h2>
+<div class="clear"></div>
+<div><span style="color:#aaa;">Email</span> <span style="font-weight: bold;"><%= @mail['address'].join(', ') %></span></div>
+<div><span style="color:#aaa;">Subject</span> <%= @mail['subject'] %></div>
+<hr class="gray"/>
+
+<%- unless @mail['bounce'].blank? -%>
+  <div>
+    <%= @mail['bounce']['date'].strftime('%d.%m.%Y %l:%M %p') %> <%= bounce_type(@mail['bounce_type']).humanize %>
+    <%- unless @mail['bounce']['details'].blank? -%>
+      <div style="color:#aaa;font-size:small;"><%= @mail['bounce']['details'] %></div>
+    <%- end -%>
+  </div>
+<%- end -%>
+<div><%= @mail['date'].strftime('%d.%m.%Y %l:%M %p') %> <span><%= bounce_type(0).humanize %></span></div>
+
+<ul>
+  <%- unless @mail['response'].blank? -%>
+    <li><a href="#" onclick="showAmazonResponse();">XML Amazon Response</a></li>
+  <%- end -%>
+  <li><a href="#" onclick="showPlainText();">Plain Text</a></li>
+  <li><a href="#" onclick="showRawSource();">Raw Source</a></li>
+  <%- unless @mail['bounce'].blank? -%>
+    <li><a href="#" onclick="showBounceRawSource();">Bounce Raw Source</a></li>
+  <%- end -%>
+</ul>
+
+<%- unless @mail['response'].blank? -%>
+  <div id="amazon-response" style="display:none;font-size:small;border:1px solid #aaa;">
+    <pre><%= h @mail['response'] %></pre>
+  </div>
+<%- end -%>
+<div id="plain-text" style="font-size:small;border:1px solid #aaa;"><%= simple_format @mail['body'].to_s %></div>
+<div id="raw-source" style="display:none;font-size:small;border:1px solid #aaa;">
+  <%#= simple_format @mail['raw_source'] %>
+  <pre><%= h @mail['raw_source'] %></pre>
+</div>
+<%- unless @mail['bounce'].blank? -%>
+  <div id="bounce-raw-source" style="display:none;font-size:small;border:1px solid #aaa;">
+    <pre><%= h @mail['bounce']['raw_source'] %></pre>
+  </div>
+<%- end -%>
+
+<script type="text/javascript">
+  function showPlainText() {
+    document.getElementById('amazon-response').style.display = 'none';
+    document.getElementById('plain-text').style.display = null;
+    document.getElementById('raw-source').style.display = 'none';
+    document.getElementById('bounce-raw-source').style.display = 'none';
+    return false;
+  }
+  function showRawSource() {
+    document.getElementById('amazon-response').style.display = 'none';
+    document.getElementById('plain-text').style.display = 'none';
+    document.getElementById('raw-source').style.display = null;
+    document.getElementById('bounce-raw-source').style.display = 'none';
+    return false;
+  }
+  function showBounceRawSource() {
+    document.getElementById('amazon-response').style.display = 'none';
+    document.getElementById('plain-text').style.display = 'none';
+    document.getElementById('raw-source').style.display = 'none';
+    document.getElementById('bounce-raw-source').style.display = null;
+    return false;
+  }
+  function showAmazonResponse() {
+    document.getElementById('amazon-response').style.display = null;
+    document.getElementById('plain-text').style.display = 'none';
+    document.getElementById('raw-source').style.display = 'none';
+    document.getElementById('bounce-raw-source').style.display = 'none';
+    return false;
+  }
+</script>

data/generators/ses_machine/USAGE

@@ -0,0 +1,3 @@
+To copy a SesMachine initializer, configuration and stylesheets file to your Rails App just do
+    script/generate ses_machine
+

data/generators/ses_machine/ses_machine_generator.rb

@@ -0,0 +1,19 @@
+# -*- encoding : utf-8 -*-
+
+class SesMachineGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.directory 'config'
+      m.template 'ses_machine.yml', 'config/ses_machine.yml'
+
+      m.directory 'config/initializers'
+      m.template 'ses_machine.rb', 'config/initializers/ses_machine.rb'
+      m.template 'ses_machine_hooks.rb', 'config/initializers/ses_machine_hooks.rb'
+
+      m.directory 'public/stylesheets'
+      m.template 'ses_machine.css', 'public/stylesheets/ses_machine.css'
+
+      m.readme 'README' unless ENV['RAILS_ENV'].eql?('test')
+    end
+  end
+end

data/generators/ses_machine/templates/README

@@ -0,0 +1,7 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. TODO
+
+===============================================================================

data/generators/ses_machine/templates/ses_machine.css

@@ -0,0 +1,14 @@
+hr.black{border:none;border-bottom:1px solid black}
+hr.gray{border:none;border-bottom:1px solid #aaa}
+
+#ses-machine-wrapper{width:900px;margin:0 auto}
+
+.activity-date{padding:10px 0 5px 0;font-weight:bold}
+.activity-item{padding:5px 0;border:none;border-bottom:1px solid #aaa}
+    .activity-item.email-sent .address a{color:green}
+    .activity-item.unknown .address a{color:#666}
+    .activity-item.hard-bounce .address a{color:red}
+    .activity-item .status{float:right;color:gray;font-size:small}
+    .activity-item .subject{color:gray;font-size:small}
+.clear{height:1px;line-height:1px;clear:both}
+.flash-error{padding:8px 15px;border:1px solid #991010;background-color:#ffc0cb}

data/generators/ses_machine/templates/ses_machine.rb

@@ -0,0 +1,19 @@
+# -*- encoding : utf-8 -*-
+
+SesMachine.configure do |config|
+  # Email configuration for rake tasks
+  config.email_server = 'imap.googlemail.com'
+  config.email_port = 993
+  config.email_use_ssl = true
+  config.email_account = 'username@gmail.com' # The email address to which bounce notifications are to be forwarded.
+  config.email_password = '12345'
+  config.email_imap_folders = ['INBOX', '[Gmail]/Spam']
+
+  # DKIM
+  config.use_dkim = false
+  # config.dkim_domain = 'example.com'
+  # config.dkim_selector = 'ses'
+  # config.dkim_private_key = '/path/to/private/key'
+end
+
+

data/generators/ses_machine/templates/ses_machine.yml

@@ -0,0 +1,15 @@
+defaults: &defaults
+  database:
+    name: ses_machine_test
+    host: localhost
+    port: 27017
+
+development:
+  <<: *defaults
+  database:
+    name: ses_machine_development
+
+production:
+  <<: *defaults
+  database:
+    name: ses_machine_production

data/generators/ses_machine/templates/ses_machine_hooks.rb

@@ -0,0 +1,33 @@
+# -*- encoding : utf-8 -*-
+
+module SesMachineAuthHooks
+  protected
+
+  def ses_machine_authorize!
+    true
+  end
+end
+
+# module SesMachineHooks
+#   def soft_bounce_hook(email)
+#     # Add your code
+#   end
+#
+#   def hard_bounce_hook(email)
+#     # Add your code
+#   end
+#
+#   def unknown_hook(email)
+#     # Add your code
+#   end
+#
+#   def spam_complaint_hook(email)
+#     # Add your code
+#   end
+#
+#   def auto_responder_hook(email)
+#     # Add your code
+#   end
+# end
+
+# SesMachine::Hooks.send :extend, SesMachineHooks

data/init.rb

@@ -0,0 +1,3 @@
+# -*- encoding : utf-8 -*-
+
+require File.join(File.dirname(__FILE__), 'lib', 'ses_machine.rb')

data/install.rb

@@ -0,0 +1,3 @@
+# -*- encoding : utf-8 -*-
+
+# Install hook code here

data/lib/ses_machine/bounce.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+
+
+module SesMachine #:nodoc:
+  class Bounce #:nodoc:
+
+    TYPES = {
+      :email_sent => 0,
+      :unknown => 1,
+      :soft_bounce => 2,
+      :hard_bounce => 3,
+      :spam_complaint => 4,
+      :auto_responder => 5
+    }
+  end
+end

data/lib/ses_machine/config.rb

@@ -0,0 +1,107 @@
+# -*- encoding : utf-8 -*-
+
+
+module SesMachine #:nodoc:
+  class Config #:nodoc:
+    include Singleton
+
+    attr_accessor :ses,
+                  :dkim_domain, :dkim_selector, :dkim_private_key,
+                  :email_server, :email_port, :email_use_ssl, :email_account, :email_password, :email_imap_folders
+    attr_reader :database, :use_dkim
+    alias_method :use_dkim?, :use_dkim
+
+    # Defaults the configuration options
+    def initialize
+      reset
+    end
+
+    # Reset the configuration options to the defaults.
+    #
+    # Example:
+    #
+    # <tt>Config.reset</tt>
+    def reset
+      @use_dkim = false
+      @dkim_domain = nil
+      @dkim_selector = nil
+      @dkim_private_key = nil
+    end
+
+    def load(filename=nil)
+      filename = File.join(ENV['RAILS_ROOT'], 'config', 'ses_machine.yml') if filename.blank?
+      if File.exist?(filename)
+        settings = YAML.load_file(filename)[ENV['RAILS_ENV']]
+        from_hash(settings)
+      else
+        $stderr.puts "WARNING: File '#{filename}' doesn't exist"
+      end
+    end
+
+    # TODO: fix readme
+    # Sets whether the times returned from the database are in UTC or local time.
+    # If you omit this setting, then times will be returned in
+    # the local time zone.
+    #
+    # Example:
+    #
+    # <tt>Config.use_dkim = true</tt>
+    #
+    # Returns:
+    #
+    # A boolean
+    def use_dkim=(value=false)
+      @use_dkim = value
+    end
+
+    # Configure SesMachine from a hash that was usually parsed out of yml.
+    #
+    # Example:
+    #
+    # <tt>SesMachine::Config.instance.from_hash({})</tt>
+    def from_hash(settings)
+      _database(settings)
+      settings.except('database').each_pair do |name, value|
+        send("#{name}=", value) if respond_to?(name)
+      end
+    end
+
+    # Sets the Mongo::DB database to be used. If the object trying to be
+    # set is not a valid +Mongo::DB+, then an error will be raised.
+    #
+    # Example:
+    #
+    # <tt>Config.database = Mongo::Connection.db('test')</tt>
+    #
+    # Returns:
+    #
+    # The +Mongo::DB+ instance.
+    def database=(db)
+      check_database!(db)
+      @database = db
+    end
+
+    protected
+
+    # Check if the database is valid and the correct version.
+    #
+    # Example:
+    #
+    # <tt>config.check_database!</tt>
+    def check_database!(database)
+      raise Errors::InvalidDatabase.new(database) unless database.kind_of?(Mongo::DB)
+    end
+
+    # Get a database from settings.
+    #
+    # Example:
+    #
+    # <tt>config._database({})</tt>
+    def _database(settings)
+      name = settings['database']['name']
+      host = settings['database']['host'] || 'localhost'
+      port = settings['database']['port'] || 27017
+      self.database = Mongo::Connection.new(host, port).db(name)
+    end
+  end
+end