bugzilla 0.10.0

data/lib/bugzilla/bugzilla.rb

@@ -0,0 +1,149 @@
+# bugzilla.rb
+# Copyright (C) 2010-2014 Red Hat, Inc.
+#
+# Authors:
+#   Akira TAGOH  <tagoh@redhat.com>
+#
+# This library is free software: you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# This library 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, see <http://www.gnu.org/licenses/>.
+
+require 'bugzilla/skeleton'
+
+module Bugzilla
+  # rdoc
+  #
+  # === Bugzilla::Bugzilla
+  #
+  # Bugzilla::Bugzilla class is to access the
+  # Bugzilla::WebService::Bugzilla API that provides functions
+  # tell you about Bugzilla in general.
+  #
+
+  class Bugzilla < Skeleton
+    # rdoc
+    #
+    # ==== Bugzilla::Bugzilla#check_version(version_)
+    #
+    # Returns Array contains the result of the version check and
+    # Bugzilla version that is running on.
+    #
+
+    def check_version(version_)
+      v = version
+      f = false
+      if v.is_a?(Hash) && v.include?('version') &&
+         Gem::Version.new(v['version']) >= Gem::Version.new(version_.to_s)
+        f = true
+      end
+
+      [f, v['version']]
+    end # def check_version
+
+    # rdoc
+    #
+    # ==== Bugzilla::Bugzilla#requires_version(cmd, version_)
+    #
+    # Raise an exception if the Bugzilla doesn't satisfy
+    # the requirement of the _version_.
+    #
+
+    def requires_version(cmd, version_)
+      v = check_version(version_)
+      raise NoMethodError, format('%s is not supported in Bugzilla %s', cmd, v[1]) unless v[0]
+    end # def requires_version
+
+    # rdoc
+    #
+    # ==== Bugzilla::Bugzilla#version
+    #
+    # Raw Bugzilla API to obtain the Bugzilla version.
+    #
+    # See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bugzilla.html
+    #
+
+    # rdoc
+    #
+    # ==== Bugzilla::Bugzilla#extensions
+    #
+    # Raw Bugzilla API to obtain the information about
+    # the extensions that are currently installed and enabled in
+    # the Bugzilla.
+    #
+    # See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bugzilla.html
+    #
+
+    # rdoc
+    #
+    # ==== Bugzilla::Bugzilla#timezone
+    #
+    # Raw Bugzilla API to obtain the timezone that Bugzilla
+    # expects dates and times in.
+    #
+    # See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bugzilla.html
+    #
+
+    # rdoc
+    #
+    # ==== Bugzilla::Bugzilla#time
+    #
+    # Raw Bugzilla API to obtain the information about what time
+    # the bugzilla server thinks it is, and what timezone it's
+    # running on.
+    #
+    # See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bugzilla.html
+    #
+
+    # rdoc
+    #
+    # ==== Bugzilla::Bugzilla#parameters
+    #
+    # Raw Bugzilla API to obtain parameter values currently used in Bugzilla.
+    #
+    # See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bugzilla.html
+    #
+
+    protected
+
+    def _version(cmd, *_args)
+      @iface.call(cmd)
+    end # def _version
+
+    def _extensions(cmd, *_args)
+      requires_version(cmd, 3.2)
+
+      @iface.call(cmd)
+    end # def _extensions
+
+    def _timezone(cmd, *_args)
+      @iface.call(cmd)
+    end # def _timezone
+
+    def _time(cmd, *_args)
+      requires_version(cmd, 3.4)
+
+      @iface.call(cmd)
+    end # def _time
+
+    def _parameters(cmd, *_args)
+      requires_version(cmd, 4.4)
+
+      @iface.call(cmd)
+    end # def _parameters
+
+    def __last_audit_time(cmd, *_args)
+      requires_version(cmd, 4.4)
+
+      # FIXME
+    end # def _last_audit_time
+  end # class Bugzilla
+end # module Bugzilla

data/lib/bugzilla/classification.rb

@@ -0,0 +1,74 @@
+# classification.rb
+# Copyright (C) 2010-2012 Red Hat, Inc.
+#
+# Authors:
+#   Akira TAGOH  <tagoh@redhat.com>
+#
+# This library is free software: you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# This library 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, see <http://www.gnu.org/licenses/>.
+
+require 'bugzilla/api_template'
+
+module Bugzilla
+
+=begin rdoc
+
+=== Bugzilla::Classification
+
+Bugzilla::Classification class is to access
+the Bugzilla::WebService::Classification API that allows you
+to deal with the available Classifications.
+
+=end
+
+  class Classification < APITemplate
+
+=begin rdoc
+
+==== Bugzilla::Classification#get(params)
+
+Raw Bugzilla API to obtain the information about a set of
+classifications.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Classification.html
+
+=end
+
+    protected
+
+    def _get(cmd, args)
+      requires_version(cmd, 4.4)
+
+      params = {}
+      # TODO
+      # this whole block looks confuse
+      case ids
+      when Hash
+        raise ArgumentError, sprintf("Invalid parameter: %s", ids.inspect) unless ids.include?('ids') || ids.include?('names')
+        params[:ids] = ids['ids'] || ids['names']
+      when Array
+        r = ids.map {|x| x.kind_of?(Integer) ? x : nil}.compact
+        if r.length != ids.length
+          params[:names] = ids
+        else
+          params[:ids] = ids
+        end
+      when Integer # XXX: different than others, we dont support String here?
+          params[:ids] = [ids]
+      else
+        params[:names] = [ids]
+      end
+      @iface.call(cmd, params)
+    end # def _get
+  end # class Classification
+end # module Bugzilla

data/lib/bugzilla/group.rb

@@ -0,0 +1,43 @@
+# group.rb
+# Copyright (C) 2010-2012 Red Hat, Inc.
+#
+# Authors:
+#   Akira TAGOH  <tagoh@redhat.com>
+#
+# This library is free software: you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# This library 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, see <http://www.gnu.org/licenses/>.
+
+require 'bugzilla/api_template'
+
+module Bugzilla
+  # rdoc
+  #
+  # === Bugzilla::Group
+  #
+  # Bugzilla::Group class is to access
+  # the Bugzilla::WebService::Group API that allows you to
+  # create Groups and get information about them.
+  #
+
+  class Group < APITemplate
+    protected
+
+    def __create(cmd, *args)
+      # FIXME
+    end # def _create
+
+    def __update(cmd, *args)
+      # FIXME
+    end # def _update
+  end # class Group
+end # module Bugzilla

data/lib/bugzilla/plugin.rb

@@ -0,0 +1,67 @@
+# plugin.rb
+# Copyright (C) 2010-2012 Red Hat, Inc.
+#
+# Authors:
+#   Akira TAGOH  <tagoh@redhat.com>
+#
+# This library is free software: you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# This library 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, see <http://www.gnu.org/licenses/>.
+
+module Bugzilla
+  # rdoc
+  #
+  # === Bugzilla::Plugin
+  #
+
+  module Plugin
+    # rdoc
+    #
+    # ==== Bugzilla::Plugin::Template
+    #
+
+    class Template
+      @@plugins = []
+
+      def initialize
+        @hostname = nil
+      end # def initialize
+
+      attr_reader :hostname
+
+      def self.inherited(subclass)
+        @@plugins << subclass
+      end # def inherited
+
+      def run(hook, host, *args)
+        @@plugins.each do |k|
+          i = k.new
+          next unless i.hostname == host || host.nil?
+          case hook
+          when :parser
+            i.parserhook(*args)
+          when :pre
+            i.prehook(*args)
+          when :post
+            i.posthook(*args)
+          end
+        end
+      end # def run
+
+      def parserhook(parser, argv, opts); end # def parserhook
+
+      def prehook(cmd, opts); end # def prehook
+
+      def posthook(cmd, opts); end # def posthook
+    end # class Template
+  end # module Plugin
+end # module Bugzilla

data/lib/bugzilla/plugins/nvbugzilla.rb

@@ -0,0 +1,49 @@
+# nvbugzilla.rb
+# Copyright (C) 2014 Novell, Inc.
+#
+# Authors:
+#  Victor Pereira  <vpereira@suse.com>
+#
+# This library is free software: you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# This library 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, see <http://www.gnu.org/licenses/>.
+
+require 'rubygems'
+
+# begin
+#  gem 'ruby-bugzilla'
+# rescue Gem::LoadError
+#  require File.join(File.dirname(__FILE__), "..", "bugzilla.rb")
+# end
+
+module Bugzilla
+  module Plugin
+    class Novell < ::Bugzilla::Plugin::Template
+      def initialize
+        super
+        @hostname = 'bugzilla.novell.com'
+      end # def initialize
+
+      def parserhook(*args)
+        super
+      end # def parserhook
+
+      def prehook(*args)
+        super
+      end # def prehook
+
+      def posthook(*args)
+        super
+      end # def posthook
+    end # class Novell
+  end # module Plugin
+end # module Bugzilla

data/lib/bugzilla/plugins/rhbugzilla.rb

@@ -0,0 +1,210 @@
+# rhbugzilla.rb
+# Copyright (C) 2010-2012 Red Hat, Inc.
+#
+# Authors:
+#   Akira TAGOH  <tagoh@redhat.com>
+#
+# This library is free software: you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# This library 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, see <http://www.gnu.org/licenses/>.
+
+require 'rubygems'
+
+# begin
+#  gem 'ruby-bugzilla'
+# rescue Gem::LoadError
+#  require File.join(File.dirname(__FILE__), "..", "bugzilla.rb")
+# end
+
+module Bugzilla
+  module Plugin
+    class RedHat < ::Bugzilla::Plugin::Template
+      def initialize
+        super
+
+        @hostname = 'bugzilla.redhat.com'
+      end # def initialize
+
+      def parserhook(*args)
+        parser, argv, opts, *etc = args
+        parser.separator ''
+        parser.separator 'RH Bugzilla specific options:'
+        parser.on('--cc=EMAILS', 'filter out the result by Cc in bugs') { |v| opts[:query][:cc] ||= []; opts[:query][:cc].push(*v.split(',')) }
+        parser.on('--filterversion=VERSION', 'filter out the result by the version in bugs') { |v| opts[:query][:version] ||= []; opts[:query][:version].push(*v.split(',')) }
+      end # def parserhook
+
+      def prehook(*args)
+        cmd, opts, *etc = args
+        case cmd
+        when :search
+          # This parameter is Red Hat Extension
+          # See https://bugzilla.redhat.com/docs/en/html/api/Bugzilla/WebService/Bug.html#search
+          opts[:query_format] = 'advanced'
+          extra_field = 0
+
+          if opts.include?(:status)
+            opts[:bug_status] = opts[:status]
+            opts.delete(:status)
+          end
+          if opts.include?(:id)
+            opts[:bug_id] = opts[:id]
+            opts.delete(:id)
+          end
+          opts[:bug_severity] = opts[:severity] if opts.include?(:severity)
+          if opts.include?(:summary)
+            opts[:short_desc] = opts[:summary]
+            opts.delete(:summary)
+          end
+          if opts.include?(:cc)
+            # CC should be parsed "any words" by default
+            opts[eval(':emailcc1')] = 1
+            opts[eval(':emailtype1')] = :anywordssubstr
+            opts[eval(':email1')] = opts[:cc]
+            opts.delete(:cc)
+          end
+          if opts.include?(:creation_time)
+            opts[format('field0-%d-0', extra_field)] = :creation_ts
+            opts[format('type0-%d-0', extra_field)] = :greaterthan
+            opts[format('value0-%d-0', extra_field)] = opts[:creation_time]
+            opts.delete(:creation_time)
+          end
+        when :metrics
+          metricsopts = etc[0]
+          extra_field = 0
+
+          if opts.include?(:status)
+            opts[:bug_status] = opts[:status]
+            opts.delete(:status)
+          end
+          if opts.include?(:id)
+            opts[:bug_id] = opts[:id]
+            opts.delete(:id)
+          end
+          opts[:bug_severity] = opts[:severity] if opts.include?(:severity)
+          if opts.include?(:summary)
+            opts[:short_desc] = opts[:summary]
+            opts.delete(:summary)
+          end
+          if opts.include?(:cc)
+            i = 1
+            opts[:cc].each do |e|
+              opts[eval(":emailcc#{i}")] = 1
+              opts[eval(":emailtype#{i}")] = :substring
+              opts[eval(":email#{i}")] = e
+            end
+            opts.delete(:cc)
+          end
+
+          if opts.include?(:creation_time)
+            if opts[:creation_time].is_a?(Array)
+              opts[format('field0-%d-0', extra_field)] = :creation_ts
+              opts[format('type0-%d-0', extra_field)] = :greaterthan
+              opts[format('value0-%d-0', extra_field)] = opts[:creation_time][0]
+              extra_field += 1
+              opts[format('field0-%d-0', extra_field)] = :creation_ts
+              opts[format('type0-%d-0', extra_field)] = :lessthan
+              opts[format('value0-%d-0', extra_field)] = opts[:creation_time][1]
+              extra_field += 1
+            else
+              opts[format('field0-%d-0', extra_field)] = :creation_ts
+              opts[format('type0-%d-0', extra_field)] = :greaterthan
+              opts[format('value0-%d-0', extra_field)] = opts[:creation_time]
+              extra_field += 1
+            end
+            opts.delete(:creation_time)
+          end
+          if opts.include?(:last_change_time)
+            if opts[:last_change_time].is_a?(Array)
+              opts[:chfieldfrom] = opts[:last_change_time][0]
+              opts[:chfieldto] = opts[:last_change_time][1]
+              if opts[:bug_status] == 'CLOSED'
+                opts[format('field0-%d-0', extra_field)] = :bug_status
+                opts[format('type0-%d-0', extra_field)] = :changedto
+                opts[format('value0-%d-0', extra_field)] = opts[:bug_status]
+                extra_field += 1
+              end
+            end
+            opts.delete(:last_change_time)
+          end
+          if opts.include?(:metrics_closed_after)
+            opts[format('field0-%d-0', extra_field)] = :bug_status
+            opts[format('type0-%d-0', extra_field)] = :changedafter
+            opts[format('value0-%d-0', extra_field)] = opts[:metrics_closed_after]
+            extra_field += 1
+            opts.delete(:metrics_closed_after)
+          end
+          if opts.include?(:metrics_not_closed)
+            opts[format('field0-%d-0', extra_field)] = :bug_status
+            opts[format('type0-%d-0', extra_field)] = :notequals
+            opts[format('value0-%d-0', extra_field)] = 'CLOSED'
+            extra_field += 1
+            opts[format('field0-%d-0', extra_field)] = :creation_ts
+            opts[format('type0-%d-0', extra_field)] = :lessthan
+            opts[format('value0-%d-0', extra_field)] = opts[:metrics_not_closed]
+            extra_field += 1
+            opts.delete(:metrics_not_closed)
+          end
+       end
+      end # def prehook
+
+      def posthook(*args)
+        cmd, opts, *etc = args
+        case cmd
+        when :search
+          if opts.include?('bugs')
+            opts['bugs'].each do |bug|
+              if bug.include?('bug_status')
+                bug['status'] = bug['bug_status']
+                bug.delete('bug_status')
+              end
+              if bug.include?('bug_id')
+                bug['id'] = bug['bug_id']
+                bug.delete('bug_id')
+              end
+              if bug.include?('bug_severity')
+                bug['severity'] = bug['bug_severity']
+                bug.delete('bug_severity')
+              end
+              if bug.include?('short_desc')
+                bug['summary'] = bug['short_desc']
+                bug.delete('short_desc')
+              end
+            end
+           end
+        when :metrics
+          metricsopts = etc[0]
+
+          if opts.include?('bugs')
+            opts['bugs'].each do |bug|
+              if bug.include?('bug_status')
+                bug['status'] = bug['bug_status']
+                bug.delete('bug_status')
+              end
+              if bug.include?('bug_id')
+                bug['id'] = bug['bug_id']
+                bug.delete('bug_id')
+              end
+              if bug.include?('bug_severity')
+                bug['severity'] = bug['bug_severity']
+                bug.delete('bug_severity')
+              end
+              if bug.include?('short_desc')
+                bug['summary'] = bug['short_desc']
+                bug.delete('short_desc')
+              end
+            end
+          end
+       end
+      end # def posthook
+    end # class RedHat
+  end # module Plugin
+end # module Bugzilla