fcoury-gmail 0.3.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Daniel Cadenas
+
+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.rdoc

@@ -0,0 +1,44 @@
+= gmail_sender
+
+A simple gem to send email through gmail
+
+  require 'rubygems'
+  require 'gmail_sender'
+
+  g = GmailSender.new("gmail_account_user_name", "gmail_account_password")
+  g.attach('/path/to/document.hz') # you can attach any number of files, but there are limits for total attachments size
+  g.send("someone@domain.com", "The subject", "The mail body")
+
+== Command line usage
+
+You can also use gmail_sender from the command line. First you need to create ~/.gmail with this content (YAML):
+
+  receiver_email: default_receiver@gmail.com
+  sender_user: gmail_account_user_name
+  sender_password: gmail_account_password
+
+Is advisable to use a different sender account than your main email address so that it's not so bad if someone reads your configuration file and gets your password.
+
+=== Examples
+
+To send your directory list to the default receiver:
+
+  ls | gmail
+
+You can specify some parameters like in this example which doesn't use pipes:
+
+  gmail -t somebody@gmail.com -s "This is the subject" -c "This is the email content" 
+
+You can send attachments by using the -a option (this example assumes that you have a receiver_email set in the ~/.gmail file so the -t is not needed):
+
+  gmail -c "hi, I'm sending some attachments" -a ./VERSION ./gmail_sender.gemspec
+  
+== Requirements
+
+tlsmail if running Ruby 1.8.6
+
+== Major contributors
+
+* Daniel Cadenas - Maintainer
+* Felipe Coury
+* iwakura

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fcoury-gmail"
+    gem.summary = %Q{A simple gem to send email through gmail}
+    gem.email = "dcadenas@gmail.com"
+    gem.homepage = "http://github.com/dcadenas/gmail_sender"
+    gem.authors = ["Daniel Cadenas"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gmail_sender #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.3.1

data/bin/gmail

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'gmail_sender'
+require 'choice'
+
+Choice.options do
+  header ''
+  header 'options:'
+  
+  option :receiver_email do
+    short '-t'
+    long '--to=RECEIVER'
+    desc 'Receiver of the email'
+  end
+
+  option :subject do
+    short '-s'
+    long '--subject=SUBJECT'
+    desc 'Subject of the email'
+  end
+
+  option :content do
+    short '-c'
+    long '--content=MAIL_CONTENTS'
+    desc 'Body of the email, uses STDIN if omitted'
+  end
+
+option :attachments do
+    short '-a'
+    long '--attachments *ATTACHMENTS'
+    desc "A list of space separated list of files you wish to attach."
+  end
+  
+end
+
+def params
+  return @params if @params
+
+  config_file_path = File.join(ENV['HOME'],'.gmail')
+  if !File.exists?(config_file_path)
+    STDERR.puts "Please first create a ~/.gmail file with some defaults. Example:
+      receiver_email: default_receiver@gmail.com
+      sender_user: gmail_account_user_name
+      sender_password: gmail_account_user_password
+    "
+    exit 1
+  end
+
+  defaults = {'subject' => 'Sent from command line',
+              'sender_domain' => 'gmail.com'}
+
+  @params = defaults.merge(YAML.load_file(config_file_path)).merge(Choice.choices)
+end
+
+
+mailer = GmailSender.new(params['sender_user'], params['sender_password'], params['sender_domain'])
+if params['attachments']
+  params['attachments'].each do |attachment|
+    mailer.attach(attachment)
+  end
+end
+content = params['content'] || (params['attachments'] && params['attachments'].join("\n"))
+mailer.send(params['receiver_email'], params['subject'], content || STDIN.read)

data/lib/gmail_sender.rb

@@ -0,0 +1,69 @@
+require 'base64'
+require "tls_smtp_patch"
+
+class GmailSender
+
+  ATTACHMENT_READ_PORTION = 150360 # you may change this, but must be multiply to 3
+
+  def initialize(user, password, domain="gmail.com")
+    @sender_domain   = domain
+    @sender_password = password
+    @sender_email     = "#{user}@#{domain}"
+    @net_smtp = Net::SMTP.new("smtp.gmail.com", 587)
+    @net_smtp.enable_starttls
+    @attachments = []
+    @boundary = rand(2**256).to_s(16)
+  end
+
+  def attach(file)
+    @attachments << file if File.exist?(file)
+  end
+
+  def send(to, subject = "", content = "")
+    @net_smtp.start(@sender_domain, @sender_email, @sender_password, :plain) do |smtp|
+      smtp.open_message_stream(@sender_email, [to]) do |msg_stream|
+        set_message_stream(msg_stream, to, subject, content)
+      end
+    end
+  end
+
+  def set_message_stream(msg_stream, to, subject, content)
+    set_headers(msg_stream, to, subject)
+    set_content(msg_stream, content)
+    set_attachments(msg_stream)
+  end
+
+private
+  def set_headers(msg_stream, to, subject)
+    msg_stream.puts "From: #{@sender_email}"
+    msg_stream.puts "To: #{to}"
+    msg_stream.puts "Subject: #{subject}"
+    unless @attachments.empty?
+      msg_stream.puts 'MIME-Version: 1.0'
+      msg_stream.puts %{Content-Type: multipart/mixed; boundary="#{@boundary}"}
+    end
+    msg_stream.puts
+    unless @attachments.empty?
+      msg_stream.puts "--#{@boundary}"
+      msg_stream.puts 'Content-Type: text/plain'
+    end
+  end
+
+  def set_content(msg_stream, content)
+    msg_stream.puts content
+  end
+
+  def set_attachments(msg_stream)
+    @attachments.each do |file|
+      msg_stream.puts "--#{@boundary}"
+      msg_stream.puts %{Content-Type: application/octet-stream; name="#{File.basename(file)}"}
+      msg_stream.puts %{Content-Disposition: attachment; filename="#{File.basename(file)}"}
+      msg_stream.puts 'Content-Transfer-Encoding: base64'
+      msg_stream.puts "Content-ID: <#{File.basename(file)}>"
+      msg_stream.puts
+      File.open(file) do |fd|
+        msg_stream.puts Base64.encode64(fd.read(ATTACHMENT_READ_PORTION)) until fd.eof?
+      end
+    end
+  end
+end

data/lib/tls_smtp_patch.rb

@@ -0,0 +1,10 @@
+require "net/smtp"
+
+unless Net::SMTP.instance_methods.include?(:enable_starttls)
+  require "tlsmail" 
+  class Net::SMTP
+    def enable_starttls
+      enable_tls(OpenSSL::SSL::VERIFY_NONE)
+    end
+  end
+end

data/test/gmail_sender_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+Expectations do
+  expect "From: gmail_account_name@gmail.com\nTo: to@gmail.com\nSubject: subject\n\nbody\n" do
+    gmail_sender = GmailSender.new("gmail_account_name", "gmail_account_password")
+    string_io = StringIO.new
+    gmail_sender.set_message_stream(string_io, "to@gmail.com", "subject", "body")
+    string_io.string
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'expectations'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gmail_sender'

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: fcoury-gmail
+version: !ruby/object:Gem::Version 
+  version: 0.3.1
+platform: ruby
+authors: 
+- Daniel Cadenas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-20 00:00:00 -02:00
+default_executable: gmail
+dependencies: []
+
+description: 
+email: dcadenas@gmail.com
+executables: 
+- gmail
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/gmail
+- lib/gmail_sender.rb
+- lib/tls_smtp_patch.rb
+- test/gmail_sender_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/dcadenas/gmail_sender
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simple gem to send email through gmail
+test_files: 
+- test/gmail_sender_test.rb
+- test/test_helper.rb