ratch 1.0.0 → 1.1.0

data/lib/ratch/emailer.rb

@@ -0,0 +1,251 @@
+begin
+  require 'facets/net/smtp_tls'
+rescue LoadError
+  require 'net/smtp'
+end
+
+
+module Ratch
+
+  # Emailer class makes it easy send out an email.
+  #
+  # Settings:
+  #
+  #     subject      Subject of email message.
+  #     from         Message FROM address [email].
+  #     to           Email address to send announcemnt.
+  #     server       Email server to route message.
+  #     port         Email server's port.
+  #     port_secure  Email server's port.
+  #     domain       Email server's domain name.
+  #     account      Email account name if needed.
+  #     password     Password for login..
+  #     login        Login type: plain, cram_md5 or login [plain].
+  #     secure       Uses TLS security, true or false? [false]
+  #     message      Mesage to send -or-
+  #     file         File that contains message.
+  #
+  class Emailer
+
+    class << self
+      # Used for caching password between usages.
+      attr_accessor :password
+
+      #
+      def environment_options
+        options = {}
+        options[:server]   = ENV['EMAIL_SERVER']
+        options[:from]     = ENV['EMAIL_FROM']
+        options[:account]  = ENV['EMAIL_ACCOUNT'] || ENV['EMAIL_FROM']
+        options[:password] = ENV['EMAIL_PASSWORD']
+        options[:port]     = ENV['EMAIL_PORT']
+        options[:domain]   = ENV['EMAIL_DOMAIN']
+        options[:login]    = ENV['EMAIL_LOGIN']
+        options[:secure]   = ENV['EMAIL_SECURE']
+        options
+      end
+
+      def new_with_environment(options={})
+        environment_options.merge(options.rekey)
+        new(options)
+      end
+    end
+
+    attr_accessor :server
+    attr_accessor :port
+    attr_accessor :account
+    attr_accessor :passwd
+    attr_accessor :login
+    attr_accessor :secure
+    attr_accessor :domain
+    attr_accessor :from
+    attr_accessor :mailto
+    attr_accessor :subject
+    attr_accessor :message
+
+    #
+
+    #
+    def initialize(options={})
+      options = options.rekey
+
+      if not options[:server]
+        options = self.class.environment_options.merge(options)
+      end
+
+      @mailto    = options[:to] || options[:mailto]
+
+      @from      = options[:from]
+      @message   = options[:message]
+      @subject   = options[:subject]
+      @server    = options[:server]
+      @account   = options[:account]
+      @passwd    = options[:password]
+      @login     = options[:login]
+      @secure    = options[:secure] #.to_b
+      @domain    = options[:domain]
+      @port      = options[:port]
+
+      @port    ||= secure ? 465 : 25
+      @port = @port.to_i
+
+      @account ||= @from
+
+      @login   ||= :plain
+      @login = @login.to_sym
+
+      @passwd ||= self.class.password
+
+      @domain ||= @server
+
+      # save the password for later use
+      self.class.password = @passwd
+    end
+
+    #
+
+    def email(options={})
+      options.rekey
+
+      message = options[:message] || self.message
+      subject = options[:subject] || self.subject
+      from    = options[:from]    || self.from
+      mailto  = options[:mailto]  || options[:to] || self.mailto
+
+      raise ArgumentError, "missing email field -- server"  unless server
+      raise ArgumentError, "missing email field -- account" unless account
+
+      raise ArgumentError, "missing email field -- from"    unless from
+      raise ArgumentError, "missing email field -- mailto"  unless mailto
+      raise ArgumentError, "missing email field -- subject" unless subject
+
+      passwd ||= password("#{account} password:")
+
+      mailto = [mailto].flatten.compact
+
+      msg = ""
+      msg << "From: #{from}\n"
+      msg << "To: #{mailto.join(';')}\n"
+      msg << "Subject: #{subject}\n"
+      msg << ""
+      msg << message
+
+      #p server, port, domain, account, passwd, login, secure if verbose?
+
+      begin
+        if Net::SMTP.respond_to?(:enable_tls) && secure
+          Net::SMTP.enable_tls
+          Net::SMTP.start(server, port, domain, account, passwd, login, secure) do |smtp|
+            smtp.send_message(msg, from, mailto)
+          end
+        else
+          Net::SMTP.start(server, port, domain, account, passwd, login) do |smtp|
+            smtp.send_message(msg, from, mailto)
+          end
+        end
+        return mailto
+      rescue Exception => e
+        return e
+      end
+    end
+
+    # Ask for a password.
+    #
+    # FIXME: Does not hide password.
+
+    def password(msg=nil)
+      msg ||= "Enter Password: "
+      inp = ''
+
+      $stdout << msg
+
+      inp = STDIN.gets.chomp
+
+      #begin
+      #  system "stty -echo"
+      #  inp = gets.chomp
+      #ensure
+      #  system "stty echo"
+      #end
+
+      return inp
+    end
+
+  end
+
+end
+
+
+
+=begin
+    # Email function to easily send out an email.
+    #
+    # Settings:
+    #
+    #     subject      Subject of email message.
+    #     from         Message FROM address [email].
+    #     to           Email address to send announcemnt.
+    #     server       Email server to route message.
+    #     port         Email server's port.
+    #     domain       Email server's domain name.
+    #     account      Email account name if needed.
+    #     password     Password for login..
+    #     login        Login type: plain, cram_md5 or login [plain].
+    #     secure       Uses TLS security, true or false? [false]
+    #     message      Mesage to send -or-
+    #     file         File that contains message.
+    #
+    def email(message, settings)
+      settings ||= {}
+      settings.rekey!
+
+      server    = settings[:server]
+      account   = settings[:account]  || ENV['EMAIL_ACCOUNT']
+      passwd    = settings[:password] || ENV['EMAIL_PASSWORD']
+      login     = settings[:login].to_sym
+      subject   = settings[:subject]
+      mail_to   = settings[:to]     || settings[:mail_to]
+      mail_from = settings[:from]   || settings[:mail_from]
+      secure    = settings[:secure]
+      domain    = settings[:domain] || server
+
+      port    ||= (secure ? 465 : 25)
+      account ||= mail_from
+      login   ||= :plain
+
+      #mail_to = nil if mail_to.empty?
+
+      raise ArgumentError, "missing email field -- server"  unless server
+      raise ArgumentError, "missing email field -- account" unless account
+      raise ArgumentError, "missing email field -- subject" unless subject
+      raise ArgumentError, "missing email field -- to"      unless mail_to
+      raise ArgumentError, "missing email field -- from"    unless mail_from
+
+      passwd ||= password(account)
+
+      mail_to = [mail_to].flatten.compact
+
+      msg = ""
+      msg << "From: #{mail_from}\n"
+      msg << "To: #{mail_to.join(';')}\n"
+      msg << "Subject: #{subject}\n"
+      msg << ""
+      msg << message
+
+      begin
+        Net::SMTP.enable_tls if Net::SMTP.respond_to?(:enable_tls) and secure
+        Net::SMTP.start(server, port, domain, account, passwd, login) do |s|
+          s.send_message( msg, mail_from, mail_to )
+        end
+        puts "Email sent successfully to #{mail_to.join(';')}."
+        return true
+      rescue => e
+        if trace?
+          raise e
+        else
+          abort "Email delivery failed."
+        end
+      end
+    end
+=end
+

data/lib/ratch/io.rb

@@ -1,4 +1,5 @@
-require 'facets/consoleutils'
+require 'clio/consoleutils'
+require 'clio/ansicode'
 
 module Ratch
 
@@ -10,26 +11,25 @@ module Ratch
   class IO
 
     #
-    attr :runmode
+    attr :commandline
 
     #
-    def initialize(runmode)
-      @runmode = runmode
+    def initialize(commandline)
+      @commandline = commandline
     end
 
-    def force?  ; runmode.force?  ; end
-    def quiet?  ; runmode.quiet?  ; end
-    def trace?  ; runmode.trace?  ; end
-    def debug?  ; runmode.debug?  ; end
-    def dryrun? ; runmode.dryrun? ; end
-    def noharm? ; runmode.noharm? ; end
+    def force?   ; commandline.force?   ; end
+    def quiet?   ; commandline.quiet?   ; end
+    def trace?   ; commandline.trace?   ; end
+    def debug?   ; commandline.debug?   ; end
+    def pretend? ; commandline.pretend? ; end
 
     # Internal status report.
     #
     # Only output if dryrun or trace mode.
     #
     def status(message)
-      if runmode.dryrun? or runmode.trace?
+      if pretend? or trace?
         puts message
       end
     end
@@ -72,7 +72,7 @@ module Ratch
     #
     #
     def printline(left, right='', options={})
-      return if runmode.quiet?
+      return if quiet?
 
       separator = options[:seperator] || options[:sep] || ' '
       padding   = options[:padding]   || options[:pad] || 0
@@ -101,13 +101,13 @@ module Ratch
       if PLATFORM =~ /win/
         text.to_s
       else
-        ANSICode.send(text.color){ text.to_s }
+        Clio::ANSICode.send(text.color){ text.to_s }
       end
     end
 
     #
     def screen_width
-      ConsoleUtils.screen_width
+      Clio::ConsoleUtils.screen_width
     end
 
   end

data/lib/ratch/plugin.rb

@@ -1,6 +1,6 @@
 module Ratch
 
-  # = PLugin
+  # = Plugin
   #
   # A Plugin is essentially a delegated Service class..
   #
@@ -12,22 +12,25 @@ module Ratch
   # which allows them to call on the context easily.
   # However this means plugins cannot be used independent
   # of a batch context, and changes in the batch context
-  # can cause effects in plujgin behvior that can be harder
+  # can cause effects in plugin behvior that can be harder
   # to track down and fix if a bug arises.
   #
   # Unless the tight coupling of a plugin is required, use the
   # loose coupling of a Service class instead.
-
+  #
+  # The context must be a subclass of Ratch::DSL.
+  #
   class Plugin
 
     # The batch context.
     attr :context
 
-    alias_method :project, :context
-
     private
 
-    #
+    # Sets the context and assigns options to setter attributes
+    # if they exist and values are not nil. That last point is
+    # important. You must use 'false' to purposely negate an option.
+    # +nil+ will instead allow any default setting to be used.
     def initialize(context, options=nil)
       @context = context
 
@@ -37,14 +40,21 @@ module Ratch
 
       options ||= {}
       options.each do |k, v|
-        send("#{k}=", v) if respond_to?("#{k}=")
+        send("#{k}=", v) if respond_to?("#{k}=") && !v.nil?
       end
     end
 
+    # When subclassing, put default instance variable settngs here.
+    # Eg.
+    #
+    #   def initialize_defaults
+    #     @gravy = true
+    #   end
+    #
     def initialize_defaults
     end
 
-    # TODO: This should be optional? How?
+    # TODO: Allow this to be optional? How?
     def method_missing(s, *a, &b)
       @context.send(s, *a, &b)
     end

data/lib/ratch/script.rb

@@ -1,5 +1,4 @@
 require 'ratch/dsl'
-#require 'annotatable'
 
 module Ratch
 
@@ -10,43 +9,6 @@ module Ratch
   # How rare.
   #
   class Script < DSL
-    #include Annotatable
-
-    #
-    #annotation :cmd
-
-    #
-    #annotation :opt
-
-    #
-    #def commands
-    #  c = {}
-    #  self.class.annotations.each do |n, a|
-    #    if a.key?(:cmd)
-    #      c[n] = a[:cmd]
-    #    end
-    #  end
-    #  c
-    #end
-
-    #
-    #def initialize   
-    #  @noharm  = %w{-n --noharm --dryrun --dry-run}.any?{ |a| ARGV.delete(a) }
-    #  @verbose = %w{--verbose}.any?{|a| ARGV.delete(a) }
-    #  @quiet   = %w{--quiet}.any?{|a| ARGV.delete(a) }
-    #  @force   = %w{--force}.any?{|a| ARGV.delete(a) }
-    #  @debug   = %w{--debug}.any?{|a| ARGV.delete(a) }
-    #  @trace   = %w{--trace}.any?{|a| ARGV.delete(a) }
-    #
-    #  super
-    #end
-
-    #  @noharm  ||= %w{noharm n dryrun dry-run}.any?{|a| commandline.options[a] }
-    #  @verbose ||= %w{verbose}.any?{|a| commandline.options[a] }
-    #  @force  ||= %w{force}.any?{|a| commandline.options[a] }
-    #  @debug ||= %w{debug}.any?{|a| commandline.options[a] }
-    #  @trace ||= %w{trace}.any?{|a| commandline.options[a] }
-
   end
 
 end

data/man/ratch.1

@@ -0,0 +1,28 @@
+.\" NAME
+.\"   ratch - ruby-based batch files
+.\"
+.\" SYNOPSIS
+.\"   reap [-n] [-h] [file]
+.\"
+.\" DESCRIPTION
+.\"   Ratch is batch file system using a Ruby=based DSL.
+.\"
+.\" OPTIONS
+.\"   -h help     This option displays help.
+.\"   -n dryrun   Dry-run/no-harm mode.
+.\"
+.\" ENVIRONMENT
+.\"   PAGER    name of paging command, usually more(1), or less(1). If not set
+.\"            falls back to more(1).
+.\"
+.\" EXAMPLES
+.\"   Try this command to format this text itself:
+.\"
+.\"       $ txt2man -h 2>&1 | txt2man -T
+.\"
+.\" SEE ALSO:
+.\"   ruby(1).
+.\"
+.\" AUTHOR:
+.\"   7rans <transfire@gmail,com>
+