malone 1.0.0.rc1 → 1.0.0

data/README.md

@@ -1,71 +1,82 @@
-Originally taken from my initial draft [here][blogpost].
-
-[blogpost]: http://www.pipetodevnull.com/past/2010/11/27/simple_mailer/
+malone(1) -- send mail using smtp without any fuss
+==================================================
 
 ## USAGE
 
-```ruby
-$ gem install malone
+    require "malone"
+
+    # Typically you would do this somewhere in the bootstrapping
+    # part of your application
 
-require "malone"
+    m = Malone.connect(url: "smtp://foo%40bar.com:pass@smtp.gmail.com:587",
+                       domain: "mysite.com")
 
-# Typically you would do this somewhere in the bootstrapping
-# part of your application
+    m.deliver(from: "me@me.com", to: "you@me.com",
+              subject: "Test subject", text: "Great!")
 
-m = Malone.connect(url: "smtp://foo%40bar.com:pass1234@smtp.gmail.com:587",
-                   domain: "mysite.com")
+    # Malone.current will now remember the last configuration you setup.
+    Malone.current.config == m.config
 
-m.deliver(from: "me@me.com", to: "you@me.com",
-          subject: "Test subject", text: "Great!")
+    # Now you can also do Malone.deliver, which is syntactic sugar
+    # for Malone.current.deliver
+    Malone.deliver(from: "me@me.com", to: "you@me.com",
+                   subject: "Test subject", text: "Great!")
 
-# Malone.current will now remember the last configuration you setup.
-Malone.current.config == m.config
+    # Also starting with Malone 1.0, you can pass in :html
+    # for multipart emails.
 
-# Now you can also do Malone.deliver, which is syntactic sugar
-# for Malone.current.deliver
-Malone.deliver(from: "me@me.com", to: "you@me.com",
-               subject: "Test subject", text: "Great!")
+    Malone.deliver(from: "me@me.com", to: "you@me.com",
+                   subject: "Test subject",
+                   text: "Great!", html: "<b>Great!</b>")
 
-# Also starting with Malone 1.0, you can also pass in :html
-# for multipart emails.
 
-m.deliver(from: "me@me.com", to: "you@me.com",
-          subject: "Test subject",
-          text: "Great!", html: "<b>Great!</b>")
+## TESTING
 
-```
+    require "malone/test"
 
-That's it!
+    m = Malone.connect(url: "smtp://foo%40bar.com:pass@smtp.gmail.com:587",
+                       domain: "mysite.com")
 
-## TESTING
+    m.deliver(from: "me@me.com", to: "you@me.com",
+              subject: "Test subject", text: "Great!")
+
+    Malone.deliveries.size == 1
+    # => true
+
+    mail = Malone.deliveries.first
+
+    "me@me.com" == mail.from
+    # => true
+
+    "you@me.com" == mail.to
+    # => true
 
-```ruby
-require "malone/test"
+    "FooBar" == mail.text
+    # => true
 
-m = Malone.connect(url: "smtp://foo%40bar.com:pass1234@smtp.gmail.com:587",
-                   domain: "mysite.com")
+    "Hello World" == envelope.subject
+    # => true
 
-m.deliver(from: "me@me.com", to: "you@me.com",
-          subject: "Test subject", text: "Great!")
+## INSTALLATION
 
-Malone.deliveries.size == 1
-# => true
+    gem install malone
 
-mail = Malone.deliveries.first
+## CONFIGURATION TIPS
 
-"me@me.com" == mail.from
-# => true
+If you're used to doing configuration via environment
+variables, similar to how Heroku does configuration, then
+you can simply set an environment variable in your
+production machine like so:
 
-"you@me.com" == mail.to
-# => true
+    export MALONE_URL=smtp://foo%40bar.com:pass@smtp.gmail.com:587
 
-"FooBar" == mail.text
-# => true
+Then you can connect using the environment variable in your
+code like so:
 
-"Hello World" == envelope.subject
-# => true
-```
+    Malone.connect(url: ENV["MALONE_URL"])
 
-## LICENSE
+    # or quite simply
+    Malone.connect
 
-MIT
+By default Malone tries for the environment variable `MALONE_URL` when
+you call `Malone.connect` without any arguments.

data/malone.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'malone'
-  s.version = "1.0.0.rc1"
+  s.version = "1.0.0"
   s.summary = %{Dead-simple Ruby mailing solution which always delivers.}
   s.date = "2011-01-10"
   s.author = "Cyril David"

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: malone
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Cyril David
@@ -13,7 +13,7 @@ date: 2011-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mailfactory
-  requirement: &70255670212260 !ruby/object:Gem::Requirement
+  requirement: &70338423965500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70255670212260
+  version_requirements: *70338423965500
 - !ruby/object:Gem::Dependency
   name: cutest
-  requirement: &70255670211520 !ruby/object:Gem::Requirement
+  requirement: &70338423965000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70255670211520
+  version_requirements: *70338423965000
 description: 
 email: me@cyrildavid.com
 executables: []
@@ -62,9 +62,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11