http-cookie 1.0.0.pre3 → 1.0.0.pre4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38b7c03ef15bbe6b866f7128b719962c7776fa16
-  data.tar.gz: 79078f90e4250e68ec2fa0b6250ee378d7681aea
+  metadata.gz: b4b4b558d9627051478d3ea9e33579ffedadbe50
+  data.tar.gz: 1c3bfc5bd3379d934cc4aeda4211ad339d4ac9dc
 SHA512:
-  metadata.gz: 41d93c054cda8e2fbb07554de72061fcf6218da13dce541fda0581056315b0d0438307c1f95043d59bce7742e4cee08ea9295f75c7fc1ddf297849cf7ed87ee0
-  data.tar.gz: a9cebb93040062c160bccf8758a25898af16f8b8fc2e5118a5cfb7210ba96b2f212b8154ca2b4e1fb1e2e740a5efaffd515bd9addc0ddee3be94d6e93e89f7f9
+  metadata.gz: a5b077b1f4220e1a6c5dc9454f498d2d0757d55584ebad1b19a9f565ab5d91070a519b6c1f75b8118e88efd0542614bc5b15282952bbf12d29bdff9daacacb0c
+  data.tar.gz: f16235e47faae4d97c500ea2ccea5c9a7fc3948c366906ce7ad1a09dd11474754b351a66919e34bbe3e6a9b87ec7f050d7ef3b5f84bb2004f56c2bed613ef4e9

data/README.md

@@ -114,10 +114,10 @@ equivalent using `HTTP::Cookie`:
 - `Mechanize::CookieJar#jar`
 
     There is no direct access to the internal hash in
-    `HTTP::CookieJar` since it has introduced an abstract storage
-    layer.  If you want to tweak the internals of the hash storage,
-    try creating a new storage class referring to the default storage
-    class `HTTP::CookieJar::HashStore`.
+    `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

data/lib/http/cookie.rb

@@ -38,7 +38,8 @@ class HTTP::Cookie
     name        value
     domain      for_domain  path
     secure      httponly
-    expires     created_at  accessed_at
+    expires     max_age
+    created_at  accessed_at
   ]
 
   if String.respond_to?(:try_convert)
@@ -110,8 +111,8 @@ class HTTP::Cookie
   # The setter method accepts a Time object, a string representation
   # of date/time, or `nil`.
   #
-  # Note that #max_age and #expires are mutually exclusive.  Setting
-  # \#max_age resets #expires to nil, and vice versa.
+  # Setting this value resets #max_age to nil.  When #max_age is
+  # non-nil, #expires returns `created_at + max_age`.
   #
   # :attr_accessor: expires
 
@@ -122,8 +123,7 @@ class HTTP::Cookie
   # represents an integer which will be stringified and then
   # integerized using #to_i.
   #
-  # Note that #max_age and #expires are mutually exclusive.  Setting
-  # \#max_age resets #expires to nil, and vice versa.
+  # This value is reset to nil when #expires= is called.
   #
   # :attr_accessor: max_age
 
@@ -232,22 +232,17 @@ class HTTP::Cookie
     # given origin is not allowed to issue is not included in the
     # resulted array.
     #
-    # Any Max-Age attribute value found is converted to an expires
-    # value computing from the current time so that expiration check
-    # (#expired?) can be performed.
-    #
     # If a block is given, each cookie object is passed to the block.
     #
     # Available option keywords are below:
     #
-    # `origin`
+    # :origin
     # : The cookie's origin URI/URL
     #
-    # `date`
-    # : The base date used for interpreting Max-Age attribute values
-    #   instead of the current time
+    # :created_at
+    # : The creation time of the cookies parsed.
     #
-    # `logger`
+    # :logger
     # : Logger object useful for debugging
     #
     # ### Compatibility Note for Mechanize::Cookie users
@@ -271,9 +266,8 @@ class HTTP::Cookie
       if options
         logger = options[:logger]
         origin = options[:origin] and origin = URI(origin)
-        date = options[:date]
+        created_at = options[:created_at]
       end
-      date ||= Time.now
 
       [].tap { |cookies|
         s = Scanner.new(set_cookie, logger)
@@ -282,6 +276,7 @@ class HTTP::Cookie
           break if name.nil? || name.empty?
 
           cookie = new(name, value)
+          cookie.created_at = created_at if created_at
           attrs.each { |aname, avalue|
             begin
               case aname
@@ -311,10 +306,6 @@ class HTTP::Cookie
             end
           }
 
-          # Have `expires` set instead of `max_age`, so that
-          # expiration check (`expired?`) can be performed.
-          cookie.expires = date + cookie.max_age if cookie.max_age
-
           if origin
             begin
               cookie.origin = origin
@@ -445,7 +436,9 @@ class HTTP::Cookie
   attr_reader :session
   alias session? session
 
-  attr_reader :expires
+  def expires
+    @expires or @created_at && @max_age ? @created_at + @max_age : nil
+  end
 
   # See #expires.
   def expires=(t)
@@ -483,8 +476,11 @@ class HTTP::Cookie
 
   # Tests if this cookie is expired by now, or by a given time.
   def expired?(time = Time.now)
-    return false unless @expires
-    time > @expires
+    if expires = self.expires
+      expires <= time
+    else
+      false
+    end
   end
 
   # Expires this cookie by setting the expires attribute value to a
@@ -501,7 +497,8 @@ class HTTP::Cookie
   # The comment attribute.
   attr_accessor :comment
 
-  # The time this cookie was created at.
+  # 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
 
   # The time this cookie was last accessed at.
@@ -618,11 +615,16 @@ class HTTP::Cookie
 
   # YAML deserialization helper for Psych.
   def yaml_initialize(tag, map)
+    expires = nil
     map.each { |key, value|
       case key
+      when 'expires'
+        # avoid clobbering max_age
+        expires = value
       when *PERSISTENT_PROPERTIES
         __send__(:"#{key}=", value)
       end
     }
+    self.expires = expires if self.max_age.nil?
   end
 end

data/lib/http/cookie/version.rb

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

data/lib/http/cookie_jar.rb

@@ -1,3 +1,4 @@
+# :markup: markdown
 require 'http/cookie'
 
 ##
@@ -10,18 +11,30 @@ class HTTP::CookieJar
 
   attr_reader :store
 
-  # Generates a new cookie jar.  The default store class is `:hash`,
-  # which maps to `HTTP::CookieJar::HashStore`.  Any given options are
-  # passed through to the initializer of the specified store class.
-  # For example, the `:mozilla` (`HTTP::CookieJar::MozillaStore`)
-  # store class requires a `:filename` option.
-  def initialize(store = :hash, options = nil)
-    case store
+  # Generates a new cookie jar.
+  #
+  # Available option keywords are as below:
+  #
+  # :store
+  # : 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`.
+  #
+  # 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.
+  def initialize(options = nil)
+    opthash = {
+      :store => :hash,
+    }
+    opthash.update(options) if options
+    case store = opthash[:store]
     when Symbol
-      @store = AbstractStore.implementation(store).new(options)
+      @store = AbstractStore.implementation(store).new(opthash)
     when AbstractStore
-      options.empty? or
-        raise ArgumentError, 'wrong number of arguments (%d for 1)' % (1 + options.size)
       @store = store
     else
       raise TypeError, 'wrong object given as cookie store: %s' % store.inspect
@@ -32,7 +45,7 @@ class HTTP::CookieJar
     @store = other.instance_eval { @store.dup }
   end
 
-  # Adds a +cookie+ to the jar and return self.  If a given cookie has
+  # Adds a cookie to the jar and return self.  If a given cookie has
   # no domain or path attribute values and the origin is unknown,
   # ArgumentError is raised.
   #
@@ -71,7 +84,7 @@ class HTTP::CookieJar
     }.sort
   end
 
-  # Tests if the jar is empty.  If +url+ is given, tests if there is
+  # Tests if the jar is empty.  If `url` is given, tests if there is
   # no cookie for the URL.
   def empty?(url = nil)
     if url
@@ -84,12 +97,12 @@ class HTTP::CookieJar
 
   # Iterates over all cookies that are not expired.
   #
-  # An optional argument +uri+ specifies a URI/URL indicating the
+  # An optional argument `uri` specifies a URI/URL indicating the
   # destination of the cookies being selected.  Every cookie yielded
   # should be good to send to the given URI,
   # i.e. cookie.valid_for_uri?(uri) evaluates to true.
   #
-  # If (and only if) the +uri+ option is given, last access time of
+  # If (and only if) the `uri` option is given, last access time of
   # each cookie is updated to the current time.
   def each(uri = nil, &block)
     block_given? or return enum_for(__method__, uri)
@@ -114,16 +127,21 @@ class HTTP::CookieJar
   #
   # Available option keywords are below:
   #
-  # * +format+
-  #   [<tt>:yaml</tt>]
-  #     YAML structure (default)
-  #   [<tt>:cookiestxt</tt>]
-  #     Mozilla's cookies.txt format
-  # * +session+
-  #   [+true+]
-  #     Save session cookies as well.
-  #   [+false+]
-  #     Do not save session cookies. (default)
+  # * `: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>
+  #
+  # * `: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>
   #
   # All options given are passed through to the underlying cookie
   # saver module.
@@ -175,11 +193,13 @@ class HTTP::CookieJar
   #
   # Available option keywords are below:
   #
-  # * +format+
-  #   [<tt>:yaml</tt>]
-  #     YAML structure (default)
-  #   [<tt>:cookiestxt</tt>]
-  #     Mozilla's cookies.txt format
+  # * `: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>
   #
   # All options given are passed through to the underlying cookie
   # saver module.

data/lib/http/cookie_jar/cookiestxt_saver.rb

@@ -39,7 +39,7 @@ class HTTP::CookieJar::CookiestxtSaver < HTTP::CookieJar::AbstractSaver
         @for_domain ? True : False,
         @path,
         @secure ? True : False,
-        @expires.to_i,
+        expires.to_i,
         @name,
         @value
       ]

data/lib/http/cookie_jar/hash_store.rb

@@ -9,7 +9,7 @@ end
 # :startdoc:
 
 class HTTP::CookieJar
-  # A store class that uses a hash of hashes.
+  # A store class that uses a hash-based cookie store.
   class HashStore < AbstractStore
     def default_options
       {
@@ -17,20 +17,26 @@ class HTTP::CookieJar
       }
     end
 
+    # Generates a hash based cookie store.
+    #
+    # Available option keywords are as below:
+    #
+    # :gc_threshold
+    # : GC threshold; A GC happens when this many times cookies have
+    # been stored (default: `HTTP::Cookie::MAX_COOKIES_TOTAL / 20`)
     def initialize(options = nil)
       super
 
-      @jar = {}
-      # {
-      #   hostname => {
-      #     path => {
-      #       name => cookie,
-      #       ...
-      #     },
+      @jar = {
+      # hostname => {
+      #   path => {
+      #     name => cookie,
       #     ...
       #   },
       #   ...
-      # }
+      # },
+      # ...
+      }
 
       @gc_index = 0
     end

data/lib/http/cookie_jar/mozilla_store.rb

@@ -1,7 +1,10 @@
+# :markup: markdown
 require 'http/cookie_jar'
 require 'sqlite3'
 
 class HTTP::CookieJar
+  # A store class that uses Mozilla compatible SQLite3 database as
+  # backing store.
   class MozillaStore < AbstractStore
     SCHEMA_VERSION = 5
 
@@ -26,6 +29,27 @@ class HTTP::CookieJar
       appId inBrowserElement
     ]
 
+    # Generates a Mozilla cookie store.  If the file does not exist,
+    # it is created.  If it does and its schema is old, it is
+    # automatically upgraded with a new schema keeping the existing
+    # data.
+    #
+    # Available option keywords are as below:
+    #
+    # :filename
+    # : A file name of the SQLite3 database to open.  This option is
+    # mandatory.
+    #
+    # :gc_threshold
+    # : GC threshold; A GC happens when this many times cookies have
+    # been stored (default: `HTTP::Cookie::MAX_COOKIES_TOTAL / 20`)
+    #
+    # :app_id
+    # : application ID (default: `0`) to have per application jar.
+    #
+    # :in_browser_element
+    # : a flag to tell if cookies are stored in an in browser
+    # element. (default: `false`)
     def initialize(options = nil)
       super
 
@@ -39,6 +63,22 @@ class HTTP::CookieJar
       @gc_index = 0
     end
 
+    # The file name of the SQLite3 database given in initialization.
+    attr_reader :filename
+
+    # Closes the SQLite3 database.  After closing, any operation may
+    # raise an error.
+    def close
+      @db.close
+      self
+    end
+
+    # Tests if the SQLite3 database is closed.
+    def closed?
+      @db.closed?
+    end
+
+    # Returns the schema version of the database.
     def schema_version
       @schema_version ||= @db.execute("PRAGMA user_version").first[0]
     rescue SQLite3::SQLException

data/test/test_http_cookie.rb

@@ -200,18 +200,18 @@ class TestHTTPCookie < Test::Unit::TestCase
 
     cookie = HTTP::Cookie.parse('name=Akinori; max-age=3600', :origin => url).first
     assert_in_delta Time.now + 3600, cookie.expires, 1
-    cookie = HTTP::Cookie.parse('name=Akinori; max-age=3600', :origin => url, :date => base).first
+    cookie = HTTP::Cookie.parse('name=Akinori; max-age=3600', :origin => url, :created_at => base).first
     assert_equal base + 3600, cookie.expires
 
     # Max-Age has precedence over Expires
     cookie = HTTP::Cookie.parse("name=Akinori; max-age=3600; expires=#{date}", :origin => url).first
     assert_in_delta Time.now + 3600, cookie.expires, 1
-    cookie = HTTP::Cookie.parse("name=Akinori; max-age=3600; expires=#{date}", :origin => url, :date => base).first
+    cookie = HTTP::Cookie.parse("name=Akinori; max-age=3600; expires=#{date}", :origin => url, :created_at => base).first
     assert_equal base + 3600, cookie.expires
 
     cookie = HTTP::Cookie.parse("name=Akinori; expires=#{date}; max-age=3600", :origin => url).first
     assert_in_delta Time.now + 3600, cookie.expires, 1
-    cookie = HTTP::Cookie.parse("name=Akinori; expires=#{date}; max-age=3600", :origin => url, :date => base).first
+    cookie = HTTP::Cookie.parse("name=Akinori; expires=#{date}; max-age=3600", :origin => url, :created_at => base).first
     assert_equal base + 3600, cookie.expires
   end
 
@@ -382,8 +382,8 @@ class TestHTTPCookie < Test::Unit::TestCase
       date = Time.at(Time.now.to_i)
       cookie_params.keys.combine.each do |keys|
         cookie_text = [cookie_value, *keys.map { |key| cookie_params[key] }].join('; ')
-        cookie, = HTTP::Cookie.parse(cookie_text, :origin => url, :date => date)
-        cookie2, = HTTP::Cookie.parse(cookie.set_cookie_value, :origin => url, :date => date)
+        cookie, = HTTP::Cookie.parse(cookie_text, :origin => url, :created_at => date)
+        cookie2, = HTTP::Cookie.parse(cookie.set_cookie_value, :origin => url, :created_at => date)
 
         assert_equal(cookie.name, cookie2.name)
         assert_equal(cookie.value, cookie2.value)
@@ -539,7 +539,7 @@ class TestHTTPCookie < Test::Unit::TestCase
 
     cookie.max_age = 3600
     assert_equal false, cookie.session?
-    assert_equal nil, cookie.expires
+    assert_equal cookie.created_at + 3600, cookie.expires
 
     cookie.max_age = nil
     assert_equal true, cookie.session?
@@ -775,6 +775,38 @@ class TestHTTPCookie < Test::Unit::TestCase
     }
   end
 
+  def test_yaml_expires
+    require 'yaml'
+    cookie = HTTP::Cookie.new(cookie_values)
+
+    assert_equal false, cookie.session?
+    assert_equal nil, cookie.max_age
+
+    ycookie = YAML.load(cookie.to_yaml)
+    assert_equal false, ycookie.session?
+    assert_equal nil, ycookie.max_age
+
+    cookie.expires = nil
+    ycookie = YAML.load(cookie.to_yaml)
+    assert_equal true, ycookie.session?
+    assert_equal nil, ycookie.max_age
+
+    cookie.expires = Time.now + 3600
+    ycookie = YAML.load(cookie.to_yaml)
+    assert_equal false, ycookie.session?
+    assert_equal nil, ycookie.max_age
+
+    cookie.max_age = 3600
+    ycookie = YAML.load(cookie.to_yaml)
+    assert_equal false, ycookie.session?
+    assert_equal cookie.created_at + 3600, ycookie.expires
+
+    cookie.max_age = nil
+    ycookie = YAML.load(cookie.to_yaml)
+    assert_equal true, ycookie.session?
+    assert_equal nil, ycookie.expires
+  end
+
   def test_s_path_match?
     assert_equal true,  HTTP::Cookie.path_match?('/admin/', '/admin/index')
     assert_equal false, HTTP::Cookie.path_match?('/admin/', '/Admin/index')

data/test/test_http_cookie_jar.rb

@@ -363,13 +363,16 @@ class TestHTTPCookieJar < Test::Unit::TestCase
     h_cookie = HTTP::Cookie.new(cookie_values(:name => 'Quux',
                                               :value => 'Foo#Quux',
                                               :httponly => true))
-
+    ma_cookie = HTTP::Cookie.new(cookie_values(:name => 'Maxage',
+                                               :value => 'Foo#Maxage',
+                                               :max_age => 15000))
     @jar.add(cookie)
     @jar.add(s_cookie)
     @jar.add(cookie2)
     @jar.add(h_cookie)
+    @jar.add(ma_cookie)
 
-    assert_equal(4, @jar.cookies(url).length)
+    assert_equal(5, @jar.cookies(url).length)
 
     Dir.mktmpdir do |dir|
       filename = File.join(dir, "cookies.txt")
@@ -384,7 +387,7 @@ class TestHTTPCookieJar < Test::Unit::TestCase
       jar = HTTP::CookieJar.new
       jar.load(filename, :cookiestxt) # HACK test the format
       cookies = jar.cookies(url)
-      assert_equal(3, cookies.length)
+      assert_equal(4, cookies.length)
       cookies.each { |cookie|
         case cookie.name
         when 'Foo'
@@ -407,13 +410,17 @@ class TestHTTPCookieJar < Test::Unit::TestCase
           assert_equal true, cookie.for_domain
           assert_equal '/', cookie.path
           assert_equal true, cookie.httponly?
+        when 'Maxage'
+          assert_equal 'Foo#Maxage', cookie.value
+          assert_equal nil, cookie.max_age
+          assert_in_delta ma_cookie.expires, cookie.expires, 1
         else
           raise
         end
       }
     end
 
-    assert_equal(4, @jar.cookies(url).length)
+    assert_equal(5, @jar.cookies(url).length)
   end
 
   def test_expire_cookies
@@ -591,19 +598,27 @@ class TestHTTPCookieJar < Test::Unit::TestCase
   def test_max_cookies_hashstore
     gc_threshold = 150
     h_test_max_cookies(
-      HTTP::CookieJar.new(:hash,
+      HTTP::CookieJar.new(
+        :store => :hash,
         :gc_threshold => gc_threshold),
       HTTP::Cookie::MAX_COOKIES_TOTAL + gc_threshold)
   end
 
   def test_max_cookies_mozillastore
     gc_threshold = 150
-    Dir.mktmpdir { |dir|
-      h_test_max_cookies(
-        HTTP::CookieJar.new(:mozilla,
-          :gc_threshold => gc_threshold,
-          :filename => File.join(dir, "cookies.sqlite")),
-        HTTP::Cookie::MAX_COOKIES_TOTAL + gc_threshold)
-    }
+    h_test_max_cookies(
+      HTTP::CookieJar.new(
+        :store => :mozilla,
+        :gc_threshold => gc_threshold,
+        :filename => ":memory:"),
+      HTTP::Cookie::MAX_COOKIES_TOTAL + gc_threshold)
+    #Dir.mktmpdir { |dir|
+    #  h_test_max_cookies(
+    #    HTTP::CookieJar.new(
+    #      :store => :mozilla,
+    #      :gc_threshold => gc_threshold,
+    #      :filename => File.join(dir, "cookies.sqlite")),
+    #    HTTP::Cookie::MAX_COOKIES_TOTAL + gc_threshold)
+    #}
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http-cookie
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre3
+  version: 1.0.0.pre4
 platform: ruby
 authors:
 - Akinori MUSHA