post_office 0.3.0 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce85b02dd82bd4acd4fe34c5bf0c56f9b343ad7480a1c2e3ac429146e9b77e44
+  data.tar.gz: c032ebc0fedff67be24fb010b77f1f9d7144354329d333c707e2ad5a51b0bfd5
+SHA512:
+  metadata.gz: 0a870109cf0a649ab8c0a5f4713532b0060e97a4e9002c6a8a8cf30ebbf6be002cb59418f79a7ef4f5e0c823d5a1d8fe9fa7d7cf8b53476d036e86ffdafdbbdd
+  data.tar.gz: 7374e542844b2abfd968e12f9d339a4bc28138a8e4f82bd4407d22797d2f7cb6fc7bd7c11fe1e78c355e8672cb9c3a22f000ce9744b45a4fe260d7825b396461

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011-2013 LICO Innovations
+
+MIT License
+
+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.md

@@ -1,13 +1,6 @@
 PostOffice mock SMTP/POP3 server
 ================================
 
-https://github.com/bluerail/post_office
-
-By Rene van Lieshout <rene@bluerail.nl>
-
-Description
------------
-
 PostOffice is a mock SMTP/POP3 server to accept mails sent from your Rails application when it's running in development. The messages can be retrieved using a standard POP3 client, such as mail.app. Just connect to localhost with any username and password.
 
 Note: Received messages are **not** sent to their final recipient and will remain available until deleted or when the process is quit.
@@ -21,12 +14,22 @@ Usage
 -----
 
     sudo post_office [options]
-    
+
     -v, --verbose                    Output more information
     -l, --logfile FILE               Write log to FILE. Outputs to STDOUT (or /var/log/post_office.log when daemonized) by default.
+    -s, --smtp PORT                  Specify SMTP port to use
+    -p, --pop3 PORT                  Specify POP3 port to use
+
     -h, --help                       Display this screen
 
-This starts the service and listens on port 25 and 110. Configure your POP3 client with any username and password.
+This starts the service and listens on the specified ports (or 25 for SMTP and 110 for POP3 by default). Configure your POP3 client with any username and password.
+
+Config
+------
+
+Post Office will try to find a configuration file (post_office/config.json) in the user dir ($HOME), and then in /etc. It will load the first one it finds.
+
+The arguments passed on the command line will always override the ones specified in the config file.
 
 Daemon
 ------
@@ -69,8 +72,30 @@ The Startup Item is stored in */Library/StartupItems/PostOffice*
 Planned features
 ----------------
 
-* Ability to use custom ports for SMTP and POP
-* Growl notifications
 * Store mail in tempfiles instead of in-memory array
 
 Contributions are welcome! Feel free to fork and send a pull request through Github.
+
+## Changelog
+
+### 1.0.1 (Jan 17, 2022)
+
+* [(snoutmate)](https://github.com/snoutmate) [Added SMTP AUTH support](https://github.com/bluerail/post_office/pull/7)
+
+### 1.0.0 (Aug 11, 2016)
+
+* [(tijn)](https://github.com/tijn) [load a config file and move default options (to become more DRY)](https://github.com/bluerail/post_office/pull/5)
+* [(gamecreature)](https://github.com/gamecreature) [NOOP smtp command support](https://github.com/bluerail/post_office/pull/4)
+* [(martijn)](https://github.com/martijn) Shorten timestamp in logs
+
+### 0.3.3 (Sep 13, 2011)
+
+* [(sgeorgi)](https://github.com/sgeorgi) [Specifying SMTP and POP3 ports on the command line](https://github.com/bluerail/post_office/pull/2)
+
+### 0.3.2 (Sep 13, 2011)
+
+Broken build
+
+### 0.3.1 (Aug 16, 2011)
+
+* First 'official' release

data/VERSION

@@ -1 +1 @@
-0.3.0
+1.0.1

data/bin/post_office

@@ -6,29 +6,41 @@ require 'logger'
 require 'thread'
 require 'smtp_server.rb'
 require 'pop_server.rb'
+require 'config_file.rb'
+
+options = ConfigFile.detect.read
 
 #
 # Parse command line arguments
 #
-options = {}
- 
 optparse = OptionParser.new do |opts|
   opts.banner = "Usage: #{__FILE__} [options]"
 
-  options[:verbose] = false
+  options[:verbose] ||= false
   opts.on( '-v', '--verbose', 'Output more information' ) do
     options[:verbose] = true
   end
 
-  options[:logfile] = nil
+  options[:logfile] ||= nil
   opts.on( '-l', '--logfile FILE', 'Write log to FILE. Outputs to STDOUT (or /var/log/post_office.log when daemonized) by default.' ) do |file|
     options[:logfile] = file
   end
-  
+
+  options[:smtp_port] ||= 25
+  opts.on( '-s', '--smtp PORT', 'Specify SMTP port to use' ) do |port|
+    options[:smtp_port] = port
+  end
+
+  options[:pop3_port] ||= 110
+  opts.on( '-p', '--pop3 PORT', 'Specify POP3 port to use' ) do |port|
+    options[:pop3_port] = port
+  end
+
   options[:startup_item] = nil
   opts.on('--install-osx-startup-item', 'Installs Post Office as OS X Startup Item') do
     options[:startup_item] = :install
   end
+
   opts.on('--remove-osx-startup-item', 'Removes Post Office as OS X Startup Item') do
     options[:startup_item] = :remove
   end
@@ -58,15 +70,17 @@ end
 #
 $log = Logger.new(options[:logfile] || STDOUT)
 $log.level = options[:verbose] ? Logger::DEBUG : Logger::INFO
+$log.datetime_format = "%H:%M:%S"
 
 begin
-  smtp_server = Thread.new{ SMTPServer.new }
-  pop_server  = Thread.new{ POPServer.new  }
+  smtp_server = Thread.new{ SMTPServer.new(options[:smtp_port]) }
+  pop_server  = Thread.new{ POPServer.new(options[:pop3_port]) }
 
   smtp_server.join
   pop_server.join
 rescue Interrupt
   $log.info "Interrupt..."
 rescue Errno::EACCES
-  $log.error "I need root access to open ports 25 and 110. Please sudo #{__FILE__}"
+  $log.error "I need root access to open ports #{options[:smtp_port]} and / or #{options[:pop3_port]}. Please sudo #{__FILE__}"
 end
+

data/lib/config_file.rb

@@ -0,0 +1,24 @@
+require 'json'
+
+class ConfigFile
+  USER_CONFIG_DIR = ENV.fetch('XDG_CONFIG_HOME', ENV['HOME'] + '/.config')
+  SYSTEM_CONFIG_DIR = '/etc'
+  CONFIG_DIRS = [USER_CONFIG_DIR, SYSTEM_CONFIG_DIR]
+  attr_reader :filename
+
+  def initialize(filename)
+    @filename = filename
+  end
+
+  def self.detect
+    filename =
+      CONFIG_DIRS.map { |dir| "#{dir}/post_office/config.json" }
+                 .detect { |file| File.exist? file }
+    new(filename)
+  end
+
+  def read
+    return {} if @filename.nil?
+    JSON.parse(File.read(@filename), symbolize_names: true)
+  end
+end

data/lib/generic_server.rb

@@ -26,7 +26,14 @@ class GenericServer
     @port = options[:port]
     server = TCPServer.open(@port)
     $log.info "#{self.class.to_s} listening on port #{@port}"
-    
+
+    # Try to increase the buffer to give us some more time to parse incoming data
+    begin
+      server.setsockopt(Socket::SOL_SOCKET, Socket::SO_RCVBUF, 1024 * 1024)
+    rescue
+      # then try it using our available buffer
+    end
+
     # Accept connections until infinity and beyond
     loop do
       Thread.start(server.accept) do |client|
@@ -45,6 +52,7 @@ class GenericServer
             $log.debug "#{client.object_id}:#{@port} < #{input}"
 
             process(client, command, input)
+
           end until client.closed?
           $log.info "#{self.class.to_s} closed connection #{client.object_id} with #{client_addr.inspect}"
         rescue => detail

data/lib/pop_server.rb

@@ -6,8 +6,8 @@ require 'digest/md5'
 
 class POPServer < GenericServer
   # Create new server listening on port 110
-  def initialize
-    super(:port => 110)
+  def initialize(port)
+    super(:port => port)
   end
   
   # Send a greeting to client

data/lib/smtp_server.rb

@@ -7,9 +7,9 @@ class SMTPServer < GenericServer
   attr_accessor :client_data
   
   # Create new server listening on port 25
-  def initialize
+  def initialize(port)
     self.client_data = Hash.new
-    super(:port => 25)
+    super(:port => port)
   end
   
   # Send a greeting to client
@@ -22,10 +22,12 @@ class SMTPServer < GenericServer
     case command
       when 'DATA' then data(client)
       when 'HELO', 'EHLO' then respond(client, 250)
+      when 'NOOP' then respond(client, 250)
       when 'MAIL' then mail_from(client, full_data)
       when 'QUIT' then quit(client)
       when 'RCPT' then rcpt_to(client, full_data)
       when 'RSET' then rset(client)
+      when 'AUTH' then auth(client)
       else begin
         if get_client_data(client, :sending_data)
           append_data(client, full_data)
@@ -65,6 +67,7 @@ class SMTPServer < GenericServer
   # Markes client sending data
   def data(client)
     set_client_data(client, :sending_data, true)
+    set_client_data(client, :data, "")
     respond(client, 354)
   end
   
@@ -73,6 +76,11 @@ class SMTPServer < GenericServer
     self.client_data[client.object_id] = Hash.new
   end
   
+  # Authenticates client
+  def auth(client)
+    respond(client, 235)
+  end
+
   # Adds full_data to incoming mail message
   #
   # We'll store the mail when full_data == "."
@@ -86,7 +94,7 @@ class SMTPServer < GenericServer
       respond(client, 250)
       $log.info "Received mail from #{get_client_data(client, :from).to_s} with recipient #{get_client_data(client, :to).to_s}"
     else
-      set_client_data(client, :data, get_client_data(client, :data).to_s + full_data)
+      self.client_data[client.object_id][:data] << full_data
     end
   end
   
@@ -119,6 +127,7 @@ class SMTPServer < GenericServer
     214 => "Help message",
     220 => "Bluerail Post Office Service ready",
     221 => "Bluerail Post Office Service closing transmission channel",
+    235 => "Authentication successful",
     421 => "Bluerail Post Office Service not available,",
     250 => "Requested mail action okay, completed",
     251 => "User not local; will forward to <forward-path>",

data/post_office.gemspec

@@ -2,47 +2,42 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: post_office 1.0.1 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = %q{post_office}
-  s.version = "0.2.1"
+  s.name = "post_office".freeze
+  s.version = "1.0.1"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Rene van Lieshout"]
-  s.date = %q{2011-04-19}
-  s.description = %q{A mock SMTP/POP3 server to aid in the development of applications with mail functionality.}
-  s.email = %q{rene@bluerail.nl}
-  s.executables = ["post_office", "post_officed"]
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Rene van Lieshout".freeze]
+  s.date = "2022-01-17"
+  s.description = "A mock SMTP/POP3 server to aid in the development of applications with mail functionality.".freeze
+  s.email = "rene@bluerail.nl".freeze
+  s.executables = ["post_office".freeze, "post_officed".freeze]
   s.extra_rdoc_files = [
+    "LICENSE",
     "README.md"
   ]
   s.files = [
+    "LICENSE",
     "README.md",
     "Rakefile",
     "VERSION",
     "bin/post_office",
     "bin/post_officed",
+    "lib/config_file.rb",
     "lib/generic_server.rb",
     "lib/pop_server.rb",
     "lib/smtp_server.rb",
+    "lib/startup_item.rb",
     "lib/store.rb",
-    "pkg/post_office-0.1.0.gem",
-    "pkg/post_office-0.2.0.gem",
-    "pkg/post_office-0.2.1.gem",
-    "post_office.gemspec"
+    "post_office.gemspec",
+    "startup_item/PostOffice/PostOffice",
+    "startup_item/PostOffice/StartupParameters.plist"
   ]
-  s.homepage = %q{http://github.com/bluerail/post_office}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.0}
-  s.summary = %q{PostOffice mock SMTP/POP3 server}
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
+  s.homepage = "http://github.com/bluerail/post_office".freeze
+  s.rubygems_version = "3.0.9".freeze
+  s.summary = "PostOffice mock SMTP/POP3 server".freeze
 end
 

metadata

@@ -1,83 +1,61 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: post_office
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
+version: !ruby/object:Gem::Version
+  version: 1.0.1
 platform: ruby
-authors: 
+authors:
 - Rene van Lieshout
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2011-05-18 00:00:00 +02:00
-default_executable: 
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies: []
-
-description: A mock SMTP/POP3 server to aid in the development of applications with mail functionality.
+description: A mock SMTP/POP3 server to aid in the development of applications with
+  mail functionality.
 email: rene@bluerail.nl
-executables: 
+executables:
 - post_office
 - post_officed
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
+- LICENSE
 - README.md
-files: 
+files:
+- LICENSE
 - README.md
 - Rakefile
 - VERSION
 - bin/post_office
 - bin/post_officed
+- lib/config_file.rb
 - lib/generic_server.rb
 - lib/pop_server.rb
 - lib/smtp_server.rb
 - lib/startup_item.rb
 - lib/store.rb
-- pkg/post_office-0.1.0.gem
-- pkg/post_office-0.2.0.gem
-- pkg/post_office-0.2.1.gem
 - post_office.gemspec
 - startup_item/PostOffice/PostOffice
 - startup_item/PostOffice/StartupParameters.plist
-has_rdoc: true
 homepage: http://github.com/bluerail/post_office
 licenses: []
-
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.5.0
-signing_key: 
-specification_version: 3
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
 summary: PostOffice mock SMTP/POP3 server
 test_files: []
-