ruby-bugzilla 0.4.1 → 0.5.0

data/README.rdoc

@@ -4,15 +4,23 @@ This aims to provide similar features in Ruby to access to Bugzilla
 through {WebService APIs}[http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService.html].  currently the following
 APIs are available:
 
+* Bugzilla::WebService::Bug[http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html]
 * Bugzilla::WebService::Bugzilla[http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bugzilla.html]
+* Bugzilla::WebService::Classification[http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Classification.html]
 * Bugzilla::WebService::Product[http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Product.html]
-* Bugzilla::WebService::Bug[http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html]
 * Bugzilla::WebService::User[http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/User.html]
 
 == Copyright
 
 Copyright (c) 2010-2012 Red Hat, Inc. See COPYING for details.
 
+== License
+
+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.
+
 == Authors
 
 Akira TAGOH

data/bin/bzconsole

@@ -1,25 +1,23 @@
 #! /usr/bin/env ruby
 # -*- coding: utf-8 -*-
-# bzconsole.rb
+# bzconsole
 # Copyright (C) 2010-2012 Red Hat, Inc.
 #
 # Authors:
 #   Akira TAGOH  <tagoh@redhat.com>
 #
-# This library is free software; you can redistribute it and/or
+# 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 2 of the License, or (at your option) any later version.
+# 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
-# Lesser General Public License for more details.
+# 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 Lesser General Public
-# License along with this library; if not, write to the
-# Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-# Boston, MA 02111-1307, USA.
+# 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 'optparse'
 require 'time'

data/lib/bugzilla/api_tmpl.rb

@@ -4,20 +4,18 @@
 # 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 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 program is distributed in the hope that it will be useful,
+# 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, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330,
-# Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'bugzilla/skeleton'
 require 'bugzilla/bugzilla'

data/lib/bugzilla/api_tmpl.rb~

@@ -20,6 +20,7 @@
 # Boston, MA 02111-1307, USA.
 
 require 'bugzilla/skeleton'
+require 'bugzilla/bugzilla'
 
 
 module Bugzilla

data/lib/bugzilla/bug.rb

@@ -4,20 +4,18 @@
 # 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 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 program is distributed in the hope that it will be useful,
+# 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, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330,
-# Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'bugzilla/api_tmpl'
 
@@ -175,6 +173,8 @@ See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html
 Raw Bugzilla API to obtain the information about particular
 bugs in the database.
 
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html
+
 =end
 
 =begin rdoc
@@ -184,6 +184,8 @@ bugs in the database.
 Raw Bugzilla API to obtain the history of changes for
 particular bugs in the database.
 
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html
+
 =end
 
 =begin rdoc
@@ -193,6 +195,18 @@ particular bugs in the database.
 Raw Bugzilla API to search for bugs based on particular
 criteria.
 
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Bug#create(params)
+
+Raw Bugzilla API to create a new bug in Bugzilla.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html
+
 =end
 
     protected
@@ -341,6 +355,11 @@ criteria.
       # FIXME
     end # def _update_see_also
 
+    def __update_tags(cmd, *args)
+      requires_version(cmd, 4.4)
+      # FIXME
+    end # def _update_tags
+
   end # class Bug
 
 end # module Bugzilla

data/lib/bugzilla/bug.rb~

@@ -1,4 +1,4 @@
-# product.rb
+# bug.rb
 # Copyright (C) 2010-2012 Red Hat, Inc.
 #
 # Authors:
@@ -294,8 +294,31 @@ criteria.
       @iface.call(cmd, args[0])
     end # def _search
 
-    def __create(cmd, *args)
-      # FIXME
+    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)

data/lib/bugzilla/bugzilla.rb

@@ -4,20 +4,18 @@
 # 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 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 program is distributed in the hope that it will be useful,
+# 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, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330,
-# Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'bugzilla/skeleton'
 
@@ -112,6 +110,16 @@ running on.
 
 See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bugzilla.html
 
+=end
+
+=begin 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
+
 =end
 
     protected
@@ -136,6 +144,18 @@ See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bugzilla.ht
       @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/bugzilla.rb~

@@ -1,4 +1,4 @@
-# skeleton.rb
+# bugzilla.rb
 # Copyright (C) 2010-2012 Red Hat, Inc.
 #
 # Authors:
@@ -19,6 +19,7 @@
 # Foundation, Inc., 59 Temple Place - Suite 330,
 # Boston, MA 02111-1307, USA.
 
+require 'bugzilla/skeleton'
 
 module Bugzilla
 

data/lib/bugzilla/classification.rb

@@ -0,0 +1,76 @@
+# 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_tmpl'
+
+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
+
+    def _get(cmd, args[0])
+      requires_version(cmd, 4.4)
+
+      params = {}
+
+      if ids.kind_of?(Hash) then
+        raise ArgumentError, sprintf("Invalid parameter: %s", ids.inspect) unless ids.include?('ids') || ids.include?('names')
+        params[:ids] = ids['ids'] || ids['names']
+      elsif ids.kind_of?(Array) then
+	r = ids.map {|x| x.kind_of?(Integer) ? x : nil}.compact
+        if r.length != ids.length then
+          params[:names] = ids
+        else
+          params[:ids] = ids
+        end
+      else
+        if ids.kind_of?(Integer) then
+          params[:ids] = [ids]
+        else
+          params[:names] = [ids]
+        end
+      end
+
+      @iface.call(cmd, params)
+    end # def _get
+
+  end # class Classification
+
+end # module Bugzilla
+

data/lib/bugzilla/group.rb

@@ -0,0 +1,46 @@
+# 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_tmpl'
+
+module Bugzilla
+
+=begin 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.
+
+=end
+
+  class Group < APITemplate
+
+    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/group.rb~

@@ -0,0 +1,66 @@
+# 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_tmpl'
+
+module Bugzilla
+
+=begin 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.
+
+=end
+
+  class Group < APITemplate
+
+=begin rdoc
+
+==== Bugzilla::Group#create(params)
+
+Raw Bugzilla API to create a new group in Bugzilla.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Group.html
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Group#update(params)
+
+Raw Bugzilla APi to update a group in Bugzilla.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Group.html
+
+=end
+
+    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

@@ -4,20 +4,18 @@
 # 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 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 program is distributed in the hope that it will be useful,
+# 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, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330,
-# Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
 module Bugzilla

data/lib/bugzilla/product.rb

@@ -4,20 +4,18 @@
 # 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 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 program is distributed in the hope that it will be useful,
+# 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, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330,
-# Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'bugzilla/api_tmpl'
 
@@ -39,54 +37,57 @@ list the available Products and get information about them.
 
 ==== Bugzilla::Product#selectable_products
 
-Returns the products that the user can search on as Hash
-contains the product name as the Hash key and Array as the
-value. Array contains the list of _id_, _name_,
-_description_ and _internals_ according to API documentation
-though, actually the component, the version and the target
-milestone.
+Returns Hash table for the products information that the user
+can search on. the Hash key is the product name and containing
+a Hash table which contains id, name, description,
+is_active, default_milestone, has_uncomfirmed, classification,
+components, versions and milestones. please see
+http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Product.html#get
+for more details.
 
 =end
 
     def selectable_products
       ids = get_selectable_products
-      get(ids)
+      Hash[*get(ids)['products'].map {|x| [x['name'], x]}.flatten]
     end # def selectable_products
 
 =begin rdoc
 
 ==== Bugzilla::Product#enterable_products
 
-Returns the products that the user can enter bugs against
-as Hash contains the product name as the Hash key and Array
-as the value. Array contains the list of _id_, _name_,
-_description_ and _internals_ according to API documentation
-though, actually the component, the version and the target
-milestone.
+Returns Hash table for the products information that the user
+can enter bugs against. the Hash key is the product name and
+containing a Hash table which contains id, name, description,
+is_active, default_milestone, has_uncomfirmed, classification,
+components, versions and milestones. please see
+http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Product.html#get
+for more details.
 
 =end
 
     def enterable_products
       ids = get_enterable_products
-      get(ids)
+      Hash[*get(ids)['products'].map {|x| [x['name'], x]}.flatten]
     end # def enterable_products
 
 =begin rdoc
 
 ==== Bugzilla::Product#accessible_products
 
-Returns the products that the user can search or enter bugs
-against as Hash contains the product name as the Hash key
-and Array as the value. Array contains the list of _id_,
-_name_, _description_ and _internals_ according to API
-documentation though, actually the component, the version
-and the target milestone.
+Returns Hash table for the products information that the user
+can search or enter bugs against. the Hash key is the product
+name and containing a Hash table which contains id, name, description,
+is_active, default_milestone, has_uncomfirmed, classification,
+components, versions and milestones. please see
+http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Product.html#get
+for more details.
 
 =end
 
     def accessible_products
       ids = get_accessible_products
-      get(ids)
+      Hash[*get(ids)['products'].map {|x| [x['name'], x]}.flatten]
     end # def accessible_products
 
 =begin rdoc
@@ -120,6 +121,17 @@ search or enter bugs against.
 
 See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Product.html
 
+=end
+
+=begin rdoc
+
+==== Bugzilla::Product#get(params)
+
+Raw Bugzilla API to obtain a list of information about the products
+passed to it.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Product.html
+
 =end
 
     protected
@@ -137,20 +149,43 @@ See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Product.htm
     end # def _get_accessible_products
 
     def _get(cmd, ids, *args)
+      # This is still in experimental and apparently the behavior was changed since 4.2.
+      # We don't keep the backward-compatibility and just require the proper version here.
+      requires_version(cmd, 4.2)
+
       params = {}
 
       if ids.kind_of?(Hash) then
-        raise ArgumentError, sprintf("Invalid parameter: %s", ids.inspect) unless ids.include?('ids')
-        params[:ids] = ids['ids']
+        raise ArgumentError, sprintf("Invalid parameter: %s", ids.inspect) unless ids.include?('ids') || ids.include?('names')
+        params[:ids] = ids['ids'] || ids['names']
       elsif ids.kind_of?(Array) then
-	params[:ids] = ids
+	r = ids.map {|x| x.kind_of?(Integer) ? x : nil}.compact
+        if r.length != ids.length then
+          params[:names] = ids
+        else
+          params[:ids] = ids
+        end
       else
-        params[:ids] = [ids]
+        if ids.kind_of?(Integer) then
+          params[:ids] = [ids]
+        else
+          params[:names] = [ids]
+        end
       end
 
       @iface.call(cmd, params)
     end # def _get
 
+    def __create(cmd, *args)
+      # FIXME
+    end # def _create
+
+    def __update(cmd, *args)
+      requires_version(cmd, 4.4)
+
+      # FIXME
+    end # def _update
+
   end # class Product
 
 end # module Bugzilla