cookiejar 0.2.9

data/test/cookie_validation_test.rb

@@ -0,0 +1,235 @@
+require 'cookiejar'
+require 'rubygems'
+
+include CookieJar
+describe CookieValidation do
+  describe "#validate_cookie" do
+    localaddr = 'http://localhost/foo/bar/'
+    it "should fail if version unset" do
+      lambda do
+        unversioned = Cookie.from_set_cookie localaddr, 'foo=bar'
+        unversioned.instance_variable_set :@version, nil
+        CookieValidation.validate_cookie localaddr, unversioned
+      end.should raise_error InvalidCookieError
+    end
+    it "should fail if the path is more specific" do
+      lambda do
+        subdirred = Cookie.from_set_cookie localaddr, 'foo=bar;path=/foo/bar/baz'
+        # validate_cookie localaddr, subdirred
+      end.should raise_error InvalidCookieError
+    end
+    it "should fail if the path is different than the request" do
+      lambda do
+        difdirred = Cookie.from_set_cookie localaddr, 'foo=bar;path=/baz/'
+        # validate_cookie localaddr, difdirred
+      end.should raise_error InvalidCookieError
+    end
+    it "should fail if the domain has no dots" do
+      lambda do
+        nodot = Cookie.from_set_cookie 'http://zero/', 'foo=bar;domain=zero'
+        # validate_cookie 'http://zero/', nodot
+      end.should raise_error InvalidCookieError
+    end
+    it "should fail for explicit localhost" do
+      lambda do
+        localhost = Cookie.from_set_cookie localaddr, 'foo=bar;domain=localhost'
+        # validate_cookie localaddr, localhost
+      end.should raise_error InvalidCookieError
+    end
+    it "should fail for mismatched domains" do
+      lambda do
+        foobar = Cookie.from_set_cookie 'http://www.foo.com/', 'foo=bar;domain=bar.com'
+        # validate_cookie 'http://www.foo.com/', foobar
+      end.should raise_error InvalidCookieError
+    end
+    it "should fail for domains more than one level up" do
+      lambda do
+        xyz = Cookie.from_set_cookie 'http://x.y.z.com/', 'foo=bar;domain=z.com'
+        # validate_cookie 'http://x.y.z.com/', xyz
+      end.should raise_error InvalidCookieError
+    end
+    it "should fail for setting subdomain cookies" do
+      lambda do
+        subdomain = Cookie.from_set_cookie 'http://foo.com/', 'foo=bar;domain=auth.foo.com'
+        # validate_cookie 'http://foo.com/', subdomain
+      end.should raise_error InvalidCookieError
+    end
+    it "should handle a normal implicit internet cookie" do
+      normal = Cookie.from_set_cookie 'http://foo.com/', 'foo=bar'
+      CookieValidation.validate_cookie('http://foo.com/', normal).should be_true
+    end
+    it "should handle a normal implicit localhost cookie" do
+      localhost = Cookie.from_set_cookie 'http://localhost/', 'foo=bar'
+      CookieValidation.validate_cookie('http://localhost/', localhost).should be_true
+    end
+    it "should handle an implicit IP address cookie" do
+      ipaddr =  Cookie.from_set_cookie 'http://127.0.0.1/', 'foo=bar'
+      CookieValidation.validate_cookie('http://127.0.0.1/', ipaddr).should be_true
+    end
+    it "should handle an explicit domain on an internet site" do
+      explicit = Cookie.from_set_cookie 'http://foo.com/', 'foo=bar;domain=.foo.com'
+      CookieValidation.validate_cookie('http://foo.com/', explicit).should be_true
+    end
+    it "should handle setting a cookie explicitly on a superdomain" do
+      superdomain = Cookie.from_set_cookie 'http://auth.foo.com/', 'foo=bar;domain=.foo.com'
+      CookieValidation.validate_cookie('http://foo.com/', superdomain).should be_true
+    end
+    it "should handle explicitly setting a cookie" do
+      explicit = Cookie.from_set_cookie 'http://foo.com/bar/', 'foo=bar;path=/bar/'
+      CookieValidation.validate_cookie('http://foo.com/bar/', explicit)
+    end
+    it "should handle setting a cookie on a higher path" do
+      higher = Cookie.from_set_cookie 'http://foo.com/bar/baz/', 'foo=bar;path=/bar/'
+      CookieValidation.validate_cookie('http://foo.com/bar/baz/', higher)
+    end 
+  end
+  describe '#cookie_base_path' do
+    it "should leave '/' alone" do
+      CookieValidation.cookie_base_path('/').should == '/'
+    end
+    it "should strip off everything after the last '/'" do
+      CookieValidation.cookie_base_path('/foo/bar/baz').should == '/foo/bar/'
+    end
+    it "should handle query parameters and fragments with slashes" do
+      CookieValidation.cookie_base_path('/foo/bar?query=a/b/c#fragment/b/c').should == '/foo/'
+    end
+    it "should handle URI objects" do
+      CookieValidation.cookie_base_path(URI.parse('http://www.foo.com/bar/')).should == '/bar/'
+    end
+    it "should preserve case" do
+      CookieValidation.cookie_base_path("/BaR/").should == '/BaR/'
+    end
+  end
+  describe '#determine_cookie_path' do
+    it "should use the requested path when none is specified for the cookie" do
+      CookieValidation.determine_cookie_path('http://foo.com/', nil).should == '/'
+      CookieValidation.determine_cookie_path('http://foo.com/bar/baz', '').should == '/bar/'
+    end
+    it "should handle URI objects" do
+      CookieValidation.determine_cookie_path(URI.parse('http://foo.com/bar/'), '').should == '/bar/'
+    end
+    it "should handle Cookie objects" do
+      cookie = Cookie.from_set_cookie('http://foo.com/', "name=value;path=/")
+      CookieValidation.determine_cookie_path('http://foo.com/', cookie).should == '/'
+    end
+    it "should ignore the request when a path is specified" do
+      CookieValidation.determine_cookie_path('http://foo.com/ignorable/path', '/path/').should == '/path/'
+    end
+  end
+  describe '#compute_search_domains' do
+    it "should handle subdomains" do
+      CookieValidation.compute_search_domains('http://www.auth.foo.com/').should ==
+       ['www.auth.foo.com', '.www.auth.foo.com', '.auth.foo.com']
+    end
+    it "should handle root domains" do
+      CookieValidation.compute_search_domains('http://foo.com/').should ==
+      ['foo.com', '.foo.com']
+    end
+    it "should handle IP addresses" do
+      CookieValidation.compute_search_domains('http://127.0.0.1/').should ==
+      ['127.0.0.1']
+    end
+    it "should handle local addresses" do
+      CookieValidation.compute_search_domains('http://zero/').should == 
+      ['zero.local', '.zero.local', '.local']
+    end
+  end
+  describe '#determine_cookie_domain' do
+    it "should add a dot to the front of domains" do
+      CookieValidation.determine_cookie_domain('http://foo.com/', 'foo.com').should == '.foo.com'
+    end
+    it "should not add a second dot if one present" do
+      CookieValidation.determine_cookie_domain('http://foo.com/', '.foo.com').should == '.foo.com'
+    end
+    it "should handle Cookie objects" do
+      c = Cookie.from_set_cookie('http://foo.com/', "foo=bar;domain=foo.com")
+      CookieValidation.determine_cookie_domain('http://foo.com/', c).should == '.foo.com'
+    end
+    it "should handle URI objects" do
+      CookieValidation.determine_cookie_domain(URI.parse('http://foo.com/'), '.foo.com').should == '.foo.com'
+    end
+    it "should use an exact hostname when no domain specified" do
+      CookieValidation.determine_cookie_domain('http://foo.com/', '').should == 'foo.com'
+    end
+    it "should leave IPv4 addresses alone" do
+      CookieValidation.determine_cookie_domain('http://127.0.0.1/', '127.0.0.1').should == '127.0.0.1'
+    end
+    it "should leave IPv6 addresses alone" do
+      ['2001:db8:85a3::8a2e:370:7334', '::ffff:192.0.2.128'].each do |value|
+        CookieValidation.determine_cookie_domain("http://[#{value}]/", value).should == value
+      end
+    end
+  end
+  describe "#effective_host" do
+    it "should leave proper domains the same" do
+      ['google.com', 'www.google.com', 'google.com.'].each do |value|
+        CookieValidation.effective_host(value).should == value
+      end
+    end
+    it "should handle a URI object" do
+      CookieValidation.effective_host(URI.parse('http://example.com/')).should == 'example.com'
+    end	
+    it "should add a local suffix on unqualified hosts" do
+      CookieValidation.effective_host('localhost').should == 'localhost.local'
+    end
+    it "should leave IPv4 addresses alone" do
+      CookieValidation.effective_host('127.0.0.1').should == '127.0.0.1'
+    end
+    it "should leave IPv6 addresses alone" do
+      ['2001:db8:85a3::8a2e:370:7334', ':ffff:192.0.2.128'].each do |value|
+        CookieValidation.effective_host(value).should == value
+      end
+    end
+    it "should lowercase addresses" do
+      CookieValidation.effective_host('FOO.COM').should == 'foo.com'
+    end
+  end
+  describe '#match_domains' do
+    it "should handle exact matches" do
+      CookieValidation.domains_match('localhost.local', 'localhost.local').should == 'localhost.local'
+      CookieValidation.domains_match('foo.com', 'foo.com').should == 'foo.com'
+      CookieValidation.domains_match('127.0.0.1', '127.0.0.1').should == '127.0.0.1'
+      CookieValidation.domains_match('::ffff:192.0.2.128', '::ffff:192.0.2.128').should == '::ffff:192.0.2.128'
+    end
+    it "should handle matching a superdomain" do
+      CookieValidation.domains_match('.foo.com', 'auth.foo.com').should == '.foo.com'
+      CookieValidation.domains_match('.y.z.foo.com', 'x.y.z.foo.com').should == '.y.z.foo.com'
+    end
+    it "should not match superdomains, or illegal domains" do
+      CookieValidation.domains_match('.z.foo.com', 'x.y.z.foo.com').should be_nil
+      CookieValidation.domains_match('foo.com', 'com').should be_nil
+    end
+    it "should not match domains with and without a dot suffix together" do
+      CookieValidation.domains_match('foo.com.', 'foo.com').should be_nil
+    end
+  end
+  describe '#hostname_reach' do
+    it "should find the next highest subdomain" do
+      {'www.google.com' => 'google.com', 'auth.corp.companyx.com' => 'corp.companyx.com'}.each do |entry|
+        CookieValidation.hostname_reach(entry[0]).should == entry[1]
+      end
+    end
+    it "should handle domains with suffixed dots" do
+      CookieValidation.hostname_reach('www.google.com.').should == 'google.com.'
+    end
+    it "should return nil for a root domain" do
+      CookieValidation.hostname_reach('github.com').should be_nil
+    end
+    it "should return 'local' for a local domain" do
+      ['foo.local', 'foo.local.'].each do |hostname|
+        CookieValidation.hostname_reach(hostname).should == 'local'
+      end
+    end
+    it "should handle mixed-case '.local'" do
+      CookieValidation.hostname_reach('foo.LOCAL').should == 'local'
+    end
+    it "should return nil for an IPv4 address" do
+      CookieValidation.hostname_reach('127.0.0.1').should be_nil
+    end
+    it "should return nil for IPv6 addresses" do
+      ['2001:db8:85a3::8a2e:370:7334', '::ffff:192.0.2.128'].each do |value|
+        CookieValidation.hostname_reach(value).should be_nil
+      end
+    end
+  end
+end

data/test/jar_test.rb

@@ -0,0 +1,205 @@
+require 'cookiejar'
+require 'yaml'
+require 'rubygems'
+
+include CookieJar
+
+describe Jar do
+  describe '.setCookie' do
+    it "should allow me to set a cookie" do
+      jar = Jar.new 
+      jar.set_cookie 'http://foo.com/', 'foo=bar'
+    end
+    it "should allow me to set multiple cookies" do
+      jar = Jar.new 
+      jar.set_cookie 'http://foo.com/', 'foo=bar'
+      jar.set_cookie 'http://foo.com/', 'bar=baz'
+      jar.set_cookie 'http://auth.foo.com/', 'foo=bar'
+      jar.set_cookie 'http://auth.foo.com/', 'auth=135121...;domain=foo.com'    
+    end
+  end
+  describe '.get_cookies' do
+    it "should let me read back cookies which are set" do
+      jar = Jar.new 
+      jar.set_cookie 'http://foo.com/', 'foo=bar'
+      jar.set_cookie 'http://foo.com/', 'bar=baz'
+      jar.set_cookie 'http://auth.foo.com/', 'foo=bar'
+      jar.set_cookie 'http://auth.foo.com/', 'auth=135121...;domain=foo.com'
+      jar.get_cookies('http://foo.com/').should have(3).items
+    end
+    it "should return cookies longest path first" do
+      jar = Jar.new
+      uri = 'http://foo.com/a/b/c/d' 
+      jar.set_cookie uri, 'a=bar'
+      jar.set_cookie uri, 'b=baz;path=/a/b/c/d'
+      jar.set_cookie uri, 'c=bar;path=/a/b'
+      jar.set_cookie uri, 'd=bar;path=/a/'
+      cookies = jar.get_cookies(uri)
+      cookies.should have(4).items
+      cookies[0].name.should == 'b'
+      cookies[1].name.should == 'a'
+      cookies[2].name.should == 'c'
+      cookies[3].name.should == 'd'
+    end
+    it "should not return expired cookies" do
+      jar = Jar.new
+      uri = 'http://localhost/'
+      jar.set_cookie uri, 'foo=bar;expires=Wednesday, 09-Nov-99 23:12:40 GMT'
+      cookies = jar.get_cookies(uri)
+      cookies.should have(0).items
+    end
+  end
+  describe '.get_cookie_headers' do
+    it "should return cookie headers" do
+      jar = Jar.new
+      uri = 'http://foo.com/a/b/c/d' 
+      jar.set_cookie uri, 'a=bar'
+      jar.set_cookie uri, 'b=baz;path=/a/b/c/d'
+      cookie_headers = jar.get_cookie_header uri
+      cookie_headers.should == "b=baz;a=bar"
+    end
+    it "should handle a version 1 cookie" do
+      jar = Jar.new
+      uri = 'http://foo.com/a/b/c/d' 
+      jar.set_cookie uri, 'a=bar'
+      jar.set_cookie uri, 'b=baz;path=/a/b/c/d'
+      jar.set_cookie2 uri, 'c=baz;Version=1;path="/"'
+      cookie_headers = jar.get_cookie_header uri
+      cookie_headers.should == '$Version=0;b=baz;$Path="/a/b/c/d";a=bar;$Path="/a/b/c/",$Version=1;c=baz;$Path="/"'
+    end
+  end
+  describe '.add_cookie' do
+    it "should let me add a pre-existing cookie" do
+      jar = Jar.new
+      cookie = Cookie.from_set_cookie 'http://localhost/', 'foo=bar'
+      jar.add_cookie cookie
+    end
+  end
+  describe '.to_a' do
+    it "should return me an array of all cookie objects" do
+      uri = 'http://foo.com/a/b/c/d' 
+      jar = Jar.new
+      jar.set_cookie uri, 'a=bar;expires=Wednesday, 09-Nov-99 23:12:40 GMT'
+      jar.set_cookie uri, 'b=baz;path=/a/b/c/d'
+      jar.set_cookie uri, 'c=bar;path=/a/b'
+      jar.set_cookie uri, 'd=bar;path=/a/'
+      jar.set_cookie 'http://localhost/', 'foo=bar'
+      jar.to_a.should have(5).items
+    end
+  end
+  describe '.expire_cookies' do
+    it "should expire cookies which are no longer valid" do
+      uri = 'http://foo.com/a/b/c/d' 
+      jar = Jar.new
+      jar.set_cookie uri, 'a=bar;expires=Wednesday, 09-Nov-99 23:12:40 GMT'
+      jar.set_cookie uri, 'b=baz;path=/a/b/c/d;expires=Wednesday, 01-Nov-2028 12:00:00 GMT'
+      jar.set_cookie uri, 'c=bar;path=/a/b'
+      jar.set_cookie uri, 'd=bar;path=/a/'
+      jar.set_cookie 'http://localhost/', 'foo=bar'
+      jar.to_a.should have(5).items
+      jar.expire_cookies
+      jar.to_a.should have(4).items
+    end
+    it "should let me expire all session cookies" do
+      uri = 'http://foo.com/a/b/c/d' 
+      jar = Jar.new
+      jar.set_cookie uri, 'a=bar;expires=Wednesday, 09-Nov-99 23:12:40 GMT'
+      jar.set_cookie uri, 'b=baz;path=/a/b/c/d;expires=Wednesday, 01-Nov-2028 12:00:00 GMT'
+      jar.set_cookie uri, 'c=bar;path=/a/b'
+      jar.set_cookie uri, 'd=bar;path=/a/'
+      jar.set_cookie 'http://localhost/', 'foo=bar'
+      jar.to_a.should have(5).items
+      jar.expire_cookies true
+      jar.to_a.should have(1).items
+    end
+  end
+  describe '#set_cookies_from_headers' do
+    it "should handle a Set-Cookie header" do
+      jar = Jar.new
+      cookies = jar.set_cookies_from_headers 'http://localhost/', 
+      { 'Set-Cookie' => 'foo=bar' } 
+      cookies.should have(1).items
+      jar.to_a.should have(1).items
+    end
+    it "should handle multiple Set-Cookie headers" do
+      jar = Jar.new
+      cookies = jar.set_cookies_from_headers 'http://localhost/', 
+      { 'Set-Cookie' => ['foo=bar','bar=baz'] } 
+      cookies.should have(2).items
+      jar.to_a.should have(2).items
+    end
+    it "should handle a Set-Cookie2 header" do
+      jar = Jar.new
+      cookies = jar.set_cookies_from_headers 'http://localhost/', 
+      { 'Set-Cookie2' => 'foo=bar;Version=1' } 
+      cookies.should have(1).items
+      jar.to_a.should have(1).items
+    end
+    it "should handle multiple Set-Cookie2 headers" do
+      jar = Jar.new
+      cookies = jar.set_cookies_from_headers 'http://localhost/', 
+      { 'Set-Cookie2' => ['foo=bar;Version=1','bar=baz;Version=1'] } 
+      cookies.should have(2).items
+      jar.to_a.should have(2).items
+    end
+    it "should handle mixed distinct Set-Cookie and Set-Cookie2 headers" do
+      jar = Jar.new
+      cookies = jar.set_cookies_from_headers 'http://localhost/', 
+      { 'Set-Cookie' => 'foo=bar',
+        'Set-Cookie2' => 'bar=baz;Version=1' } 
+      cookies.should have(2).items
+      jar.to_a.should have(2).items
+    end
+    it "should handle overlapping Set-Cookie and Set-Cookie2 headers" do
+      jar = Jar.new
+      cookies = jar.set_cookies_from_headers 'http://localhost/', 
+      { 'Set-Cookie' => ['foo=bar','bar=baz'],
+        'Set-Cookie2' => 'foo=bar;Version=1' } 
+      cookies.should have(2).items
+      jar.to_a.should have(2).items
+      # and has the version 1 cookie
+      cookies.find do |cookie|
+        cookie.name == 'foo'
+      end.version.should == 1
+    end
+  end
+  begin
+    require 'json'
+    describe ".to_json" do
+      it "should serialize cookies to JSON" do
+      
+        c = Cookie.from_set_cookie 'https://localhost/', 'foo=bar;secure;expires=Wed, 01-Nov-2028 12:00:00 GMT'
+        jar = Jar.new
+        jar.add_cookie c
+        json = jar.to_json
+        json.should be_a String
+      end
+    end
+    describe ".json_create" do
+      it "should deserialize a JSON array to a jar" do
+        json = "[{\"name\":\"foo\",\"value\":\"bar\",\"domain\":\"localhost.local\",\"path\":\"\\/\",\"created_at\":\"2009-09-11 12:51:03 -0600\",\"expiry\":\"2028-11-01 12:00:00 GMT\",\"secure\":true}]" 
+        array = JSON.parse json
+        
+        jar = Jar.json_create array
+        jar.get_cookies('https://localhost/').should have(1).items
+      end
+      it "should deserialize a JSON hash to a jar" do
+        json = "{\"cookies\":[{\"name\":\"foo\",\"value\":\"bar\",\"domain\":\"localhost.local\",\"path\":\"\\/\",\"created_at\":\"2009-09-11 12:51:03 -0600\",\"expiry\":\"2028-11-01 12:00:00 GMT\",\"secure\":true}]}" 
+        hash = JSON.parse json
+        
+        jar = Jar.json_create hash
+        jar.get_cookies('https://localhost/').should have(1).items
+      end
+      
+      it "should automatically deserialize to a jar" do
+        json = "{\"json_class\":\"CookieJar::Jar\",\"cookies\":[{\"name\":\"foo\",\"value\":\"bar\",\"domain\":\"localhost.local\",\"path\":\"\\/\",\"created_at\":\"2009-09-11 12:51:03 -0600\",\"expiry\":\"2028-11-01 12:00:00 GMT\",\"secure\":true}]}" 
+        jar = JSON.parse json
+        jar.get_cookies('https://localhost/').should have(1).items  
+      end
+    end
+  rescue LoadError
+    it "does not appear the JSON library is installed" do
+       raise 'please install the JSON lirbary'
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: cookiejar
+version: !ruby/object:Gem::Version 
+  version: 0.2.9
+platform: ruby
+authors: 
+- David Waite
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-02 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: Allows for parsing and returning cookies in Ruby HTTP client code
+email: david@alkaline-solutions.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/cookiejar/cookie.rb
+- lib/cookiejar/cookie_validation.rb
+- lib/cookiejar/jar.rb
+- lib/cookiejar.rb
+- test/cookie_test.rb
+- test/cookie_validation_test.rb
+- test/jar_test.rb
+has_rdoc: true
+homepage: http://alkaline-solutions.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- CookieJar -- Client-side HTTP Cookies
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Client-side HTTP Cookie library
+test_files: []
+