mailcannon 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: c76844e3b36af8d15ea57c40d77894449392a62c
-  data.tar.gz: f0283cff4d2c2d18a6c25552b42ae64206334b84
-SHA512: 
-  metadata.gz: 4872da07cf07f5d27a8be700dfee7c52f1bb6685f9ce02946ede451554b121368168270889f5a3b7385553474ab28720760b3177cf3cae58cc7e4e262977d902
-  data.tar.gz: 53c32841dd0e9f407827b899b76784816489729ad52f0d66d58602e59468617a2ac3b78bf00381975f4fa4225cead3c3563252e3f8397a5900fe55a7ebe4450c
+---
+SHA1:
+  metadata.gz: 4d633fe39d924cee3797b5e2f133dbaa8abe23f2
+  data.tar.gz: b61dd21b5ad3d561e40cd15bc96e328e2cc76403
+SHA512:
+  metadata.gz: 8c25da71c5a0387fd8d62b65cffb4d881b2d93917d80240e28fb7a23626fc17c355ca3dd634d7247c4ff5136c056b2a76f6dbd52329818662c16595fc8e37ede
+  data.tar.gz: cd55772c0f1a9eb64a67a1bea3501f56300409208dbc135cc18eb8aabe83715fc4c22dd592355f9b35f46911de4548a3381dff0abe984c14c5a758800e5bab33

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+pkg
+tmp
+env.sh

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+rbx-2.2.1

data/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - rbx-2.1.1
+  - 2.0.0-p353
+  - 1.9.3-p448
+  - jruby-19mode
+before_install:
+- gem install bundler
+services:
+  - mongodb
+  - redis

data/Gemfile

@@ -1,2 +1,22 @@
-source "https://rubygems.org"
-gemspec
+source 'https://rubygems.org'
+
+gem 'redis'
+gem 'mongoid'
+gem 'sidekiq'
+gem 'sendgrid_webapi'
+gem 'librato-metrics'
+gem 'rubysl', platform: :rbx
+gem 'jruby-openssl', platform: :jruby
+
+group :development do
+  gem 'rspec'
+  gem 'rspec-mocks'
+  gem 'rspec-expectations'
+  gem 'database_cleaner'
+  gem 'factory_girl'
+  gem 'vcr'
+  gem 'webmock', '>= 1.8.0', '< 1.16'
+  gem 'rake'
+  gem 'pry'
+  gem 'pry-nav'
+end

data/Gemfile.lock

@@ -1,14 +1,3 @@
-PATH
-  remote: .
-  specs:
-    mailcannon (0.0.1)
-      librato-metrics
-      mongoid
-      redis
-      rubysl
-      sendgrid_webapi
-      sidekiq
-
 GEM
   remote: https://rubygems.org/
   specs:
@@ -18,13 +7,19 @@ GEM
     activesupport (3.2.16)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
+    addressable (2.3.5)
     aggregate (0.2.2)
     builder (3.0.4)
     celluloid (0.15.2)
       timers (~> 1.1.0)
     coderay (1.0.9)
     connection_pool (1.2.0)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    database_cleaner (1.2.0)
     diff-lcs (1.2.4)
+    factory_girl (4.3.0)
+      activesupport (>= 3.0.0)
     faraday (0.8.8)
       multipart-post (~> 1.2.0)
     ffi2-generators (0.1.1)
@@ -264,6 +259,7 @@ GEM
     rubysl-xmlrpc (2.0.0)
     rubysl-yaml (2.0.4)
     rubysl-zlib (2.0.1)
+    safe_yaml (0.9.7)
     sendgrid_webapi (0.0.2)
       faraday (~> 0.8.0)
       json (~> 1.8.0)
@@ -276,14 +272,29 @@ GEM
     slop (3.4.5)
     timers (1.1.0)
     tzinfo (0.3.38)
+    vcr (2.8.0)
+    webmock (1.15.2)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  mailcannon!
+  database_cleaner
+  factory_girl
+  jruby-openssl
+  librato-metrics
+  mongoid
   pry
   pry-nav
   rake
+  redis
   rspec
+  rspec-expectations
   rspec-mocks
+  rubysl
+  sendgrid_webapi
+  sidekiq
+  vcr
+  webmock (>= 1.8.0, < 1.16)

data/Readme.md

@@ -0,0 +1,52 @@
+[![Gem version](https://badge.fury.io/rb/mailcannon.png)](http://rubygems.org/gems/mailcannon) [![Code Climate](https://codeclimate.com/github/lucasmartins/mailcannon.png)](https://codeclimate.com/github/lucasmartins/mailcannon) [![Build Status](https://travis-ci.org/lucasmartins/mailcannon.png?branch=master)](https://travis-ci.org/lucasmartins/mailcannon) [![Dependency Status](https://gemnasium.com/lucasmartins/mailcannon.png)](https://gemnasium.com/lucasmartins/mailcannon)
+
+MailCannon
+==========
+
+This is a **WORK IN PROGRESS**
+
+This Gem relies heavily on both [Sidekiq](https://github.com/mperham/sidekiq) and Celluloid Gems, you are encouraged to use it anywhere with Ruby (a http interface is on the Roadmap ).
+
+This Gem provides workers ready for deploy cooked with [MongoDB](http://www.mongodb.org/) + [Mongoid](https://github.com/mongoid/mongoid) + [Sidekiq](https://github.com/mperham/sidekiq) + [Rubinius](http://rubini.us/) (feel free to use on MRI and jruby as well).
+
+Install
+=======
+
+You can:
+```
+  $ gem install mailcannon
+```
+
+Or just add it to your Gemfile
+```
+  gem 'mailcannon'
+```
+
+Use
+===
+
+### Configuration file
+If you are on Rails, run the following command to generate a config file:
+
+`$ rails g mailcannon:config`
+
+Edit the file to meet your environemnt needs.
+
+Check the [specs](https://github.com/lucasmartins/mailcannon/tree/master/spec) to see the testing example, it will surely make it clearer.
+
+Contribute
+==========
+
+Just fork [MailCannon](https://github.com/lucasmartins/mailcannon), add your feature+spec, and make a pull request. Do not mess up with the version file though.
+
+**NOTICE**: The project is at embrionary stage, breaking changes will apply.
+
+Support
+=======
+
+This is an opensource project so don't expect premium support, but don't be shy, post any troubles you're having in the [Issues](https://github.com/lucasmartins/mailcannon/issues) page and we'll do what we can to help.
+
+License
+=======
+
+MailCannon is free software under the [MIT license](http://lucasmartins.mit-license.org).

data/config/locales/en.yml

@@ -0,0 +1 @@
+en:

data/config/locales/pt-BR.yml

@@ -0,0 +1 @@
+pt-BR:

data/env.sample.sh

@@ -0,0 +1,7 @@
+export REDIS_URL='redis://localhost:6379'
+export SENDGRID_PASSWORD=''
+export SENDGRID_USERNAME=''
+export LIBRATO_SOURCE='staging'
+export LIBRATO_USER=''
+export LIBRATO_TOKEN=''
+

data/lib/mailcannon/adapter.rb

@@ -0,0 +1,15 @@
+module MailCannon::Adapter
+
+  module InstanceMethods
+    def send!
+      raise 'Not available for this adapter!'
+    end
+    def send_bulk!
+      raise 'Not available for this adapter!'
+    end
+  end
+  
+  def self.included(receiver)
+    receiver.send :include, InstanceMethods
+  end
+end

data/lib/mailcannon/adapters/sendgrid.rb

@@ -0,0 +1,44 @@
+module MailCannon::Adapter
+  module Sendgrid
+    include MailCannon::Adapter
+    module InstanceMethods
+      def send!
+        raise 'Invalid Document!' unless self.valid?
+        response = send_single_email
+        self.after_sent(successfully_sent?(response))
+        return response
+      end
+    end
+    
+    def self.included(receiver)
+      receiver.send :include, InstanceMethods
+    end
+    
+    private
+    def api_client
+      client = SendGridWebApi::Client.new(ENV['SENDGRID_USERNAME'], ENV['SENDGRID_PASSWORD'])
+    end
+    
+    def send_single_email
+      api_client.mail.send(
+                :to => self.to,
+                :toname => self.to_name,
+                :subject => self.subject,
+                :text => self.mail.text,
+                :html => self.mail.html,
+                :from => self.from,
+                :fromname => self.from_name,
+                :bcc => self.bcc,
+                :replyto => self.reply_to
+              )
+    end
+    
+    def successfully_sent?(response)
+      if response['message']=='success'
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/lib/mailcannon/envelope.rb

@@ -0,0 +1,49 @@
+load 'lib/mailcannon/adapters/sendgrid.rb'
+
+class MailCannon::Envelope
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include MailCannon::Adapter::Sendgrid
+  
+  has_one :mail
+  has_many :stamps
+  
+  field :from, type: String
+  field :from_name, type: String
+  field :to, type: String
+  field :to_name, type: String
+  field :subject, type: String
+  field :bcc, type: String
+  field :reply_to, type: String
+  field :date, type: Date
+  field :xsmtpapi, type: Hash
+  
+  validates :from, :to, :subject, :mail, presence: true
+  validates_associated :mail
+  
+  after_create do |envelope|
+    envelope.stamp! MailCannon::Event::New.stamp
+    MailCannon::SingleBarrel.perform_async(envelope.id)
+  end
+  
+  def stamp!(code)
+    self.class.valid_code_kind?(code)
+    self.stamps << MailCannon::Stamp.from_code(code)
+  end
+  
+  def after_sent(response)
+    if response
+      stamp!(MailCannon::Event::Processed.stamp)
+      self.mail.destroy
+      self.mail=nil # to avoid reload
+    end
+  end
+  
+  private
+  def self.valid_code_kind?(code)
+    unless [Fixnum, MailCannon::Stamp].include?(code.class) || MailCannon::Event.constants.include?(code.to_s.camelize.to_sym)
+      raise 'code must be an Integer, MailCannon::Event::*, or MailCannon::Stamp !'
+    end
+  end
+    
+end

data/lib/mailcannon/event.rb

@@ -0,0 +1,54 @@
+class MailCannon::Event
+  
+  EVENTS = [
+    'new',
+    'processed',
+    'delivered',
+    'open',
+    'click',
+    'deferred',
+    'spam_report',
+    'spam',
+    'unsubscribe',
+    'drop',
+    'bounce'
+  ]
+  
+  EVENTS.each do |module_name|
+MailCannon::Event.class_eval <<RUBY
+module #{module_name.camelize}
+  def self.to_i
+    #{EVENTS.index(module_name)}
+  end
+  def self.to_s
+    "#{module_name}"
+  end
+  def self.stamp
+    MailCannon::Stamp.new({code: #{EVENTS.index(module_name)} })
+  end
+  def self.to_stamp
+    self.stamp
+  end
+end
+RUBY
+  end # ends each loop
+
+  def self.from_code(code)
+    raise 'code must be an Integer or String!' unless code.is_a?(Integer)||code.is_a?(String)
+    if code.is_a?(Integer)
+      return eval_module(EVENTS[code])
+    else
+      return eval_module(code)
+    end
+  end
+  
+  private
+  def self.eval_module(code)
+    if EVENTS.include?(code)
+      return eval("MailCannon::Event::#{code.camelize}")
+    else
+      raise "invalid code. Use one of the following: #{EVENTS}"
+    end
+  end
+  
+end

data/lib/mailcannon/mail.rb

@@ -0,0 +1,11 @@
+class MailCannon::Mail
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  
+  belongs_to :envelope, index: true
+  
+  field :text, type: String
+  field :html, type: String
+  
+  validate :text, presence: true
+end

data/lib/mailcannon/stamp.rb

@@ -0,0 +1,24 @@
+class MailCannon::Stamp
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  
+  belongs_to :envelope, index: true
+  
+  field :code, type: Integer, default: 0
+  
+  validate :code, :envelope, presence: true
+  
+  def event
+    MailCannon::Event.from_code(self.code)
+  end
+  
+  def self.from_code(code)
+    if code.is_a? Fixnum
+      return MailCannon::Stamp.new({code: code})
+    elsif code.is_a? MailCannon::Stamp
+      return code
+    else # MailCannon::Event::*
+      return code.stamp
+    end
+  end
+end

data/lib/mailcannon/version.rb

@@ -2,7 +2,7 @@ module MailCannon
   module Version
     MAJOR = 0
     MINOR = 0
-    PATCH = 1
+    PATCH = 2
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/lib/mailcannon/workers/multi_barrel.rb

@@ -0,0 +1,11 @@
+class MailCannon::MultiBarrel
+  include Sidekiq::Worker
+
+  def perform
+    raise 'Worker unavailable!'
+    # search pending emails in the db
+    # build the xsmtpapi Hash
+    # bulk_send!
+    # callbacks
+  end
+end

data/lib/mailcannon/workers/single_barrel.rb

@@ -0,0 +1,25 @@
+class MailCannon::SingleBarrel
+  include Sidekiq::Worker
+
+  def perform(envelope_id)
+    aggregator = Librato::Metrics::Aggregator.new
+    aggregator.time 'mailcannon.shooter.perform' do
+      envelope_id = envelope_id['$oid'] if envelope_id['$oid']
+      puts "sending MailCannon::Envelope.find('#{envelope_id}')"
+    
+      begin
+        envelope = MailCannon::Envelope.find(envelope_id)
+        if envelope.valid?
+          response = envelope.send!
+          unless response==true
+            raise response
+          end
+        end  
+      rescue Exception => e
+        puts "unable to send MailCannon::Envelope.find(#{envelope_id})"
+        puts e.backtrace
+      end
+    end
+    aggregator.submit
+  end
+end

data/lib/mailcannon.rb

@@ -1,3 +1,16 @@
+require 'yaml'
+require 'openssl'
+require 'bundler'
+require 'json'
+require 'mongoid'
+
+case ENV['RACK_ENV']
+when 'production'
+  Bundler.require(:default)
+else
+  Bundler.require(:default,:development)
+end
+
 Encoding.default_internal = "utf-8"
 Encoding.default_external = "utf-8"
 
@@ -9,8 +22,25 @@ class Module
 end
 
 module MailCannon
-
-  #load 'mailcannon/class.rb'
+  
+  load 'mailcannon/envelope.rb'
+  load 'mailcannon/mail.rb'
+  load 'mailcannon/stamp.rb'
+  load 'mailcannon/event.rb'
+  load 'mailcannon/adapter.rb'
+  load 'mailcannon/adapters/sendgrid.rb'
+  load 'mailcannon/workers/single_barrel.rb'
+  load 'mailcannon/version.rb'
+  
+  self.warmode if ENV['MAILCANNON_MODE']=='war'
+  
+  def self.warmode
+    Bundler.require(:default)
+    Mongoid.load!("config/mongoid.yml", ENV['RACK_ENV']) # change to env URL
+    Librato::Metrics.authenticate(ENV['LIBRATO_USER'], ENV['LIBRATO_TOKEN']) if ENV['LIBRATO_TOKEN'] && ENV['LIBRATO_USER'] # change to initializer
+    redis_uri = URI.parse(ENV['REDIS_URL'])
+    $redis = Redis.new(host: redis_uri.host, port: redis_uri.port)
+  end
 
   def self.config(root_dir=nil)
     @config ||= load_config(root_dir)
@@ -24,7 +54,7 @@ module MailCannon
     raise "Couldn't find config yml at #{path}." unless File.file?(path)
     content = File.read(path)
     erb = ERB.new(content).result
-    YAML.load(erb).with_indifferent_access
+    YAML.load(erb)
   end
 
 end

data/mailcannon.gemspec

@@ -27,8 +27,13 @@ Gem::Specification.new do |s|
   s.add_dependency 'rubysl'
   #s.add_dependency 'jruby-openssl'
 
+  s.add_development_dependency "vcr"
   s.add_development_dependency "rspec"
   s.add_development_dependency "rspec-mocks"
+  s.add_development_dependency "rspec-expectations"
+  s.add_development_dependency "webmock", '>= 1.8.0', '< 1.16'
+  s.add_development_dependency "database_cleaner"
+  s.add_development_dependency "factory_girl"
   s.add_development_dependency "rake"
   s.add_development_dependency "pry"
   s.add_development_dependency "pry-nav"

data/spec/factories/envelope.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+  factory :envelope, class: MailCannon::Envelope do
+    from 'test@mailcannon.com'
+    to 'lucasmartins@railsnapraia.com'
+    subject 'Test'
+    mail factory: :mail
+  end
+end

data/spec/factories/mail.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  factory :mail, class: MailCannon::Mail do
+    text  "If you can't read the HTML content, you're screwed!"
+    html "<html><body><p>You should see what happens when your email client can't read HTML content.</p></body></html>"
+  end
+end

data/spec/factories/stamp.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  factory :stamp, class: MailCannon::Stamp do
+    code 0
+    envelope factory: :envelope 
+  end
+end

data/spec/fixtures/cassettes/mailcannon_adapter_sendgrid.send.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://sendgrid.com/api/mail.send.json
+    body:
+      encoding: US-ASCII
+      string: to=lucasmartins%40railsnapraia.com&toname&subject=Test&text=If+you+can%27t+read+the+HTML+content%2C+you%27re+screwed%21&html=%3Chtml%3E%3Cbody%3E%3Cp%3EYou+should+see+what+happens+when+your+email+client+can%27t+read+HTML+content.%3C%2Fp%3E%3C%2Fbody%3E%3C%2Fhtml%3E&from=test%40mailcannon.com&fromname&bcc&replyto&api_user=app5967346%40heroku.com&api_key=i1att6wi
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.4.2
+      Date:
+      - Sun, 15 Dec 2013 18:53:38 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"message":"success"}'
+    http_version: 
+  recorded_at: Sun, 15 Dec 2013 18:53:33 GMT
+recorded_with: VCR 2.8.0

data/spec/fixtures/cassettes/mailcannon_adapter_sendgrid_send.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://sendgrid.com/api/mail.send.json
+    body:
+      encoding: US-ASCII
+      string: to=lucasmartins%40railsnapraia.com&toname&subject=Test&text=If+you+can%27t+read+the+HTML+content%2C+you%27re+screwed%21&html=%3Chtml%3E%3Cbody%3E%3Cp%3EYou+should+see+what+happens+when+your+email+client+can%27t+read+HTML+content.%3C%2Fp%3E%3C%2Fbody%3E%3C%2Fhtml%3E&from=test%40mailcannon.com&fromname&bcc&replyto&api_user=app5967346%40heroku.com&api_key=i1att6wi
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.4.2
+      Date:
+      - Sun, 15 Dec 2013 18:59:55 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"message":"success"}'
+    http_version: 
+  recorded_at: Sun, 15 Dec 2013 18:59:50 GMT
+recorded_with: VCR 2.8.0

data/spec/mailcannon/adapters/sendgrid_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe MailCannon::Adapter::Sendgrid do
+  describe "#send!" do
+    let(:envelope) { build(:envelope) }
+    it "sends http request for Sendgrid web API" do
+      VCR.use_cassette('mailcannon_adapter_sendgrid_send') do
+        expect(envelope.send!).to eq({"message"=>"success"})
+      end
+    end
+    it "calls after_sent callback" do
+      VCR.use_cassette('mailcannon_adapter_sendgrid_send') do
+        envelope.should_receive(:after_sent)
+        envelope.send!
+      end
+    end
+  end
+end
+