rack-php-session 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Adam Daniels
+
+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.markdown

@@ -0,0 +1,58 @@
+rack-php-session
+================
+
+Exposes a PHP session (read-only) to Rack applications
+
+
+Installation
+------------
+      gem install rack-php-session
+
+
+Dependencies
+------------
+* [php-serialize](http://www.aagh.net/projects/ruby-php-serialize)
+
+
+Usage
+-----
+In a Rack environment:
+      
+      require 'rack/php-session'
+      use Rack::PHPSession
+
+      run app
+
+In your application
+
+      env['php.session'] => { } # Returns a Hash of the PHP Session contents
+
+In a Rails environment add in 'config/environment.rb' the following:
+    
+      config.middleware.use Rack::PHPSession
+
+Limitations
+-----------
+* The PHP session is currently read-only.
+* The Rack application must be able to read PHP session files. In PHP configurations
+  that utilize suPHP, this is trivial as session files are stored as the current user.
+  Standard mod_php configurations may result in permission problems.
+* The PHP Session ID must be known -- this is generally stored in a cookie so the Rack
+  application must run on the same domain as the PHP application (easily achievable
+  using Passenger or a Proxy method).
+
+
+Note on Patches/Pull Requests
+-----------------------------
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+Copyright
+---------
+Copyright (c) 2010 Adam Daniels. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-php-session"
+    gem.summary = %Q{Read-only access to PHP Sessions from Rack Applications}
+    gem.description = %Q{Exposes a PHP Session (read-only) to Rack applications}
+    gem.email = "adam@mediadrive.ca"
+    gem.homepage = "http://github.com/adam12/rack-php-session"
+    gem.authors = ["Adam Daniels"]
+    gem.add_dependency 'php-serialize'
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+
+  Jeweler::RubyforgeTasks.new do |t|
+    t.doc_task = :yardoc
+  end
+  
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/example/config.ru

@@ -0,0 +1,18 @@
+require 'rubygems'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'rack/php-session')
+require 'sinatra/base'
+
+use Rack::Reloader
+use Rack::Lint
+use Rack::ShowExceptions
+use Rack::PHPSession
+
+class App < Sinatra::Base
+  get '/' do
+    "<pre>" + env.to_yaml + "</pre>"
+  end
+end
+
+map '/' do
+  run App.new
+end

data/lib/rack-php-session.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'rack', 'php-session')

data/lib/rack/php-session.rb

@@ -0,0 +1,30 @@
+require 'php_serialize'
+
+module Rack
+  # Exposes a PHP Session in Rack Applications as a Hash
+
+  class PHPSession
+    # @param [Hash] options the options to configure the middleware
+    # @option options [String] :session_name ('PHPSESSID') The name of the PHP Session
+    # @option options [String] :session_file_path ('.') The folder where PHP Session files are stored
+
+    def initialize(app, options = {})
+      @app = app
+      @options = { :session_name => 'PHPSESSID', :session_file_path => '.' }.merge(options)
+    end
+
+    def call(env, options = {})
+      req = Request.new(env)
+
+      session_id = req.cookies[@options[:session_name]]
+      session_file = ::File.join(@options[:session_file_path], "sess_#{session_id}")
+
+      if ::File.exists?(session_file)
+        contents = ::File.read(session_file)
+        env['php.session'] = (contents.nil? || contents.empty?) ? Hash.new : PHP.unserialize(contents)
+      end
+      
+      @app.call(env)
+    end
+  end
+end

data/rack-php-session.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-php-session}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Adam Daniels"]
+  s.date = %q{2010-05-20}
+  s.description = %q{Exposes a PHP Session (read-only) to Rack applications}
+  s.email = %q{adam@mediadrive.ca}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "example/config.ru",
+     "lib/rack-php-session.rb",
+     "lib/rack/php-session.rb",
+     "rack-php-session.gemspec",
+     "test/fixtures/sess_b6c1556e31e663f35b042c8b8369b75e",
+     "test/fixtures/sess_empty",
+     "test/helper.rb",
+     "test/test_rack-php-session.rb"
+  ]
+  s.homepage = %q{http://github.com/adam12/rack-php-session}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Read-only access to PHP Sessions from Rack Applications}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_rack-php-session.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<php-serialize>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<php-serialize>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<php-serialize>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/test/fixtures/sess_b6c1556e31e663f35b042c8b8369b75e

@@ -0,0 +1 @@
+uid|s:1:"1";upw|s:32:"fc34cbc639d6f616f6a43daa3451ab7a";

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/test'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rack-php-session'
+
+class Test::Unit::TestCase
+end

data/test/test_rack-php-session.rb

@@ -0,0 +1,32 @@
+require 'helper'
+
+class TestRackPhpSession < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    @app = Rack::Builder.new {
+      use Rack::PHPSession, :session_file_path => File.join(File.dirname(__FILE__), 'fixtures')
+      run lambda {|env| [200,  {'Content-Type' =>  'text/plain', 'Content-Length' => '12'}, ["Hello World!"] ] }
+    }.to_app
+  end
+
+  def test_no_php_session_without_cookie
+    get '/'
+    assert ! last_request.env.include?('php.session')
+  end
+
+  def test_php_session_with_cookie
+    get '/', nil, { 'HTTP_COOKIE' => 'PHPSESSID=b6c1556e31e663f35b042c8b8369b75e' }
+    assert last_request.env.include?('php.session')
+  end
+
+  def test_php_session_hash_is_valid
+    get '/', nil, { 'HTTP_COOKIE' => 'PHPSESSID=b6c1556e31e663f35b042c8b8369b75e' }
+    assert_equal Hash["uid" => "1", "upw" => "fc34cbc639d6f616f6a43daa3451ab7a"], last_request.env['php.session']
+  end
+
+  def test_empty_session_file_should_return_empty_hash
+    get '/', nil, { 'HTTP_COOKIE' => 'PHPSESSID=empty' }
+    assert_equal Hash.new, last_request.env['php.session']
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: rack-php-session
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Adam Daniels
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-20 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: php-serialize
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Exposes a PHP Session (read-only) to Rack applications
+email: adam@mediadrive.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- example/config.ru
+- lib/rack-php-session.rb
+- lib/rack/php-session.rb
+- rack-php-session.gemspec
+- test/fixtures/sess_b6c1556e31e663f35b042c8b8369b75e
+- test/fixtures/sess_empty
+- test/helper.rb
+- test/test_rack-php-session.rb
+has_rdoc: true
+homepage: http://github.com/adam12/rack-php-session
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Read-only access to PHP Sessions from Rack Applications
+test_files: 
+- test/helper.rb
+- test/test_rack-php-session.rb