xforge 0.1

data/CHANGES

@@ -0,0 +1,5 @@
+= XForge Changelog
+
+== Version 0.1.0
+
+* Added support for file releases

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2005 Aslak Hellesoy
+
+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

@@ -0,0 +1,55 @@
+= XForge
+
+This package contains XForge, a simple library to interact with RubyForge,
+SourceForge, GForge or other SourceForge clones.
+
+XForge has the following features:
+
+* Look up projects by unix name (no need to worry about group_id or package_id).
+
+* Upload new releases (with multiple files if desired).
+
+* Rake integration.
+
+== Download/Installation
+
+The latest version of XForge can be found at
+
+* http://rubyforge.org/project/showfiles.php?group_id=801
+
+Download and install XForge with the following.
+
+   gem install xforge
+
+(You may need administrative privileges for this).
+
+== Usage
+
+See XForge and Rake::XForge::Release.
+
+---
+
+== Credits
+
+[<b>Aslak Hellesoy</b>] Maintainer of this project.
+
+[<b>David Heinemeier Hansson</b>] For the HTTP POST code and the idea to parse ids from project pages.
+
+[<b>Jim Weirich</b>] For Rake, making XForge functionality more available to Ruby developers.
+
+== Support
+
+The XForge homepage is http://xforge.rubyforge.org.  You can find the XForge
+RubyForge page at http://rubyforge.org/projects/xforge.
+
+Feel free to submit patches, bug reports or feature requests via XForge's issue tracker on RubyForge.
+
+For other information, feel free to ask on the ruby-talk mailing list
+(which is mirrored to comp.lang.ruby) or contact
+aslak hellesoy gmail com.
+
+== License
+
+XForge is available under an MIT-style license.
+
+:include: MIT-LICENSE

data/Rakefile

@@ -0,0 +1,113 @@
+# Rakefile for XForge        -*- ruby -*-
+
+# Copyright 2003, 2004 by Jim Weirich (jim@weirichhouse.org)
+# All rights reserved.
+
+# This file is may be distributed under an MIT style license.  See
+# MIT-LICENSE for details.
+
+$:.unshift('lib')
+require 'xforge'
+require 'rake/gempackagetask'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+# Create a task to build the RDOC documentation tree.
+rd = Rake::RDocTask.new("rdoc") { |rdoc|
+  rdoc.rdoc_dir = 'html'
+#  rdoc.template = 'kilmer'
+#  rdoc.template = 'css2'
+#  rdoc.template = 'doc/jamis.rb'
+  rdoc.title    = "XForge"
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
+  rdoc.rdoc_files.include('README', 'MIT-LICENSE', 'TODO', 'CHANGES')
+  rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
+}
+
+# ====================================================================
+# Create a task that will package the Rake software into distributable
+# tar, zip and gem files.
+
+PKG_VERSION = "0.1"
+PKG_FILES = FileList[
+  '[A-Z]*',
+  'lib/**/*.rb', 
+  'doc/**/*'
+]
+
+if ! defined?(Gem)
+  puts "Package Target requires RubyGEMs"
+else
+  spec = Gem::Specification.new do |s|
+    
+    #### Basic information.
+
+    s.name = 'xforge'
+    s.version = PKG_VERSION
+    s.summary = "Ruby based make-like utility."
+    s.description = <<-EOF
+      XForge is a simple library to interact with RubyForge, SourceForge, GForge or other SourceForge clones.
+    EOF
+
+    s.files = PKG_FILES.to_a
+    s.require_path = 'lib'
+
+    #### Documentation and testing.
+
+    s.has_rdoc = true
+    s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
+    s.rdoc_options <<
+      '--title' <<  'XForge' <<
+      '--main' << 'README' <<
+      '--line-numbers'
+
+    #### Author and project details.
+
+    s.author = "Aslak Hellesoy"
+    s.email = "aslak.hellesoy@gmail.com"
+    s.homepage = "http://xforge.rubyforge.org"
+    s.rubyforge_project = "xforge"
+  end
+
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
+  end
+end
+
+# Support Tasks ------------------------------------------------------
+
+def egrep(pattern)
+  Dir['**/*.rb'].each do |fn|
+    count = 0
+    open(fn) do |f|
+      while line = f.gets
+        count += 1
+        if line =~ pattern
+          puts "#{fn}:#{count}:#{line}"
+        end
+      end
+    end
+  end
+end
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  egrep /#.*(FIXME|TODO|TBD)/
+end
+
+task :release => [:gem] do
+  release_files = FileList[
+    'pkg/*.gem', 
+    'CHANGES'
+  ]
+
+  Rake::XForge::Release.new('xforge') do |xf|
+    # Never hardcode user name and password in the Rakefile!
+    xf.user_name = ENV['RUBYFORGE_USER']
+    xf.password = ENV['RUBYFORGE_PASSWORD']
+    xf.files = release_files.to_a
+    xf.release_name = "XForge 0.1"
+  end
+end

data/TODO

@@ -0,0 +1,9 @@
+= XForge Project -- To Do List
+
+Send suggestions for this list to mailto:aslak.hellesoy@gmail.org.
+
+=== To Do
+* Retrieve SCM info as RSCM objects
+* Retrieve tracker info
+
+(moved DONE list to CHANGES file)

data/lib/rake/contrib/xforge.rb

@@ -0,0 +1,2 @@
+require 'rake/contrib/xforge/base'
+require 'rake/contrib/xforge/release'

data/lib/rake/contrib/xforge/base.rb

@@ -0,0 +1,43 @@
+module Rake
+  module XForge
+  
+    # Base class for XForge tasks
+    class Base
+      attr_writer :user_name, :password
+
+      def initialize(project_name, xforge_host="rubyforge.org")
+        @project_name = project_name
+        @host = ::XForge::Host.new(xforge_host)
+
+        set_defaults
+  
+        if(block_given?)
+          yield self
+          execute
+        end
+      end
+      
+    protected
+    
+      def set_defaults
+      end
+      
+      def user_name
+        if(@user_name.nil?)
+          print "#{@host.name} user: "
+          @user_name = STDIN.gets.chomp
+        end
+        @user_name
+      end
+
+      def password
+        if(@password.nil?)
+          print "#{@host.name} password: "
+          @password = STDIN.gets.chomp
+        end
+        @password
+      end
+  
+    end
+  end
+end

data/lib/rake/contrib/xforge/release.rb

@@ -0,0 +1,71 @@
+require 'rake/contrib/xforge/release'
+
+module Rake
+  module XForge
+
+    # This Rake task releases files to RubyForge or other SourceForge clones. In its most simple usage it looks like:
+    #
+    #   # Create a new release of the xforge project on Rubyforge.
+    #   task :release => [:gem] do
+    #     Rake::XForge::Release.new('xforge') {}
+    #   end
+    #
+    # The previous example will use defaults where it can. It will prompt you for your RubyForge user name 
+    # and password before it uploads all gems under the pkg folder and creates a RubyForge release.
+    #
+    # While defaults are nice, you may want a little more control. You can specify additional attributes:
+    #
+    # :include: base_attrs.rdoc
+    # * files - an array of files that should go into the release
+    # * release_name - name of the release
+    #
+    # Example:
+    #
+    #   task :release => [:gem] do
+    #     release_files = FileList[
+    #       'pkg/*.gem', 
+    #       'CHANGES'
+    #     ]
+    #
+    #     Rake::XForge::Release.new('xforge') do |xf|
+    #       # Never hardcode user name and password in the Rakefile!
+    #       xf.user_name = ENV['RUBYFORGE_USER']
+    #       xf.password = ENV['RUBYFORGE_PASSWORD']
+    #       xf.files = release_files.to_a
+    #       xf.release_name = "XForge 0.1"
+    #     end
+    #   end
+    #
+    # This can be invoked with
+    #
+    #   rake release RUBYFORGE_USER=aslak_hellesoy RUBYFORGE_PASSWORD=nahnotreal
+    #
+    # If you don't like blocks, you can do like this:
+    #
+    #   task :release => [:gem] do
+    #     xf = Rake::XForge::Release.new('xforge')
+    #     ... # Set additional attributes
+    #     xf.execute
+    #   end
+    #
+    class Release < Base
+
+      attr_accessor :files, :release_name
+  
+    protected
+    
+      def set_defaults
+        @files = ["pkg/#{PKG_FILE_NAME}.gem"] if defined? PKG_FILE_NAME
+        @release_name = "#{PKG_NAME}-#{PKG_VERSION}" if (defined? PKG_NAME && defined? PKG_VERSION)
+      end
+      
+      def execute
+        project = @host.project(@project_name)
+        u = user_name
+        session = project.login(u, password)
+        session.release(@files, @release_name)
+      end
+  
+    end
+  end
+end

data/lib/xforge.rb

@@ -0,0 +1,218 @@
+require 'net/http'
+require 'open-uri'
+require 'rake/contrib/xforge'
+
+# XForge provides an object-oriented view of the administrative interface for
+# hosting environments similar to SourceForge.net. This includes http://rubyforge.org/,
+# http://sourceforge.net/, custom installations of GForge (http://gforge.org/) and other
+# clones (provided their URL schemes are the similar).
+#
+# Currently it only supports uploading of new releases, but later versions may support
+# other functions if there is a demand for it. Patches are welcome.
+#
+# Example usage:
+#
+#   require 'xforge'
+#
+#   rubyforge = XForge::Host.new('rubyforge.org')
+#   xforge = rubyforge.project('xforge')
+#   session = xforge.login(my_user, my_password)
+#   session.release(['pkg/xforge-0.1.gem'], "XForge-0.1")
+#
+# Also see Rake::XForge::Release.
+#
+module XForge
+  # A Host represents a proxy to a server
+  class Host
+    attr_reader :name
+
+    # Create a new Host proxy located at +name+.
+    def initialize(name)
+      @name = name
+    end
+    
+    # Get access to 
+    def project(name)
+      Project.new(self, name)
+    end
+  end
+  
+  # A Project is an interface to a hosted project.
+  class Project
+    def initialize(host, name)
+      @host = host
+      @name = name
+    end
+    
+    # Logs in and returns a Session
+    def login(user_name, password)
+      login_response = Net::HTTP.start(@host.name, 80) 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)
+        project_uri = "http://#{@host.name}/projects/#{@name}/"
+        project_data = open(project_uri) { |data| data.read }
+        @group_id = project_data[/[?&]group_id=(\d+)/, 1]
+        raise "Couldn't get group_id" unless @group_id
+      end
+      @group_id
+    end
+  end
+  
+  # A Session object allows authenticated interaction with a Project, such as releasing files.
+  #
+  # A Session object can be obtained via Project.login
+  #
+  class Session
+    
+    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.name}/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(filenames, release_name, processor=Processor::ANY, release_notes="", release_changes="", preformatted=true)
+      release_date = Time.now.strftime("%Y-%m-%d %H:%M")
+
+      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.name, 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_hash.map do |(name, value)|
+            [name, URI.encode(value.to_s)].join("=")
+          end.join("&")
+
+          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")
+
+          release_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, release_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
+    end
+  end
+
+  # 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
+
+  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],
+      ".html" => ["text/html", 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

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.8
+specification_version: 1
+name: xforge
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2005-07-18
+summary: Ruby based make-like utility.
+require_paths: 
+  - lib
+email: aslak.hellesoy@gmail.com
+homepage: http://xforge.rubyforge.org
+rubyforge_project: xforge
+description: "XForge is a simple library to interact with RubyForge, SourceForge, GForge or
+  other SourceForge clones."
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+authors: 
+  - Aslak Hellesoy
+files: 
+  - CHANGES
+  - MIT-LICENSE
+  - Rakefile
+  - README
+  - TODO
+  - lib/xforge.rb
+  - lib/rake/contrib/xforge.rb
+  - lib/rake/contrib/xforge/base.rb
+  - lib/rake/contrib/xforge/release.rb
+test_files: []
+rdoc_options: 
+  - "--title"
+  - XForge
+  - "--main"
+  - README
+  - "--line-numbers"
+extra_rdoc_files: 
+  - README
+  - MIT-LICENSE
+  - TODO
+  - CHANGES
+executables: []
+extensions: []
+requirements: []
+dependencies: []