bugzscout 0.0.3

data/lib/bugzscout.rb

@@ -0,0 +1,70 @@
+# This library that gives you easy access to the excellent BugzScout feature of FogBugz (http://fogcreek.com/fogbugz).
+# For those that don't know, BugzScout allows bug data (exceptions, user input, etc) to be reported back to your FogBugz install 
+# for further diagnosis.
+#
+# Author:: Michael Gorsuch (mailto:michael@styledbits.com)
+# Copyright:: Copyright (c) 2009 Michael Gorsuch
+# License:: Distributed under the same terms as Ruby
+
+require 'rubygems'
+require 'httpclient'
+require 'uri'
+
+# This is the core class that does all of the heavy lifting.
+class BugzScout
+  attr_accessor :url, :user, :project, :area, :title, :new, :body, :email
+  
+  # provide BugzScout with the URL of your FogBugz instance, including the 'scoutsubmit.asp' entry point
+  # example: https://styledbits.fogbugz.com/scoutsubmit.asp
+  def initialize(url)
+    self.url = url
+  end
+
+  # send the response to FogBugz
+  # return true if all goes well
+  # throw a BugzScoutError exception along with the error text if otherwise.
+  def submit
+    # ensure that the required fields are included
+    validate
+    
+    body = {
+      :ScoutUserName => self.user,
+      :ScoutProject => self.project,
+      :ScoutArea => self.area,
+      :Description => self.title, 
+      :ForceNewBug => self.new,
+      :Extra => self.body,
+      :Email => self.email,
+      :ScoutDefaultMessage => "",
+      :FriendlyResponse => 0 
+    }
+    client = HTTPClient.new
+    response = client.post(url, body).content
+    
+    if response =~ /<Error>(.*)<\/Error>/
+      # if we see an error response, we know that we fudged some of our input values to BugzScout
+      # the error message should contain where we went wrong.
+      # We raise the exception so the user can catch it and log if necessary.  No one likes things that fail silently!
+      raise(BugzScoutError, $1)
+    else
+      # we'll return 'true' for the sake of clarity
+      return true
+    end
+  end
+  
+  def validate
+    raise(BugzScoutError, "You have to provide a user name") if !self.user
+    raise(BugzScoutError, "You must provide a FogBugz project") if !self.project
+    raise(BugzScoutError, "You have to provide an area") if !self.area
+  end
+  
+  def self.submit(url)
+    scout = BugzScout.new(url)
+    yield scout
+    scout.submit
+  end
+  
+end
+
+# just a simple custom exception
+class BugzScoutError < RuntimeError ; end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: bugzscout
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Michael Gorsuch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-26 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httpclient
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: michael@styledbits.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/bugzscout.rb
+has_rdoc: true
+homepage: http://bitbucket.org/mgorsuch/rb-bugzscout
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: A package for using Fog Creek Software's FogBugz BugzScout bug reporting system.
+test_files: []
+