reap 9.3.5 → 9.4.0

data/lib/reap/defaults.rb

@@ -0,0 +1,49 @@
+module Reap
+
+  class Project
+
+    # = Project Settings Defaults
+    #
+    # Provides an inteface to default values for Settings.
+    # The default values are loaded from a .yaml file.
+
+    class Defaults < Hash
+
+      DEFAULT_FILE = File.join(File.dirname(__FILE__), 'default.yaml')
+
+      attr :metadata
+
+      # FIXME: when using the settings, I think nil should be considered a none entry and
+      # so false would be required to actually mean "off". This means assigning each key value par one a time?
+
+      def initialize(metadata)
+        super()
+        @metadata = metadata
+        defaults = File.read(DEFAULT_FILE)
+        defaults = instance_eval("<<-XXXXXXXXXXXXX\n#{defaults}\nXXXXXXXXXXXXX")
+        defaults = YAML::load(defaults)
+        #settings = defaults.dup
+        #data.each do |key, value|
+        #  settings[key] ||= {}
+        #  settings[key].update(value) if value
+        #end
+        update(defaults)
+      end
+
+      # open hash
+
+      def method_missing(s, *a)
+        if s =~ /=$/
+          self[s] = a[0]
+        elsif a.empty?
+          self[s]
+        else
+          super
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/reap/emailer.rb

@@ -0,0 +1,189 @@
+require 'facets/openhash'
+
+module Reap
+
+  # 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
+    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 self.load_with_environment(options, defaults={})
+      options  = options.rekey
+      defaults = defaults.rekey
+      environ  = environment_options
+
+      options[:server]   ||= environ[:server]
+      options[:from]     ||= environ[:from]
+      options[:account]  ||= environ[:account]
+      options[:password] ||= environ[:password]
+      options[:port]     ||= environ[:port]
+      options[:domain]   ||= environ[:domain]
+      options[:login]    ||= environ[:login]
+      options[:secure]   ||= environ[:secure]
+
+      options[:server]   ||= defaults[:server]
+      options[:from]     ||= defaults[:from]
+      options[:account]  ||= defaults[:account] || defaults[:from]
+      options[:port]     ||= defaults[:port].to_i
+      options[:domain]   ||= defaults[:domain]
+      options[:login]    ||= defaults[:login]
+      options[:secure]   ||= defaults[:secure].to_b
+
+      new(options)
+    end
+
+    def self.environment_options
+      options = {}
+
+      options[:server]   ||= ENV['EMAIL_SERVER']
+      options[:from]     ||= ENV['EMAIL_FROM']
+      options[:account]  ||= ENV['EMAIL_ACCOUNT'] || options[:from]
+      options[:password] ||= ENV['EMAIL_PASSWORD']
+      options[:port]     ||= ENV['EMAIL_PORT'].to_i
+      options[:domain]   ||= ENV['EMAIL_DOMAIN']
+      options[:login]    ||= ENV['EMAIL_LOGIN']
+      options[:secure]   ||= ENV['EMAIL_SECURE'].to_b
+
+      options
+    end
+
+    #
+
+    def initialize(options)
+      options = options.to_ostruct
+
+      @server    = options.server
+      @account   = options.account  || options.from
+      @passwd    = options.password || self.class.password
+      @login     = options.login
+      @secure    = options.secure
+      @domain    = options.domain || options.server
+
+      @from      = options.from
+      @subject   = options.subject
+      @mailto    = options.mailto || options.to
+      @message   = options.message
+
+      if options.port
+        @port = options.port
+      else
+        @port = secure ? 465 : 25
+      end
+
+      @account ||= @from
+
+      @login   ||= :plain
+      @login = @login.to_sym
+
+      # save the password for later use
+      self.class.password = @password
+    end
+
+    #
+
+    def email(options={})
+      options.rekey
+
+      message = options[:message] || message()
+      subject = options[:subject] || subject()
+      from    = options[:from]    || from()
+      mailto  = options[:mailto]  || options[:to] || 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
+
+      if secure
+        Net::SMTP.send(:include, Net::SMTP::TLS)
+        Net::SMTP.enable_tls #if secure #if Net::SMTP.respond_to?(:enable_tls) and secure
+      end
+
+      begin
+        Net::SMTP.start(server, port, domain, account, passwd, login, secure) do |smtp|
+          smtp.send_message(msg, from, mailto)
+        end
+        puts "Email sent successfully to #{mailto.join(';')}."
+        true
+      rescue Exception => e
+        if $DEBUG
+          raise e
+        else
+          abort "Email delivery failed with #{e}"
+        end
+      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
+

data/lib/reap/extensions.rb

@@ -1,5 +1,4 @@
-require 'facets/dir/multiglob'
-require 'facets/file/write'
+require 'facets'
 
 require 'reap/extensions/array'
 require 'reap/extensions/hash'

data/lib/reap/hosts.rb

@@ -0,0 +1,4 @@
+require 'reap/hosts/mailinglist'
+require 'reap/hosts/rubyforge'
+require 'reap/hosts/rubytalk'
+

data/lib/reap/hosts/host.rb

@@ -0,0 +1,69 @@
+require 'reap/tool'
+
+module Reap
+module Hosts
+
+  def self.registry
+    @registry ||= {}
+  end
+
+  # = Host
+  #
+  # Base class for Hosts.
+
+  class Host < Tool
+
+    def self.registry
+      Hosts.registry
+    end
+
+    def self.register(*uris)
+      uris.each do |uri|
+        registry[uri] = self
+      end
+    end
+
+    def self.inherited(base)
+      scm = base.basename.downcase
+      registry[scm] = base
+    end
+
+    def self.factory(name)
+      registry[name]
+    end
+
+    # Generic announce confirmation.
+
+    def announce_confirm?(options={})
+      return true if force?
+      ans = ask("Announce to #{self.class.basename.downcase}?", "yN")
+      case ans.downcase
+      when 'y', 'yes'
+        true
+      else
+        false
+      end
+    end
+
+    # Generic announce confirmation.
+
+    def release_confirm?(options={})
+      return true if force?
+      ans = ask("Release to #{self.class.basename.downcase}?", "yN")
+      case ans.downcase
+      when 'y', 'yes'
+        true
+      else
+        false
+      end
+    end
+
+    def inspect
+      "<#{self.class}>"
+    end
+
+  end
+
+end
+end
+

data/lib/reap/hosts/mailinglist.rb

@@ -0,0 +1,83 @@
+require 'reap/hosts/host'
+require 'reap/emailer'
+
+module Reap
+module Hosts
+
+  # = Mailinglist
+  #
+  # Gerneic Mailing list "host". Mailinglist hosts
+  # support the @announce@ task.
+
+  class Mailinglist < Host
+
+    register('mailinglist')
+
+    # Email message. Options are:
+    #
+    #   message     Message to send.
+    #   mailto      Email address to whom to mail.
+    #   from        Email address from whom.
+    #   subject     Subject line (default is "ANN: project version").
+    #   server      Email server
+    #   port        Emails server port (default is usually correct).
+    #   account     Email account name (defaults to from).
+    #   domain      User domain (not sure why SMTP requires this?)
+    #   login       Login type (plain, login)
+    #   secure      Use TLS/SSL true or false?
+
+    def announce(options)
+      options = announce_options(options)
+
+      subject = options[:subject]
+      mailto  = options[:mailto] || options[:to]
+      to      = [mailto].flatten.join(", ")
+
+      if dryrun?
+        puts "email '#{subject}' to #{to}"
+      else
+        emailer = Emailer.new(options)
+        emailer.email
+      end
+    end
+
+    # Confirm announcement
+
+    def announce_confirm?(options)
+      options = announce_options(options)
+
+      if mailto = options[:mailto] || options[:to]
+        return true if force?
+        to  = [mailto].flatten.join(", ")
+        ans = ask("Announce to #{to}?", "yN")
+        case ans.downcase
+        when 'y', 'yes'
+          true
+        else
+          false
+        end
+      end
+    end
+
+    #
+
+    def announce_options(options)
+      options  = options.rekey
+      environ  = Emailer.environment_options
+      defaults = project.defaults['email'].rekey
+
+      result = {}
+      result.update(defaults)
+      result.update(environ)
+      result.update(options)
+
+      result[:subject] = (result[:subject] % [metadata.unixname, metadata.version])
+
+      result
+    end
+
+  end
+
+end
+end
+

data/lib/reap/{systems → hosts}/rubyforge.rb

@@ -6,28 +6,35 @@ require 'ostruct'
 require 'httpclient'
 require 'tmpdir'
 
-require 'facets/hash/rekey'
+require 'facets' #/hash/rekey'
 require 'facets/kernel/ask'
 
+require 'reap/hosts/host'
+
 module Reap
+module Hosts
 
+  # = Rubyforge
+  #
   # Interface with the RubyForge hosting service.
-  # Currently supports functions:
+  # Supports the following tasks:
   #
-  #  * release  - Upload release packages.
-  #  * publish  - Upload website files.
-  #  * announce - Post news announcement.
-  #  * touch    - Test connection.
+  # * release  - Upload release packages.
+  # * announce - Post news announcement.
+  # * touch    - Test connection.
+  #
+  # TODO: Handle publish tasks to upload website files (currently this is handled separately)
 
-  class Rubyforge
+  class Rubyforge < Host
+    #include FileUtils
 
-    include FileUtils
+    register('rubyforge', 'rubyforge.org')
 
     #HOME    = ENV["HOME"] || ENV["HOMEPATH"] || File.expand_path("~")
 
+    DOMAIN     = "rubyforge.org"
     COOKIEJAR  = File::join(Dir.tmpdir, 'reap', 'cookie.dat')
-
-    REPORT = /<h\d><span style="color:red">(.*?)<\/span><\/h\d>/
+    REPORT     = /<h\d><span style="color:red">(.*?)<\/span><\/h\d>/
 
     # URI = http:// + domain name
     # TODO Deal with https, and possible other protocols too.
@@ -37,53 +44,42 @@ module Reap
     # for use even if they arn't used.
     attr :username
     attr :password
+    attr :domain
 
-    # Domain name of host. Must be overriden by adapter.
-    def domain
-      raise "Missing Domain"
-    end
-
-    # New RubyForge tasks.
-    def initialize(options)
-      options = options.dup.rekey
+    # New RubyForge object.
+    #
+    def initialize(project, options={})
+      options = options.rekey
 
-      @dryrun  = options[:dryrun]
-      @trace   = options[:trace]
+      super(project, options)
 
-      #@domain   = options[:domain] || default_domain
-      @uri   = URI.parse("http://" + domain)
+      @domain   = options[:domain] || DOMAIN
+      @uri      = URI.parse("http://" + domain)
 
       @username = options[:username] || ENV['RUBYFORGE_USERNAME']
-      @password = options[:password]
+      @password = options[:password] || ENV['RUBYFORGE_PASSWORD']
+      @unixname = options[:project]  || project.metadata.unixname
+      @version  = project.metadata.version
 
-      mkdir_p(File.dirname(COOKIEJAR))
-      @cookie_jar = COOKIEJAR
-
-      @project  = options[:project]
-      @group_id = options[:group_id] || options[:groupid]
+      @group_id = options[:group] || options[:group_id] || options[:groupid]
 
       @package_ids = {}
       @release_ids = {}
-      @file_ids = {}
+      @file_ids    = {}
 
-      load_project
-    end
+      project.mkdir_p(File.dirname(COOKIEJAR))
 
-    def dryrun?
-      @dryrun
+      #load_project
     end
 
-    def trace?
-      @trace
+    #
+
+    def cookie_jar
+      COOKIEJAR
     end
 
     public
 
-    #
-    def domain
-      "rubyforge.org"
-    end
-
     # Website location on server.
     def siteroot
       "/var/www/gforge-projects"
@@ -95,8 +91,11 @@ module Reap
       %w{ touch release publish post }
     end
 
+    # Project unixname.
+    attr_accessor :unixname
+
     # Project name.
-    attr_accessor :project
+    attr_accessor :version
 
     # Project's group id number.
     attr_accessor :group_id
@@ -107,6 +106,8 @@ module Reap
     # Login to website.
 
     def login # :yield:
+      load_project_cached
+
       page = @uri + "/account/login.php"
       page.scheme = 'https'
       page = URI.parse(page.to_s) # set SSL port correctly
@@ -119,12 +120,14 @@ module Reap
       }
       html = http_post(page, form)
 
-      unless html[/Personal Page/]
+      if not html[/Personal Page/]
         puts "Login failed."
         re1 = Regexp.escape(%{<h2 style="color:red">})
         re2 = Regexp.escape(%{</h2>})
         html[/#{re1}(.*?)#{re2}/]
         raise $1
+      else
+        @printed_project_name ||= (puts "Project: #{unixname}"; true)
       end
 
       if block_given?
@@ -164,7 +167,7 @@ module Reap
     #     files          package files to release.
     #     exclude        Package formats to exclude from files.
     #                    (from those created by pack)
-    #     project        Project name on host.
+    #     unixname       Project name on host.
     #     package        Package to which this release belongs (defaults to project)
     #     release        Release name (default is version number)
     #     version        Version of release
@@ -190,9 +193,9 @@ module Reap
       changelog = options[:changelog]
       notelog   = options[:notelog]
 
-      project   = options[:project]   || @project
-      package   = options[:package]   || project
-      release   = options[:release]   || version
+      unixname  = options[:unixname]  || unixname()
+      package   = options[:package]   || unixname()
+      release   = options[:release]   || version()
       name      = options[:name]      || package
       files     = options[:file]      || []
       date      = options[:date]      || Time::now.strftime('%Y-%m-%d %H:%M')
@@ -201,8 +204,7 @@ module Reap
 
       is_public = options[:is_public].nil? ? true : options[:is_public]
 
-      raise ArgumentError, "missing group_id" unless group_id
-      raise ArgumentError, "missing project"  unless project
+      raise ArgumentError, "missing unixname" unless unixname
       raise ArgumentError, "missing package"  unless package
       raise ArgumentError, "missing release"  unless release
 
@@ -232,6 +234,8 @@ module Reap
 
       login do
 
+        raise ArgumentError, "missing group_id" unless group_id
+
         unless package_id = package?(package)
           if dryrun?
             puts "Package '#{package}' does not exist."
@@ -311,7 +315,7 @@ module Reap
 #       options = options.rekey
 #
 #       #domain = options[:domain] || DOMAIN
-#       root   = File.join(siteroot, project)
+#       root   = File.join(siteroot, unixname)
 #       root   = File.join(root, options[:root]) if options[:root]
 #
 #       options.update(
@@ -324,7 +328,7 @@ module Reap
 
     # Submit a news item.
 
-    def post(options)
+    def announce(options)
       options = options.rekey
 
       if file = options[:file]
@@ -338,8 +342,7 @@ module Reap
       end
 
       if dryrun?
-        puts "\nSUBJECT: #{subject}"
-        puts "\n#{message}\n\n"
+        puts "announce-rubyforge: #{subject}"
       else
         post_news(subject, message)
         puts "News item posted!"
@@ -353,8 +356,8 @@ module Reap
 
     def http_post(page, form, extheader={})
       client = HTTPClient::new ENV["HTTP_PROXY"]
-      client.debug_dev = STDERR if ENV["ICLI_DEBUG"] || ENV["DEBUG"] || $DEBUG
-      client.set_cookie_store(@cookie_jar)
+      client.debug_dev = STDERR if ENV["REAP_DEBUG"] || $DEBUG
+      client.set_cookie_store(cookie_jar)
       client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
 
       # HACK to fix http-client redirect bug/feature
@@ -382,12 +385,16 @@ module Reap
       return response
     end
 
+    #
+
+    def load_project_cached
+      @load_project_cache ||= load_project
+    end
+
     # Loads information for project: group_id, package_ids and release_ids.
 
     def load_project
-      puts "Project: #{project}"
-
-      html = URI.parse("http://#{domain}/projects/#{project}/index.html").read
+      html = URI.parse("http://#{domain}/projects/#{unixname}/index.html").read
 
       group_id = html[/(frs|tracker)\/\?group_id=\d+/][/\d+/].to_i
       @group_id = group_id
@@ -445,7 +452,7 @@ module Reap
       restr = ''
       restr << Regexp.escape( package_name )
       restr << '\s*'
-      restr << Regexp.escape( %{<a href="/frs/monitor.php?filemodule_id=} )
+      restr << Regexp.escape( '<a href="/frs/monitor.php?filemodule_id=' )
       restr << '(\d+)'
       restr << Regexp.escape( %{&group_id=#{group_id}} )
       re = Regexp.new( restr )
@@ -606,7 +613,7 @@ module Reap
       restr = ''
       #restr << Regexp.escape( package )
       #restr << '\s*'
-      restr << Regexp.escape( %{<a href="/frs/download.php/} )
+      restr << Regexp.escape( '<a href="/frs/download.php/' )
       restr << '(\d+)'
       restr << Regexp.escape( %{/#{file}} )
       re = Regexp.new(restr)
@@ -672,6 +679,8 @@ module Reap
     def post_news(subject, body)
       page = "/news/submit.php"
 
+      subject % [unixname, version]
+
       form = {
         "group_id"     => group_id,
         "post_changes" => "y",
@@ -680,7 +689,9 @@ module Reap
         "submit"       => "Submit"
       }
 
-      http_post(page, form)
+      login do
+        http_post(page, form)
+      end
     end
 
     # Constant for file types accepted by Rubyforge
@@ -745,4 +756,5 @@ module Reap
   end
 
 end
+end