meta_project 0.4.1

data/lib/meta_project/project/xforge/session.rb

@@ -0,0 +1,162 @@
+require 'net/http'
+require 'open-uri'
+
+module MetaProject
+  module Project
+    module XForge
+
+      # A Session object allows authenticated interaction with a Project, such as releasing files.
+      #
+      # A Session object can be obtained via Project.login
+      #
+      class Session
+
+        # Simple enumeration of processors. Used from Session.release
+        class Processor
+          I386           = 1000
+          IA64           = 6000
+          ALPHA          = 7000
+          ANY            = 8000
+          PPC            = 2000
+          MIPS           = 3000
+          SPARC          = 4000
+          ULTRA_SPARC    = 5000
+          OTHER_PLATFORM = 9999
+        end
+
+        BOUNDARY = "rubyqMY6QN9bp6e4kS21H4y0zxcvoor"
+
+        def initialize(host, project, cookie) # :nodoc:
+          @host = host
+          @project = project
+          @headers = { "Cookie" => cookie }
+        end
+
+        # The package_id of our project
+        def package_id
+          unless(@package_id)
+            release_uri = "http://#{@host}/frs/admin/?group_id=#{@project.group_id}"
+            release_data = open(release_uri, @headers) { |data| data.read }
+            @package_id = release_data[/[?&]package_id=(\d+)/, 1]
+            raise "Couldn't get package_id" unless @package_id
+          end
+          @package_id
+        end
+
+        # Creates a new release containing the files specified by +filenames+ (Array) and named +release_name+.
+        # Optional parameters are +processor+ (which should be one of the Processor constants), +release_notes+,
+        # +release_changes+ and +preformatted+ which will appear on the releas page of the associated project.
+        #
+        def release(release_name, filenames, release_notes="", release_changes="", preformatted=true, processor=Processor::ANY)
+          release_date = Time.now.strftime("%Y-%m-%d %H:%M")
+          release_id = nil
+
+          puts "About to release '#{release_name}'"
+          puts "Files:"
+          puts "  " + filenames.join("\n  ")
+          puts "\nRelease Notes:\n"
+          puts release_notes
+          puts "\nRelease Changes:\n"
+          puts release_changes
+          puts "\nRelease Settings:\n"
+          puts "Preformatted: #{preformatted}"
+          puts "Processor: #{processor}"
+          puts "\nStarting release..."
+
+          xfiles = filenames.collect{|filename| XFile.new(filename)}      
+          xfiles.each_with_index do |xfile, i|
+            first_file = i==0
+            puts "Releasing #{xfile.basename}..."
+
+            release_response = Net::HTTP.start(@host, 80) do |http|
+              query_hash = if first_file then
+                {
+                  "group_id" => @project.group_id,
+                  "package_id" => package_id,
+                  "type_id" => xfile.bin_type_id,
+                  "processor_id" => processor,
+
+                  "release_name" => release_name,
+                  "release_date" => release_date,
+                  "release_notes" => release_notes,
+                  "release_changes" => release_changes,
+                  "preformatted" => preformatted ? "1" : "0",
+                  "submit" => "1"
+                }
+              else
+                {
+                  "group_id" => @project.group_id,
+                  "package_id" => package_id,
+                  "type_id" => xfile.bin_type_id,
+                  "processor_id" => processor,
+
+                  "step2" => "1",
+                  "release_id" => release_id,
+                  "submit" => "Add This File"
+                }
+              end
+
+              query = query(query_hash)
+
+              data = [
+                "--" + BOUNDARY,
+                "Content-Disposition: form-data; name=\"userfile\"; filename=\"#{xfile.basename}\"",
+                "Content-Type: application/octet-stream",
+                "Content-Transfer-Encoding: binary",
+                "", xfile.data, ""
+                ].join("\x0D\x0A")
+
+              headers = @headers.merge(
+                "Content-Type" => "multipart/form-data; boundary=#{BOUNDARY}"
+              )
+
+              target = first_file ? "/frs/admin/qrs.php" : "/frs/admin/editrelease.php"
+              http.post(target + query, data, headers)
+            end
+
+            if first_file then
+              release_id = release_response.body[/release_id=(\d+)/, 1]
+              raise("Couldn't get release id") unless release_id
+            end
+          end
+          puts "Done!"
+        end
+    
+        def publish_news(subject, details)
+          puts "About to publish news"
+          puts "Subject: '#{subject}'"
+          puts "Details:"
+          puts details
+          puts ""
+      
+          release_response = Net::HTTP.start(@host, 80) do |http|
+            query_hash = {
+              "group_id" => @project.group_id,
+              "package_id" => package_id,
+              "post_changes" => "y",
+              "summary" => subject,
+              "details" => details
+            }
+      
+            target = "/news/submit.php"
+            headers = @headers.merge(
+              "Content-Type" => "multipart/form-data"
+            )
+            http.post(target + query(query_hash), "", headers)
+
+          end
+          puts "Done!"
+        end
+
+      private
+  
+        def query(query_hash)
+          "?" + query_hash.map do |(name, value)|
+            [name, URI.encode(value.to_s)].join("=")
+          end.join("&")
+        end
+
+      end
+    end
+  end
+end

data/lib/meta_project/project/xforge/source_forge.rb

@@ -0,0 +1,46 @@
+require 'meta_project/tracker/xforge'
+
+module MetaProject
+  module Project
+    module XForge
+      class SourceForge < XForgeBase
+
+        def initialize(unix_name, cvs_mod=nil)
+          super("sourceforge.net", unix_name, cvs_mod)
+        end
+
+        def tracker_class
+          ::MetaProject::Tracker::XForge::SourceForgeTracker
+        end
+
+      protected
+
+        def create_cvs(unix_name, mod)
+          RSCM::Cvs.new(":pserver:anonymous@cvs.sourceforge.net:/cvsroot/#{unix_name}", mod)
+        end
+
+        def create_view_cvs(unix_name, mod)
+          view_cvs = "http://cvs.sourceforge.net/viewcvs.py/"
+          unix_name_mod = "#{unix_name}/#{mod}"
+          project_path = "#{unix_name_mod}/\#{path}"
+          rev = "rev=\#{revision}"
+
+          overview = "#{view_cvs}#{unix_name_mod}/"
+          history  = "#{view_cvs}#{project_path}"
+          raw      = "#{view_cvs}*checkout*/#{project_path}?#{rev}"
+          html     = "#{history}?#{rev}&view=markup"
+          diff     = "#{history}?r1=\#{previous_revision}&r2=\#{revision}"
+
+          ScmWeb.new(overview, history, raw, html, diff)
+        end
+
+        # Regexp used to find projects' home page
+        def home_page_regexp
+          # This seems a little volatile
+          /<A href=\"(\w*:\/\/[^\"]*)\">&nbsp;Project Home Page<\/A>/
+        end
+
+      end
+    end
+  end
+end

data/lib/meta_project/project/xforge/xfile.rb

@@ -0,0 +1,45 @@
+module MetaProject
+  module Project
+    module XForge
+
+      class XFile # :nodoc:
+
+        # extension => [mime_type, rubyforge_bin_type_id, rubyforge_src_type_id]
+        FILE_TYPES = {
+          ".deb"  => ["application/octet-stream", 1000],
+
+          # all of these can be source or binary
+          ".rpm"  => ["application/octet-stream", 2000, 5100],
+          ".zip"  => ["application/octet-stream", 3000, 5000],
+          ".bz2"  => ["application/octet-stream", 3100, 5010],
+          ".gz"   => ["application/octet-stream", 3110, 5020],
+          ".jpg"  => ["application/octet-stream", 8000],
+          ".jpeg" => ["application/octet-stream", 8000],
+          ".txt"  => ["text/plain", 8100, 8100],
+          ".html" => ["text/html", 8200, 8200],
+          ".pdf"  => ["application/octet-stream", 8300],
+          ".ebuild"  => ["application/octet-stream", 1300],
+          ".exe"  => ["application/octet-stream", 1100],
+          ".dmg"  => ["application/octet-stream", 1200],
+          ".gem"  => ["application/octet-stream", 1400],
+          ".sig"  => ["application/octet-stream", 8150]
+        }
+        FILE_TYPES.default = ["application/octet-stream", 9999, 5900] # default to "other", "other source"
+
+        attr_reader :basename, :ext, :content_type, :bin_type_id, :src_type_id
+
+        def initialize(filename)
+          @filename = filename
+          @basename = File.basename(filename)
+          @ext = File.extname(filename)
+          @content_type = FILE_TYPES[@ext][0]
+          @bin_type_id = FILE_TYPES[@ext][1]
+        end
+
+        def data
+          File.open(@filename, "rb") { |file| file.read }
+        end
+      end
+    end
+  end
+end

data/lib/meta_project/project/xforge/xforge_base.rb

@@ -0,0 +1,76 @@
+require 'net/http'
+require 'net/https'
+require 'open-uri'
+
+module MetaProject
+  module Project
+    module XForge
+      class XForgeBase < Base
+
+        def initialize(host, unix_name, cvs_mod)
+          @host = host
+          @unix_name = unix_name
+
+          @tracker = tracker_class.new(group_id_uri("tracker"), self)
+
+          unless(cvs_mod.nil?)
+            @scm = create_cvs(unix_name, cvs_mod)
+            @scm_web = create_view_cvs(unix_name, cvs_mod)
+          end
+        end
+
+        def to_yaml_properties
+          ["@host", "@unix_name"]
+        end
+
+        # Logs in and returns a Session
+        def login(user_name, password)
+          http = Net::HTTP.new(@host, 80)
+
+          login_response = http.start do |http|
+            data = [
+              "login=1",
+              "form_loginname=#{user_name}",
+              "form_pw=#{password}"
+            ].join("&")
+            http.post("/account/login.php", data)
+          end
+
+          cookie = login_response["set-cookie"]
+          raise "Login failed" unless cookie
+          Session.new(@host, self, cookie)
+        end
+
+        # The group_id of this project
+        def group_id
+          unless(@group_id)
+            regexp = /stats\/[?&]group_id=(\d+)/
+            html = open(project_uri) { |data| data.read }
+            @group_id = html[regexp, 1]
+            raise "Couldn't get group_id" unless @group_id
+          end
+          @group_id
+        end
+
+        def project_uri
+          "http://#{@host}/projects/#{@unix_name}/"
+        end
+
+        def group_id_uri(path, postfix="")
+          "http://#{@host}/#{path}/?group_id=#{group_id}#{postfix}"
+        end
+
+        # The home page of this project
+        def home_page
+          unless(@home_page)
+            html = open(project_uri) { |data| data.read }
+            @home_page = html[home_page_regexp, 1]
+            raise "Couldn't get home_page" unless @home_page
+          end
+          @home_page
+        end
+
+      end
+    end
+  end
+end

data/lib/meta_project/project/xforge.rb

@@ -0,0 +1,5 @@
+require 'meta_project/project/xforge/xforge_base'
+require 'meta_project/project/xforge/session'
+require 'meta_project/project/xforge/xfile'
+require 'meta_project/project/xforge/ruby_forge'
+require 'meta_project/project/xforge/source_forge'

data/lib/meta_project/project.rb

@@ -0,0 +1,4 @@
+require 'meta_project/project/base'
+require 'meta_project/project/xforge'
+require 'meta_project/project/trac'
+require 'meta_project/project/codehaus'

data/lib/meta_project/project_analyzer.rb

@@ -0,0 +1,36 @@
+module MetaProject
+  module ProjectAnalyzer
+    # Creates a project from an scm web url. The project has a +tracker+, +scm+ and +scm_web+.
+    def project_from_scm_web(url, options=nil)
+      # RubyForge
+      if(url =~ /http:\/\/rubyforge.org\/cgi-bin\/viewcvs.cgi\/(.*)[\/]?\?cvsroot=(.*)/)
+        unix_name = $2
+        mod = $1[-1..-1] == "/" ? $1[0..-2] : $1
+        return Project::XForge::RubyForge.new(unix_name, mod)
+      end
+
+      # SourceForge
+      if(url =~ /http:\/\/cvs.sourceforge.net\/viewcvs.py\/([^\/]*)\/(.*)/)
+        unix_name = $1
+        mod = $2[-1..-1] == "/" ? $2[0..-2] : $2
+        return Project::XForge::SourceForge.new(unix_name, mod)
+      end
+
+      # Trac
+      if(url =~ /(http:\/\/.*)\/browser\/(.*)/)
+        trac_base_url = $1
+        svn_path = $2[-1..-1] == "/" ? $2[0..-2] : $2
+        return Project::Trac::TracProject.new(trac_base_url, options[:svn_root_url], svn_path)
+      end
+      
+      # Codehaus SVN
+      if(url =~ /http:\/\/svn.(.*).codehaus.org\/(.*)/)
+        svn_id = $1
+        svn_path = $2[-1..-1] == "/" ? $2[0..-2] : $2
+        return Project::Codehaus::CodehausProjectSvn.new(svn_id, svn_path, options[:jira_id])
+      end
+
+    end
+    
+  end
+end

data/lib/meta_project/scm_web.rb

@@ -0,0 +1,53 @@
+module MetaProject
+  
+  # An ScmWeb instance is capable of generating URLs to various files and diffs
+  # in an online scm web interface.
+  class ScmWeb
+
+    # The variables to use in +uri_specs+ are:
+    #
+    # * path
+    # * revision
+    # * previous_revision
+    #
+    def initialize(overview_spec, history_spec, raw_spec, html_spec, diff_spec)
+      @overview_spec, @history_spec, @raw_spec, @html_spec, @diff_spec = overview_spec, history_spec, raw_spec, html_spec, diff_spec
+    end
+
+    def overview
+      file_uri(nil, nil, @overview_spec)
+    end
+
+    def history(path)
+      file_uri(path, nil, @history_spec)
+    end
+
+    def raw(path, revision)
+      file_uri(path, revision, @raw_spec)
+    end
+
+    def html(path, revision)
+      file_uri(path, revision, @html_spec)
+    end
+
+    def diff(path, revision, previous_revision)
+      file_uri(path, revision, @diff_spec, previous_revision)
+    end
+
+  private
+
+    # Returns the file URI for +path+. Valid options are:
+    #
+    # * :type => ["overview"|"html"|"diff"|"raw"]
+    # * :revision
+    # * :previous_revision
+    def file_uri(path="", revision=nil, spec=@overview_spec, previous_revision=nil)
+      begin
+        eval("\"#{spec}\"", binding)
+      rescue NameError
+        raise "Couldn't evaluate '#{spec}'"
+      end
+    end
+
+  end
+end

data/lib/meta_project/tracker/base.rb

@@ -0,0 +1,18 @@
+module MetaProject
+  module Tracker
+
+    # Tracker objects are responsible for interacting with issue trackers (bug trackers).
+    # They know how to recognise issue identifiers in strings (typically from SCM commit
+    # messages) and turn these into HTML links that point to the associated issue on an
+    # issue tracker installation running somewhere else.
+    class Base
+      def self.classes
+        [
+          ::Tracker::Jira::JiraProject,
+          ::Tracker::XForge::RubyForgeProject,
+          ::Tracker::Trac::TracProject
+        ]
+      end
+    end
+  end
+end

data/lib/meta_project/tracker/digit_issues.rb

@@ -0,0 +1,24 @@
+module MetaProject
+  module Tracker
+    # This module should be included by trackers that follow a digit-based issue scheme
+    module DigitIssues
+      def identifier_regexp
+        /#(\d+)/
+      end
+
+      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(identifier_regexp) do |match|
+          issue_identifier = $1
+          issue = issue(issue_identifier)
+          issue ? "<a href=\"#{issue.uri}\">#{issue.summary}</a>" : "\##{issue_identifier}"
+        end
+      end
+    end
+  end
+end

data/lib/meta_project/tracker/issue.rb

@@ -0,0 +1,11 @@
+module MetaProject
+  module Tracker
+    class Issue
+      attr_reader :uri, :summary
+    
+      def initialize(uri, summary)
+        @uri, @summary = uri, summary
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+require 'xmlrpc/client'
+
+module MetaProject
+  module Tracker
+    module Jira
+      class JiraTracker
+        JIRA_API = "jira1"
+      
+        def initialize(rooturl=nil, identifier=nil, username=nil, password=nil)
+          @rooturl, @identifier, @username, @password = rooturl, identifier, username, password
+        end
+
+        def identifier_regexp
+          /([A-Z]+-[\d]+)/
+        end
+
+        def identifier_examples
+          ["DC-420", "PICO-12"]
+        end
+
+        def overview
+          "#{@rooturl}/browse/#{@identifier}"
+        end
+
+        def issue(issue_identifier)
+          session = login
+          begin
+            issue = session.getIssue(issue_identifier)
+            Issue.new("#{@rooturl}/browse/#{issue_identifier}", issue["summary"])
+          rescue XMLRPC::FaultException
+            # Probably bad issue number
+            nil
+          end
+        end
+
+        def markup(text)
+          text.gsub(identifier_regexp) do |match|
+            issue_identifier = $1
+            issue = issue(issue_identifier)
+            issue ? "<a href=\"#{issue.uri}\">#{issue_identifier}: #{issue.summary}</a>" : issue_identifier
+          end
+        end
+
+      private
+      
+        def login
+          client = XMLRPC::Client.new2("#{@rooturl}/rpc/xmlrpc")
+          token = client.call("#{JIRA_API}.login", @username, @password)
+          Session.new(client, token)
+        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

data/lib/meta_project/tracker/jira.rb

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

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

@@ -0,0 +1,29 @@
+module MetaProject
+  module Tracker
+    module Trac
+      class TracTracker < ::MetaProject::Tracker::Base
+        include ::MetaProject::Tracker::DigitIssues
+
+        def initialize(trac_base_url)
+          @trac_base_url = trac_base_url
+        end
+        
+        def overview
+          "#{@trac_base_url}/report"
+        end
+
+        def issue(issue_identifier)
+          issue_uri = "#{@trac_base_url}/ticket/#{issue_identifier}"
+          begin
+            html = open(issue_uri) { |data| data.read }
+            summary = html[/Ticket ##{issue_identifier}\s*<\/h1>\s*<h2>([^<]*)<\/h2>/n, 1]
+            ::MetaProject::Tracker::Issue.new(issue_uri, summary)
+          rescue OpenURI::HTTPError
+            nil
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/meta_project/tracker/trac.rb

@@ -0,0 +1 @@
+require 'meta_project/tracker/trac/trac_tracker'

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

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

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

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