bicho 0.0.10 → 0.0.12

data/lib/bicho/bug.rb

@@ -1,6 +1,7 @@
 require 'bicho/query'
 
 module Bicho
+  # A single bug inside a bugzilla instance.
   class Bug
     # ActiveRecord like interface
     #
@@ -86,10 +87,15 @@ module Bicho
       @client.get_history(id).first
     end
 
+    # @return [Array<Attachment>] attachments for this bug
+    def attachments
+      @client.get_attachments(id)
+    end
+
     # @param format_string For Kernel#sprintf; named params supplied by the bug
     def format(format_string)
-      sym_data = Hash[@data.to_a.map { |k, v| [k.to_sym, v]}]
-      sprintf(format_string, sym_data)
+      sym_data = Hash[@data.to_a.map { |k, v| [k.to_sym, v] }]
+      Kernel.format(format_string, sym_data)
     end
   end
 end

data/lib/bicho/cli/command.rb

@@ -78,8 +78,8 @@ module Bicho
       # with current ARGV
       def parse_options
         self.class.parser = Trollop::Parser.new unless self.class.parser
-        opts = Trollop.with_standard_exception_handling(self.class.parser) do
-          o = self.class.parser.parse ARGV
+        Trollop.with_standard_exception_handling(self.class.parser) do
+          self.class.parser.parse ARGV
         end
       end
 
@@ -88,7 +88,7 @@ module Bicho
       end
 
       def do(_opts, _args)
-        fail RuntimeError, "No implementation for #{self.class}" if self.class =~ /CommandTemplate/
+        raise "No implementation for #{self.class}" if self.class =~ /CommandTemplate/
       end
     end
   end

data/lib/bicho/cli/commands/attachments.rb

@@ -0,0 +1,75 @@
+#--
+# Copyright (c) 2011 SUSE LINUX Products GmbH
+#
+# Author: Duncan Mac-Vicar P. <dmacvicar@suse.de>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+require 'bicho/cli/command'
+require 'bicho/client'
+
+module Bicho::CLI::Commands
+  # Command to display bug information.
+  class Attachments < ::Bicho::CLI::Command
+    private
+
+    # check for supportconfigs and download
+    def download(bug, supportconfig_only)
+      bug.attachments.each do |attachment|
+        filename = "bsc#{bug.id}-#{attachment.id}-#{attachment.props['file_name']}"
+        if supportconfig_only
+          next unless attachment.content_type == 'application/x-gzip' ||
+                      attachment.content_type == 'application/x-bzip-compressed-tar'
+          next unless attachment.summary =~ /supportconfig/i
+        end
+        t.say("Downloading to #{t.color(filename, :even_row)}")
+        begin
+          data = attachment.data
+          File.open(filename, 'w') do |f|
+            f.write data.read
+          end
+        rescue StandardError => e
+          t.say("#{t.color('Error:', :error)} Download of #{filename} failed: #{e}")
+          raise
+        end
+      end
+    end
+
+    public
+
+    options do
+      opt :download, 'Download attachments'
+      opt :supportconfig, 'Only download supportconfig attachments'
+    end
+
+    def do(global_opts, opts, args)
+      client = ::Bicho::Client.new(global_opts[:bugzilla])
+      client.get_bugs(*args).each do |bug|
+        if opts[:download]
+          download(bug, opts[:supportconfig])
+        else
+          t.say("Bug #{t.color(bug.id.to_s, :headline)} has #{bug.attachments.size} attachments")
+        end
+      end
+      0
+    end
+  end
+end

data/lib/bicho/cli/commands/history.rb

@@ -31,7 +31,6 @@ module Bicho::CLI::Commands
   # command that shows the history colored as a
   # changelog
   class History < ::Bicho::CLI::Command
-
     def do(global_opts, _opts, args)
       client = ::Bicho::Client.new(global_opts[:bugzilla])
       client.get_history(*args).each do |history|

data/lib/bicho/cli/commands/search.rb

@@ -30,6 +30,7 @@ require 'bicho/query'
 require 'pp'
 
 module Bicho::CLI::Commands
+  # Command to search for bugs.
   class Search < ::Bicho::CLI::Command
     options do
       # add all fields as command line options of this command

data/lib/bicho/cli/commands/show.rb

@@ -27,9 +27,10 @@ require 'bicho/cli/command'
 require 'bicho/client'
 
 module Bicho::CLI::Commands
+  # Command to display bug information.
   class Show < ::Bicho::CLI::Command
     options do
-      opt :format, "Format string, eg. '%{id}:%{priority}:%{summary}'", :type => :string
+      opt :format, "Format string, eg. '%{id}:%{priority}:%{summary}'", type: :string
     end
 
     def do(global_opts, opts, args)

data/lib/bicho/cli/commands/version.rb

@@ -26,6 +26,7 @@
 require 'bicho/cli/command'
 
 module Bicho::CLI::Commands
+  # Command to display Bicho's version.
   class Version < ::Bicho::CLI::Command
     def do(_global_opts, _opts, _args)
       t.say(Bicho::VERSION)

data/lib/bicho/client.rb

@@ -29,6 +29,7 @@ require 'nokogiri'
 require 'net/https'
 require 'cgi'
 
+require 'bicho/attachment'
 require 'bicho/bug'
 require 'bicho/history'
 require 'bicho/query'
@@ -54,6 +55,7 @@ class XMLRPC::Client
 end
 
 module Bicho
+  # Plugins are defined inside this module
   module Plugins
   end
 
@@ -85,7 +87,7 @@ module Bicho
     # APIs
     def url
       warn 'url is deprecated. Use site_url or api_url'
-      fail NoMethodError
+      raise NoMethodError
     end
 
     # @param [String] site_url Bugzilla installation site url
@@ -104,7 +106,7 @@ module Bicho
       end
 
       # If the default url is still null, we can't continue
-      fail ArgumentError, 'missing bugzilla site' if site_url.nil?
+      raise ArgumentError, 'missing bugzilla site' if site_url.nil?
 
       @plugins.each do |pl_instance|
         if pl_instance.respond_to?(:transform_site_url_hook)
@@ -132,7 +134,7 @@ module Bicho
 
       # User.login sets the credentials cookie for subsequent calls
       if @client.user && @client.password
-        ret = @client.call('User.login',  'login' => @client.user, 'password' => @client.password, 'remember' => 0)
+        ret = @client.call('User.login', 'login' => @client.user, 'password' => @client.password, 'remember' => 0)
         handle_faults(ret)
         @userid = ret['id']
       end
@@ -144,14 +146,13 @@ module Bicho
       plugin_glob = File.join(File.dirname(__FILE__), 'plugins', '*.rb')
       Dir.glob(plugin_glob).each do |plugin|
         logger.debug("Loading file: #{plugin}")
-        load plugin
+        require plugin
       end
     end
 
     # instantiate all plugin classes in the Bicho::Plugins
     # module and add them to the list of known plugins
     def instantiate_plugins!
-      # instantiate plugins
       ::Bicho::Plugins.constants.each do |cnt|
         pl_class = ::Bicho::Plugins.const_get(cnt)
         pl_instance = pl_class.new
@@ -176,8 +177,9 @@ module Bicho
     def version
       ret = @client.call('Bugzilla.version')
       handle_faults(ret)
-      ret["version"]
+      ret['version']
     end
+
     # Search for a bug
     #
     # +query+ has to be either a +Query+ object or
@@ -212,9 +214,7 @@ module Bicho
     # @private
     # @returns [Array<String>] list of bugs
     def fetch_named_query_url(url, redirects_left)
-      unless @userid
-        fail 'You need to be authenticated to use named queries'
-      end
+      raise 'You need to be authenticated to use named queries' unless @userid
       http = Net::HTTP.new(@api_url.host, @api_url.port)
       http.set_debug_output(Bicho::LoggerIODevice.new)
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
@@ -238,14 +238,14 @@ module Bicho
         end
       when Net::HTTPRedirection
         location = response['location']
-        if (redirects_left == 0)
-          fail "Maximum redirects exceeded (redirected to #{location})"
+        if redirects_left == 0
+          raise "Maximum redirects exceeded (redirected to #{location})"
         end
         new_location_uri = URI.parse(location)
         logger.debug("Moved to #{new_location_uri}")
         fetch_named_query_url(new_location_uri, redirects_left - 1)
       else
-        fail "Error when expanding named query '#{url.request_uri}': #{response}"
+        raise "Error when expanding named query '#{url.request_uri}': #{response}"
       end
     end
 
@@ -288,7 +288,7 @@ module Bicho
       end.flatten
 
       histories = []
-      ret = @client.call("Bug.history", params)
+      ret = @client.call('Bug.history', params)
       handle_faults(ret)
       ret['bugs'].each do |history_data|
         histories << History.new(self, history_data)
@@ -296,5 +296,28 @@ module Bicho
       histories
     end
 
+    # @return [Array<Attachment>] a list of attachments for the
+    # given bugs.
+    #
+    # Payload is lazy-loaded
+    def get_attachments(*ids)
+      params = {}
+      params[:ids] = ids.collect(&:to_s).map do |what|
+        if what =~ /^[0-9]+$/
+          next what.to_i
+        else
+          next expand_named_query(what)
+        end
+      end.flatten
+
+      ret = @client.call('Bug.attachments',
+                         params.merge(exclude_fields: ['data']))
+      handle_faults(ret)
+      ret['bugs'].map do |_, attachments_data|
+        attachments_data.map do |attachment_data|
+          Attachment.new(self, @client, attachment_data)
+        end
+      end.flatten
+    end
   end
 end

data/lib/bicho/common_client.rb

@@ -24,6 +24,7 @@
 #++
 require 'logger'
 
+# All classes go into this module.
 module Bicho
   # This module allows the [Bug] and other
   # classes to offer an ActiveRecord like query
@@ -35,7 +36,7 @@ module Bicho
     end
 
     def self.common_client
-      @common_client || (fail 'No common client set')
+      @common_client ||= (raise 'No common client set')
     end
 
     def common_client

data/lib/bicho/ext/logger_colors.rb

@@ -3,47 +3,46 @@
 
 require 'logger'
 
+# Utility class to color output.
 class Logger
   module Colors
-    VERSION = '1.0.0'
+    VERSION = '1.0.0'.freeze
 
-    NOTHING      = '0;0'
-    BLACK        = '0;30'
-    RED          = '0;31'
-    GREEN        = '0;32'
-    BROWN        = '0;33'
-    BLUE         = '0;34'
-    PURPLE       = '0;35'
-    CYAN         = '0;36'
-    LIGHT_GRAY   = '0;37'
-    DARK_GRAY    = '1;30'
-    LIGHT_RED    = '1;31'
-    LIGHT_GREEN  = '1;32'
-    YELLOW       = '1;33'
-    LIGHT_BLUE   = '1;34'
-    LIGHT_PURPLE = '1;35'
-    LIGHT_CYAN   = '1;36'
-    WHITE        = '1;37'
+    NOTHING      = '0;0'.freeze
+    BLACK        = '0;30'.freeze
+    RED          = '0;31'.freeze
+    GREEN        = '0;32'.freeze
+    BROWN        = '0;33'.freeze
+    BLUE         = '0;34'.freeze
+    PURPLE       = '0;35'.freeze
+    CYAN         = '0;36'.freeze
+    LIGHT_GRAY   = '0;37'.freeze
+    DARK_GRAY    = '1;30'.freeze
+    LIGHT_RED    = '1;31'.freeze
+    LIGHT_GREEN  = '1;32'.freeze
+    YELLOW       = '1;33'.freeze
+    LIGHT_BLUE   = '1;34'.freeze
+    LIGHT_PURPLE = '1;35'.freeze
+    LIGHT_CYAN   = '1;36'.freeze
+    WHITE        = '1;37'.freeze
 
     SCHEMA = {
       STDOUT => %w(nothing green brown red purple cyan),
       STDERR => %w(nothing green yellow light_red light_purple light_cyan)
-    }
+    }.freeze
   end
-end
 
-class Logger
-  alias_method :format_message_colorless, :format_message
+  alias format_message_colorless format_message
 
   def format_message(level, *args)
     if Logger::Colors::SCHEMA[@logdev.dev]
       color = begin
         Logger::Colors.const_get \
-          Logger::Colors::SCHEMA[@logdev.dev][Logger.const_get(level.sub 'ANY', 'UNKNOWN')].to_s.upcase
+          Logger::Colors::SCHEMA[@logdev.dev][Logger.const_get(level.sub('ANY', 'UNKNOWN'))].to_s.upcase
       rescue NameError
         '0;0'
       end
-      "\e[#{ color }m#{ format_message_colorless(level, *args) }\e[0;0m"
+      "\e[#{color}m#{format_message_colorless(level, *args)}\e[0;0m"
     else
       format_message_colorless(level, *args)
     end

data/lib/bicho/history.rb

@@ -25,6 +25,9 @@
 require 'stringio'
 
 module Bicho
+  # Represents a single change inside a bug.
+  # History has multiple ChangeSets, and they have
+  # multiple changes.
   class Change
     def field_name
       @data['field_name']
@@ -51,17 +54,19 @@ module Bicho
     end
   end
 
+  # A collection of related changes.
   class ChangeSet
-
     include Enumerable
 
+    # return [Date] The date the bug activity/change happened.
+    # @deprecated Use {#timestamp} instead
     def date
       warn 'Deprecated. Use timestamp instead'
       timestamp
     end
 
     # return [Date] The date the bug activity/change happened.
-    def date
+    def timestamp
       @data['when'].to_date
     end
 
@@ -98,7 +103,10 @@ module Bicho
 
     # iterate over each changeset
     def each
-      changesets.each
+      return enum_for(:each) unless block_given?
+      changesets.each do |c|
+        yield c
+      end
     end
 
     # @return [Fixnum] number of changesets
@@ -122,9 +130,7 @@ module Bicho
 
     # @return [String] The numeric id of the bug
     def bug
-      unless @bug
-        @bug = @client.get_bug(@data['id'])
-      end
+      @bug = @client.get_bug(@data['id']) unless @bug
       @bug
     end
 

data/lib/bicho/logging.rb

@@ -26,6 +26,7 @@ require 'logger'
 require 'bicho/ext/logger_colors'
 
 module Bicho
+  # All logging related classes go into this module.
   module Logging
     class << self
       attr_writer :logger

data/lib/bicho/plugins/aliases.rb

@@ -1,6 +1,6 @@
 module Bicho
   module Plugins
-
+    # This plugin allows to specify shortcuts for bugzilla urls
     class Aliases
       def transform_site_url_hook(url, _logger)
         case url.to_s
@@ -11,6 +11,5 @@ module Bicho
         end
       end
     end
-
   end
 end