httpadapter 0.2.1 → 1.0.0

data/lib/httpadapter/adapters/rack.rb

@@ -19,20 +19,24 @@ 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
+  class RackAdapter
+    include HTTPAdapter
+
+    def initialize(options={})
+      options = {
+        :error_stream => $stderr
+      }.merge(options)
+      @error_stream = options[:error_stream]
     end
 
-    def to_ary
-      method = @request.request_method.to_s.upcase
-      uri = Addressable::URI.parse(@request.url.to_s).normalize.to_s
+    def convert_request_to_a(request_obj)
+      unless request_obj.kind_of?(Rack::Request)
+        raise TypeError, "Expected Rack::Request, got #{request_obj.class}."
+      end
+      method = request_obj.request_method.to_s.upcase
+      uri = Addressable::URI.parse(request_obj.url.to_s).normalize.to_s
       headers = []
-      @request.env.each do |parameter, value|
+      request_obj.env.each do |parameter, value|
         next if parameter !~ /^HTTP_/
         # Ugh, lossy canonicalization again
         header = (parameter.gsub(/^HTTP_/, '').split('_').map do |chunk|
@@ -40,12 +44,12 @@ module HTTPAdapter #:nodoc:
         end).join('-')
         headers << [header, value]
       end
-      return [method, uri, headers, @request.body]
+      return [method, uri, headers, request_obj.body]
     end
 
-    def self.from_ary(array)
+    def convert_request_from_a(request_ary)
       # These contortions are really obnoxious; lossiness is bad!
-      method, uri, headers, body = array
+      method, uri, headers, body = request_ary
       env = {}
       method = method.to_s.upcase
       uri = Addressable::URI.parse(uri)
@@ -88,26 +92,15 @@ module HTTPAdapter #:nodoc:
       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
-    def initialize(response)
-      unless response.kind_of?(Rack::Response)
-        raise TypeError, "Expected Rack::Response, got #{response.class}."
+    def convert_response_to_a(response_obj)
+      unless response_obj.kind_of?(Rack::Response)
+        raise TypeError, "Expected Rack::Response, got #{response_obj.class}."
       end
-      @response = response
-    end
-
-    def to_ary
-      return @response.finish
+      return response_obj.finish
     end
 
-    def self.from_ary(array)
-      status, headers, body = array
+    def convert_response_from_a(request_ary)
+      status, headers, body = request_ary
       status = status.to_i
       body.each do |chunk|
         # Purely for strict type-checking
@@ -118,5 +111,10 @@ module HTTPAdapter #:nodoc:
       response = Rack::Response.new(body, status, Hash[headers])
       return response
     end
+
+    def fetch_resource(request_ary, connection=nil)
+      raise NotImplementedError,
+        'No HTTP client implementation available to transmit a Rack::Request.'
+    end
   end
 end

data/lib/httpadapter/adapters/typhoeus.rb

@@ -19,27 +19,26 @@ require 'typhoeus/response'
 require 'addressable/uri'
 
 module HTTPAdapter #:nodoc:
-  class TyphoeusRequestAdapter
-    def initialize(request)
-      unless request.kind_of?(Typhoeus::Request)
-        raise TypeError, "Expected Typhoeus::Request, got #{request.class}."
-      end
-      @request = request
-    end
+  class TyphoeusAdapter
+    include HTTPAdapter
 
-    def to_ary
-      method = @request.method.to_s.upcase
-      uri = @request.url.to_str
+    def convert_request_to_a(request_obj)
+      unless request_obj.kind_of?(Typhoeus::Request)
+        raise TypeError,
+          "Expected Typhoeus::Request, got #{request_obj.class}."
+      end
+      method = request_obj.method.to_s.upcase
+      uri = request_obj.url.to_str
       headers = []
-      @request.headers.each do |header, value|
+      request_obj.headers.each do |header, value|
         headers << [header, value]
       end
-      body = @request.body || ""
+      body = request_obj.body || ""
       return [method, uri, headers, [body]]
     end
 
-    def self.from_ary(array)
-      method, uri, headers, body = array
+    def convert_request_from_a(request_ary)
+      method, uri, headers, body = request_ary
       method = method.to_s.downcase.to_sym
       uri = Addressable::URI.parse(uri)
       headers = Hash[headers]
@@ -59,41 +58,14 @@ module HTTPAdapter #:nodoc:
       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
-    def initialize(response)
-      unless response.kind_of?(Typhoeus::Response)
-        raise TypeError, "Expected Typhoeus::Response, got #{response.class}."
+    def convert_response_to_a(response_obj)
+      unless response_obj.kind_of?(Typhoeus::Response)
+        raise TypeError,
+          "Expected Typhoeus::Response, got #{response_obj.class}."
       end
-      @response = response
-    end
-
-    def to_ary
-      status = @response.code.to_i
+      status = response_obj.code.to_i
       headers = []
-      @response.headers_hash.each do |header, value|
+      response_obj.headers_hash.each do |header, value|
         # Eh? Seriously?  This is NOT a header!
         next if header =~ /^HTTP\/\d\.\d \d{3} .+$/
         if value.kind_of?(Array)
@@ -105,12 +77,12 @@ module HTTPAdapter #:nodoc:
           headers << [header, value]
         end
       end
-      body = @response.body || ""
+      body = response_obj.body || ""
       return [status, headers, [body]]
     end
 
-    def self.from_ary(array)
-      status, headers, body = array
+    def convert_response_from_a(request_ary)
+      status, headers, body = request_ary
       status = status.to_i
       merged_body = ""
       body.each do |chunk|
@@ -123,5 +95,29 @@ module HTTPAdapter #:nodoc:
       )
       return response
     end
+
+    def fetch_resource(request_ary, connection=nil)
+      method, uri, headers, body = request_ary
+      uri = Addressable::URI.parse(uri)
+      typhoeus_request = self.convert_request_from_a(
+        [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 self.convert_response_to_a(typhoeus_response)
+    end
   end
 end

data/lib/httpadapter/connection.rb

@@ -12,8 +12,6 @@
 #    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={})

data/lib/httpadapter/version.rb

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

data/spec/httpadapter/adapter_type_checking_spec.rb

@@ -0,0 +1,170 @@
+# 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.
+
+shared_examples_for 'adapter type-checking example' do
+  before do
+    @request = ['GET', '/', [], ['']]
+    @response = [200, [], ['']]
+  end
+
+  describe 'when attempting to specialize a request' do
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_request(42)
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_request([42])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_request([42, 42, 42, 42])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_request(['GET', 42, [], ['']])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_request(['GET', '/', 42, ['']])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_request(['GET', '/', [42], ['']])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_request(['GET', '/', [[42, 'value']], ['']])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_request(['GET', '/', [['X', 42]], ['']])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_request(['GET', '/', [], 42])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        # Note that the body value here should be [''], not ''.
+        @adapter.specialize_request(['GET', '/', [], ''])
+      end).should raise_error(TypeError)
+    end
+  end
+
+  describe 'when attempting to specialize a response' do
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_response(42)
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_response([42])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_response([42, 42, 42])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_response([Object.new, [], ['']])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_response(['', 42, ['']])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_response([200, [42], ['']])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_response([200, [[42, 'value']], ['']])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_response([200, [['X', 42]], ['']])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        @adapter.specialize_response([200, [], 42])
+      end).should raise_error(TypeError)
+    end
+
+    it 'should raise an error for converting from an invalid tuple' do
+      (lambda do
+        # Note that the body value here should be [''], not ''.
+        @adapter.specialize_response([200, [], ''])
+      end).should raise_error(TypeError)
+    end
+  end
+
+  it 'should raise an error for invalid adapt request calls' do
+    (lambda do
+      @adapter.adapt_request(42)
+    end).should raise_error(TypeError)
+  end
+
+  it 'should raise an error for invalid adapt response calls' do
+    (lambda do
+      @adapter.adapt_response(42)
+    end).should raise_error(TypeError)
+  end
+
+  it 'should raise an error for invalid transmission calls' do
+    (lambda do
+      @adapter.transmit(42)
+    end).should raise_error(TypeError)
+  end
+
+  it 'should raise an error for invalid transmission calls' do
+    (lambda do
+      @adapter.transmit(@request, 42)
+    end).should raise_error(TypeError)
+  end
+end

data/spec/httpadapter/adapters/mock_adapter_spec.rb

@@ -0,0 +1,81 @@
+# 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 'spec/httpadapter/adapter_type_checking_spec'
+
+require 'httpadapter/adapters/mock'
+
+describe HTTPAdapter::MockAdapter do
+  describe 'with no response mocked' do
+    before do
+      @adapter = HTTPAdapter::MockAdapter.create do |request_ary, connection|
+        method, uri, headers, body = request_ary
+        headers.should be_any { |k, v| k.downcase == 'user-agent' }
+      end
+    end
+
+    it_should_behave_like 'adapter type-checking example'
+
+    describe 'when transmitting a request' do
+      it 'should have an expectation failure' do
+        (lambda do
+          @adapter.transmit(['GET', 'http://www.google.com/', [], ['']])
+        end).should raise_error(Spec::Expectations::ExpectationNotMetError)
+      end
+
+      it 'should meet all expectations' do
+        response = @adapter.transmit([
+          'GET',
+          'http://www.google.com/',
+          [['User-Agent', 'Mock Agent']],
+          ['']
+        ])
+        status, headers, body = response
+        status.should == 200
+      end
+    end
+  end
+
+  describe 'with a mocked response' do
+    before do
+      @adapter = HTTPAdapter::MockAdapter.create do |request_ary, connection|
+        method, uri, headers, body = request_ary
+        headers.should be_any { |k, v| k.downcase == 'user-agent' }
+        [400, [], ['']]
+      end
+    end
+
+    it_should_behave_like 'adapter type-checking example'
+
+    describe 'when transmitting a request' do
+      it 'should have an expectation failure' do
+        (lambda do
+          @adapter.transmit(['GET', 'http://www.google.com/', [], ['']])
+        end).should raise_error(Spec::Expectations::ExpectationNotMetError)
+      end
+
+      it 'should meet all expectations' do
+        response = @adapter.transmit([
+          'GET',
+          'http://www.google.com/',
+          [['User-Agent', 'Mock Agent']],
+          ['']
+        ])
+        status, headers, body = response
+        status.should == 400
+      end
+    end
+  end
+end