php_session 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91b55063968fec647a72fe0aa42537907c1a3d79
-  data.tar.gz: 05aa36fdc96ad702c03316ae749de25b2c088eba
+  metadata.gz: 16cf738d413f25164e6bee9698592671dd1cc6af
+  data.tar.gz: f32cf9dd832e3c66f1c7755ae0c2581c890a5d2e
 SHA512:
-  metadata.gz: fe4b25bbf30ece559c174961af6f18d0ee6cfbcf88d8f807dab3bca0a047663f4dfe86ace91cd1b7bf54f435ee2edf63af370ce8911844fbf584fbd2b4b44006
-  data.tar.gz: f6121e69661e82a29dba92db0319c4bc892211cfbd60a7683f065523c7c921589c766f30368cbee0e4816425961e2e6f544d405d02cc2f3d5697f0da381dff21
+  metadata.gz: b93e0e6d6a2e334e4a3bc0ed1e1054c0486021f4bf2bf761db49c8685cf2b0030dca809e4e76602d4717e4708f1c60b830ef7446b65a4345e17510223335f5d6
+  data.tar.gz: 6fbe2cc80a4ea1977b6dae82f5a1d68ad2516f15439b6d82a97f2b8c46e8824c614ff01ce0922dd61d692630db5b14977419e246370adc023da2da9ccb594a5f

data/README.md

@@ -1,6 +1,7 @@
 # PHPSession
 [![Build Status](https://travis-ci.org/Shinpeim/ruby_php_session.png?branch=master)](https://travis-ci.org/Shinpeim/ruby_php_session)
 [![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.
 
@@ -72,21 +73,16 @@ Or install it yourself as:
     # :encoding_option   => {}
     session = PHPSession.new(session_file_dir, option)
 
-    begin
-      # load session data from file and obtain a lock
-      data = session.load(session_id)
+    # load session data from file with lock
+    data = session.load(session_id)
 
-      data.is_a? Hash # => true
+    data.is_a? Hash # => true
 
-      # save session and release the lock
-      session.commit(data)
+    # save session to a file with lock
+    session.commit(session_id, data)
 
-      # delete session file and release the lock
-      session.destroy
-    ensure
-      # please ensure that the lock is released and the file is closed.
-      session.ensure_file_closed
-    end
+    # delete session
+    session.destroy(session_id)
 
 ## Contributing
 

data/lib/php_session.rb

@@ -14,60 +14,48 @@ class PHPSession
     }
     @option = default_option.merge(option)
     @session_dir = File.expand_path(session_dir)
-
-    @file = nil
   end
 
   def load(session_id)
-    set_session_id(session_id)
-    @file = File.open(file_path, File::CREAT|File::RDWR)
-
-    unless @file.flock(File::LOCK_EX)
-      raise PHPSession::Errors, "can't obtain lock of session file"
+    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
-
-    # set internal_encoding to nil to avoid encoding conversion
-    @file.set_encoding(@option[:external_encoding], nil)
-    data = Decoder.decode(@file.read, @option[:internal_encoding], @option[:encoding_option]) || {}
-    @file.rewind
-    data
   end
 
-  def loaded?
-    ! @file.nil?
-  end
-
-  def destroy
-    if @file && ! @file.closed?
-      @file.truncate(0)
-    end
-    ensure_file_closed
-    File.delete(file_path)
+  def destroy(session_id)
+    File.delete(file_path(session_id))
   rescue Errno::ENOENT => e
     # file already deleted
   end
 
-  def commit(data)
-    self.load(@session_id) unless @file
-    @file.truncate(0)
-    @file.write(Encoder.encode(data, @option[:external_encoding], @option[:encoding_option]))
-    ensure_file_closed
-  end
-
-  def ensure_file_closed
-    if @file && ! @file.closed?
-      @file.close
+  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
-    File.expand_path(File.join(@session_dir, "sess_#{@session_id}"))
+  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
   end
 end

data/lib/php_session/version.rb

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

data/spec/php_session_spec.rb

@@ -2,79 +2,48 @@
 require 'spec_helper'
 
 describe PHPSession do
-  describe "loaded?" do
-    before do
-      @session_file = create_dummy_session_file('key|s:1:"a";')
-    end
-
-    it "should return true when file is loaded" do
-      session = PHPSession.new(@session_file[:dir_name])
-      session.load(@session_file[:session_id])
-      expect(session.loaded?).to be_true
-    end
-
-    it "should return false when file is loaded" do
-      session = PHPSession.new(@session_file[:dir_name])
-      expect(session.loaded?).to be_false
-    end
-
-    after do
-      File.delete(@session_file[:file_path])
-    end
-  end
-
   describe "load" do
-   context "when session file encoding is utf8" do
+    context "when session file encoding is utf8" do
       before do
         @session_file = create_dummy_session_file('key|s:13:"テスト🍺";')
       end
+
       it "should be able to load file with internal:nil, external:utf8" do
         option = {
           :internal_encoding => nil,
           :external_encoding => "UTF-8",
         }
         session = PHPSession.new(@session_file[:dir_name], option)
-        begin
-          data = session.load(@session_file[:session_id])
-          expect(data).to eq({"key" => "テスト🍺"})
-        ensure
-          session.ensure_file_closed
-        end
+        data = session.load(@session_file[:session_id])
+        expect(data).to eq({"key" => "テスト🍺"})
       end
+
       it "should be able to load file with internal:utf8, external:utf8" do
         option = {
           :internal_encoding => "UTF-8",
           :external_encoding => "UTF-8",
         }
         session = PHPSession.new(@session_file[:dir_name], option)
-        begin
-          data = session.load(@session_file[:session_id])
-          expect(data).to eq({"key" => "テスト🍺"})
-        ensure
-          session.ensure_file_closed
-        end
+        data = session.load(@session_file[:session_id])
+        expect(data).to eq({"key" => "テスト🍺"})
       end
+
       it "should return euc-jp string with internal:euc-jp, exterenal:utf8" do
         option = {
           :internal_encoding => "EUC-JP",
           :external_encoding => "UTF-8",
-          :encoding_option => {
-            :undef => :replace
-          }
+          :encoding_option => {:undef => :replace}
         }
         session = PHPSession.new(@session_file[:dir_name], option)
-        begin
-          data = session.load(@session_file[:session_id])
-          expect(data).to eq({"key" => "テスト🍺".encode("EUC-JP", {:undef => :replace})})
-        ensure
-          session.ensure_file_closed
-        end
+        data = session.load(@session_file[:session_id])
+        expect(data).to eq({"key" => "テスト🍺".encode("EUC-JP", {:undef => :replace})})
       end
 
       after do
         File.delete(@session_file[:file_path])
       end
     end
+
     context "when session file exists" do
       before do
         @session_file = create_dummy_session_file('key|s:1:"a";')
@@ -82,12 +51,8 @@ describe PHPSession do
 
       it "should return session data" do
         session = PHPSession.new(@session_file[:dir_name])
-        begin
-          data = session.load(@session_file[:session_id])
-          expect(data).to eq({"key" => "a"})
-        ensure
-          session.ensure_file_closed
-        end
+        data = session.load(@session_file[:session_id])
+        expect(data).to eq({"key" => "a"})
       end
 
       after do
@@ -98,17 +63,13 @@ describe PHPSession do
     context "when session file dosen't exist" do
       it "should return new session data" do
         session = PHPSession.new(Dir.tmpdir)
-        begin
-          data = session.load("session_id")
-          expect(data).to eq({})
-        ensure
-          session.ensure_file_closed
-        end
+        data = session.load("session_id")
+        expect(data).to eq({})
       end
     end
   end
 
-  describe "#commit" do
+  describe "#save" do
     before do
       @session_file = create_dummy_session_file('key|s:1:"a";')
     end
@@ -122,20 +83,13 @@ describe PHPSession do
       session = PHPSession.new(@session_file[:dir_name], option)
       data = session.load(@session_file[:session_id])
       data["key"] = "テスト🍣"
-      session.commit(data)
+      session.save(@session_file[:session_id], data)
 
       # read in bytesequence mode to avoid encoding conversion
       byte_sequence = IO.read(@session_file[:file_path], File.size(@session_file[:file_path]))
       expect(byte_sequence.force_encoding('EUC-JP')).to eq('key|s:7:"テスト?";'.encode("EUC-JP"))
     end
 
-    it "should save session data even if session_file is not loaded" do
-      session = PHPSession.new(@session_file[:dir_name])
-      expect {
-        session.commit({:hoge => "nyan"})
-      }.not_to raise_error
-    end
-
     after do
       File.delete(@session_file[:file_path])
     end
@@ -145,12 +99,11 @@ describe PHPSession do
     context "when session file exists and loaded" do
       before do
         @session_file = create_dummy_session_file('key|s:1:"a";')
-        @session = PHPSession.new(@session_file[:dir_name])
-        @session.load(@session_file[:session_id])
       end
 
       it "should delete session file" do
-        @session.destroy
+        session = PHPSession.new(@session_file[:dir_name])
+        session.destroy(@session_file[:session_id])
         expect(File.exists?(@session_file[:file_path])).to eq(false)
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: php_session
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Shinpei Maruyama