hc-httpclient 3.1.1

data/History.txt

@@ -0,0 +1,3 @@
+=== 3.1.1 / 2009-1-24 (TBD)
+
+* Inital release based on Apache HttpClient 3.1

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+pom.xml
+assembly.xml
+lib/hc-httpclient/base.rb
+lib/hc-httpclient.rb
+test/test_httpclient.rb
+lib/hc-httpclient/commons-httpclient-3.1.jar
+lib/hc-httpclient/commons-codec-1.2.jar

data/README.txt

@@ -0,0 +1,77 @@
+= hc-httpclient
+
+* http://rjack.rubyforge.org
+* http://rubyforge.org/projects/rjack
+
+== Description
+
+A gem packaging of the {HttpComponents}[http://hc.apache.org/]
+(formerly Jakarta Commons) HTTP Client for JRuby.
+
+* Provides commons-httpclient and commons-codec jars.
+* Provides a HC::HTTPClient::ManagerFacade for client and connection
+  manager setup, start, shutdown.
+
+== Synopsis
+
+ require 'logback'
+ require 'hc-httpclient'
+
+ include HC::HTTPClient
+
+ mf = ManagerFacade.new 
+ mf.manager_params.max_total_connections = 200
+ mf.client_params.so_timeout = 3000 #ms
+ mf.start
+    
+ mf.client # --> org.apache.commons.HttpClient
+
+ mf.shutdown
+
+See {org.apache.commons.HttpClient}[http://hc.apache.org/httpclient-3.x/apidocs/org/apache/commons/httpclient/HttpClient.html].
+
+== Requirements
+
+* slf4j[http://rjack.rubyforge.org/slf4j] (rjack gem).
+
+* An slf4j output adaptor such as 'slf4j/simple' or
+  logback[http://rjack.rubyforge.org/logback] must be require'd before
+  hc-httpclient.  (The logback gem is listed as a development
+  dependency only.)
+
+== License
+
+=== hc-httpclient ruby gem
+
+Copyright (C) 2009 David Kellum
+
+Licensed under the Apache License, Version 2.0 (the "License"); you
+may not use this file except in compliance with the License.  You
+may obtain a copy of the License at:
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied.  See the License for the specific language governing
+permissions and limitations under the License.
+
+=== Jakarta Commons HTTPClient (java)
+
+Copyright 1999-2007 The Apache Software Foundation
+
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version
+2.0 (the "License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied.  See the License for the specific language governing
+permissions and limitations under the License.

data/Rakefile

@@ -0,0 +1,90 @@
+# -*- ruby -*-
+#--
+# Copyright (C) 2008-2009 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You
+# may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+require 'rubygems'
+
+ENV['NODOT'] = "no thank you"
+require 'hoe'
+
+$LOAD_PATH << './lib'
+require 'hc-httpclient/base'
+
+ASSEMBLY = "target/httpclient-1.0-bin.dir"
+
+desc "Update the Manifest with actual jars"
+task :manifest => [ ASSEMBLY ] do
+  out = File.new( 'Manifest.txt', 'w' ) 
+  begin
+    out.write <<END
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+pom.xml
+assembly.xml
+lib/hc-httpclient/base.rb
+lib/hc-httpclient.rb
+test/test_httpclient.rb
+END
+    out.puts( Dir.glob( File.join( ASSEMBLY, '*.jar' ) ).map do |jar|
+                File.join( 'lib', 'hc-httpclient', File.basename( jar ) )
+              end )
+  ensure
+    out.close
+  end
+end
+
+file ASSEMBLY => [ 'pom.xml', 'assembly.xml' ] do
+  sh( 'mvn package' )
+end
+
+JAR_FILES = File.new( 'Manifest.txt' ).readlines.map { |f| f.strip }\
+.select { |f| f =~ /\.jar$/ }
+
+JARS = JAR_FILES.map { |f| File.basename( f.strip ) }
+
+JARS.each do |jar|
+  file "lib/hc-httpclient/#{jar}" => [ ASSEMBLY ] do
+    cp_r( File.join( ASSEMBLY, jar ), 'lib/hc-httpclient' )
+  end
+end
+[ :gem, :test ].each { |t| task t => JAR_FILES }
+
+task :mvn_clean do
+  rm_f( JAR_FILES )
+  sh( 'mvn clean' )
+end
+
+task :clean => :mvn_clean 
+
+task :tag do
+  tag = "hc-httpclient-#{HC::HTTPClient::VERSION}"
+  dname = File.dirname( __FILE__ )
+  dname = '.' if Dir.getwd == dname
+  sh( "git status --only #{dname}" ) do |ok,res|
+    raise "Commit these changes before tagging." if ok #changes present
+  end
+  sh %{git tag -s -f -m "tag [#{tag}]" "#{tag}"}
+end
+
+hoe = Hoe.new( "hc-httpclient", HC::HTTPClient::VERSION ) do |p|
+  p.developer( "David Kellum", "dek-oss@gravitext.com" )
+  p.extra_deps << [ 'slf4j', '~> 1.5.6.1' ]
+  p.extra_dev_deps << [ 'logback', '>= 1.9.14' ]
+  p.rubyforge_name = "rjack"
+  p.rdoc_pattern = /^(lib.*\.(rb|txt))|[^\/]*\.txt$/
+end

data/assembly.xml

@@ -0,0 +1,15 @@
+<assembly>
+  <id>bin</id>
+  <formats>
+    <format>dir</format>
+  </formats>
+  <includeBaseDirectory>false</includeBaseDirectory>
+  <dependencySets>
+    <dependencySet>
+      <includes>
+        <include>commons-httpclient:commons-httpclient</include>
+        <include>commons-codec:commons-codec</include>
+      </includes>
+    </dependencySet>
+  </dependencySets>
+</assembly>

data/lib/hc-httpclient.rb

@@ -0,0 +1,102 @@
+#--
+# Copyright (C) 2008-2009 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You
+# may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+require 'rubygems'
+require 'slf4j'
+require 'slf4j/jcl-over-slf4j'
+
+require 'hc-httpclient/base'
+
+# "HC" stands for "Http Components" the latest project name, at:
+#
+# http://hc.apache.org
+#
+# which has inherited "Jakarta Commons HttpClient" 3.x and released
+# "HttpComponents Client" 4.x currently in beta. The HC module name is
+# inserted to distinguish this module from others named "HTTPClient",
+# including:
+#
+# * http://dev.ctor.org/http-access2
+# * http://rubyforge.org/projects/soap4r
+#
+module HC
+  module HTTPClient
+
+    Dir.glob( File.join( HTTPCLIENT_DIR, '*.jar' ) ).each { |jar| require jar }
+
+    import 'org.apache.commons.httpclient.params.HttpConnectionManagerParams'
+    import 'org.apache.commons.httpclient.params.HttpClientParams'
+    import 'org.apache.commons.httpclient.params.HttpMethodParams'  
+    import 'org.apache.commons.httpclient.DefaultHttpMethodRetryHandler'
+    import 'org.apache.commons.httpclient.MultiThreadedHttpConnectionManager'
+    import 'org.apache.commons.httpclient.HttpClient'
+
+    # Facade over http client and connection manager, setup, start, shutdown
+    # 
+    # == Example Settings
+    #
+    # See: http://hc.apache.org/httpclient-3.x/preference-api.html
+    #
+    #  manager_params.max_total_connections = 200
+    #  manager_params.connection_timeout = 1500 #ms
+    #  manager_params.default_max_connections_per_host = 20
+    #  manager_params.stale_checking_enabled = false
+    #  client_params.connection_manager_timeout = 3000 #ms
+    #  client_params.so_timeout = 3000 #ms
+    #  client_params.set_parameter( HttpMethodParams::RETRY_HANDLER, 
+    #                               DefaultHttpMethodRetryHandler.new( 2, false ) )
+    #  client_params.cookie_policy = CookiePolicy::IGNORE_COOKIES
+    #
+    # Note, use of set_parameter style settings will increase the
+    # likelihood of 4.x compatibility
+    class ManagerFacade
+
+      # The HttpClient instance available after start
+      attr_reader :client
+      
+      # Manager parameters
+      attr_reader :manager_params
+
+      # Client parameters
+      attr_reader :client_params
+
+      def initialize
+        @manager_params = HttpConnectionManagerParams.new
+
+        @client_params = HttpClientParams.new
+        
+        @client = nil
+        @connection_manager = nil
+      end
+
+      # Given previously set parameters, construct connection manager
+      # and client.
+      def start
+        @connection_manager = MultiThreadedHttpConnectionManager.new()
+        @connection_manager.params = @manager_params
+
+        @client = HttpClient.new( @client_params, @connection_manager );
+      end
+
+      # Shutdown and close the connection manager and client.
+      def shutdown
+        @connection_manager.shutdown if @connection_manager
+        @client = nil
+        @connection_manager = nil
+      end
+    end
+  end
+end

data/lib/hc-httpclient/base.rb

@@ -0,0 +1,24 @@
+#--
+# Copyright (C) 2008-2009 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You
+# may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+module HC
+  module HTTPClient
+    HTTPCLIENT_VERSION = '3.1'
+    VERSION = HTTPCLIENT_VERSION + '.1'
+    
+    HTTPCLIENT_DIR = File.dirname( __FILE__ ) # :nodoc:
+  end
+end

data/pom.xml

@@ -0,0 +1,61 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.gravitext</groupId>
+  <artifactId>httpclient</artifactId>
+  <packaging>pom</packaging>
+  <version>1.0</version>
+  <name>HTTPClient Assembly for Gem</name>
+
+  <dependencies>
+
+     <dependency>
+      <groupId>commons-httpclient</groupId>
+      <artifactId>commons-httpclient</artifactId>
+      <version>3.1</version>
+      <exclusions>
+        <exclusion>
+          <groupId>commons-logging</groupId>
+          <artifactId>commons-logging</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>
+
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <artifactId>maven-assembly-plugin</artifactId>
+        <configuration>
+          <descriptors>
+            <descriptor>assembly.xml</descriptor>
+          </descriptors>
+          <tarLongFileMode>gnu</tarLongFileMode>
+        </configuration>
+        <executions>
+          <execution>
+            <id>assembly</id>
+            <phase>package</phase>
+            <goals>
+              <goal>attached</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <configuration>
+          <source>1.5</source>
+          <target>1.5</target>
+          <optimize>true</optimize>
+          <debug>true</debug>
+          <encoding>UTF-8</encoding>
+          <showDeprecation>true</showDeprecation>
+          <showWarnings>true</showWarnings>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+
+</project>

data/test/test_httpclient.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env jruby
+#--
+# Copyright (C) 2008-2009 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You
+# may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+require 'rubygems'
+gem( 'logback', '>= 0.9.14' )
+
+require 'logback'
+Logback.root.level = Logback::DEBUG
+
+require 'test/unit'
+
+$LOAD_PATH.unshift File.join( File.dirname(__FILE__), "..", "lib" )
+
+require 'hc-httpclient'
+
+class TestClient < Test::Unit::TestCase
+  include HC::HTTPClient
+  def test_setup
+    m = ManagerFacade.new 
+    m.manager_params.max_total_connections = 200
+    m.client_params.so_timeout = 3000 #ms
+    m.start
+    
+    assert_not_nil m.client
+
+    m.shutdown
+
+    assert_nil m.client
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - '>='
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+email: 
+- dek-oss@gravitext.com
+cert_chain: []
+
+summary: A gem packaging of the {HttpComponents}[http://hc.apache.org/] (formerly
+  Jakarta Commons) HTTP Client for JRuby
+post_install_message: 
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+homepage: http://rjack.rubyforge.org
+signing_key: 
+name: hc-httpclient
+rdoc_options: 
+- --main
+- README.txt
+autorequire: 
+rubyforge_project: rjack
+executables: []
+
+description: A gem packaging of the {HttpComponents}[http://hc.apache.org/] (formerly
+  Jakarta Commons) HTTP Client for JRuby.  * Provides commons-httpclient and commons-codec
+  jars. * Provides a HC::HTTPClient::ManagerFacade for client and connection manager
+  setup, start, shutdown.
+specification_version: 2
+default_executable: 
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- pom.xml
+- assembly.xml
+- lib/hc-httpclient/base.rb
+- lib/hc-httpclient.rb
+- test/test_httpclient.rb
+- lib/hc-httpclient/commons-httpclient-3.1.jar
+- lib/hc-httpclient/commons-codec-1.2.jar
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - '>='
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+extensions: []
+
+rubygems_version: 1.3.1
+requirements: []
+
+authors: 
+- David Kellum
+date: 2009-02-22 08:00:00 +00:00
+platform: ruby
+test_files: 
+- test/test_httpclient.rb
+version: !ruby/object:Gem::Version 
+  version: 3.1.1
+require_paths: 
+- lib
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.6.1
+    version: 
+  type: :runtime
+  version_requirement: 
+  name: slf4j
+- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - '>='
+      - !ruby/object:Gem::Version 
+        version: 1.9.14
+    version: 
+  type: :development
+  version_requirement: 
+  name: logback
+- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - '>='
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+  type: :development
+  version_requirement: 
+  name: hoe
+bindir: bin
+has_rdoc: true