mailcannon 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36ee9ad3e66d2643ea8c836320032d2c4bbcf9e1
-  data.tar.gz: ab5103437e1bfa9d43eec27014dfcc43590af0c4
+  metadata.gz: 3959f5796552901e917b0be3bb6fb9aa24764385
+  data.tar.gz: d7e17ded5d4953acb0f5f1120d4f0ed3b5f70a07
 SHA512:
-  metadata.gz: 05c4f51be1809c2ce8c0960216c4392a3214d4dc0c8de368db77ec36482ca13f8ce91ac4779e6233d15eaf3181792a4bd8a77e659353a3584b177f1e5ac09b3b
-  data.tar.gz: ee3bc50462bcf0e27a8fabe9ee2c63f500f30b4063dcf997ac3551d5883a43140027945386e8a225b11531c0c342935460099d027ec1582fb4eb9cd39564df72
+  metadata.gz: 677148b0354d35fa556dd58890ea96b7991b28057fcc7dadf1df893805fb1db242d02b2eca74552dcb29fc40b9cb7005e8433479dbf58496214c7a0461d3204c
+  data.tar.gz: d6308cd543f6f44779d90d5ec62c4a799189ceebc4e4f653ffd4b368e62db775bd0b656c7192b7ecf7a5373bdf0f75aa2caad1edc4580bc98616d9b267a794e7

data/.gitignore

@@ -5,3 +5,6 @@ doc/
 .yardoc/
 coverage/
 .coveralls.yml
+pkg/
+Gemfile.lock
+config/mailcannon.yml

data/.travis.yml

@@ -2,7 +2,7 @@ rvm:
   - rbx-2.1.1
   - 2.0.0-p353
 #  - 1.9.3-p448
-  - jruby-19mode
+  - jruby-20mode
 before_install:
 - gem install bundler
 services:

data/Gemfile

@@ -1,16 +1,15 @@
 source 'https://rubygems.org'
 
 gem 'redis'
-gem 'mongoid'
+gem 'activemodel'
+gem 'mongoid', '3.1.6'
 gem 'sidekiq'
 gem 'sendgrid_webapi'
-#gem 'sendgrid_toolkit'
-gem 'librato-metrics'
+#gem 'librato-metrics'
 gem 'rubysl', platform: :rbx
 gem 'jruby-openssl', platform: :jruby
-#for SendgridWeb adapter
-gem "yajl-ruby", :platforms=>[:rbx,:ruby]
-gem "json-schema"
+gem 'yajl-ruby', :platforms=>[:rbx,:ruby]
+gem 'json-schema'
 
 group :development do
   gem 'rake'
@@ -24,7 +23,7 @@ group :test do
   gem 'rspec-mocks'
   gem 'rspec-expectations'
   gem 'database_cleaner'
-  gem 'factory_girl'
+  gem 'factory_girl', '4.2.0'
   gem 'vcr'
   gem 'webmock', '>= 1.8.0', '< 1.16'
   gem 'coveralls', platform: :ruby, require: false

data/Rakefile

@@ -13,6 +13,7 @@ end
 desc 'Opens a Pry/IRB session with the environment loaded'
 task :console => :environment do
   #gotcha!
+  Mongoid.load!("spec/support/mongoid.yml", 'development')
   binding.pry
 end
 

data/Readme.md

@@ -29,11 +29,28 @@ Create a `MailCannon::Envelope`:
 ```ruby
 envelope = MailCannon::Envelope.create(
   from: 'test@mailcannon.com',
-  to: 'lucasmartins@railsnapraia.com',
+  to: [{email: 'lucasmartins@railsnapraia.com', name: 'Lucas Martins'}],
   subject: 'Test',
-  mail: MailCannon::Mail.create(text: 'you will see this when no HTML reader is available', html: 'this should be an HTML'))
-envelope.send!
+  mail: MailCannon::Mail.new(text: 'you will see this when no HTML reader is available', html: 'this should be an HTML'))
+
+envelope.post!
+```
+
+### Campaign abstraction
+
+Create a `MailCannon::Envelope`:
+```ruby
+envelope_bag = MailCannon::EnvelopeBag.new(integration_code: 'my-cool-campaign')
+envelope = MailCannon::Envelope.create(
+  from: 'test@mailcannon.com',
+  to: [{email: 'lucasmartins@railsnapraia.com', name: 'Lucas Martins'}],
+  subject: 'Test',
+  mail: MailCannon::Mail.new(text: 'you will see this when no HTML reader is available', html: 'this should be an HTML'))
+envelope_bag.push envelope
+# envelope_bag.push ...
+envelope_bag.post!
 ```
+
 ### Configuration file
 If you are on Rails, run the following command to generate a config file:
 

data/lib/mailcannon/adapters/sendgrid_web.rb

@@ -11,7 +11,7 @@ module MailCannon::Adapter::SendgridWeb
         response = send_single_email
       end
       self.after_sent(successfully_sent?(response))
-      return response
+      return successfully_sent?(response)
     end
 
     def send_bulk!
@@ -34,14 +34,18 @@ module MailCannon::Adapter::SendgridWeb
 
   def prepare_xsmtpapi!
     validate_envelope!
-    self.xsmtpapi = build_xsmtpapi({'to'=>self.to},{'sub'=>self.substitutions})
+    self.xsmtpapi = {} if self.xsmtpapi.nil?
+    self.xsmtpapi = self.xsmtpapi.merge(build_xsmtpapi({'to'=>self.to},{'sub'=>self.substitutions}))
     validate_xsmtpapi!
+    self.save!
   end
 
   def build_xsmtpapi(recipients,subs)
     xsmtpapi = {}
     to = []
-    recipients['to'].each do |h|
+    recipients.symbolize_keys!
+    recipients[:to].each do |h|
+      h.symbolize_keys!
       to.push h[:email]
     end
     xsmtpapi.merge!({'to' => to})
@@ -71,9 +75,12 @@ module MailCannon::Adapter::SendgridWeb
   end
 
   def send_single_email
+    if self.xsmtpapi!=nil
+      logger.warn "Single emails do not support X-SMTPAPI! #{self.id}"
+    end
     api_client.mail.send(
-              :to => self.to.first[:email],
-              :toname => self.to.first[:name],
+              :to => self.to.first['email'],
+              :toname => self.to.first['name'],
               :subject => self.subject,
               :text => self.mail.text,
               :html => self.mail.html,
@@ -86,10 +93,8 @@ module MailCannon::Adapter::SendgridWeb
 
   def send_multiple_emails
     prepare_xsmtpapi!
-
     api_client.mail.send(
               :to => self.from,
-              #:toname => self.to.first[:name],
               :subject => self.subject,
               :text => self.mail.text,
               :html => self.mail.html,

data/lib/mailcannon/envelope.rb

@@ -6,12 +6,11 @@ class MailCannon::Envelope
   
   embeds_one :mail
   embeds_many :stamps
-  
-  field :group_id, type: Bignum # create sparse Index for this field, put this in RDoc
+  belongs_to :envelope_bag
+
   field :from, type: String
   field :from_name, type: String
-  field :to, type: Array # of hashes
-  field :to_name, type: Array # strings
+  field :to, type: Array # of hashes. [{email: '', name: ''},...]
   field :substitutions, type: Hash # of hashes
   field :subject, type: String
   field :bcc, type: String
@@ -21,24 +20,31 @@ class MailCannon::Envelope
   
   validates :from, :to, :subject, :mail, presence: true
   validates_associated :mail
-  
-  after_create :post_envelope!
 
   # Post this Envelope!
   def post_envelope!
     self.save if self.changed?
-    self.stamp! MailCannon::Event::New.stamp
+    self.stamp! MailCannon::Event::Posted.stamp
     if validate_xsmtpapi(self.xsmtpapi)
-      MailCannon::Barrel.perform_async(self.id)
+      if MailCannon.config['waiting_time'] && MailCannon.config['waiting_time'].to_i>0
+        MailCannon::Barrel.perform_in(MailCannon.config['waiting_time'].seconds,self.id)  
+      else
+        MailCannon::Barrel.perform_async(self.id)
+      end      
     else
       raise 'Invalid xsmtpapi hash!'
     end
   end
+  alias_method :"post!",:"post_envelope!"
 
   # Stamp this Envelope with code.
-  def stamp!(code)
+  def stamp!(code,recipient=nil)
     self.class.valid_code_kind?(code)
-    self.stamps << MailCannon::Stamp.from_code(code)
+    unless self.persisted?
+      logger.warn "You're trying to save the Stamp with an unsaved Envelope! Auto-saving Envelope."
+      self.save
+    end
+    self.stamps.create(code: MailCannon::Stamp.from_code(code).code, recipient: recipient)
   end
   
   # Callback to be run after the Envelope has been processed.
@@ -49,6 +55,14 @@ class MailCannon::Envelope
       self.mail=nil # to avoid reload
     end
   end
+
+  def posted?
+    if self.stamps.where(code: 0).count > 0
+      true
+    else
+      false
+    end
+  end
   
   private
   def self.valid_code_kind?(code)

data/lib/mailcannon/envelope_bag.rb

@@ -0,0 +1,27 @@
+# Where the magic happens, the Envelope is responsible for keeping the information necessary to send the email(s) and holding the Stamps related to mailing Events.
+class MailCannon::EnvelopeBag
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  
+  has_many :envelopes, autosave: true
+  field :integration_code, type: String # Used to link your own app models to the Bag.
+
+  def push(envelope)
+    self.envelopes.push envelope
+  end
+  alias_method :"add",:"push"
+
+  # Post this Envelope!
+  def post_envelopes!
+    return false if envelopes.size==0
+    self.save if self.changed?
+    envelopes.each do |e|
+      unless e.posted?
+        e.post!
+      end
+    end
+    true
+  end
+  alias_method :"post!",:"post_envelopes!"
+    
+end

data/lib/mailcannon/event.rb

@@ -2,7 +2,7 @@
 class MailCannon::Event
   
   EVENTS = [
-    'new',
+    'posted',
     'processed',
     'delivered',
     'open',

data/lib/mailcannon/hash.rb

@@ -0,0 +1,10 @@
+module MailCannon
+  refine Hash do
+    def symbolize_keys!
+      keys.each do |key|
+        self[(key.to_sym rescue key) || key] = delete(key)
+      end
+      self
+    end
+  end
+end

data/lib/mailcannon/mail.rb

@@ -3,7 +3,7 @@ class MailCannon::Mail
   include Mongoid::Document
   include Mongoid::Timestamps
   
-  embedded_in :envelope#, index: true
+  embedded_in :envelope
   
   field :text, type: String
   field :html, type: String

data/lib/mailcannon/stamp.rb

@@ -3,11 +3,11 @@ class MailCannon::Stamp
   include Mongoid::Document
   include Mongoid::Timestamps
   
-  belongs_to :envelope, index: true
+  embedded_in :envelope
   
   field :code, type: Integer, default: 0
   field :recipient # email address for this "notification"
-  validates :code, :envelope, presence: true
+  validates :code, presence: true
   
   # Returns the Event for this Stamp. 
   def event

data/lib/mailcannon/version.rb

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

data/lib/mailcannon/workers/barrel.rb

@@ -3,24 +3,20 @@ class MailCannon::Barrel
   include Sidekiq::Worker
 
   def perform(envelope_id)
-    aggregator = Librato::Metrics::Aggregator.new
-    aggregator.time 'mailcannon.barrel.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
+    envelope_id = envelope_id['$oid'] if envelope_id['$oid']
+    logger.info "sending MailCannon::Envelope.find('#{envelope_id}')"
+    begin
+      envelope = MailCannon::Envelope.find(envelope_id.to_s)
+      if envelope.valid?
+        response = envelope.send!
+        unless response==true
+          raise response
+        end
       end
+    rescue Mongoid::Errors::DocumentNotFound
+      logger.error "unable to find the document MailCannon::Envelope.find('#{envelope_id}')"
+    rescue Exception => e
+      logger.error "unable to send MailCannon::Envelope.find('#{envelope_id}')\n#{e.backtrace}"
     end
-    aggregator.submit
   end
 end

data/lib/mailcannon.rb

@@ -2,14 +2,13 @@ require 'yaml'
 require 'openssl'
 require 'bundler'
 require 'json'
+#should use Bundler
 require 'mongoid'
-
-case ENV['RACK_ENV']
-when 'production'
-  Bundler.require(:default)
-else
-  Bundler.require(:default,:development)
-end
+require 'sidekiq'
+require 'sendgrid_webapi'
+require 'yajl-ruby' if RUBY_PLATFORM=='ruby'
+require 'jruby-openssl' if RUBY_PLATFORM=='jruby'
+#require 'librato-metrics'
 
 Encoding.default_internal = "utf-8"
 Encoding.default_external = "utf-8"
@@ -17,6 +16,7 @@ Encoding.default_external = "utf-8"
 module MailCannon
   require_relative 'mailcannon/adapter'
   require_relative 'mailcannon/adapters/sendgrid_web'
+  require_relative 'mailcannon/envelope_bag'
   require_relative 'mailcannon/envelope'
   require_relative 'mailcannon/mail'
   require_relative 'mailcannon/stamp'
@@ -24,16 +24,16 @@ module MailCannon
   require_relative 'mailcannon/workers/barrel'
   require_relative 'mailcannon/version'
   
-  self.warmode if ENV['MAILCANNON_MODE']=='war'
+  #Librato::Metrics.authenticate(ENV['LIBRATO_USER'], ENV['LIBRATO_TOKEN']) if ENV['LIBRATO_TOKEN'] && ENV['LIBRATO_USER'] # change to initializer
   
   # To be used with caution
   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)
+    #Mongoid.load!("config/mongoid.yml", ENV['RACK_ENV']||'development') # change to env URL
+    Sidekiq.configure_client do |config|
+      config.redis = { :namespace => 'mailcannon', :size => 1, :url => ENV['REDIS_URL'] }
+    end
   end
+  self.warmode if ENV['MAILCANNON_MODE']=='war'
 
   # Returns the config Hash
   def self.config(root_dir=nil)
@@ -52,4 +52,24 @@ module MailCannon
     YAML.load(erb)
   end
 
+  # alias method
+  def logger
+    MailCannon.logger
+  end
+
+  # Returns the lib logger object
+  def self.logger
+    @logger || initialize_logger
+  end
+
+  # Initializes logger with mailcannon setup
+  def self.initialize_logger(log_target = STDOUT)
+    oldlogger = @logger
+    @logger = Logger.new(log_target)
+    @logger.level = Logger::INFO
+    @logger.progname = 'mailcannon'
+    oldlogger.close if oldlogger && !$TESTING # don't want to close testing's STDOUT logging
+    @logger
+  end
+
 end

data/mailcannon.gemspec

@@ -18,6 +18,25 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+  
+  if RUBY_ENGINE=='rbx'
+    s.add_dependency 'rubysl'
+  end
+  if RUBY_PLATFORM=='ruby'
+    s.add_dependency 'yajl-ruby'
+  end
+  if RUBY_PLATFORM=='jruby'
+    s.add_dependency 'jruby-openssl'
+  end
+  
+  s.add_runtime_dependency 'activemodel', '>= 3.0.0'
+  
+  #s.add_dependency 'librato-metrics'
+  s.add_dependency 'redis'
+  s.add_dependency 'mongoid'
+  s.add_dependency 'sidekiq'
+  s.add_dependency 'sendgrid_webapi'
+  s.add_dependency 'json-schema'
 
   s.add_development_dependency "vcr"
   s.add_development_dependency "rspec"

data/spec/factories/envelope_bag.rb

@@ -0,0 +1,13 @@
+FactoryGirl.define do
+  factory :empty_envelope_bag, class: MailCannon::EnvelopeBag do
+    envelopes []
+
+    factory :filled_envelope_bag, class: MailCannon::EnvelopeBag do
+      # This factories will be inconsistent on tests running post! at the same spec
+      envelope_a = FactoryGirl.build(:envelope)
+      envelope_b = FactoryGirl.build(:envelope_multi)
+      envelopes [envelope_a,envelope_b]
+    end
+
+  end
+end

data/spec/integration/1k_spec.rb

@@ -4,7 +4,7 @@ describe "shoot 1k emails!" do
   let(:envelope) { build(:envelope_multi_1k) }
   it "sends http request for Sendgrid web API" do
     VCR.use_cassette('mailcannon_integration_1k') do
-      expect(envelope.send_bulk!).to eq({"message"=>"success"})
+      expect(envelope.send_bulk!).to be_true
     end
   end
 end

data/spec/integration/xsmtpapi_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe 'X-SMTPAPI compatibility' do
+  describe "xsmtpapi for bulk" do
+    context "generates expected xsmtpapi for #post!" do
+      let(:envelope) { build(:envelope_multi, xsmtpapi: { "unique_args" => { "userid" => "1123", "template" => "welcome" }}) }
+
+      it "returns true" do
+        VCR.use_cassette('mailcannon_adapter_sendgrid_send_bulk') do
+          Sidekiq::Testing.inline! do
+            envelope.post!
+          end
+        end
+        envelope.reload # content is changed inside the Adapter module
+        #binding.pry
+        expect(envelope.xsmtpapi['to']).to match_array ['mailcannon@railsnapraia.com', 'contact@railsonthebeach.com', 'lucasmartins@railsnapraia.com']
+      end
+    end
+  end
+end

data/spec/mailcannon/adapters/sendgrid_spec.rb

@@ -5,7 +5,7 @@ describe MailCannon::Adapter::SendgridWeb 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"})
+        expect(envelope.send!).to be_true
       end
     end
     it "calls after_sent callback" do
@@ -20,7 +20,7 @@ describe MailCannon::Adapter::SendgridWeb do
     let(:envelope) { build(:envelope_multi) }
     it "sends http request for Sendgrid web API" do
       VCR.use_cassette('mailcannon_adapter_sendgrid_send_bulk') do
-        expect(envelope.send_bulk!).to eq({"message"=>"success"})
+        expect(envelope.send_bulk!).to be_true
       end
     end
   end

data/spec/mailcannon/envelope_bag_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+describe MailCannon::EnvelopeBag do
+  describe "#post!" do
+    context "when it has no Envelopes" do
+      let(:envelope_bag) { build(:empty_envelope_bag) }
+      it "does not raise error" do
+        expect{envelope_bag.post!}.not_to raise_error
+      end
+      it "returns false" do
+        expect(envelope_bag.post!).to be_false
+      end
+    end
+    context "when it has Envelopes" do
+      let(:envelope_bag) { build(:filled_envelope_bag) }
+      it "does not raise error" do
+        expect{envelope_bag.post!}.not_to raise_error
+      end
+      it "returns true" do
+        expect(envelope_bag.post!).to be_true
+      end
+    end
+    context "when it has Envelopes (isolating Bag)" do
+      let(:envelope_bag) { MailCannon::EnvelopeBag.new }
+      it "posts Envelopes in the bag" do
+        envelope_bag.envelopes.push build(:envelope)
+        envelope_bag.envelopes.push build(:envelope_multi)
+        expect(envelope_bag.envelopes.size).to eq(2)
+        # Rspec can't do 'any_instance.should_receive' twice.
+        envelope_bag.envelopes.each do |envelope|
+          expect(envelope).to receive(:post!)
+        end
+        envelope_bag.post!
+      end
+    end
+  end
+end

data/spec/mailcannon/envelope_spec.rb

@@ -1,10 +1,11 @@
 require "spec_helper"
 
 describe MailCannon::Envelope do
-  describe "initialize" do
+  describe "initialization" do
     let(:envelope) { build(:envelope) }
-    it "creates a new Stamp" do
-      expect{ envelope.save }.to change{envelope.stamps.size}.by(1)
+    it "has no Stamps" do
+      envelope.save
+      expect(envelope.stamps.size).to eq(0)
     end
     context "check for expected adapter behavior" do
       it "implements send! behavior" do
@@ -52,6 +53,42 @@ describe MailCannon::Envelope do
     end
   end
   
+  describe "#posted?" do
+    context "when already posted" do
+      let(:envelope) { build(:envelope) }
+      it "returns true" do
+        VCR.use_cassette('mailcannon_adapter_sendgrid_send') do
+          envelope.post!
+        end
+        expect(envelope.posted?).to be_true
+      end
+    end
+    context "when not yet posted" do
+      let(:envelope) { build(:envelope) }
+      it "returns false" do
+        expect(envelope.posted?).to be_false
+      end
+    end
+  end
+
+  describe "xsmtpapi" do
+    context "keep xsmtpapi arguments after #post!" do
+      let(:envelope) { build(:envelope_multi, xsmtpapi: { "unique_args" => { "userid" => "1123", "template" => "welcome" }}) }
+
+      it "returns true" do
+        VCR.use_cassette('mailcannon_adapter_sendgrid_send_bulk') do
+          Sidekiq::Testing.inline! do
+            envelope.post!
+          end
+        end
+        envelope.reload # content is changed inside the Adapter module
+        expect(envelope.xsmtpapi).to have_key("unique_args")
+        expect(envelope.xsmtpapi).to have_key("to")
+        expect(envelope.xsmtpapi).to have_key("sub")
+      end
+    end
+  end
+
   describe "#after_sent" do
     let(:envelope) { create(:envelope) }
     it "creates a Processed Stamp" do

data/spec/mailcannon/workers/barrel_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe MailCannon::Barrel do
+  describe "perform" do
+    let(:envelope) { create(:envelope) }
+    it "creates a new Stamp" do
+      VCR.use_cassette('mailcannon_barrel_envelope_post') do
+        expect{ envelope.post! }.to change{envelope.stamps.size}.by(1)
+      end
+      expect(envelope.stamps.first.code).to eq(0) # 0=posted
+    end
+    it "looks for an existing MongoDB document" do
+      VCR.use_cassette('mailcannon_barrel_envelope_post') do
+        Sidekiq::Testing.inline! do
+          expect{envelope.post!}.not_to raise_error(Mongoid::Errors::DocumentNotFound)
+        end
+      end
+    end
+    it "runs the job without errors" do
+      VCR.use_cassette('mailcannon_barrel_envelope_post') do
+        Sidekiq::Testing.inline! do
+          expect{envelope.post!}.not_to raise_error
+        end
+      end
+    end
+    pending "calls Envelope#send!" do
+      Sidekiq::Testing.inline! do
+        MailCannon::Adapter::SendgridWeb.any_instance.should_receive('send!')
+        VCR.use_cassette('mailcannon_barrel_envelope_post') do
+          envelope.post!
+        end
+      end
+    end
+    context "check for expected adapter behavior" do
+      it "implements send! behavior" do
+        expect(envelope.respond_to?(:send!)).to be_true
+      end
+    end
+  end
+end

data/spec/mailcannon_spec.rb

@@ -4,6 +4,6 @@ describe MailCannon, "::config" do
   it "returns a valid configuration Hash" do
     config = MailCannon.config('templates')
     config.should be_a_kind_of(Hash)
-    config.should have_key('folder')
+    config.should have_key('auto_post')
   end
 end

data/spec/spec_helper.rb

@@ -10,6 +10,7 @@ require 'factory_girl'
 require 'vcr'
 require 'webmock'
 require 'webmock/rspec'
+require 'sidekiq/testing'
 
 if ENV['TRAVIS']==true
   begin
@@ -54,4 +55,5 @@ VCR.configure do |c|
   c.allow_http_connections_when_no_cassette = true
 end
 
-Mongoid.load!("spec/support/mongoid.yml", 'test')
+Mongoid.load!("spec/support/mongoid.yml", 'test')
+MailCannon.config('templates')

data/templates/config/mailcannon.yml

@@ -1,3 +1,7 @@
 # This file will hold any hard configurations MailCannon may need. Customizations included.
-folder:
-  key: value
+
+# When creating a MailCannon::Envelope the default behavior is to auto-post the Job to send it.
+auto_post: true
+
+# This is will schedule a delay for the Job execution, useful if you want to be able to Cancel the Job.
+waiting_time: 0

metadata

@@ -1,15 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: mailcannon
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Lucas Martins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-07 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  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'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  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'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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'
+- !ruby/object:Gem::Dependency
+  name: sendgrid_webapi
+  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'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  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'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -183,35 +267,40 @@ files:
 - .travis.yml
 - .yardopts
 - Gemfile
-- Gemfile.lock
 - Rakefile
 - Readme.md
 - ReadmeContributors.md
 - config/locales/en.yml
 - config/locales/pt-BR.yml
 - env.sample.sh
-- lib/generators/highrise_mapper/USAGE
-- lib/generators/highrise_mapper/config_generator.rb
+- lib/generators/mailcannon/USAGE
+- lib/generators/mailcannon/config_generator.rb
 - lib/mailcannon.rb
 - lib/mailcannon/adapter.rb
 - lib/mailcannon/adapters/sendgrid_web.rb
 - lib/mailcannon/envelope.rb
+- lib/mailcannon/envelope_bag.rb
 - lib/mailcannon/event.rb
+- lib/mailcannon/hash.rb
 - lib/mailcannon/mail.rb
 - lib/mailcannon/stamp.rb
 - lib/mailcannon/version.rb
 - lib/mailcannon/workers/barrel.rb
 - mailcannon.gemspec
 - spec/factories/envelope.rb
+- spec/factories/envelope_bag.rb
 - spec/factories/stamp.rb
 - spec/fixtures/cassettes/mailcannon_adapter_sendgrid.send.yml
 - spec/fixtures/cassettes/mailcannon_adapter_sendgrid_send.yml
 - spec/fixtures/cassettes/mailcannon_adapter_sendgrid_send_bulk.yml
 - spec/fixtures/cassettes/mailcannon_integration_1k.yml
 - spec/integration/1k_spec.rb
+- spec/integration/xsmtpapi_spec.rb
 - spec/mailcannon/adapters/sendgrid_spec.rb
+- spec/mailcannon/envelope_bag_spec.rb
 - spec/mailcannon/envelope_spec.rb
 - spec/mailcannon/stamp_spec.rb
+- spec/mailcannon/workers/barrel_spec.rb
 - spec/mailcannon_spec.rb
 - spec/spec_helper.rb
 - spec/support/mongoid.yml
@@ -243,15 +332,19 @@ specification_version: 4
 summary: A mass mailing tool for real threads aficionados
 test_files:
 - spec/factories/envelope.rb
+- spec/factories/envelope_bag.rb
 - spec/factories/stamp.rb
 - spec/fixtures/cassettes/mailcannon_adapter_sendgrid.send.yml
 - spec/fixtures/cassettes/mailcannon_adapter_sendgrid_send.yml
 - spec/fixtures/cassettes/mailcannon_adapter_sendgrid_send_bulk.yml
 - spec/fixtures/cassettes/mailcannon_integration_1k.yml
 - spec/integration/1k_spec.rb
+- spec/integration/xsmtpapi_spec.rb
 - spec/mailcannon/adapters/sendgrid_spec.rb
+- spec/mailcannon/envelope_bag_spec.rb
 - spec/mailcannon/envelope_spec.rb
 - spec/mailcannon/stamp_spec.rb
+- spec/mailcannon/workers/barrel_spec.rb
 - spec/mailcannon_spec.rb
 - spec/spec_helper.rb
 - spec/support/mongoid.yml

data/Gemfile.lock

@@ -1,322 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (3.2.16)
-      activesupport (= 3.2.16)
-      builder (~> 3.0.0)
-    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)
-    colorize (0.5.8)
-    connection_pool (1.2.0)
-    coveralls (0.6.7)
-      colorize
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      thor
-    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)
-    i18n (0.6.9)
-    json (1.8.1)
-    json-schema (2.1.8)
-    librato-metrics (1.3.0)
-      aggregate (~> 0.2.2)
-      faraday (~> 0.7)
-      multi_json
-    method_source (0.8.1)
-    mime-types (1.23)
-    mongoid (3.1.6)
-      activemodel (~> 3.2)
-      moped (~> 1.4)
-      origin (~> 1.0)
-      tzinfo (~> 0.3.29)
-    moped (1.5.1)
-    multi_json (1.8.2)
-    multipart-post (1.2.0)
-    origin (1.1.0)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    pry-nav (0.2.3)
-      pry (~> 0.9.10)
-    rake (10.0.4)
-    redis (3.0.6)
-    redis-namespace (1.4.1)
-      redis (~> 3.0.4)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
-    rubysl (2.0.15)
-      rubysl-abbrev (~> 2.0)
-      rubysl-base64 (~> 2.0)
-      rubysl-benchmark (~> 2.0)
-      rubysl-bigdecimal (~> 2.0)
-      rubysl-cgi (~> 2.0)
-      rubysl-cgi-session (~> 2.0)
-      rubysl-cmath (~> 2.0)
-      rubysl-complex (~> 2.0)
-      rubysl-continuation (~> 2.0)
-      rubysl-coverage (~> 2.0)
-      rubysl-csv (~> 2.0)
-      rubysl-curses (~> 2.0)
-      rubysl-date (~> 2.0)
-      rubysl-delegate (~> 2.0)
-      rubysl-digest (~> 2.0)
-      rubysl-drb (~> 2.0)
-      rubysl-e2mmap (~> 2.0)
-      rubysl-english (~> 2.0)
-      rubysl-enumerator (~> 2.0)
-      rubysl-erb (~> 2.0)
-      rubysl-etc (~> 2.0)
-      rubysl-expect (~> 2.0)
-      rubysl-fcntl (~> 2.0)
-      rubysl-fiber (~> 2.0)
-      rubysl-fileutils (~> 2.0)
-      rubysl-find (~> 2.0)
-      rubysl-forwardable (~> 2.0)
-      rubysl-getoptlong (~> 2.0)
-      rubysl-gserver (~> 2.0)
-      rubysl-io-console (~> 2.0)
-      rubysl-io-nonblock (~> 2.0)
-      rubysl-io-wait (~> 2.0)
-      rubysl-ipaddr (~> 2.0)
-      rubysl-irb (~> 2.0)
-      rubysl-logger (~> 2.0)
-      rubysl-mathn (~> 2.0)
-      rubysl-matrix (~> 2.0)
-      rubysl-mkmf (~> 2.0)
-      rubysl-monitor (~> 2.0)
-      rubysl-mutex_m (~> 2.0)
-      rubysl-net-ftp (~> 2.0)
-      rubysl-net-http (~> 2.0)
-      rubysl-net-imap (~> 2.0)
-      rubysl-net-pop (~> 2.0)
-      rubysl-net-protocol (~> 2.0)
-      rubysl-net-smtp (~> 2.0)
-      rubysl-net-telnet (~> 2.0)
-      rubysl-nkf (~> 2.0)
-      rubysl-observer (~> 2.0)
-      rubysl-open-uri (~> 2.0)
-      rubysl-open3 (~> 2.0)
-      rubysl-openssl (~> 2.0)
-      rubysl-optparse (~> 2.0)
-      rubysl-ostruct (~> 2.0)
-      rubysl-pathname (~> 2.0)
-      rubysl-prettyprint (~> 2.0)
-      rubysl-prime (~> 2.0)
-      rubysl-profile (~> 2.0)
-      rubysl-profiler (~> 2.0)
-      rubysl-pstore (~> 2.0)
-      rubysl-pty (~> 2.0)
-      rubysl-rational (~> 2.0)
-      rubysl-readline (~> 2.0)
-      rubysl-resolv (~> 2.0)
-      rubysl-rexml (~> 2.0)
-      rubysl-rinda (~> 2.0)
-      rubysl-rss (~> 2.0)
-      rubysl-scanf (~> 2.0)
-      rubysl-securerandom (~> 2.0)
-      rubysl-set (~> 2.0)
-      rubysl-shellwords (~> 2.0)
-      rubysl-singleton (~> 2.0)
-      rubysl-socket (~> 2.0)
-      rubysl-stringio (~> 2.0)
-      rubysl-strscan (~> 2.0)
-      rubysl-sync (~> 2.0)
-      rubysl-syslog (~> 2.0)
-      rubysl-tempfile (~> 2.0)
-      rubysl-thread (~> 2.0)
-      rubysl-thwait (~> 2.0)
-      rubysl-time (~> 2.0)
-      rubysl-timeout (~> 2.0)
-      rubysl-tmpdir (~> 2.0)
-      rubysl-tsort (~> 2.0)
-      rubysl-un (~> 2.0)
-      rubysl-uri (~> 2.0)
-      rubysl-weakref (~> 2.0)
-      rubysl-webrick (~> 2.0)
-      rubysl-xmlrpc (~> 2.0)
-      rubysl-yaml (~> 2.0)
-      rubysl-zlib (~> 2.0)
-    rubysl-abbrev (2.0.4)
-    rubysl-base64 (2.0.0)
-    rubysl-benchmark (2.0.1)
-    rubysl-bigdecimal (2.0.2)
-    rubysl-cgi (2.0.1)
-    rubysl-cgi-session (2.0.1)
-    rubysl-cmath (2.0.0)
-    rubysl-complex (2.0.0)
-    rubysl-continuation (2.0.0)
-    rubysl-coverage (2.0.3)
-    rubysl-csv (2.0.2)
-      rubysl-english (~> 2.0)
-    rubysl-curses (2.0.0)
-    rubysl-date (2.0.6)
-    rubysl-delegate (2.0.1)
-    rubysl-digest (2.0.3)
-    rubysl-drb (2.0.1)
-    rubysl-e2mmap (2.0.0)
-    rubysl-english (2.0.0)
-    rubysl-enumerator (2.0.0)
-    rubysl-erb (2.0.1)
-    rubysl-etc (2.0.3)
-      ffi2-generators (~> 0.1)
-    rubysl-expect (2.0.0)
-    rubysl-fcntl (2.0.4)
-      ffi2-generators (~> 0.1)
-    rubysl-fiber (2.0.0)
-    rubysl-fileutils (2.0.3)
-    rubysl-find (2.0.1)
-    rubysl-forwardable (2.0.1)
-    rubysl-getoptlong (2.0.0)
-    rubysl-gserver (2.0.0)
-      rubysl-socket (~> 2.0)
-      rubysl-thread (~> 2.0)
-    rubysl-io-console (2.0.0)
-    rubysl-io-nonblock (2.0.0)
-    rubysl-io-wait (2.0.0)
-    rubysl-ipaddr (2.0.0)
-    rubysl-irb (2.0.4)
-      rubysl-e2mmap (~> 2.0)
-      rubysl-mathn (~> 2.0)
-      rubysl-readline (~> 2.0)
-      rubysl-thread (~> 2.0)
-    rubysl-logger (2.0.0)
-    rubysl-mathn (2.0.0)
-    rubysl-matrix (2.1.0)
-      rubysl-e2mmap (~> 2.0)
-    rubysl-mkmf (2.0.1)
-      rubysl-fileutils (~> 2.0)
-      rubysl-shellwords (~> 2.0)
-    rubysl-monitor (2.0.0)
-    rubysl-mutex_m (2.0.0)
-    rubysl-net-ftp (2.0.1)
-    rubysl-net-http (2.0.4)
-      rubysl-cgi (~> 2.0)
-      rubysl-erb (~> 2.0)
-      rubysl-singleton (~> 2.0)
-    rubysl-net-imap (2.0.1)
-    rubysl-net-pop (2.0.1)
-    rubysl-net-protocol (2.0.1)
-    rubysl-net-smtp (2.0.1)
-    rubysl-net-telnet (2.0.0)
-    rubysl-nkf (2.0.1)
-    rubysl-observer (2.0.0)
-    rubysl-open-uri (2.0.0)
-    rubysl-open3 (2.0.0)
-    rubysl-openssl (2.0.5)
-    rubysl-optparse (2.0.1)
-      rubysl-shellwords (~> 2.0)
-    rubysl-ostruct (2.0.4)
-    rubysl-pathname (2.0.0)
-    rubysl-prettyprint (2.0.2)
-    rubysl-prime (2.0.1)
-    rubysl-profile (2.0.0)
-    rubysl-profiler (2.0.1)
-    rubysl-pstore (2.0.0)
-    rubysl-pty (2.0.2)
-    rubysl-rational (2.0.1)
-    rubysl-readline (2.0.2)
-    rubysl-resolv (2.0.0)
-    rubysl-rexml (2.0.2)
-    rubysl-rinda (2.0.0)
-    rubysl-rss (2.0.0)
-    rubysl-scanf (2.0.0)
-    rubysl-securerandom (2.0.0)
-    rubysl-set (2.0.1)
-    rubysl-shellwords (2.0.0)
-    rubysl-singleton (2.0.0)
-    rubysl-socket (2.0.1)
-    rubysl-stringio (2.0.0)
-    rubysl-strscan (2.0.0)
-    rubysl-sync (2.0.0)
-    rubysl-syslog (2.0.1)
-      ffi2-generators (~> 0.1)
-    rubysl-tempfile (2.0.1)
-    rubysl-thread (2.0.2)
-    rubysl-thwait (2.0.0)
-    rubysl-time (2.0.3)
-    rubysl-timeout (2.0.0)
-    rubysl-tmpdir (2.0.0)
-    rubysl-tsort (2.0.1)
-    rubysl-un (2.0.0)
-      rubysl-fileutils (~> 2.0)
-      rubysl-optparse (~> 2.0)
-    rubysl-uri (2.0.0)
-    rubysl-weakref (2.0.0)
-    rubysl-webrick (2.0.0)
-    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)
-    sidekiq (2.17.0)
-      celluloid (>= 0.15.2)
-      connection_pool (>= 1.0.0)
-      json
-      redis (>= 3.0.4)
-      redis-namespace (>= 1.3.1)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-    slop (3.4.5)
-    thor (0.18.1)
-    timers (1.1.0)
-    tzinfo (0.3.38)
-    vcr (2.8.0)
-    webmock (1.15.2)
-      addressable (>= 2.2.7)
-      crack (>= 0.3.2)
-    yajl-ruby (1.2.0)
-    yard (0.8.6.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  coveralls
-  database_cleaner
-  factory_girl
-  jruby-openssl
-  json-schema
-  librato-metrics
-  mongoid
-  pry
-  pry-nav
-  rake
-  redis
-  rspec
-  rspec-expectations
-  rspec-mocks
-  rubysl
-  sendgrid_webapi
-  sidekiq
-  vcr
-  webmock (>= 1.8.0, < 1.16)
-  yajl-ruby
-  yard