http-cookie 1.0.0.pre9 → 1.0.0.pre10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53cb4c9e7487abb35fc5566cadc3c2f8afbea819
-  data.tar.gz: dfa1e8393cc3f71df62e55984196046788942c6d
+  metadata.gz: f409469763d06151a3094c2246c64c71f8f0016a
+  data.tar.gz: 4c6433fa901c541aa2bf16461fbbe817fca00f4e
 SHA512:
-  metadata.gz: 8e232e6d966c1fb49b9e7e6ab50456b955d4b377962f71d570531aa622200ef94031ec602bddea8d2c475e51b20240c85306ff6dc9b874c27453acacaf0ae9cd
-  data.tar.gz: 188e45b944168d04516707ad503710b938acae9f50a50d61d3351e6e12e936fba53cc0ce26e7ee80b370e18809df95e91160f12ef4c73d760ad4202a8eaa9cb6
+  metadata.gz: ec86eccfc64ce5e1672b0ed786722deda4c0386deb564c7eec89ba965199717b603e517a8acdd0cbd560380585e8ed96e66ff9d8cf227ca716ab9c9b4dfabec1
+  data.tar.gz: ad8af975e1ec653bd2e978f21a1c8199160598c16a8bad6851a9d6b6a2ee3e069409858b31a7f076e37c59f697eeeec6f43b9309b6eff51f5acbc0767d9ac4e4

data/README.md

@@ -1,6 +1,6 @@
 # HTTP::Cookie
 
-`HTTP::Cookie` is a ruby library to handle HTTP cookies in a way both
+HTTP::Cookie is a ruby library to handle HTTP cookies in a way both
 compliant with RFCs and compatible with today's major browsers.
 
 It was originally a part of the
@@ -60,14 +60,16 @@ Or install it yourself as:
     set_cookie_header_value = cookies.set_cookie_value(my_url)
 
 
-## Incompatibilities with `Mechanize::Cookie`/`CookieJar`
+## Incompatibilities with Mechanize::Cookie/CookieJar
 
 There are several incompatibilities between
-`Mechanize::Cookie`/`CookieJar` and `HTTP::Cookie`/`CookieJar`.  Below
-is how to rewrite existing code written for `Mechanize::Cookie` with
-equivalent using `HTTP::Cookie`:
+Mechanize::Cookie/CookieJar and HTTP::Cookie/CookieJar.  Below
+is how to rewrite existing code written for Mechanize::Cookie with
+equivalent using HTTP::Cookie:
 
-- `Mechanize::Cookie.parse`
+- Mechanize::Cookie.parse
+
+    The parameter order changed in HTTP::Cookie.parse.
 
         # before
         cookies1 = Mechanize::Cookie.parse(uri, set_cookie1)
@@ -77,7 +79,21 @@ equivalent using `HTTP::Cookie`:
         cookies1 = HTTP::Cookie.parse(set_cookie1, uri_or_url)
         cookies2 = HTTP::Cookie.parse(set_cookie2, uri_or_url, :logger => log)
 
-- `Mechanize::Cookie#set_domain`
+- Mechanize::Cookie#version, #version=
+
+    There is no longer a sense of version in HTTP cookie.  The only
+    version number that has ever been defined was zero, and there will
+    be no other version since the version attribute has been removed
+    in RFC 6265.
+
+- Mechanize::Cookie#comment, #comment=
+
+    Ditto.  The comment attribute has been removed in RFC 6265.
+
+- Mechanize::Cookie#set_domain
+
+    This method was unintentionally made public.  Simply use
+    HTTP::Cookie#domain=.
 
         # before
         cookie.set_domain(domain)
@@ -85,7 +101,9 @@ equivalent using `HTTP::Cookie`:
         # after
         cookie.domain = domain
 
-- `Mechanize::CookieJar#add`, `#add!`
+- Mechanize::CookieJar#add, #add!
+
+    Always use HTTP::CookieJar#add.
 
         # before
         jar.add!(cookie1)
@@ -95,7 +113,9 @@ equivalent using `HTTP::Cookie`:
         jar.add(cookie1)
         cookie2.origin = uri; jar.add(cookie2)  # or specify origin in parse() or new()
 
-- `Mechanize::CookieJar#clear!`
+- Mechanize::CookieJar#clear!
+
+    Use HTTP::Cookiejar#clear.
 
         # before
         jar.clear!
@@ -103,7 +123,9 @@ equivalent using `HTTP::Cookie`:
         # after
         jar.clear
 
-- `Mechanize::CookieJar#save_as`
+- Mechanize::CookieJar#save_as
+
+    Use HTTP::CookieJar#save.
 
         # before
         jar.save_as(file)
@@ -111,34 +133,34 @@ equivalent using `HTTP::Cookie`:
         # after
         jar.save(file)
 
-- `Mechanize::CookieJar#jar`
+- Mechanize::CookieJar#jar
 
-    There is no direct access to the internal hash in
-    `HTTP::CookieJar` since it has introduced an abstract store layer.
-    If you want to tweak the internals of the hash store, try creating
-    a new store class referring to the default store class
-    `HTTP::CookieJar::HashStore`.
+    There is no direct access to the internal hash in HTTP::CookieJar
+    since it has introduced an abstract store layer.  If you want to
+    tweak the internals of the hash store, try creating a new store
+    class referring to the default store class
+    HTTP::CookieJar::HashStore.
 
     If you desperately need it you can access it by
     `jar.store.instance_variable_get(:@jar)`, but there is no
     guarantee that it will remain available in the future.
 
 
-`HTTP::Cookie`/`CookieJar` raise runtime errors to help migration, so
+HTTP::Cookie/CookieJar raise runtime errors to help migration, so
 after replacing the class names, try running your test code once to
 find out how to fix your code base.
 
 ### File formats
 
-The YAML serialization format has changed, and `HTTP::CookieJar#load`
+The YAML serialization format has changed, and HTTP::CookieJar#load
 cannot import what is written in a YAML file saved by
-`Mechanize::CookieJar#save_as`.  `HTTP::CookieJar#load` will not raise
-an exception if an incompatible YAML file is given, but the content is
+Mechanize::CookieJar#save_as.  HTTP::CookieJar#load will not raise an
+exception if an incompatible YAML file is given, but the content is
 silently ignored.
 
 Note that there is (obviously) no forward compatibillity with this.
-Trying to load a YAML file saved by `HTTP::CookieJar` with
-`Mechanize::CookieJar` will fail in runtime error.
+Trying to load a YAML file saved by HTTP::CookieJar with
+Mechanize::CookieJar will fail in runtime error.
 
 On the other hand, there has been (and will ever be) no change in the
 cookies.txt format, so use it instead if compatibility is significant.

data/lib/http/cookie.rb

@@ -95,8 +95,8 @@ class HTTP::Cookie
   # The cookie domain.
   #
   # Setting a domain with a leading dot implies that the #for_domain
-  # flag should be turned on.  The setter accepts a `DomainName`
-  # object as well as a string-like.
+  # flag should be turned on.  The setter accepts a DomainName object
+  # as well as a string-like.
   #
   # :attr_accessor: domain
 
@@ -147,8 +147,8 @@ class HTTP::Cookie
   # string, downcased or not.
   #
   # This methods accepts any attribute name for which a setter method
-  # is defined.  Beware, however, any error (typically
-  # `ArgumentError`) a setter method raises will be passed through.
+  # is defined.  Beware, however, any error (typically ArgumentError)
+  # a setter method raises will be passed through.
   #
   # e.g.
   #
@@ -158,11 +158,8 @@ class HTTP::Cookie
   #     new("name" => "uid", "value" => "a12345", "Domain" => 'www.example.org')
   #
   def initialize(*args)
-    @version = 0     # Netscape Cookie
-
     @origin = @domain = @path =
-      @expires = @max_age =
-      @comment = nil
+      @expires = @max_age = nil
     @secure = @httponly = false
     @session = true
     @created_at = @accessed_at = Time.now
@@ -195,7 +192,7 @@ class HTTP::Cookie
         origin = val
       when 'max_age'
         # Let max_age take precedence over expires
-        max_age = val if val
+        max_age = val
       else
         setter = :"#{skey}="
         __send__(setter, val) if respond_to?(setter)
@@ -259,23 +256,22 @@ class HTTP::Cookie
     #
     # ### Compatibility Note for Mechanize::Cookie users
     #
-    # * Order of parameters changed in
-    #   `HTTP::Cookie.parse`.  Compare these:
+    # * Order of parameters changed in HTTP::Cookie.parse:
     #
     #         Mechanize::Cookie.parse(uri, set_cookie[, log])
     #
     #         HTTP::Cookie.parse(set_cookie, uri[, :logger => # log])
     #
-    # * `HTTP::Cookie.parse` does not accept nil for `set_cookie`.
+    # * HTTP::Cookie.parse does not accept nil for `set_cookie`.
     #
-    # * `HTTP::Cookie.parse` does not yield nil nor include nil in an
+    # * HTTP::Cookie.parse does not yield nil nor include nil in an
     #   returned array.  It simply ignores unparsable parts.
     #
-    # * `HTTP::Cookie.parse` is made to follow RFC 6265 to the extent
+    # * HTTP::Cookie.parse is made to follow RFC 6265 to the extent
     #   not terribly breaking interoperability with broken
     #   implementations.  In particular, it is capable of parsing
-    #   cookie definitions containing double-quotes just as
-    #   naturally expected.
+    #   cookie definitions containing double-quotes just as naturally
+    #   expected.
     def parse(set_cookie, origin, options = nil, &block)
       if options
         logger = options[:logger]
@@ -306,10 +302,6 @@ class HTTP::Cookie
                 cookie.expires = avalue unless cookie.max_age
               when 'max-age'
                 cookie.max_age = avalue
-              when 'comment'
-                cookie.comment = avalue
-              when 'version'
-                cookie.version = avalue
               when 'secure'
                 cookie.secure = avalue
               when 'httponly'
@@ -494,6 +486,8 @@ class HTTP::Cookie
     else
       str = check_string_type(sec) or
         raise TypeError, "#{sec.class} is not an Integer or String"
+      /\A-?\d+\z/.match(str) or
+        raise ArgumentError, "invalid Max-Age: #{sec.inspect}"
       sec = str.to_i
     end
     if @session = sec.nil?
@@ -519,13 +513,6 @@ class HTTP::Cookie
     self
   end
 
-  # The version attribute.  The only known version of the cookie
-  # format is 0.
-  attr_accessor :version
-
-  # The comment attribute.
-  attr_accessor :comment
-
   # The time this cookie was created at.  This value is used as a base
   # date for interpreting the Max-Age attribute value.  See #expires.
   attr_accessor :created_at
@@ -608,9 +595,6 @@ class HTTP::Cookie
     elsif @expires
       string << "; Expires=#{@expires.httpdate}"
     end
-    if @comment
-      string << "; Comment=#{Scanner.quote(@comment)}"
-    end
     if @httponly
       string << "; HttpOnly"
     end

data/lib/http/cookie/version.rb

@@ -1,5 +1,5 @@
 module HTTP
   class Cookie
-    VERSION = "1.0.0.pre9"
+    VERSION = "1.0.0.pre10"
   end
 end

data/lib/http/cookie_jar.rb

@@ -19,13 +19,13 @@ class HTTP::CookieJar
   # : The store class that backs this jar. (default: `:hash`)
   # A symbol or an instance of a store class is accepted.  Symbols are
   # mapped to store classes, like `:hash` to
-  # `HTTP::CookieJar::HashStore` and `:mozilla` to
-  # `HTTP::CookieJar::MozillaStore`.
+  # HTTP::CookieJar::HashStore and `:mozilla` to
+  # HTTP::CookieJar::MozillaStore.
   #
   # Any options given are passed through to the initializer of the
   # specified store class.  For example, the `:mozilla`
-  # (`HTTP::CookieJar::MozillaStore`) store class requires a
-  # `:filename` option.  See individual store classes for details.
+  # (HTTP::CookieJar::MozillaStore) store class requires a `:filename`
+  # option.  See individual store classes for details.
   def initialize(options = nil)
     opthash = {
       :store => :hash,
@@ -57,8 +57,6 @@ class HTTP::CookieJar
   # To be more specific, HTTP::Cookie.new takes an `:origin` option
   # and HTTP::Cookie.parse takes one via the second argument.
   #
-  #   `HTTP::Cookie.parse`.  Compare these:
-  #
   #       # Mechanize::Cookie
   #       jar.add(origin, cookie)
   #       jar.add!(cookie)    # no acceptance check is performed
@@ -151,20 +149,22 @@ class HTTP::CookieJar
   # Available option keywords are below:
   #
   # * `:format`
-  #   <dl class="rdoc-list note-list">
-  #     <dt>:yaml</dt>
-  #     <dd>YAML structure (default)</dd>
-  #     <dt>:cookiestxt</dt>
-  #     <dd>: Mozilla's cookies.txt format</dd>
-  #   </dl>
+  #
+  #     <dl class="rdoc-list note-list">
+  #       <dt>:yaml</dt>
+  #       <dd>YAML structure (default)</dd>
+  #       <dt>:cookiestxt</dt>
+  #       <dd>: Mozilla's cookies.txt format</dd>
+  #     </dl>
   #
   # * `:session`
-  #   <dl class="rdoc-list note-list">
-  #     <dt>true</dt>
-  #     <dd>Save session cookies as well.</dd>
-  #     <dt>false</dt>
-  #     <dd>Do not save session cookies. (default)</dd>
-  #   </dl>
+  #
+  #     <dl class="rdoc-list note-list">
+  #       <dt>true</dt>
+  #       <dd>Save session cookies as well.</dd>
+  #       <dt>false</dt>
+  #       <dd>Do not save session cookies. (default)</dd>
+  #     </dl>
   #
   # All options given are passed through to the underlying cookie
   # saver module.
@@ -212,17 +212,18 @@ class HTTP::CookieJar
   #
   # Loads cookies recorded in a file or an IO in the format specified
   # into the jar and returns self.  If a given object responds to
-  # #read it is taken as an IO, or taken as a filename otherwise.
+  # \#read it is taken as an IO, or taken as a filename otherwise.
   #
   # Available option keywords are below:
   #
   # * `:format`
-  #   <dl class="rdoc-list note-list">
-  #     <dt>:yaml</dt>
-  #     <dd>YAML structure (default)</dd>
-  #     <dt>:cookiestxt</dt>
-  #     <dd>: Mozilla's cookies.txt format</dd>
-  #   </dl>
+  #
+  #     <dl class="rdoc-list note-list">
+  #       <dt>:yaml</dt>
+  #       <dd>YAML structure (default)</dd>
+  #       <dt>:cookiestxt</dt>
+  #       <dd>Mozilla's cookies.txt format</dd>
+  #     </dl>
   #
   # All options given are passed through to the underlying cookie
   # saver module.

data/lib/http/cookie_jar/cookiestxt_saver.rb

@@ -80,7 +80,6 @@ class HTTP::CookieJar::CookiestxtSaver < HTTP::CookieJar::AbstractSaver
       :path => path,
       :secure => s_secure == True,
       :httponly => httponly,
-      :expires => expires,
-      :version => 0)
+      :expires => expires)
   end
 end

data/test/test_http_cookie.rb

@@ -102,7 +102,6 @@ class TestHTTPCookie < Test::Unit::TestCase
     assert_equal 1, HTTP::Cookie.parse(cookie_str, uri) { |cookie|
       assert_equal 'quoted', cookie.name
       assert_equal 'value', cookie.value
-      assert_equal 'comment is "comment"', cookie.comment
     }.size
   end
 
@@ -126,14 +125,19 @@ class TestHTTPCookie < Test::Unit::TestCase
 
   def test_parse_bad_version
     bad_cookie = 'PRETANET=TGIAqbFXtt; Name=/PRETANET; Path=/; Version=1.2; Content-type=text/html; Domain=192.168.6.196; expires=Friday, 13-November-2026  23:01:46 GMT;'
-    url = URI.parse('http://localhost/')
-    assert_equal 0, HTTP::Cookie.parse(bad_cookie, url).size
+    url = URI.parse('http://192.168.6.196/')
+    # The version attribute is obsolete and simply ignored
+    cookies = HTTP::Cookie.parse(bad_cookie, url)
+    assert_equal 1, cookies.size
   end
 
   def test_parse_bad_max_age
-    bad_cookie = 'PRETANET=TGIAqbFXtt; Name=/PRETANET; Path=/; Max-Age=1.2; Content-type=text/html; Domain=192.168.6.196; expires=Friday, 13-November-2026  23:01:46 GMT;'
-    url = URI.parse('http://localhost/')
-    assert_equal 0, HTTP::Cookie.parse(bad_cookie, url).size
+    bad_cookie = 'PRETANET=TGIAqbFXtt; Name=/PRETANET; Path=/; Max-Age=forever; Content-type=text/html; Domain=192.168.6.196; expires=Friday, 13-November-2026  23:01:46 GMT;'
+    url = URI.parse('http://192.168.6.196/')
+    # A bad max-age is simply ignored
+    cookies = HTTP::Cookie.parse(bad_cookie, url)
+    assert_equal 1, cookies.size
+    assert_equal nil, cookies.first.max_age
   end
 
   def test_parse_date_fail
@@ -582,6 +586,28 @@ class TestHTTPCookie < Test::Unit::TestCase
     assert_equal true, cookie.expired?
   end
 
+  def test_max_age=
+    cookie = HTTP::Cookie.new(cookie_values)
+
+    assert_raises(ArgumentError) {
+      cookie.max_age = "+1"
+    }
+    assert_raises(ArgumentError) {
+      cookie.max_age = "1.5"
+    }
+    assert_raises(ArgumentError) {
+      cookie.max_age = "1 day"
+    }
+    assert_raises(TypeError) {
+      cookie.max_age = [1]
+    }
+    cookie.max_age = "12"
+    assert_equal 12, cookie.max_age
+
+    cookie.max_age = -3
+    assert_equal -3, cookie.max_age
+  end
+
   def test_session
     cookie = HTTP::Cookie.new(cookie_values)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http-cookie
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre9
+  version: 1.0.0.pre10
 platform: ruby
 authors:
 - Akinori MUSHA
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-03 00:00:00.000000000 Z
+date: 2013-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: domain_name