rjack-httpclient-4 4.0.1.1-java

data/History.rdoc

@@ -0,0 +1,23 @@
+=== 4.0.1.1 (2010-3-6)
+* Set gem platform to java
+* Upgraded to tarpit ~> 1.2.0
+
+=== 4.0.1.0 (2009-12-19)
+* Upgrade to HttpComponents HttpClient 4.0.1
+* Upgrade to tarpit-1.1.0 (gemcutter)
+
+=== 4.0.0 (2009-10-10)
+* Update jars and docs for HTTPComponents 4.0 HttpClient and dependencies.
+* Rename gem rjack-httpclient-4 and as module RJack::HTTPClient4
+
+=== 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-4/base.rb
+lib/rjack-httpclient-4.rb
+test/test_httpclient.rb

data/Manifest.txt

@@ -0,0 +1,13 @@
+Manifest.static
+Manifest.txt
+README.rdoc
+History.rdoc
+NOTICE.txt
+Rakefile
+pom.xml
+assembly.xml
+lib/rjack-httpclient-4/base.rb
+lib/rjack-httpclient-4.rb
+test/test_httpclient.rb
+lib/rjack-httpclient-4/httpclient-4.0.1.jar
+lib/rjack-httpclient-4/httpcore-4.0.1.jar

data/NOTICE.txt

@@ -0,0 +1,10 @@
+rjack-httpclient-4 gem
+Copyright (c) 2009 David Kellum
+
+This product includes software developed by:
+
+Apache HttpComponents Client
+Copyright 1999-2009 The Apache Software Foundation
+
+  This project contains annotations derived from JCIP-ANNOTATIONS
+  Copyright (c) 2005 Brian Goetz and Tim Peierls. See http://www.jcip.net

data/README.rdoc

@@ -0,0 +1,82 @@
+= rjack-httpclient-4
+
+* http://rjack.rubyforge.org
+* http://rubyforge.org/projects/rjack
+
+== Description
+
+A gem packaging of the {HttpComponents}[http://hc.apache.org/] HTTP
+Client 4.x for JRuby.
+
+* Provides httpclient and httpcore jars.
+* Provides a RJack::HTTPClient4::ManagerFacade for client and connection
+  manager setup, start, shutdown.
+
+== Synopsis
+
+ require 'rjack-logback'
+ require 'rjack-httpclient-4'
+
+ mf = RJack::HTTPClient4::ManagerFacade.new
+
+ mf.connection_params.so_timeout         = 2000 #ms
+ mf.manager_params.timeout               = 2000 #ms
+ mf.manager_params.max_total_connections = 200
+ mf.manager_params.connections_per_route = 10
+ mf.client_params.default_headers        = { "X-Name" => "value" }
+ mf.client_params.cookie_policy          = CookiePolicy::BEST_MATCH
+ mf.start
+
+ mf.client # --> org.apache.http.client.HttpClient
+
+ mf.shutdown
+
+See {org.apache.http.client.HttpClient}[http://hc.apache.org/httpcomponents-client/httpclient/apidocs/org/apache/http/client/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-4 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.
+
+=== HttpComponents Client (java)
+
+Copyright (c) 1999-2009 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,57 @@
+# -*- 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-4/base'
+
+require 'rubygems'
+gem     'rjack-tarpit', '~> 1.2.0'
+require 'rjack-tarpit'
+
+include RJack
+
+t = TarPit.new( 'rjack-httpclient-4',
+                HTTPClient4::VERSION,
+                :jars_from_assembly, :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-4"
+end
+
+t.assembly_version = 1.0
+
+task :check_pom_deps do
+  t.test_line_match( 'pom.xml',
+                     %r[<version>#{ HTTPClient4::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,15 @@
+<assembly>
+  <id>bin</id>
+  <formats>
+    <format>dir</format>
+  </formats>
+  <includeBaseDirectory>false</includeBaseDirectory>
+  <dependencySets>
+    <dependencySet>
+      <includes>
+        <include>org.apache.httpcomponents:httpclient</include>
+        <include>org.apache.httpcomponents:httpcore</include>
+      </includes>
+    </dependencySet>
+  </dependencySets>
+</assembly>

data/lib/rjack-httpclient-4.rb

@@ -0,0 +1,175 @@
+#--
+# 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-4/base'
+
+module RJack
+  module HTTPClient4
+
+    Dir.glob( File.join( HTTPCLIENT_DIR, '*.jar' ) ).each { |jar| require jar }
+
+    import 'org.apache.http.client.params.ClientParamBean'
+    import 'org.apache.http.client.params.CookiePolicy'
+    import 'org.apache.http.conn.MultihomePlainSocketFactory'
+    import 'org.apache.http.conn.params.ConnManagerParamBean'
+    import 'org.apache.http.conn.params.ConnPerRouteBean'
+    import 'org.apache.http.conn.scheme.Scheme'
+    import 'org.apache.http.conn.scheme.SchemeRegistry'
+    import 'org.apache.http.conn.ssl.SSLSocketFactory'
+    import 'org.apache.http.impl.client.DefaultHttpClient'
+    import 'org.apache.http.impl.client.DefaultHttpRequestRetryHandler'
+    import 'org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager'
+    import 'org.apache.http.message.BasicHeader'
+    import 'org.apache.http.params.BasicHttpParams'
+    import 'org.apache.http.params.HttpConnectionParamBean'
+
+    # Facade over http client and connection manager, supporting
+    # setup -> start() -> shutdown()
+    class ManagerFacade
+      # {Manager parameters}[http://hc.apache.org/httpcomponents-client/httpclient/apidocs/org/apache/http/conn/params/ConnManagerParamBean.html]
+      # "bean", responding to various setters:
+      #
+      #  manager_params.max_total_connections     = 200
+      #  manager_params.timeout                   = 2000     #milliseconds
+      #  manager_params.connections_per_route     = 10
+      #
+      attr_reader :manager_params
+
+      # {Client parameters}[http://hc.apache.org/httpcomponents-client/httpclient/apidocs/org/apache/http/client/params/ClientParamBean.html]
+      # "bean", responding to various setters:
+      #
+      #  client_params.allow_circular_redirects   = false
+      #  client_params.cookie_policy              = CookiePolicy::BEST_MATCH
+      #  client_params.default_headers            = { "X-Name" => "value" }
+      #  client_params.handle_redirects           = true
+      #  client_params.reject_relative_redirect   = true
+      #
+      attr_reader :client_params
+
+      # {Connection parameters}[http://hc.apache.org/httpcomponents-core/httpcore/apidocs/org/apache/http/params/HttpConnectionParamBean.html]
+      # "bean", responding to various setters:
+      #
+      #  connection_params.connection_timeout     = 2000     #milliseconds
+      #  connection_params.so_timeout             = 3000     #milliseconds
+      #  connection_params.linger                 = 2        #seconds
+      #  connection_params.socket_buffer_size     = 2 * 1024 #bytes
+      #  connection_params.stale_checking_enabled = true
+      #  connection_params.tcp_no_delay           = false
+      #
+      attr_reader :connection_params
+
+      # {org.apache.http.client.HttpClient}[http://hc.apache.org/httpcomponents-client/httpclient/apidocs/org/apache/http/client/HttpClient.html]
+      # available after start()
+      attr_reader :client
+
+      # New facade ready for setup
+      def initialize
+        @mparams = BasicHttpParams.new
+        @cparams = BasicHttpParams.new
+
+        @manager_params    = ConnManagerParamBean.new( @mparams )
+        @client_params     = ClientParamBean.new( @cparams )
+        @connection_params = HttpConnectionParamBean.new( @cparams )
+
+        @client = nil
+        @connection_manager = nil
+        @retry_handler = nil
+      end
+
+      # Setup a DefaultHttpRequestRetryHandler
+      def set_retry_handler( count, retry_if_sent = false )
+        @retry_handler =
+          DefaultHttpRequestRetryHandler.new( count, retry_if_sent )
+      end
+
+      # Given previous setup, create connection manager, create, and
+      # return client.
+      def start
+        @scheme_registry = create_scheme_registry
+        @connection_manager = create_connection_manager
+
+        @client = create_http_client
+      end
+
+      # Shutdown client and connection manager.
+      def shutdown
+        @connection_manager.shutdown if @connection_manager
+        @client = nil
+        @connection_manager = nil
+      end
+
+      # Create a default SchemeRegistry with http and https enabled.
+      def create_scheme_registry
+        sr = SchemeRegistry.new
+        sr.register( Scheme.new( "http",  plain_factory,  80 ) )
+        sr.register( Scheme.new( "https", ssl_factory,   443 ) )
+        sr
+      end
+
+      # Return MultihomePlainSocketFactory instance
+      def plain_factory
+        MultihomePlainSocketFactory::socket_factory
+      end
+
+      # Return SSLSocketFactory instance
+      def ssl_factory
+        SSLSocketFactory::socket_factory
+      end
+
+      # Create default ThreadSafeClientConnManager using a set manager_params
+      def create_connection_manager
+        ThreadSafeClientConnManager.new( @mparams, @scheme_registry )
+      end
+
+      # Create DefaultHttpClient given connection manager and any set
+      # client or connection_params
+      def create_http_client
+        c = DefaultHttpClient.new( @connection_manager, @cparams )
+        c.http_request_retry_handler = @retry_handler if @retry_handler
+        c
+      end
+
+    end
+
+    # ConnManagerParamBean reopen
+    class ConnManagerParamBean
+      # Convert to ConnPerRouteBean.new( value ) unless is one.
+      def connections_per_route=( value )
+        unless value.is_a?( ConnPerRouteBean )
+          value = ConnPerRouteBean.new( value.to_i )
+        end
+        setConnectionsPerRoute( value )
+      end
+    end
+
+    # ClientParamBean reopen
+    class ClientParamBean
+      # Convert to [ BasicHeader.new( k,v ) ] if value is hash.
+      def default_headers=( value )
+        if value.is_a?( Hash )
+          value = value.map { |nv| BasicHeader.new( *nv ) }
+        end
+        setDefaultHeaders( value )
+      end
+    end
+
+  end
+end

data/lib/rjack-httpclient-4/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 HTTPClient4
+    HTTPCLIENT_VERSION = '4.0.1'
+    VERSION = HTTPCLIENT_VERSION + '.1'
+
+    HTTPCLIENT_DIR = File.dirname( __FILE__ ) # :nodoc:
+  end
+end

data/pom.xml

@@ -0,0 +1,75 @@
+<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-4</artifactId>
+  <packaging>pom</packaging>
+  <version>1.0</version>
+  <name>HTTPClient Assembly for Gem</name>
+
+  <dependencies>
+
+     <dependency>
+      <groupId>org.apache.httpcomponents</groupId>
+      <artifactId>httpclient</artifactId>
+      <version>4.0.1</version>
+      <exclusions>
+        <exclusion>
+          <groupId>commons-logging</groupId>
+          <artifactId>commons-logging</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>
+
+    <!--
+    <dependency>
+      <groupId>org.apache.httpcomponents</groupId>
+      <artifactId>httpmime</artifactId>
+      <version>4.0</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,60 @@
+#!/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-4'
+
+class TestClient < Test::Unit::TestCase
+  include RJack::HTTPClient4
+  def test_setup
+    mf = ManagerFacade.new
+
+    mf.manager_params.max_total_connections     = 200
+    mf.manager_params.timeout                   = 2000     #milliseconds
+    mf.manager_params.connections_per_route     = 10
+    mf.client_params.allow_circular_redirects   = false
+    mf.client_params.cookie_policy              = CookiePolicy::BEST_MATCH
+    mf.client_params.default_headers            = { "X-Name" => "value" }
+    mf.client_params.handle_redirects           = true
+    mf.client_params.reject_relative_redirect   = true
+    mf.connection_params.connection_timeout     = 2000     #milliseconds
+    mf.connection_params.so_timeout             = 3000     #milliseconds
+    mf.connection_params.linger                 = 2        #seconds
+    mf.connection_params.socket_buffer_size     = 2 * 1024 #bytes
+    mf.connection_params.stale_checking_enabled = true
+    mf.connection_params.tcp_no_delay           = false
+
+    mf.set_retry_handler( 2 )
+
+    mf.start
+
+    assert_not_nil mf.client
+
+    mf.shutdown
+
+    assert_nil mf.client
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: rjack-httpclient-4
+version: !ruby/object:Gem::Version 
+  version: 4.0.1.1
+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 the {HttpComponents}[http://hc.apache.org/] HTTP
+  Client 4.x for JRuby.
+  
+  * Provides httpclient and httpcore jars.
+  * Provides a RJack::HTTPClient4::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-4/base.rb
+  - lib/rjack-httpclient-4.rb
+  - test/test_httpclient.rb
+  - lib/rjack-httpclient-4/httpclient-4.0.1.jar
+  - lib/rjack-httpclient-4/httpcore-4.0.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 the {HttpComponents}[http://hc.apache.org/] HTTP Client 4.x for JRuby
+test_files: 
+  - test/test_httpclient.rb