bicho 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c310b39555e503cc2b2499c20dc1bf39305448e0
-  data.tar.gz: 7c75e72001d044b19ae518903739d61199895a50
+  metadata.gz: 4a0d062e368708076439568e705310a5434de9ba
+  data.tar.gz: 7bf1e89725b8870dd8d87d5b5f5747b419cbd284
 SHA512:
-  metadata.gz: e9e7ad0a98e5dfdaf9ab6fd038927b8f4256e415b6841f236d8574db19636bf8db052dbb581d850bd1362e1981b874e7a3cd1535caa1f0ca6e46064755e0a991
-  data.tar.gz: f10639f87f15b62b106150b11321e7b840bd69c487ec46212b795578cabb4db47c626f8dfefdce18cb43a9707bb296a45bfa842696d421934e74d2fbfdf27ea4
+  metadata.gz: 12e08de436746cfb6c9453ea300a24571a686848ed15c882c51a49f7fc0d85b8f00d45d51db05b8d28917e36231c9581491ae377e137afb40a4026af922d92f8
+  data.tar.gz: 00bd9161bc8120b63570dd6d8f7d9fdd0fd878bfe4cbbf8a0d415ddbdecb1920f64cd1dc2f4873a2cc5323b69cfb1c7851e53485bd7e6bb7441a9d68827f319e

data/.rubocop.yml

@@ -1,117 +1,45 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-12-19 12:45:53 +0100 using RuboCop version 0.27.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# Configuration parameters: AlignWith, SupportedStyles.
-Lint/DefEndAlignment:
+Metrics/AbcSize:
   Enabled: false
+  Max: 41
 
-# Offense count: 1
-Lint/RescueException:
+Metrics/ClassLength:
   Enabled: false
+  Max: 182
 
-# Offense count: 3
-Lint/UselessAssignment:
+Metrics/CyclomaticComplexity:
   Enabled: false
+  Max: 11
 
-# Offense count: 8
-Metrics/AbcSize:
-  Max: 43
-
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 133
-
-# Offense count: 41
-# Configuration parameters: AllowURI, URISchemes.
+# Offense count: 49
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
 Metrics/LineLength:
   Max: 356
 
-# Offense count: 13
-# Configuration parameters: CountComments.
 Metrics/MethodLength:
   Enabled: false
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/BlockComments:
-  Enabled: false
-
-# Offense count: 2
-Style/ClassAndModuleCamelCase:
+Metrics/PerceivedComplexity:
   Enabled: false
 
-# Offense count: 5
-# Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/ClassAndModuleChildren:
-  Enabled: false
-
-# Offense count: 17
-Style/Documentation:
-  Enabled: false
-
-# Offense count: 13
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/EmptyLinesAroundClassBody:
-  Enabled: false
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/EmptyLinesAroundMethodBody:
-  Enabled: false
+  Exclude:
+    # CLI plugins
+    - 'lib/bicho/cli/commands/*.rb'
+    - 'lib/bicho/client.rb'
 
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/EmptyLinesAroundModuleBody:
-  Enabled: false
-
-# Offense count: 2
-# Configuration parameters: MinBodyLength.
 Style/GuardClause:
-  Enabled: false
+  Exclude:
+    - 'lib/bicho/client.rb'
 
-# Offense count: 4
-# Configuration parameters: MaxLineLength.
-Style/IfUnlessModifier:
-  Enabled: false
-
-# Offense count: 1
 # Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: snake_case, camelCase
 Style/MethodName:
-  Enabled: false
+  Exclude:
+    # L3 method
+    - 'lib/bicho/query.rb'
 
-# Offense count: 7
+# Offense count: 3
 # Cop supports --auto-correct.
 Style/NumericLiterals:
   MinDigits: 7
-
-# Offense count: 1
-Style/RedundantException:
-  Enabled: false
-
-# Offense count: 1
-Style/RescueModifier:
-  Enabled: false
-
-# Offense count: 6
-# Cop supports --auto-correct.
-Style/SpaceInsideBrackets:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/StringLiterals:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/TrailingWhitespace:
-  Enabled: true

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.2.5
+script:
+  - bundle exec rake test
+  - bundle exec rubocop

data/{README.rdoc → README.md}

@@ -1,15 +1,19 @@
-= Bicho
+# Bicho
 
 * http://github.com/dmacvicar/bicho
 
-== Introduction
+![stable](https://img.shields.io/badge/stability-stable-green.svg)
+![maintained](https://img.shields.io/maintenance/yes/2016.svg)
+[![Build Status](https://travis-ci.org/dmacvicar/bicho.svg?branch=master)](https://travis-ci.org/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
+## Features
 
 Main use case is report generation, therefore only the following
 features are implemented right now:
@@ -19,62 +23,72 @@ features are implemented right now:
 
 Plugins can be written to deal with specific bugzilla installations.
 
-== Example (API)
+## Example (API)
 
-=== Client API
+### Client API
 
-    require 'bicho'
+```ruby
+require 'bicho'
 
-    server = Bicho::Client.new('http://bugzilla.gnome.org')
-    server.get_bugs(127043).each do |bug|
-      puts bug.summary
-      puts bug.url
+server = Bicho::Client.new('http://bugzilla.gnome.org')
+server.get_bugs(127043).each do |bug|
+  puts bug.summary
+  puts bug.url
 
-      puts bug.history
-    end
+  puts bug.history
+end
+```
 
 You can give more than one bug or a named query, or both:
 
-    server.get_bugs(127043, 432423) => [....]
-    server.get_bugs("Named list") => [....]
-    server.get_bugs("Named list", 4423443) => [....]
+```ruby
+server.get_bugs(127043, 432423) => [....]
+server.get_bugs("Named list") => [....]
+server.get_bugs("Named list", 4423443) => [....]
+```
 
-=== ActiveRecord-like API
+### ActiveRecord-like API
 
 To use the ActiveRecord like interface over the +Bug+ class, you need first
 to set the Bicho common client:
 
-    require 'bicho'
+```ruby
+require 'bicho'
 
-    Bicho.client = Bicho::Client.new('https://bugzilla.gnome.org')
+Bicho.client = Bicho::Client.new('https://bugzilla.gnome.org')
 
-    Bicho::Bug.where(product: 'vala', status: 'resolved').each do |bug|
-      # .. do something with bug
-    end
+Bicho::Bug.where(product: 'vala', status: 'resolved').each do |bug|
+  # .. do something with bug
+end
+```
 
-    Or alternatively:
+Or alternatively:
 
-    Bicho::Bug.where.product('vala').status('resolved').each do |bug|
-      # .. do something with bug
-    end
+```ruby
+Bicho::Bug.where.product('vala').status('resolved').each do |bug|
+  # .. do something with bug
+end
+```
 
-== Example (CLI)
+## Example (CLI)
 
-    bicho -b http://bugzilla.gnome.org show 127043
+```console
+bicho -b http://bugzilla.gnome.org show 127043
 
-    bicho -b gnome history 127043
+bicho -b gnome history 127043
 
-    bicho -b gnome search --summary "crash"
+bicho -b gnome search --summary "crash"
 
-    bicho -b gnome search --help
+bicho -b gnome search --help
+```
 
-== Authentication
+## Authentication
 
 For SUSE/Novell Bugzilla, a plugin loads the credentials from '~/.oscrc'.
 
 Otherwise, use the 'username:password@' part of the API URL.
 
-== Customizing Bicho: the user.rb plugin.
+## Customizing Bicho: the user.rb plugin.
 
 Plugins are included that provide shortcuts for the most common bugzilla sites.
 
@@ -83,13 +97,15 @@ There is a "user" plugin that does some of these shortcuts from a configuration
 The settings are read from '.config/bicho/config.yml'. There you can specify the default
 bugzilla site to use when none is specified and custom aliases.
 
-    aliases:
-      mysite: http://bugzilla.site.com
-    default: mysite
+```yml
+aliases:
+    mysite: http://bugzilla.site.com
+default: mysite
+```
 
-== Extending Bicho
+## Extending Bicho
 
-=== Plugins
+### Plugins
 
 Plugins are classes in the module Bicho::Plugins. They can implement hooks that are
 called at different points of execution.
@@ -111,26 +127,26 @@ called at different points of execution.
   The API url is derived from the site url, however some bugzilla installations may have
   different servers or endpoints.
 
-=== Commands
+### Commands
 
 See the +Command+ class to implement more commands.
 
-== Known issues
+## 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
+## Roadmap
 
 * Define the plugin hooks, right now there is one :-)
 * Shortcuts for the bugzilla URL (bicho -b bko search ..), a plugin?
 
-== Authors
+## Authors
 
 * Duncan Mac-Vicar P. <dmacvicar@suse.de>
 
-== License
+## License
 
 Copyright (c) 2011-2015 SUSE LLC
 

data/Rakefile

@@ -8,10 +8,8 @@ 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
+  t.test_files = Dir.glob(File.join(Dir.pwd, '/test/test_*.rb'))
+  t.verbose = true if ENV['DEBUG']
 end
 
 begin
@@ -20,12 +18,12 @@ begin
     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
+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

@@ -17,6 +17,11 @@ Gem::Specification.new do |s|
   s.add_dependency('highline', ['~> 1.6.2'])
   s.add_dependency('nokogiri')
 
+  s.add_development_dependency('rake')
+  s.add_development_dependency('minitest')
+  s.add_development_dependency('minitest-reporters')
+  s.add_development_dependency('rubocop')
+
   s.rubyforge_project = 'bicho'
 
   s.files         = `git ls-files`.split("\n")

data/bin/bicho

@@ -34,9 +34,9 @@ ft = HighLine::ColorScheme.new do |cs|
   cs[:even_row]        = [:green]
   cs[:odd_row]         = [:magenta]
   cs[:error]           = [:red]
-  cs[:remove]           = [ :red ]
-  cs[:add]           = [ :green ]
-  cs[:changeset]           = [ :blue ]
+  cs[:remove] = [:red]
+  cs[:add] = [:green]
+  cs[:changeset] = [:blue]
 end
 
 HighLine.color_scheme = ft
@@ -75,7 +75,11 @@ EOS
   Bicho::Logging.logger.level = Logger::DEBUG if global_opts[:debug]
 
   # get the subcommand
-  cmd = ARGV.shift rescue nil
+  cmd = begin
+          ARGV.shift
+        rescue
+          nil
+        end
 
   if !cmd || !SUB_COMMANDS.include?(cmd)
     Trollop.die "available subcommands: #{SUB_COMMANDS.join(' ')}"
@@ -88,7 +92,7 @@ EOS
   opts = cmd_instance.parse_options
 
   ret = cmd_instance.do(global_opts, opts, ARGV)
-rescue Exception => e
+rescue StandardError => e
   Bicho::Logging.logger.error e.message
   Bicho::Logging.logger.error e.backtrace
   t.say("#{t.color('ERROR: ', :error)} #{t.color(e.message, :bold)}")

data/lib/bicho.rb

@@ -29,6 +29,7 @@ require 'bicho/logging'
 require 'bicho/client'
 require 'bicho/bug'
 
+# All classes of the Bicho library belong to this module.
 module Bicho
   SEARCH_FIELDS = [
     # name, type, description, multi
@@ -55,5 +56,5 @@ module Bicho
     [: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]
-  ]
+  ].freeze
 end

data/lib/bicho/attachment.rb

@@ -0,0 +1,72 @@
+#--
+# Copyright (c) 2016 SUSE LLC
+#
+# 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 'stringio'
+
+module Bicho
+  # Represents an attachment object for a given bug
+  class Attachment
+    attr_reader :props
+
+    def initialize(client, xmlrpc_client, props)
+      @client = client
+      @xmlrpc_client = xmlrpc_client
+      @props = props
+    end
+
+    # @return [Fixnum] attachment id
+    def id
+      props['id'].to_i
+    end
+
+    # @return [Fixnum] attachment bug id
+    def bug_id
+      props['bug_id'].to_i
+    end
+
+    # @return [String] attachment content type
+    def content_type
+      props['content_type']
+    end
+
+    # @return [Fixnum] attachment size
+    def size
+      props['size'].to_i
+    end
+
+    # @return [String] attachment summary
+    def summary
+      props['summary']
+    end
+
+    # @return [StringIO] attachmentdata
+    # This will be loaded lazyly every time called
+    def data
+      ret = @xmlrpc_client.call('Bug.attachments',
+                                attachment_ids: [id], include_fields: ['data'])
+      @client.handle_faults(ret)
+      StringIO.new(ret['attachments'][id.to_s]['data'])
+    end
+  end
+end