http_cookie_monster 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cca29bec6ea05bf5be5c79496d3a42843bc55c8
+  data.tar.gz: 86cc6b181e01cb4db5e2fb2721b2a4890f8206b5
+SHA512:
+  metadata.gz: 0b8ccafd95c834ca2fe40f49e478a2ca2836c64d147699a066e9a8d7bb515483568825ac2c299f8f77f858030e3975e377c4ab49cc5d8053973c5896ab3f193d
+  data.tar.gz: 232f4860d4622ee89925ca3d3ccbb8222207db2c13e9679e96460d8f773819d04b7e76bee991f5f2d03dd30c1ed7ccfa87be5d729ef9d918bff1e2c06f7935bd

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    http_cookie_monster (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    method_source (0.8.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  http_cookie_monster!
+  pry
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Marc Jakobs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Marc Jakobs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,125 @@
+# CookieMonster
+
+CookieMonster is a Ruby library to work with HTTP Cookies. It allows to parse cookies from a HTTP header into an object and to convert the object back to a cookie string or response header.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'http_cookie_monster'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install http_cookie_monster
+
+## Usage
+
+```ruby
+
+# include the gem into your code
+#
+require 'cookie_monster'
+
+# a new cookie-monster object
+#
+cookie = CookieMonster.new
+
+# a new cookie-monster object with initial attributes
+#
+cookie = CookieMonster.new({ :name => 'cookiename', :value => 'cookievalue', :httponly => true })
+
+# a new cookie-monster object from a raw cookie HTTP request header
+#
+cookie = CookieMonster.new 'Cookie: name=value; domain=.domain.com; path=/; httponly'
+
+# a new cookie-monster object from a cookie string
+#
+cookie = CookieMonster.new 'name=value; domain=.domain.com; path=/; httponly; secure'
+
+#
+# please note:
+#
+# name and value will be automatically URL decoded when parsed 
+# and automatically URL encoded when being set
+#
+
+# the following cookie attributes can be set
+#
+cookie.name     = 'myShinyCookie'          # the name will be URL encoded
+cookie.value    = 'test|123|zyx'           # the value will be URL encoded as well
+cookie.path     = '/'
+cookie.domain   = '.my.domain.com'
+cookie.expires  = Time.now + 7*86400       # must be a Time object
+cookie.httponly = true
+cookie.secure   = true
+
+# the attributes can be accessed like this
+#
+puts cookie.name
+puts cookie.value
+puts cookie.path
+puts cookie.domain
+puts cookie.expires
+puts cookie.httponly
+puts cookie.secure
+
+# there are some helper methods available
+#
+
+# is_valid? does some basic checks: is the cookie name set and is the expiry a Time object (if it's defined)
+if cookie.is_valid?
+  puts ":-)"
+else
+  puts ":-("
+end
+
+# runs the validation and throws exceptions
+#
+cookie.validate!
+
+# sets the cookie expiry
+#
+cookie.expires_in_seconds(60)      # in 60 seconds
+cookie.expires_in_seconds(3600)    # in 1 hour
+cookie.expires_in_seconds(86400)   # in 1 day
+cookie.expires_in_seconds(-60)     # expires the cookie
+
+# expire cookies
+#
+cookie.expire!      # sets the expire date to a date in the past
+cookie.delete!      # removes the cookie value
+
+# export the cookie object - runs validate! and throws a RuntimeError exception if the cookie is invalid!
+#
+cookie.to_s         # convert to a string
+cookie.to_header    # convert to a HTTP response header
+
+# ... so this would be better
+#
+begin
+  puts cookie.to_header
+rescue => ex
+  puts "Failed to generate cookie: #{ex}"
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hirschnase/CookieMonster.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cookie_monster"
+require "pry"
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cookie_monster.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cookie_monster/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "http_cookie_monster"
+  spec.version       = CookieMonster::VERSION
+  spec.authors       = ["Marc Jakobs"]
+  spec.email         = ["marc@moc.io"]
+
+  spec.summary       = %q{A Ruby Class to work on HTTP Cookies}
+  spec.description   = %q{A simple helper Class to parse / generate HTTP Cookies}
+  spec.homepage      = "https://github.com/hirschnase/CookieMonster"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/cookie_monster.rb

@@ -0,0 +1,127 @@
+require 'cookie_monster/version'
+require 'time'          # always need more time! :)
+require 'uri'           # url encoding/decoding
+
+class CookieMonster
+
+  attr_accessor :name
+  attr_accessor :value
+  attr_accessor :domain
+  attr_accessor :path
+  attr_accessor :expires
+  attr_accessor :httponly
+  attr_accessor :secure
+
+  # init - a raw cookie can be passed for parsing. a hash with attributes can be handed in as well.
+  #
+  def initialize(args=nil)
+    from_header(args) if args.is_a? String
+    if args.is_a? Hash
+      args.each do |k,v|
+        _set([k,v])
+      end
+    end
+    self
+  end
+
+  # helper method to mass asign attributes
+  #
+  def _set(kv)
+    case kv.first.to_sym
+    when :name
+      @name = kv.last
+    when :value
+      @value = kv.last
+    when :path
+      @path = kv.last
+    when :domain
+      @domain = kv.last
+    when :expires
+      @expires = Time.parse(kv.last.gsub('GMT', 'UTC'))
+    when :httponly
+      @httponly = true
+    when :secure
+      @secure = true
+    end
+  end
+
+  # parse a cookie header string
+  #
+  def from_header(header)
+    parse(header.gsub(/^set-cookie:\s*/i, '').gsub(/^cookie:\s*/i, ''))
+  end
+
+  # parse a raw cookie string
+  #
+  def parse(raw_cookie)
+    cookie = raw_cookie.split(/\;\s*/)
+
+    kv = cookie.shift
+    @name   = URI.unescape(kv.split('=').first)
+    @value  = URI.unescape(kv.split('=').last)
+
+    cookie.each do |kv|
+      _set(kv.split('='))
+    end
+
+  end
+
+  # convert the cookie to a string
+  #
+  def to_s
+    validate!
+    URI.escape(name.to_s) + '=' + (value ? URI.escape(value.to_s) : '') +
+    (domain   ? '; domain='+domain        : '') +
+    (path     ? '; path='+path            : '') +
+    (expires  ? '; expires='+expires.to_time.utc.strftime('%a, %d-%b-%Y %T GMT') : '') +
+    (httponly ? '; httponly'              : '') +
+    (secure   ? '; secure'                : '')
+  end
+
+  # convert the cookie to a HTTP response header
+  #
+  def to_header
+    validate!
+    "Set-Cookie: " + to_s
+  end
+
+  # sets the cookie expiry in seconds from now
+  #
+  def expires_in_seconds(secs)
+    @expires = Time.now.utc + secs;
+    self
+  end
+
+  # expires the cookie by settings its expire date to yesterday - browsers will then delete the cookie from their jar
+  #
+  def expire!
+    @expires = Time.now.utc - 86400;
+    self
+  end
+
+  # deletes the cookie by removing it's value - browsers will then delete the cookie from their jar
+  #
+  def delete!
+    @value = ''
+    self
+  end
+
+  # runs some simple validation against the cookie - throws exceptions!
+  #
+  def validate!
+    raise 'Cookie name must be defined' unless name
+    raise 'Cookie expires is not an instance of the Time class' if expires and ! expires.is_a? Time
+  end
+
+  # validates the cookie - returns true or false
+  #
+  def is_valid?
+    begin
+      validate!
+      true
+    rescue => ex
+      false
+    end
+  end
+
+end

data/lib/cookie_monster/version.rb

@@ -0,0 +1,3 @@
+class CookieMonster
+  VERSION = "0.1.3"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: http_cookie_monster
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Marc Jakobs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A simple helper Class to parse / generate HTTP Cookies
+email:
+- marc@moc.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cookie_monster.gemspec
+- lib/cookie_monster.rb
+- lib/cookie_monster/version.rb
+homepage: https://github.com/hirschnase/CookieMonster
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: A Ruby Class to work on HTTP Cookies
+test_files: []