httpadapter 0.1.1 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,11 @@
+== 0.2.0
+
+* abstracted transmission of HTTP requests
+
+== 0.1.1
+
+* dependencies fixed
+
 == 0.1.0
 
 * initial release

data/README

@@ -17,6 +17,8 @@ A library for translating HTTP request and response objects for various clients
 
 - {HTTPAdapter::NetHTTPRequestAdapter}
 - {HTTPAdapter::NetHTTPResponseAdapter}
+- {HTTPAdapter::RackRequestAdapter}
+- {HTTPAdapter::RackResponseAdapter}
 - {HTTPAdapter::TyphoeusRequestAdapter}
 - {HTTPAdapter::TyphoeusResponseAdapter}
 

data/lib/httpadapter.rb

@@ -12,7 +12,8 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-require "httpadapter/version"
+require 'httpadapter/version'
+require 'httpadapter/connection'
 
 module HTTPAdapter #:nodoc:
   ##
@@ -109,12 +110,40 @@ module HTTPAdapter #:nodoc:
     if adapter.respond_to?(:from_ary)
       return adapter.from_ary(response)
     else
+      raise TypeError, 'Expected adapter to implement .from_ary.'
+    end
+  end
+
+  ##
+  # Transmits a request.
+  #
+  # @param [Array] request
+  #   The request that will be sent.
+  # @param [#transmit] adapter
+  #   The adapter object that will perform the transmission of the HTTP
+  #   request.  It must respond to <code>#transmit</code>.  Typically a
+  #   reference to a class is used.
+  # @param [HTTPAdapter::Connection] connection
+  #   An object representing a connection.  This object represents an open
+  #   HTTP connection that is used to make multiple HTTP requests.
+  # @return [Array]
+  #   The response given by the server.
+  #
+  # @return [Array] The implementation-specific response object.
+  def self.transmit(request, adapter, connection=nil)
+    request = self.verified_request(request)
+    if connection && !connection.kind_of?(HTTPAdapter::Connection)
       raise TypeError,
-        "Expected adapter to implement .from_ary."
+        "Expected HTTPAdapter::Connection, got #{connection.class}."
+    end
+    if adapter.respond_to?(:transmit)
+      response = adapter.transmit(request, connection)
+      return self.verified_response(response)
+    else
+      raise TypeError, 'Expected adapter to implement .transmit.'
     end
   end
 
-protected
   ##
   # Verifies a request tuple matches the specification.
   #

data/lib/httpadapter/adapters/net_http.rb

@@ -13,6 +13,7 @@
 #    limitations under the License.
 
 require 'httpadapter'
+require 'httpadapter/connection'
 require 'net/http'
 require 'addressable/uri'
 
@@ -80,14 +81,55 @@ module HTTPAdapter #:nodoc:
       request = request_class.new(uri.request_uri)
       headers.each do |header, value|
         request[header] = value
+        if header.downcase == 'Content-Type'.downcase
+          request.content_type = value
+        end
       end
       merged_body = ""
       body.each do |chunk|
         merged_body += chunk
       end
-      request.body = merged_body
+      if merged_body.length > 0
+        request.body = merged_body
+      elsif ['POST', 'PUT'].include?(method)
+        request.content_length = 0
+      end
       return request
     end
+
+    def self.transmit(request, connection=nil)
+      method, uri, headers, body = request
+      uri = Addressable::URI.parse(uri)
+      net_http_request = self.from_ary([method, uri, headers, body])
+      net_http_response = nil
+      unless connection
+        http = Net::HTTP.new(uri.host, uri.inferred_port)
+        if uri.normalized_scheme == 'https'
+          require 'net/https'
+          http.use_ssl = true
+          if http.respond_to?(:enable_post_connection_check=)
+            http.enable_post_connection_check = true
+          end
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          store = OpenSSL::X509::Store.new
+          store.set_default_paths
+          http.cert_store = store
+        end
+        http.start
+        connection = HTTPAdapter::Connection.new(
+          uri.host, uri.inferred_port, http,
+          :open => [:start, [], nil],
+          :close => [:finish, [], nil]
+        )
+      else
+        http = nil
+      end
+      net_http_response = connection.connection.request(net_http_request)
+      if http
+        connection.close
+      end
+      return NetHTTPResponseAdapter.new(net_http_response).to_ary
+    end
   end
 
   class NetHTTPResponseAdapter

data/lib/httpadapter/adapters/rack.rb

@@ -87,6 +87,11 @@ module HTTPAdapter #:nodoc:
       request = Rack::Request.new(env)
       return request
     end
+
+    def self.transmit(request, connection=nil)
+      raise NotImplementedError,
+        'No HTTP client implementation available to transmit a Rack::Request.'
+    end
   end
 
   class RackResponseAdapter

data/lib/httpadapter/adapters/typhoeus.rb

@@ -42,18 +42,44 @@ module HTTPAdapter #:nodoc:
       method, uri, headers, body = array
       method = method.to_s.downcase.to_sym
       uri = Addressable::URI.parse(uri)
+      headers = Hash[headers]
       merged_body = ""
       body.each do |chunk|
         merged_body += chunk
       end
+      if merged_body == ''
+        merged_body = nil
+      end
       request = Typhoeus::Request.new(
         uri.to_str,
         :method => method,
-        :headers => Hash[headers],
+        :headers => headers,
         :body => merged_body
       )
       return request
     end
+
+    def self.transmit(request, connection=nil)
+      method, uri, headers, body = request
+      uri = Addressable::URI.parse(uri)
+      typhoeus_request = self.from_ary([method, uri, headers, body])
+      typhoeus_response = nil
+      unless connection
+        hydra = Typhoeus::Hydra.new
+        connection = HTTPAdapter::Connection.new(
+          uri.host, uri.inferred_port, hydra,
+          :join => [:run, [], nil]
+        )
+      else
+        http = nil
+      end
+      typhoeus_request.on_complete do |response|
+        typhoeus_response = response
+      end
+      connection.connection.queue(typhoeus_request)
+      connection.join
+      return TyphoeusResponseAdapter.new(typhoeus_response).to_ary
+    end
   end
 
   class TyphoeusResponseAdapter
@@ -68,7 +94,16 @@ module HTTPAdapter #:nodoc:
       status = @response.code.to_i
       headers = []
       @response.headers_hash.each do |header, value|
-        headers << [header, value]
+        # Eh? Seriously?  This is NOT a header!
+        next if header =~ /^HTTP\/\d\.\d \d{3} .+$/
+        if value.kind_of?(Array)
+          for repeated_header_value in value
+            # Header appears multiple times; common for Set-Cookie
+            headers << [header, repeated_header_value]
+          end
+        else
+          headers << [header, value]
+        end
       end
       body = @response.body || ""
       return [status, headers, [body]]

data/lib/httpadapter/connection.rb

@@ -0,0 +1,73 @@
+# 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'
+
+module HTTPAdapter #:nodoc:
+  class Connection
+    def initialize(host, port, connection, options={})
+      if !host.respond_to?(:to_str)
+        raise TypeError, "Expected String, got #{host.class}."
+      end
+      @host = host.to_str
+      if port.kind_of?(Symbol) || !port.respond_to?(:to_i)
+        raise TypeError, "Expected Integer, got #{port.class}."
+      end
+      @port = port.to_i
+      unless (1..65535) === @port
+        raise ArgumentError, "Invalid port number."
+      end
+      @connection = connection
+      @options = options
+    end
+
+    def open
+      if @options[:open]
+        method, args, block = @options[:open]
+        method ||= :open
+        args ||= []
+        return @connection.send(method, *args, &block)
+      else
+        # No-op
+        return nil
+      end
+    end
+
+    def close
+      if @options[:close]
+        method, args, block = @options[:close]
+        method ||= :close
+        args ||= []
+        return @connection.send(method, *args, &block)
+      else
+        # No-op
+        return nil
+      end
+    end
+
+    def join
+      if @options[:join]
+        method, args, block = @options[:join]
+        method ||= :join
+        args ||= []
+        return @connection.send(method, *args, &block)
+      else
+        # No-op
+        return nil
+      end
+    end
+
+    attr_reader :host, :port, :connection
+  end
+end

data/lib/httpadapter/version.rb

@@ -17,8 +17,8 @@ unless defined? HTTPAdapter::VERSION
   module HTTPAdapter #:nodoc:
     module VERSION #:nodoc:
       MAJOR = 0
-      MINOR = 1
-      TINY  = 1
+      MINOR = 2
+      TINY  = 0
 
       STRING = [MAJOR, MINOR, TINY].join('.')
     end

data/spec/httpadapter/adapters/net_http_transmission_spec.rb

@@ -0,0 +1,130 @@
+# 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 'spec_helper'
+
+require 'httpadapter/adapters/net_http'
+
+if ([:enable_post_connection_check=, 'enable_post_connection_check='] &
+    Net::HTTP.instance_methods).empty?
+  class Net::HTTP
+    def enable_post_connection_check=(value)
+      # No-op
+    end
+  end
+end
+
+describe HTTPAdapter::NetHTTPRequestAdapter, 'transmitting a GET tuple' do
+  before do
+    @tuple = [
+      'GET',
+      'http://www.google.com/',
+      [],
+      []
+    ]
+    @response = HTTPAdapter.transmit(
+      @tuple, HTTPAdapter::NetHTTPRequestAdapter
+    )
+    @status, @headers, @chunked_body = @response
+    @body = ''
+    @chunked_body.each do |chunk|
+      @body += chunk
+    end
+  end
+
+  it 'should have the correct status' do
+    @status.should == 200
+  end
+
+  it 'should have response headers' do
+    @headers.should_not be_empty
+  end
+
+  it 'should have a response body' do
+    @body.length.should > 0
+  end
+end
+
+describe HTTPAdapter::NetHTTPRequestAdapter, 'transmitting a GET tuple' do
+  before do
+    @tuple = [
+      'GET',
+      'https://www.google.com/',
+      [],
+      []
+    ]
+    @response = HTTPAdapter.transmit(
+      @tuple, HTTPAdapter::NetHTTPRequestAdapter
+    )
+    @status, @headers, @chunked_body = @response
+    @body = ''
+    @chunked_body.each do |chunk|
+      @body += chunk
+    end
+  end
+
+  it 'should have the correct status' do
+    @status.should == 200
+  end
+
+  it 'should have response headers' do
+    @headers.should_not be_empty
+  end
+
+  it 'should have a response body' do
+    @body.length.should > 0
+  end
+end
+
+describe HTTPAdapter::NetHTTPRequestAdapter, 'transmitting with connection' do
+  before do
+    @connection = HTTPAdapter::Connection.new(
+      'www.google.com', 80,
+      Net::HTTP.new('www.google.com', 80),
+      :open => [:start],
+      :close => [:finish]
+    )
+    @connection.open
+    @tuple = [
+      'GET',
+      'http://www.google.com/',
+      [],
+      []
+    ]
+    @response = HTTPAdapter.transmit(
+      @tuple, HTTPAdapter::NetHTTPRequestAdapter, @connection
+    )
+    @status, @headers, @chunked_body = @response
+    @body = ''
+    @chunked_body.each do |chunk|
+      @body += chunk
+    end
+  end
+
+  after do
+    @connection.close
+  end
+
+  it 'should have the correct status' do
+    @status.should == 200
+  end
+
+  it 'should have response headers' do
+    @headers.should_not be_empty
+  end
+
+  it 'should have a response body' do
+    @body.length.should > 0
+  end
+end

data/spec/httpadapter/adapters/rack_request_spec.rb

@@ -226,3 +226,14 @@ describe HTTPAdapter::RackRequestAdapter,
     @request.body.read.should == '{"three":3,"two":2,"one":1}'
   end
 end
+
+describe HTTPAdapter::RackRequestAdapter, 'transmitting' do
+  it 'should raise an error indicating that transmission is not possible' do
+    (lambda do
+      HTTPAdapter.transmit(
+        ['GET', 'http://www.google.com/', [], ['']],
+        HTTPAdapter::RackRequestAdapter
+      )
+    end).should raise_error(NotImplementedError)
+  end
+end

data/spec/httpadapter/adapters/typhoeus_request_spec.rb

@@ -107,7 +107,7 @@ describe HTTPAdapter::TyphoeusRequestAdapter,
   end
 
   it 'should convert the body properly' do
-    @request.body.should == ''
+    @request.body.should == nil
   end
 end
 

data/spec/httpadapter/adapters/typhoeus_transmission_spec.rb

@@ -0,0 +1,89 @@
+# 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 'spec_helper'
+
+require 'httpadapter/adapters/typhoeus'
+
+describe HTTPAdapter::TyphoeusRequestAdapter, 'transmitting a GET tuple' do
+  before do
+    @tuple = [
+      'GET',
+      'http://www.google.com/',
+      [],
+      []
+    ]
+    @response = HTTPAdapter.transmit(
+      @tuple, HTTPAdapter::TyphoeusRequestAdapter
+    )
+    @status, @headers, @chunked_body = @response
+    @body = ''
+    @chunked_body.each do |chunk|
+      @body += chunk
+    end
+  end
+
+  it 'should have the correct status' do
+    @status.should == 200
+  end
+
+  it 'should have response headers' do
+    @headers.should_not be_empty
+  end
+
+  it 'should have a response body' do
+    @body.length.should > 0
+  end
+end
+
+describe HTTPAdapter::TyphoeusRequestAdapter, 'transmitting with connection' do
+  before do
+    @connection = HTTPAdapter::Connection.new(
+      'www.google.com', 80,
+      Typhoeus::Hydra.new,
+      :join => [:run, [], nil]
+    )
+    @connection.open
+    @tuple = [
+      'GET',
+      'http://www.google.com/',
+      [],
+      []
+    ]
+    @response = HTTPAdapter.transmit(
+      @tuple, HTTPAdapter::TyphoeusRequestAdapter, @connection
+    )
+    @status, @headers, @chunked_body = @response
+    @body = ''
+    @chunked_body.each do |chunk|
+      @body += chunk
+    end
+  end
+
+  after do
+    @connection.close
+  end
+
+  it 'should have the correct status' do
+    @status.should == 200
+  end
+
+  it 'should have response headers' do
+    @headers.should_not be_empty
+  end
+
+  it 'should have a response body' do
+    @body.length.should > 0
+  end
+end

data/spec/httpadapter/connection_spec.rb

@@ -0,0 +1,107 @@
+# 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 'spec_helper'
+
+require 'httpadapter/connection'
+
+class StubbedConnection
+  def open
+    # Does nothing
+  end
+
+  def close
+    # Does nothing
+  end
+
+  def join
+    # Does nothing
+  end
+end
+
+describe HTTPAdapter::Connection, 'when wrapping a connection' do
+  before do
+    @connection = HTTPAdapter::Connection.new(
+      'www.example.com', 80, StubbedConnection.new,
+      :open => [:open, [], nil],
+      :close => [:close, [], nil],
+      :join => [:join, [], nil]
+    )
+  end
+
+  it 'should be able to call open' do
+    @connection.open
+  end
+
+  it 'should be able to call close' do
+    @connection.close
+  end
+
+  it 'should be able to call join' do
+    @connection.join
+  end
+
+  it 'should be able to obtain a reference to the wrapped connection' do
+    @connection.connection.should be_kind_of(StubbedConnection)
+  end
+end
+
+describe HTTPAdapter::Connection,
+    'when wrapping a connection that does not implement methods' do
+  it 'should perform no-ops' do
+    @connection = HTTPAdapter::Connection.new(
+      'www.example.com', 80, Object.new
+    )
+    @connection.open.should == nil
+    @connection.close.should == nil
+    @connection.join.should == nil
+  end
+end
+
+describe HTTPAdapter::Connection,
+    'when wrapping a connection using bogus parameters' do
+  it 'should raise an error for invalid hostnames' do
+    (lambda do
+      HTTPAdapter::Connection.new(42, 80, Object.new)
+    end).should raise_error(TypeError)
+  end
+
+  it 'should raise an error for invalid port' do
+    (lambda do
+      HTTPAdapter::Connection.new('www.example.com', 0, Object.new)
+    end).should raise_error(ArgumentError)
+  end
+
+  it 'should raise an error for invalid port' do
+    (lambda do
+      HTTPAdapter::Connection.new('www.example.com', 65536, Object.new)
+    end).should raise_error(ArgumentError)
+  end
+
+  it 'should not raise an error for a valid port expressed as a String' do
+    HTTPAdapter::Connection.new('www.example.com', '80', Object.new)
+  end
+
+  it 'should raise an error for invalid port' do
+    (lambda do
+      HTTPAdapter::Connection.new('www.example.com', '65536', Object.new)
+    end).should raise_error(ArgumentError)
+  end
+
+  it 'should raise an error for invalid port' do
+    (lambda do
+      HTTPAdapter::Connection.new('www.example.com', :bogus, Object.new)
+    end).should raise_error(TypeError)
+  end
+end

data/spec/httpadapter_spec.rb

@@ -20,10 +20,14 @@ class StubAdapter
   def to_ary
     return ['GET', '/', [], [""]]
   end
-  
+
   def self.from_ary(array)
     return Object.new
   end
+
+  def self.transmit(request, connection=nil)
+    return [200, [], ['']]
+  end
 end
 
 class BogusAdapter
@@ -222,3 +226,23 @@ describe HTTPAdapter, 'when attempting to adapt a response' do
     end).should raise_error(TypeError)
   end
 end
+
+describe HTTPAdapter, 'when attempting to transmit a request' do
+  it 'should raise an error for invalid request objects' do
+    (lambda do
+      HTTPAdapter.transmit(42, StubAdapter)
+    end).should raise_error(TypeError)
+  end
+
+  it 'should raise an error for invalid adapter objects' do
+    (lambda do
+      HTTPAdapter.transmit(['GET', '/', [], ['']], BogusAdapter)
+    end).should raise_error(TypeError)
+  end
+
+  it 'should raise an error for invalid connection objects' do
+    (lambda do
+      HTTPAdapter.transmit(['GET', '/', [], ['']], StubAdapter, 42)
+    end).should raise_error(TypeError)
+  end
+end

data/tasks/rubyforge.rake

@@ -36,9 +36,7 @@ namespace :doc do
     host = "#{config['username']}@rubyforge.org"
     remote_dir = RUBY_FORGE_PATH + "/api"
     local_dir = "doc"
-    if !File.exist?("website/api")
-      system("mkdir website/api")
-    end
+    system("mkdir -p website/api")
     Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
   end
 end
@@ -55,9 +53,7 @@ namespace :spec do
     host = "#{config['username']}@rubyforge.org"
     remote_dir = RUBY_FORGE_PATH + "/specdoc"
     local_dir = "specdoc"
-    if !File.exist?("website/specdoc")
-      system("mkdir website/specdoc")
-    end
+    system("mkdir -p website/specdoc")
     Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
   end
 
@@ -73,9 +69,7 @@ namespace :spec do
       host = "#{config['username']}@rubyforge.org"
       remote_dir = RUBY_FORGE_PATH + "/coverage"
       local_dir = "coverage"
-      if !File.exist?("website/coverage")
-        system("mkdir website/coverage")
-      end
+      system("mkdir -p website/coverage")
       Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
     end
   end
@@ -93,6 +87,9 @@ namespace :website do
     host = "#{config['username']}@rubyforge.org"
     remote_dir = RUBY_FORGE_PATH
     local_dir = "website"
+    system("mkdir -p website/api")
+    system("mkdir -p website/specdoc")
+    system("mkdir -p website/coverage")
     Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: httpadapter
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Bob Aman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-30 00:00:00 -07:00
+date: 2010-09-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -144,14 +144,18 @@ files:
 - lib/httpadapter/adapters/net_http.rb
 - lib/httpadapter/adapters/rack.rb
 - lib/httpadapter/adapters/typhoeus.rb
+- lib/httpadapter/connection.rb
 - lib/httpadapter/version.rb
 - lib/httpadapter.rb
 - spec/httpadapter/adapters/net_http_request_spec.rb
 - spec/httpadapter/adapters/net_http_response_spec.rb
+- spec/httpadapter/adapters/net_http_transmission_spec.rb
 - spec/httpadapter/adapters/rack_request_spec.rb
 - spec/httpadapter/adapters/rack_response_spec.rb
 - spec/httpadapter/adapters/typhoeus_request_spec.rb
 - spec/httpadapter/adapters/typhoeus_response_spec.rb
+- spec/httpadapter/adapters/typhoeus_transmission_spec.rb
+- spec/httpadapter/connection_spec.rb
 - spec/httpadapter_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb