bicho 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.yardoc
+*.rbc
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in bicho.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 SUSE LINUX Products GmbH
+
+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.

data/README.rdoc

@@ -0,0 +1,86 @@
+= Bicho
+
+* http://github.com/dmacvicar/bicho
+
+== Introduction
+
+Library to access bugzilla and command line tool.
+
+Its main goal is to be clean and provide a command line tool
+that exposes its features.
+
+== Features
+
+Main use case is report generation, therefore only the following
+features are implemented right now:
+
+* get a bug
+* search bugs
+
+Plugins can be written to deal with specific bugzilla installations.
+
+== Example (API)
+
+=== Client API
+
+    require 'bicho'
+
+    server = Bicho::Client.new('http://bugzilla.gnome.org')
+    server.get(127043).each do |bug|
+      puts bug.summary
+      puts bug.url
+    end
+
+=== ActiveRecord-like API
+
+To use the ActiveRecord like interface over the +Bug+ class, you need first
+to set the Bicho common client:
+
+    require 'bicho'
+
+    Bicho.client = Bicho::Client.new('https://bugzilla.gnome.org')
+
+    Bicho::Bug.where(:product => "vala", :status => "resolved").each do |bug|
+      # .. do something with bug
+    end
+
+    Or alternatively:
+
+    Bicho::Bug.where.product("vala").status("resolved").each do |bug|
+      # .. do something with bug
+    end
+
+== Example (CLI)
+
+    bicho -b http://bugzilla.gnome.org show 127043
+
+    bicho -b https://bugzilla.gnome.org search --summary "crash"
+
+    bicho -b https://bugzilla.gnome.org search --help
+
+== Extending Bicho
+
+=== Commands
+
+See the +Command+ class to implement more commands.
+
+== Known issues
+
+* For now bugs respond to the bugs attributtes described in
+http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html, I intend to make those real attributes.
+* There is no check if an API is supported on the server side
+
+== Roadmap
+
+* Define the plugin hooks, right now there is one :-)
+* Shortcuts for the bugzilla URL (bicho -b bko search ..), a plugin?
+
+== Authors
+
+* Duncan Mac-Vicar P. <dmacvicar@suse.de>
+
+== License
+
+Copyright (c) 2011 SUSE LINUX Products GmbH.
+
+Bicho is licensed under the MIT license. See MIT-LICENSE for details.

data/Rakefile

@@ -0,0 +1,31 @@
+$:.push(File.join(File.dirname(__FILE__), 'lib'))
+require 'bundler/gem_tasks'
+require 'bicho/version'
+require 'rake/testtask'
+
+extra_docs = ['README*', 'TODO*', 'CHANGELOG*']
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << File.expand_path('../test', __FILE__)
+  t.libs << File.expand_path('../', __FILE__)
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+begin
+ require 'yard'
+  YARD::Rake::YardocTask.new(:doc) do |t|
+    t.files   = ['lib/**/*.rb', *extra_docs]
+    t.options = ['--no-private']
+  end
+rescue LoadError
+  STDERR.puts "Install yard if you want prettier docs"
+  require 'rdoc/task'
+  Rake::RDocTask.new(:doc) do |rdoc|
+    rdoc.rdoc_dir = "doc"
+    rdoc.title = "bicho #{Bicho::VERSION}"
+    extra_docs.each { |ex| rdoc.rdoc_files.include ex }
+  end
+end

data/bicho.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bicho/version"
+
+Gem::Specification.new do |s|
+  s.name        = "bicho"
+  s.version     = Bicho::VERSION
+  s.authors     = ["Duncan Mac-Vicar P."]
+  s.email       = ["dmacvicar@suse.de"]
+  s.homepage    = ""
+  s.summary     = %q{Library to access bugzilla}
+  s.description = %q{Library to access bugzilla}
+
+  s.add_dependency("inifile", ["~> 0.4.1"])
+  s.add_dependency("trollop", [">= 1.16"])
+  s.add_dependency("highline", ["~> 1.6.2"])
+
+
+  s.rubyforge_project = "bicho"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/bin/bicho

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+#--
+# 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.
+#++
+$:.push(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'bicho'
+require 'highline/import'
+
+# Set the console color scheme
+ft = HighLine::ColorScheme.new do |cs|
+  cs[:headline]        = [ :bold ]
+  cs[:horizontal_line] = [ :bold, :white ]
+  cs[:even_row]        = [ :green ]
+  cs[:odd_row]         = [ :magenta ]
+  cs[:error]           = [ :red ]
+end
+
+HighLine.color_scheme = ft
+# Our 'terminal' object
+t = HighLine.new
+
+# Scan all installed pluggable commands
+Dir.glob(File.join(File.dirname(__FILE__), '..', 'lib', 'bicho', 'cli', 'commands', '*.rb')).each do |cmd|
+  load cmd
+end
+
+# Setup a logger and connect it with stupid libraries
+# that can't use a logger
+Bicho::Logging.logger = Logger.new(STDERR)
+# Don't show by default anything
+Bicho::Logging.logger.level = Logger::FATAL
+
+ret = 0
+begin
+  # create subcommands automatically from the available
+  # symbols in BzConsole module
+  SUB_COMMANDS = Bicho::CLI::Commands.constants.sort.map(&:to_s).map(&:downcase)
+
+  global_opts = Trollop::options do
+    banner <<-EOS
+    Usage: #{File.basename(__FILE__)} [global options] <command> ...
+
+    Bugzilla url can be given as https://bugs.kde.org or bko
+EOS
+    opt :config, "Read FILE as configuration file.", :type => :io
+    opt :debug, "Show debug messages", :default => false
+    opt :bugzilla, "Bugzilla URL or alias", :default => 'bnz'
+    stop_on SUB_COMMANDS
+  end
+
+  Bicho::Logging.logger.level = Logger::DEBUG if global_opts[:debug]
+
+  # get the subcommand
+  cmd = ARGV.shift rescue nil
+
+  if (!cmd || !SUB_COMMANDS.include?(cmd))
+    Trollop.die "available subcommands: #{SUB_COMMANDS.join(" ")}"
+  end
+
+  # Create an instance for the command
+  mod = Bicho::CLI::Commands
+  cmd_class = mod.const_get(cmd.capitalize)
+  cmd_instance = cmd_class.new
+  opts = cmd_instance.parse_options
+
+  ret = cmd_instance.do(global_opts, opts, ARGV)
+rescue Exception => e
+  Bicho::Logging.logger.error e.message
+  Bicho::Logging.logger.error e.backtrace
+  t.say("#{t.color('ERROR: ', :error)} #{t.color(e.message, :bold)}")
+  ret = 1
+end
+exit ret

data/lib/bicho.rb

@@ -0,0 +1,61 @@
+#--
+# 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 'rubygems'
+require 'logger'
+require 'bicho/version'
+require 'bicho/logging'
+require 'bicho/client'
+require 'bicho/bug'
+
+module Bicho
+
+  SEARCH_FIELDS = [
+    # name, type, description, multi
+    [ :alias, :strings, "The unique alias for this bug", true],
+    [ :assigned_to, :strings, "The login name of a user that a bug is assigned to.", true],
+    [ :component, :strings, "The name of the Component", true],
+    [ :creation_time, :string, "Searches for bugs that were created at this time or later.", false],
+    [ :id, :ints, "The numeric id of the bug.", true],
+    [ :last_change_time, :string, "Searches for bugs that were modified at this time or later.", false],
+    [ :limit, :ints, "Limit the number of results returned to int records.", true],
+    [ :offset, :ints, "Used in conjunction with the limit argument, offset defines the starting position for the search.", true],
+    [ :op_sys, :strings, "The 'Operating System' field of a bug.", true],
+    [ :platform, :strings, "The Platform field of a bug.", true],
+    [ :priority, :strings, "The Priority field on a bug.", true],
+    [ :product, :strings, "The name of the Product that the bug is in.", true],
+    [ :reporter, :strings, "The login name of the user who reported the bug.", true],
+    [ :resolution, :strings, "The current resolution--only set if a bug is closed.", true],
+    [ :severity, :strings, "The Severity field on a bug.", true],
+    [ :status, :strings, "The current status of a bug", true],
+    [ :summary, :strings, "Searches for substrings in the single-line Summary field on bugs.", true],
+    [ :target_milestone, :strings, "The Target Milestone field of a bug.", true],
+    [ :qa_contact, :strings, "The login name of the bug's QA Contact.", true],
+    [ :url, :strings, "The 'URL' field of a bug.", true],
+    [ :version, :strings, "The Version field of a bug.", true],
+    [ :votes, :ints, "Searches for bugs with this many votes or greater", false],
+    [ :whiteboard, :strings, "Search the 'Status Whiteboard' field on bugs for a substring.", true]
+  ]
+
+end

data/lib/bicho/bug.rb

@@ -0,0 +1,82 @@
+require 'bicho/query'
+
+module Bicho
+
+  class Bug
+
+    # ActiveRecord like interface
+    #
+    # @example Searching for bugs
+    #     Bug.where(:summary => "crash").each do |bug|
+    #       #...do something with bug
+    #     end
+    #
+    # Requires Bicho.client to be set
+    #
+    # @param [Hash] conds the conditions for the query.
+    # alias
+    # @option conds [String] The unique alias for this bug.
+    # @option conds assigned_to [String] The login name of a user that a bug is assigned to.
+    # @option conds component [String] The name of the Component that the bug is in.
+    # @option conds creation_time [DateTime] Searches for bugs that were created at this time or later. May not be an array.
+    # @option conds creator [String] The login name of the user who created the bug.
+    # @option conds id [Integer] The numeric id of the bug.
+    # @option conds last_change_time [DateTime] Searches for bugs that were modified at this time or later. May not be an array.
+    # @option conds limit [Integer] Limit the number of results returned to int records.
+    # @option conds offset [Integer] Used in conjunction with the limit argument, offset defines the starting position for the search. For example, given a search that would return 100 bugs, setting limit to 10 and offset to 10 would return bugs 11 through 20 from the set of 100.
+    # @option conds op_sys [String] The "Operating System" field of a bug.
+    # @option conds platform [String] The Platform (sometimes called "Hardware") field of a bug.
+    # @option conds priority [String] The Priority field on a bug.
+    # @option conds product [String] The name of the Product that the bug is in.
+    # @option conds creator [String] The login name of the user who reported the bug.
+    # @option conds resolution [String] The current resolution--only set if a bug is closed. You can find open bugs by searching for bugs with an empty resolution.
+    # @option conds severity [String] The Severity field on a bug.
+    # @option conds status [String] The current status of a bug (not including its resolution, if it has one, which is a separate field above).
+    # @option conds summary [String] Searches for substrings in the single-line Summary field on bugs. If you specify an array, then bugs whose summaries match any of the passed substrings will be returned.
+    # @option conds target_milestone [String] The Target Milestone field of a bug. Note that even if this Bugzilla does not have the Target Milestone field enabled, you can still search for bugs by Target Milestone. However, it is likely that in that case, most bugs will not have a Target Milestone set (it defaults to "---" when the field isn't enabled).
+    # @option conds qa_contact [String] The login name of the bug's QA Contact. Note that even if this Bugzilla does not have the QA Contact field enabled, you can still search for bugs by QA Contact (though it is likely that no bug will have a QA Contact set, if the field is disabled).
+    # @option conds url [String] The "URL" field of a bug.
+    # @option conds version [String] The Version field of a bug.
+    # @option conds whiteboard [String] Search the "Status Whiteboard" field on bugs for a substring. Works the same as the summary field described above, but searches the Status Whiteboard field.
+    #
+    # @return [Array]
+    #
+    # @see http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Bug.html#search bugzilla search API and allowed attributes
+    #
+    def self.where(conditions={})
+      return Query.new(conditions)
+    end
+
+    # Normally you will not use this constructor as
+    # bugs will be constructed by a query result
+    #
+    # @param client [Bicho::Client] client where this bug gets its data
+    # @param data [Hash] retrieved data for this bug
+    def initialize(client, data)
+      @client = client
+      @data = data
+    end
+
+    def method_missing(name, *args)
+      @data[name.to_s]
+    end
+
+    def id
+      # we define id to not get the deprecated
+      # warning of object_id
+      @data['id']
+    end
+
+    def to_s
+      "##{id} - #{summary} (#{url})"
+    end
+
+    # URL where the bug can be viewed
+    # Example: http://bugs.foo.com/2345
+    def url
+      "#{@client.url}/#{id}"
+    end
+
+  end
+
+end

data/lib/bicho/cli/command.rb

@@ -0,0 +1,99 @@
+#--
+# 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 'trollop'
+require 'highline'
+
+module Bicho
+
+  module CLI
+
+    # Bicho allows to easily add commands to the
+    # command line interface.
+    #
+    # In order to create a command, add a class under
+    # Bicho::CLI::Commands. Then you need to:
+    # * Add options, using a Trollop syntax
+    # * Implement do(global_opts, options, args)
+    #
+    # You can use t.say to talk to the terminal
+    # including all HighLine features.
+    #
+    # <tt>
+    # class Bicho::CLI::Commands::Hello < ::Bicho::CLI::Command
+    #   options do
+    #     opt :monkey, "Use monkey mode", :default => true
+    #     opt :text, "Name", :type => :string
+    #   end
+    #
+    #   def do(global_opts, opts, args)
+    #     t.say("Hello")
+    #   end
+    # end
+    # </tt>
+    #
+    class Command
+
+      include ::Bicho::Logging
+
+      class << self; attr_accessor :parser end
+
+      attr_accessor :t
+
+      def initialize
+        @t = HighLine.new
+      end
+
+      # Gateway to Trollop
+      def self.opt(*args)
+        self.parser = Trollop::Parser.new if not self.parser
+        self.parser.opt(*args)
+      end
+
+      # DSL method to describe a command's option
+      def self.options
+        yield
+      end
+
+      # Called by the cli to get the options
+      # with current ARGV
+      def parse_options
+        self.class.parser = Trollop::Parser.new if not self.class.parser
+        opts = Trollop::with_standard_exception_handling(self.class.parser) do
+          o = self.class.parser.parse ARGV
+        end
+      end
+
+      def parser
+        self.class.parser
+      end
+
+      def do(opts, args)
+        raise RuntimeError, "No implementation for #{self.class}" if self.class =~ /CommandTemplate/
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+#--
+# 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'
+require 'bicho'
+require 'bicho/query'
+require 'pp'
+
+module Bicho::CLI::Commands
+  class Search < ::Bicho::CLI::Command
+    options do
+      # add all fields as command line options of this command
+      Bicho::SEARCH_FIELDS.each do |field|
+        opt field[0], field[2], :type => field[1], :multi => field[3]
+      end
+    end
+
+    def do(global_opts, opts, args)
+      server = ::Bicho::Client.new(global_opts[:bugzilla])
+      # for most parameter we accept arrays, and also multi mode
+      # this means parameters come in arrays of arrays
+      query = ::Bicho::Query.new
+      opts.each do |n,v|
+        # skip any option that is not part of SEARCH_FIELDS
+        next if not Bicho::SEARCH_FIELDS.map { |x| x[0] }.include?(n)
+        next if v.nil? || v.flatten.empty?
+        v.flatten.each do |single_val|
+          query.send(n.to_sym, single_val)
+        end
+      end
+
+      server.search_bugs(query).each do |bug|
+        t.say("#{t.color(bug.id, :headline)} #{bug.summary}")
+      end
+      return 0
+    end
+
+  end
+end

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

@@ -0,0 +1,43 @@
+#--
+# 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
+  class Show < ::Bicho::CLI::Command
+    options do
+    end
+
+    def do(global_opts, opts, args)
+      client = ::Bicho::Client.new(global_opts[:bugzilla])
+      client.get_bugs(*args).each do |bug|
+        t.say("#{t.color(bug.id, :headline)} #{bug.summary}")
+      end
+      return 0
+    end
+
+  end
+end

data/lib/bicho/client.rb

@@ -0,0 +1,132 @@
+#--
+# 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 'inifile'
+require 'uri'
+require 'xmlrpc/client'
+
+require 'bicho/bug'
+require 'bicho/query'
+require 'bicho/logging'
+
+# Helper IO device that forwards to the logger, we use it
+# to debug XMLRPC by monkey patching it
+#
+# @private
+class Bicho::LoggerIODevice
+  def <<(msg)
+    Bicho::Logging.logger.debug(msg)
+  end
+end
+
+# monkey patch XMLRPC
+#
+# @private
+class XMLRPC::Client
+  def set_debug
+    @http.set_debug_output(Bicho::LoggerIODevice.new);
+  end
+end
+
+module Bicho
+
+  module Plugins
+  end
+
+  # Client to query bugzilla
+  class Client
+
+    include Bicho::Logging
+
+    attr_reader :url
+
+    def initialize(url)
+      url = URI.parse(url) if not url.is_a?(URI)
+      # save the unmodified (by plugins) url
+      @url = url.clone
+
+      url.path = '/xmlrpc.cgi'
+
+      # Scan plugins
+      plugin_glob = File.join(File.dirname(__FILE__), 'plugins', '*.rb')
+      Dir.glob(plugin_glob).each do |plugin|
+        logger.debug("Loading file: #{plugin}")
+        load plugin
+      end
+
+      #instantiate plugins
+      ::Bicho::Plugins.constants.each do |cnt|
+        pl_class = ::Bicho::Plugins.const_get(cnt)
+        pl_instance = pl_class.new
+        logger.debug("Loaded: #{pl_instance}")
+        pl_instance.initialize_hook(url, logger)
+      end
+
+      @client = XMLRPC::Client.new_from_uri(url.to_s, nil, 900)
+      @client.set_debug
+    end
+
+    def handle_faults(ret)
+      if ret.has_key?('faults')
+        ret['faults'].each do |fault|
+          logger.error fault
+        end
+      end
+    end
+
+    # Search for a bug
+    #
+    # +query+ has to be either a +Query+ object or
+    # a +String+ that will be searched in the summary
+    # of the bugs.
+    #
+    def search_bugs(query)
+      # allow plain strings to be passed, interpretting them
+      query = Query.new.summary(query) if query.is_a?(String)
+
+      ret = @client.call("Bug.search", query.query_map)
+      handle_faults(ret)
+      bugs = []
+      ret['bugs'].each do |bug_data|
+        bugs << Bug.new(self, bug_data)
+      end
+      bugs
+    end
+
+    # Retrieves one or more bugs by id
+    def get_bugs(*ids)
+      params = Hash.new
+      params[:ids] = ids.collect(&:to_s)
+
+      bugs = []
+      ret = @client.call("Bug.get", params)
+      handle_faults(ret)
+      ret['bugs'].each do |bug_data|
+        bugs << Bug.new(self, bug_data)
+      end
+      bugs
+    end
+
+  end
+end

data/lib/bicho/common_client.rb

@@ -0,0 +1,57 @@
+#--
+# 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 'logger'
+
+module Bicho
+  # This module allows the [Bug] and other
+  # classes to offer an ActiveRecord like query
+  # API by allowing to set a default [Client]
+  # to make operations.
+  module CommonClient
+    def self.common_client=(client)
+      @common_client = client
+    end
+
+    def self.common_client
+      @common_client || (raise "No common client set")
+    end
+
+    def common_client
+      CommonClient.common_client
+    end
+  end
+
+  # Sets the common client to be used by
+  # the library
+  def self.client=(client)
+    CommonClient.common_client = client
+  end
+
+  # Current client used by the library
+  def self.client
+    CommonClient.common_client
+  end
+
+end

data/lib/bicho/ext/logger_colors.rb

@@ -0,0 +1,53 @@
+# Colorizes the output of the standard library logger, depending on the logger level:
+# To adjust the colors, look at Logger::Colors::SCHEMA and Logger::Colors::constants
+
+require 'logger'
+
+class Logger
+  module Colors
+    VERSION = '1.0.0'
+
+    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'
+
+    SCHEMA = {
+      STDOUT => %w[nothing green brown red purple cyan],
+      STDERR => %w[nothing green yellow light_red light_purple light_cyan],
+    }
+  end
+end
+
+class Logger
+  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
+      rescue NameError
+        "0;0"
+      end
+      "\e[#{ color }m#{ format_message_colorless(level, *args) }\e[0;0m"
+    else
+      format_message_colorless(level, *args)
+    end
+  end
+end
+
+# J-_-L

data/lib/bicho/logging.rb

@@ -0,0 +1,44 @@
+#--
+# 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 'logger'
+require 'bicho/ext/logger_colors'
+
+module Bicho
+  module Logging
+
+    def self.logger=(logger)
+      @logger = logger
+    end
+
+    def self.logger
+      @logger ||= Logger.new('/dev/null')
+    end
+
+    def logger
+      Logging.logger
+    end
+
+  end
+end

data/lib/bicho/plugins/novell.rb

@@ -0,0 +1,76 @@
+#--
+# 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 'inifile'
+require 'uri'
+
+module Bicho
+  module Plugins
+
+    # Novell bugzilla is behind ichain
+    #
+    # Plugin that rewrites the bugzilla API url
+    # to the Novell internal endpoint without
+    # ichain.
+    #
+    # Also, it takes your credentials from
+    # your oscrc.
+    #
+    class Novell
+
+      OSCRC_CREDENTIALS = "https://api.opensuse.org"
+
+      def to_s
+        self.class.to_s
+      end
+
+      def self.oscrc_credentials
+        oscrc = IniFile.new(File.join(ENV['HOME'], '.oscrc'))
+        if oscrc.has_section?(OSCRC_CREDENTIALS)
+          user = oscrc[OSCRC_CREDENTIALS]['user']
+          pass = oscrc[OSCRC_CREDENTIALS]['pass']
+          if user && pass
+            return {:user => user, :password => pass}
+          else
+            raise "No .oscrc credentials for bnc"
+          end
+        end
+      end
+
+      def initialize_hook(url, logger)
+
+        return if not url.host.include?('bugzilla.novell.com')
+
+        auth = Novell.oscrc_credentials
+        url.user = auth[:user]
+        url.password = auth[:password]
+        url.host = url.host.gsub(/bugzilla\.novell.com/, 'apibugzilla.novell.com')
+        url.path = url.path.gsub(/xmlrpc\.cgi/, 'tr_xmlrpc.cgi')
+
+        logger.debug("#{self} : Rewrote url to '#{url.to_s.gsub(/#{url.user}:#{url.password}/, "USER:PASS")}'")
+      end
+
+    end
+  end
+end

data/lib/bicho/query.rb

@@ -0,0 +1,102 @@
+#--
+# 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/common_client'
+
+module Bicho
+
+  # Represents a bug search to the server and it can
+  # be configured with all bug attributes.
+  #
+  #
+  class Query
+
+    # Iterates through the result of the current query.
+    #
+    # @note Requires Bicho.client to be set
+    #
+    # @yield [Bicho::Bug]
+    def each
+      ret = Bicho.client.search_bugs(self)
+      return ret.each if not block_given?
+      ret.each { |bug| yield bug }
+     end
+
+    # obtains the parameter that can be passed to the XMLRPC API
+    # @private
+    attr_reader :query_map
+
+    # Create a query.
+    #
+    # @example query from a hash containing the attributes:
+    #   q = Query.new({:summary => "substring", :assigned_to => "foo@bar.com"})
+    #
+    # @example using chainable methods:
+    #   q = Query.new.assigned_to("foo@bar.com@).summary("some text")
+    #
+    def initialize(conditions={})
+      @query_map = conditions
+    end
+
+    # Query responds to all the bug search attributes.
+    #
+    # @see {Bug.where Allowed attributes}
+    def method_missing(name, *args)
+      args.each do |arg|
+        append_query(name.to_s, arg)
+      end
+      self
+    end
+
+    # Shortcut equivalent to status new, assigned, needinfo and reopened
+    def open
+      status(:new).status(:assigned).status(:needinfo).status(:reopened)
+    end
+
+    # Shortcut, equivalent to
+    #   :summary => "L3"
+    def L3
+      append_query("summary", "L3")
+      self
+    end
+
+    private
+    # Appends a parameter to the query map
+    #
+    # Only used internally.
+    #
+    # If the parameter already exists that parameter is converted to an
+    # array of values
+    #
+    # @private
+    def append_query(param, value)
+      if not @query_map.has_key?(param)
+        @query_map[param] = Array.new
+      end
+      @query_map[param] = value
+    end
+
+  end
+
+end

data/lib/bicho/version.rb

@@ -0,0 +1,3 @@
+module Bicho
+  VERSION = "0.0.1"
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+require 'test/unit'
+require 'bicho'
+
+if ENV["DEBUG"]
+  Bicho::Logging.logger = Logger.new(STDERR)
+  Bicho::Logging.logger.level = Logger::DEBUG
+end
+

data/test/test_query.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class Query_test < Test::Unit::TestCase
+
+  def test_active_record_style
+    # No client set yet
+    assert_raise RuntimeError do
+      Bicho::Bug.where.assigned_to("foo@bar.com").each do |bug|
+        puts bug
+      end
+    end
+
+    Bicho.client = Bicho::Client.new('https://bugzilla.gnome.org')
+
+    ret  = Bicho::Bug.where.product("vala").status("resolved").component("Basic Types").each.to_a
+    assert ret.collect(&:id).include?(645150)
+
+  end
+
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: bicho
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Duncan Mac-Vicar P.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: inifile
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 4
+        - 1
+        version: 0.4.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 1
+        - 16
+        version: "1.16"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  type: :runtime
+  version_requirements: *id003
+description: Library to access bugzilla
+email: 
+- dmacvicar@suse.de
+executables: 
+- bicho
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- bicho.gemspec
+- bin/bicho
+- lib/bicho.rb
+- lib/bicho/bug.rb
+- lib/bicho/cli/command.rb
+- lib/bicho/cli/commands/search.rb
+- lib/bicho/cli/commands/show.rb
+- lib/bicho/client.rb
+- lib/bicho/common_client.rb
+- lib/bicho/ext/logger_colors.rb
+- lib/bicho/logging.rb
+- lib/bicho/plugins/novell.rb
+- lib/bicho/query.rb
+- lib/bicho/version.rb
+- test/helper.rb
+- test/test_query.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: bicho
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Library to access bugzilla
+test_files: 
+- test/helper.rb
+- test/test_query.rb