Extract HTTP cookie handling to middleware

3 files changed, 57 insertions, 14 deletions

diff --git a/lib/chef/http/cookie_manager.rb b/lib/chef/http/cookie_manager.rb
new file mode 100644
index 0000000000..5c96b9e115
--- /dev/null
+++ b/lib/chef/http/cookie_manager.rb
@@ -0,0 +1,51 @@
+#--
+# Author:: Daniel DeLeo (<dan@opscode.com>)
+# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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 'chef/http/cookie_jar'
+
+class Chef
+  class HTTP
+
+    # An HTTP middleware to manage storing/sending cookies in HTTP requests.
+    # Most HTTP communication in Chef does not need cookies, it was originally
+    # implemented to support OpenID, but it's not known who might be relying on
+    # it, so it's included with Chef::REST
+    class CookieManager
+
+      def initialize(options={})
+        @cookies = CookieJar.instance
+      end
+
+      def handle_request(method, url, headers={}, data=false)
+        host, port = url.host, url.port
+        if @cookies.has_key?("#{host}:#{port}")
+          headers['Cookie'] = @cookies["#{host}:#{port}"]
+        end
+        [method, url, headers, data]
+      end
+
+      def handle_response(http_response, rest_request, return_value)
+        if http_response['set-cookie']
+          @cookies["#{host}:#{port}"] = http_response['set-cookie']
+        end
+        [http_response, rest_request, return_value]
+      end
+
+    end
+  end
+end
diff --git a/lib/chef/http/http_request.rb b/lib/chef/http/http_request.rb
index 918dafa99e..b314c3b88b 100644
--- a/lib/chef/http/http_request.rb
+++ b/lib/chef/http/http_request.rb
@@ -22,7 +22,6 @@
 #
 require 'uri'
 require 'net/http'
-require 'chef/http/cookie_jar'
 
 # To load faster, we only want ohai's version string.
 # However, in ohai before 0.6.0, the version is defined
@@ -72,7 +71,6 @@ class Chef
       def initialize(method, url, req_body, base_headers={})
         @method, @url = method, url
         @request_body = nil
-        @cookies = CookieJar.instance
         configure_http_client
         build_headers(base_headers)
         configure_http_request(req_body)
@@ -97,7 +95,6 @@ class Chef
       def call
         hide_net_http_bug do
           http_client.request(http_request) do |response|
-            store_cookie(response)
             yield response if block_given?
             response
           end
@@ -125,19 +122,10 @@ class Chef
         end
       end
 
-      def store_cookie(response)
-        if response['set-cookie']
-          @cookies["#{host}:#{port}"] = response['set-cookie']
-        end
-      end
-
       def build_headers(headers)
         @headers = headers.dup
         @headers['X-Chef-Version'] = ::Chef::VERSION
-
-        if @cookies.has_key?("#{host}:#{port}")
-          @headers['Cookie'] = @cookies["#{host}:#{port}"]
-        end
+        @headers
       end
 
       #adapted from buildr/lib/buildr/core/transports.rb
@@ -222,6 +210,8 @@ class Chef
           password = URI.unescape(url.password) if url.password
           @http_request.basic_auth(user, password)
         end
+
+        # Overwrite default UA
         @http_request[USER_AGENT] = self.class.user_agent
       end
 
diff --git a/lib/chef/rest.rb b/lib/chef/rest.rb
index 03ebb99152..fe416bc619 100644
--- a/lib/chef/rest.rb
+++ b/lib/chef/rest.rb
@@ -30,6 +30,7 @@ end
 require 'chef/http/authenticator'
 require 'chef/http/decompressor'
 require 'chef/http/json_to_model_inflater'
+require 'chef/http/cookie_manager'
 require 'chef/config'
 require 'chef/exceptions'
 require 'chef/platform/query_helpers'
@@ -58,6 +59,7 @@ class Chef
       super(url, options)
 
       @chef_json_inflater = JSONToModelInflater.new(options)
+      @cookie_manager = CookieManager.new(options)
       @decompressor = Decompressor.new(options)
       @authenticator = Authenticator.new(options)
     end
@@ -134,7 +136,7 @@ class Chef
 
     # Chef::REST doesn't define middleware in the normal way for backcompat reasons, so it's hardcoded here.
     def middlewares
-      [@chef_json_inflater, @decompressor, @authenticator]
+      [@chef_json_inflater, @cookie_manager, @decompressor, @authenticator]
     end
 
     alias :api_request :request