http-cookie 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d1a93009a55673a4827d9f8d85c19b5c08f4b19c
-  data.tar.gz: a7f4a3bb7a58ded55e6edac658cb20e0ad5d0821
+SHA256:
+  metadata.gz: 6e3fc7cc6e374fa6bdd53c2a32cae8b8856615df4aad76fe496ab6375738652e
+  data.tar.gz: 0132bb41158fa3bf84a0adf2fcf7226115a1126efbc12c879f465a8c2114215b
 SHA512:
-  metadata.gz: d46e2e2d42e8a5e7947ccb2b0eb187b930e1e1dcb5912b75ffd78aca7532af0b9144d0210b7ca46ec3c4d591cfd8c742b64e393c60fda814d7ce75ae2aaada26
-  data.tar.gz: 5debdf55ddc8886db1e4e117e13829f6f93e2f08364126c0c693ed4dfde469374c49a35bef3f5b18455ab5379bf1289b386f30ebbae25603b4c5725beb2c231e
+  metadata.gz: 341c0b9947ed005f8c73030ad7b5380aa19d76cbfc2f3f09ac69207a9a5b33e62f0094f6b68b98ad839f110c565f7afc08a9ff504c82affe736a8bcb55908e05
+  data.tar.gz: c4346ce6bae86a394c72b38f079c3c272205df3b7453c630e1dc3fc1ae7dec7ee0f652c9b5f2b12151fb6b7b402a5fbc41b832c051cf17102bd1cd584f72b461

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## Unreleased
+
+- Support Mozilla's cookie storage format up to version 7.
+
+- Fix the time representation with creationTime and lastAccessed in
+  MozillaStore. (#8)
+
 ## 1.0.3 (2016-09-30)
 
 - Treat comma as normal character in HTTP::Cookie.cookie_value_to_hash

data/http-cookie.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency("bundler", [">= 1.2.0"])
   gem.add_development_dependency("test-unit", [">= 2.4.3", *("< 3" if RUBY_VERSION < "1.9")])
   gem.add_development_dependency("rake", [">= 0.9.2.2", *("< 11" if RUBY_VERSION < "1.9")])
-  gem.add_development_dependency("rdoc", ["> 2.4.2"])
+  gem.add_development_dependency("rdoc", RUBY_VERSION > "1.9" ? "> 2.4.2" : "~> 2.4.2")
   gem.add_development_dependency("simplecov", [">= 0"])
+  gem.add_development_dependency("json", ["< 2"]) if RUBY_VERSION < "2.0"
 end

data/lib/http/cookie.rb

@@ -128,7 +128,7 @@ class HTTP::Cookie
   #     new("name" => "uid", "value" => "a12345", "Domain" => 'www.example.org')
   #
   def initialize(*args)
-    @origin = @domain = @path =
+    @name = @origin = @domain = @path =
       @expires = @max_age = nil
     @for_domain = @secure = @httponly = false
     @session = true

data/lib/http/cookie/version.rb

@@ -1,5 +1,5 @@
 module HTTP
   class Cookie
-    VERSION = "1.0.3"
+    VERSION = "1.0.4"
   end
 end

data/lib/http/cookie_jar/abstract_store.rb

@@ -17,8 +17,8 @@ class HTTP::CookieJar::AbstractStore
       begin
         require 'http/cookie_jar/%s_store' % symbol
         @@class_map.fetch(symbol)
-      rescue LoadError, IndexError
-        raise IndexError, 'cookie store unavailable: %s' % symbol.inspect
+      rescue LoadError, IndexError => e
+        raise IndexError, 'cookie store unavailable: %s, error: %s' % symbol.inspect, e.message
       end
     end
 

data/lib/http/cookie_jar/hash_store.rb

@@ -67,10 +67,8 @@ class HTTP::CookieJar
     def each(uri = nil) # :yield: cookie
       now = Time.now
       if uri
-        thost = DomainName.new(uri.host)
         tpath = uri.path
         @jar.each { |domain, paths|
-          next unless thost.cookie_domain?(domain)
           paths.each { |path, hash|
             next unless HTTP::Cookie.path_match?(path, tpath)
             hash.delete_if { |name, cookie|

data/lib/http/cookie_jar/mozilla_store.rb

@@ -10,7 +10,7 @@ class HTTP::CookieJar
   # stored persistently in the SQLite3 database.
   class MozillaStore < AbstractStore
     # :stopdoc:
-    SCHEMA_VERSION = 5
+    SCHEMA_VERSION = 7
 
     def default_options
       {
@@ -22,14 +22,11 @@ class HTTP::CookieJar
 
     ALL_COLUMNS = %w[
       baseDomain
-      appId inBrowserElement
+      originAttributes
       name value
       host path
       expiry creationTime lastAccessed
       isSecure isHttpOnly
-    ]
-    UK_COLUMNS = %w[
-      name host path
       appId inBrowserElement
     ]
 
@@ -95,6 +92,11 @@ class HTTP::CookieJar
     def initialize(options = nil)
       super
 
+      @origin_attributes = encode_www_form({}.tap { |params|
+        params['appId'] = @app_id if @app_id.nonzero?
+        params['inBrowserElement'] = 1 if @in_browser_element
+      })
+
       @filename = options[:filename] or raise ArgumentError, ':filename option is missing'
 
       @sjar = HTTP::CookieJar::HashStore.new
@@ -147,8 +149,8 @@ class HTTP::CookieJar
       @schema_version = version
     end
 
-    def create_table
-      self.schema_version = SCHEMA_VERSION
+    def create_table_v5
+      self.schema_version = 5
       @db.execute("DROP TABLE IF EXISTS moz_cookies")
       @db.execute(<<-'SQL')
                    CREATE TABLE moz_cookies (
@@ -176,6 +178,62 @@ class HTTP::CookieJar
       SQL
     end
 
+    def create_table_v6
+      self.schema_version = 6
+      @db.execute("DROP TABLE IF EXISTS moz_cookies")
+      @db.execute(<<-'SQL')
+                   CREATE TABLE moz_cookies (
+                     id INTEGER PRIMARY KEY,
+                     baseDomain TEXT,
+                     originAttributes TEXT NOT NULL DEFAULT '',
+                     name TEXT,
+                     value TEXT,
+                     host TEXT,
+                     path TEXT,
+                     expiry INTEGER,
+                     lastAccessed INTEGER,
+                     creationTime INTEGER,
+                     isSecure INTEGER,
+                     isHttpOnly INTEGER,
+                     CONSTRAINT moz_uniqueid UNIQUE (name, host, path, originAttributes)
+                   )
+      SQL
+      @db.execute(<<-'SQL')
+                   CREATE INDEX moz_basedomain
+                     ON moz_cookies (baseDomain,
+                                     originAttributes);
+      SQL
+    end
+
+    def create_table
+      self.schema_version = SCHEMA_VERSION
+      @db.execute("DROP TABLE IF EXISTS moz_cookies")
+      @db.execute(<<-'SQL')
+                   CREATE TABLE moz_cookies (
+                     id INTEGER PRIMARY KEY,
+                     baseDomain TEXT,
+                     originAttributes TEXT NOT NULL DEFAULT '',
+                     name TEXT,
+                     value TEXT,
+                     host TEXT,
+                     path TEXT,
+                     expiry INTEGER,
+                     lastAccessed INTEGER,
+                     creationTime INTEGER,
+                     isSecure INTEGER,
+                     isHttpOnly INTEGER,
+                     appId INTEGER DEFAULT 0,
+                     inBrowserElement INTEGER DEFAULT 0,
+                     CONSTRAINT moz_uniqueid UNIQUE (name, host, path, originAttributes)
+                   )
+      SQL
+      @db.execute(<<-'SQL')
+                   CREATE INDEX moz_basedomain
+                     ON moz_cookies (baseDomain,
+                                     originAttributes);
+      SQL
+    end
+
     def db_prepare(sql)
       st = @db.prepare(sql)
       yield st
@@ -226,7 +284,7 @@ class HTTP::CookieJar
         when 4
           @db.execute("ALTER TABLE moz_cookies RENAME TO moz_cookies_old")
           @db.execute("DROP INDEX moz_basedomain")
-          create_table
+          create_table_v5
           @db.execute(<<-'SQL')
                        INSERT INTO moz_cookies
                          (baseDomain, appId, inBrowserElement, name, value, host, path, expiry,
@@ -236,7 +294,42 @@ class HTTP::CookieJar
                            FROM moz_cookies_old
           SQL
           @db.execute("DROP TABLE moz_cookies_old")
+        when 5
+          @db.execute("ALTER TABLE moz_cookies RENAME TO moz_cookies_old")
+          @db.execute("DROP INDEX moz_basedomain")
+          create_table_v6
+          @db.create_function('CONVERT_TO_ORIGIN_ATTRIBUTES', 2) { |func, appId, inBrowserElement|
+            params = {}
+            params['appId'] = appId if appId.nonzero?
+            params['inBrowserElement'] = inBrowserElement if inBrowserElement.nonzero?
+            func.result = encode_www_form(params)
+          }
+          @db.execute(<<-'SQL')
+                       INSERT INTO moz_cookies
+                         (baseDomain, originAttributes, name, value, host, path, expiry,
+                          lastAccessed, creationTime, isSecure, isHttpOnly)
+                         SELECT baseDomain,
+                                CONVERT_TO_ORIGIN_ATTRIBUTES(appId, inBrowserElement),
+                                name, value, host, path, expiry, lastAccessed, creationTime,
+                                isSecure, isHttpOnly
+                           FROM moz_cookies_old
+          SQL
+          @db.execute("DROP TABLE moz_cookies_old")
+        when 6
+          @db.execute("ALTER TABLE moz_cookies ADD appId INTEGER DEFAULT 0")
+          @db.execute("ALTER TABLE moz_cookies ADD inBrowserElement INTEGER DEFAULT 0")
+          @db.create_function('SET_APP_ID', 1) { |func, originAttributes|
+            func.result = get_query_param(originAttributes, 'appId').to_i  # nil.to_i == 0
+          }
+          @db.create_function('SET_IN_BROWSER', 1) { |func, originAttributes|
+            func.result = get_query_param(originAttributes, 'inBrowserElement').to_i  # nil.to_i == 0
+          }
+          @db.execute(<<-'SQL')
+                       UPDATE moz_cookies SET appId = SET_APP_ID(originAttributes),
+                                              inBrowserElement = SET_IN_BROWSER(originAttributes)
+          SQL
           @logger.info("Upgraded database to schema version %d" % schema_version) if @logger
+          self.schema_version += 1
         else
           break
         end
@@ -259,16 +352,17 @@ class HTTP::CookieJar
     def db_add(cookie)
       @stmt[:add].execute({
           :baseDomain => cookie.domain_name.domain || cookie.domain,
-          :appId => @app_id,
-          :inBrowserElement => @in_browser_element ? 1 : 0,
+          :originAttributes => @origin_attributes,
           :name => cookie.name, :value => cookie.value,
           :host => cookie.dot_domain,
           :path => cookie.path,
           :expiry => cookie.expires_at.to_i,
-          :creationTime => cookie.created_at.to_i,
-          :lastAccessed => cookie.accessed_at.to_i,
+          :creationTime => serialize_usectime(cookie.created_at),
+          :lastAccessed => serialize_usectime(cookie.accessed_at),
           :isSecure => cookie.secure? ? 1 : 0,
           :isHttpOnly => cookie.httponly? ? 1 : 0,
+          :appId => @app_id,
+          :inBrowserElement => @in_browser_element ? 1 : 0,
         })
       cleanup if (@gc_index += 1) >= @gc_threshold
 
@@ -295,6 +389,36 @@ class HTTP::CookieJar
       self
     end
 
+    if RUBY_VERSION >= '1.9'
+      def encode_www_form(enum)
+        URI.encode_www_form(enum)
+      end
+
+      def get_query_param(str, key)
+        URI.decode_www_form(str).find { |k, v|
+          break v if k == key
+        }
+      end
+    else
+      require 'cgi'
+
+      def encode_www_form(enum)
+        enum.map { |k, v| "#{CGI.escape(k)}=#{CGI.escape(v)}" }.join('&')
+      end
+
+      def get_query_param(str, key)
+        CGI.parse(str)[key].first
+      end
+    end
+
+    def serialize_usectime(time)
+      time ? (time.to_f * 1e6).floor : 0
+    end
+
+    def deserialize_usectime(value)
+      Time.at(value ? value / 1e6 : 0)
+    end
+
     public
 
     def add(cookie)
@@ -337,7 +461,6 @@ class HTTP::CookieJar
       now = Time.now
       if uri
         thost = DomainName.new(uri.host)
-        tpath = uri.path
 
         @stmt[:cookies_for_domain].execute({
             :baseDomain => thost.domain || thost.hostname,
@@ -355,8 +478,8 @@ class HTTP::CookieJar
               attrs[:domain]      = row['host']
               attrs[:path]        = row['path']
               attrs[:expires_at]  = Time.at(row['expiry'])
-              attrs[:accessed_at] = Time.at(row['lastAccessed'] || 0)
-              attrs[:created_at]  = Time.at(row['creationTime'] || 0)
+              attrs[:accessed_at] = deserialize_usectime(row['lastAccessed'])
+              attrs[:created_at]  = deserialize_usectime(row['creationTime'])
               attrs[:secure]      = secure
               attrs[:httponly]    = row['isHttpOnly'] != 0
             })
@@ -364,7 +487,7 @@ class HTTP::CookieJar
           if cookie.valid_for_uri?(uri)
             cookie.accessed_at = now
             @stmt[:update_lastaccessed].execute({
-                'lastAccessed' => now.to_i,
+                'lastAccessed' => serialize_usectime(now),
                 'id' => row['id'],
               })
             yield cookie
@@ -383,8 +506,8 @@ class HTTP::CookieJar
               attrs[:domain]      = row['host']
               attrs[:path]        = row['path']
               attrs[:expires_at]  = Time.at(row['expiry'])
-              attrs[:accessed_at] = Time.at(row['lastAccessed'] || 0)
-              attrs[:created_at]  = Time.at(row['creationTime'] || 0)
+              attrs[:accessed_at] = deserialize_usectime(row['lastAccessed'])
+              attrs[:created_at]  = deserialize_usectime(row['creationTime'])
               attrs[:secure]      = row['isSecure'] != 0
               attrs[:httponly]    = row['isHttpOnly'] != 0
             })

data/lib/http/cookie_jar/yaml_saver.rb

@@ -21,7 +21,7 @@ class HTTP::CookieJar::YAMLSaver < HTTP::CookieJar::AbstractSaver
 
   def load(io, jar)
     begin
-      data = YAML.load(io)
+      data = load_yaml(io)
     rescue ArgumentError => e
       case e.message
       when %r{\Aundefined class/module Mechanize::}
@@ -31,7 +31,7 @@ class HTTP::CookieJar::YAMLSaver < HTTP::CookieJar::AbstractSaver
           yaml = io.read
           # a gross hack
           yaml.gsub!(%r{^(    [^ ].*:) !ruby/object:Mechanize::Cookie$}, "\\1")
-          data = YAML.load(yaml)
+          data = load_yaml(yaml)
         rescue Errno::ESPIPE
           @logger.warn "could not rewind the stream for conversion" if @logger
         rescue ArgumentError
@@ -73,4 +73,14 @@ class HTTP::CookieJar::YAMLSaver < HTTP::CookieJar::AbstractSaver
   def default_options
     {}
   end
+
+  if YAML.name == 'Psych' && Psych::VERSION >= '3.1'
+    def load_yaml(yaml)
+      YAML.safe_load(yaml, :permitted_classes => %w[Time HTTP::Cookie Mechanize::Cookie DomainName], :aliases => true)
+    end
+  else
+    def load_yaml(yaml)
+      YAML.load(yaml)
+    end
+  end
 end

data/test/test_http_cookie_jar.rb

@@ -20,11 +20,7 @@ module TestHTTPCookieJar
         assert_raises(NameError) {
           HTTP::CookieJar::ErroneousStore
         }
-        if RUBY_VERSION >= "1.9"
-          assert_includes $LOADED_FEATURES, rb
-        else
-          assert_includes $LOADED_FEATURES, rb[(dir.size + 1)..-1]
-        end
+        assert($LOADED_FEATURES.any? { |file| FileTest.identical?(file, rb) })
       }
     end
 
@@ -45,11 +41,7 @@ module TestHTTPCookieJar
         assert_raises(NameError) {
           HTTP::CookieJar::ErroneousSaver
         }
-        if RUBY_VERSION >= "1.9"
-          assert_includes $LOADED_FEATURES, rb
-        else
-          assert_includes $LOADED_FEATURES, rb[(dir.size + 1)..-1]
-        end
+        assert($LOADED_FEATURES.any? { |file| FileTest.identical?(file, rb) })
       }
     end
   end
@@ -139,6 +131,17 @@ module TestHTTPCookieJar
       assert_equal(0, @jar.cookies(URI('http://www.rubyforge.org/')).length)
     end
 
+    def test_host_only_with_unqualified_hostname
+      @jar.add(HTTP::Cookie.new(cookie_values(
+        :origin => 'http://localhost/', :domain => 'localhost', :for_domain => false)))
+
+      assert_equal(1, @jar.cookies(URI('http://localhost/')).length)
+
+      assert_equal(1, @jar.cookies(URI('http://Localhost/')).length)
+
+      assert_equal(1, @jar.cookies(URI('https://Localhost/')).length)
+    end
+
     def test_empty_value
       url = URI 'http://rubyforge.org/'
       values = cookie_values(:value => "")

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: http-cookie
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Akinori MUSHA
 - Aaron Patterson
 - Eric Hodel
 - Mike Dalessio
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: domain_name
@@ -156,7 +156,7 @@ homepage: https://github.com/sparklemotion/http-cookie
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -171,9 +171,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.6
-signing_key: 
+rubygems_version: 3.2.11
+signing_key:
 specification_version: 4
 summary: A Ruby library to handle HTTP Cookies based on RFC 6265
 test_files: