httpi 1.0.0 → 1.1.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.1.0
+
+* Refactoring: Moved code that sets the cookies from the last response for the
+  next request from Savon to `HTTPI::Request#set_cookies`.
+
 ## 1.0.0 (2012-06-07)
 
 * Feature: [#48](https://github.com/rubiii/httpi/pull/48) @jheiss added support

data/lib/httpi/cookie.rb

@@ -0,0 +1,35 @@
+module HTTPI
+
+  # = HTTPI::Cookie
+  #
+  # Represents a single delicious cookie.
+  #
+  # == Examples
+  #
+  #   cookie = HTTPI::Cookie.new("token=choc-choc-chip; Path=/; HttpOnly")
+  #
+  #   cookie.name            # "token"
+  #   cookie.name_and_value  # "token=choc-choc-chip"
+  class Cookie
+
+    # Returns a list of cookies from a Hash of +headers+.
+    def self.list_from_headers(headers)
+      Array(headers["Set-Cookie"]).map { |cookie| new(cookie) }
+    end
+
+    def initialize(cookie)
+      @cookie = cookie
+    end
+
+    # Returns the name of the cookie.
+    def name
+      @cookie.split("=").first
+    end
+
+    # Returns the name and value of the cookie.
+    def name_and_value
+      @cookie.split(";").first
+    end
+
+  end
+end

data/lib/httpi/cookie_store.rb

@@ -0,0 +1,34 @@
+module HTTPI
+
+  # = HTTPI::CookieStore
+  #
+  # Stores a unique list of cookies for future requests.
+  #
+  # == Examples
+  #
+  #   # Add one or more cookies to the store
+  #   cookie_store = HTTPI::CookieStore.new
+  #   cookie_store.add HTTPI::Cookie.new("token=choc-choc-chip; Path=/; HttpOnly")
+  #
+  #   # Fetch the names and values for the "Cookie" header
+  #   cookie_store.fetch  # => "token=choc-choc-chip"
+  class CookieStore
+
+    def initialize
+      @cookies = {}
+    end
+
+    # Adds one or more cookies to the store.
+    def add(*cookies)
+      cookies.each do |cookie|
+        @cookies[cookie.name] = cookie.name_and_value
+      end
+    end
+
+    # Returns the names and values for the "Cookie" header.
+    def fetch
+      @cookies.values.join(";") unless @cookies.empty?
+    end
+
+  end
+end

data/lib/httpi/request.rb

@@ -1,4 +1,5 @@
 require "uri"
+require "httpi/cookie_store"
 require "httpi/auth/config"
 require "rack/utils"
 
@@ -62,6 +63,12 @@ module HTTPI
       headers["Accept-Encoding"] = "gzip,deflate"
     end
 
+    # Sets the cookies from a given +http_response+.
+    def set_cookies(http_response)
+      cookie_store.add *http_response.cookies
+      headers["Cookie"] = cookie_store.fetch
+    end
+
     attr_accessor :open_timeout, :read_timeout
     attr_reader :body
 
@@ -87,6 +94,11 @@ module HTTPI
 
   private
 
+    # Stores the cookies from past requests.
+    def cookie_store
+      @cookie_store ||= CookieStore.new
+    end
+
     # Expects a +url+, validates its validity and returns a +URI+ object.
     def normalize_url!(url)
       raise ArgumentError, "Invalid URL: #{url}" unless url.to_s =~ /^http/

data/lib/httpi/response.rb

@@ -1,6 +1,7 @@
 require "zlib"
 require "stringio"
 require "httpi/dime"
+require "httpi/cookie"
 require "rack/utils"
 
 module HTTPI
@@ -32,6 +33,11 @@ module HTTPI
       !!(headers["Content-Type"] =~ /^multipart/i)
     end
 
+    # Returns a list of cookies from the response.
+    def cookies
+      @cookies ||= Cookie.list_from_headers(headers)
+    end
+
     # Returns any DIME attachments.
     def attachments
       decode_body unless @body

data/lib/httpi/version.rb

@@ -1,5 +1,5 @@
 module HTTPI
 
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 
 end

data/spec/httpi/cookie_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+require "httpi"
+
+describe HTTPI::Cookie do
+
+  let(:cookie) { HTTPI::Cookie.new("token=choc-choc-chip; Path=/; HttpOnly") }
+
+  describe ".list_from_headers" do
+    it "returns a list of cookies from a Hash of headers" do
+      headers = { "Set-Cookie" => "token=strawberry; Path=/; HttpOnly" }
+      cookies = HTTPI::Cookie.list_from_headers(headers)
+
+      cookies.should have(1).item
+      cookies.first.should be_a(HTTPI::Cookie)
+    end
+
+    it "handles multiple cookies" do
+      headers = { "Set-Cookie" => ["user=chucknorris; Path=/; HttpOnly", "token=strawberry; Path=/; HttpOnly"] }
+      cookies = HTTPI::Cookie.list_from_headers(headers)
+      cookies.should have(2).items
+    end
+  end
+
+  describe "#name" do
+    it "returns the name of the cookie" do
+      cookie.name.should == "token"
+    end
+  end
+
+  describe "#name_and_value" do
+    it "returns the name and value of the cookie" do
+      cookie.name_and_value.should == "token=choc-choc-chip"
+    end
+  end
+
+end

data/spec/httpi/cookie_store_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+require "httpi"
+
+describe HTTPI::CookieStore do
+
+  let(:user_cookie)  { some_cookie(:user, "chucknorris") }
+  let(:token_cookie) { some_cookie(:token, "strawberry") }
+
+  it "stores a set of cookies" do
+    cookie_store = HTTPI::CookieStore.new
+    cookie_store.add(user_cookie, token_cookie)
+    cookie_store.fetch.should include("user=chucknorris", "token=strawberry")
+
+    # add a new token cookie with a different value
+    token_cookie = some_cookie(:token, "choc-choc-chip")
+    cookie_store.add(token_cookie)
+
+    cookie_store.fetch.should include("token=choc-choc-chip")
+    cookie_store.fetch.should_not include("token=strawberry")
+  end
+
+  def some_cookie(name, value)
+    HTTPI::Cookie.new("#{name}=#{value}; Path=/; HttpOnly")
+  end
+
+end

data/spec/httpi/request_spec.rb

@@ -100,6 +100,29 @@ describe HTTPI::Request do
     end
   end
 
+  describe "#set_cookies" do
+    it "sets the cookie header for the next request" do
+      request.set_cookies response_with_cookie("some-cookie=choc-chip")
+      request.headers["Cookie"].should == "some-cookie=choc-chip"
+    end
+
+    it "sets additional cookies from subsequent requests" do
+      request.set_cookies response_with_cookie("some-cookie=choc-chip")
+      request.set_cookies response_with_cookie("second-cookie=oatmeal")
+
+      request.headers["Cookie"].should include("some-cookie=choc-chip", "second-cookie=oatmeal")
+    end
+
+    it "doesn't do anything if the response contains no cookies" do
+      request.set_cookies HTTPI::Response.new(200, {}, "")
+      request.headers["Cookie"].should be_nil
+    end
+
+    def response_with_cookie(cookie)
+      HTTPI::Response.new(200, { "Set-Cookie" => "#{cookie}; Path=/; HttpOnly" }, "")
+    end
+  end
+
   describe "#body" do
     it "lets you specify the HTTP request body using a String" do
       request.body = "<some>xml</some>"

data/spec/httpi/response_spec.rb

@@ -34,6 +34,23 @@ describe HTTPI::Response do
         response.should_not be_multipart
       end
     end
+
+    describe "#cookies" do
+      it "returns an empty list" do
+        response.cookies.should == []
+      end
+    end
+  end
+
+  context "with cookies" do
+    let(:response) { HTTPI::Response.new 200, { "Set-Cookie" => "some-cookie=choc-chip; Path=/; HttpOnly" }, "" }
+
+    describe "#cookies" do
+      it "returns a list of cookies" do
+        cookie = response.cookies.first
+        cookie.should be_a(HTTPI::Cookie)
+      end
+    end
   end
 
   context "empty" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: httpi
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-07 00:00:00 Z
+date: 2012-06-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -150,6 +150,8 @@ files:
 - lib/httpi/adapter/net_http.rb
 - lib/httpi/auth/config.rb
 - lib/httpi/auth/ssl.rb
+- lib/httpi/cookie.rb
+- lib/httpi/cookie_store.rb
 - lib/httpi/dime.rb
 - lib/httpi/request.rb
 - lib/httpi/response.rb
@@ -167,6 +169,8 @@ files:
 - spec/httpi/adapter_spec.rb
 - spec/httpi/auth/config_spec.rb
 - spec/httpi/auth/ssl_spec.rb
+- spec/httpi/cookie_spec.rb
+- spec/httpi/cookie_store_spec.rb
 - spec/httpi/httpi_spec.rb
 - spec/httpi/request_spec.rb
 - spec/httpi/response_spec.rb