http-cookie 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5230b0bd44e032652855e7b9e60e3d994ca56adbd57550c7520930d4dbf734a4
-  data.tar.gz: 65240197f49ac57bac8c6f3d1104cfe4f8fff77e1ac992c05c72d74efbba8300
+  metadata.gz: d8164cb03f90d107b135379101cbc38ca71bfb1b850410007d739c38c3097036
+  data.tar.gz: 1171fba029df999fd8c27a1ddb42626840510cf1b9521f5d48282f0578f8c94f
 SHA512:
-  metadata.gz: 7fc5bb2e287d60d060c54eb9fb9ccb6d55c55e84ec35525deff8c088c873d6ac26db86f7f1cf3c03a7cbf05e397b6cd0e3a1e1171c2dcff8848e0345a34b0905
-  data.tar.gz: 1c85e07a65fac1d5440126bea27dbc01160edc9a791f56e021cd3142070eada54bf1ec3cda31c9d9273f23c3a84c8786c308bcdd27e03f7266c203dde4abdd6f
+  metadata.gz: b41e686acc80a67ceb08ef01ce608de1cf67790364f1dba9255ff595b30dcd361316d50d5dcca03c1f3d0d2c506c507fa707fdd1cfe4963076b7bdef0551a2f7
+  data.tar.gz: d88dc3ccf9dad9bf2ee56b27ad137e87c9ff19e29d2ef28814c6eb06038e3db8cb93fa6be17a7cc8cbfc00ad70f086409ab41d7a1ff52fdacffbedee39302013

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## 1.1.0 (2025-09-26)
+
+- Implement `Cookie#to_h`. (#55) @luke-hill @flavorjones
+- Reduce gem size by excluding test files (#54) @yuri-zubov
+
+
+## 1.0.8 (2024-12-05)
+
+- `Cookie#expires=` accepts `DateTime` objects. (#52) @luke-hill @flavorjones
+
+
+## 1.0.7 (2024-06-06)
+
+- Explicitly require "cgi" to avoid `NameError` in some applications. (#50 by @flavorjones)
+
+
+## 1.0.6 (2024-06-01)
+
+- Fix error formatting bug in HTTP::CookieJar::AbstractStore (#42 by @andrelaszlo)
+- Allow non-RFC 3986-compliant URLs (#45 by @c960657)
+- Add coverage for Ruby 3.2 and 3.3 (#46 by @flavorjones)
+- Quash ruby 3.4 warnings (#47 by @flavorjones)
+
 ## 1.0.5 (2022-05-25)
 
 - Silence SQLite3 warnings

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/http-cookie.svg)](https://badge.fury.io/rb/http-cookie)
+
 # HTTP::Cookie
 
 HTTP::Cookie is a ruby library to handle HTTP cookies in a way both
@@ -20,7 +22,8 @@ The following is an incomplete list of its features:
 * 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.
+  brought to you by the
+  [domain_name](https://github.com/knu/ruby-domain_name) gem.
 
 * The number of cookies and the size are properly capped so that a
   cookie store does not get flooded.
@@ -207,7 +210,7 @@ equivalent using HTTP::Cookie:
     guarantee that it will remain available in the future.
 
 
-HTTP::Cookie/CookieJar raise runtime errors to help migration, so
+HTTP::Cookie/CookieJar raises 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.
 

data/lib/http/cookie/scanner.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'http/cookie'
 require 'strscan'
 require 'time'
@@ -23,7 +24,7 @@ class HTTP::Cookie::Scanner < StringScanner
   class << self
     def quote(s)
       return s unless s.match(RE_BAD_CHAR)
-      '"' << s.gsub(/([\\"])/, "\\\\\\1") << '"'
+      (+'"') << s.gsub(/([\\"])/, "\\\\\\1") << '"'
     end
   end
 
@@ -32,7 +33,7 @@ class HTTP::Cookie::Scanner < StringScanner
   end
 
   def scan_dquoted
-    ''.tap { |s|
+    (+'').tap { |s|
       case
       when skip(/"/)
         break
@@ -51,7 +52,7 @@ class HTTP::Cookie::Scanner < StringScanner
   end
 
   def scan_value(comma_as_separator = false)
-    ''.tap { |s|
+    (+'').tap { |s|
       case
       when scan(/[^,;"]+/)
         s << matched

data/lib/http/cookie/uri_parser.rb

@@ -0,0 +1,36 @@
+module HTTP::Cookie::URIParser
+  module_function
+
+  # Regular Expression taken from RFC 3986 Appendix B
+  URIREGEX = %r{
+    \A
+    (?: (?<scheme> [^:/?\#]+ ) : )?
+    (?: // (?<authority> [^/?\#]* ) )?
+    (?<path> [^?\#]* )
+    (?: \? (?<query> [^\#]* ) )?
+    (?: \# (?<fragment> .* ) )?
+    \z
+  }x
+
+  # Escape RFC 3986 "reserved" characters minus valid characters for path
+  # More specifically, gen-delims minus "/" / "?" / "#"
+  def escape_path(path)
+    path.sub(/\A[^?#]+/) { |p| p.gsub(/[:\[\]@]+/) { |r| CGI.escape(r) } }
+  end
+
+  # Parse a URI string or object, relaxing the constraints on the path component
+  def parse(uri)
+    URI(uri)
+  rescue URI::InvalidURIError
+    str = String.try_convert(uri) or
+      raise ArgumentError, "bad argument (expected URI object or URI string)"
+
+    m = URIREGEX.match(str) or raise
+
+    path = m[:path]
+    str[m.begin(:path)...m.end(:path)] = escape_path(path)
+    uri = URI.parse(str)
+    uri.__send__(:set_path, path)
+    uri
+  end
+end

data/lib/http/cookie/version.rb

@@ -1,5 +1,5 @@
 module HTTP
   class Cookie
-    VERSION = "1.0.5"
+    VERSION = "1.1.0"
   end
 end

data/lib/http/cookie.rb

@@ -1,9 +1,12 @@
 # :markup: markdown
+# frozen_string_literal: true
 require 'http/cookie/version'
+require 'http/cookie/uri_parser'
 require 'time'
 require 'uri'
 require 'domain_name'
 require 'http/cookie/ruby_compat'
+require 'cgi'
 
 module HTTP
   autoload :CookieJar, 'http/cookie_jar'
@@ -86,7 +89,7 @@ class HTTP::Cookie
 
   # The Expires attribute value as a Time object.
   #
-  # The setter method accepts a Time object, a string representation
+  # The setter method accepts a Time / DateTime object, a string representation
   # of date/time that Time.parse can understand, or `nil`.
   #
   # Setting this value resets #max_age to nil.  When #max_age is
@@ -275,7 +278,7 @@ class HTTP::Cookie
         logger = options[:logger]
         created_at = options[:created_at]
       end
-      origin = URI(origin)
+      origin = HTTP::Cookie::URIParser.parse(origin)
 
       [].tap { |cookies|
         Scanner.new(set_cookie, logger).scan_set_cookie { |name, value, attrs|
@@ -424,7 +427,7 @@ class HTTP::Cookie
   # Returns the domain, with a dot prefixed only if the domain flag is
   # on.
   def dot_domain
-    @for_domain ? '.' << @domain : @domain
+    @for_domain ? (+'.') << @domain : @domain
   end
 
   # Returns the domain attribute value as a DomainName object.
@@ -455,7 +458,7 @@ class HTTP::Cookie
     @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)
+    origin = HTTP::Cookie::URIParser.parse(origin)
     if URI::HTTP === origin
       self.domain ||= origin.host
       self.path   ||= (origin + './').path
@@ -490,6 +493,8 @@ class HTTP::Cookie
   def expires= t
     case t
     when nil, Time
+    when DateTime
+      t = t.to_time
     else
       t = Time.parse(t)
     end
@@ -548,7 +553,7 @@ class HTTP::Cookie
   # Tests if it is OK to accept this cookie if it is sent from a given
   # URI/URL, `uri`.
   def acceptable_from_uri?(uri)
-    uri = URI(uri)
+    uri = HTTP::Cookie::URIParser.parse(uri)
     return false unless URI::HTTP === uri && uri.host
     host = DomainName.new(uri.host)
 
@@ -585,7 +590,7 @@ class HTTP::Cookie
     if @domain.nil?
       raise "cannot tell if this cookie is valid because the domain is unknown"
     end
-    uri = URI(uri)
+    uri = HTTP::Cookie::URIParser.parse(uri)
     # RFC 6265 5.4
     return false if secure? && !(URI::HTTPS === uri)
     acceptable_from_uri?(uri) && HTTP::Cookie.path_match?(@path, uri.path)
@@ -594,7 +599,7 @@ class HTTP::Cookie
   # Returns a string for use in the Cookie header, i.e. `name=value`
   # or `name="value"`.
   def cookie_value
-    "#{@name}=#{Scanner.quote(@value)}"
+    +"#{@name}=#{Scanner.quote(@value)}"
   end
   alias to_s cookie_value
 
@@ -650,6 +655,11 @@ class HTTP::Cookie
   end
   include Comparable
 
+  # Hash serialization helper for use back into other libraries (Like Selenium)
+  def to_h
+    PERSISTENT_PROPERTIES.each_with_object({}) { |property, hash| hash[property.to_sym] = instance_variable_get("@#{property}") }
+  end
+
   # YAML serialization helper for Syck.
   def to_yaml_properties
     PERSISTENT_PROPERTIES.map { |name| "@#{name}" }

data/lib/http/cookie_jar/abstract_store.rb

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

data/lib/http/cookie_jar/mozilla_store.rb

@@ -400,8 +400,6 @@ class HTTP::CookieJar
         }
       end
     else
-      require 'cgi'
-
       def encode_www_form(enum)
         enum.map { |k, v| "#{CGI.escape(k)}=#{CGI.escape(v)}" }.join('&')
       end

data/lib/http/cookie_jar.rb

@@ -156,7 +156,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
 

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: http-cookie
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Akinori MUSHA
 - Aaron Patterson
 - Eric Hodel
 - Mike Dalessio
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: domain_name
@@ -124,21 +123,17 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE.txt
+- README.md
 files:
-- ".github/workflows/ci.yml"
-- ".gitignore"
 - 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,13 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
-signing_key:
+rubygems_version: 3.6.9
 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/.github/workflows/ci.yml

@@ -1,37 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - "*"
-
-jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu]
-        # We still kind of support Ruby 1.8.7
-        ruby: [2.7, "3.0", 3.1, head, jruby]
-
-    name: >-
-      ${{matrix.os}}:ruby-${{matrix.ruby}}
-    runs-on: ${{matrix.os}}-latest
-    continue-on-error: ${{matrix.ruby == 'head' || matrix.ruby == 'jruby'}}
-
-    steps:
-      - name: Check out
-        uses: actions/checkout@v2
-
-      - name: Set up ruby and bundle
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{matrix.ruby}}
-          bundler-cache: true
-
-      - name: Run rake
-        run: |
-          bundle exec rake

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/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,35 +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"]) 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", 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/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

data/test/mechanize.yml

@@ -1,101 +0,0 @@
----
-google.com:
-  /:
-    PREF: !ruby/object:Mechanize::Cookie
-      version: 0
-      port: 
-      discard: 
-      comment_url: 
-      expires: Tue, 24 Mar 2065 08:20:15 GMT
-      max_age: 
-      comment: 
-      secure: false
-      path: /
-      domain: google.com
-      accessed_at: 2013-03-24 17:20:15.822619000 +09:00
-      created_at: 2013-03-24 17:20:15.822619000 +09:00
-      name: PREF
-      value: ID=7571a59c059e09db:FF=0:TM=1364199615:LM=1364199615:S=BxUqnqPrchd2cVmC
-      for_domain: true
-      domain_name: !ruby/object:DomainName
-        ipaddr: 
-        hostname: google.com
-        uri_host: google.com
-        tld: com
-        canonical_tld_p: true
-        domain: google.com
-      session: false
-    NID: !ruby/object:Mechanize::Cookie
-      version: 0
-      port: 
-      discard: 
-      comment_url: 
-      expires: Sun, 23 Sep 2063 08:20:15 GMT
-      max_age: 
-      comment: 
-      secure: false
-      path: /
-      domain: google.com
-      accessed_at: 2013-03-24 17:20:15.828434000 +09:00
-      created_at: 2013-03-24 17:20:15.828434000 +09:00
-      name: NID
-      value: 67=Kn2osS6wOzILpl7sCM1QIDmGg2VESBiwCyt6zx4vOVSWKOYDlwGIpgIGrpD8FpkbS9eqizo3QWFa5YkOygnCF6vRIQpbvlTxWB2Hq1Oo-qXWy0317yCqQ-B25eJLfUcC
-      for_domain: true
-      domain_name: !ruby/object:DomainName
-        ipaddr: 
-        hostname: google.com
-        uri_host: google.com
-        tld: com
-        canonical_tld_p: true
-        domain: google.com
-      session: false
-google.co.jp:
-  /:
-    PREF: !ruby/object:Mechanize::Cookie
-      version: 0
-      port: 
-      discard: 
-      comment_url: 
-      expires: Tue, 24 Mar 2065 08:20:16 GMT
-      max_age: 
-      comment: 
-      secure: false
-      path: /
-      domain: google.co.jp
-      accessed_at: 2013-03-24 17:20:17.136581000 +09:00
-      created_at: 2013-03-24 17:20:17.136581000 +09:00
-      name: PREF
-      value: ID=cb25dd1567d8b5c8:FF=0:TM=1364199616:LM=1364199616:S=c3PbhRq79Wo5T_vV
-      for_domain: true
-      domain_name: !ruby/object:DomainName
-        ipaddr: 
-        hostname: google.co.jp
-        uri_host: google.co.jp
-        tld: jp
-        canonical_tld_p: true
-        domain: google.co.jp
-      session: false
-    NID: !ruby/object:Mechanize::Cookie
-      version: 0
-      port: 
-      discard: 
-      comment_url: 
-      expires: Sun, 23 Sep 2063 08:20:16 GMT
-      max_age: 
-      comment: 
-      secure: false
-      path: /
-      domain: google.co.jp
-      accessed_at: 2013-03-24 17:20:17.139782000 +09:00
-      created_at: 2013-03-24 17:20:17.139782000 +09:00
-      name: NID
-      value: 67=GS7P-68zgm_KRA0e0dpN_XbYpmw9uBDe56qUeoCGiSRTahsM7dtOBCKfCoIFRKlzSuOiwJQdIZNpwv3DSXQNHXDKltucgfv2qkHlGeoj8-5VlowPXLLesz2VIpLOLw-a
-      for_domain: true
-      domain_name: !ruby/object:DomainName
-        ipaddr: 
-        hostname: google.co.jp
-        uri_host: google.co.jp
-        tld: jp
-        canonical_tld_p: true
-        domain: google.co.jp
-      session: false

data/test/simplecov_start.rb

@@ -1,2 +0,0 @@
-require 'simplecov'
-SimpleCov.start