rack-session-php 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9746184f83319cea7aec8a657f3e12cd5745e2a
+  data.tar.gz: 207bd0a0470851de002decc427f615731ddc4eaf
+SHA512:
+  metadata.gz: 210cace6152f7e73ca737324f447ca67c025ad2829614f178d27cacd1725e471664ca13f200a303654c76ca852b07df7cf935920d089455450f76b5fd4ae5faf
+  data.tar.gz: 72ea19019221571e1c9719d2282f04689eb586bb7be611ca9219e60f046487ef35d6bb3ce76332ad9780cff74635c6e62cf96a20530c3cfb9dbd36630965db50

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+    - 1.9.3
+    - 2.0.0
+    - ruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-session-php.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Shinpei Maruyama
+
+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,47 @@
+# Rack::Session::PHP
+[![Build Status](https://travis-ci.org/Shinpeim/rack-session-php.png?branch=master)](https://travis-ci.org/Shinpeim/rack-session-php)
+
+This module provides PHP compatible session in rack layer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-session-php'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rack-session-php
+
+## Usage
+
+In your config.ru
+
+```
+require 'rack/session/php'
+
+use Rack::Session::PHP, {
+  :session_file_dir => "/path/to/your/session_files"
+  :file_options => {
+    :internal_encoding => 'UTF-8', # encoding in ruby is utf-8
+    :external_encoding => 'EUC-JP',# encoding in session file is euc-jp
+    :encoding_option => {:undef => :replace}, # option passed to String#encode
+  }
+  :expire_after => 10,
+  # and you can pass Rack::Session options.
+}
+
+run your_awsome_rack_application
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/examples/config.ru

@@ -0,0 +1,11 @@
+require 'rack/session/php'
+
+app = lambda {|env|
+  env["rack.session"]["counter"] ||= 0
+  env["rack.session"]["counter"] += 1
+  Rack::Response.new(env["rack.session"].inspect).to_a
+}
+
+use Rack::Session::PHP, :session_file_dir => Dir.tmpdir
+
+run app

data/lib/rack/session/php.rb

@@ -0,0 +1,67 @@
+require "rack/session/abstract/id"
+require "php_session"
+
+module Rack
+  module Session
+    class PHP < Rack::Session::Abstract::ID
+      def initialize(app, options = {})
+        @session_file_dir = options.delete(:session_file_dir)
+        raise "session file dir must be defined" unless @session_file_dir
+
+        file_options = options.delete(:file_options)
+        file_options ||= {}
+
+        @session = PHPSession.new(@session_file_dir, file_options)
+        @mutex = Mutex.new
+
+        super(app, options)
+      end
+
+      def generate_sid
+        loop do
+          sid = super
+          break sid unless ::File.exists?(::File.join(@session_file_dir, "sess_#{sid}"))
+        end
+      end
+
+      def get_session(env, sid)
+        with_lock(env) do
+          if sid
+            data = @session.load(sid)
+          else
+            data = {}
+          end
+
+          if sid.nil? || data.empty?
+            sid = generate_sid
+          end
+
+          [sid, data]
+        end
+      end
+
+      def set_session(env, sid, session, options)
+        with_lock(env) do
+          @session.save(sid, session)
+          sid
+        end
+      end
+
+      def destroy_session(env, sid, options)
+        with_lock(env) do
+          @session.destroy(sid)
+          generate_sid unless options[:drop]
+        end
+      end
+
+      private
+
+      def with_lock(env, default=nil)
+        @mutex.lock if env['rack.multithread']
+        yield
+      ensure
+        @mutex.unlock if @mutex.locked?
+      end
+    end
+  end
+end

data/rack-session-php.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-session-php"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Shinpei Maruyama"]
+  spec.email         = ["shinpeim@gmail.com"]
+  spec.description   = %q{rack middleware which provides php compatible sessions}
+  spec.summary       = %q{rack middleware which provides php compatible sessions. multibyte string is supported.}
+  spec.homepage      = "https://github.com/Shinpeim/rack-session-php"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "php_session", "~> 0.3.0"
+  spec.add_dependency "rack", "~> 1.5.2"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/rack/session/php_spec.rb

@@ -0,0 +1,206 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+require 'rack/session/php'
+require 'rack/lint'
+require 'rack/mock'
+require 'tempfile'
+
+describe Rack::Session::PHP do
+  session_key = Rack::Session::PHP::DEFAULT_OPTIONS[:key]
+  session_match = /#{session_key}=([0-9a-fA-F]+);/
+  incrementor = lambda do |env|
+    env["rack.session"]["counter"] ||= 0
+    env["rack.session"]["counter"] += 1
+    Rack::Response.new(env["rack.session"].inspect).to_a
+  end
+  drop_session = Rack::Lint.new(proc do |env|
+    env['rack.session.options'][:drop] = true
+    incrementor.call(env)
+  end)
+  renew_session = Rack::Lint.new(proc do |env|
+    env['rack.session.options'][:renew] = true
+    incrementor.call(env)
+  end)
+  defer_session = Rack::Lint.new(proc do |env|
+    env['rack.session.options'][:defer] = true
+    incrementor.call(env)
+  end)
+  skip_session = Rack::Lint.new(proc do |env|
+    env['rack.session.options'][:skip] = true
+    incrementor.call(env)
+  end)
+  incrementor = Rack::Lint.new(incrementor)
+
+  let(:session_file_dir) {File.join(File.dirname(__FILE__), "..", "..", "session_files")}
+  let(:pool) {
+    Rack::Session::PHP.new(incrementor, :session_file_dir => session_file_dir)
+  }
+
+  after do
+    Dir.foreach(session_file_dir) do |file|
+      File.delete(File.join(session_file_dir, file)) if file =~ /^sess/
+    end
+  end
+
+  it "creates a new cookie" do
+    res = Rack::MockRequest.new(pool).get("/")
+    expect(res["Set-Cookie"]).to be_include("#{session_key}=")
+    expect(res.body).to eq '{"counter"=>1}'
+  end
+
+  it "determines session from a cookie" do
+    req = Rack::MockRequest.new(pool)
+    res = req.get("/")
+    cookie = res["Set-Cookie"]
+    expect(req.get("/", "HTTP_COOKIE" => cookie).body).
+      to eq '{"counter"=>2}'
+    expect(req.get("/", "HTTP_COOKIE" => cookie).body).
+      to eq '{"counter"=>3}'
+  end
+
+  it "determines session only from a cookie by default" do
+    req = Rack::MockRequest.new(pool)
+    res = req.get("/")
+    sid = res["Set-Cookie"][session_match, 1]
+    expect(req.get("/?rack.session=#{sid}").body).
+      to eq '{"counter"=>1}'
+    expect(req.get("/?rack.session=#{sid}").body).
+      to eq '{"counter"=>1}'
+  end
+
+  it "determines session from params" do
+    pool_with_params = Rack::Session::PHP.new(incrementor, :session_file_dir => session_file_dir, :cookie_only => false)
+    req = Rack::MockRequest.new(pool_with_params)
+    res = req.get("/")
+    sid = res["Set-Cookie"][session_match, 1]
+    expect(req.get("/?rack.session=#{sid}").body).
+      to eq '{"counter"=>2}'
+    expect(req.get("/?rack.session=#{sid}").body).
+      to eq '{"counter"=>3}'
+  end
+
+  it "survives nonexistant cookies" do
+    bad_session_id = "nekodaisuki"
+    bad_cookie = "rack.session=#{bad_session_id}"
+    res = Rack::MockRequest.new(pool).
+      get("/", "HTTP_COOKIE" => bad_cookie)
+    expect(res.body).to eq '{"counter"=>1}'
+    cookie = res["Set-Cookie"][session_match]
+    expect(cookie).not_to match(/#{bad_cookie}/)
+  end
+
+  it "does not send the same session id if it did not change" do
+    req = Rack::MockRequest.new(pool)
+
+    res0 = req.get("/")
+    cookie = res0["Set-Cookie"][session_match]
+    expect(res0.body).to eq '{"counter"=>1}'
+
+    res1 = req.get("/", "HTTP_COOKIE" => cookie)
+    expect(res1["Set-Cookie"]).to be_nil
+    expect(res1.body).to eq '{"counter"=>2}'
+
+    res2 = req.get("/", "HTTP_COOKIE" => cookie)
+    expect(res2["Set-Cookie"]).to be_nil
+    expect(res2.body).to eq '{"counter"=>3}'
+  end
+
+  it "deletes cookies with :drop option" do
+    req = Rack::MockRequest.new(pool)
+    drop = Rack::Utils::Context.new(pool, drop_session)
+    dreq = Rack::MockRequest.new(drop)
+
+    res1 = req.get("/")
+    session = (cookie = res1["Set-Cookie"])[session_match]
+    expect(res1.body).to eq '{"counter"=>1}'
+
+    res2 = dreq.get("/", "HTTP_COOKIE" => cookie)
+    expect(res2["Set-Cookie"]).to be_nil
+    expect(res2.body).to eq '{"counter"=>2}'
+
+    res3 = req.get("/", "HTTP_COOKIE" => cookie)
+    expect(res3["Set-Cookie"][session_match]).not_to eq session
+    expect(res3.body).to eq '{"counter"=>1}'
+  end
+
+  it "provides new session id with :renew option" do
+    req = Rack::MockRequest.new(pool)
+    renew = Rack::Utils::Context.new(pool, renew_session)
+    rreq = Rack::MockRequest.new(renew)
+
+    res1 = req.get("/")
+    session = (cookie = res1["Set-Cookie"])[session_match]
+    expect(res1.body).to eq '{"counter"=>1}'
+
+    res2 = rreq.get("/", "HTTP_COOKIE" => cookie)
+    new_cookie = res2["Set-Cookie"]
+    new_session = new_cookie[session_match]
+    expect(new_session).not_to eq session
+    expect(res2.body).to eq '{"counter"=>2}'
+
+    res3 = req.get("/", "HTTP_COOKIE" => new_cookie)
+    expect(res3.body).to eq '{"counter"=>3}'
+
+    # Old cookie was deleted
+    res4 = req.get("/", "HTTP_COOKIE" => cookie)
+    expect(res4.body).to eq '{"counter"=>1}'
+  end
+
+  it "omits cookie with :defer option but still updates the state" do
+    count = Rack::Utils::Context.new(pool, incrementor)
+    defer = Rack::Utils::Context.new(pool, defer_session)
+    dreq = Rack::MockRequest.new(defer)
+    creq = Rack::MockRequest.new(count)
+
+    res0 = dreq.get("/")
+    expect(res0["Set-Cookie"]).to be_nil
+    expect(res0.body).to eq '{"counter"=>1}'
+
+    res0 = creq.get("/")
+    res1 = dreq.get("/", "HTTP_COOKIE" => res0["Set-Cookie"])
+    expect(res1.body).to eq '{"counter"=>2}'
+    res2 = dreq.get("/", "HTTP_COOKIE" => res0["Set-Cookie"])
+    expect(res2.body).to eq '{"counter"=>3}'
+  end
+
+  it "omits cookie and state update with :skip option" do
+    count = Rack::Utils::Context.new(pool, incrementor)
+    skip = Rack::Utils::Context.new(pool, skip_session)
+    sreq = Rack::MockRequest.new(skip)
+    creq = Rack::MockRequest.new(count)
+
+    res0 = sreq.get("/")
+    expect(res0["Set-Cookie"]).to be_nil
+    expect(res0.body).to eq '{"counter"=>1}'
+
+    res0 = creq.get("/")
+    res1 = sreq.get("/", "HTTP_COOKIE" => res0["Set-Cookie"])
+    expect(res1.body).to eq '{"counter"=>2}'
+    res2 = sreq.get("/", "HTTP_COOKIE" => res0["Set-Cookie"])
+    expect(res2.body).to eq '{"counter"=>2}'
+  end
+
+  it "can handle multibyte strings" do
+    multibyte_app = lambda{|env|
+      env['rack.session']['key'] = 'テスト'
+      [200, {}, 'session stored']
+    }
+    pool = Rack::Session::PHP.new(multibyte_app, {
+      :session_file_dir => session_file_dir,
+      :file_options => {
+        :internal_encoding => "UTF-8",
+        :external_encoding => "EUC-JP",
+      }
+    })
+
+    req = Rack::MockRequest.new(pool)
+    res = req.get("/")
+    session_id = session_match.match(res["Set-Cookie"])[1]
+
+    file_name = File.join(session_file_dir, "sess_#{session_id}")
+
+    # read as byte sequence
+    byteseq = IO.read(file_name, File.size(file_name))
+    expect(byteseq.force_encoding('EUC-JP')).to eq('key|s:6:"テスト";'.encode('EUC-JP'))
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "rack/session/php"

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: rack-session-php
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shinpei Maruyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: php_session
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: rack middleware which provides php compatible sessions
+email:
+- shinpeim@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/config.ru
+- lib/rack/session/php.rb
+- rack-session-php.gemspec
+- spec/rack/session/php_spec.rb
+- spec/session_files/.gitkeep
+- spec/spec_helper.rb
+homepage: https://github.com/Shinpeim/rack-session-php
+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.0
+signing_key: 
+specification_version: 4
+summary: rack middleware which provides php compatible sessions. multibyte string
+  is supported.
+test_files:
+- spec/rack/session/php_spec.rb
+- spec/session_files/.gitkeep
+- spec/spec_helper.rb