padrino-cookies 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+archive/*
+doc/*
+.yardoc
+.bundle
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.yardopts

@@ -0,0 +1,9 @@
+--no-save
+--no-private
+--title Padrino Cookies
+--markup-provider redcarpet
+--markup markdown
+lib/**/*.rb
+-
+README.md
+LICENSE

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Benjamin Bloch
+
+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,38 @@
+Overview
+--------
+
+Padrino Cookies is a plugin for the [Padrino](https://github.com/padrino/padrino-framework) web framework which adds support for [Rails](https://github.com/rails/rails) like cookie manipulation.
+
+Setup & Installation
+--------------------
+
+Include it in your project's `Gemfile`:
+
+``` ruby
+gem 'padrino-cookies'
+```
+
+Modify your `app/app.rb` file to register the plugin:
+
+``` ruby
+class ExampleApplication < Padrino::Application
+  register Padrino::Cookies
+end
+```
+
+Dependencies
+------------
+
+* [Padrino-Core](https://github.com/padrino/padrino-framework)
+* [Ruby](http://www.ruby-lang.org/en) >= 1.9.2
+
+TODO
+-----
+
+* Additional documentation
+* Signed cookies
+
+Copyright
+---------
+
+Copyright &copy; 2012 Benjamin Bloch (Cirex). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'padrino-cookies/version'
+
+require 'rake'
+require 'yard'
+require 'rspec'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+end
+
+YARD::Rake::YardocTask.new
+
+task :build do
+  `gem build padrino-cookies.gemspec`
+end
+
+task :install => :build do
+  `gem install padrino-cookies-#{Padrino::Cookies::VERSION}.gem`
+end
+
+desc 'Releases the current version into the wild'
+task :release => :build do
+  `git tag -a v#{Padrino::Cookies::VERSION} -m "Version #{Padrino::Cookies::VERSION}"`
+  `gem push padrino-cookies-#{Padrino::Cookies::VERSION}.gem`
+  `git push --tags`
+end
+
+task :default => :spec

data/lib/padrino-cookies.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+require 'padrino-core'
+FileSet.glob_require('padrino-cookies/**/*.rb', __FILE__)
+
+module Padrino
+  module Cookies
+    class << self
+      # @private
+      def registered(app)
+        app.helpers Helpers
+      end
+    end # self
+  end # Cookies
+end # Padrino

data/lib/padrino-cookies/helpers.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+module Padrino
+  module Cookies
+    module Helpers
+      ###
+      # Returns the cookie storage object
+      #
+      # @return [Jar]
+      #   ...Nom ....Nom ....Nom
+      #
+      # @example
+      #   cookie[:remembrance] = '71ab53190d2f863b5f3b12381d2d5986512f8e15b34d439e6b66e3daf41b5e35'
+      #   cookies.delete :remembrance
+      #
+      # since 0.1.0
+      # @api public
+      def cookies
+        @cookie_jar ||= Jar.new(self)
+      end
+      alias_method :cookie, :cookies
+    end # Helpers
+  end # Cookies
+end # Padrino

data/lib/padrino-cookies/jar.rb

@@ -0,0 +1,236 @@
+# encoding: UTF-8
+require 'active_support/core_ext/integer/time'
+require 'active_support/core_ext/numeric/time'
+require 'active_support/core_ext/numeric/bytes'
+require 'active_support/core_ext/date/calculations'
+
+module Padrino
+  module Cookies
+    class Jar
+      include Enumerable
+
+      # @private
+      def initialize(app)
+        @response = app.response
+        @request  = app.request
+        @cookies  = app.request.cookies
+
+        @options = {
+              path: '/',
+          httponly: true,
+            secure: @request.secure?
+        }
+      end
+
+      ###
+      # Returns the value of the specified cookie
+      #
+      # @return [String]
+      #   Value of the cookie
+      #
+      # @example
+      #   cookies[:remembrance]
+      #   # => '71ab53190d2f863b5f3b12381d2d5986512f8e15b34d439e6b66e3daf41b5e35'
+      #
+      # @since 0.1.0
+      # @api public
+      def [](name)
+        @cookies[name.to_s]
+      end
+
+      ###
+      # Sets the specified cookie
+      #
+      # @overload []=(name, value)
+      #   @param [Symbol] name
+      #     The name of the cookie being set
+      #   @param [String] value
+      #     The value of the cookie being set
+      #
+      # @overload []=(name, options)
+      #   @param [Symbol] name
+      #     The name of the cookie being set
+      #   @param [Hash] options
+      #     The options to set along with this cookie
+      #
+      #   @option options [String] :value
+      #     The value of the cookie being set
+      #   @option options [Time] :expires
+      #     The time when this cookie expires
+      #   @option options [Boolean] :httponly (true)
+      #     Should the cookie be accessible to the HTTP protocol only
+      #   @option options [Boolean] :secure
+      #     Should the cookie only be sent over secure connections such as HTTPS
+      #   @option options [String] :path ('/')
+      #     The scope in which this cookie is accessible
+      #   @option options [String] :domain
+      #     The scope in which this cookie is accessible
+      #
+      # @example
+      #   cookies[:remembrance] = '71ab53190d2f863b5f3b12381d2d5986512f8e15b34d439e6b66e3daf41b5e35'
+      #
+      # @since 0.1.0
+      # @api public
+      def []=(name, options)
+        unless options.is_a?(Hash)
+          options = { value: options }
+        end
+
+        @response.set_cookie(name, @options.merge(options))
+        @cookies[name.to_s] = options[:value]
+      end
+
+      ###
+      # Returns an array of cookies that have been set
+      #
+      # @return [Array<String>]
+      #   Cookies set
+      #
+      # @example
+      #   cookies.keys
+      #   # => ['remembrance']
+      #
+      # @since 0.1.0
+      # @api public
+      def keys
+        @cookies.keys
+      end
+
+      ###
+      # Returns whether or not the specified cookie is set
+      #
+      # @return [Boolean]
+      #   *true* if it is, *false* otherwise
+      #
+      # @example
+      #   cookie.key?(:remembrance)
+      #   # => true
+      #
+      # @since 0.1.0
+      # @api public
+      def key?(name)
+        @cookies.key?(name.to_s)
+      end
+      alias_method :has_key?, :key?
+      alias_method :include?, :key?
+
+      ###
+      # Deletes the specified cookie
+      #
+      # @return [String]
+      #   Value of the deleted cookie
+      #
+      # @example
+      #   cookies.delete :remembrance
+      #
+      # @since 0.1.0
+      # @api public
+      def delete(name)
+        @response.delete_cookie(name)
+        @cookies.delete(name.to_s)
+      end
+
+      ###
+      # Deletes all cookies that are currently set
+      #
+      # @example
+      #   cookies.clear
+      #
+      # @since 0.1.0
+      # @api public
+      def clear
+        @cookies.each_key { |name| delete(name) }
+      end
+
+      ###
+      # Returns whether or not any cookies have been set
+      #
+      # @return [Boolean]
+      #   *true* if cookies are set, *false* otherwise
+      #
+      # @example
+      #   cookies.empty?
+      #   # => true
+      #
+      # @since 0.1.0
+      # @api public
+      def empty?
+        @cookies.empty?
+      end
+
+      ###
+      # Returns the total amount of cookies that have been set
+      #
+      # @return [Integer]
+      #   Total cookies set
+      #
+      # @example
+      #   cookies.length
+      #   # => 2
+      #
+      # @since 0.1.0
+      # @api public
+      def length
+        @cookies.length
+      end
+      alias_method :size, :length
+
+      ###
+      # Iterates through set cookies
+      #
+      # @example
+      #   cookies.each do |key, value|
+      #     # ...
+      #   end
+      #
+      # @since 0.1.0
+      # @api public
+      def each(&block)
+        @cookies.each(&block)
+      end
+
+      # @since 0.1.0
+      # @api public
+      def to_hash
+        @cookies.dup
+      end
+
+      # @since 0.1.0
+      # @api public
+      def to_s
+        @cookies.to_s
+      end
+
+      ###
+      # Sets a permanent cookie
+      #
+      # @example
+      #   cookies.permanent[:remembrance] = '71ab53190d2f863b5f3b12381d2d5986512f8e15b34d439e6b66e3daf41b5e35'
+      #
+      # @since 0.1.0
+      # @api public
+      def permanent
+        @permanent ||= PermanentJar.new(self)
+      end
+    end # Jar
+
+    class PermanentJar # @private
+      def initialize(parent_jar)
+        @parent_jar = parent_jar
+      end
+
+      def []=(key, options)
+        unless options.is_a?(Hash)
+          options = { value: options }
+        end
+
+        options[:expires] = 1.year.from_now
+        @parent_jar[key] = options
+      end
+
+      def method_missing(method, *args, &block)
+        @parent_jar.send(method, *args, &block)
+      end
+    end # PermanentJar
+  end # Cookies
+end # Padrino

data/lib/padrino-cookies/version.rb

@@ -0,0 +1,6 @@
+# encoding: UTF-8
+module Padrino
+  module Cookies
+    VERSION = '0.1.0'
+  end
+end

data/padrino-cookies.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+require 'padrino-cookies/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'padrino-cookies'
+  s.version     = Padrino::Cookies::VERSION
+  s.authors     = ['Benjamin Bloch']
+  s.email       = ['cirex@gamesol.org']
+  s.homepage    = 'https://github.com/Cirex/padrino-cookies'
+  s.description = 'A plugin for the Padrino web framework which adds support for Rails like cookie manipulation'
+  s.summary     = s.description
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'padrino-core'
+
+  s.add_development_dependency 'rspec', '>= 2.0.0'
+  s.add_development_dependency 'rspec-html-matchers'
+  s.add_development_dependency 'rack-test'
+end

data/spec/cookies_spec.rb

@@ -0,0 +1,178 @@
+require_relative 'spec'
+
+describe Padrino::Cookies do
+  let :cookies do
+    route('foo=bar', 'bar=foo') { cookies }
+  end
+
+  context :[] do
+    it 'can retrieve existing cookies' do
+      cookies['foo'].should == 'bar'
+      cookies['bar'].should == 'foo'
+    end
+
+    it 'should allow symbols to be used as keys' do
+      cookies[:foo].should == 'bar'
+      cookies['foo'].should == 'bar'
+    end
+
+    it 'should return nil when the cookie is not found' do
+      cookies[:nom_nom].should be_nil
+    end
+  end
+
+  context :[]= do
+    it 'should add the cookie to the jar' do
+      cookies['test'] = 'test'
+      cookies['test'].should == 'test'
+    end
+
+    it 'should allow symbols to be used as keys' do
+      cookies[:test] = 'test'
+      cookies[:test].should == 'test'
+      cookies['test'].should == 'test'
+    end
+
+    it 'should set the response headers when setting a cookie' do
+      result = route do
+        cookies['foo'] = 'bar'
+        response['Set-Cookie']
+      end
+      result.should == 'foo=bar; path=/; HttpOnly'
+    end
+
+    it 'should set the path to / by default' do
+      result = route do
+        cookies['foo'] = 'bar'
+        response['Set-Cookie']
+      end
+
+      result.should include('path=/')
+    end
+
+    it 'should set HttpOnly by default' do
+      result = route do
+        cookies['foo'] = 'bar'
+        response['Set-Cookie']
+      end
+
+      result.should include('HttpOnly')
+    end
+  end
+
+  context :delete do
+    it 'should remove the cookie from the jar' do
+      cookies['foo'].should == 'bar'
+      cookies.delete 'foo'
+      cookies['foo'].should be_nil
+    end
+
+    it 'should allow symbols to be used as keys' do
+      cookies.delete :foo
+      cookies['foo'].should be_nil
+    end
+
+    it 'should set the response headers when deleting a cookie' do
+      result = route('foo=bar') do
+        cookies.delete 'foo'
+        response['Set-Cookie']
+      end
+
+      result.should == 'foo=; expires=Thu, 01-Jan-1970 00:00:00 GMT'
+    end
+
+    it 'should return the cookie value when deleting a cookie' do
+      cookies.delete('foo').should == 'bar'
+    end
+  end
+
+  describe :clear do
+    it 'can delete all cookies that are set' do
+      cookies['foo'].should == 'bar'
+      cookies['bar'].should == 'foo'
+      cookies.clear
+      cookies['foo'].should be_nil
+      cookies['bar'].should be_nil
+    end
+  end
+
+  context :length do
+    it 'can tell you how many cookies are set' do
+      cookies.length.should == 2
+      cookies['baz'] = 'foo'
+      cookies.length.should == 3
+    end
+
+    it 'should return 0 when no cookies are set' do
+      cookies.length.should == 2
+      cookies.clear
+      cookies.length.should == 0
+    end
+  end
+
+  describe :keys do
+    it 'can give you a list of cookies that are set' do
+      cookies.keys.should == ['bar', 'foo']
+    end
+  end
+
+  context :key? do
+    it 'should return true when a cookie is set' do
+      cookies.key?('foo').should be_true
+    end
+
+    it 'should return false when a cookie is not set' do
+      cookies.key?('nom_nom').should be_false
+    end
+
+    it 'should allow symbols to be used as keys' do
+      cookies.key?(:foo).should be_true
+    end
+  end
+
+  context :empty? do
+    it 'should return true when no cookies are set' do
+      cookies.clear
+      cookies.empty?.should be_true
+    end
+
+    it 'should return false when cookies are set' do
+      cookies.empty?.should be_false
+    end
+  end
+
+  context :each do
+    it 'can iterate through cookies' do
+      result = []
+      cookies.each do |key, value|
+        result << [key, value]
+      end
+      result[0].should == ['bar', 'foo']
+      result[1].should == ['foo', 'bar']
+    end
+
+    it 'should allow enumeration' do
+      result = cookies.collect do |key, value|
+        [key, value]
+      end
+      result[0].should == ['bar', 'foo']
+      result[1].should == ['foo', 'bar']
+    end
+  end
+
+  context :permanent do
+    it 'should add cookies to the parent jar' do
+      cookies.permanent['baz'] = 'foo'
+      cookies['baz'].should == 'foo'
+    end
+
+    it 'should set a cookie that expires in the distant future' do
+      result = route do
+        cookies.permanent['baz'] = 'foo'
+        response['Set-Cookie']
+      end
+
+      result.should =~ /#{1.year.from_now.year}/
+    end
+  end
+end

data/spec/spec.rb

@@ -0,0 +1,28 @@
+PADRINO_ENV = 'test'
+
+require 'rspec'
+require 'rack/test'
+require 'padrino-cookies'
+
+module TestHelpers
+  def app
+    @app ||= Sinatra.new(Padrino::Application) do
+      register Padrino::Cookies
+      disable :logging
+    end
+  end
+
+  def route(*cookies, &block)
+    result = nil
+    set_cookie(cookies)
+    app.get('cookies') { result = instance_eval(&block) }
+    get 'cookies'
+    result
+  end
+end
+
+RSpec.configure do |configuration|
+  configuration.include TestHelpers
+  configuration.include Rack::Test::Methods
+end
+

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: padrino-cookies
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Benjamin Bloch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: padrino-core
+  requirement: &15464784 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *15464784
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &15464232 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *15464232
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: &15463920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *15463920
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &15463500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *15463500
+description: A plugin for the Padrino web framework which adds support for Rails like
+  cookie manipulation
+email:
+- cirex@gamesol.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/padrino-cookies.rb
+- lib/padrino-cookies/helpers.rb
+- lib/padrino-cookies/jar.rb
+- lib/padrino-cookies/version.rb
+- padrino-cookies.gemspec
+- spec/cookies_spec.rb
+- spec/spec.rb
+homepage: https://github.com/Cirex/padrino-cookies
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A plugin for the Padrino web framework which adds support for Rails like
+  cookie manipulation
+test_files: []
+has_rdoc: