cookie_cutter 0.1.0

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+#exclude rubymine ide files
+.idea/

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+# Specify your gem's dependencies in cookie_cutter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andy Alm
+
+MIT License
+
+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,54 @@
+# CookieCutter
+
+WARNING: CookieCutter is very early in its development cycle (pre-alpha).
+
+CookieCutter provides a nice DSL for defining your cookies so that you can formalize your cookie definitions.
+This leads to DRY-er code by ensuring that concerns such as the domain and lifetime of a cookie are consistent.
+It also makes it easy to know what info you are putting into your cookies, which is becoming more important
+these days as more laws surrounding cookies get written.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cookie_cutter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cookie_cutter
+
+## Usage Examples
+
+### Define your cookie
+
+    class MyCookie < CookieCutter::Base
+      store_as :my
+      domain :all
+      is_permanent
+      secure_requests_only
+      http_only
+      has_attribute :language
+      has_attribute :country
+    end
+
+### Use your cookie
+
+    #writes your cookie
+    cookie = MyCookie.find(request)
+    cookie.language = "fr"
+
+    #reads your cookie
+    cookie = MyCookie.find(request)
+    puts "My language is #{cookie.language}"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+
+#use bundler to resolve dependencies
+require 'bundler'
+Bundler.require(:default, :development, :test)
+
+#import standard bundler gem tasks
+require "bundler/gem_tasks"
+
+#import/define rspec task
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Runs all the tests'
+task :tests => :spec
+task :t => :tests
+
+task :default => [:tests,:build]

data/cookie_cutter.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cookie_cutter/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andy Alm"]
+  gem.email         = ["private"]
+  gem.description   = %q{Provides a way to define the structure, lifetime, and other properties of a cookie all in one place.}
+  gem.summary       = gem.description
+  gem.homepage      = "http://github.com/andyalm/cookie_cutter"
+
+  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.name          = "cookie_cutter"
+  gem.require_paths = ["lib"]
+  gem.version       = CookieCutter::VERSION
+
+  gem.add_development_dependency 'activesupport' #for date helpers
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/lib/cookie_cutter/base.rb

@@ -0,0 +1,7 @@
+require 'cookie_cutter/cookie'
+
+module CookieCutter
+  class Base
+    include Cookie
+  end
+end

data/lib/cookie_cutter/cookie.rb

@@ -0,0 +1,140 @@
+module CookieCutter
+  module Cookie
+    module ClassMethods
+      def find(request)
+        new(request.cookie_jar)
+      end
+
+      attr_reader :cookie_name
+      def store_as(name)
+        @cookie_name = name
+      end
+
+      attr_reader :cookie_domain
+      def domain(domain_value)
+        @cookie_domain = domain_value
+        add_handler do |cookie|
+          cookie[:domain] = domain_value
+        end
+      end
+
+      attr_reader :cookie_lifetime
+      def lifetime(seconds)
+        @cookie_lifetime = seconds
+        add_handler do |cookie|
+          cookie[:expires] = (Time.now + seconds)
+        end
+      end
+
+      def is_permanent
+        twenty_years = 60 * 60 * 24 * 365.25 * 20
+        lifetime twenty_years
+      end
+
+      def secure_requests_only
+        @secure = true
+        add_handler do |cookie|
+          cookie[:secure] = true
+        end
+      end
+
+      def secure?
+        @secure ? true : false
+      end
+
+      def http_only
+        @http_only = true
+        add_handler do |cookie|
+          cookie[:httponly] = true
+        end
+      end
+      alias_method :httponly, :http_only
+
+      def http_only?
+        @http_only ? true : false
+      end
+      alias_method :httponly?, :http_only?
+
+      def has_attribute(value_name, options={})
+        raise "CookieCutter value names must by symbols. #{value_name} is not a symbol" unless value_name.is_a?(Symbol)
+        #make value and value= private when the cookie has one or more named values
+        private :value, :value=, :set_value
+
+        value_key = (options[:store_as] || value_name).to_sym
+        send :define_method, value_name do
+          get_attribute_value(value_key)
+        end
+        setter_method_name = "#{value_name.to_s}=".to_sym
+        send :define_method, setter_method_name do |value|
+          set_attribute_value(value_key, value)
+        end
+      end
+
+      def add_options(cookie)
+        handlers.each do |handler|
+          handler.call(cookie)
+        end
+      end
+
+      def add_handler(&block)
+        handlers << block
+      end
+
+      def handlers
+        @handlers ||= []
+      end
+    end
+
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    def initialize(cookie_jar)
+      @cookie_jar = cookie_jar
+    end
+
+    def value
+      @cookie_jar[cookie_name]
+    end
+
+    def value=(val)
+      cookie = { value: val }
+      self.class.add_options(cookie)
+      @cookie_jar[cookie_name] = cookie
+    end
+
+    def delete!
+      @cookie_jar.delete(cookie_name)
+    end
+
+    def cookie_name
+      self.class.cookie_name
+    end
+
+    def secure?
+      self.class.secure?
+    end
+
+    def cookie_lifetime
+      self.class.cookie_lifetime
+    end
+
+    def cookie_domain
+      self.class.cookie_domain
+    end
+
+    alias_method :set_value, :value=
+
+    private
+    def set_attribute_value(value_name, val)
+      values_hash = value() || {}
+      values_hash[value_name] = val
+      set_value(values_hash)
+    end
+
+    def get_attribute_value(value_name)
+      values_hash = value() || {}
+      values_hash[value_name]
+    end
+  end
+end

data/lib/cookie_cutter/version.rb

@@ -0,0 +1,3 @@
+module CookieCutter
+  VERSION = "0.1.0"
+end

data/lib/cookie_cutter.rb

@@ -0,0 +1,6 @@
+require "cookie_cutter/version"
+require "cookie_cutter/base"
+
+module CookieCutter
+  # Your code goes here...
+end

data/spec/base_spec.rb

@@ -0,0 +1,158 @@
+require 'rspec'
+require 'cookie_cutter'
+require_relative 'support/fake_cookie_jar'
+require 'active_support/core_ext'
+
+class SingleValuedCookie < CookieCutter::Base
+  store_as :svc
+end
+
+class MultiValuedCookie < CookieCutter::Base
+  store_as :mvc
+
+  has_attribute :value1
+  has_attribute :value2, store_as: 'val2'
+end
+
+class MyMixedCaseCookie < CookieCutter::Base
+  store_as :my_uppercase_cookie
+
+  has_attribute :mixed_case_key, store_as: 'mixedcasekey'
+end
+
+describe CookieCutter::Base do
+  let(:cookie_jar) { FakeCookieJar.new }
+  it 'should not not update the cookie_jar when no value is set' do
+    SingleValuedCookie.new(cookie_jar)
+    cookie_jar.to_hash.should be_empty
+  end
+  describe 'domain' do
+    it 'does not set domain if not given' do
+      class CookieWithNoDomain < CookieCutter::Base
+        store_as :cwnd
+      end
+      cookie = CookieWithNoDomain.new(cookie_jar)
+      cookie.value = "my value"
+      cookie_jar.metadata_for(:cwnd)[:domain].should be_nil
+    end
+    it 'uses given domain when saving cookie' do
+      class CookieWithDomain < CookieCutter::Base
+        store_as :cwd
+        domain :all
+      end
+      cookie = CookieWithDomain.new(cookie_jar)
+      cookie.value = "my value"
+      cookie_jar.metadata_for(:cwd)[:domain].should == :all
+    end
+  end
+  describe 'lifetime' do
+    it 'defaults to a session cookie' do
+      class CookieWithNoLifetimeSpecified < CookieCutter::Base
+        store_as :cwnls
+      end
+      cookie = CookieWithNoLifetimeSpecified.new(cookie_jar)
+      cookie.value = "my value"
+      cookie_jar.metadata_for(:cwnls)[:expires].should be_nil
+    end
+    it 'sets expires to now plus lifetime' do
+      now = Time.now
+      lifetime = 60
+      class CookieWithLifetimeSpecified < CookieCutter::Base
+        store_as :cwls
+
+        lifetime 60
+      end
+      cookie = CookieWithLifetimeSpecified.new(cookie_jar)
+      cookie.value = "my value"
+      cookie_jar.metadata_for(:cwls)[:expires].should be_within(0.01).of(now + lifetime)
+    end
+    it 'sets expires to 20 years from now if made permanent!' do
+      now = Time.now
+      class PermanentCookie < CookieCutter::Base
+        store_as :pc
+        is_permanent
+      end
+      cookie = PermanentCookie.new(cookie_jar)
+      cookie.value = "my value"
+      cookie_jar.metadata_for(:pc)[:expires].should be_within(0.01).of(20.years.from_now)
+    end
+  end
+  describe 'secure_requests_only' do
+    it 'defaults to all requests (insecure) cookie' do
+      class CookieWithNoSecuritySpecified < CookieCutter::Base
+        store_as :cwnss
+      end
+      cookie = CookieWithNoSecuritySpecified.new(cookie_jar)
+      cookie.value = "my value"
+      cookie_jar.metadata_for(:cwnss)[:secure].should be_nil
+    end
+    it 'sets secure flag when secure_requests_only is specified' do
+      class CookieWithSecureRequestsOnly < CookieCutter::Base
+        store_as :cwsro
+        secure_requests_only
+      end
+      cookie = CookieWithSecureRequestsOnly.new(cookie_jar)
+      cookie.value = "my value"
+      cookie_jar.metadata_for(:cwsro)[:secure].should be_true
+    end
+  end
+  describe 'http_only' do
+    it 'defaults to being accessible to client scripts (i.e. not http_only)' do
+      class ClassWithNoHttpOnly < CookieCutter::Base
+        store_as :cwnho
+      end
+      cookie = ClassWithNoHttpOnly.new(cookie_jar)
+      cookie.value = "my value"
+      cookie_jar.metadata_for(:cwnho)[:httponly].should be_nil
+    end
+    it 'sets httponly flag when http_only is specified' do
+      class CookieWithHttpOnly < CookieCutter::Base
+        store_as :cwho
+        http_only
+      end
+      cookie = CookieWithHttpOnly.new(cookie_jar)
+      cookie.value = "my value"
+      cookie_jar.metadata_for(:cwho)[:httponly].should be_true
+    end
+  end
+  describe 'delete!' do
+    it 'should delete the cookie from the cookie jar' do
+      cookie = SingleValuedCookie.new(cookie_jar)
+      cookie.delete!
+      cookie_jar.deleted?(cookie.cookie_name).should be_true
+    end
+  end
+  describe 'single valued cookie' do
+    let(:single_valued_cookie) { SingleValuedCookie.new(cookie_jar) }
+    it 'should update the cookie jar when value is updated' do
+      single_valued_cookie.value = "ordinary value"
+      cookie_jar[:svc].should == "ordinary value"
+    end
+    it 'can be read via ordinary cookie jar' do
+      single_value_cookie = SingleValuedCookie.new(FakeCookieJar.new({ svc: "preset value" }))
+      single_value_cookie.value.should == "preset value"
+    end
+  end
+  describe 'multi-valued cookie' do
+    let(:multi_valued_cookie) { MultiValuedCookie.new(cookie_jar) }
+    it 'should update the cookie jar when an attribute is updated' do
+      multi_valued_cookie.value1 = "myval"
+      cookie_jar[:mvc][:value1].should == "myval"
+    end
+    it 'generates getters and setters for each attribute' do
+      multi_valued_cookie.value1 = "myval1"
+      multi_valued_cookie.value2 = "myval2"
+
+      multi_valued_cookie.value1.should == "myval1"
+      multi_valued_cookie.value2.should == "myval2"
+    end
+    it "privatizes the singular 'value' getter and setter" do
+      expect { multi_valued_cookie.value = "myval"}.should raise_error(NoMethodError)
+      expect { multi_valued_cookie.value}.should raise_error(NoMethodError)
+    end
+    it "can override stored attribute name with :store_as option" do
+      multi_valued_cookie.value2 = "myval2"
+      cookie_jar[:mvc][:val2].should == "myval2"
+    end
+  end
+end

data/spec/support/fake_cookie_jar.rb

@@ -0,0 +1,41 @@
+class FakeCookieJar
+  def [](name)
+    cookie = @cookies[name]
+    if cookie
+      cookie[:value]
+    else
+      nil
+    end
+  end
+
+  def []=(name, value)
+    @cookies[name] = value
+  end
+
+  def delete(name)
+    @deleted_cookies << name
+  end
+
+  def initialize(*args)
+    @cookies = {}
+    @deleted_cookies = []
+    if args.any?
+      cookies = args.first
+      cookies.keys.each do |cookie_name|
+        self[cookie_name] = { value: cookies[cookie_name] }
+      end
+    end
+  end
+
+  def deleted?(name)
+    @deleted_cookies.include?(name)
+  end
+
+  def to_hash
+    @cookies
+  end
+
+  def metadata_for(name)
+    @cookies[name]
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: cookie_cutter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andy Alm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a way to define the structure, lifetime, and other properties
+  of a cookie all in one place.
+email:
+- private
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cookie_cutter.gemspec
+- lib/cookie_cutter.rb
+- lib/cookie_cutter/base.rb
+- lib/cookie_cutter/cookie.rb
+- lib/cookie_cutter/version.rb
+- spec/base_spec.rb
+- spec/support/fake_cookie_jar.rb
+homepage: http://github.com/andyalm/cookie_cutter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1951188585045254267
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1951188585045254267
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides a way to define the structure, lifetime, and other properties of
+  a cookie all in one place.
+test_files:
+- spec/base_spec.rb
+- spec/support/fake_cookie_jar.rb