php_session 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8550806b73142b48e0e82596af2e4f1b8e8ab363
-  data.tar.gz: 80ad0853de0fea1c9e22c460d65bb60bdae9c3fd
+  metadata.gz: b7b87e7c1e025ed1df45430687998b0f60dacc50
+  data.tar.gz: 2daeb3db468fe3c91db723e2da73d44ac678571b
 SHA512:
-  metadata.gz: 92cfdb1e5126e6d8a7819e3d03467586bd3c0aa39b779586d900d6ae46d01dfb233353dcd909b0d4a6945c8cccecb804c0c70d1ba19b69462dcf63cc54c857b8
-  data.tar.gz: c0416ce6aee7827f08a5f041f24893ba16bed74f4b29e97f46cb5e41937d335c456be45bf88c5de36169998e7553ec3233b9d8fcecbbc21f815a719d95dc6de4
+  metadata.gz: ce3e5b3099257ae86f80dc68b459994d003a95f38ea3e627242237b02947d7769bed8c822dd8dc84b22789a8e93234f3ebb97f7030c569320dcb7474faffa9fe
+  data.tar.gz: 684cc95377949741e0d8d9e642caa77288cac2bfc673d8954e123afa237d7437209578479132ea926c9ed17292ae36bb03518725c861bab90f2b0811ac8bd1bc

data/.travis.yml

@@ -2,4 +2,5 @@ language: ruby
 rvm:
     - 1.9.3
     - 2.0.0
+    - 2.1.2
     - ruby-head

data/README.md

@@ -3,7 +3,9 @@
 [![Code Climate](https://codeclimate.com/github/Shinpeim/ruby_php_session.png)](https://codeclimate.com/github/Shinpeim/ruby_php_session)
 
 ## Description
-PHPSession is a php session file reader/writer. Multibyte string and exclusive control are supported.
+PHPSession is a php session reader/writer.
+
+### Mapping between ruby and PHP
 
 When decoding php session data to ruby objects,
 
@@ -17,6 +19,56 @@ When encoding ruby objects to php session data,
 * Arrays in ruby is mapped to a associative arrays which's keys are integer in PHP.
 * Hashes in ruby is mapped to a associative arrays which's keys are string in PHP.
 
+### Session store engines are pluggable
+
+By default, PHPSession use file session store, which is compatible with PHP session file.
+
+You can use your own session store like bellow.
+
+First, develop your own store_engine.
+
+```ruby
+# lib_path/php_session/store_engine/custom.rb
+class PHPSession
+  module StoreEngine
+    class File
+      def initialize(option)
+        # option passed to PHPSession constractor
+        @option = option
+      end
+
+      def load(session_id)
+        # load php-style serialized session data from your favorite storage
+        # and return that
+      end
+
+      def save(session_id, serialized_session)
+        # save php-style serialized session data to your favorite storage
+      end
+
+      def destroy(session_id)
+        # delete session_data from your favorite storage
+      end
+    end
+  end
+end
+
+# register store engine name and store engine class
+PHPSession.register_store_engine(:custom, PHPSession::StoreEngine::Custom)
+```
+
+And then, assingn engine name to option[:store_engine] passed to PHPSession constractor
+
+```ruby
+option = {
+  :external_encoding => "EUC-JP",
+  :internal_encoding => "UTF-8",
+  :encoding_option   => {:undef => :replace},
+  :session_file_dir => @session_file[:dir_name],
+}
+session = PHPSession.new(option)
+```
+
 ### Multibyte support
 
 Passing option to PHPSession.new, you can handle encodings.
@@ -61,28 +113,35 @@ Or install it yourself as:
     $ gem install php_session
 
 ## Usage
-    # initialize
-    option = {
-        :internal_encoding => "UTF-8",  # value will be decoded as UTF-8
-        :external_encoding => "EUC-JP", # encoding of sesion file is EUC-JP
-        :encoding_option   => {:undef => :replace} # passed to String#encode
-    }
-    # option's default values are
-    # :internal_encoding => Encoding.default_internal_encoding
-    # :external_encoding => Encoding.default_external_encoding
-    # :encoding_option   => {}
-    session = PHPSession.new(session_file_dir, option)
-
-    # load session data from file with lock
-    data = session.load(session_id)
-
-    data.is_a? Hash # => true
-
-    # save session to a file with lock
-    session.commit(session_id, data)
-
-    # delete session
-    session.destroy(session_id)
+```ruby
+# initialize
+option = {
+  :internal_encoding => "UTF-8",  # value will be decoded as UTF-8
+  :external_encoding => "EUC-JP", # encoding of sesion file is EUC-JP
+  :encoding_option   => {:undef => :replace} # passed to String#encode
+
+  :store_engine      => :file,
+  :session_file_dir  => "/path/to/session_file_dir" # needed when the store_engine is :file
+}
+# option's default values are
+# :internal_encoding => Encoding.default_internal_encoding
+# :external_encoding => Encoding.default_external_encoding
+# :encoding_option   => {}
+# :store_engine      => :file,
+    
+session = PHPSession.new(option)
+
+# load session data
+data = session.load(session_id)
+
+data.is_a? Hash # => true
+
+# save session
+session.commit(session_id, data)
+
+# delete session
+session.destroy(session_id)
+```
 
 ## Contributing
 

data/lib/php_session.rb

@@ -3,59 +3,51 @@ require "php_session/version"
 require "php_session/errors"
 require "php_session/decoder"
 require "php_session/encoder"
+require "php_session/store_engine/file"
 
 class PHPSession
   attr_reader :data
-  def initialize(session_dir, option = {})
+
+  def self.register_store_engine(engine_name, klass)
+    @engines ||= {}
+    @engines[engine_name] = klass
+  end
+
+  def self.store_engine_class_of(engine_name)
+    store_engine = @engines[engine_name]
+    raise PHPSession::Errors, "unknown sotre engine: #{engine_name}" unless store_engine
+
+    store_engine
+  end
+
+  def initialize(option = {})
     default_option = {
+      :store_engine => :file,
+
       :internal_encoding => Encoding.default_internal,
       :external_encoding => Encoding.default_external,
       :encoding_option => {},
     }
     @option = default_option.merge(option)
-    @session_dir = File.expand_path(session_dir)
+
+    store_engine_class = self.class.store_engine_class_of(@option[:store_engine])
+
+    @store_engine = store_engine_class.new(@option)
   end
 
   def load(session_id)
-    with_lock(file_path(session_id)) do |f|
-     # set internal_encoding to nil to avoid encoding conversion
-      f.set_encoding(@option[:external_encoding], nil)
-      Decoder.decode(f.read, @option[:internal_encoding], @option[:encoding_option]) || {}
-    end
+    serialized_session = @store_engine.load(session_id)
+    Decoder.decode(serialized_session, @option[:internal_encoding], @option[:encoding_option]) || {}
   end
 
   def destroy(session_id)
-    File.delete(file_path(session_id))
-  rescue Errno::ENOENT => e
-    # file already deleted
+    @store_engine.destroy(session_id)
   end
 
   def save(session_id, data)
-    with_lock(file_path(session_id)) do |f|
-      f.truncate(0)
-      f.write(Encoder.encode(data, @option[:external_encoding], @option[:encoding_option]))
-    end
-  end
-
-  private
-
-  def with_lock(file_path)
-    File.open(file_path, File::CREAT|File::RDWR) do |f|
-      unless f.flock(File::LOCK_EX)
-        raise PHPSession::Errors, "can't obtain lock of session file"
-      end
-      yield(f)
-    end
-  end
-
-  def set_session_id(session_id)
-    @session_id = session_id
-    raise Errors::SecurityError, "directory traversal detected" unless file_path.index(@session_dir) == 0
-  end
-
-  def file_path(session_id)
-    path = File.expand_path(File.join(@session_dir, "sess_#{session_id}"))
-    raise Errors::SecurityError, "directory traversal detected" unless path.index(@session_dir) == 0
-    path
+    serialized_session = Encoder.encode(data, @option[:external_encoding], @option[:encoding_option])
+    @store_engine.save(session_id, serialized_session)
   end
 end
+
+PHPSession.register_store_engine(:file, PHPSession::StoreEngine::File)

data/lib/php_session/errors.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
 class PHPSession::Errors < StandardError; end
-class PHPSession::Errors::ParseError < StandardError; end
-class PHPSession::Errors::EncodeError < StandardError; end
+class PHPSession::Errors::ParameterError < StandardError; end
+class PHPSession::Errors::ParseError < PHPSession::Errors; end
+class PHPSession::Errors::EncodeError < PHPSession::Errors; end

data/lib/php_session/store_engine/file.rb

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+class PHPSession
+  module StoreEngine
+    class File
+      def initialize(option)
+        if ! option[:session_file_dir]
+          raise PHPSession::Errors::ParameterError , "option[:session_dir] is required"
+        end
+
+        @option = option
+      end
+
+      def load(session_id)
+        serialized_session = with_lock(file_path(session_id)) do |f|
+          # set internal_encoding to nil to avoid encoding conversion
+          f.set_encoding(@option[:external_encoding], nil)
+          f.read
+        end
+
+        serialized_session
+      end
+
+      def save(session_id, serialized_session)
+        with_lock(file_path(session_id)) do |f|
+          f.truncate(0)
+          f.write(serialized_session)
+        end
+      end
+
+      def destroy(session_id)
+        ::File.delete(file_path(session_id))
+      rescue Errno::ENOENT
+        # file already deleted
+      end
+
+      private
+
+      def with_lock(file_path)
+        mode = ::File::CREAT|::File::RDWR
+        ::File.open(file_path, mode) do |f|
+          unless f.flock(::File::LOCK_EX)
+            raise PHPSession::Errors, "can't obtain lock of session file"
+          end
+          yield(f)
+        end
+      end
+
+      def file_path(session_id)
+        path = ::File.expand_path(::File.join(@option[:session_file_dir], "sess_#{session_id}"))
+        raise Errors::SecurityError, "directory traversal detected" unless path.index(@option[:session_file_dir]) == 0
+        path
+      end
+    end
+  end
+end

data/lib/php_session/version.rb

@@ -1,4 +1,4 @@
 # -*- coding: utf-8 -*-
 class PHPSession
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/php_session.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Shinpei Maruyama"]
   spec.email         = ["shinpeim@gmail.com"]
   spec.description   = %q{php session reader/writer}
-  spec.summary       = %q{php_session is a php session file reader/writer. Multibyte string and exclusive control is supported}
+  spec.summary       = %q{php_session is a php session file reader/writer. Multibyte string control is supported}
   spec.homepage      = "https://github.com/Shinpeim/ruby_php_session"
   spec.license       = "MIT"
 

data/spec/php_session_spec.rb

@@ -12,8 +12,9 @@ describe PHPSession do
         option = {
           :internal_encoding => nil,
           :external_encoding => "UTF-8",
+          :session_file_dir => @session_file[:dir_name],
         }
-        session = PHPSession.new(@session_file[:dir_name], option)
+        session = PHPSession.new(option)
         data = session.load(@session_file[:session_id])
         expect(data).to eq({"key" => "テスト🍺"})
       end
@@ -22,8 +23,9 @@ describe PHPSession do
         option = {
           :internal_encoding => "UTF-8",
           :external_encoding => "UTF-8",
+          :session_file_dir => @session_file[:dir_name],
         }
-        session = PHPSession.new(@session_file[:dir_name], option)
+        session = PHPSession.new(option)
         data = session.load(@session_file[:session_id])
         expect(data).to eq({"key" => "テスト🍺"})
       end
@@ -32,9 +34,10 @@ describe PHPSession do
         option = {
           :internal_encoding => "EUC-JP",
           :external_encoding => "UTF-8",
-          :encoding_option => {:undef => :replace}
+          :encoding_option => {:undef => :replace},
+          :session_file_dir => @session_file[:dir_name],
         }
-        session = PHPSession.new(@session_file[:dir_name], option)
+        session = PHPSession.new(option)
         data = session.load(@session_file[:session_id])
         expect(data).to eq({"key" => "テスト🍺".encode("EUC-JP", {:undef => :replace})})
       end
@@ -50,7 +53,7 @@ describe PHPSession do
       end
 
       it "should return session data" do
-        session = PHPSession.new(@session_file[:dir_name])
+        session = PHPSession.new(:session_file_dir => @session_file[:dir_name])
         data = session.load(@session_file[:session_id])
         expect(data).to eq({"key" => "a"})
       end
@@ -62,7 +65,7 @@ describe PHPSession do
 
     context "when session file dosen't exist" do
       it "should return new session data" do
-        session = PHPSession.new(Dir.tmpdir)
+        session = PHPSession.new(:session_file_dir => Dir.tmpdir)
         data = session.load("session_id")
         expect(data).to eq({})
       end
@@ -78,9 +81,10 @@ describe PHPSession do
       option = {
         :external_encoding => "EUC-JP",
         :internal_encoding => "UTF-8",
-        :encoding_option   => {:undef => :replace}
+        :encoding_option   => {:undef => :replace},
+        :session_file_dir => @session_file[:dir_name],
       }
-      session = PHPSession.new(@session_file[:dir_name], option)
+      session = PHPSession.new(option)
       data = session.load(@session_file[:session_id])
       data["key"] = "テスト🍣"
       session.save(@session_file[:session_id], data)
@@ -102,7 +106,7 @@ describe PHPSession do
       end
 
       it "should delete session file" do
-        session = PHPSession.new(@session_file[:dir_name])
+        session = PHPSession.new(:session_file_dir => @session_file[:dir_name])
         session.destroy(@session_file[:session_id])
         expect(File.exists?(@session_file[:file_path])).to eq(false)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: php_session
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Shinpei Maruyama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,7 @@ files:
 - lib/php_session/decoder.rb
 - lib/php_session/encoder.rb
 - lib/php_session/errors.rb
+- lib/php_session/store_engine/file.rb
 - lib/php_session/version.rb
 - php_session.gemspec
 - spec/php_session/decoder_spec.rb
@@ -99,8 +100,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: php_session is a php session file reader/writer. Multibyte string and exclusive
-  control is supported
+summary: php_session is a php session file reader/writer. Multibyte string control
+  is supported
 test_files:
 - spec/php_session/decoder_spec.rb
 - spec/php_session/encoder_spec.rb