manticore 0.1.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3adc56dba6cc75385969e1b3654322a1c23c71f9
+  data.tar.gz: d695c2db318e5eaec73f6cdbd5641df4fd51af07
+SHA512:
+  metadata.gz: 9d09b50c6d313f09bd09cd0948905033079badb23f972430b29edfb6275312c750dc72d8274f76860d093747fd717de98436b7eddd4fb971df9998da4cc68907
+  data.tar.gz: 4d290e644a3a9426608f378aef1deaf625c1fdba81c36d303e63211c884e55391a6aab445eaddc2618df3a261a28bc0cc819af09ac8b44ca9ee5f9d620f2806e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - jruby

data/APACHE-LICENSE-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in manticore.gemspec
+gemspec
+
+gem "net-http-server"
+gem "rspec"
+gem "httpclient"
+gem "rack"

data/LICENSE.txt

@@ -0,0 +1,28 @@
+Copyright (c) 2013 Chris Heald
+
+Some JARs distributed with this project are licensed under the Apache 2.0 License. See APACHE-LICENSE-2.0.txt for details:
+
+  lib/jars/commons-logging-1.1.3.jar
+  lib/jars/httpclient-4.3.2.jar
+  lib/jars/httpcore-4.3.1.jar
+
+All other code distributed with this project is licensed under the MIT License as follows:
+
+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.md

@@ -0,0 +1,120 @@
+# Manticore
+
+[![Build Status](https://travis-ci.org/cheald/manticore.png?branch=master)](https://travis-ci.org/cheald/manticore)
+
+Manticore is a HTTP client with the fast, robust HTTP client built on the Apache HTTPClient libraries. It is only compatible with JRuby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'manticore'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install manticore
+
+## Documentation
+
+  Documentation is available [at rubydoc.info](http://rubydoc.info/github/cheald/manticore/master/frames).
+
+## Major Features
+
+  As it's built on the Apache Commons HTTP components, Manticore is very rich. It includes support for:
+
+  * Keepalive connections (and connection pooling)
+  * Transparent gzip and deflate handling
+  * Transparent cookie handling
+  * Both synchronous and asynchronous execution models
+  * SSL
+  * Much more!
+
+## Usage
+
+### Quick Start
+
+If you don't want to worry about setting up and maintaining client pools, Manticore comes with a facade that you can use to start making requests right away:
+
+    Manticore.get "http://www.google.com/"
+
+Additionally, you can mix the `Manticore::Facade` into your own class for similar behavior:
+
+    class MyClient
+      include Manticore::Facade
+      include_http_client user_agent: "MyClient/1.0"
+    end
+
+    MyClient.get "http://www.google.com/"
+
+Mixing the client into a class will create a new new pool. If you want to share a single pool between clients, specify the `shared_pool` option:
+
+    class MyClient
+      include Manticore::Facade
+      include_http_client shared_pool: true
+    end
+
+    class MyOtherClient
+      include Manticore::Facade
+      include_http_client shared_pool: true
+    end
+
+### More Control
+
+Manticore is built around a connection pool. When you create a `Client`, you will pass various parameters that it will use to set up the pool.
+
+    client = Manticore::Client.new(request_timeout: 5, connect_timeout: 5, socket_timeout: 5, pool_max: 10, pool_max_per_route: 2)
+
+Then, you can make requests from the client. Pooling and route maximum constraints are automatically managed:
+
+    response = client.get("http://www.google.com/")
+
+It is recommend that you instantiate a client once, then re-use it, rather than instantiating a new client per request.
+
+Additionally, if you pass a block to the initializer, the underlying [HttpClientBuilder](http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/impl/client/HttpClientBuilder.html) and [RequestConfig.Builder](http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/client/config/RequestConfig.Builder.html) will be yielded so that you can operate on them directly:
+
+    client = Manticore::Client.new(socket_timeout: 5) do |http_client_builder, request_builder|
+      http_client_builder.disable_redirect_handling
+    end
+
+### Parallel execution
+
+Manticore can perform multiple concurrent execution of requests.
+
+    client = Manticore::Client.new
+
+    # These aren't actually executed until #execute! is called.
+    # You can define response handlers in a block when you queue the request:
+    client.async_get("http://www.google.com") {|req|
+      req.on_success do |response, request|
+        puts response.body
+      end
+
+      req.on_failure do |exception|
+        puts "Boom! #{exception.message}"
+      end
+    }
+
+    # ...or by invoking the method on the queued response returned:
+    response = client.async_get("http://www.yahoo.com")
+    response.on_success do |response, request|
+      puts "The length of the Yahoo! homepage is #{response.body.length}"
+    end
+
+    # ...or even by chaining them onto the call
+    client.async_get("http://bing.com").
+      on_success {|r, _| puts r.code }.
+      on_failure {|e| puts "on noes!"}
+
+    client.execute!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--tty --color --format documentation']
+end
+task :default => :spec

data/lib/manticore/async_response.rb

@@ -0,0 +1,80 @@
+module Manticore
+  # AsyncResponse is a runnable/future that encapsulates a request to be run asynchronously. It is created by Client#async_* calls.
+  class AsyncResponse < Response
+    java_import 'java.util.concurrent.Callable'
+
+    include Callable
+
+    # Creates a new AsyncResponse. The response is not realized until the client associated
+    # with this response calls #execute!
+    def initialize(client, request, context, body_handler_block)
+      @client = client
+      @handlers = {
+        success:   ->(request){},
+        failure:   ->(ex){},
+        cancelled: ->{}
+      }
+      body_handler_block.call(self) if body_handler_block
+      super request, context, nil
+    end
+
+    # @private
+    # Implementation of Callable#call
+    def call
+      begin
+        @client.execute @request, self, @context
+      rescue Java::JavaNet::SocketTimeoutException, Java::OrgApacheHttpConn::ConnectTimeoutException, Java::OrgApacheHttp::NoHttpResponseException => e
+        @handlers[:failure].call( Manticore::Timeout.new(e.get_cause) )
+      rescue Java::OrgApacheHttpClient::ClientProtocolException => e
+        @handlers[:failure].call( Manticore::ClientProtocolException.new(e.get_cause) )
+      end
+    end
+
+    # Set handler for success responses
+    # @param block Proc which will be invoked on a successful response. Block will receive |response, request|
+    #
+    # @return self
+    def on_success(&block)
+      @handlers[:success] = block
+      self
+    end
+    alias_method :success, :on_success
+
+    # Set handler for failure responses
+    # @param block Proc which will be invoked on a on a failed response. Block will receive an exception object.
+    #
+    # @return self
+    def on_failure(&block)
+      @handlers[:failure] = block
+      self
+    end
+    alias_method :failure, :on_failure
+    alias_method :fail,    :on_failure
+
+    # Set handler for cancelled requests
+    # @param block Proc which will be invoked on a on a cancelled response.
+    #
+    # @return self
+    def on_cancelled(&block)
+      @handlers[:cancelled] = block
+      self
+    end
+    alias_method :cancelled,       :on_cancelled
+    alias_method :cancellation,    :on_cancelled
+    alias_method :on_cancellation, :on_cancelled
+
+    private
+
+    # @private
+    def handle_response(response)
+      begin
+        @response = response
+        @code     = response.get_status_line.get_status_code
+        @headers  = Hash[* response.get_all_headers.flat_map {|h| [h.get_name.downcase, h.get_value]} ]
+        @handlers[:success].call(self, @request)
+      rescue => e
+        @exception = e
+      end
+    end
+  end
+end