meta_project 0.4.9 → 0.4.10

data/CHANGES

@@ -1,5 +1,13 @@
 = MetaProject Changelog
 
+== Version 0.4.10
+
+This version fixes some bugs in the JIRA and SourceForge APIs.
+
+* Made error reporting better for JIRA exceptions.
+* Avoid exception rippling through when login credentials are not specified.
+* Made SourceForge tracker API more robust.
+
 == Version 0.4.9
 
 This release makes the validation of Browser objects more robust.

data/README

@@ -1,4 +1,4 @@
-= MetaProject 0.4.9
+= MetaProject 0.4.10
 
 MetaProject (formerly XForge) is a library that allows interaction with various project hosting servers, issue trackers, SCMs and SCM browsers through a common API.
 

data/Rakefile

@@ -24,7 +24,7 @@ require 'rake/rdoctask'
 #
 # REMEMBER TO KEEP PKG_VERSION IN SYNC WITH THE CHANGES FILE!
 PKG_NAME = "meta_project"
-PKG_VERSION = "0.4.9"
+PKG_VERSION = "0.4.10"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 PKG_FILES = FileList[
   '[A-Z]*',

data/lib/meta_project/tracker/jira/jira_tracker.rb

@@ -45,18 +45,30 @@ module MetaProject
           login do |session|
             issue_struct = session.createIssue(issue_struct)
             issue.attributes[:identifier] = issue_struct["key"]
+            issue
           end
         end
         
         def materialize(issue)
-          login do |session|
-            issue.attributes[:identifier] = issue.attributes[:identifier].upcase
-            issue_struct = session.getIssue(issue.identifier)
-            
-            issue.attributes[:summary] = issue_struct["summary"].strip
-            issue.attributes[:detail] = issue_struct["description"].strip
+          issue.attributes[:identifier] = issue.attributes[:identifier].upcase
+
+          # Getting summary and detail requires login
+          begin
+            login do |session|
+              issue_struct = session.getIssue(issue.identifier)            
+              issue.attributes[:url] = "#{@jira_base_url}/browse/#{issue.identifier}"
+              issue.attributes[:summary] = issue_struct["summary"].strip
+              issue.attributes[:detail] = issue_struct["description"].strip
+            end
+          rescue JiraEnvVarException => e
+            # Couldn't log in because of missing login info. Assume issue exists
             issue.attributes[:url] = "#{@jira_base_url}/browse/#{issue.identifier}"
+            STDERR.puts("WARNING: #{e.message}")
+          rescue XMLRPC::FaultException => e
+            # Probably bad issue number. Don't set URL.
+            STDERR.puts("WARNING: Exception from JIRA: #{e.faultCode}, #{e.faultString} Issue id: #{issue.identifier}")
           end
+          issue
         end
         
       private
@@ -64,27 +76,17 @@ module MetaProject
         def login
           client = XMLRPC::Client.new2("#{@jira_base_url}/rpc/xmlrpc")
           token = client.call("#{JIRA_API}.login", user, password)
-          begin
-            yield Session.new(client, token)
-          rescue XMLRPC::FaultException => e
-            # Probably bad issue number or failed login
-            STDERR.puts("WARNING: Exception from JIRA: #{e.faultCode}, #{e.faultString}")
-            nil
-          rescue LoginException => e
-            # Missing env vars
-            STDERR.puts("WARNING: Couldn't log in to JIRA at #{@rooturl}: #{e.message}")
-            nil
-          end
+          yield Session.new(client, token)
         end
         
         def user
           var = "#{login_env_var_prefix}_JIRA_USER"
-          ENV[var] || login_error(var)
+          ENV[var] || missing_env_var(var)
         end
 
         def password
           var = "#{login_env_var_prefix}_JIRA_PASSWORD"
-          ENV[var] || login_error(var)
+          ENV[var] || missing_env_var(var)
         end
         
         def login_env_var_prefix
@@ -95,13 +97,14 @@ module MetaProject
           end
         end
 
-        def login_error(var)
-          raise LoginException.new("#{var} environment variable not defined")
+        def missing_env_var(var)
+          raise JiraEnvVarException.new("Couldn't log in to JIRA at #{@rooturl}: #{e.message}. The " +
+          "#{var} environment variable must be set in order to communicate with JIRA")
         end
         
-        class LoginException < Exception
+        class JiraEnvVarException < Exception
         end
-      
+        
         # This wrapper around XMLRPC::Client that allows simpler method calls
         # via method_missing and doesn't require to manage the token
         class Session

data/lib/meta_project/tracker/trac/trac_tracker.rb

@@ -24,6 +24,7 @@ module MetaProject
           rescue OpenURI::HTTPError => e
             STDERR.puts e.message
           end
+          issue
         end
         
       end

data/lib/meta_project/tracker/xforge/ruby_forge_tracker.rb

@@ -3,11 +3,11 @@ module MetaProject
     module XForge
       class RubyForgeTracker < XForgeTracker
 
-        def subtracker_regexp
+        def subtracker_pattern
           /\/tracker\/\?atid=(\d+)&group_id=\d*&func=browse/
         end
 
-        def issue_summary_regexp(identifier)
+        def issue_summary_pattern(identifier)
           /<a href=\"\/tracker\/index.php\?func=detail&aid=#{identifier}&group_id=\d+&atid=\d+\">([^<]*)<\/a>/
         end
 

data/lib/meta_project/tracker/xforge/source_forge_tracker.rb

@@ -3,11 +3,11 @@ module MetaProject
     module XForge
       class SourceForgeTracker < XForgeTracker
         
-        def subtracker_regexp
+        def subtracker_pattern
           /\/tracker\/\?atid=(\d+)&amp;group_id=\d*&amp;func=browse/
         end
 
-        def issue_summary_regexp(identifier)
+        def issue_summary_pattern(identifier)
           /<a href=\"\/tracker\/index.php\?func=detail&amp;aid=#{identifier}&amp;group_id=\d+&amp;atid=\d+\">([^<]*)<\/a>/
         end
 

data/lib/meta_project/tracker/xforge/xforge_tracker.rb

@@ -1,3 +1,4 @@
+
 require 'meta_project/tracker/base'
 require 'meta_project/tracker/digit_issues'
 require 'meta_project/tracker/issue'
@@ -26,6 +27,7 @@ module MetaProject
         end
         
         def materialize(issue)
+          issue
         end
 
         class SubTracker
@@ -40,8 +42,8 @@ module MetaProject
           def issue(identifier)
             html = better_open(@uri).read
 
-            issue_summary_regexp = @tracker.issue_summary_regexp(identifier)
-            if(html =~ issue_summary_regexp)
+            issue_summary_pattern = @tracker.issue_summary_pattern(identifier)
+            if(html =~ issue_summary_pattern)
               issue_url = @tracker.project.group_id_uri("tracker/index.php", "&atid=#{@atid}&func=detail&aid=#{identifier}")
               issue_summary = $1.strip
               return Issue.new(@tracker, :summary => issue_summary, :url => issue_url)
@@ -54,14 +56,32 @@ module MetaProject
 
         # The ids of the subtrackers
         def atids
+#          headers = {
+#            "User-Agent" => "Mozilla/5.0 (Macintosh; U; PPC Mac OS X Mach-O; en-US; rv:1.7.8) Gecko/20050511 Firefox/1.0.4",
+#            "Accept" => "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5",
+#            "Accept-Language" => "en-us,en;q=0.5",
+#            "Accept-Encoding" => "gzip,deflate",
+#            "Accept-Charset" => "ISO-8859-1,utf-8;q=0.7,*;q=0.7",
+#            "Keep-Alive" => "300",
+#            "Connection" => "close",
+#            "X-Requested-With" => "XMLHttpRequest",
+#            "X-Prototype-Version" => "1.3.1",
+#            "Content-Type" => "application/x-www-form-urlencoded",
+#            "Content-Length" => "0",
+#            "Cookie" => "author=AnonymousCoward; _session_id=975a583d513190522ce3aeba315552d0",
+#            "Pragma" => "no-cache",
+#            "Cache-Control" => "no-cache"
+#          }
+          
           html = better_open(overview).read
+          STDERR.puts "The HTML returned from #{overview} was empty! This might be because the server is trying to fool us" if html == ""
 
           # TODO: there has to be a better way to extract the atids from the HTML!
           atids = []
           offset = 0
           look_for_atid = true
           while(look_for_atid)
-            match_data = subtracker_regexp.match(html[offset..-1])
+            match_data = subtracker_pattern.match(html[offset..-1])
             if(match_data)
               offset += match_data.begin(1)
               atids << match_data[1]
@@ -69,6 +89,14 @@ module MetaProject
               look_for_atid = false
             end
           end
+          if atids.empty?
+            debug_file = "xforge_tracker_debug.html"
+            File.open(debug_file, "w"){|io| io.write html}
+            STDERR.puts "WARNING: No subtrackers found at #{overview}."
+            STDERR.puts "I was looking for /#{subtracker_pattern.source}/"
+            STDERR.puts "Please consider filing a bug report at http://rubyforge.org/tracker/?atid=3161&group_id=801&func=browse"
+            STDERR.puts "The HTML has been saved to #{debug_file}"
+          end
           atids
         end
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: meta_project
 version: !ruby/object:Gem::Version 
-  version: 0.4.9
-date: 2005-09-06 00:00:00 -04:00
+  version: 0.4.10
+date: 2005-09-08 00:00:00 -04:00
 summary: Ruby based make-like utility.
 require_paths: 
   - lib