http-cookie 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aacf47668ef161f9e46f07ed44bd6e145c805c14
-  data.tar.gz: 92c544f479f357ad08e66a8a3827e1edaca35c2e
+  metadata.gz: e01904534ca62610f72b5aba64d20f403ef41334
+  data.tar.gz: b7194473dbb2106fc6fea76fc8077135721518a3
 SHA512:
-  metadata.gz: 7cc1fc98627c5167e3eb410359b00a868f849d10458ca0b1881efdb6ab94bf51d300f732f9b3de52edec2e21934553f937cb38e416af18e103ca923e70285c58
-  data.tar.gz: 3fef65c59da56daba7cb4d571b034cecab3b66cb656811fe9644d99404a152b5656dc04d2a501a3a6b74cf75cb5bcdde91c87f3d5b470d8ba1ffcd515498c421
+  metadata.gz: 11de16cdf76a561e3dfcf5af1fcc78d6231a352cba9460fed867b4a6a4548dd71b6615c75eb70507599f23906877c05e878b1ed1b5abb33ddcf3410cf5d2794e
+  data.tar.gz: 9cd258c417a7f5f80a5b718a6f4c3b1a59086c871ae62500b3809fce95bbd57a75e45dd9d11deced0052996fa12e32769aae9f7547f82efbab4d1f1a4a2c68a7

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 1.0.1 (2013-04-21)
+
+  - Minor error handling improvements and documentation updates.
+
+  - Argument error regarding specifying store/saver classes no longer
+    raises IndexError, but either ArgumentError or TypeError.
+
+## 1.0.0 (2013-04-17)
+
+  - Initial Release.

data/README.md

@@ -8,6 +8,34 @@ It was originally a part of the
 separated as an independent library in the hope of serving as a common
 component that is reusable from any HTTP related piece of software.
 
+The following is an incomplete list of its features:
+
+* Its behavior is highly compatible with that of today's major web
+  browsers.
+
+* It is based on and conforms to RFC 6265 (the latest standard for the
+  HTTP cookie mechanism) to a high extent, with real world conventions
+  deeply in mind.
+
+* It takes eTLD (effective TLD, also known as "Public Suffix") into
+  account just as major browsers do, to reject cookies with an eTLD
+  domain like "org", "co.jp", or "appspot.com".  This feature is
+  brought to you by the domain_name gem.
+
+* The number of cookies and the size are properly capped so that a
+  cookie store does not get flooded.
+
+* It supports the legacy Netscape cookies.txt format for
+  serialization, maximizing the interoperability with other
+  implementations.
+
+* It supports the cookies.sqlite format adopted by Mozilla Firefox for
+  backend store database which can be shared among multiple program
+  instances.
+
+* It is relatively easy to add a new serialization format or a backend
+  store because of its modular API.
+
 ## Installation
 
 Add this line to your application's `Gemfile`:

data/http-cookie.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |gem|
     'Mike Dalessio'   => 'mike.dalessio@gmail.com',
   }.instance_eval { [keys, values] }
 
-  gem.description   = %q{A Ruby library to handle HTTP Cookies}
-  gem.summary       = %q{A Ruby library to handle HTTP Cookies}
+  gem.description   = %q{HTTP::Cookie is a Ruby library to handle HTTP Cookies based on RFC 6265.  It has with security, standards compliance and compatibility in mind, to behave just the same as today's major web browsers.  It has builtin support for the legacy cookies.txt and the latest cookies.sqlite formats of Mozilla Firefox, and its modular API makes it easy to add support for a new backend store.}
+  gem.summary       = %q{A Ruby library to handle HTTP Cookies based on RFC 6265}
   gem.homepage      = "https://github.com/sparklemotion/http-cookie"
 
   gem.files         = `git ls-files`.split($/)

data/lib/http/cookie.rb

@@ -174,7 +174,7 @@ class HTTP::Cookie
         # Let max_age take precedence over expires
         max_age = val
       when :expires, :expires_at
-        self.expires = val
+        self.expires = val unless max_age
       when :httponly, :httponly?
         @httponly = val
       when :secure, :secure?
@@ -288,7 +288,9 @@ class HTTP::Cookie
               case aname
               when 'domain'
                 cookie.for_domain = true
-                cookie.domain = avalue # This may negate @for_domain
+                # The following may negate @for_domain if the value is
+                # an eTLD or IP address, hence this order.
+                cookie.domain = avalue
               when 'path'
                 cookie.path = avalue
               when 'expires'
@@ -447,6 +449,7 @@ class HTTP::Cookie
     return origin if origin == @origin
     @origin.nil? or
       raise ArgumentError, "origin cannot be changed once it is set"
+    # Delay setting @origin because #domain= or #path= may fail
     origin = URI(origin)
     if URI::HTTP === origin
       self.domain ||= origin.host
@@ -497,7 +500,6 @@ class HTTP::Cookie
 
   # See #max_age.
   def max_age= sec
-    @expires = nil
     case sec
     when Integer, nil
     else
@@ -507,6 +509,7 @@ class HTTP::Cookie
         raise ArgumentError, "invalid Max-Age: #{sec.inspect}"
       sec = str.to_i
     end
+    @expires = nil
     if @session = sec.nil?
       @max_age = nil
     else
@@ -600,7 +603,7 @@ class HTTP::Cookie
       if @domain
         string << "; Domain=#{@domain}"
       else
-        raise "for_domain is specified but domain is known"
+        raise "for_domain is specified but domain is unknown"
       end
     end
     if @path
@@ -608,7 +611,7 @@ class HTTP::Cookie
         string << "; Path=#{@path}"
       end
     else
-      raise "path is known"
+      raise "path is unknown"
     end
     if @max_age
       string << "; Max-Age=#{@max_age}"

data/lib/http/cookie/version.rb

@@ -1,5 +1,5 @@
 module HTTP
   class Cookie
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/lib/http/cookie_jar.rb

@@ -29,16 +29,38 @@ class HTTP::CookieJar
 
   attr_reader :store
 
+  def get_impl(base, value, *args)
+    case value
+    when base
+      value
+    when Symbol
+      begin
+        base.implementation(value).new(*args)
+      rescue IndexError => e
+        raise ArgumentError, e.message
+      end
+    when Class
+      if base >= value
+        value.new(*args)
+      else
+        raise TypeError, 'not a subclass of %s: %s' % [base, value]
+      end
+    else
+      raise TypeError, 'invalid object: %s' % value.inspect
+    end
+  end
+  private :get_impl
+
   # 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.
+  # A symbol addressing a store class, a store class, 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`
@@ -49,14 +71,7 @@ class HTTP::CookieJar
       :store => :hash,
     }
     opthash.update(options) if options
-    case store = opthash[:store]
-    when Symbol
-      @store = AbstractStore.implementation(store).new(opthash)
-    when AbstractStore
-      @store = store
-    else
-      raise TypeError, 'wrong object given as cookie store: %s' % store.inspect
-    end
+    @store = get_impl(AbstractStore, opthash[:store], opthash)
   end
 
   # The copy constructor.  Not all backend store classes support cloning.
@@ -191,6 +206,10 @@ class HTTP::CookieJar
   #
   # * `:format`
   #
+  #     Specifies the format for saving.  A saver class, a symbol
+  #     addressing a saver class, or a pre-generated instance of a
+  #     saver class is accepted.
+  #
   #     <dl class="rdoc-list note-list">
   #       <dt>:yaml</dt>
   #       <dd>YAML structure (default)</dd>
@@ -221,20 +240,20 @@ class HTTP::CookieJar
       when Symbol
         opthash[:format] = options
       else
-        opthash.update(options) if options
+        if hash = Hash.try_convert(options)
+          opthash.update(hash)
+        end
       end
     when 2
       opthash[:format], options = options
-      opthash.update(options) if options
+      if hash = Hash.try_convert(options)
+        opthash.update(hash)
+      end
     else
       raise ArgumentError, 'wrong number of arguments (%d for 1-3)' % (1 + options.size)
     end
 
-    begin
-      saver = AbstractSaver.implementation(opthash[:format]).new(opthash)
-    rescue IndexError => e
-      raise ArgumentError, e.message
-    end
+    saver = get_impl(AbstractSaver, opthash[:format], opthash)
 
     if writable.respond_to?(:write)
       saver.save(writable, self)
@@ -259,6 +278,10 @@ class HTTP::CookieJar
   #
   # * `:format`
   #
+  #     Specifies the format for loading.  A saver class, a symbol
+  #     addressing a saver class, or a pre-generated instance of a
+  #     saver class is accepted.
+  #
   #     <dl class="rdoc-list note-list">
   #       <dt>:yaml</dt>
   #       <dd>YAML structure (default)</dd>
@@ -280,20 +303,20 @@ class HTTP::CookieJar
       when Symbol
         opthash[:format] = options
       else
-        opthash.update(options) if options
+        if hash = Hash.try_convert(options)
+          opthash.update(hash)
+        end
       end
     when 2
       opthash[:format], options = options
-      opthash.update(options) if options
+      if hash = Hash.try_convert(options)
+        opthash.update(hash)
+      end
     else
       raise ArgumentError, 'wrong number of arguments (%d for 1-3)' % (1 + options.size)
     end
 
-    begin
-      saver = AbstractSaver.implementation(opthash[:format]).new(opthash)
-    rescue IndexError => e
-      raise ArgumentError, e.message
-    end
+    saver = get_impl(AbstractSaver, opthash[:format], opthash)
 
     if readable.respond_to?(:write)
       saver.load(readable, self)

data/test/test_http_cookie.rb

@@ -692,19 +692,32 @@ class TestHTTPCookie < Test::Unit::TestCase
 
   def test_max_age=
     cookie = HTTP::Cookie.new(cookie_values)
+    expires = cookie.expires
 
     assert_raises(ArgumentError) {
       cookie.max_age = "+1"
     }
+    # make sure #expires is not destroyed
+    assert_equal expires, cookie.expires
+
     assert_raises(ArgumentError) {
       cookie.max_age = "1.5"
     }
+    # make sure #expires is not destroyed
+    assert_equal expires, cookie.expires
+
     assert_raises(ArgumentError) {
       cookie.max_age = "1 day"
     }
+    # make sure #expires is not destroyed
+    assert_equal expires, cookie.expires
+
     assert_raises(TypeError) {
       cookie.max_age = [1]
     }
+    # make sure #expires is not destroyed
+    assert_equal expires, cookie.expires
+
     cookie.max_age = "12"
     assert_equal 12, cookie.max_age
 

data/test/test_http_cookie_jar.rb

@@ -355,14 +355,6 @@ module TestHTTPCookieJar
       assert_equal(0, @jar.cookies(url).length)
     end
 
-    def test_save_nonexistent_saver
-      Dir.mktmpdir { |dir|
-        assert_raises(ArgumentError) {
-          @jar.save(File.join(dir, "file"), :nonexistent)
-        }
-      }
-    end
-
     def test_save_cookies_yaml
       url = URI 'http://rubyforge.org/'
 
@@ -403,12 +395,18 @@ module TestHTTPCookieJar
         @jar.save(filename, :format => :cookiestxt)
         @jar.save(filename, :cookiestxt, :session => true)
         @jar.save(filename, :cookiestxt)
+        @jar.save(filename, HTTP::CookieJar::CookiestxtSaver)
+        @jar.save(filename, HTTP::CookieJar::CookiestxtSaver.new)
         @jar.save(filename, :session => true)
         @jar.save(filename)
+
         assert_raises(ArgumentError) {
           @jar.save()
         }
         assert_raises(ArgumentError) {
+          @jar.save(filename, :nonexistent)
+        }
+        assert_raises(TypeError) {
           @jar.save(filename, { :format => :cookiestxt }, { :session => true })
         }
         assert_raises(ArgumentError) {
@@ -418,6 +416,8 @@ module TestHTTPCookieJar
         @jar.load(filename, :format => :cookiestxt, :linefeed => "\n")
         @jar.load(filename, :format => :cookiestxt, :linefeed => "\n")
         @jar.load(filename, :format => :cookiestxt)
+        @jar.load(filename, HTTP::CookieJar::CookiestxtSaver)
+        @jar.load(filename, HTTP::CookieJar::CookiestxtSaver.new)
         @jar.load(filename, :cookiestxt, :linefeed => "\n")
         @jar.load(filename, :cookiestxt)
         @jar.load(filename, :linefeed => "\n")
@@ -426,6 +426,9 @@ module TestHTTPCookieJar
           @jar.load()
         }
         assert_raises(ArgumentError) {
+          @jar.load(filename, :nonexistent)
+        }
+        assert_raises(TypeError) {
           @jar.load(filename, { :format => :cookiestxt }, { :linefeed => "\n" })
         }
         assert_raises(ArgumentError) {
@@ -850,16 +853,14 @@ module TestHTTPCookieJar
       jar = HTTP::CookieJar.new(:store => :hash)
       assert_instance_of HTTP::CookieJar::HashStore, jar.store
 
-      assert_raises(IndexError) {
+      assert_raises(ArgumentError) {
         jar = HTTP::CookieJar.new(:store => :nonexistent)
       }
 
       jar = HTTP::CookieJar.new(:store => HTTP::CookieJar::HashStore.new)
       assert_instance_of HTTP::CookieJar::HashStore, jar.store
 
-      assert_raises(TypeError) {
-        jar = HTTP::CookieJar.new(:store => HTTP::CookieJar::HashStore)
-      }
+      jar = HTTP::CookieJar.new(:store => HTTP::CookieJar::HashStore)
     end
 
     def test_clone

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http-cookie
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Akinori MUSHA
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-17 00:00:00.000000000 Z
+date: 2013-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: domain_name
@@ -111,7 +111,11 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A Ruby library to handle HTTP Cookies
+description: HTTP::Cookie is a Ruby library to handle HTTP Cookies based on RFC 6265.  It
+  has with security, standards compliance and compatibility in mind, to behave just
+  the same as today's major web browsers.  It has builtin support for the legacy cookies.txt
+  and the latest cookies.sqlite formats of Mozilla Firefox, and its modular API makes
+  it easy to add support for a new backend store.
 email:
 - knu@idaemons.org
 - aaronp@rubyforge.org
@@ -125,6 +129,7 @@ extra_rdoc_files:
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -169,7 +174,7 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: A Ruby library to handle HTTP Cookies
+summary: A Ruby library to handle HTTP Cookies based on RFC 6265
 test_files:
 - test/helper.rb
 - test/mechanize.yml