mmailer 0.0.4 → 0.0.5

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## VERSION "0.0.5"
+
+* Zoho set to port 465
+* display version in cli
+
 ## VERSION "0.0.4"
 
 * Initial release

data/README.md

@@ -56,8 +56,6 @@ To restart from  the 56th element in your queue (more on this later).
 
     $ mmailer start 56
 
-The results of above commands are displayed in the server terminal.
-
 ### Bundler
 
 Although this gem performs as a standalone program, nothing prevents you from adding the following in a project's Gemfile:
@@ -104,10 +102,10 @@ end
 
 * `from`: The from address that will be used in your emails.
 * `subject`: The subject of your email.
-* `provider`: The name of your provider. These are preset. For the moment, Gmail, Zoho and Mandrill are defined. Please add more via pull requests or by sending me mail.
+* `provider`: The name of your provider. These are preset. For the moment, one of `:gmail`, `:zoho` or `:mandrill`. Please add more providers via pull requests or by sending me mail.
 * `time_interval`: The number of seconds we want to wait between emails. We use this value as a ceiling when randomizing.
 * `mail_interval`: After how many emails we wait before continuing.
-* `sleep_time`: How long we wait when we reach the mail interval.
+* `sleep_time`: How long we wait when we reach the mail interval/threshold.
 * `collection`: An array of objects that respond to an `email` message. In the above example, the objects also respond to a `name` message. This will prove handy in templates. Instead of directly providing the array, it is recommended to specify a lambda that returns said array. You will then be able to make expensive calls to your database, bringing as many objects as memory permits, without impacting the server startup time.
 * `template`: The path (relative to the current directory) and filename to the ERB templates for your mail, without suffix. For example, "newsletter". This means your template files are actually "newsletter.txt.erb" and "newsletter.html.erb" in the current directory.
 
@@ -127,7 +125,7 @@ Yours.
 And the equivalent html template.
 
 ```ruby
-<p>Dear <em><%= user.name %></em>/p>
+<p>Dear <em><%= user.name %></em></p>
 <p>This is my newsletter.</p>
 <p>Yours.</p>
 ```
@@ -170,7 +168,7 @@ Mmailer.configure do |config|
   config.provider = :gmail
   config.subject = "My newsletter"
   config.template = "newsletter"
-  config.collection = lambda { User.all.entries}
+  config.collection = lambda { User.all.entries }
   config.time_interval = 6
   config.from = 'John Doe <john@example.com>'
 end
@@ -222,6 +220,10 @@ The server exposes an object representing the state of your queue (started/stopp
 
 We use MicroMachine, a minimal finite state machine, to help with the state transitioning.
 
+### Mail
+
+We leverage the ubiquitous Mail gem to do the actual sending of email.
+
 ### CLI
 
 We used Thor to provide a command line interface.
@@ -232,17 +234,19 @@ This program will be best served with some sort of GUI. A web-based interface (u
 
 ## Status
 
-This program makes me happy as it solves one of my problems. It may not be a beginner's friendly program, however. You might want to wait for the web interface if it all seems a little bit too involved.
+This is an initial release. Currently, no checks or sanitation is done when parsing the configuration. Mmailer will just blow up when an error is encountered. At this early stage, the project targets power users and contributors. Others may want to wait for a later release that will hopefully sport a web interface with better usability.
 
-## TODO
+## Roadmap
 
 * [] Web interface
 * [X] Command-line interface
 * [] Documentation
+* [] Test suite
+* [] Generic template engine (Tilt, https://github.com/rtomayko/tilt)
 
 ## Spam
 
-Mmailer is a mail sending tool. Don't use it for spamming purposes. Spam is evil.
+Mmailer is a bulk mail sending tool. Don't use it for spamming purposes. Spam is evil.
 
 ## Contributing
 

data/lib/mmailer/commands.rb

@@ -7,25 +7,35 @@ class MyCLI < Thor
   end
 
   desc "start FROM", "Start an email run from FROM (default is 0, start of the collection)."
+
   def start(from=0)
     client(:start, from.to_i)
   end
 
   desc "pause", "Pause an email run."
+
   def pause
     client(:pause)
   end
 
   desc "resume", "Resume an email run."
+
   def resume
     client(:resume)
   end
 
   desc "stop", "Stop an email run and exit server."
+
   def stop
     client(:stop)
   end
 
+  desc "version", "Show mmailer version"
+
+  def version
+    require 'mmailer'
+    puts Mmailer::VERSION
+  end
 
   private
 

data/lib/mmailer/providers.rb

@@ -29,11 +29,13 @@ module Mmailer
 
     @zoho = Proc.new do
       delivery_method :smtp, {
-          :port => 587,
+          :port => 465,
           :address => "smtp.zoho.com",
           :user_name => ENV['ZOHO_USERNAME'],
           :password => ENV['ZOHO_PASSWORD'],
-          :authentication => :plain,
+          :authentication => :login,
+          :ssl => true,
+          :tls => true,
           :enable_starttls_auto => true
       }
     end

data/lib/mmailer/version.rb

@@ -1,3 +1,3 @@
 module Mmailer
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mmailer
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-14 00:00:00.000000000 Z
+date: 2013-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler