ruby-managesieve 0.3.0 → 0.4.0

data/bin/sievectl

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 #
 #--
-# Copyright (c) 2004-2006 Andre Nathan <andre@digirati.com.br>
+# Copyright (c) 2004-2009 Andre Nathan <andre@digirati.com.br>
 #
 # Permission to use, copy, modify, and distribute this software for any
 # purpose with or without fee is hereby granted, provided that the above
@@ -38,10 +38,13 @@
 #    user:     john
 #    password: secret
 #    auth:     PLAIN
+#    tls:      false
 #
 # The +port+ and +euser+ parameters can be ommited, and will respectively
 # default to 2000 and the value of the +user+ parameter. If the +auth+
-# parameter is ommited, it will default to +ANONYMOUS+.
+# parameter is ommited, it will default to +ANONYMOUS+. If the +tls+ parameter
+# is ommited, a TLS connection will be used if the server supports it.
+# Otherwise, a plain text connection will be used.
 #
 # == Usage and examples
 #
@@ -75,7 +78,7 @@
 #        sievectl myaccount del scriptname
 #
 #--
-# $Id: sievectl,v 1.27 2006/08/30 18:06:21 andre Exp $
+# $Id: sievectl,v 1.30 2009/01/13 21:29:52 andre Exp $
 #++
 #
 
@@ -87,13 +90,9 @@ require 'managesieve'
 
 $has_termios = true
 begin
-  require_gem 'termios'
+  require 'termios'
 rescue LoadError
-  begin
-    require 'termios'
-  rescue LoadError
-    $has_termios = false
-  end
+  $has_termios = false
 end
 
 require 'yaml'
@@ -129,14 +128,14 @@ class ConfigFile < File # :nodoc:
     begin
       conf = nil
       super(name) do |file|
-        conf = YAML::load(file)
+        conf = YAML.load(file)
       end
       conf.each_key do |acct|
-        conf[acct].each_key { |k| conf[acct][k] = conf[acct][k].to_s }
+        conf[acct].each_key { |k| conf[acct][k] = conf[acct][k] }
       end
       conf
     rescue Errno::ENOENT
-      ConfigFile::create_template(name)
+      ConfigFile.create_template(name)
       exit 0
     end
   end
@@ -146,7 +145,7 @@ class ConfigFile < File # :nodoc:
     STDERR.puts <<-__EOF__
 * Could not find configuration file #{name}.
 * A template file will be created. Please edit the values to fit your
-* local configuration and run `#{File::basename $0}' again.
+* local configuration and run `#{File.basename($0)}' again.
     __EOF__
 
     begin
@@ -159,6 +158,7 @@ accountname:
   euser:    effectiveusername
   password: password
   auth:     authmethod
+  tls:      true
       __EOF__
     rescue => e
       raise TemplateError, e
@@ -228,7 +228,7 @@ class SieveCtl
 end
 
 def usage(quit=true, out=STDERR) # :nodoc: #
-  prog = File.basename $0
+  prog = File.basename($0)
   out.puts <<-__EOF__
 Usage: #{prog} <account> <action> [script name]
 Action is one of:
@@ -240,7 +240,7 @@ You can also try `#{prog} help' for usage examples.
 end
 
 def help # :nodoc:
-  prog = File::basename $0
+  prog = File.basename($0)
   usage(false, STDOUT)
   puts <<-__EOF__
 
@@ -282,7 +282,7 @@ account, action, name, file = ARGV
 usage if action.nil?
 
 begin
-  conf = ConfigFile::open(ENV['HOME'] + '/.sievectlrc')
+  conf = ConfigFile.open(ENV['HOME'] + '/.sievectlrc')
 rescue TemplateError => e
   STDERR.puts "Cannot create template configuration file: #{e}"
   exit 1
@@ -319,14 +319,16 @@ end
 info['password'].chomp!
 
 begin
-  sievectl = SieveCtl.new(
+  config = {
     :host     => info['host'],
     :port     => info['port'] || 2000,
-    :user     => info['user'],
-    :euser    => info['euser'] || info['user'],
-    :password => info['password'],
+    :user     => info['user'].to_s,
+    :euser    => info['euser'].to_s || info['user'].to_s,
+    :password => info['password'].to_s,
     :auth     => info['auth']
-  )
+  }
+  config.merge!({:tls => info['tls']}) if info.has_key? 'tls'
+  sievectl = SieveCtl.new(config)
 rescue SieveNetworkError => e
   STDERR.puts "* #{e}"
   exit 1

data/lib/managesieve.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 #
 #--
-# Copyright (c) 2004-2006 Andre Nathan <andre@digirati.com.br>
+# Copyright (c) 2004-2009 Andre Nathan <andre@digirati.com.br>
 #
 # Permission to use, copy, modify, and distribute this software for any
 # purpose with or without fee is hereby granted, provided that the above
@@ -25,13 +25,18 @@
 # See the ManageSieve class for documentation and examples.
 #
 #--
-# $Id: managesieve.rb,v 1.13 2006/08/30 14:23:58 andre Exp $
+# $Id: managesieve.rb,v 1.14 2009/01/13 19:22:08 andre Exp $
 #++
 #
 
 require 'base64'
 require 'socket'
 
+begin
+  require 'openssl'
+rescue LoadError
+end
+
 #
 # Define our own Base64.encode64 for compatibility with ruby <= 1.8.1, which
 # defines encode64() at the top level.
@@ -104,7 +109,7 @@ class SieveResponseError < Exception; end
 class ManageSieve
   SIEVE_PORT = 2000
 
-  attr_reader :host, :port, :user, :euser, :capabilities, :login_mechs
+  attr_reader :host, :port, :user, :euser, :capabilities, :login_mechs, :tls
 
   # Create a new ManageSieve instance. The +info+ parameter is a hash with the
   # following keys:
@@ -115,6 +120,7 @@ class ManageSieve
   # [<i>:euser</i>]     the name of the effective user (defaults to +:user+)
   # [<i>:password</i>]  the password of the user
   # [<i>:auth_mech</i>] the authentication mechanism (defaults to +"ANONYMOUS"+)
+  # [<i>:tls</i>]       use TLS (defaults to use it if the server supports it)
   #
   def initialize(info)
     @host      = info[:host]
@@ -123,15 +129,25 @@ class ManageSieve
     @euser     = info[:euser] || @user
     @password  = info[:password]
     @auth_mech = info[:auth] || 'ANONYMOUS'
+    @tls       = info.has_key?(:tls) ? !!info[:tls] : nil
 
     @capabilities   = []
     @login_mechs    = []
     @implementation = ''
     @supports_tls   = false
-    @socket = TCPSocket.new(@host, @port)
+    @socket         = TCPSocket.new(@host, @port)
 
     data = get_response
     server_features(data)
+
+    if @tls and not supports_tls?
+      raise SieveNetworkError, 'Server does not support TLS'
+      @socket.close
+    elsif @tls != false
+      @tls = supports_tls?
+      starttls if @tls
+    end
+
     authenticate
     @password = nil
   end
@@ -261,7 +277,7 @@ class ManageSieve
   def send_command(cmd, args=nil, wait_response=true) # :nodoc:
     cmd += ' ' + args if args
     begin
-      @socket.send(cmd + "\r\n", 0)
+      @socket.write(cmd + "\r\n")
       resp = get_response if wait_response
     rescue SieveResponseError => e
       raise SieveCommandError, "Command error: #{e}"
@@ -326,4 +342,13 @@ class ManageSieve
     return "{#{string.length}+}\r\n#{string}"
   end
 
+  private
+  def starttls
+    send_command('STARTTLS')
+    @socket = OpenSSL::SSL::SSLSocket.new(@socket)
+    @socket.sync_close = true
+    @socket.connect
+    data = get_response
+    server_features(data)
+  end
 end

metadata

@@ -1,46 +1,53 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: ruby-managesieve
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2006-08-30 00:00:00 -03:00
-summary: A Ruby library for the MANAGESIEVE protocol
-require_paths: 
-- lib
-email: andre@digirati.com.br
-homepage: http://managesieve.rubyforge.org
-rubyforge_project: ruby-managesieve
-description: ruby-managesieve is a pure-ruby implementation of the MANAGESIEVE protocol, allowing remote management of Sieve scripts from ruby.
-autorequire: managesieve
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.4.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Andre Nathan
-files: 
-- lib/managesieve.rb
-test_files: []
-
-rdoc_options: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
-extra_rdoc_files: []
+date: 2009-01-13 00:00:00 -02:00
+default_executable: 
+dependencies: []
 
+description: ruby-managesieve is a pure-ruby implementation of the MANAGESIEVE protocol, allowing remote management of Sieve scripts from ruby.
+email: andre@digirati.com.br
 executables: 
 - sievectl
 extensions: []
 
+extra_rdoc_files: []
+
+files: 
+- lib/managesieve.rb
+has_rdoc: true
+homepage: http://managesieve.rubyforge.org
+post_install_message: 
+rdoc_options: []
+
+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: 
 - A network connection and a MANAGESIEVE server.
-dependencies: []
+rubyforge_project: ruby-managesieve
+rubygems_version: 1.3.0
+signing_key: 
+specification_version: 2
+summary: A Ruby library for the MANAGESIEVE protocol
+test_files: []