envoy 0.0.1 → 1.0

data/Gemfile.lock

@@ -1,32 +1,20 @@
 PATH
   remote: .
   specs:
-    envoy (0.0.1)
+    envoy (1.0)
       broach (= 0.2.1)
-      i18n (~> 0.5.0)
-      pony (= 1.1)
+      tmail (= 1.2.7.1)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.0.3)
     broach (0.2.1)
       json (~> 1.4)
       nap (~> 0.3)
     diff-lcs (1.1.2)
     fakeweb (1.3.0)
-    i18n (0.5.0)
-    json (1.4.6)
-    mail (2.2.11)
-      activesupport (>= 2.3.6)
-      i18n (~> 0.5.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.16)
+    json (1.5.1)
     nap (0.4)
-    polyglot (0.3.1)
-    pony (1.1)
-      mail (> 2.0)
     rspec (2.1.0)
       rspec-core (~> 2.1.0)
       rspec-expectations (~> 2.1.0)
@@ -35,16 +23,14 @@ GEM
     rspec-expectations (2.1.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.1.0)
-    treetop (1.4.9)
-      polyglot (>= 0.3.1)
+    timecop (0.3.5)
+    tmail (1.2.7.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  broach (= 0.2.1)
   envoy!
   fakeweb (= 1.3.0)
-  i18n (~> 0.5.0)
-  pony (= 1.1)
   rspec (~> 2.1.0)
+  timecop (~> 0.3.5)

data/README.markdown

@@ -0,0 +1,91 @@
+A simple, extendable messaging system designed for deployments
+
+Usage
+=====
+    gem install envoy (use sudo if not using RVM)
+    require 'envoy'
+
+Create a new messenger
+----------------------
+    messenger = Envoy::Messenger.new
+
+Define some transports
+----------------------
+    messenger.transports.each do |transport|
+      transport.add_transport(:campfire, :account => 'foo', :token => 'bar', :room => 'my_room')
+    end
+
+OR
+
+    messenger.transport(:campfire, :account => 'foo', :token => 'bar', :room => 'my_room')
+
+Add some messages
+-----------------
+    messenger.messages.each do |message|
+      message.add_message(:name => 'Start deployment message', :subject => "Carlos started deployment of branch foo to production at #{Time.now}")
+      message.add_message(:name => 'End deployment message', :subject => "Carlos ended deployment of branch foo to production at #{Time.now}")
+    end
+
+OR
+
+    messenger.message(:name => 'Start deployment message', :subject => "Carlos started deployment of branch foo to production at #{Time.now}")
+
+Deliver messages one at a time
+------------------------------
+
+    messenger.deliver_start_deployment_message
+
+AND THEN
+
+    messenger.deliver_end_deployment_message
+
+Deliver all messages
+--------------------
+
+    messenger.deliver_all_messages
+
+Email, Campfire, and Webhook Transports are included. Create your own by inheriting from Envoy::Transport
+
+Sample Capistrano Usage
+=======================
+
+    begin
+      require 'envoy'
+      set :envoy_loaded, true
+    rescue LoadError
+      set :envoy_loaded, false
+    end
+
+    if envoy_loaded
+      set :messenger, Envoy::Messenger.new
+      set :git_username, `git config user.name`.gsub("\n", '')
+      messenger.transport :name => :campfire, :account => [YOUR ACCOUNT HERE], :token => [YOUR TOKEN HERE], :use_ssl => true
+    else
+      set :messenger, nil
+    end
+
+    before :deploy do
+      if messenger
+        messenger.message :name => :start_deployment,
+          :subject => "#{git_username} started deployment of branch master to production for project Foo at #{Time.now}"
+        messenger.deliver_start_deployment
+      end
+    end
+
+    after :deploy do
+      if messenger
+        messenger.message :name => :end_deployment,
+          :subject => "#{git_username} ended deployment of branch master to production for project Foo at #{Time.now}"
+        messenger.deliver_end_deployment
+      end
+    end
+
+Thanks
+------
+
+Thanks to [Robby Russell](http://robbyonrails.com) for beta testing
+
+Copyright
+---------
+
+**Envoy** is Copyright (c) 2010 [Carlos Rodriguez](http://eddorre.com), released under the MIT License.

data/envoy.gemspec

@@ -20,9 +20,10 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "broach", "0.2.1"
-  s.add_dependency "i18n", "~> 0.5.0"
-  s.add_dependency "pony", "1.1"
+  s.add_dependency "tmail", "1.2.7.1"
+  s.add_dependency "tlsmail", "0.0.1" if RUBY_VERSION <= '1.8.6'
 
   s.add_development_dependency "rspec", "~> 2.1.0"
   s.add_development_dependency "fakeweb", "1.3.0"
+  s.add_development_dependency "timecop", "~> 0.3.5"
 end

data/lib/envoy/messenger.rb

@@ -37,6 +37,7 @@ module Envoy
         end
       end
     end
+    alias :deliver_all_messages :deliver_messages
 
     def deliver_message(transport, message)
       unless self._sent_messages.include?({ :transport => transport, :message => message })
@@ -55,7 +56,6 @@ module Envoy
     end
 
     def message(message_options = {})
-      message_options.symbolize_keys!
       self._messages << Envoy::Message.new(message_options[:name], message_options[:subject],
         message_options[:body], message_options[:options])
     end

data/lib/envoy/transport.rb

@@ -1,8 +1,16 @@
+if RUBY_VERSION <= '1.8.6'
+  begin
+    require 'tlsmail'
+  rescue LoadError
+    raise "You need to install tlsmail if you are using ruby <= 1.8.6"
+  end
+end
+
 require 'broach'
-require 'pony'
-require 'i18n'
 require 'net/http'
 require 'uri'
+require 'net/smtp'
+require 'tmail'
 
 module Envoy
   class Transport
@@ -82,30 +90,74 @@ module Envoy
   end
 
   class Email < Transport
-    attr_accessor :host, :username, :password, :sender, :to, :port, :ssl, :authentication
+    attr_accessor :host, :username, :password, :sender, :to, :port, :ssl, :authentication, :domain, :openssl_verify_mode
 
     def initialize(options = {})
       self.host = options[:host]
       self.username = options[:username]
       self.sender = options[:sender]
+      self.password = options[:password]
       self.to = options[:to]
       self.port = options[:port] || 25
       self.ssl = options[:ssl] || false
       self.authentication = options[:authentication] || nil
+      self.domain = options[:domain]
+      self.openssl_verify_mode = options[:openssl_verify_mode]
+    end
+
+    def sendmail_binary
+      sendmail = `which sendmail`.chomp
+      (sendmail.nil? || sendmail == '') ? '/usr/bin/sendmail' : sendmail
+    end
+
+    def build_mail(message)
+      mail = TMail::Mail.new
+      mail.to = @to.is_a?(String) ? @to : @to.join(',')
+      mail.from = @sender.nil? ? 'Envoy Messenger <envoymessenger@localhost>' : @sender
+      mail.subject = message.subject
+      mail.date = Time.now
+      mail.body = message.body || message.subject
+
+      mail
+    end
+
+    def build_connection
+      smtp = Net::SMTP.new(@host, @port)
+
+      if using_authentication?
+        @openssl_verify_mode.nil? ? smtp.send(tls_mode) : smtp.send(tls_mode, @openss_verify_mode)
+      end
+
+      return smtp
+    end
+
+    def tls_mode
+      RUBY_VERSION <= '1.8.6' ? "enable_tls" : "enable_starttls_auto"
+    end
+
+    def using_authentication?
+      !@username.nil? && !@password.nil? && !@authentication.nil? && @ssl
     end
 
     def send_message(message)
+      mail = self.build_mail(message)
+
       if @host.to_sym == :sendmail
-        Pony.mail(:from => (@sender.nil? ? 'Envoy Messenger <envoymessenger@localhost>' : @sender),
-          :to => (@to.is_a?(String) ? @to : @to.join(',')),
-          :via => :sendmail, :body => message.body || message.subject, :subject => message.subject)
+        IO.popen("#{self.sendmail_binary} -f #{mail.from}, #{mail.to}", "w+") do |io|
+          io.puts mail
+          io.flush
+        end
       else
-        Pony.mail(:from => (@sender.nil? ? 'Envoy Messenger <envoymessenger@localhost>' : @sender),
-          :to => (@to.is_a?(String) ? @to : @to.join(',')), :via => :smtp, :via_options =>
-            {
-              :address => @host, :port => @port, :enable_starttls_auto => @ssl, :user_name => @username,
-              :password => @password, :authentication => @authentication, :body => message.body || message.subject, :subject => message.subject
-            })
+        smtp = build_connection
+        if using_authentication?
+          smtp.start(@domain, @username, @password, @authentication.to_sym) do |smtp|
+            smtp.sendmail mail.to_s, mail.from, mail.to
+          end
+        else
+          smtp.start do |smtp|
+            smtp.sendmail mail.to_s, mail.from, mail.to
+          end
+        end
       end
 
       return true

data/lib/envoy/version.rb

@@ -1,3 +1,3 @@
 module Envoy
-  VERSION = "0.0.1"
+  VERSION = "1.0"
 end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+# Original mockup from ActionMailer - copied from Mail gem
+
+class MockSMTP
+  def self.deliveries
+    @@deliveries
+  end
+
+  def initialize
+    @@deliveries = []
+  end
+
+  def sendmail(mail, from, to)
+    @@deliveries << [mail, from, to]
+  end
+
+  def start(*args)
+    yield self
+  end
+
+  def self.clear_deliveries
+    @@deliveries = []
+  end
+  # in the standard lib: net/smtp.rb line 577
+  #   a TypeError is thrown unless this arg is a
+  #   kind of OpenSSL::SSL::SSLContext
+  def enable_tls(context = nil)
+    if context && context.kind_of?(OpenSSL::SSL::SSLContext)
+      true
+    elsif context
+      raise TypeError,
+        "wrong argument (#{context.class})! "+
+        "(Expected kind of OpenSSL::SSL::SSLContext)"
+    end
+  end
+
+  def enable_starttls_auto
+    true
+  end
+end
+
+class Net::SMTP
+  def self.new(*args)
+    MockSMTP.new
+  end
+end

data/spec/transport_spec.rb

@@ -1,5 +1,7 @@
 require 'envoy'
 require 'fakeweb'
+require 'spec_helper'
+require 'timecop'
 include Envoy
 
 describe Transport do
@@ -17,72 +19,51 @@ describe Transport do
 
   describe "Email Transport" do
     before(:each) do
-      @transport = Envoy::Email.new
-      @transport.to = 'carlos@eddorre.com'
+      @transport = Envoy::Email.new(:to => 'carlos@eddorre.com', :sender => 'carlos_sender@eddorre.com')
     end
 
-    it "should send a message through pony" do
+    it "should send a message through sendmail binary" do
       @transport.host = :sendmail
-      Pony.should_receive(:mail)
+      IO.should_receive(:popen).with("#{@transport.sendmail_binary} -f #{@transport.sender}, #{@transport.to}", "w+")
       @transport.send_message(@message)
     end
 
-    it "should send a message through pony with sendmail" do
-      @transport.host = :sendmail
-
+    it "should send a message through SMTP" do
+      new_time = Time.local(2008, 9, 1, 12, 0, 0)
+      Timecop.freeze(new_time)
 
-      Pony.should_receive(:mail).with(:via => :sendmail, :from => 'Envoy Messenger <envoymessenger@localhost>',
-      :to => 'carlos@eddorre.com', :body => @message.subject, :subject => @message.subject)
+      mail = TMail::Mail.new
+      mail.to = @transport.to
+      mail.from = @transport.sender
+      mail.subject = @message.subject
+      mail.date = Time.now
+      mail.body = @message.subject
 
-      @transport.send_message(@message)
-    end
+      TMail::Mail.stub!(:new).and_return(mail)
 
-    it "should send a message through pony using SMTP" do
       @transport.host = 'mail.eddorre.com'
 
-      Pony.should_receive(:mail).with(:from => 'Envoy Messenger <envoymessenger@localhost>', :to => 'carlos@eddorre.com', :via => :smtp, :via_options => { :address => @transport.host,
-        :port => 25, :enable_starttls_auto => false, :user_name => nil, :password => nil, :authentication => nil,
-        :body => @message.subject, :subject => @message.subject })
-
       @transport.send_message(@message)
-    end
-
-    it "should send a message through pony with multiple recipients" do
-      @transport.to = ['carlos@eddorre.com', 'hello@eddorre.com']
-      @transport.host = :sendmail
 
-      Pony.should_receive(:mail).with(:via => :sendmail, :from => 'Envoy Messenger <envoymessenger@localhost>',
-      :to => 'carlos@eddorre.com,hello@eddorre.com', :body => @message.subject, :subject => @message.subject)
+      MockSMTP.deliveries[0][1].should == [@transport.sender]
+      MockSMTP.deliveries[0][2].should == [@transport.to]
+      MockSMTP.deliveries[0][0].should == mail.to_s
 
-      @transport.send_message(@message)
-    end
-
-    it "should send a message through pony with a set sender" do
-      @transport.host = :sendmail
-      @transport.sender = 'carlos@eddorre.com'
-
-      Pony.should_receive(:mail).with(:via => :sendmail, :from => 'carlos@eddorre.com',
-      :to => 'carlos@eddorre.com', :body => @message.subject, :subject => @message.subject)
-
-      @transport.send_message(@message)
+      Timecop.return
     end
 
-    it "should return false when an exception is triggered when attempting to send through pony" do
+    it "should return false when an exception is triggered" do
       @transport.host = :sendmail
-      @transport.sender = 'carlos@eddorre.com'
-      @transport.to = 'carlos@eddorre.com'
 
-      Pony.stub!(:mail).and_raise(ArgumentError)
+      IO.stub!(:popen).and_raise(ArgumentError)
 
       @transport.send_message(@message).should == false
     end
 
-    it "should return true when there is no exception triggered when attempting to send through pony" do
+    it "should return true when there is no exception triggered" do
       @transport.host = :sendmail
-      @transport.sender = 'carlos@eddorre.com'
-      @transport.to = 'carlos@eddorre.com'
 
-      Pony.stub!(:mail).and_return(true)
+      IO.stub!(:popen).and_return
 
       @transport.send_message(@message).should == true
     end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: envoy
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
-  - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: "1.0"
 platform: ruby
 authors: 
 - Carlos Rodriguez
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-17 00:00:00 -08:00
+date: 2011-04-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,40 +34,26 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: i18n
+  name: tmail
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 0
-        - 5
-        - 0
-        version: 0.5.0
-  type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: pony
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 81
         segments: 
         - 1
+        - 2
+        - 7
         - 1
-        version: "1.1"
+        version: 1.2.7.1
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -80,11 +65,11 @@ dependencies:
         - 0
         version: 2.1.0
   type: :development
-  version_requirements: *id004
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: fakeweb
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -96,6 +81,22 @@ dependencies:
         - 0
         version: 1.3.0
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 3
+        - 5
+        version: 0.3.5
+  type: :development
   version_requirements: *id005
 description: A simple, extendable messaging system built for deployments
 email: 
@@ -110,7 +111,7 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
-- README
+- README.markdown
 - Rakefile
 - envoy.gemspec
 - lib/envoy.rb
@@ -119,6 +120,7 @@ files:
 - lib/envoy/transport.rb
 - lib/envoy/version.rb
 - spec/messenger_spec.rb
+- spec/spec_helper.rb
 - spec/transport_spec.rb
 has_rdoc: true
 homepage: http://github.com/eddorre/envoy
@@ -150,10 +152,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: envoy
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A simple, extendable messaging system built for deployments
 test_files: 
 - spec/messenger_spec.rb
+- spec/spec_helper.rb
 - spec/transport_spec.rb

data/README

@@ -1,43 +0,0 @@
-A simple, extendable messaging system
-
-Usage
-
-require 'envoy'
-
-# Create a new messenger
-messenger = Envoy::Messenger.new
-
-# Define some transports
-messenger.transports.each do |transport|
-  transport.add_transport(:campfire, :account => 'foo', :token => 'bar', :room => 'my_room')
-end
-
-OR
-
-messenger.transport(:campfire, :account => 'foo', :token => 'bar', :room => 'my_room')
-
-# Add some messages
-messenger.messages.each do |message|
-  message.add_message(:name => 'Start deployment message', :subject => "Carlos started deployment of branch foo to production at #{Time.now}")
-  message.add_message(:name => 'End deployment message', :subject => "Carlos ended deployment of branch foo to production at #{Time.now}")
-end
-
-Email and Campfire Transports are included. Create your own by inheriting from Envoy::Transport
-
-OR
-
-messenger.message(:name => 'Start deployment message', :subject => "Carlos started deployment of branch foo to production at #{Time.now}")
-
-# Deliver messages one at a time
-
-messenger.deliver_start_deployment_message
-
-AND THEN
-
-messenger.deliver_end_deployment_message
-
-OR
-
-# Deliver all messages
-
-messenger.deliver_all_messages