gmail-mailer 0.2.0 → 0.3.0

data/Changelog.md

@@ -0,0 +1,10 @@
+= gmail-mailer Changelog
+
+=== 0.3.0
+* Removed the `from` field from `GmailMailer::Message`
+* Added accessors for `to`, `subject`, `body` fields
+* put validation on `to` field. 
+=== 0.2.0
+* Removed attachments from the constructor and added `add_attachment` method
+=== 0.1.0
+* Initial version

data/{README.rdoc → README.md}

@@ -1,22 +1,20 @@
-= gmail-mailer
+Programatically send emails using a given gmail account. No username/passwords needed, just use your OAUTH credentials
 
-simple gem to allow you to send emails using your gmail account (without having to fiddle around with passwords)
+## Usage
+### Creating a message
+    message = GmailMailer::Message.new("to", "Hello Subject", "Hello Body")
 
-= Usage
-== Creating a message
-    message = GmailMailer::Message.new("to", "from", "Hello Subject", "Hello Body")
+### Adding attachments
+**NOTE:** Only single attachments work at the current moment in time 
+    message.add_attachment("<path-to-file>")
 
-== Adding attachments
-((*NOTE:*))Only single attachments work at the current moment in time 
-    message.add_attachment(Filepath)
-
-== Setting up gmail-mailer
+### Setting up gmail-mailer
 You will need to provide mailer with a hashmap containing the ouath details for your account.
 
-== Sending a message
+### Sending a message
     mailer.send(message)
 
-== Example application
+### Example application
     require 'gmail-mailer'
     email_credentials = 
     {
@@ -30,13 +28,19 @@ You will need to provide mailer with a hashmap containing the ouath details for
         :email=>"<your gmail address>"
     }
 
-    message = GmailMailer::Message.new("to","from", "Hello Subject", "Hello Body")
+    # construct message
+    message = GmailMailer::Message.new("to", "Hello Subject", "Hello Body")
+
+    # add an attachment to the message
     message.add_attachment(File.expand_path('~/image.png'))
 
+    # construct mailer using the email_credentials defined above
     mailer = GmailMailer::Mailer.new(email_credentials)
+
+    # send email
     mailer.send(message)
        
-== Contributing to gmail-mailer
+### Contributing to gmail-mailer
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -46,7 +50,7 @@ You will need to provide mailer with a hashmap containing the ouath details for
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+### Copyright
 
 Copyright (c) 2011 Daniel Harper. See LICENSE.txt for
 further details.

data/TODO.txt

@@ -1,3 +1,4 @@
 changes needed for next version: -
-- Add more validation for email configuration
+- Better validation for email configuration
 - Add better handling for SMTP errors
+- unit testing

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/gmail-mailer.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gmail-mailer}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Harper"]
@@ -14,14 +14,15 @@ Gem::Specification.new do |s|
   s.email = %q{djharperuk@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
+    "Changelog.md",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "TODO.txt",
     "VERSION",

data/lib/gmail-mailer.rb

@@ -9,7 +9,6 @@ module GmailMailer
 
     def send(message)
       mail = Mail.new do
-        from message.from
         to message.to
         subject message.subject
         body message.body
@@ -52,10 +51,11 @@ module GmailMailer
   end
 
   class Message
-    attr_reader :to, :from, :subject, :body, :attachments
-    def initialize(to, from, subject="", body="")
-      @to = to
-      @from = from
+    attr_accessor :to, :subject, :body 
+    attr_reader :attachments
+    def initialize(to, subject="", body="")
+      raise ArgumentError, "You must specify an email address to send the message to!" if(to.nil? or to.empty?)
+      @to = to 
       @subject = subject
       @body = body
       @attachments = []

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Daniel Harper
@@ -115,13 +115,14 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.md
 files: 
 - .document
+- Changelog.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - TODO.txt
 - VERSION
@@ -141,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2151435929044116729
+      hash: -3791998660236781509
       segments: 
       - 0
       version: "0"