net-smtp-proxy 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b21b652bd81a297ede1bf7d17f5d0cf905defc5c371ede6c9f43e0480e8118f
-  data.tar.gz: 861663272537d7d5ef072dec5d593235424d7ebbe6d96e042a4d435797a7acfe
+  metadata.gz: e461f6f7c17acc5fb3fcd5a9bd3fa830be74d491a5b32da3a4edd2fe51ab6187
+  data.tar.gz: 79ac2ee20166f4b23f5676f40b6045bb38cf4e82a1a593903efc592b874a7050
 SHA512:
-  metadata.gz: b53016b660aa90d84f020b2c44920124a467e84016f4cc5eb82d223c4c638724573e3420b61a8125241b74cd4fac6a20d01a0fd80cb6c1336a05e9c5abfad06a
-  data.tar.gz: 1fe4d577140248f324305d3e21665059c54a8b50722b8275c2a4a3e49c320f178aa15daf96dcf8bdcb81e01aa6554c496f1197b67a1857ba6950950d4f50ddd9
+  metadata.gz: ca662340ca87f6d80b99f130d5c87c96f7dcfccbdf4d598a5859379e536b19bf6a5d36f78bb517f1f6e6b4820e4ee58cf95b9a023c99986a3c7b2ef853a57fd6
+  data.tar.gz: 462268f69e3910707ae18cd4445364dd68fb608238c9224527e45c6513c6345d5c20982a838bbf1f4057d00fad5f4b184b55fb26c5601d7337b7ac8f5e44b7f8

data/README.md

@@ -0,0 +1,76 @@
+## net-smtp-proxy
+Proxy support for Ruby's Net::SMTP library.
+
+## Installation
+
+`gem install net-smtp-proxy`
+
+or put it in your Gemfile:
+
+```ruby
+gem 'net-smtp-proxy'
+```
+
+Once it's available in your project, require it like so:
+
+```ruby
+require 'net/smtp/proxy'
+```
+
+### What is this Thing?
+
+This gem allows you to connect to an SMTP server by way of an HTTP proxy. Why would you want to do that? I'm sure a number of use-cases exist, but I specifically needed to connect to the Gmail SMTP relay service in order to send an email from a company-wide alias. Normally, Gmail requires you to provide the credentials for the sender's account when sending an email. The relay service however replaces the usual password authentication with IP whitelisting. You provide Google with a static IP address that all your SMTP requests will come from. The SMTP relay service also allows you to send email from company-wide email aliases, i.e. accounts that don't have a login. In our case, we wanted to send an email from the Platform Engineering Team as opposed to one specific member of that team. We already had [Squid](http://www.squid-cache.org/) set up as a [reverse proxy](https://en.wikipedia.org/wiki/Reverse_proxy) with a static IP, so we whitelisted the IP with Google and wrote this gem to send SMTP requests through the proxy.
+
+### Usage
+
+Instantiate an instance of the `Proxy` class and use it to make SMTP requests:
+
+```ruby
+address = 'smtp-relay.gmail.com'
+port = 587
+proxy_address = 'http://myproxy.mydomain.com'
+proxy_port = 1234
+
+proxy = Net::SMTP::Proxy.new(address, port, proxy_address, proxy_port)
+
+proxy.start do |smtp|
+  smtp.helo('mydomain.com')
+end
+```
+
+You can also use the `.start` method to accomplish the same thing:
+
+```ruby
+Net::SMTP::Proxy.start(address, port, proxy_address, proxy_port) do |smtp|
+  smtp.helo('mydomain.com')
+end
+```
+
+### Integration with the Mail Gem
+
+The `DeliveryMethod` class provides an easy way to integrate with the [Mail gem](https://github.com/mikel/mail). Simply pass the class in as the delivery method, providing the same options hash you would pass to the SMTP delivery method (plus the proxy options):
+
+```ruby
+Mail.deliver do
+  delivery_method Net::SMTP::Proxy::DeliveryMethod, {
+    address: address,
+    port: port,
+    proxy_address: proxy_address,
+    proxy_port: proxy_port,
+    domain: 'mydomain.com'
+  }
+
+  from    'from@mydomain.com'
+  to      'to@mydomain.com'
+  subject 'Mail is cool'
+  body    "Look ma, I'm sending email!"
+end
+```
+
+## License
+
+Licensed under the MIT license. See LICENSE for details.
+
+## Authors
+
+* Cameron C. Dutro: http://github.com/camertron

data/lib/net/{smtp-proxy → smtp}/proxy.rb

@@ -2,10 +2,19 @@ require 'net/smtp'
 require 'proxifier'
 
 module Net
-  module SMTPProxy
+  class SMTP
     class Proxy < SMTP
+      autoload :DeliveryMethod, 'net/smtp/proxy/delivery_method'
+
       attr_reader :proxy_address, :proxy_port
 
+      class << self
+        def start(address, port = nil, proxy_address = nil, proxy_port = nil,
+                  helo = 'localhost', user = nil, secret = nil, authtype = nil, &block)
+          new(address, port, proxy_address, proxy_port).start(helo, user, secret, authtype, &block)
+        end
+      end
+
       def initialize(address, port, proxy_address, proxy_port)
         super(address, port)
         @proxy_address = proxy_address

data/lib/net/smtp/proxy/delivery_method.rb

@@ -0,0 +1,46 @@
+require 'net/smtp'
+
+begin
+  require 'mail'
+rescue LoadError
+  puts 'The mail gem is required to use the DeliveryMethod class.'
+end
+
+module Net
+  class SMTP
+    class Proxy < SMTP
+      # for use with the mail gem
+      class DeliveryMethod < ::Mail::SMTP
+        private
+
+        # adapted from
+        # https://github.com/mikel/mail/blob/6bc16b4bce4fe280b19523c939b14a30e32a8ba4/lib/mail/network/delivery_methods/smtp.rb#L112
+        def build_smtp_session
+          init_params = [
+            settings[:address], settings[:port],
+            settings[:proxy_address], settings[:proxy_port]
+          ]
+
+          Net::SMTP::Proxy.new(*init_params).tap do |smtp|
+            if settings[:tls] || settings[:ssl]
+              if smtp.respond_to?(:enable_tls)
+                smtp.enable_tls(ssl_context)
+              end
+            elsif settings[:enable_starttls]
+              if smtp.respond_to?(:enable_starttls)
+                smtp.enable_starttls(ssl_context)
+              end
+            elsif settings[:enable_starttls_auto]
+              if smtp.respond_to?(:enable_starttls_auto)
+                smtp.enable_starttls_auto(ssl_context)
+              end
+            end
+
+            smtp.open_timeout = settings[:open_timeout] if settings[:open_timeout]
+            smtp.read_timeout = settings[:read_timeout] if settings[:read_timeout]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/net/smtp/proxy/version.rb

@@ -0,0 +1,9 @@
+require 'net/smtp'
+
+module Net
+  class SMTP
+    class Proxy < SMTP
+      VERSION = '2.0.0'
+    end
+  end
+end

data/net-smtp-proxy.gemspec

@@ -1,14 +1,14 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
-require 'net/smtp-proxy/version'
+require 'net/smtp/proxy/version'
 
 Gem::Specification.new do |s|
   s.name     = 'net-smtp-proxy'
-  s.version  = ::Net::SMTPProxy::VERSION
+  s.version  = ::Net::SMTP::Proxy::VERSION
   s.authors  = ['Cameron Dutro']
   s.email    = ['camertron@gmail.com']
   s.homepage = 'http://github.com/camertron'
 
-  s.description = s.summary = "Proxy support for Ruby's Net::SMTP."
+  s.description = s.summary = "Proxy support for Ruby's Net::SMTP library."
 
   s.platform = Gem::Platform::RUBY
   s.has_rdoc = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-smtp-proxy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-05 00:00:00.000000000 Z
+date: 2018-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: proxifier
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-description: Proxy support for Ruby's Net::SMTP.
+description: Proxy support for Ruby's Net::SMTP library.
 email:
 - camertron@gmail.com
 executables: []
@@ -60,11 +60,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- README.md
 - Rakefile
-- lib/net/smtp-proxy.rb
-- lib/net/smtp-proxy/delivery_method.rb
-- lib/net/smtp-proxy/proxy.rb
-- lib/net/smtp-proxy/version.rb
+- lib/net/smtp/proxy.rb
+- lib/net/smtp/proxy/delivery_method.rb
+- lib/net/smtp/proxy/version.rb
 - net-smtp-proxy.gemspec
 homepage: http://github.com/camertron
 licenses: []
@@ -88,5 +88,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Proxy support for Ruby's Net::SMTP.
+summary: Proxy support for Ruby's Net::SMTP library.
 test_files: []

data/lib/net/smtp-proxy.rb

@@ -1,9 +0,0 @@
-require 'net/smtp'
-require 'proxifier'
-
-module Net
-  module SMTPProxy
-    autoload :DeliveryMethod, 'net/smtp-proxy/delivery_method'
-    autoload :Proxy,          'net/smtp-proxy/proxy'
-  end
-end

data/lib/net/smtp-proxy/delivery_method.rb

@@ -1,42 +0,0 @@
-begin
-  require 'mail'
-rescue LoadError
-  puts 'The mail gem is required to use the DeliveryMethod class.'
-end
-
-module Net
-  module SMTPProxy
-    # for use with the mail gem
-    class DeliveryMethod < ::Mail::SMTP
-      private
-
-      # adapted from
-      # https://github.com/mikel/mail/blob/6bc16b4bce4fe280b19523c939b14a30e32a8ba4/lib/mail/network/delivery_methods/smtp.rb#L112
-      def build_smtp_session
-        init_params = [
-          settings[:address], settings[:port],
-          settings[:proxy_address], settings[:proxy_port]
-        ]
-
-        Net::SMTPProxy::Proxy.new(*init_params).tap do |smtp|
-          if settings[:tls] || settings[:ssl]
-            if smtp.respond_to?(:enable_tls)
-              smtp.enable_tls(ssl_context)
-            end
-          elsif settings[:enable_starttls]
-            if smtp.respond_to?(:enable_starttls)
-              smtp.enable_starttls(ssl_context)
-            end
-          elsif settings[:enable_starttls_auto]
-            if smtp.respond_to?(:enable_starttls_auto)
-              smtp.enable_starttls_auto(ssl_context)
-            end
-          end
-
-          smtp.open_timeout = settings[:open_timeout] if settings[:open_timeout]
-          smtp.read_timeout = settings[:read_timeout] if settings[:read_timeout]
-        end
-      end
-    end
-  end
-end

data/lib/net/smtp-proxy/version.rb

@@ -1,5 +0,0 @@
-module Net
-  module SMTPProxy
-    VERSION = '1.0.0'
-  end
-end