httpadapter 0.1.1

data/CHANGELOG

@@ -0,0 +1,3 @@
+== 0.1.0
+
+* initial release

data/LICENSE

@@ -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/README

@@ -0,0 +1,47 @@
+== HTTPAdapter
+
+Homepage::  httpadapter.rubyforge.org[http://httpadapter.rubyforge.org/]
+Author::    Bob Aman  (mailto:bob@sporkmonger.com)
+Copyright:: Copyright © 2010 Google Inc.
+License::   Apache 2.0
+
+== Description
+
+A library for translating HTTP request and response objects for various clients into a common representation.
+
+== Reference
+
+- {HTTPAdapter}
+
+== Adapters
+
+- {HTTPAdapter::NetHTTPRequestAdapter}
+- {HTTPAdapter::NetHTTPResponseAdapter}
+- {HTTPAdapter::TyphoeusRequestAdapter}
+- {HTTPAdapter::TyphoeusResponseAdapter}
+
+== Example Usage
+
+  response = Net::HTTP.start('www.google.com', 80) { |http| http.get('/') }
+  # => #<Net::HTTPOK 200 OK readbody=true>
+  result = HTTPAdapter.adapt_response(
+    response, HTTPAdapter::NetHTTPResponseAdapter
+  )
+  # => [
+  #   200,
+  #   [
+  #     ["Expires", "-1"],
+  #     ["Content-Type", "text/html; charset=ISO-8859-1"],
+  #     ["X-Xss-Protection", "1; mode=block"],
+  #     ["Server", "gws"],
+  #     ["Date", "Thu, 26 Aug 2010 22:13:03 GMT"],
+  #     ["Set-Cookie", "<snip>"],
+  #     ["Cache-Control", "private, max-age=0"],
+  #     ["Transfer-Encoding", "chunked"]
+  #   ],
+  #   ["<snip>"]
+  # ]
+
+== Install
+
+* sudo gem install httpadapter

data/Rakefile

@@ -0,0 +1,59 @@
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), "lib"))
+$:.unshift(lib_dir)
+$:.uniq!
+
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  STDERR.puts "Please install rspec:"
+  STDERR.puts "sudo gem install rspec"
+  exit(1)
+end
+
+require File.join(File.dirname(__FILE__), 'lib/httpadapter', 'version')
+
+PKG_DISPLAY_NAME   = 'HTTPAdapter'
+PKG_NAME           = PKG_DISPLAY_NAME.downcase
+PKG_VERSION        = HTTPAdapter::VERSION::STRING
+PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
+
+RELEASE_NAME       = "REL #{PKG_VERSION}"
+
+RUBY_FORGE_PROJECT = PKG_NAME
+RUBY_FORGE_USER    = "sporkmonger"
+RUBY_FORGE_PATH    = "/var/www/gforge-projects/#{RUBY_FORGE_PROJECT}"
+RUBY_FORGE_URL     = "http://#{RUBY_FORGE_PROJECT}.rubyforge.org/"
+
+PKG_AUTHOR         = "Bob Aman"
+PKG_AUTHOR_EMAIL   = "bob@sporkmonger.com"
+PKG_HOMEPAGE       = RUBY_FORGE_URL
+PKG_SUMMARY        = "Package Summary"
+PKG_DESCRIPTION    = <<-TEXT
+A library for translating HTTP request and response objects for various clients into a common representation.
+TEXT
+
+PKG_FILES = FileList[
+    "lib/**/*", "spec/**/*", "vendor/**/*",
+    "tasks/**/*", "website/**/*",
+    "[A-Z]*", "Rakefile"
+].exclude(/database\.yml/).exclude(/[_\.]git$/)
+
+RCOV_ENABLED = (RUBY_PLATFORM != "java" && RUBY_VERSION =~ /^1\.8/)
+if RCOV_ENABLED
+  task :default => "spec:verify"
+else
+  task :default => "spec"
+end
+
+WINDOWS = (RUBY_PLATFORM =~ /mswin|win32|mingw|bccwin|cygwin/) rescue false
+SUDO = WINDOWS ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/lib/httpadapter/adapters/net_http.rb

@@ -0,0 +1,192 @@
+# Copyright (C) 2010 Google Inc.
+#
+#    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 'httpadapter'
+require 'net/http'
+require 'addressable/uri'
+
+module HTTPAdapter #:nodoc:
+  class NetHTTPRequestAdapter
+    METHOD_MAPPING = {
+      # RFC 2616
+      'OPTIONS' => Net::HTTP::Options,
+      'GET' => Net::HTTP::Get,
+      'HEAD' => Net::HTTP::Head,
+      'POST' => Net::HTTP::Post,
+      'PUT' => Net::HTTP::Put,
+      'DELETE' => Net::HTTP::Delete,
+      'TRACE' => Net::HTTP::Trace,
+      # Other standards supported by Net::HTTP
+      'COPY' => Net::HTTP::Copy,
+      'LOCK' => Net::HTTP::Lock,
+      'MKCOL' => Net::HTTP::Mkcol,
+      'MOVE' => Net::HTTP::Move,
+      'PROPFIND' => Net::HTTP::Propfind,
+      'PROPPATCH' => Net::HTTP::Proppatch,
+      'UNLOCK' => Net::HTTP::Unlock
+    }
+
+    def initialize(request, options={})
+      unless request.kind_of?(Net::HTTPRequest)
+        raise TypeError, "Expected Net::HTTPRequest, got #{request.class}."
+      end
+      @request = request
+      @uri = Addressable::URI.parse(options[:uri] || request.path || "")
+      if !@uri.host && options[:host]
+        @uri.host = options[:host]
+        if !@uri.scheme && options[:scheme]
+          @uri.scheme = options[:scheme]
+        elsif !@uri.scheme
+          @uri.scheme = 'http'
+        end
+        if !@uri.port && options[:port]
+          @uri.port = options[:port]
+        end
+        @uri.scheme = @uri.normalized_scheme
+        @uri.authority = @uri.normalized_authority
+      end
+    end
+
+    def to_ary
+      method = @request.method.to_s.upcase
+      uri = @uri.to_str
+      headers = []
+      @request.canonical_each do |header, value|
+        headers << [header, value]
+      end
+      body = @request.body || ""
+      return [method, uri, headers, [body]]
+    end
+
+    def self.from_ary(array)
+      method, uri, headers, body = array
+      method = method.to_s.upcase
+      uri = Addressable::URI.parse(uri)
+      request_class = METHOD_MAPPING[method]
+      unless request_class
+        raise ArgumentError, "Unknown HTTP method: #{method}"
+      end
+      request = request_class.new(uri.request_uri)
+      headers.each do |header, value|
+        request[header] = value
+      end
+      merged_body = ""
+      body.each do |chunk|
+        merged_body += chunk
+      end
+      request.body = merged_body
+      return request
+    end
+  end
+
+  class NetHTTPResponseAdapter
+    STATUS_MESSAGES = {
+      100 => "Continue",
+      101 => "Switching Protocols",
+      102 => "Processing",
+
+      200 => "OK",
+      201 => "Created",
+      202 => "Accepted",
+      203 => "Non-Authoritative Information",
+      204 => "No Content",
+      205 => "Reset Content",
+      206 => "Partial Content",
+      207 => "Multi-Status",
+      226 => "IM Used",
+
+      300 => "Multiple Choices",
+      301 => "Moved Permanently",
+      302 => "Found",
+      303 => "See Other",
+      304 => "Not Modified",
+      305 => "Use Proxy",
+      307 => "Temporary Redirect",
+
+      400 => "Bad Request",
+      401 => "Unauthorized",
+      402 => "Payment Required",
+      403 => "Forbidden",
+      404 => "Not Found",
+      405 => "Method Not Allowed",
+      406 => "Not Acceptable",
+      407 => "Proxy Authentication Required",
+      408 => "Request Timeout",
+      409 => "Conflict",
+      410 => "Gone",
+      411 => "Length Required",
+      412 => "Precondition Failed",
+      413 => "Request Entity Too Large",
+      414 => "Request-URI Too Long",
+      415 => "Unsupported Media Type",
+      416 => "Requested Range Not Satisfiable",
+      417 => "Expectation Failed",
+      422 => "Unprocessable Entity",
+      423 => "Locked",
+      424 => "Failed Dependency",
+      426 => "Upgrade Required",
+
+      500 => "Internal Server Error",
+      501 => "Not Implemented",
+      502 => "Bad Gateway",
+      503 => "Service Unavailable",
+      504 => "Gateway Timeout",
+      505 => "HTTP Version Not Supported",
+      507 => "Insufficient Storage",
+      510 => "Not Extended"
+    }
+    STATUS_MAPPING = Net::HTTPResponse::CODE_TO_OBJ
+
+    def initialize(response)
+      unless response.kind_of?(Net::HTTPResponse)
+        raise TypeError, "Expected Net::HTTPResponse, got #{response.class}."
+      end
+      @response = response
+    end
+
+    def to_ary
+      status = @response.code.to_i
+      headers = []
+      @response.canonical_each do |header, value|
+        headers << [header, value]
+      end
+      body = @response.body || ""
+      return [status, headers, [body]]
+    end
+
+    def self.from_ary(array)
+      status, headers, body = array
+      message = STATUS_MESSAGES[status.to_i]
+      response_class = STATUS_MAPPING[status.to_s]
+      unless message && response_class
+        raise ArgumentError, "Unknown status code: #{status}"
+      end
+      status = status.to_i
+      response = response_class.new('1.1', status.to_s, message)
+      headers.each do |header, value|
+        response.add_field(header, value)
+      end
+      merged_body = ""
+      body.each do |chunk|
+        merged_body += chunk
+      end
+
+      # Ugh
+      response.instance_variable_set('@read', true)
+      response.instance_variable_set('@body', merged_body)
+
+      return response
+    end
+  end
+end

data/lib/httpadapter/adapters/rack.rb

@@ -0,0 +1,117 @@
+# Copyright (C) 2010 Google Inc.
+#
+#    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 'httpadapter'
+require 'rack'
+require 'rack/request'
+require 'rack/response'
+require 'addressable/uri'
+
+module HTTPAdapter #:nodoc:
+  class RackRequestAdapter
+    def initialize(request, error_stream=STDERR)
+      unless request.kind_of?(Rack::Request)
+        raise TypeError, "Expected Rack::Request, got #{request.class}."
+      end
+      @request = request
+      @error_stream = error_stream
+    end
+
+    def to_ary
+      method = @request.request_method.to_s.upcase
+      uri = Addressable::URI.parse(@request.url.to_s).normalize.to_s
+      headers = []
+      @request.env.each do |parameter, value|
+        next if parameter !~ /^HTTP_/
+        # Ugh, lossy canonicalization again
+        header = (parameter.gsub(/^HTTP_/, '').split('_').map do |chunk|
+          chunk.capitalize
+        end).join('-')
+        headers << [header, value]
+      end
+      return [method, uri, headers, @request.body]
+    end
+
+    def self.from_ary(array)
+      # These contortions are really obnoxious; lossiness is bad!
+      method, uri, headers, body = array
+      env = {}
+      method = method.to_s.upcase
+      uri = Addressable::URI.parse(uri)
+      body_io = StringIO.new
+      body.each do |chunk|
+        unless chunk.kind_of?(String)
+          raise TypeError, "Expected String, got #{chunk.class}."
+        end
+        body_io.write(chunk)
+      end
+      body_io.rewind
+
+      # PEP333 variables
+      env['REQUEST_METHOD'] = method
+      env['SERVER_NAME'] = uri.host || ''
+      env['SERVER_PORT'] = uri.port || '80'
+      env['SCRIPT_NAME'] = ''
+      env['PATH_INFO'] = uri.path
+      env['QUERY_STRING'] = uri.query || ''
+
+      # Rack-specific variables
+      env['rack.version'] = Rack::VERSION
+      env['rack.input'] = body_io
+      env['rack.errors'] = @error_stream
+      env['rack.multithread'] = true # maybe?
+      env['rack.multiprocess'] = true # maybe?
+      env['rack.run_once'] = false
+      env['rack.url_scheme'] = uri.scheme || 'http'
+
+      headers.each do |header, value|
+        case header.downcase
+        when 'content-length'
+          env['CONTENT_LENGTH'] = value
+        when 'content-type'
+          env['CONTENT_TYPE'] = value
+        end
+        env['HTTP_' + header.gsub(/\-/, "_").upcase] = value
+      end
+      request = Rack::Request.new(env)
+      return request
+    end
+  end
+
+  class RackResponseAdapter
+    def initialize(response)
+      unless response.kind_of?(Rack::Response)
+        raise TypeError, "Expected Rack::Response, got #{response.class}."
+      end
+      @response = response
+    end
+
+    def to_ary
+      return @response.finish
+    end
+
+    def self.from_ary(array)
+      status, headers, body = array
+      status = status.to_i
+      body.each do |chunk|
+        # Purely for strict type-checking
+        unless chunk.kind_of?(String)
+          raise TypeError, "Expected String, got #{chunk.class}."
+        end
+      end
+      response = Rack::Response.new(body, status, Hash[headers])
+      return response
+    end
+  end
+end