ruby-bugzilla 0.3.3 → 0.4.0

data/lib/bugzilla/api_tmpl.rb~

@@ -0,0 +1,51 @@
+# 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'
+
+
+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

data/lib/bugzilla/bug.rb

@@ -0,0 +1,346 @@
+# bug.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/api_tmpl'
+
+module Bugzilla
+
+=begin rdoc
+
+=== Bugzilla::Bug
+
+Bugzilla::Bug class is to access
+the Bugzilla::WebService::Bug API that allows you to file
+a new bug in Bugzilla or get information about bugs that
+have already been filed.
+
+=end
+
+  class Bug < APITemplate
+
+    FIELDS_SUMMARY = ["id", "product", "component", "status", "severity", "summary"]
+    FIELDS_DETAILS = FIELDS_SUMMARY + ["assigned_to", "internals", "priority", "resolution"]
+    FIELDS_ALL = ["alias", "assigned_to", "blocks", "cc", "classification",
+                  "component", "creation_time", "creator", "deadline",
+                  "depends_on", "dupe_of", "estimated_time", "groups",
+                  "id", "is_cc_accessible", "is_confirmed", "is_open",
+                  "is_creator_accessible", "keywords", "last_change_time",
+                  "op_sys", "platform", "priority", "product", "qa_contact",
+                  "remaining_time", "resolution", "see_also", "severity",
+                  "status", "summary", "target_milestone", "update_token",
+                  "url", "version", "whiteboard",
+                  "external_bugs", "internals"]
+
+=begin rdoc
+
+==== Bugzilla::Bug#get_bugs(bugs, fields = Bugzilla::Bug::FIELDS_SUMMARY)
+
+Get the _bugs_ information from Bugzilla. either of String
+or Numeric or Array would be acceptable for _bugs_. you can
+specify the fields you want to look up with _fields_.
+
+FWIW this name conflicts to Bugzilla API but this isn's a
+primitive method since get_bugs method in WebService API is
+actually deprecated.
+
+=end
+
+    def get_bugs(bugs, fields = ::Bugzilla::Bug::FIELDS_SUMMARY)
+      params = {}
+
+      if bugs.kind_of?(Array) then
+        params['ids'] = bugs
+      elsif bugs.kind_of?(Integer) ||
+          bugs.kind_of?(String) then
+        params['ids'] = [bugs]
+      else
+        raise ArgumentError, sprintf("Unknown type of arguments: %s", bugs.class)
+      end
+      unless fields.nil? then
+        unless (fields - ::Bugzilla::Bug::FIELDS_ALL).empty? then
+          raise ArgumentError, sprintf("Invalid fields: %s", (::Bugzilla::Bug::FIELDS_ALL - fields).join(' '))
+        end
+        params['include_fields'] = fields
+      end
+
+      result = get(params)
+
+      if fields.nil? || fields == ::Bugzilla::Bug::FIELDS_ALL then
+        get_comments(bugs).each do |id, c|
+          result['bugs'].each do |r|
+            if r['id'].to_s == id then
+              r['comments'] = c['comments']
+              r['comments'] = [] if r['comments'].nil?
+              break
+            end
+          end
+        end 
+      end
+
+      # 'bugs' is only in interests.
+      # XXX: need to deal with 'faults' ?
+      result['bugs']
+    end # def get_bugs
+
+=begin rdoc
+
+==== Bugzilla::Bug#get_comments(bugs)
+
+=end
+
+    def get_comments(bugs)
+      params = {}
+
+      if bugs.kind_of?(Array) then
+        params['ids'] = bugs
+      elsif bugs.kind_of?(Integer) ||
+          bugs.kind_of?(String) then
+        params['ids'] = [bugs]
+      else
+        raise ArgumentError, sprintf("Unknown type of arguments: %s", bugs.class)
+      end
+
+      result = comments(params)
+
+      # not supporting comment_ids. so drop "comments".
+      result['bugs']
+    end # def get_comments
+
+=begin rdoc
+
+==== Bugzilla::Bug#fields(params)
+
+Raw Bugzilla API to obtain the information about valid bug
+fields, including the lists of legal values for each field.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Bug#legal_values(params)
+
+Raw Bugzilla API to obtain the information what values are
+allowed for a particular field.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Bug#attachments(params)
+
+Raw Bugzilla API to obtain the information about
+attachments, given a list of bugs and/or attachment ids.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Bug#comments(params)
+
+Raw Bugzilla API to obtain the information about comments,
+given a list of bugs and/or comment ids.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Bug#get(params)
+
+Raw Bugzilla API to obtain the information about particular
+bugs in the database.
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Bug#history(params)
+
+Raw Bugzilla API to obtain the history of changes for
+particular bugs in the database.
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Bug#search(params)
+
+Raw Bugzilla API to search for bugs based on particular
+criteria.
+
+=end
+
+    protected
+
+    def _fields(cmd, *args)
+      requires_version(cmd, 3.6)
+      params = {}
+
+      if args[0].kind_of?(Array) then
+        x = args[0].map {|x| x.kind_of?(Integer)}.uniq
+        if x.length == 1 && x[0] then
+          params['ids'] = args[0]
+        else
+          x = args[0].map {|x| x.kind_of?(String)}.uniq
+          if x.length == 1 && x[0] then
+            params['names'] = args[0]
+          end
+        end
+      elsif args[0].kind_of?(Hash) then
+	params = args[0]
+      elsif args[0].kind_of?(Integer) then
+	params['ids'] = [args[0]]
+      elsif args[0].kind_of?(String) then
+	params['names'] = [args[0]]
+      elsif args[0].nil? then
+      else
+        raise ArgumentError, "Invalid parameters"
+      end
+
+      @iface.call(cmd, params)
+    end # def _fields
+
+    def _legal_values(cmd, *args)
+      raise ArgumentError, "Invalid parameters" unless args[0].kind_of?(Hash)
+
+      @iface.call(cmd, args[0])
+    end # def _legal_values
+
+    def _attachments(cmd, *args)
+      requires_version(cmd, 3.6)
+
+      raise ArgumentError, "Invalid parameters" unless args[0].kind_of?(Hash)
+
+      @iface.call(cmd, args[0])
+    end # def _attachments
+
+    def _comments(cmd, *args)
+      requires_version(cmd, 3.4)
+
+      raise ArgumentError, "Invalid parameters" unless args[0].kind_of?(Hash)
+
+      @iface.call(cmd, args[0])
+    end # def _comments
+
+    def _get(cmd, *args)
+      params = {}
+
+      if args[0].kind_of?(Hash) then
+        params = args[0]
+      elsif args[0].kind_of?(Array) then
+	params['ids'] = args[0]
+      elsif args[0].kind_of?(Integer) ||
+          args[0].kind_of?(String) then
+	params['ids'] = [args[0]]
+      else
+        raise ArgumentError, "Invalid parameters"
+      end
+      if check_version(3.4)[0] then
+        params['permissive'] = true
+      end
+
+      @iface.call(cmd, params)
+    end # def _get
+
+    def _history(cmd, *args)
+      requires_version(cmd, 3.4)
+
+      params = {}
+
+      if args[0].kind_of?(Hash) then
+        params = args[0]
+      elsif args[0].kind_of?(Array) then
+	params['ids'] = args[0]
+      elsif args[0].kind_of?(Integer) ||
+          args[0].kind_of?(String) then
+	params['ids'] = [args[0]]
+      else
+        raise ArgumentError, "Invalid parameters"
+      end
+
+      @iface.call(cmd, params)
+    end # def _history
+
+    def _search(cmd, *args)
+      requires_version(cmd, 3.4)
+
+      raise ArgumentError, "Invalid parameters" unless args[0].kind_of?(Hash)
+
+      @iface.call(cmd, args[0])
+    end # def _search
+
+    def _create(cmd, *args)
+      raise ArgumentError, "Invalid parameters" unless args[0].kind_of?(Hash)
+
+      required_fields = [:product, :component, :summary, :version]
+      defaulted_fields = [:description, :op_sys, :platform, :priority, :severity]
+
+      res = check_version("3.0.4")
+      unless res[0] then
+	required_fields.push(*defaulted_fields)
+      end
+      required_fields.each do |f|
+        raise ArgumentError, sprintf("Required fields isn't given: %s", f) unless args[0].include?(f)
+      end
+      res = check_version(4.0)
+      unless res[0] then
+        raise ArgumentError, "groups field isn't available in this bugzilla" if args[0].include?("groups")
+        raise ArgumentError, "comment_is_private field isn't available in this bugzilla" if args[0].include?("comment_is_private")
+      else
+        if args[0].include?("commentprivacy") then
+          args[0]["comment_is_private"] = args[0]["commentprivacy"]
+          args[0].delete("commentprivacy")
+        end
+      end
+
+      @iface.call(cmd, args[0])
+    end # def _create
+
+    def __add_attachment(cmd, *args)
+      requires_version(cmd, 4.0)
+      # FIXME
+    end # def _add_attachment
+
+    def __add_comment(cmd, *args)
+      requires_version(cmd, 3.2)
+      # FIXME
+    end # def _add_comment
+
+    def __update(cmd, *args)
+      requires_version(cmd, 4.0)
+      # FIXME
+    end # def _update
+
+    def __update_see_also(cmd, *args)
+      requires_version(cmd, 3.4)
+      # FIXME
+    end # def _update_see_also
+
+  end # class Bug
+
+end # module Bugzilla

data/lib/bugzilla/bug.rb~

@@ -0,0 +1,323 @@
+# product.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/api_tmpl'
+
+module Bugzilla
+
+=begin rdoc
+
+=== Bugzilla::Bug
+
+Bugzilla::Bug class is to access
+the Bugzilla::WebService::Bug API that allows you to file
+a new bug in Bugzilla or get information about bugs that
+have already been filed.
+
+=end
+
+  class Bug < APITemplate
+
+    FIELDS_SUMMARY = ["id", "product", "component", "status", "severity", "summary"]
+    FIELDS_DETAILS = FIELDS_SUMMARY + ["assigned_to", "internals", "priority", "resolution"]
+    FIELDS_ALL = ["alias", "assigned_to", "blocks", "cc", "classification",
+                  "component", "creation_time", "creator", "deadline",
+                  "depends_on", "dupe_of", "estimated_time", "groups",
+                  "id", "is_cc_accessible", "is_confirmed", "is_open",
+                  "is_creator_accessible", "keywords", "last_change_time",
+                  "op_sys", "platform", "priority", "product", "qa_contact",
+                  "remaining_time", "resolution", "see_also", "severity",
+                  "status", "summary", "target_milestone", "update_token",
+                  "url", "version", "whiteboard",
+                  "external_bugs", "internals"]
+
+=begin rdoc
+
+==== Bugzilla::Bug#get_bugs(bugs, fields = Bugzilla::Bug::FIELDS_SUMMARY)
+
+Get the _bugs_ information from Bugzilla. either of String
+or Numeric or Array would be acceptable for _bugs_. you can
+specify the fields you want to look up with _fields_.
+
+FWIW this name conflicts to Bugzilla API but this isn's a
+primitive method since get_bugs method in WebService API is
+actually deprecated.
+
+=end
+
+    def get_bugs(bugs, fields = ::Bugzilla::Bug::FIELDS_SUMMARY)
+      params = {}
+
+      if bugs.kind_of?(Array) then
+        params['ids'] = bugs
+      elsif bugs.kind_of?(Integer) ||
+          bugs.kind_of?(String) then
+        params['ids'] = [bugs]
+      else
+        raise ArgumentError, sprintf("Unknown type of arguments: %s", bugs.class)
+      end
+      unless fields.nil? then
+        unless (fields - ::Bugzilla::Bug::FIELDS_ALL).empty? then
+          raise ArgumentError, sprintf("Invalid fields: %s", (::Bugzilla::Bug::FIELDS_ALL - fields).join(' '))
+        end
+        params['include_fields'] = fields
+      end
+
+      result = get(params)
+
+      if fields.nil? || fields == ::Bugzilla::Bug::FIELDS_ALL then
+        get_comments(bugs).each do |id, c|
+          result['bugs'].each do |r|
+            if r['id'].to_s == id then
+              r['comments'] = c['comments']
+              r['comments'] = [] if r['comments'].nil?
+              break
+            end
+          end
+        end 
+      end
+
+      # 'bugs' is only in interests.
+      # XXX: need to deal with 'faults' ?
+      result['bugs']
+    end # def get_bugs
+
+=begin rdoc
+
+==== Bugzilla::Bug#get_comments(bugs)
+
+=end
+
+    def get_comments(bugs)
+      params = {}
+
+      if bugs.kind_of?(Array) then
+        params['ids'] = bugs
+      elsif bugs.kind_of?(Integer) ||
+          bugs.kind_of?(String) then
+        params['ids'] = [bugs]
+      else
+        raise ArgumentError, sprintf("Unknown type of arguments: %s", bugs.class)
+      end
+
+      result = comments(params)
+
+      # not supporting comment_ids. so drop "comments".
+      result['bugs']
+    end # def get_comments
+
+=begin rdoc
+
+==== Bugzilla::Bug#fields(params)
+
+Raw Bugzilla API to obtain the information about valid bug
+fields, including the lists of legal values for each field.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Bug#legal_values(params)
+
+Raw Bugzilla API to obtain the information what values are
+allowed for a particular field.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Bug#attachments(params)
+
+Raw Bugzilla API to obtain the information about
+attachments, given a list of bugs and/or attachment ids.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Bug#comments(params)
+
+Raw Bugzilla API to obtain the information about comments,
+given a list of bugs and/or comment ids.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Bug#get(params)
+
+Raw Bugzilla API to obtain the information about particular
+bugs in the database.
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Bug#history(params)
+
+Raw Bugzilla API to obtain the history of changes for
+particular bugs in the database.
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Bug#search(params)
+
+Raw Bugzilla API to search for bugs based on particular
+criteria.
+
+=end
+
+    protected
+
+    def _fields(cmd, *args)
+      requires_version(cmd, 3.6)
+      params = {}
+
+      if args[0].kind_of?(Array) then
+        x = args[0].map {|x| x.kind_of?(Integer)}.uniq
+        if x.length == 1 && x[0] then
+          params['ids'] = args[0]
+        else
+          x = args[0].map {|x| x.kind_of?(String)}.uniq
+          if x.length == 1 && x[0] then
+            params['names'] = args[0]
+          end
+        end
+      elsif args[0].kind_of?(Hash) then
+	params = args[0]
+      elsif args[0].kind_of?(Integer) then
+	params['ids'] = [args[0]]
+      elsif args[0].kind_of?(String) then
+	params['names'] = [args[0]]
+      elsif args[0].nil? then
+      else
+        raise ArgumentError, "Invalid parameters"
+      end
+
+      @iface.call(cmd, params)
+    end # def _fields
+
+    def _legal_values(cmd, *args)
+      raise ArgumentError, "Invalid parameters" unless args[0].kind_of?(Hash)
+
+      @iface.call(cmd, args[0])
+    end # def _legal_values
+
+    def _attachments(cmd, *args)
+      requires_version(cmd, 3.6)
+
+      raise ArgumentError, "Invalid parameters" unless args[0].kind_of?(Hash)
+
+      @iface.call(cmd, args[0])
+    end # def _attachments
+
+    def _comments(cmd, *args)
+      requires_version(cmd, 3.4)
+
+      raise ArgumentError, "Invalid parameters" unless args[0].kind_of?(Hash)
+
+      @iface.call(cmd, args[0])
+    end # def _comments
+
+    def _get(cmd, *args)
+      params = {}
+
+      if args[0].kind_of?(Hash) then
+        params = args[0]
+      elsif args[0].kind_of?(Array) then
+	params['ids'] = args[0]
+      elsif args[0].kind_of?(Integer) ||
+          args[0].kind_of?(String) then
+	params['ids'] = [args[0]]
+      else
+        raise ArgumentError, "Invalid parameters"
+      end
+      if check_version(3.4)[0] then
+        params['permissive'] = true
+      end
+
+      @iface.call(cmd, params)
+    end # def _get
+
+    def _history(cmd, *args)
+      requires_version(cmd, 3.4)
+
+      params = {}
+
+      if args[0].kind_of?(Hash) then
+        params = args[0]
+      elsif args[0].kind_of?(Array) then
+	params['ids'] = args[0]
+      elsif args[0].kind_of?(Integer) ||
+          args[0].kind_of?(String) then
+	params['ids'] = [args[0]]
+      else
+        raise ArgumentError, "Invalid parameters"
+      end
+
+      @iface.call(cmd, params)
+    end # def _history
+
+    def _search(cmd, *args)
+      requires_version(cmd, 3.4)
+
+      raise ArgumentError, "Invalid parameters" unless args[0].kind_of?(Hash)
+
+      @iface.call(cmd, args[0])
+    end # def _search
+
+    def __create(cmd, *args)
+      # FIXME
+    end # def _create
+
+    def __add_attachment(cmd, *args)
+      requires_version(cmd, 4.0)
+      # FIXME
+    end # def _add_attachment
+
+    def __add_comment(cmd, *args)
+      requires_version(cmd, 3.2)
+      # FIXME
+    end # def _add_comment
+
+    def __update(cmd, *args)
+      requires_version(cmd, 4.0)
+      # FIXME
+    end # def _update
+
+    def __update_see_also(cmd, *args)
+      requires_version(cmd, 3.4)
+      # FIXME
+    end # def _update_see_also
+
+  end # class Bug
+
+end # module Bugzilla