bugzilla 0.10.0

data/lib/bugzilla/product.rb

@@ -0,0 +1,179 @@
+# product.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::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.
+  #
+
+  class Product < APITemplate
+    # rdoc
+    #
+    # ==== Bugzilla::Product#selectable_products
+    #
+    # 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.
+    #
+
+    def selectable_products
+      ids = get_selectable_products
+      Hash[*get(ids)['products'].map { |x| [x['name'], x] }.flatten]
+    end # def selectable_products
+
+    # rdoc
+    #
+    # ==== Bugzilla::Product#enterable_products
+    #
+    # 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.
+    #
+
+    def enterable_products
+      ids = get_enterable_products
+      Hash[*get(ids)['products'].map { |x| [x['name'], x] }.flatten]
+    end # def enterable_products
+
+    # rdoc
+    #
+    # ==== Bugzilla::Product#accessible_products
+    #
+    # 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.
+    #
+
+    def accessible_products
+      ids = get_accessible_products
+      Hash[*get(ids)['products'].map { |x| [x['name'], x] }.flatten]
+    end # def accessible_products
+
+    # 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
+    #
+
+    # 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
+    #
+
+    # 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
+    #
+
+    # 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
+    #
+
+    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)
+      # 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.is_a?(Hash)
+        raise ArgumentError, format('Invalid parameter: %s', ids.inspect) unless ids.include?('ids') || ids.include?('names')
+        params[:ids] = ids['ids'] || ids['names']
+      elsif ids.is_a?(Array)
+        r = ids.map { |x| x.is_a?(Integer) ? x : nil }.compact
+        if r.length != ids.length
+          params[:names] = ids
+        else
+          params[:ids] = ids
+        end
+      else
+        if ids.is_a?(Integer)
+          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

data/lib/bugzilla/skeleton.rb

@@ -0,0 +1,42 @@
+# skeleton.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/>.
+
+module Bugzilla
+  # rdoc
+  #
+  # === Bugzilla::Skeleton
+  #
+
+  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 respond_to?(m, true)
+        __send__(m, fm, *args)
+      else
+        raise NoMethodError, format('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,182 @@
+# user.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 'yaml'
+require 'bugzilla/api_template'
+
+module Bugzilla
+  # 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.
+  #
+
+  class User < APITemplate
+    # rdoc
+    #
+    # ==== Bugzilla::User#session(user, password)
+    #
+    # Keeps the bugzilla session during doing something in the block.
+    #
+
+    def session(user, password)
+      key, fname = authentication_method
+
+      # TODO
+      # make those variables available
+      host = @iface.instance_variable_get(:@xmlrpc).instance_variable_get(:@host)
+
+      conf = load_authentication_token(fname)
+
+      val = conf.fetch(host, nil)
+
+      if !val.nil?
+        if key == :token
+          @iface.token = val
+        else
+          @iface.cookie = val
+        end
+        yield
+      elsif user.nil? || password.nil?
+        yield
+        return
+      else
+        login('login' => user, 'password' => password, 'remember' => true)
+        yield
+      end
+
+      conf[host] = @iface.send(key) if %i[token cookie].include? key
+
+      save_authentication_token(fname, conf)
+      key
+    end # def session
+
+    # rdoc
+    #
+    # ==== Bugzilla::User#get_userinfo(params)
+    #
+
+    def get_userinfo(user)
+      p = {}
+      ids = []
+      names = []
+
+      if user.is_a?(Array)
+        user.each do |u|
+          names << u if u.is_a?(String)
+          id << u if u.is_a?(Integer)
+        end
+      elsif user.is_a?(String)
+        names << user
+      elsif user.is_a?(Integer)
+        ids << user
+      else
+        raise ArgumentError, format('Unknown type of arguments: %s', user.class)
+      end
+
+      result = get('ids' => ids, 'names' => names)
+
+      result['users']
+    end # def get_userinfo
+
+    # rdoc
+    #
+    # ==== Bugzilla::User#login(params)
+    #
+    # Raw Bugzilla API to log into Bugzilla.
+    #
+    # See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/User.html
+    #
+
+    # rdoc
+    #
+    # ==== Bugzilla::User#logout
+    #
+    # Raw Bugzilla API to log out the user.
+    #
+    # See http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/User.html
+    #
+
+    protected
+
+    def load_authentication_token(fname)
+      if File.exist?(fname) && File.lstat(fname).mode & 0o600 == 0o600
+        YAML.safe_load(File.open(fname).read)
+      else
+        {}
+      end
+    end
+
+    def save_authentication_token(fname, conf)
+      File.open(fname, 'w') { |f| f.chmod(0o600); f.write(conf.to_yaml) }
+    end
+
+    def is_token_supported?
+      check_version('4.4.3')[0] == true
+    rescue StandardError
+      false
+    end
+
+    # it returns an array with authentication type and the name of the storage
+    def authentication_method
+      # if version supported, use token, otherwise cookie
+      if is_token_supported?
+        [:token, File.join(ENV['HOME'], '.ruby-bugzilla-token.yml')]
+      else
+        [:cookie, File.join(ENV['HOME'], '.ruby-bugzilla-cookie.yml')]
+      end
+    end
+
+    def _login(cmd, *args)
+      raise ArgumentError, 'Invalid parameters' unless args[0].is_a?(Hash)
+
+      res = @iface.call(cmd, args[0])
+      @iface.token = res['token'] unless res['token'].nil?
+
+      res
+    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 __update(cmd, *args)
+      # FIXME
+    end # def _update
+
+    def _get(cmd, *args)
+      raise ArgumentError, 'Invalid parameters' unless args[0].is_a?(Hash)
+
+      requires_version(cmd, 3.4)
+      res = @iface.call(cmd, args[0])
+      # FIXME
+    end # def _get
+  end # class User
+end # module Bugzilla

data/lib/bugzilla/utils.rb

@@ -0,0 +1,53 @@
+module Bugzilla
+  module Utils
+    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
+      [proxy_host, proxy_port]
+    end
+
+    def get_xmlrpc(conf = {}, opts = {})
+      info = conf
+      uri = URI.parse(info[:URL])
+      host = uri.host
+      port = uri.port
+      path = uri.path.empty? ? nil : uri.path
+      proxy_host, proxy_port = get_proxy(info)
+      timeout = opts[:timeout].nil? ? 60 : opts[:timeout]
+      yield host if block_given? # if you want to run some pre hook
+      xmlrpc = XMLRPC.new(host, port: port, path: path, proxy_host:
+                                    proxy_host, proxy_port: proxy_port, timeout:
+                                    timeout, http_basic_auth_user: uri.user,
+                                http_basic_auth_pass: uri.password, debug: opts[:debug])
+      [xmlrpc, host]
+    end
+    def read_config(opts)
+      fname = opts[:config].nil? ? @defaultyamlfile : opts[:config]
+      begin
+        # TODO: fix config file
+        # Psych doesnt allow Symbol as class
+        # conf = YAML.safe_load(File.open(fname).read)
+        conf = YAML.load(File.open(fname).read)
+      rescue Errno::ENOENT
+        conf = {}
+      end
+      conf.each do |_k, v|
+        load(v[:Plugin]) if v.is_a?(Hash) && v.include?(:Plugin)
+      end
+      conf
+    end # def read_config
+
+    def save_config(opts, conf)
+      fname = opts[:config].nil? ? @defaultyamlfile : opts[:config]
+      if File.exist?(fname)
+        st = File.lstat(fname)
+        if st.mode & 0o600 != 0o600
+          raise format('The permissions of %s has to be 0600', fname)
+        end
+      end
+      File.open(fname, 'w') { |f| f.chmod(0o600); f.write(conf.to_yaml) }
+    end # def save_config
+  end
+end