ruby-bugzilla 0.3.3 → 0.4.0

data/bin/bzconsole

@@ -1,4 +1,5 @@
 #! /usr/bin/env ruby
+# -*- coding: utf-8 -*-
 # bzconsole.rb
 # Copyright (C) 2010-2012 Red Hat, Inc.
 #
@@ -30,14 +31,18 @@ require 'uri'
 require 'highline/import'
 
 begin
-  require 'bugzilla'
+  require 'bugzilla/xmlrpc'
+  require 'bugzilla/user'
+  require 'bugzilla/plugin'
+  require 'bugzilla/bug'
 rescue LoadError
   $:.push(File.join(File.dirname(__FILE__), '..', 'lib'))
-  require 'bugzilla'
+  require 'bugzilla/xmlrpc'
+  require 'bugzilla/user'
+  require 'bugzilla/plugin'
+  require 'bugzilla/bug'
 end
 
-$KCODE = 'u'
-
 module BzConsole
 
   class CommandTemplate
@@ -210,8 +215,9 @@ module BzConsole
         login = info[:User].nil? ? ask("Bugzilla ID: ") : info[:User]
         pass = info[:Password].nil? ? ask("Bugzilla password: ") {|q| q.echo = false} : info[:Password]
         proxy_host, proxy_port = get_proxy(info)
+        timeout = opts[:timeout].nil? ? 60 : opts[:timeout]
 
-        xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port)
+        xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port, timeout)
         user = Bugzilla::User.new(xmlrpc)
         begin
           result = user.login({'login'=>login, 'password'=>pass, 'remember'=>true})
@@ -309,10 +315,11 @@ module BzConsole
         login = opts[:command][:anonymous] == true ? nil : info[:User]
         pass = opts[:command][:anonymous] == true ? nil : info[:Password]
         proxy_host, proxy_port = get_proxy(info)
+        timeout = opts[:timeout].nil? ? 60 : opts[:timeout]
 
         @plugin.run(:pre, host, :getbug, opts)
 
-        xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port)
+        xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port, timeout)
         user = Bugzilla::User.new(xmlrpc)
         user.session(login, pass) do
           bug = Bugzilla::Bug.new(xmlrpc)
@@ -422,10 +429,11 @@ module BzConsole
         login = opts[:command][:anonymous] == true ? nil : info[:User]
         pass = opts[:command][:anonymous] == true ? nil : info[:Password]
         proxy_host, proxy_port = get_proxy(info)
+        timeout = opts[:timeout].nil? ? 60 : opts[:timeout]
 
         @plugin.run(:pre, host, :search, opts[:command][:query])
 
-        xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port)
+        xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port, timeout)
         user = Bugzilla::User.new(xmlrpc)
         user.session(login, pass) do
           bug = Bugzilla::Bug.new(xmlrpc)
@@ -500,10 +508,11 @@ module BzConsole
         login = opts[:command][:anonymous] == true ? nil : info[:User]
         pass = opts[:command][:anonymous] == true ? nil : info[:Password]
         proxy_host, proxy_port = get_proxy(info)
+        timeout = opts[:timeout].nil? ? 60 : opts[:timeout]
 
         @plugin.run(:pre, host, :show, opts)
 
-        xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port)
+        xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port, timeout)
         user = Bugzilla::User.new(xmlrpc)
         user.session(login, pass) do
           if opts[:command][:show][:mode] == :field then
@@ -665,8 +674,9 @@ module BzConsole
         login = opts[:command][:anonymous] == true ? nil : info[:User]
         pass = opts[:command][:anonymous] == true ? nil : info[:Password]
         proxy_host, proxy_port = get_proxy(info)
+        timeout = opts[:timeout].nil? ? 60 : opts[:timeout]
 
-        xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port)
+        xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port, timeout)
         user = Bugzilla::User.new(xmlrpc)
         user.session(login, pass) do
           bug = Bugzilla::Bug.new(xmlrpc)
@@ -782,6 +792,89 @@ module BzConsole
 
   end # class Metrics
 
+  class Newbug < CommandTemplate
+
+    def initialize(plugin)
+      super
+
+      @n_args = 1
+    end # def initialize
+
+    def parse(parser, argv, opts)
+      opts[:newbug] = {}
+
+      parser.banner = sprintf("Usage: %s [global options] newbug [command options] <prefix>", File.basename(__FILE__))
+      parser.separator ""
+      parser.separator "Options:"
+      parser.on('-p', '--product=PRODUCT', 'The name of the product the bug is being filed against') {|v| opts[:newbug][:product] = v}
+      parser.on('-c', '--component=COMPONENT', 'The name of the component in PRODUCT') {|v| opts[:newbug][:component] = v}
+      parser.on('-s', '--summary=SUMMARY', 'A brief description of the bug being filed') {|v| opts[:newbug][:summary] = v}
+      parser.on('-v', '--version=VERSION', 'A version of PRODUCT that the bug was found in') {|v| opts[:newbug][:version] = v}
+      parser.on('-d', '--description=DESCRIPTION', 'The initial description for bug') {|v| opts[:newbug][:description] = v}
+      parser.on('--opsys=OPSYS', 'The operating system the bug was discovered on') {|v| opts[:newbug][:op_sys] = v}
+      parser.on('--platform=PLATFORM', 'What type of hardware the bug was experienced on') {|v| opts[:newbug][:platform] = v}
+      parser.on('--priority=PRIORITY', 'What order the bug will be fixed in by the developer') {|v| opts[:newbug][:priority] = v}
+      parser.on('--severity=SEVERITY', 'How severe the bug is') {|v| opts[:newbug][:severity] = v}
+      parser.on('--alias=ALIAS', 'A brief alias for the bug that can be used instead of a bug number') {|v| opts[:newbug][:alias] = v}
+      parser.on('--assigned_to=ASSGINEE', 'A user to assign the bug to') {|v| opts[:newbug][:assigned_to] = v}
+      parser.on('--comment_is_private', 'Make the description to private') {|v| opts[:newbug][:comment_is_private] = true}
+      parser.on('--groups=GROUPS', 'The list of group names to put this bug into') {|v| opts[:newbug][:groups] = v.split(/,/)}
+      parser.on('--qacontact=USER', 'The QA concact to assign the bug to') {|v| opts[:newbug][:qa_contact] = v}
+      parser.on('--status=STATUS', 'The status that the bug should start out as') {|v| opts[:newbug][:status] = v}
+      parser.on('--resolution=RESOLUTION', 'Set the resolution if filing a closed bug') {|v| opts[:newbug][:resolution] = v}
+      parser.on('--targetmilestone=MILESTONE', 'A valid target milestone for PRODUCT') {|v| opts[:newbug][:target_milestone] = v}
+
+      super
+    end # def parse
+
+    def do(argv, opts)
+      real_do(argv, opts) do |res|
+        if res.include?('id') then
+          printf("A bug has been filed as Bug#%s\n", res['id'])
+        else
+          p res
+        end
+      end
+    end # def do
+
+    private
+
+    def real_do(argv, opts)
+      conf = read_config(opts)
+      conf.freeze
+      # not supporting filing a bug to multiple bugzilla
+      prefix = argv[0]
+      unless conf.include?(prefix) then
+        raise RuntimeError, sprintf("No host information for %s", prefix)
+      end
+
+      info = conf[prefix]
+      uri = URI.parse(info[:URL])
+      host = uri.host
+      port = uri.port
+      path = uri.path.empty? ? nil : uri.path
+      login = opts[:command][:anonymous] == true ? nil : info[:User]
+      pass = opts[:command][:anonymous] == true ? nil : info[:Password]
+      proxy_host, proxy_port = get_proxy(info)
+      timeout = opts[:timeout].nil? ? 60 : opts[:timeout]
+
+      @plugin.run(:pre, host, :newbug, opts)
+
+      xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port, timeout)
+      user = Bugzilla::User.new(xmlrpc)
+      user.session(login, pass) do
+        bug = Bugzilla::Bug.new(xmlrpc)
+
+        result = bug.create(opts[:command][:newbug])
+
+        @plugin.run(:post, host, :newbug, result)
+
+        yield result
+      end
+    end # def real_do
+
+  end # class Newbug
+
 end # module BzConsole
 
 begin
@@ -794,16 +887,17 @@ begin
     opt.separator ""
     opt.separator "Global options:"
     opt.on('-c', '--config=FILE', 'read FILE as the configuration file.') {|v| opts[:config] = v}
+    opt.on('-t', '--timeout=SEC', 'Set XMLRPC timeout in a second.') {|v| opts[:timeout] = v.to_i}
     opt.on('-h', '--help', 'show this message') {|x| opts[:help] = true}
 
-    cmds = BzConsole.constants.sort.map {|x| (k = eval("BzConsole::#{x}")).class == Class && x != "CommandTemplate" ? x.downcase : nil}.compact
+    cmds = BzConsole.constants.sort.map {|x| (k = eval("BzConsole::#{x}")).class == Class && x != :CommandTemplate ? x.downcase : nil}.compact
 
     subargv = opt.order(ARGV);
 
     command = subargv[0]
 
     if subargv.length > 0 then
-      n = cmds.index(command)
+      n = cmds.index(command.to_sym)
       unless n.nil? then
         opts[:instance] = eval("BzConsole::#{cmds[n].capitalize}.new(Bugzilla::Plugin::Template.new)")
         subargv = opts[:instance].parse(opt, subargv[1..-1], opts[:command])

data/bin/bzconsole~

@@ -1,6 +1,6 @@
 #! /usr/bin/env ruby
 # bzconsole.rb
-# Copyright (C) 2010 Red Hat, Inc.
+# Copyright (C) 2010-2012 Red Hat, Inc.
 #
 # Authors:
 #   Akira TAGOH  <tagoh@redhat.com>
@@ -27,17 +27,17 @@ require 'rubygems'
 require 'pp'
 require 'gruff'
 require 'uri'
-
-
-$KCODE = 'u'
+require 'highline/import'
 
 begin
   require 'bugzilla'
 rescue LoadError
-  require File.join(File.dirname(__FILE__), "..", "lib", "bugzilla.rb")
-  $:.push(File.join(File.dirname(__FILE__), "..", "lib"))
+  $:.push(File.join(File.dirname(__FILE__), '..', 'lib'))
+  require 'bugzilla'
 end
 
+$KCODE = 'u'
+
 module BzConsole
 
   class CommandTemplate
@@ -61,6 +61,12 @@ module BzConsole
       parser.order(argv)
     end # def parse
 
+    def do(argv)
+      raise RuntimeError, sprintf("No implementation for %s", self.class)
+    end # def do
+
+    protected
+
     def read_config(opts)
       fname = opts[:config].nil? ? @defaultyamlfile : opts[:config]
       begin
@@ -69,16 +75,33 @@ module BzConsole
         conf = {}
       end
       conf.each do |k, v|
-        if v.include?(:Plugin) then
+        if v.kind_of?(Hash) && v.include?(:Plugin) then
           load(v[:Plugin])
         end
       end
       conf
     end # def read_config
 
-    def do(argv)
-      raise RuntimeError, sprintf("No implementation for %s", self.class)
-    end # def do
+    def save_config(opts, conf)
+      fname = opts[:config].nil? ? @defaultyamlfile : opts[:config]
+      if File.exist?(fname) then
+        st = File.lstat(fname)
+        if st.mode & 0600 != 0600 then
+          raise RuntimeError, sprintf("The permissions of %s has to be 0600", fname)
+        end
+      end
+      File.open(fname, "w") {|f| f.chmod(0600); f.write(conf.to_yaml)}
+    end # def save_config
+
+    private
+
+    def get_proxy(info)
+      uri = info[:Proxy] || ENV["http_proxy"]
+      proxy_uri = uri.nil? ? nil : URI.parse(uri)
+      proxy_host = proxy_uri.nil? ? nil : proxy_uri.host
+      proxy_port = proxy_uri.nil? ? nil : proxy_uri.port
+      return proxy_host, proxy_port
+    end
 
   end # class CommandTemplate
 
@@ -149,6 +172,60 @@ module BzConsole
 
   end # class Setup
 
+  class Login < CommandTemplate
+
+    def initialize(plugin)
+      super
+
+      @n_args = 1
+    end # def initialize
+
+    def parse(parser, argv, opts)
+      opts[:output] = File.join(ENV['HOME'], '.ruby-bugzilla-cookie.yml')
+      parser.banner = sprintf("Usage: %s [global options] login [command options] <prefix> ...", File.basename(__FILE__))
+      parser.separator ""
+      parser.separator "Command options:"
+      parser.on('-o', '--output=FILE', 'FILE to store the cookie') {|v| opts[:output] = v}
+
+      super
+    end # def parse
+
+    def do(argv, opts)
+      conf = read_config(opts)
+      conf.freeze
+      cconf = read_config({:config=>opts[:command][:output]})
+      argv.each do |prefix|
+        if prefix.nil? then
+          raise ArgumentError, "No prefix to log in"
+        end
+        unless conf.include?(prefix) then
+          raise RuntimeError, sprintf("No host information for %s", prefix)
+        end
+
+        info = conf[prefix]
+        uri = URI.parse(info[:URL])
+        host = uri.host
+        port = uri.port
+        path = uri.path.empty? ? nil : uri.path
+        login = info[:User].nil? ? ask("Bugzilla ID: ") : info[:User]
+        pass = info[:Password].nil? ? ask("Bugzilla password: ") {|q| q.echo = false} : info[:Password]
+        proxy_host, proxy_port = get_proxy(info)
+        timeout = opts[:timeout].nil? ? 60 : opts[:timeout]
+
+        xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port, timeout)
+        user = Bugzilla::User.new(xmlrpc)
+        begin
+          result = user.login({'login'=>login, 'password'=>pass, 'remember'=>true})
+          cconf[host] = xmlrpc.cookie
+          save_config({:config=>opts[:command][:output]}, cconf)
+        rescue XMLRPC::FaultException => e
+          printf("E: %s\n", e.message)
+        end
+      end
+    end # def do
+
+   end # class Login
+
   class Getbug < CommandTemplate
 
     def initialize(plugin)
@@ -232,10 +309,12 @@ module BzConsole
         path = uri.path.empty? ? nil : uri.path
         login = opts[:command][:anonymous] == true ? nil : info[:User]
         pass = opts[:command][:anonymous] == true ? nil : info[:Password]
+        proxy_host, proxy_port = get_proxy(info)
+        timeout = opts[:timeout].nil? ? 60 : opts[:timeout]
 
         @plugin.run(:pre, host, :getbug, opts)
 
-        xmlrpc = Bugzilla::XMLRPC.new(host, port, path)
+        xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port, timeout)
         user = Bugzilla::User.new(xmlrpc)
         user.session(login, pass) do
           bug = Bugzilla::Bug.new(xmlrpc)
@@ -344,10 +423,12 @@ module BzConsole
         path = uri.path.empty? ? nil : uri.path
         login = opts[:command][:anonymous] == true ? nil : info[:User]
         pass = opts[:command][:anonymous] == true ? nil : info[:Password]
+        proxy_host, proxy_port = get_proxy(info)
+        timeout = opts[:timeout].nil? ? 60 : opts[:timeout]
 
         @plugin.run(:pre, host, :search, opts[:command][:query])
 
-        xmlrpc = Bugzilla::XMLRPC.new(host, port, path)
+        xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port, timeout)
         user = Bugzilla::User.new(xmlrpc)
         user.session(login, pass) do
           bug = Bugzilla::Bug.new(xmlrpc)
@@ -421,10 +502,12 @@ module BzConsole
         path = uri.path.empty? ? nil : uri.path
         login = opts[:command][:anonymous] == true ? nil : info[:User]
         pass = opts[:command][:anonymous] == true ? nil : info[:Password]
+        proxy_host, proxy_port = get_proxy(info)
+        timeout = opts[:timeout].nil? ? 60 : opts[:timeout]
 
         @plugin.run(:pre, host, :show, opts)
 
-        xmlrpc = Bugzilla::XMLRPC.new(host, port, path)
+        xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port, timeout)
         user = Bugzilla::User.new(xmlrpc)
         user.session(login, pass) do
           if opts[:command][:show][:mode] == :field then
@@ -585,8 +668,10 @@ module BzConsole
         path = uri.path.empty? ? nil : uri.path
         login = opts[:command][:anonymous] == true ? nil : info[:User]
         pass = opts[:command][:anonymous] == true ? nil : info[:Password]
+        proxy_host, proxy_port = get_proxy(info)
+        timeout = opts[:timeout].nil? ? 60 : opts[:timeout]
 
-        xmlrpc = Bugzilla::XMLRPC.new(host, port, path)
+        xmlrpc = Bugzilla::XMLRPC.new(host, port, path, proxy_host, proxy_port, timeout)
         user = Bugzilla::User.new(xmlrpc)
         user.session(login, pass) do
           bug = Bugzilla::Bug.new(xmlrpc)
@@ -714,6 +799,7 @@ begin
     opt.separator ""
     opt.separator "Global options:"
     opt.on('-c', '--config=FILE', 'read FILE as the configuration file.') {|v| opts[:config] = v}
+    opt.on('-t', '--timeout=SEC', 'Set XMLRPC timeout in a second.') {|v| opts[:timeout] = v.to_i}
     opt.on('-h', '--help', 'show this message') {|x| opts[:help] = true}
 
     cmds = BzConsole.constants.sort.map {|x| (k = eval("BzConsole::#{x}")).class == Class && x != "CommandTemplate" ? x.downcase : nil}.compact

data/lib/bugzilla/api_tmpl.rb

@@ -0,0 +1,52 @@
+# api_tmpl.rb
+# Copyright (C) 2010-2012 Red Hat, Inc.
+#
+# Authors:
+#   Akira TAGOH  <tagoh@redhat.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330,
+# Boston, MA 02111-1307, USA.
+
+require 'bugzilla/skeleton'
+require 'bugzilla/bugzilla'
+
+
+module Bugzilla
+
+=begin rdoc
+
+=== Bugzilla::APITemplate
+
+=end
+
+  class APITemplate < Skeleton
+
+    def initialize(iface)
+      super
+
+      @bz = Bugzilla.new(iface)
+    end # def initialize
+
+    def method_missing(symbol, *args)
+      if @bz.respond_to?(symbol) then
+        @bz.__send__(symbol, *args)
+      else
+        super
+      end
+    end # def method_missing
+
+  end # class APITemplate
+
+end # module Bugzilla