cookiejar 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9e74c8690174e08cec5fa35868f2d91c4428b77d
-  data.tar.gz: aab937a1668a87baa131e048b7fc8d3513bb9d47
+SHA256:
+  metadata.gz: d08d63f0ec86285b96e7ee8ba926564aa526b10ae9cb77e25bcd9acb8779600e
+  data.tar.gz: 6a5c0d291baab26ef76ef25d12c95d31b6ca6f47ada89d67e5aed5fa70582003
 SHA512:
-  metadata.gz: b84ac2103a3a7435082647d671ae43c2c41b523c09f6563c8f9946613ae00a61c4de70290f3af4b901736333106cf6066ab46fa0e3f4c5fc1b386873b7c9ab26
-  data.tar.gz: fe140117a6960848e4b69697b7368d9ace9abec4edffeb4123c7aaa55392b666d9260097d11bee50bdbe0ff3b7ffbaeef26557925aacb9bd4b7110eee3b002a6
+  metadata.gz: 2c23451da58eaffb6b878aa9bd21083de306461a88ea2381cb710d10fcd5cd99ee1d4227a26690c2407acc96528e61ce591738f0ce997c358a00e24cea96df06
+  data.tar.gz: c5029ccd84b21567f16750a24aca4d4c99f7c0078548451756027012753f001e8c92a7bdb6d520429e7a0a865302ba797ba5fa64b4b723416d644e134f6a98c9

data/.gitignore

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

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

@@ -1,4 +1,4 @@
-Copyright (c) 2009 - 2014, David Waite and Other Contributors
+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:

data/README.markdown

@@ -5,6 +5,13 @@ Ruby CookieJar
 
   **Author**:	David Waite 
 
+[![Build Status](https://travis-ci.org/dwaite/cookiejar.svg?branch=master)](https://travis-ci.org/dwaite/cookiejar)
+
+Status
+------
+
+This project is no longer maintained. There may be other gems more appropriate for use which support newer versions of the cookie specifications, or more maintained forks of this gem such as [cookiejar2](https://github.com/dorianmariefr/cookiejar2).
+
 Synopsis
 --------
 
@@ -12,6 +19,18 @@ The Ruby CookieJar is a library to help manage client-side cookies in pure Ruby.
 
 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 David Waite. Licensing terms are given within the LICENSE file.
+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

@@ -1,19 +1,15 @@
+require 'bundler/gem_tasks'
+
 require 'rake'
 
 require 'rake/clean'
-require 'rake/packagetask'
 require 'yard'
 require 'yard/rake/yardoc_task'
 
-require 'fileutils'
-include FileUtils
-
-# Default Rake task is to run all tests
-task :default => :test
 CLEAN << Rake::FileList['doc/**', '.yardoc']
-#Yard
+# Yard
 YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb']   # optional
+  t.files   = ['lib/**/*.rb'] # optional
   t.options = ['--title', 'CookieJar, a HTTP Client Cookie Parsing Library',
                '--main', 'README.markdown', '--files', 'LICENSE']
 end
@@ -22,10 +18,13 @@ begin
   require 'rspec/core/rake_task'
 
   RSpec::Core::RakeTask.new do |t|
-#    t.libs << 'lib'
-#    t.pattern = 'test/**/*_test.rb'
+    t.ruby_opts = %w(-w)
+    t.pattern = 'spec/**/*_spec.rb'
   end
-  task :test => :spec
+  task test: :spec
 rescue LoadError
-  puts "Warning: unable to load rspec tasks"
+  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/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        = 'cookiejar'
+  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', '>= 10.0'
+  s.add_development_dependency 'rspec-collection_matchers', '~> 1.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'yard',  '~> 0.9.20'
+  s.add_development_dependency 'bundler', '>= 0.9.3'
+end

data/lib/cookiejar/cookie.rb

@@ -3,14 +3,12 @@ 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.
@@ -68,15 +66,15 @@ module CookieJar
     #
     # @param [Time] time to compare against, or 'now' if omitted
     # @return [Boolean]
-    def expired? (time = Time.now)
-      expires_at != nil && time > expires_at
+    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
+      @expiry.nil? || @discard
     end
 
     # Create a cookie based on an absolute URI and the string value of a
@@ -88,12 +86,12 @@ module CookieJar
     # @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
+    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]
+      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
@@ -108,12 +106,12 @@ module CookieJar
     # @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
+    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]
+      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
@@ -125,45 +123,37 @@ module CookieJar
     #   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
-      case ver
-      when 0
-        "#{name}=#{value}"
-      when 1
-        # 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}\""
-        if domain.start_with? '.'
-          str << ";$Domain=#{domain}"
-        end
-        if ports
-          str << ";$Port=\"#{ports.join ','}\""
-        end
-        str
-      end
-    end
+    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
+        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
+        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
@@ -181,12 +171,17 @@ module CookieJar
     # @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
+    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_match   = uri.path.start_with? @path
+      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?
@@ -195,7 +190,7 @@ module CookieJar
     end
 
     def decoded_value
-      CookieJar::CookieValidation::decode_value value
+      CookieJar::CookieValidation.decode_value value
     end
 
     # Return a JSON 'object' for the various data values. Allows for
@@ -204,8 +199,8 @@ module CookieJar
     # @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)
+    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
@@ -213,7 +208,7 @@ module CookieJar
     #
     # @param [Hash] o JSON object of array data
     # @return [Cookie] cookie formed from JSON data
-    def self.json_create o
+    def self.json_create(o)
       params = o.inject({}) do |hash, (key, value)|
         hash[key.to_sym] = value
         hash
@@ -227,7 +222,7 @@ module CookieJar
       end
       params.delete :expiry
 
-      self.new params
+      new params
     end
 
     # Compute the cookie search domains for a given request URI
@@ -236,28 +231,27 @@ module CookieJar
     #
     # @param request_uri [String, URI] address being requested
     # @return [Array<String>] String domain matches
-    def self.compute_search_domains request_uri
+    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
 
+    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, :name, :value, :domain, :path, :secure,
+        :http_only, :version, :comment, :comment_url, :discard, :ports
 
       @created_at ||= Time.now
-      @expiry     = args[:max_age]   || args[:expires_at]
+      @expiry = args[:max_age] || args[:expires_at]
       @secure     ||= false
       @http_only  ||= false
       @discard    ||= false
 
-      if @ports.is_a? Integer
-        @ports = [@ports]
-      end
+      @ports = [@ports] if @ports.is_a? Integer
     end
   end
 end