curb 0.1.0

data/LICENSE

@@ -0,0 +1,51 @@
+Copyright (c) 2006 Ross Bamford (rosco AT roscopeco DOT co DOT uk).
+Curb is free software licensed under the following terms:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README

@@ -0,0 +1,106 @@
+== Curb - Libcurl bindings for Ruby
+
+* http://curb.rubyforge.org/
+* http://rubyforge.org/projects/curb
+
+Curb (probably CUrl-RuBy or something) provides Ruby-language bindings for the
+libcurl(3), a fully-featured client-side URL transfer library.
+cURL and libcurl live at http://curl.haxx.se/ .
+
+Curb is a work-in-progress, and currently only supports libcurl's 'easy' mode.
+
+=== License
+
+Curb is copyright (c)2006 Ross Bamford, and released under the terms of the 
+Ruby license. See the LICENSE file for the gory details. 
+
+=== You will need
+
+* A working Ruby installation (1.8+, tested with 1.8.5)
+* A working (lib)curl installation, with development stuff (7.5+, tested with 7.15)
+* A sane build environment
+
+=== Installation...
+
+... will usually be as simple as:
+
+	$ gem install curb
+	
+Or, if you downloaded the archive:	
+
+  $ rake install 
+
+If you have a wierd setup, you might need extconf options. In this case, pass
+them like so:
+
+	$ rake install EXTCONF_OPTS='--with-curl-dir=/path/to/libcurl --prefix=/what/ever'
+	
+Currently, Curb is tested only on GNU/Linux x86 - YMMV on other platforms.
+If you do use another platform and experience problems, or if you can 
+expand on the above instructions, please get in touch via the mailing
+list on Curb's Rubyforge page.
+
+Curb has fairly extensive RDoc comments in the source. You can build the
+documentation with:
+
+  $ rake doc
+
+=== Examples
+
+Simple fetch via HTTP:
+
+  c = Curl::Easy.perform("http://www.google.co.uk")
+  puts c.body_str
+
+Same thing, more manual:
+
+  c = Curl::Easy.new("http://www.google.co.uk")
+  c.perform
+  puts c.body_str
+
+Additional config:
+
+  Curl::Easy.perform("http://www.google.co.uk") do |curl| 
+    curl.headers["User-Agent"] = "myapp-0.0"
+    curl.verbose = true
+  end
+
+Same thing, more manual:
+
+  c = Curl::Easy.new("http://www.google.co.uk") do |curl| 
+    curl.headers["User-Agent"] = "myapp-0.0"
+    curl.verbose = true
+  end
+  
+  c.perform
+
+Supplying custom handlers:
+
+  c = Curl::Easy.new("http://www.google.co.uk")
+  
+  c.on_body { |data| print(data) }
+  c.on_header { |data| print(data) }
+  
+  c.perform
+
+Reusing Curls:
+
+  c = Curl::Easy.new
+
+  ["http://www.google.co.uk", "http://www.ruby-lang.org/"].map do |url|
+    c.url = url
+    c.perform
+    c.body_str
+  end
+
+HTTP POST form:
+
+  c = Curl::Easy.http_post("http://my.rails.box/thing/create",
+                           Curl::PostField.content('thing[name]', 'box',
+                           Curl::PostField.content('thing[type]', 'storage')
+
+HTTP POST file upload:
+
+  c = Curl::Easy.new("http://my.rails.box/files/upload")
+  c.multipart_form_post = true
+  c.http_post(Curl::PostField.file('myfile.rb'))

data/Rakefile

@@ -0,0 +1,302 @@
+# $Id$
+# 
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'rake/gempackagetask'
+rescue LoadError
+  $stderr.puts("Rubygems support disabled")
+end
+
+CLEAN.include '**/*.o'
+CLEAN.include '**/*.so'
+CLOBBER.include 'doc'
+CLOBBER.include '**/*.log'
+CLOBBER.include '**/Makefile'
+CLOBBER.include '**/extconf.h'
+
+def announce(msg='')
+  $stderr.puts msg
+end
+
+desc "Default Task (Build packages)"
+task :default => :package
+
+# Determine the current version of the software
+if File.read('ext/curb.h') =~ /\s*CURB_VERSION\s*['"](\d.+)['"]/
+  CURRENT_VERSION = $1
+else
+  CURRENT_VERSION = "0.0.0"
+end
+
+if ENV['REL']
+  PKG_VERSION = ENV['REL']
+else
+  PKG_VERSION = CURRENT_VERSION
+end
+
+task :test_ver do
+  puts PKG_VERSION
+end
+
+# Make tasks -----------------------------------------------------
+MAKECMD = ENV['MAKE_CMD'] || 'make'
+MAKEOPTS = ENV['MAKE_OPTS'] || ''
+
+file 'ext/Makefile' => 'ext/extconf.rb' do
+  Dir.chdir('ext') do
+    ruby "extconf.rb #{ENV['EXTCONF_OPTS']}"
+  end
+end
+
+def make(target = '')
+  Dir.chdir('ext') do 
+    pid = fork { exec "#{MAKECMD} #{MAKEOPTS} #{target}" }
+    Process.waitpid pid
+    $?.exitstatus
+  end    
+end
+
+# Let make handle dependencies between c/o/so - we'll just run it. 
+file 'ext/curb_core.so' => 'ext/Makefile' do
+  m = make
+  fail "Make failed (status #{m})" unless m == 0
+end
+
+desc "Compile the shared object"
+task :compile => 'ext/curb_core.so'
+
+desc "Install to your site_ruby directory"
+task :install => :alltests do
+  m = make 'install' 
+  fail "Make install failed (status #{m})" unless m == 0
+end
+
+# Test Tasks ---------------------------------------------------------
+task :ta => :alltests
+task :tu => :unittests
+task :test => :unittests
+
+if ENV['RELTEST']
+  announce "Release task testing - not running regression tests on alltests"
+  task :alltests => [:unittests]
+else
+  task :alltests => [:unittests, :bugtests]
+end
+                    
+Rake::TestTask.new(:unittests) do |t|
+  t.test_files = FileList['tests/tc_*.rb']
+  t.verbose = false
+end
+                          
+Rake::TestTask.new(:bugtests) do |t|
+  t.test_files = FileList['tests/bug_*.rb']
+  t.verbose = false
+end
+                          
+#Rake::TestTask.new(:funtests) do |t|
+  #  t.test_files = FileList['test/func_*.rb']
+  #t.warning = true
+  #t.warning = true
+#end
+
+task :unittests => :compile
+task :bugtests => :compile
+
+# RDoc Tasks ---------------------------------------------------------
+desc "Create the RDOC documentation"
+task :doc do
+  ruby "doc.rb #{ENV['DOC_OPTS']}"
+end
+
+desc "Publish the RDoc documentation to project web site"
+task :doc_upload => [ :doc ] do
+  if ENV['RELTEST']
+    announce "Release Task Testing, skipping doc upload"
+  else    
+    unless ENV['RUBYFORGE_ACCT']
+      raise "Need to set RUBYFORGE_ACCT to your rubyforge.org user name (e.g. 'fred')"
+    end
+  
+    require 'rake/contrib/sshpublisher'
+    Rake::SshDirPublisher.new(
+      "#{ENV['RUBYFORGE_ACCT']}@rubyforge.org",
+      "/var/www/gforge-projects/curb",
+      "doc"
+    ).upload
+  end
+end
+
+# Packaging ------------------------------------------------
+PKG_FILES = FileList[
+  'ext/*.rb',
+  'ext/*.c',
+  'ext/*.h',
+  'tests/**/*',
+  'samples/**/*',
+  'doc.rb',
+  '[A-Z]*',
+]
+
+if ! defined?(Gem)
+  warn "Package Target requires RubyGEMs"
+else
+  spec = Gem::Specification.new do |s|
+    
+    #### Basic information.
+
+    s.name = 'curb'
+    s.version = PKG_VERSION
+    s.summary = "Ruby bindings for the libcurl(3) URL transfer library."
+    s.description = <<-EOF
+      C-language Ruby bindings for the libcurl(3) URL transfer library.
+    EOF
+    s.extensions = 'ext/extconf.rb'    
+
+    #### Which files are to be included in this gem? 
+
+    s.files = PKG_FILES.to_a
+
+    #### Load-time details
+    s.require_path = 'lib'
+    
+    #### Documentation and testing.
+    s.has_rdoc = true
+    s.extra_rdoc_files = Dir['ext/*.c'] << 'ext/curb.rb' << 'README' << 'LICENSE'
+    s.rdoc_options <<
+      '--title' <<  'Curb API' <<
+      '--main' << 'README'
+
+    s.test_files = Dir.glob('tests/tc_*.rb')
+    
+    #### Author and project details.
+
+    s.author = "Ross Bamford"
+    s.email = "curb-devel@rubyforge.org"
+    s.homepage = "http://curb.rubyforge.org"
+    s.rubyforge_project = "curb"
+  end
+  
+  # Quick fix for Ruby 1.8.3 / YAML bug
+  if (RUBY_VERSION == '1.8.3')
+    def spec.to_yaml
+      out = super
+      out = '--- ' + out unless out =~ /^---/
+      out
+    end  
+  end
+
+  package_task = Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar_gz = true
+    pkg.package_dir = 'pkg'    
+  end      
+end
+
+
+# --------------------------------------------------------------------
+# Creating a release
+desc "Make a new release (Requires SVN commit / webspace access)"
+task :release => [
+  :prerelease,
+  :clobber,
+  :alltests,
+  :update_version,
+  :package,
+  :tag,
+  :doc_upload] do
+  
+  announce 
+  announce "**************************************************************"
+  announce "* Release #{PKG_VERSION} Complete."
+  announce "* Packages ready to upload."
+  announce "**************************************************************"
+  announce 
+end
+
+# Validate that everything is ready to go for a release.
+task :prerelease do
+  announce 
+  announce "**************************************************************"
+  announce "* Making RubyGem Release #{PKG_VERSION}"
+  announce "* (current version #{CURRENT_VERSION})"
+  announce "**************************************************************"
+  announce  
+
+  # Is a release number supplied?
+  unless ENV['REL']
+    fail "Usage: rake release REL=x.y.z [REUSE=tag_suffix]"
+  end
+
+  # Is the release different than the current release.
+  # (or is REUSE set?)
+  if PKG_VERSION == CURRENT_VERSION && ! ENV['REUSE']
+    fail "Current version is #{PKG_VERSION}, must specify REUSE=tag_suffix to reuse version"
+  end
+
+  # Are all source files checked in?
+  if ENV['RELTEST']
+    announce "Release Task Testing, skipping checked-in file test"
+  else
+    announce "Checking for unchecked-in files..."
+    data = `svn status`
+    unless data =~ /^$/
+      fail "SVN status is not clean ... do you have unchecked-in files?"
+    end
+    announce "No outstanding checkins found ... OK"
+  end
+  
+  announce "Doc will try to use GNU cpp if available"
+  ENV['DOC_OPTS'] = "--cpp"
+end
+
+# Used during release packaging if a REL is supplied
+task :update_version do
+  unless PKG_VERSION == CURRENT_VERSION
+    pkg_vernum = PKG_VERSION.tr('.','').sub(/^0*/,'')
+    pkg_vernum << '0' until pkg_vernum.length > 2
+    
+    File.open('ext/curb.h.new','w+') do |f|      
+    maj, min, mic, patch = /(\d+)\.(\d+)(?:\.(\d+))?(?:\.(\d+))?/.match(PKG_VERSION).captures
+      f << File.read('ext/curb.h').
+           gsub(/CURB_VERSION\s+"(\d.+)"/) { "CURB_VERSION   \"#{PKG_VERSION}\"" }.
+           gsub(/CURB_VER_NUM\s+\d+/) { "CURB_VER_NUM   #{pkg_vernum}" }.
+           gsub(/CURB_VER_MAJ\s+\d+/) { "CURB_VER_MAJ   #{maj}" }.
+           gsub(/CURB_VER_MIN\s+\d+/) { "CURB_VER_MIN   #{min}" }.
+           gsub(/CURB_VER_MIC\s+\d+/) { "CURB_VER_MIC   #{mic || 0}" }.
+           gsub(/CURB_VER_PATCH\s+\d+/) { "CURB_VER_PATCH #{patch || 0}" }           
+    end
+    mv('ext/curb.h.new', 'ext/curb.h')     
+    if ENV['RELTEST']
+      announce "Release Task Testing, skipping commiting of new version"
+    else
+      sh %{svn commit -m "Updated to version #{PKG_VERSION}" ext/curb.h}
+    end
+  end
+end
+
+# "Create a new SVN tag with the latest release number (REL=x.y.z)"
+task :tag => [:prerelease] do
+  reltag = "curb-#{PKG_VERSION}"
+  reltag << ENV['REUSE'] if ENV['REUSE']
+  announce "Tagging SVN with [#{reltag}]"
+  if ENV['RELTEST']
+    announce "Release Task Testing, skipping SVN tagging"
+  else
+    # need to get current base URL
+    s = `svn info`
+    if s =~ /URL:\s*([^\n]*)\n/
+      svnroot = $1
+      if svnroot =~ /^(.*)\/trunk/
+        svnbase = $1
+        sh %{svn cp #{svnroot} #{svnbase}/TAGS/#{reltag} -m "Release #{PKG_VERSION}"}
+      else
+        fail "Please merge to trunk before making a release"
+      end
+    else 
+      fail "Unable to determine repository URL from 'svn info' - is this a working copy?"
+    end  
+  end
+end