ruby_bugzilla 0.2.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - rbx-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2013 Red Hat, Inc.
+
+
+MIT License
+
+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.md

@@ -0,0 +1,42 @@
+# RubyBugzilla
+
+
+[![Gem Version](https://badge.fury.io/rb/ruby_bugzilla.png)](http://badge.fury.io/rb/ruby_bugzilla)
+[![Build Status](https://travis-ci.org/ManageIQ/ruby_bugzilla.png)](https://travis-ci.org/ManageIQ/ruby_bugzilla)
+[![Code Climate](https://codeclimate.com/github/ManageIQ/ruby_bugzilla.png)](https://codeclimate.com/github/ManageIQ/ruby_bugzilla)
+[![Coverage Status](https://coveralls.io/repos/ManageIQ/ruby_bugzilla/badge.png?branch=master)](https://coveralls.io/r/ManageIQ/ruby_bugzilla)
+[![Dependency Status](https://gemnasium.com/ManageIQ/ruby_bugzilla.png)](https://gemnasium.com/ManageIQ/ruby_bugzilla)
+
+A Ruby wrapper around the python-bugzilla CLI for easy access to the Bugzilla API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby_bugzilla'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_bugzilla
+
+## Usage
+
+  If not already logged in to bugzilla, RubyBugzilla can login using
+  the crendentials in bugzilla_credentials.yaml
+  Copy sample/bugzilla_credentials.yaml to $HOME and edit the file
+  to contain your bugzilla credentials.
+
+  TODO: Write more usage instructions here
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :test => :spec
+task :default => :spec

data/lib/ruby_bugzilla/version.rb

@@ -0,0 +1,3 @@
+class RubyBugzilla
+  VERSION = "0.2.0"
+end

data/lib/ruby_bugzilla.rb

@@ -0,0 +1,144 @@
+require 'yaml'
+require 'linux_admin'
+
+class RubyBugzilla
+
+  CMD = '/usr/bin/bugzilla'
+  COOKIES_FILE = File.expand_path('~') + '/.bugzillacookies'
+  CREDS_FILE = File.expand_path('~') + '/.bugzilla_credentials.yaml'
+
+  def self.username=(un)
+    @username = un
+  end
+
+  def self.username
+    @username
+  end
+
+  def self.password=(pw)
+    @password = pw
+  end
+
+  def self.password
+    @password
+  end
+
+  def self.credentials(username = nil, password = nil)
+    self.username = username
+    self.password = password
+
+    if self.username.nil? || self.password.nil?
+      un_from_file, pw_from_file = self.credentials_from_file
+      self.username ||= un_from_file
+      self.password ||= pw_from_file
+    end
+
+    [self.username, self.password]
+  end
+
+  # Ruby will catch and raise Erron::ENOENT: if there is no
+  # ~/.bugzilla_credentials.yaml file.
+  def self.credentials_from_file
+    begin
+      creds = YAML.load_file(CREDS_FILE)
+    rescue Errno::ENOENT => error
+      return [nil, nil]
+    end
+
+    [creds[:bugzilla_credentials][:username],
+      creds[:bugzilla_credentials][:password]]
+  end
+
+  def self.options
+    begin
+      options = YAML.load_file(CREDS_FILE)
+    rescue Errno::ENOENT => error
+      return ["https://bugzilla.redhat.com/", false]
+    end
+    [options[:bugzilla_options][:bugzilla_uri],
+      options[:bugzilla_options][:debug]]
+  end
+
+  # Running "bugzilla login" generates the bugzilla cookies.
+  # If that cookie file exists assume the user already logged in.
+  def self.logged_in?
+    File.exists?(COOKIES_FILE)
+  end
+
+  def self.clear_login!
+    if File.exists?(COOKIES_FILE) then
+      File.delete(COOKIES_FILE)
+    end
+  end
+
+  def self.login!(username = nil, password = nil)
+
+    login_cmd = "#{CMD} "
+    output = "Already Logged In"
+    params = {}
+
+    raise "Please install python-bugzilla" unless File.exists?(File.expand_path(CMD))
+
+    unless self.logged_in?
+      username, password = self.credentials(username, password)
+      uri_opt, debug_opt = self.options
+
+      params["--bugzilla="] = "#{uri_opt}/xmlrpc.cgi" unless uri_opt.nil?
+      params["--debug"]     = nil if debug_opt
+      params["login"]       = [username, password]
+
+      begin 
+        login_cmd_result = LinuxAdmin.run!(CMD, :params => params)
+      rescue => error
+        # A failed login attempt could result in a corrupt COOKIES_FILE
+        clear_login!
+        raise "#{self.string_command(CMD, params, password)} Failed.\n#{error}"
+      end
+      output = login_cmd_result.output
+    end
+    [self.string_command(CMD, params, password), output]
+  end
+
+  def self.query(product, flag=nil, bug_status=nil, output_format=nil)
+
+    raise "Please install python-bugzilla" unless
+      File.exists?(File.expand_path(CMD))
+
+    raise ArgumentError, "product cannot be nil" if product.nil?
+
+    uri_opt, debug_opt = self.options
+
+    params = {}
+
+    params["--bugzilla="]     = "#{uri_opt}/xmlrpc.cgi" unless uri_opt.nil?
+    params["query"]           = nil
+    params["--product="]      = product
+    params["--flag="]         = flag unless flag.nil?
+    params["--bug_status="]   = bug_status unless bug_status.nil?
+    params["--outputformat="] = output_format unless output_format.nil?
+
+    begin 
+      query_cmd_result = LinuxAdmin.run!(CMD, :params => params)
+    rescue => error
+      raise "#{self.string_command(CMD, params)} Failed.\n#{error}"
+    end
+
+    [self.string_command(CMD, params), query_cmd_result.output]
+  end
+
+  private
+  def self.string_command(cmd, params = {}, password=nil)
+    scrubbed_str = str = ""
+    str << cmd
+    params.each do |param, value|
+      if value.kind_of?(Array)
+        str << " #{param} \"#{value.join(" ")}\" "
+      else
+        str << " #{param}\"#{value}\" "
+      end
+    end
+    scrubbed_str = str.sub(password, "********") unless password.nil?
+    scrubbed_str
+  end
+
+end

data/ruby_bugzilla.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_bugzilla/version'
+
+Gem::Specification.new do |spec|
+
+  authors_hash = {"Joe VLcek"=>"jvlcek@redhat.com"}
+
+  spec.name          = "ruby_bugzilla"
+  spec.version       = RubyBugzilla::VERSION
+  spec.authors       = authors_hash.keys
+  spec.email         = authors_hash.values
+  spec.description   = %q{
+RubyBugzilla is a ruby wrapper around the python-bugzilla CLI for easy access to
+the Bugzilla API from Ruby.}
+  spec.summary       = %q{RubyBugzilla is a ruby wrapper around python-bugzilla}
+  spec.description   = %q{
+RubyBugzilla is a module allowing access the to python-bugzilla command
+from Ruby.
+}
+  spec.summary       = %q{RubyBugzilla is a module providing a Ruby interface to python-bugzilla.}
+  spec.homepage      = "http://github.com/ManageIQ/ruby-bugzilla"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "linux_admin", "~> 0.2.1"
+  spec.add_development_dependency "coveralls"
+end

data/samples/bugzilla_credentials.yaml

@@ -0,0 +1,14 @@
+# Copy this file to .bugzilla_credentials.yaml
+# in your home directory to use it for automated
+# login to bugzilla
+#
+# Note: The dot to make it a hiden file:
+#   <dot>bugzilla_credentials.yaml
+# 
+---
+:bugzilla_options:
+  :bugzilla_uri: https://bugzilla.redhat.com/
+  :debug: true
+:bugzilla_credentials:
+  :username: Your bugzilla login name
+  :password: Your bugzilla password

data/spec/ruby_bugzilla_spec.rb

@@ -0,0 +1,244 @@
+require 'spec_helper'
+require 'tempfile'
+
+class TempCredFile < Tempfile
+  def initialize(file)
+    f = super
+    f.puts("---")
+    f.puts(":bugzilla_credentials:")
+    f.puts("  :username: My Username")
+    f.puts("  :password: My Password")
+    f.puts(":bugzilla_options:")
+    f.puts("  :bugzilla_uri: MyURI")
+    f.puts("  :debug: MyDebug")
+    f.flush
+  end
+end
+      
+describe RubyBugzilla do
+  saved_cmd = RubyBugzilla::CMD
+  saved_cookies_file = RubyBugzilla::COOKIES_FILE
+  saved_creds_file = RubyBugzilla::CREDS_FILE
+
+  def ignore_warnings(&block)
+    begin
+      v, $VERBOSE = $VERBOSE, nil
+      block.call if block
+    ensure
+      $VERBOSE = v
+    end
+  end
+
+  # Run after each tests to reset any faked RubyBugzilla constants.
+  after :each do
+    ignore_warnings do
+      RubyBugzilla::CMD = saved_cmd
+      RubyBugzilla::COOKIES_FILE = saved_cookies_file
+      RubyBugzilla::CREDS_FILE = saved_creds_file
+      RubyBugzilla.username = nil
+      RubyBugzilla.password = nil
+    end
+  end
+
+  context "#logged_in?" do
+    it "with an existing bugzilla cookie" do
+      Tempfile.open('ruby_bugzilla_spec') do |file|
+        ignore_warnings do
+          RubyBugzilla::COOKIES_FILE = file.path
+        end
+        RubyBugzilla.logged_in?.should be true
+      end
+    end
+
+    it "with no bugzilla cookie" do
+      ignore_warnings do
+        RubyBugzilla::COOKIES_FILE = '/This/file/does/not/exist'
+      end
+      RubyBugzilla.logged_in?.should be false
+    end
+  end
+
+  context "#login!" do
+
+    it "when the bugzilla command is not found" do
+      ignore_warnings do
+        RubyBugzilla::CMD = '/This/cmd/does/not/exist'
+      end
+      expect{RubyBugzilla.login!}.to raise_exception
+    end
+
+    it "when the bugzilla login command produces output" do
+      # Fake the command and cookies file.
+      ignore_warnings do
+        RubyBugzilla::CMD = '/bin/echo'
+        RubyBugzilla::COOKIES_FILE = '/This/file/does/not/exist'
+      end
+      cmd, output = RubyBugzilla.login!("My Username", "My Password")
+      output.should include("login My Username My Password")
+    end
+
+    it "when the bugzilla login command produces output with arguments" do
+      # Fake the command and cookies file.
+      ignore_warnings do
+        RubyBugzilla::CMD = '/bin/echo'
+        RubyBugzilla::COOKIES_FILE = '/This/file/does/not/exist'
+      end
+      cmd, output = RubyBugzilla.login!("calvin", "hobbes")
+      output.should include("login calvin hobbes")
+    end
+
+  end
+
+  context "#query" do
+
+    it "when the bugzilla command is not found" do
+      ignore_warnings do
+        RubyBugzilla::CMD = '/This/cmd/does/not/exist'
+      end
+      expect{RubyBugzilla.query}.to raise_exception
+    end
+
+    it "when no product is specified" do
+      ignore_warnings do
+        RubyBugzilla::CMD = '/bin/echo'
+      end
+      expect{RubyBugzilla.query}.to raise_error(ArgumentError)
+    end
+
+    it "when the bugzilla query command produces output" do
+      # Fake the command and cookies file.
+        ignore_warnings do
+          RubyBugzilla::CMD = '/bin/echo'
+          RubyBugzilla::COOKIES_FILE = '/This/file/does/not/exist'
+        end
+
+        cmd, output = RubyBugzilla.login!("calvin", "hobbes")
+        cmd, output = RubyBugzilla.query('CloudForms Management Engine',
+          flag = '',
+          bug_status = 'NEW, ASSIGNED, POST, MODIFIED, ON_DEV, ON_QA, VERIFIED, RELEASE_PENDING',
+          output_format = 'BZ_ID: %{id} STATUS: %{bug_status} SUMMARY: %{summary}')
+
+        cmd.should include("query")
+        output.should include("BZ_ID:")
+        output.should include("STATUS:")
+        output.should include("SUMMARY:")
+    end
+
+  end
+
+  context "#credentials_from_file" do
+    it "when the YAML input file is not found" do
+      ignore_warnings do
+        RubyBugzilla::CREDS_FILE = '/This/cmd/does/not/exist'
+      end
+      un, pw = RubyBugzilla.credentials_from_file
+      un.should == nil
+      pw.should == nil
+    end
+
+    it "when the YAML input is valid" do
+      # Fake the credentials YAML file.
+      TempCredFile.open('ruby_bugzilla_spec') do |file|
+        ignore_warnings do
+          RubyBugzilla::CREDS_FILE = file.path
+        end
+        un, pw = RubyBugzilla.credentials_from_file
+        un.should == "My Username"
+        pw.should == "My Password"
+      end
+    end
+  end
+
+  context "#credentials" do
+    it "with no arguments and when the YAML input file is not found" do
+      ignore_warnings do
+        RubyBugzilla::CREDS_FILE = '/This/cmd/does/not/exist'
+      end
+      un, pw = RubyBugzilla.credentials
+      un.should == nil
+      pw.should == nil
+    end
+
+    it "with no arguments and when the YAML input is valid" do
+      # Fake the credentials YAML file.
+      TempCredFile.open('ruby_bugzilla_spec') do |file|
+        ignore_warnings do
+          RubyBugzilla::CREDS_FILE = file.path
+        end
+        un, pw = RubyBugzilla.credentials
+        un.should == "My Username"
+        pw.should == "My Password"
+      end
+    end
+
+    it "with arguments and when the YAML input file is not found" do
+      ignore_warnings do
+        RubyBugzilla::CREDS_FILE = '/This/cmd/does/not/exist'
+      end
+      un, pw = RubyBugzilla.credentials("test_un", "test_pw")
+      un.should == "test_un"
+      pw.should == "test_pw"
+    end
+
+    it "with arguments and valid YAML input, favor arguments" do
+      # Fake the credentials YAML file.
+      TempCredFile.open('ruby_bugzilla_spec') do |file|
+        ignore_warnings do
+          RubyBugzilla::CREDS_FILE = file.path
+        end
+        un, pw = RubyBugzilla.credentials("test_un", "test_pw")
+        un.should == "test_un"
+        pw.should == "test_pw"
+      end
+    end
+
+    it "with password argument and valid YAML input, favor argument" do
+      # Fake the credentials YAML file.
+      TempCredFile.open('ruby_bugzilla_spec') do |file|
+        ignore_warnings do
+          RubyBugzilla::CREDS_FILE = file.path
+        end
+        un, pw = RubyBugzilla.credentials(nil, "test_pw")
+        un.should == "My Username"
+        pw.should == "test_pw"
+      end
+    end
+
+    it "with username argument and valid YAML input, favor argument" do
+      # Fake the credentials YAML file.
+      TempCredFile.open('ruby_bugzilla_spec') do |file|
+        ignore_warnings do
+          RubyBugzilla::CREDS_FILE = file.path
+        end
+        un, pw = RubyBugzilla.credentials("test_un")
+        un.should == "test_un"
+        pw.should == "My Password"
+      end
+    end
+
+  end
+
+  context "#options" do
+    it "when the YAML input is valid" do
+      # Fake the credentials YAML file.
+      TempCredFile.open('ruby_bugzilla_spec') do |file|
+        ignore_warnings do
+          RubyBugzilla::CREDS_FILE = file.path
+        end
+        uri, debug = RubyBugzilla.options
+        uri.should == "MyURI"
+        debug.should == "MyDebug"
+      end
+    end
+    it "when the YAML input is is not found" do
+      ignore_warnings do
+        RubyBugzilla::CREDS_FILE = '/This/cmd/does/not/exist'
+      end
+      uri, debug = RubyBugzilla.options
+      uri.should == "https://bugzilla.redhat.com/"
+      debug.should == false
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'ruby_bugzilla'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+require 'coveralls'
+Coveralls.wear!

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: ruby_bugzilla
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Joe VLcek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: linux_admin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! '
+
+  RubyBugzilla is a module allowing access the to python-bugzilla command
+
+  from Ruby.
+
+'
+email:
+- jvlcek@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby_bugzilla.rb
+- lib/ruby_bugzilla/version.rb
+- ruby_bugzilla.gemspec
+- samples/bugzilla_credentials.yaml
+- spec/ruby_bugzilla_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ManageIQ/ruby-bugzilla
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -64370731141864933
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -64370731141864933
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: RubyBugzilla is a module providing a Ruby interface to python-bugzilla.
+test_files:
+- spec/ruby_bugzilla_spec.rb
+- spec/spec_helper.rb