meta_project 0.4.12 → 0.4.13

data/lib/meta_project/tracker/digit_issues.rb

@@ -1,34 +1,34 @@
-module MetaProject
-  module Tracker
-    # This module should be included by trackers that follow a digit-based issue scheme.
-    # TODO: Make issue_pattern and command_pattern attributes so they can be modified. Provide examples.
-    module DigitIssues
-      # Patois issue pattern
-      def issue_pattern
-        @issue_pattern ||= /\#([\d]+)/
-      end
-      module_function :issue_pattern
-
-      # Patois command pattern
-      def command_pattern
-        @command_pattern ||= /([A-Za-z]*).?(\#[\d]+(?:(?:[, &]*|\s?and\s?)\#[\d]+)*)/
-      end
-      module_function :command_pattern
-
-      def identifier_examples
-        ["#1926", "#1446"]
-      end
-
-      # TODO: find a way to extract just the issue summaries so they can be stored in dc as an array
-      # embedded in the revision object. that way we don't alter the original commit message
-      def markup(text)
-        text.gsub(issue_pattern) do |match|
-          issue_identifier = $1
-          issue = issue(issue_identifier)
-          link_text = (issue && issue.summary && issue.summary.strip! != "") ? "#{issue_identifier}: #{issue.summary}" : issue_identifier
-          (issue && issue.url) ? "<a href=\"#{issue.url}\">\##{link_text}</a>" : "\##{issue_identifier}"
-        end
-      end
-    end
-  end
+module MetaProject
+  module Tracker
+    # This module should be included by trackers that follow a digit-based issue scheme.
+    # TODO: Make issue_pattern and command_pattern attributes so they can be modified. Provide examples.
+    module DigitIssues
+      # Patois issue pattern
+      def issue_pattern
+        @issue_pattern ||= /\#([\d]+)/
+      end
+      module_function :issue_pattern
+
+      # Patois command pattern
+      def command_pattern
+        @command_pattern ||= /([A-Za-z]*).?(\#[\d]+(?:(?:[, &]*|\s?and\s?)\#[\d]+)*)/
+      end
+      module_function :command_pattern
+
+      def identifier_examples
+        ["#1926", "#1446"]
+      end
+
+      # TODO: find a way to extract just the issue summaries so they can be stored in dc as an array
+      # embedded in the revision object. that way we don't alter the original commit message
+      def markup(text)
+        text.gsub(issue_pattern) do |match|
+          issue_identifier = $1
+          issue = issue(issue_identifier)
+          link_text = (issue && issue.summary && issue.summary.strip! != "") ? "#{issue_identifier}: #{issue.summary}" : issue_identifier
+          (issue && issue.url) ? "<a href=\"#{issue.url}\">\##{link_text}</a>" : "\##{issue_identifier}"
+        end
+      end
+    end
+  end
 end

data/lib/meta_project/tracker/issue.rb

@@ -1,57 +1,57 @@
-module MetaProject
-  module Tracker
-    
-    # An issue represents an entry in an issue tracker such as a bug report or
-    # feature request.
-    class Issue
-      attr_reader :attributes
-    
-      def initialize(tracker, attributes={})
-        @tracker = tracker
-        @attributes = attributes
-      end
-      
-      # An URL pointing to the issue in the associated tracker, or nil if
-      # the issue doesn't exist.
-      def url
-        @tracker.materialize(self) unless @attributes[:url]
-        @attributes[:url]
-      end
-
-      # The id of the issue in the tracker
-      def identifier
-        @tracker.materialize(self) unless @attributes[:identifier]
-        @attributes[:identifier]
-      end
-
-      # The summary of the issue (typically a one-liner)
-      def summary
-        @tracker.materialize(self) unless @attributes[:summary]
-        @attributes[:summary]
-      end
-
-      # The details of the issue (typically several lines)
-      def detail
-        @tracker.materialize(self) unless @attributes[:detail]
-        @attributes[:detail]
-      end
-
-      # Adds a comment (consisting of the +detail+) to the issue
-      def update(user_name, password)
-        @tracker.update(self, user_name, password)
-      end
-
-      # Creates a new issue (consisting of the +summary+ and +detail+)
-      def create(user_name, password)
-        raise "Summary not set" unless summary
-        raise "Detail not set" unless detail
-        @tracker.create(self, user_name, password)
-      end
-
-      # Closes the issue (adding a comment consisting of the +detail+)
-      def close(user_name, password)
-        @tracker.close(self, user_name, password)
-      end
-    end
-  end
+module MetaProject
+  module Tracker
+    
+    # An issue represents an entry in an issue tracker such as a bug report or
+    # feature request.
+    class Issue
+      attr_reader :attributes
+    
+      def initialize(tracker, attributes={})
+        @tracker = tracker
+        @attributes = attributes
+      end
+      
+      # An URL pointing to the issue in the associated tracker, or nil if
+      # the issue doesn't exist.
+      def url
+        @tracker.materialize(self) unless @attributes[:url]
+        @attributes[:url]
+      end
+
+      # The id of the issue in the tracker
+      def identifier
+        @tracker.materialize(self) unless @attributes[:identifier]
+        @attributes[:identifier]
+      end
+
+      # The summary of the issue (typically a one-liner)
+      def summary
+        @tracker.materialize(self) unless @attributes[:summary]
+        @attributes[:summary]
+      end
+
+      # The details of the issue (typically several lines)
+      def detail
+        @tracker.materialize(self) unless @attributes[:detail]
+        @attributes[:detail]
+      end
+
+      # Adds a comment (consisting of the +detail+) to the issue
+      def update(user_name, password)
+        @tracker.update(self, user_name, password)
+      end
+
+      # Creates a new issue (consisting of the +summary+ and +detail+)
+      def create(user_name, password)
+        raise "Summary not set" unless summary
+        raise "Detail not set" unless detail
+        @tracker.create(self, user_name, password)
+      end
+
+      # Closes the issue (adding a comment consisting of the +detail+)
+      def close(user_name, password)
+        @tracker.close(self, user_name, password)
+      end
+    end
+  end
 end

data/lib/meta_project/tracker/jira.rb

@@ -1,2 +1,2 @@
-require 'meta_project/tracker/jira/jira_issues'
-require 'meta_project/tracker/jira/jira_tracker'
+require 'meta_project/tracker/jira/jira_issues'
+require 'meta_project/tracker/jira/jira_tracker'

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

@@ -1,35 +1,35 @@
-module MetaProject
-  module Tracker
-    module Jira
-      # This module should be included by trackers that follow a digit-based issue scheme
-      module JiraIssues
-
-        # Patois issue pattern
-        def issue_pattern
-          /([A-Za-z]+-[\d]+)/
-        end
-        module_function :issue_pattern
-
-        # Patois command pattern
-        def command_pattern
-          /([A-Za-z]*).?([A-Za-z]+-[\d]+(?:(?:[, &]*|\s?and\s?)[A-Za-z]+-[\d]+)*)/
-        end
-        module_function :command_pattern
-
-        def identifier_examples
-          ["DC-420", "pico-12"]
-        end
-
-        def markup(text)
-          text.gsub(issue_pattern) do |match|
-            issue_identifier = $1.upcase
-            issue = issue(issue_identifier)
-            link_text = (issue.summary && issue.summary.strip! != "") ? "#{issue_identifier}: #{issue.summary}" : issue_identifier
-            issue.url ? "<a href=\"#{issue.url}\">#{link_text}</a>" : issue_identifier
-          end
-        end
-
-      end
-    end
-  end
+module MetaProject
+  module Tracker
+    module Jira
+      # This module should be included by trackers that follow a digit-based issue scheme
+      module JiraIssues
+
+        # Patois issue pattern
+        def issue_pattern
+          /([A-Za-z]+-[\d]+)/
+        end
+        module_function :issue_pattern
+
+        # Patois command pattern
+        def command_pattern
+          /([A-Za-z]*).?([A-Za-z]+-[\d]+(?:(?:[, &]*|\s?and\s?)[A-Za-z]+-[\d]+)*)/
+        end
+        module_function :command_pattern
+
+        def identifier_examples
+          ["DC-420", "pico-12"]
+        end
+
+        def markup(text)
+          text.gsub(issue_pattern) do |match|
+            issue_identifier = $1.upcase
+            issue = issue(issue_identifier)
+            link_text = (issue.summary && issue.summary.strip! != "") ? "#{issue_identifier}: #{issue.summary}" : issue_identifier
+            issue.url ? "<a href=\"#{issue.url}\">#{link_text}</a>" : issue_identifier
+          end
+        end
+
+      end
+    end
+  end
 end

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

@@ -1,124 +1,149 @@
-require 'xmlrpc/client'
-
-module MetaProject
-  module Tracker
-    module Jira
-      
-      # Interface to JIRA. Uses the XML-RPC API defined at:
-      #
-      # http://confluence.atlassian.com/pages/viewpage.action?pageId=9623
-      # http://confluence.atlassian.com/pages/viewpage.action?pageId=1035
-      # http://www.atlassian.com/software/jira/docs/api/rpc-jira-plugin/latest/index.html?com/atlassian/jira/rpc/xmlrpc/XmlRpcService.html
-      class JiraTracker < Base
-        
-        include JiraIssues
-        JIRA_API = "jira1"
-      
-        attr_accessor :jira_base_url, :jira_project_id
-      
-        # Creates a new JiraTracker. In order to successfully get issue info (via XMLRPC),
-        # two env vars must be defined. Example:
-        #
-        #   JiraTracker.new("http://jira.codehaus.org", "DC")
-        #
-        # Then the following must be defined:
-        #
-        #   JIRA_CODEHAUS_ORG_JIRA_USER
-        #   JIRA_CODEHAUS_ORG_JIRA_PASSWORD
-        #   TODO: pass in to ctor instead. do this somewhere else!
-        def initialize(jira_base_url=nil, jira_project_id=nil)
-          @jira_base_url, @jira_project_id = jira_base_url, jira_project_id
-        end
-
-        def overview
-          "#{@jira_base_url}/browse/#{@jira_project_id}"
-        end
-
-        def create(issue)
-          issue_struct = {
-            "project" => @jira_project_id,
-            "summary" => issue.summary,
-            "description" => issue.detail,
-            "type" => 2, # magic number!
-            "priority" => 1
-          }
-          login do |session|
-            issue_struct = session.createIssue(issue_struct)
-            issue.attributes[:identifier] = issue_struct["key"]
-            issue
-          end
-        end
-        
-        def materialize(issue)
-          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
-            
-        def login
-          client = XMLRPC::Client.new2("#{@jira_base_url}/rpc/xmlrpc")
-          token = client.call("#{JIRA_API}.login", user, password)
-          yield Session.new(client, token)
-        end
-        
-        def user
-          var = "#{login_env_var_prefix}_JIRA_USER"
-          ENV[var] || missing_env_var(var)
-        end
-
-        def password
-          var = "#{login_env_var_prefix}_JIRA_PASSWORD"
-          ENV[var] || missing_env_var(var)
-        end
-        
-        def login_env_var_prefix
-          if(jira_base_url =~ /http:\/\/([^\/]+)/)
-            $1.gsub(/\./, "_").upcase
-          else
-            raise "Bad jira_base_url: #{jira_base_url}"
-          end
-        end
-
-        def missing_env_var(var)
-          raise JiraEnvVarException.new("Couldn't log in to JIRA at #{@rooturl}: The " +
-          "#{var} environment variable must be set in order to communicate with JIRA")
-        end
-        
-        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
-          def initialize(client, token)
-            @client, @token = client, token
-          end
-
-          def method_missing(sym, *args, &block)
-            token_args = [@token] + args
-            xmlrpc_method = "#{JIRA_API}.#{sym.to_s}"
-            @client.call(xmlrpc_method, *token_args)
-          end
-        end
-      end
-    end
-  end
+require 'xmlrpc/client'
+
+module MetaProject
+  module Tracker
+    module Jira
+      
+      # Interface to JIRA. Uses the XML-RPC API defined at:
+      #
+      # http://www.atlassian.com/software/jira/docs/api/rpc-jira-plugin/latest/com/atlassian/jira/rpc/xmlrpc/XmlRpcService.html
+      # http://confluence.atlassian.com/pages/viewpage.action?pageId=9623
+      # http://confluence.atlassian.com/pages/viewpage.action?pageId=1035
+      class JiraTracker < Base
+        
+        include JiraIssues
+        JIRA_API = "jira1"
+      
+        attr_accessor :jira_base_url, :jira_project_id
+      
+        # Creates a new JiraTracker. In order to successfully get issue info (via XMLRPC),
+        # two env vars must be defined. Example:
+        #
+        #   JiraTracker.new("http://jira.codehaus.org", "DC")
+        #
+        # Then the following must be defined:
+        #
+        #   JIRA_CODEHAUS_ORG_JIRA_USER
+        #   JIRA_CODEHAUS_ORG_JIRA_PASSWORD
+        #   TODO: pass in to ctor instead. do this somewhere else!
+        def initialize(jira_base_url=nil, jira_project_id=nil)
+          @jira_base_url, @jira_project_id = jira_base_url, jira_project_id
+        end
+
+        def overview
+          "#{@jira_base_url}/browse/#{@jira_project_id}"
+        end
+
+        def create(issue)
+          issue_struct = {
+            "project" => @jira_project_id,
+            "summary" => issue.summary,
+            "description" => issue.detail,
+            "type" => 2, # magic number!
+            "priority" => 1
+          }
+          login do |session|
+            issue_struct = session.createIssue(issue_struct)
+            issue.attributes[:identifier] = issue_struct["key"]
+            issue
+          end
+        end
+        
+        def close(issue)
+          begin
+            issue_struct = {
+              "project" => @jira_project_id,
+              "summary" => issue.summary,
+              "description" => issue.detail,
+              "type" => 2, # magic number!
+              "priority" => 1,
+              "status" => 6 # magic number for closed? do we have to look it up?
+            }
+            login do |session|
+              # TODO: Can't close JIRA issue.
+              # The following method:
+              # http://www.atlassian.com/software/jira/docs/api/rpc-jira-plugin/latest/com/atlassian/jira/rpc/xmlrpc/XmlRpcService.html#updateIssue(java.lang.String,%20java.lang.String,%20java.util.Hashtable)
+              # doesn't seem to exist on the JIRA on Codehaus (older version probably)
+              issue_struct = session.updateIssue(issue.identifier, issue_struct)
+              issue.attributes[:identifier] = issue_struct["key"]
+              issue
+            end
+          rescue XMLRPC::FaultException => e
+            # Probably bad issue number. Don't set URL.
+            STDERR.puts("WARNING: Exception from JIRA while closing issue #{issue.identifier}: #{e.faultCode}, #{e.faultString}")
+          end
+        end
+        
+        def materialize(issue)
+          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"] ? issue_struct["summary"].strip : nil
+              issue.attributes[:detail] = issue_struct["description"] ? issue_struct["description"].strip : nil
+            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 while loading issue details for #{issue.identifier}: #{e.faultCode}, #{e.faultString}")
+          end
+          issue
+        end
+        
+      private
+            
+        def login
+          client = XMLRPC::Client.new2("#{@jira_base_url}/rpc/xmlrpc")
+          token = client.call("#{JIRA_API}.login", user, password)
+          yield Session.new(client, token)
+        end
+        
+        def user
+          var = "#{login_env_var_prefix}_JIRA_USER"
+          ENV[var] || missing_env_var(var)
+        end
+
+        def password
+          var = "#{login_env_var_prefix}_JIRA_PASSWORD"
+          ENV[var] || missing_env_var(var)
+        end
+        
+        def login_env_var_prefix
+          if(jira_base_url =~ /http:\/\/([^\/]+)/)
+            $1.gsub(/\./, "_").upcase
+          else
+            raise "Bad jira_base_url: #{jira_base_url}"
+          end
+        end
+
+        def missing_env_var(var)
+          raise JiraEnvVarException.new("Couldn't log in to JIRA at #{@rooturl}: The " +
+          "#{var} environment variable must be set in order to communicate with JIRA")
+        end
+        
+        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
+          def initialize(client, token)
+            @client, @token = client, token
+          end
+
+          def method_missing(sym, *args, &block)
+            token_args = [@token] + args
+            xmlrpc_method = "#{JIRA_API}.#{sym.to_s}"
+            @client.call(xmlrpc_method, *token_args)
+          end
+        end
+      end
+    end
+  end
 end