http-cookie 1.0.3 → 1.1.6

data/lib/http/cookie_jar/mozilla_store.rb

@@ -1,6 +1,5 @@
 # :markup: markdown
-require 'http/cookie_jar'
-require 'sqlite3'
+autoload :SQLite3, 'sqlite3'
 
 class HTTP::CookieJar
   # A store class that uses Mozilla compatible SQLite3 database as
@@ -10,7 +9,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 +21,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
     ]
 
@@ -41,20 +37,15 @@ class HTTP::CookieJar
       }
     }
 
-    class Database < SQLite3::Database
-      def initialize(file, options = {})
+    class Database
+      def initialize(file)
+        @db = SQLite3::Database.new(file, results_as_hash: true)
         @stmts = []
-        options = {
-          :results_as_hash => true,
-        }.update(options)
-        super
       end
 
       def prepare(sql)
-        case st = super
-        when SQLite3::Statement
-          @stmts << st
-        end
+        st = @db.prepare(sql)
+        @stmts << st if st.is_a?(SQLite3::Statement)
         st
       end
 
@@ -63,7 +54,19 @@ class HTTP::CookieJar
         @stmts.reject! { |st|
           st.closed? || st.close
         }
-        super
+        @db.close
+      end
+
+      def closed?
+        @db.closed?
+      end
+
+      def execute(*args, &block)
+        @db.execute(*args, &block)
+      end
+
+      def create_function(*args, &block)
+        @db.create_function(*args, &block)
       end
     end
     # :startdoc:
@@ -95,6 +98,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
@@ -134,7 +142,7 @@ class HTTP::CookieJar
 
     # Returns the schema version of the database.
     def schema_version
-      @schema_version ||= @db.execute("PRAGMA user_version").first[0]
+      @schema_version ||= @db.execute("PRAGMA user_version").first["user_version"]
     rescue SQLite3::SQLException
       @logger.warn "couldn't get schema version!" if @logger
       return nil
@@ -147,8 +155,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 +184,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 +290,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 +300,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 +358,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 +395,34 @@ 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
+      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 +465,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 +482,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 +491,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 +510,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

@@ -1,7 +1,5 @@
 # :markup: markdown
-require 'http/cookie_jar'
-require 'psych' if !defined?(YAML) && RUBY_VERSION == "1.9.2"
-require 'yaml'
+autoload :YAML, 'yaml'
 
 # YAMLSaver saves and loads cookies in the YAML format.  It can load a
 # YAML file saved by Mechanize, but the saving format is not
@@ -21,7 +19,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 +29,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 +71,10 @@ class HTTP::CookieJar::YAMLSaver < HTTP::CookieJar::AbstractSaver
   def default_options
     {}
   end
+
+  def load_yaml(yaml)
+    YAML.safe_load(yaml, :permitted_classes => %w[Time HTTP::Cookie Mechanize::Cookie DomainName], :aliases => true)
+  rescue NoMethodError # ruby < 2.0, no safe_load
+    YAML.load(yaml)
+  end
 end

data/lib/http/cookie_jar.rb

@@ -1,31 +1,14 @@
 # :markup: markdown
-require 'http/cookie'
+
+module HTTP
+  autoload :Cookie, "http/cookie"
+end
 
 ##
 # This class is used to manage the Cookies that have been returned from
 # any particular website.
 
 class HTTP::CookieJar
-  class << self
-    def const_missing(name)
-      case name.to_s
-      when /\A([A-Za-z]+)Store\z/
-        file = 'http/cookie_jar/%s_store' % $1.downcase
-      when /\A([A-Za-z]+)Saver\z/
-        file = 'http/cookie_jar/%s_saver' % $1.downcase
-      end
-      begin
-        require file
-      rescue LoadError
-        raise NameError, 'can\'t resolve constant %s; failed to load %s' % [name, file]
-      end
-      if const_defined?(name)
-        const_get(name)
-      else
-        raise NameError, 'can\'t resolve constant %s after loading %s' % [name, file]
-      end
-    end
-  end
 
   attr_reader :store
 
@@ -156,7 +139,7 @@ class HTTP::CookieJar
     block_given? or return enum_for(__method__, uri)
 
     if uri
-      uri = URI(uri)
+      uri = HTTP::Cookie::URIParser.parse(uri)
       return self unless URI::HTTP === uri && uri.host
     end
 
@@ -342,3 +325,6 @@ class HTTP::CookieJar
     self
   end
 end
+
+require 'http/cookie_jar/abstract_store'
+require 'http/cookie_jar/abstract_saver'

data/lib/http-cookie.rb

@@ -1 +1,4 @@
-require 'http/cookie'
+module HTTP
+  autoload :Cookie, 'http/cookie'
+  autoload :CookieJar, 'http/cookie_jar'
+end

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: http-cookie
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.6
 platform: ruby
 authors:
 - Akinori MUSHA
 - Aaron Patterson
 - Eric Hodel
 - Mike Dalessio
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: domain_name
@@ -31,16 +30,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -124,21 +123,17 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE.txt
+- README.md
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- http-cookie.gemspec
 - lib/http-cookie.rb
 - lib/http/cookie.rb
 - lib/http/cookie/ruby_compat.rb
 - lib/http/cookie/scanner.rb
+- lib/http/cookie/uri_parser.rb
 - lib/http/cookie/version.rb
 - lib/http/cookie_jar.rb
 - lib/http/cookie_jar/abstract_saver.rb
@@ -147,16 +142,10 @@ files:
 - lib/http/cookie_jar/hash_store.rb
 - lib/http/cookie_jar/mozilla_store.rb
 - lib/http/cookie_jar/yaml_saver.rb
-- test/helper.rb
-- test/mechanize.yml
-- test/simplecov_start.rb
-- test/test_http_cookie.rb
-- test/test_http_cookie_jar.rb
 homepage: https://github.com/sparklemotion/http-cookie
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -171,14 +160,7 @@ 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: 4.0.6
 specification_version: 4
 summary: A Ruby library to handle HTTP Cookies based on RFC 6265
-test_files:
-- test/helper.rb
-- test/mechanize.yml
-- test/simplecov_start.rb
-- test/test_http_cookie.rb
-- test/test_http_cookie_jar.rb
+test_files: []

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.travis.yml

@@ -1,21 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 1.8.7
-  - ree
-  - 1.9.3
-  - 2.0.0
-  - 2.1
-  - 2.2
-  - 2.3.0
-  - ruby-head
-  - jruby-1.7
-  - jruby-9
-  - rbx-2
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: rbx-2
-before_install:
-  - gem update bundler

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in http-cookie.gemspec
-gemspec

data/Rakefile

@@ -1,20 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |test|
-  test.ruby_opts << '-r./test/simplecov_start.rb' if RUBY_VERSION >= '1.9'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = HTTP::Cookie::VERSION
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "http-cookie #{version}"
-  rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc.rdoc_files.include(Bundler::GemHelper.gemspec.extra_rdoc_files)
-end

data/http-cookie.gemspec

@@ -1,34 +0,0 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'http/cookie/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = "http-cookie"
-  gem.version       = HTTP::Cookie::VERSION
-  gem.authors, gem.email = {
-    'Akinori MUSHA'   => 'knu@idaemons.org',
-    'Aaron Patterson' => 'aaronp@rubyforge.org',
-    'Eric Hodel'      => 'drbrain@segment7.net',
-    'Mike Dalessio'   => 'mike.dalessio@gmail.com',
-  }.instance_eval { [keys, values] }
-
-  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.license       = "MIT"
-
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-  gem.extra_rdoc_files = ['README.md', 'LICENSE.txt']
-
-  gem.add_runtime_dependency("domain_name", ["~> 0.5"])
-  gem.add_development_dependency("sqlite3", ["~> 1.3.3"]) unless defined?(JRUBY_VERSION)
-  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("simplecov", [">= 0"])
-end

data/test/helper.rb

@@ -1,55 +0,0 @@
-require 'rubygems'
-require 'test-unit'
-require 'uri'
-require 'http/cookie'
-
-module Test
-  module Unit
-    module Assertions
-      def assert_warn(pattern, message = nil, &block)
-        class << (output = "")
-          alias write <<
-        end
-        stderr, $stderr = $stderr, output
-        yield
-        assert_match(pattern, output, message)
-      ensure
-        $stderr = stderr
-      end
-
-      def assert_warning(pattern, message = nil, &block)
-        verbose, $VERBOSE = $VERBOSE, true
-        assert_warn(pattern, message, &block)
-      ensure
-        $VERBOSE = verbose
-      end
-    end
-  end
-end
-
-module Enumerable
-  def combine
-    masks = inject([[], 1]){|(ar, m), e| [ar << m, m << 1 ] }[0]
-    all = masks.inject(0){ |al, m| al|m }
-
-    result = []
-    for i in 1..all do
-      tmp = []
-      each_with_index do |e, idx|
-        tmp << e unless (masks[idx] & i) == 0
-      end
-      result << tmp
-    end
-    result
-  end
-end
-
-def test_file(filename)
-  File.expand_path(filename, File.dirname(__FILE__))
-end
-
-def sleep_until(time)
-  if (s = time - Time.now) > 0
-    sleep s
-  end
-end