command_line_email 0.0.3 → 0.0.4

data/README.md

@@ -2,10 +2,6 @@
 
 Send email from the Linux or Mac command line. Attach specific file(s) or all files in a directory. Specify email body as CLI string or load from a file.
 
-## WARNING - NOT YET FULLY IMPLEMENTED
-
-This program still needs some work before I finish gemifying it. I have not yet created the bin/ directory file and currently run this by calling lib/command_line_email.rb directly.
-
 ## Installation
 
 Install command_line_email as:
@@ -26,13 +22,13 @@ This gem is useful for anyone who wishes to send email from a server using only
 
 ## Usage
 
-Once set up (see "Configuration File" below), you can send an email using various options (see "Command Line Options" below). Here's one example:
+Once set up (see "Configuration File" below), you can send an email using "clemail" plus various options (see "Command Line Options" below). Here's one example:
 
-    ruby lib/command_line_email.rb -t "me" -t "other_me" -s "Test subject line" -b "My body text"
+    clemail -t "me@myaddress.com" -t "my_friend@her_address.com" -s "Subject line text" -b "First body paragraph" -b "Second body paragraph"
 
 ### Configuration File
 
-The first time you run command_line_email, it will create a YAML file at ~/.command_line_email.yml. You edit this file to set your email configuration and, optionally, create mailing lists. A configuration file looks something like this:
+The first time you run command_line_email, it will create a YAML file at ~/.command_line_email.yml (NOT YET IMPLEMENTED). You edit this file to set your email configuration and, optionally, create mailing lists. A configuration file looks something like this:
 
     ---
     :connection:
@@ -69,7 +65,7 @@ The following command line options are available:
 
     -c (--cc) takes the same values as -t/--to and sets the email's "carbon copy" recipients
 
-    -f (--file) takes a string representing the path to a file you wish to attach to the email. This flag can be used multiple times, each with a different file.
+    -F (--file) takes a string representing the path to a file you wish to attach to the email. This flag can be used multiple times, each with a different file.
 
     -d (--directory) takes a string with a directory path. If provided with the -f/--file option, it is presumed that all files are in the directory specified by the -d/--directory option. If no -f/--file option is present, ALL files within the -d/--directory directory will be attached.
 

data/command_line_email.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/JamesLavin/command_line_email"
 
   gem.files         = `git ls-files`.split($/)
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'fakefs'
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]

data/lib/command_line_email/cle_optparse.rb

@@ -0,0 +1,65 @@
+module CommandLineEmail
+
+  class CleOptparse
+
+    def self.parse(args, user_config)
+
+      mail_attrs = {to: []}
+
+      option_parser = OptionParser.new do |opts|
+
+        opts.on("-t TO","--to TO") do |to|
+          mail_attrs[:to] = to_string_to_mailing_list(user_config, to, mail_attrs[:to])
+        end
+
+        opts.on("-f FROM","--from FROM") do |from|
+          mail_attrs[:from] = from
+        end
+
+        opts.on("-b BODY","--body BODY") do |body|
+          mail_attrs[:body] ||= ""
+          mail_attrs[:body] << body + "\n"
+        end
+
+        opts.on("-s SUBJECT","--subject SUBJECT") do |subject|
+          mail_attrs[:subject] = subject
+        end
+
+        opts.on("-c CC","--cc CC") do |cc|
+          if user_config.mailing_lists.has_key? cc.to_sym
+            mail_attrs[:cc] = user_config.mailing_lists[cc.to_sym]
+          else
+            mail_attrs[:cc] = cc
+          end
+        end
+
+        opts.on("-F FILE","--file FILE") do |file|
+          mail_attrs[:files] ||= []
+          mail_attrs[:files] << file
+        end
+
+        opts.on("-d DIRECTORY","--directory DIRECTORY") do |directory|
+          mail_attrs[:directory] = directory
+        end
+
+      end
+
+      option_parser.parse!(args)
+
+      mail_attrs
+    
+    end # parse()
+
+    def self.to_string_to_mailing_list(user_config, to, list=[])
+      # takes optional list in case you want to add to an existing list
+      if user_config.mailing_lists.has_key? to.to_sym
+        Array(user_config.mailing_lists[to.to_sym]).each { |address| list << address }
+      else
+        list << to
+      end
+      list
+    end
+
+  end
+
+end

data/lib/command_line_email/command_line_email.rb

@@ -3,99 +3,18 @@
 require 'mail'
 require 'yaml'
 require 'optparse'
-require 'send_mail_setup'
+require 'send_email_setup'
+require 'cle_optparse'
+require 'deliver_email'
 
-user_config = CommandLineEmail::SendMailSetup.new
+user_config = CommandLineEmail::SendEmailSetup.new
 
 Mail.defaults do
   delivery_method :smtp, user_config.mail_options
 end
 
-class CleOptparse
-
-  def self.parse(args, user_config)
-
-    mail_attrs = {to: []}
-
-    option_parser = OptionParser.new do |opts|
-
-      opts.on("-t TO","--to TO") do |to|
-        mail_attrs[:to] = to_string_to_mailing_list(user_config, to, mail_attrs[:to])
-      end
-
-      opts.on("-f FROM","--from FROM") do |from|
-        mail_attrs[:from] = from
-      end
-
-      opts.on("-b BODY","--body BODY") do |body|
-        mail_attrs[:body] ||= ""
-        mail_attrs[:body] << body + "\n"
-      end
-
-      opts.on("-s SUBJECT","--subject SUBJECT") do |subject|
-        mail_attrs[:subject] = subject
-      end
-
-      opts.on("-c CC","--cc CC") do |cc|
-        if user_config.mailing_lists.has_key? cc.to_sym
-          mail_attrs[:cc] = user_config.mailing_lists[cc.to_sym]
-        else
-          mail_attrs[:cc] = cc
-        end
-      end
-
-      opts.on("-f FILE","--add-file FILE") do |file|
-        mail_attrs[:files] ||= []
-        mail_attrs[:files] << file
-      end
-
-      opts.on("-d DIRECTORY","--directory DIRECTORY") do |directory|
-        mail_attrs[:directory] = directory
-      end
-
-    end
-
-    option_parser.parse!(args)
-
-    mail_attrs
-  
-  end # parse()
-
-  def self.to_string_to_mailing_list(user_config, to, list=[])
-    # takes optional list in case you want to add to an existing list
-    if user_config.mailing_lists.has_key? to.to_sym
-      Array(user_config.mailing_lists[to.to_sym]).each { |address| list << address }
-    else
-      list << to
-    end
-    list
-  end
-
-end # class CleOptparse
-
-mail_attrs = CleOptparse.parse(ARGV, user_config)
+mail_attrs = CommandLineEmail::CleOptparse.parse(ARGV, user_config)
 
 puts mail_attrs
 
-def grab_text_from_filename_if_file_exists(filename_or_text)
-  if File.exists?(filename_or_text)
-    File.open(filename_or_text,'r').read
-  else
-    filename_or_text
-  end
-end
-
-mail = Mail.new do
-  from    mail_attrs[:from]    || user_config.defaults[:from]
-  to      mail_attrs[:to]      || user_config.defaults[:to]
-  cc      mail_attrs[:cc]      || user_config.defaults[:cc]  || nil
-  subject mail_attrs[:subject] || user_config.defaults[:subject] || ''
-  body    mail_attrs[:body] ? grab_text_from_filename_if_file_exists(mail_attrs[:body]) : ''
-  if mail_attrs[:files]
-    attach_selected(mail_attrs[:files], mail_attrs[:directory] || '')
-  elsif mail_attrs[:directory]
-    attach_all_from_directory(mail_attrs[:directory])
-  end
-end
-
-mail.deliver!
+CommandLineEmail::DeliverEmail.deliver(user_config, mail_attrs)

data/lib/command_line_email/deliver_email.rb

@@ -0,0 +1,36 @@
+module CommandLineEmail
+
+  class DeliverEmail
+
+    def self.deliver(user_config, mail_attrs)
+
+      mail = Mail.new do
+        from    mail_attrs[:from]    || user_config.defaults[:from]
+        to      mail_attrs[:to]      || user_config.defaults[:to]
+        cc      mail_attrs[:cc]      || user_config.defaults[:cc]  || nil
+        subject mail_attrs[:subject] || user_config.defaults[:subject] || ''
+        body    mail_attrs[:body] ? grab_text_from_filename_if_file_exists(mail_attrs[:body]) : ''
+        if mail_attrs[:files]
+          attach_selected(mail_attrs[:files], mail_attrs[:directory] || '')
+        elsif mail_attrs[:directory]
+          attach_all_from_directory(mail_attrs[:directory])
+        end
+      end
+
+      mail.deliver!
+    
+    end
+
+    private
+
+    def self.grab_text_from_filename_if_file_exists(filename_or_text)
+      if File.exists?(filename_or_text)
+        File.open(filename_or_text,'r').read
+      else
+        filename_or_text
+      end
+    end
+
+  end
+
+end

data/lib/command_line_email/{send_mail_setup.rb → send_email_setup.rb}

@@ -2,7 +2,7 @@
 
 module CommandLineEmail
 
-  class SendMailSetup
+  class SendEmailSetup
 
     class ConfigFileNotFound < StandardError
       def initialize(msg)
@@ -14,7 +14,8 @@ module CommandLineEmail
     attr_reader :mail_options, :mail_config_file
 
     def initialize(config_file = nil)
-      @mail_config_file = config_file || File.expand_path('~/.command_line_email.yml')
+      set_mail_config_file(config_file)
+      ensure_config_file_exists
       set_mail_options
     end
 
@@ -28,14 +29,26 @@ module CommandLineEmail
 
     private
 
+    def ensure_config_file_exists
+      # nil to use default msg; [] to avoid printing ugly backtrace
+      raise(ConfigFileNotFound, nil, []) unless config_file_exists? 
+    end
+
+    def set_mail_config_file(config_file)
+      config_file ||= '~/.command_line_email.yml'
+      @mail_config_file = File.expand_path(config_file)
+    end
+
+    def config_file_exists?
+      File.exists? mail_config_file
+    end
+
     def mail_config
-      @mail_config ||= load_mail_config_file(mail_config_file)
+      @mail_config ||= load_mail_config(mail_config_file)
     end
 
-    def load_mail_config_file(mail_config_file)
+    def load_mail_config(mail_config_file)
       YAML::load(File.open(mail_config_file))
-      rescue
-        raise ConfigFileNotFound, nil, [] # turn off ugly backtrace 
     end
 
     def set_mail_options

data/lib/command_line_email/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module CommandLineEmail
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/command_line_email.rb

@@ -4,6 +4,7 @@ $LOAD_PATH.unshift("#{File.expand_path(File.dirname(__FILE__))}/command_line_ema
 
 require "mail"
 require "mail/message"
+require "extruby/mail/message"
 require "command_line_email/version"
 require "command_line_email/send_mail_setup"
 require "command_line_email/command_line_email"

data/spec/command_line_email/cle_optparse_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+require "cle_optparse"
+
+describe "cle_optparse" do
+
+  include FakeFS::SpecHelpers
+
+end

data/spec/command_line_email/command_line_email_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe "calling command_line_email" do
+
+  before do
+    $stdout = StringIO.new # suppress command line output
+  end
+
+  context "when config file not present" do
+
+    before do
+      CommandLineEmail::SendEmailSetup.any_instance.stub(:config_file_exists?).and_return(false)
+    end
+
+    it "should raise ConfigFileNotFound" do
+      expect { require "command_line_email" }.to raise_error(CommandLineEmail::SendEmailSetup::ConfigFileNotFound)
+    end
+
+  end
+
+  context "when config file present" do
+
+    before do
+      CommandLineEmail::SendEmailSetup.any_instance.stub(:config_file_exists?).and_return(true)
+    end
+
+    it "should not raise ConfigFileNotFound" do
+      expect { require "command_line_email" }.to_not raise_error(CommandLineEmail::SendEmailSetup::ConfigFileNotFound)
+    end
+
+  end
+
+end
+
+describe "other stuff" do
+
+  include FakeFS::SpecHelpers
+
+end

data/spec/command_line_email/deliver_email_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+require "deliver_email"
+
+describe "deliver_email" do
+
+  include FakeFS::SpecHelpers
+
+end

data/spec/command_line_email/send_email_setup_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+require "send_email_setup"
+
+describe "send_email_setup" do
+
+  include FakeFS::SpecHelpers
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'fakefs/spec_helpers'
+
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+$: << File.join(APP_ROOT, 'lib/command_line_email')
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command_line_email
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-25 00:00:00.000000000 Z
-dependencies: []
+date: 2012-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Send email from the Linux or Mac command line
 email:
 - command_line_email@futureresearch.com
@@ -27,10 +59,17 @@ files:
 - bin/clemail
 - command_line_email.gemspec
 - lib/command_line_email.rb
+- lib/command_line_email/cle_optparse.rb
 - lib/command_line_email/command_line_email.rb
-- lib/command_line_email/send_mail_setup.rb
+- lib/command_line_email/deliver_email.rb
+- lib/command_line_email/send_email_setup.rb
 - lib/command_line_email/version.rb
 - lib/extruby/mail/message.rb
+- spec/command_line_email/cle_optparse_spec.rb
+- spec/command_line_email/command_line_email_spec.rb
+- spec/command_line_email/deliver_email_spec.rb
+- spec/command_line_email/send_email_setup_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/JamesLavin/command_line_email
 licenses: []
 post_install_message: 
@@ -56,4 +95,10 @@ signing_key:
 specification_version: 3
 summary: Send email from the Linux or Mac command line. Can attach specific files
   or all files in a directory. Can load email body from a file.
-test_files: []
+test_files:
+- spec/command_line_email/cle_optparse_spec.rb
+- spec/command_line_email/command_line_email_spec.rb
+- spec/command_line_email/deliver_email_spec.rb
+- spec/command_line_email/send_email_setup_spec.rb
+- spec/spec_helper.rb
+has_rdoc: