ruby-bugzilla 0.3.3 → 0.4.0

data/lib/bugzilla/product.rb

@@ -0,0 +1,156 @@
+# 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::Product
+
+Bugzilla::Product class is to access
+the Bugzilla::WebService::Product API that allows you to
+list the available Products and get information about them.
+
+=end
+
+  class Product < APITemplate
+
+=begin rdoc
+
+==== 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.
+
+=end
+
+    def selectable_products
+      ids = get_selectable_products
+      get(ids)
+    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.
+
+=end
+
+    def enterable_products
+      ids = get_enterable_products
+      get(ids)
+    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.
+
+=end
+
+    def accessible_products
+      ids = get_accessible_products
+      get(ids)
+    end # def accessible_products
+
+=begin rdoc
+
+==== Bugzilla::Product#get_selectable_products
+
+Raw Bugzilla API to obtain the products that the user can
+search on.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Product.html
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Product#get_enterable_products
+
+Raw Bugzilla API to obtain the products that the user can
+enter bugs against.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Product.html
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::Product#get_accessible_products
+
+Raw Bugzilla API to obtain the products that the user can
+search or enter bugs against.
+
+See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Product.html
+
+=end
+
+    protected
+
+    def _get_selectable_products(cmd, *args)
+      @iface.call(cmd)
+    end # def _get_selectable_products
+
+    def _get_enterable_products(cmd, *args)
+      @iface.call(cmd)
+    end # def _get_entrable_products
+
+    def _get_accessible_products(cmd, *args)
+      @iface.call(cmd)
+    end # def _get_accessible_products
+
+    def _get(cmd, ids, *args)
+      params = {}
+
+      if ids.kind_of?(Hash) then
+        raise ArgumentError, sprintf("Invalid parameter: %s", ids.inspect) unless ids.include?('ids')
+        params[:ids] = ids['ids']
+      elsif ids.kind_of?(Array) then
+	params[:ids] = ids
+      else
+        params[:ids] = [ids]
+      end
+
+      @iface.call(cmd, params)
+    end # def _get
+
+  end # class Product
+
+end # module Bugzilla

data/lib/bugzilla/skeleton.rb

@@ -0,0 +1,50 @@
+# skeleton.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.
+
+
+module Bugzilla
+
+=begin rdoc
+
+=== Bugzilla::Skeleton
+
+=end
+
+  class Skeleton
+
+    def initialize(iface)
+      @iface = iface
+    end # def initialize
+
+    def method_missing(symbol, *args)
+      m = "_#{symbol}"
+      klass = self.class.to_s.sub(/\ABugzilla::/, '')
+      fm = "#{klass}.#{symbol}"
+      if self.respond_to?(m) then
+        __send__(m, fm, *args)
+      else
+        raise NoMethodError, sprintf("No such Bugzilla APIs: %s.%s", klass, symbol)
+      end
+    end # def method_missing
+
+  end # class Skeleton
+
+end # module Bugzilla

data/lib/bugzilla/skelton.rb~

@@ -0,0 +1,50 @@
+# skelton.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.
+
+
+module Bugzilla
+
+=begin rdoc
+
+=== Bugzilla::Skeleton
+
+=end
+
+  class Skeleton
+
+    def initialize(iface)
+      @iface = iface
+    end # def initialize
+
+    def method_missing(symbol, *args)
+      m = "_#{symbol}"
+      klass = self.class.to_s.sub(/\ABugzilla::/, '')
+      fm = "#{klass}.#{symbol}"
+      if self.respond_to?(m) then
+        __send__(m, fm, *args)
+      else
+        raise NoMethodError, sprintf("No such Bugzilla APIs: %s.%s", klass, symbol)
+      end
+    end # def method_missing
+
+  end # class Skeleton
+
+end # module Bugzilla

data/lib/bugzilla/user.rb

@@ -0,0 +1,114 @@
+# user.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::User
+
+Bugzilla::User class is to access the
+Bugzilla::WebService::User API that allows you to create
+User Accounts and log in/out using an existing account.
+
+=end
+
+  class User < APITemplate
+
+=begin rdoc
+
+==== Bugzilla::User#session(user, password)
+
+Keeps the bugzilla session during doing something in the block.
+
+=end
+
+    def session(user, password)
+      fname = File.join(ENV['HOME'], '.ruby-bugzilla-cookie.yml')
+      if File.exist?(fname) && File.lstat(fname).mode & 0600 == 0600 then
+        conf = YAML.load(File.open(fname).read)
+        host = @iface.instance_variable_get(:@xmlrpc).instance_variable_get(:@host)
+        cookie = conf[host]
+        unless cookie.nil? then
+          @iface.cookie = cookie
+          print "Using cookie\n"
+          yield
+          conf[host] = @iface.cookie
+          File.open(fname, 'w') {|f| f.chmod(0600); f.write(conf.to_yaml)}
+          return
+        end
+      end
+      if user.nil? || password.nil? then
+        yield
+      else
+        login({'login'=>user, 'password'=>password, 'remember'=>true})
+        yield
+        logout
+      end
+      
+    end # def session
+
+=begin rdoc
+
+==== Bugzilla::User#login(params)
+
+Raw Bugzilla API to log into Bugzilla.
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::User#logout
+
+Raw Bugzilla API to log out the user.
+
+=end
+
+    protected
+
+    def _login(cmd, *args)
+      raise ArgumentError, "Invalid parameters" unless args[0].kind_of?(Hash)
+
+      @iface.call(cmd,args[0])
+    end # def _login
+
+    def _logout(cmd, *args)
+      @iface.call(cmd)
+    end # def _logout
+
+    def __offer_account_by_email(cmd, *args)
+      # FIXME
+    end # def _offer_account_by_email
+
+    def __create(cmd, *args)
+      # FIXME
+    end # def _create
+
+    def __get(cmd, *args)
+      requires_version(cmd, 3.4)
+      # FIXME
+    end # def _get
+
+  end # class User
+
+end # module Bugzilla

data/lib/bugzilla/user.rb~

@@ -0,0 +1,114 @@
+# user.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::User
+
+Bugzilla::User class is to access the
+Bugzilla::WebService::User API that allows you to create
+User Accounts and log in/out using an existing account.
+
+=end
+
+  class User < APITemplate
+
+=begin rdoc
+
+==== Bugzilla::User#session(user, password)
+
+Keeps the bugzilla session during doing something in the block.
+
+=end
+
+    def session(user, password)
+      fname = File.join(ENV['HOME'], '.ruby-bugzilla-cookie.yml')
+      if File.exist?(fname) && File.lstat(fname).mode & 0600 == 0600 then
+        conf = YAML.load(File.open(fname).read)
+        host = @iface.instance_variable_get(:@xmlrpc).instance_variable_get(:@host)
+        cookie = conf[host]
+        unless cookie.nil? then
+          @iface.cookie = cookie
+          print "Using cookie\n"
+          yield
+          conf[host] = @iface.cookie
+          File.open(fname, 'w') {|f| f.chmod(0600); f.write(conf.to_yaml)}
+          return
+        end
+      end
+      if user.nil? || password.nil? then
+        yield
+      else
+        login({'login'=>user, 'password'=>password, 'remember'=>true})
+        yield
+        logout
+      end
+      
+    end # def session
+
+=begin rdoc
+
+==== Bugzilla::User#login(params)
+
+Raw Bugzilla API to log into Bugzilla.
+
+=end
+
+=begin rdoc
+
+==== Bugzilla::User#logout
+
+Raw Bugzilla API to log out the user.
+
+=end
+
+    protected
+
+    def _login(cmd, *args)
+      raise ArgumentError, "Invalid parameters" unless args[0].kind_of?(Hash)
+
+      @iface.call(cmd,args[0])
+    end # def _login
+
+    def _logout(cmd, *args)
+      @iface.call(cmd)
+    end # def _logout
+
+    def __offer_account_by_email(cmd, *args)
+      # FIXME
+    end # def _offer_account_by_email
+
+    def __create(cmd, *args)
+      # FIXME
+    end # def _create
+
+    def __get(cmd, *args)
+      requires_version(cmd, 3.4)
+      # FIXME
+    end # def _get
+
+  end # class User
+
+end # module Bugzilla