cookiejar2 0.3.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 78294737766796f222dc8f4d2e8b09d1e167512af6ac9a167349eb06b7839e5e
+  data.tar.gz: dd98ce246d2636b1af72c14ec7fadff3521db5a14dbd074addd82159e17c2274
+SHA512:
+  metadata.gz: fd3c960bc06f9887b7b9665ca59305f84d7df30332d3f330101965b222039a13fad665fc6225d885461f3fb23626fa29cccc43e8e79e100d5977407d9dc68b3a
+  data.tar.gz: 000d194f9e949451299b7c75d0c5816d2a6a9a4eb99996e65b3d6008cbc528b24aadc15a99ee27573d33a5a4e159b6ea71e204e572aaaa9516ce7207c74ee8d1

data/.circleci/config.yml

@@ -0,0 +1,15 @@
+version: 2.1
+
+jobs:
+  test:
+    docker:
+      - image: cimg/ruby:3.1.2
+    steps:
+      - checkout
+      - run: bundle install
+      - run: rspec
+
+workflows:
+  test:
+    jobs:
+      - test

data/.gitignore

@@ -0,0 +1,8 @@
+.yardoc
+*.*proj
+pkg
+doc
+.bundle
+.ruby-version
+Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+-w

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+ - 2.3.0
+ - 2.2.0
+ - 2.1.5
+ - 2.1.4
+ - 2.1.3
+ - 2.1.2
+ - 2.0.0
+ - jruby-19mode
+ - rbx
+jdk:
+ - oraclejdk8
+
+before_install: gem install bundler -v ">=1.9.3"

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,10 @@
+Copyright (c) 2009 - 2018, David Waite and Other Contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.markdown

@@ -0,0 +1,37 @@
+[![CircleCI](https://circleci.com/gh/dorianmariefr/cookiejar2/tree/main.svg?style=svg)](https://circleci.com/gh/dorianmariefr/cookiejar2/tree/main)
+
+This is a fork to fix warnings.
+
+-----
+
+Ruby CookieJar
+==============
+
+  **Git**:	[http://github.com/dwaite/cookiejar](http://github.com/dwaite/cookiejar)
+
+  **Author**:	David Waite
+
+[![Build Status](https://travis-ci.org/dwaite/cookiejar.svg?branch=master)](https://travis-ci.org/dwaite/cookiejar)
+
+Synopsis
+--------
+
+The Ruby CookieJar is a library to help manage client-side cookies in pure Ruby. It enables parsing and setting of cookie headers, alternating between multiple 'jars' of cookies at one time (such as having a set of cookies for each browser or thread), and supports persistence of the cookies in a JSON string.
+
+Both Netscape/RFC 2109 cookies and RFC 2965 cookies are supported.
+
+Roadmap
+-------
+
+For the Next major release, I would like to accomplish:
+
+1. Check against [RFC 6265 - HTTP State Management Mechanism][rfc6265], the latest cookie spec which came out after the initial release of cookiejar
+2. Determine better code structure to encourage alternate persistence mechanisms for cookie jars
+
+[rfc6265]: http://tools.ietf.org/html/rfc6265
+COPYRIGHT
+---------
+The Ruby CookieJar is Copyright © 2009-2014 David Waite, with [additional contributions from various authors][contributions]. Licensing terms are given within the [LICENSE file][LICENSE].
+
+[contributions]: ./contributors.json
+[LICENSE]: ./LICENSE

data/Rakefile

@@ -0,0 +1,30 @@
+require 'bundler/gem_tasks'
+
+require 'rake'
+
+require 'rake/clean'
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+CLEAN << Rake::FileList['doc/**', '.yardoc']
+# Yard
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb'] # optional
+  t.options = ['--title', 'CookieJar, a HTTP Client Cookie Parsing Library',
+               '--main', 'README.markdown', '--files', 'LICENSE']
+end
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new do |t|
+    t.ruby_opts = %w(-w)
+    t.pattern = 'spec/**/*_spec.rb'
+  end
+  task test: :spec
+rescue LoadError
+  puts 'Warning: unable to load rspec tasks'
+end
+
+# Default Rake task is to run all tests
+task default: :test

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-tactile

data/contributors.json

@@ -0,0 +1,14 @@
+[
+  {
+    "author": {
+      "github": "http://github.com/secobarbital",
+      "name":   "Seggy Umboh"
+    },
+    "contributions": [
+      "widen supported IP addresses",
+      "fix case-sensitivity issue with HTTP headers",
+      "correct issue when running under Ruby 1.8.x",
+      "made Jar act more like a browser (dropping cookies w/o exception)"
+    ]
+  }
+]

data/cookiejar.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cookiejar/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'cookiejar2'
+  s.version     = CookieJar::VERSION
+  s.authors     = ['David Waite']
+  s.license     = 'BSD-2-Clause'
+  s.email       = ['david@alkaline-solutions.com']
+  s.description = 'Allows for parsing and returning cookies in Ruby HTTP client code'
+  s.summary     = 'Client-side HTTP Cookie library'
+  s.homepage    = 'http://alkaline-solutions.com'
+  s.date        = '2014-02-01'
+
+  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.test_files    = s.files.grep(%r{^(spec)/})
+  s.rdoc_options  = ['--title', 'CookieJar -- Client-side HTTP Cookies']
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec-collection_matchers'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'bundler'
+end

data/lib/cookiejar/cookie.rb

@@ -0,0 +1,257 @@
+require 'time'
+require 'uri'
+require 'cookiejar/cookie_validation'
+
+module CookieJar
+  # Cookie is an immutable object which defines the data model of a HTTP Cookie.
+  # The data values within the cookie may be different from the
+  # values described in the literal cookie declaration.
+  # Specifically, the 'domain' and 'path' values may be set to defaults
+  # based on the requested resource that resulted in the cookie being set.
+  class Cookie
+    # [String] The name of the cookie.
+    attr_reader :name
+    # [String] The value of the cookie, without any attempts at decoding.
+    attr_reader :value
+
+    # [String] The domain scope of the cookie. Follows the RFC 2965
+    # 'effective host' rules. A 'dot' prefix indicates that it applies both
+    # to the non-dotted domain and child domains, while no prefix indicates
+    # that only exact matches of the domain are in scope.
+    attr_reader :domain
+
+    # [String] The path scope of the cookie. The cookie applies to URI paths
+    # that prefix match this value.
+    attr_reader :path
+
+    # [Boolean] The secure flag is set to indicate that the cookie should
+    # only be sent securely. Nearly all HTTP User Agent implementations assume
+    # this to mean that the cookie should only be sent over a
+    # SSL/TLS-protected connection
+    attr_reader :secure
+
+    # [Boolean] Popular browser extension to mark a cookie as invisible
+    # to code running within the browser, such as JavaScript
+    attr_reader :http_only
+
+    # [Fixnum] Version indicator, currently either
+    # * 0 for netscape cookies
+    # * 1 for RFC 2965 cookies
+    attr_reader :version
+    # [String] RFC 2965 field for indicating comment (or a location)
+    # describing the cookie to a usesr agent.
+    attr_reader :comment, :comment_url
+    # [Boolean] RFC 2965 field for indicating session lifetime for a cookie
+    attr_reader :discard
+    # [Array<FixNum>, nil] RFC 2965 port scope for the cookie. If not nil,
+    # indicates specific ports on the HTTP server which should receive this
+    # cookie if contacted.
+    attr_reader :ports
+    # [Time] Time when this cookie was first evaluated and created.
+    attr_reader :created_at
+
+    # Evaluate when this cookie will expire. Uses the original cookie fields
+    # for a max age or expires
+    #
+    # @return [Time, nil] Time of expiry, if this cookie has an expiry set
+    def expires_at
+      if @expiry.nil? || @expiry.is_a?(Time)
+        @expiry
+      else
+        @created_at + @expiry
+      end
+    end
+
+    # Indicates whether the cookie is currently considered valid
+    #
+    # @param [Time] time to compare against, or 'now' if omitted
+    # @return [Boolean]
+    def expired?(time = Time.now)
+      !expires_at.nil? && time > expires_at
+    end
+
+    # Indicates whether the cookie will be considered invalid after the end
+    # of the current user session
+    # @return [Boolean]
+    def session?
+      @expiry.nil? || @discard
+    end
+
+    # Create a cookie based on an absolute URI and the string value of a
+    # 'Set-Cookie' header.
+    #
+    # @param request_uri [String, URI] HTTP/HTTPS absolute URI of request.
+    # This is used to fill in domain and port if missing from the cookie,
+    # and to perform appropriate validation.
+    # @param set_cookie_value [String] HTTP value for the Set-Cookie header.
+    # @return [Cookie] created from the header string and request URI
+    # @raise [InvalidCookieError] on validation failure(s)
+    def self.from_set_cookie(request_uri, set_cookie_value)
+      args = CookieJar::CookieValidation.parse_set_cookie set_cookie_value
+      args[:domain] = CookieJar::CookieValidation
+                      .determine_cookie_domain request_uri, args[:domain]
+      args[:path] = CookieJar::CookieValidation
+                    .determine_cookie_path request_uri, args[:path]
+      cookie = Cookie.new args
+      CookieJar::CookieValidation.validate_cookie request_uri, cookie
+      cookie
+    end
+
+    # Create a cookie based on an absolute URI and the string value of a
+    # 'Set-Cookie2' header.
+    #
+    # @param request_uri [String, URI] HTTP/HTTPS absolute URI of request.
+    # This is used to fill in domain and port if missing from the cookie,
+    # and to perform appropriate validation.
+    # @param set_cookie_value [String] HTTP value for the Set-Cookie2 header.
+    # @return [Cookie] created from the header string and request URI
+    # @raise [InvalidCookieError] on validation failure(s)
+    def self.from_set_cookie2(request_uri, set_cookie_value)
+      args = CookieJar::CookieValidation.parse_set_cookie2 set_cookie_value
+      args[:domain] = CookieJar::CookieValidation
+                      .determine_cookie_domain request_uri, args[:domain]
+      args[:path] = CookieJar::CookieValidation
+                    .determine_cookie_path request_uri, args[:path]
+      cookie = Cookie.new args
+      CookieJar::CookieValidation.validate_cookie request_uri, cookie
+      cookie
+    end
+
+    # Returns cookie in a format appropriate to send to a server.
+    #
+    # @param [FixNum] 0 version, 0 for Netscape-style cookies, 1 for
+    #   RFC2965-style.
+    # @param [Boolean] true prefix, for RFC2965, whether to prefix with
+    # "$Version=<version>;". Ignored for Netscape-style cookies
+    def to_s(ver = 0, prefix = true)
+      return "#{name}=#{value}" if ver == 0
+
+      # we do not need to encode path; the only characters required to be
+      # quoted must be escaped in URI
+      str = prefix ? "$Version=#{version};" : ''
+      str << "#{name}=#{value};$Path=\"#{path}\""
+      str << ";$Domain=#{domain}" if domain.start_with? '.'
+      str << ";$Port=\"#{ports.join ','}\"" if ports
+      str
+    end
+
+    # Return a hash representation of the cookie.
+
+    def to_hash
+      result = {
+        name: @name,
+        value: @value,
+        domain: @domain,
+        path: @path,
+        created_at: @created_at
+      }
+      {
+        expiry: @expiry,
+        secure: (true if @secure),
+        http_only: (true if @http_only),
+        version: (@version if version != 0),
+        comment: @comment,
+        comment_url: @comment_url,
+        discard: (true if @discard),
+        ports: @ports
+      }.each do |name, value|
+        result[name] = value if value
+      end
+
+      result
+    end
+
+    # Determine if a cookie should be sent given a request URI along with
+    # other options.
+    #
+    # This currently ignores domain.
+    #
+    # @param uri [String, URI] the requested page which may need to receive
+    # this cookie
+    # @param script [Boolean] indicates that cookies with the 'httponly'
+    # extension should be ignored
+    # @return [Boolean] whether this cookie should be sent to the server
+    def should_send?(request_uri, script)
+      uri = CookieJar::CookieValidation.to_uri request_uri
+      # cookie path must start with the uri, it must not be a secure cookie
+      # being sent over http, and it must not be a http_only cookie sent to
+      # a script
+      path = if uri.path == ''
+               '/'
+             else
+               uri.path
+             end
+      path_match   = path.start_with? @path
+      secure_match = !(@secure && uri.scheme == 'http')
+      script_match = !(script && @http_only)
+      expiry_match = !expired?
+      ports_match = ports.nil? || (ports.include? uri.port)
+      path_match && secure_match && script_match && expiry_match && ports_match
+    end
+
+    def decoded_value
+      CookieJar::CookieValidation.decode_value value
+    end
+
+    # Return a JSON 'object' for the various data values. Allows for
+    # persistence of the cookie information
+    #
+    # @param [Array] a options controlling output JSON text
+    #   (usually a State and a depth)
+    # @return [String] JSON representation of object data
+    def to_json(*a)
+      to_hash.merge(json_class: self.class.name).to_json(*a)
+    end
+
+    # Given a Hash representation of a JSON document, create a local cookie
+    # from the included data.
+    #
+    # @param [Hash] o JSON object of array data
+    # @return [Cookie] cookie formed from JSON data
+    def self.json_create(o)
+      params = o.inject({}) do |hash, (key, value)|
+        hash[key.to_sym] = value
+        hash
+      end
+      params[:version] ||= 0
+      params[:created_at] = Time.parse params[:created_at]
+      if params[:expiry].is_a? String
+        params[:expires_at] = Time.parse params[:expiry]
+      else
+        params[:max_age] = params[:expiry]
+      end
+      params.delete :expiry
+
+      new params
+    end
+
+    # Compute the cookie search domains for a given request URI
+    # This will be the effective host of the request uri, along with any
+    # possibly matching dot-prefixed domains
+    #
+    # @param request_uri [String, URI] address being requested
+    # @return [Array<String>] String domain matches
+    def self.compute_search_domains(request_uri)
+      CookieValidation.compute_search_domains request_uri
+    end
+
+    protected
+
+    # Call {from_set_cookie} to create a new Cookie instance
+    def initialize(args)
+      @created_at, @name, @value, @domain, @path, @secure,
+      @http_only, @version, @comment, @comment_url, @discard, @ports \
+      = args.values_at \
+        :created_at, :name, :value, :domain, :path, :secure,
+        :http_only, :version, :comment, :comment_url, :discard, :ports
+
+      @created_at ||= Time.now
+      @expiry = args[:max_age] || args[:expires_at]
+      @secure     ||= false
+      @http_only  ||= false
+      @discard    ||= false
+
+      @ports = [@ports] if @ports.is_a? Integer
+    end
+  end
+end