rjack-httpclient-3 3.1.4-java

data/History.rdoc

@@ -0,0 +1,15 @@
+=== 3.1.4 (2010-3-6)
+* Set gem platform to java
+* Upgraded to tarpit ~> 1.2.0
+
+=== 3.1.3 (2009-10-10)
+* Rename gem rjack-httpclient-3 and as module RJack::HTTPClient3
+* Update/relax rjack-slf4j dependency to '~> 1.5.8' (tested with slf4j 1.5.8.1).
+* Replace included commons-codec with rjack-commons-codec gem dependency.
+* Use rjack-tarpit for build.
+
+=== 3.1.2 (2009-5-29)
+* Use rdoc 2.4.3 and hoe 1.12.2 for build.
+
+=== 3.1.1 (2009-2-22)
+* Inital release based on HttpClient 3.1

data/Manifest.static

@@ -0,0 +1,11 @@
+Manifest.static
+Manifest.txt
+README.rdoc
+History.rdoc
+NOTICE.txt
+Rakefile
+pom.xml
+assembly.xml
+lib/rjack-httpclient-3/base.rb
+lib/rjack-httpclient-3.rb
+test/test_httpclient.rb

data/Manifest.txt

@@ -0,0 +1,12 @@
+Manifest.static
+Manifest.txt
+README.rdoc
+History.rdoc
+NOTICE.txt
+Rakefile
+pom.xml
+assembly.xml
+lib/rjack-httpclient-3/base.rb
+lib/rjack-httpclient-3.rb
+test/test_httpclient.rb
+lib/rjack-httpclient-3/commons-httpclient-3.1.jar

data/NOTICE.txt

@@ -0,0 +1,7 @@
+rjack-httpclient-3 gem
+Copyright (c) 2008-2009 David Kellum
+
+This product includes software developed by:
+
+Apache HttpComponents Commons HttpClient
+Copyright (c) 1999-2008 The Apache Software Foundation (http://www.apache.org/)

data/README.rdoc

@@ -0,0 +1,78 @@
+= rjack-httpclient-3
+
+* http://rjack.rubyforge.org
+* http://rubyforge.org/projects/rjack
+
+== Description
+
+A gem packaging of
+{Commons HttpClient 3.x}[http://hc.apache.org/httpclient-3.x] for JRuby.
+
+* Provides commons-httpclient jar.
+* Provides a RJack::HTTPClient3::ManagerFacade for client and connection
+  manager setup, start, shutdown.
+
+== Synopsis
+
+ require 'rjack-logback'
+ require 'rjack-httpclient-3'
+
+ mf = RJack::HTTPClient3::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
+
+* rjack-commons-codec[http://rjack.rubyforge.org/commons-codec].
+
+* rjack-slf4j[http://rjack.rubyforge.org/slf4j].
+
+* An SLF4J output adaptor such as 'rjack-slf4j/simple' or
+  rjack-logback[http://rjack.rubyforge.org/logback] must be require'd
+  before rjack-httpclient.  (The rjack-logback gem is listed as a
+  development dependency only.)
+
+== License
+
+=== rjack-httpclient-3 gem
+
+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.
+
+=== Jakarta Commons HTTPClient (java)
+
+Copyright (c) 1999-2008 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,59 @@
+# -*- 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.
+#++
+
+$LOAD_PATH << './lib'
+require 'rjack-httpclient-3/base'
+
+require 'rubygems'
+gem     'rjack-tarpit', '~> 1.2.0'
+require 'rjack-tarpit'
+
+include RJack
+
+t = TarPit.new( 'rjack-httpclient-3', HTTPClient3::VERSION, :java_platform )
+
+t.specify do |h|
+  h.developer( "David Kellum", "dek-oss@gravitext.com" )
+  h.extra_deps     += [ [ 'rjack-slf4j',         '~> 1.5.8' ],
+                        [ 'rjack-commons-codec', '~> 1.4.0' ] ]
+  h.extra_dev_deps <<   [ 'rjack-logback',       '>= 0.9.17' ]
+  h.rubyforge_name = "rjack"
+  h.remote_rdoc_dir = "httpclient-3"
+end
+
+t.jars = [ "commons-httpclient-#{ HTTPClient3::HTTPCLIENT_VERSION }.jar" ]
+
+t.assembly_version = 1.0
+
+file 'Manifest.txt' => [ "lib/#{t.name}/base.rb" ]
+
+task :check_pom_deps do
+  t.test_line_match( 'pom.xml',
+                     %r[<version>#{ HTTPClient3::HTTPCLIENT_VERSION }</version>] )
+end
+task :check_history_version do
+  t.test_line_match( 'History.rdoc', /^==/, / #{t.version} / )
+end
+task :check_history_date do
+  t.test_line_match( 'History.rdoc', /^==/, /\([0-9\-]+\)$/ )
+end
+
+task :gem  => [ :check_pom_deps, :check_history_version                      ]
+task :tag  => [ :check_pom_deps, :check_history_version, :check_history_date ]
+task :push => [                                          :check_history_date ]
+
+t.define_tasks

data/assembly.xml

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

data/lib/rjack-httpclient-3.rb

@@ -0,0 +1,90 @@
+#--
+# 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 'rjack-slf4j'
+require 'rjack-slf4j/jcl-over-slf4j'
+require 'rjack-commons-codec'
+require 'rjack-httpclient-3/base'
+
+module RJack
+  module HTTPClient3
+
+    require "#{HTTPCLIENT_DIR}/commons-httpclient-#{HTTPCLIENT_VERSION}.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
+    #
+    # Expect incompatible changes to these setting upon upgrade to 4.0
+    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/rjack-httpclient-3/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 RJack
+  module HTTPClient3
+    HTTPCLIENT_VERSION = '3.1'
+    VERSION = HTTPCLIENT_VERSION + '.4'
+
+    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>rjack</groupId>
+  <artifactId>rjack-httpclient-3</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( 'rjack-logback', '>= 0.9.17.1' )
+
+require 'rjack-logback'
+Logback.config_console( :level => Logback::DEBUG )
+
+require 'test/unit'
+
+$LOAD_PATH.unshift File.join( File.dirname(__FILE__), "..", "lib" )
+
+require 'rjack-httpclient-3'
+
+class TestClient < Test::Unit::TestCase
+  include RJack::HTTPClient3
+  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,116 @@
+--- !ruby/object:Gem::Specification 
+name: rjack-httpclient-3
+version: !ruby/object:Gem::Version 
+  version: 3.1.4
+platform: java
+authors: 
+  - David Kellum
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-06 00:00:00 -08:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rjack-slf4j
+    type: :runtime
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 1.5.8
+      version: 
+  - !ruby/object:Gem::Dependency 
+    name: rjack-commons-codec
+    type: :runtime
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 1.4.0
+      version: 
+  - !ruby/object:Gem::Dependency 
+    name: rjack-logback
+    type: :development
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 0.9.17
+      version: 
+  - !ruby/object:Gem::Dependency 
+    name: rjack-tarpit
+    type: :development
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 1.2.0
+      version: 
+description: |-
+  A gem packaging of
+  {Commons HttpClient 3.x}[http://hc.apache.org/httpclient-3.x] for JRuby.
+  
+  * Provides commons-httpclient jar.
+  * Provides a RJack::HTTPClient3::ManagerFacade for client and connection
+    manager setup, start, shutdown.
+email: 
+  - dek-oss@gravitext.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - Manifest.txt
+  - NOTICE.txt
+  - README.rdoc
+  - History.rdoc
+files: 
+  - Manifest.static
+  - Manifest.txt
+  - README.rdoc
+  - History.rdoc
+  - NOTICE.txt
+  - Rakefile
+  - pom.xml
+  - assembly.xml
+  - lib/rjack-httpclient-3/base.rb
+  - lib/rjack-httpclient-3.rb
+  - test/test_httpclient.rb
+  - lib/rjack-httpclient-3/commons-httpclient-3.1.jar
+has_rdoc: true
+homepage: http://rjack.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+  - --main
+  - README.rdoc
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rjack
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A gem packaging of {Commons HttpClient 3.x}[http://hc.apache.org/httpclient-3.x] for JRuby
+test_files: 
+  - test/test_httpclient.rb