php-serial 0.9.0

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jorge Urias
+
+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,29 @@
+# Php::Serial
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'php-serial'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install php-serial
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end

data/lib/php-serial.rb

@@ -0,0 +1,144 @@
+require "php-serial/version"
+
+module Php
+
+  # Unserializes a PHP session
+  # 
+  # Params:
+  #   String data
+  # Returns: hash
+  def self.unserialize_session(data)
+    data = data.chomp
+    hash = {}
+    
+    while !data.empty? do
+      key = extract_until!(data, "|")
+      hash[key] = unserialize(data)
+    end
+    hash
+  end
+
+  # Unserializes a string up to the first valid serialized instance
+  # 
+  # Params:
+  #   String data
+  # Returns: mixed
+  def self.unserialize(data='')
+    var_type = data.slice!(0)
+    data.slice!(0)
+    case var_type
+      when "N"
+        value = nil
+      when "b"
+        value = (extract_until!(data, ";") == '1')
+      when "s"
+        length = extract_until!(data, ":").to_i
+        extract_until!(data, '"')
+        value = data.slice!(0,length)
+        extract_until!(data, ";")
+      when "i"
+        value = extract_until!(data, ";").to_i
+      when "d"
+        value = extract_until!(data, ";").to_f
+      when "a"
+        value = {}
+        length = extract_until!(data, ":").to_i
+        extract_until!(data, '{')
+        length.times do
+          key = unserialize(data)
+          value[key] = unserialize(data)
+        end
+        extract_until!(data, "}")
+        # if keys are sequential numbers, return array        
+        value = value.values if Array(0..value.length-1) == value.keys and !value.empty?
+      when "O"
+        value = {}
+        length = extract_until!(data, ":").to_i
+        extract_until!(data, '"')
+        value["class"] = data.slice!(0,length)
+        extract_until!(data, ':')
+        length = extract_until!(data, ":").to_i
+        extract_until!(data, '{')
+        length.times do
+          key = unserialize(data)
+          value[key] = unserialize(data)
+        end
+    end
+    value
+  end
+
+  # Serializes a hash into PHP session
+  #
+  # Params:
+  #   Hash hash
+  # Returns: string
+  def self.serialize_session(hash)
+    serialized_session = ''
+    hash.each do |key,value|
+      serialized_session += key.to_s + "|" + serialize(value)
+    end
+    serialized_session
+  end
+
+
+  # Serializes a ruby object into PHP serialized format
+  #
+  # Params:
+  #   Mixed var
+  # Returns: string
+  def self.serialize(var)
+    val = ''
+    case var.class.to_s
+      when 'NilClass'
+        val = 'N;'
+      when 'Fixnum'
+        val = 'i:' + var.to_s + ';'
+      when 'Float'
+        val = 'd:' + var.to_s + ';'
+      when 'TrueClass'
+        val = 'b:1' + ';'
+      when 'FalseClass'
+        val = 'b:0' + ';'
+      when 'String', 'Symbol'
+        val = 's:' + var.length.to_s + ':' + '"' + var.to_s + '";'
+      when 'Array'
+        val = 'a:' + var.length.to_s + ':' + '{'
+        var.length.times do |index|
+          val += serialize(index) + serialize(var[index])
+        end
+        val += '}'
+      when 'Hash'
+        val = 'a:' + var.length.to_s + ':' + '{'
+        var.each do |item_key, item_value|
+          val += serialize(item_key) + serialize(item_value)
+        end
+        val += '}'
+      else
+        klass = var.class.to_s
+        val = "O:#{klass.length.to_s}:\"#{klass}\":#{var.instance_variables.length}:{"
+        var.instance_variables.each do |ivar|
+          ivar = ivar.to_s
+          ivar.slice!(0)
+          val += serialize(ivar) + serialize(var.send(ivar))
+        end
+        val += '}'
+    end
+    val
+  end
+
+  # Return all characters up to the first occurrence of char
+  # Truncates those characters from input string
+  # 
+  # Params:
+  #   String str
+  #   String char
+  # Returns: string
+  def self.extract_until!(str, char)
+    extracted = ''
+    while (c = str.slice!(0))
+      break if c == char
+      extracted << c
+    end
+    extracted
+  end
+end

data/lib/php-serial/version.rb

@@ -0,0 +1,5 @@
+module Php
+  module Serial
+    VERSION = "0.9.0"
+  end
+end

data/php-serial.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/php-serial/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jorge Urias"]
+  gem.email         = ["jurias@gmail.com"]
+  gem.description   = %q{PHP serialization/unserialization with session support}
+  gem.summary       = %q{PHP serialization/unserialization with session support}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "php-serial"
+  gem.require_paths = ["lib"]
+  gem.version       = Php::Serial::VERSION
+end

data/test/php_serial_test.rb

@@ -0,0 +1,170 @@
+require 'test_helper'
+
+describe 'Serialize' do
+  it 'should correctly serialize strings' do
+    input = "This is a string"
+    expected = 's:16:"This is a string";'
+    Php.serialize(input).must_equal expected
+  end
+
+  it 'should correctly serialize symbols' do
+    input = "This is a symbol"
+    expected = 's:16:"This is a symbol";'
+    Php.serialize(input).must_equal expected
+  end
+
+  it 'should correctly serialize integers' do
+    input = 20
+    expected = 'i:20;'
+    Php.serialize(input).must_equal expected
+  end
+
+  it 'should correctly serialize floats' do
+    input = 3.14159
+    expected = 'd:3.14159;'
+    Php.serialize(input).must_equal expected
+  end
+
+  it 'should correctly serialize booleans' do
+    input = false
+    expected = 'b:0;'
+    Php.serialize(input).must_equal expected
+
+    input = true
+    expected = 'b:1;'
+    Php.serialize(input).must_equal expected
+  end
+
+  it 'should correctly serialize nil' do
+    input = nil
+    expected = 'N;'
+    Php.serialize(input).must_equal expected
+  end
+
+  it 'should correctly serialize arrays' do
+    input = [1,2,3,4,5]
+    expected = 'a:5:{i:0;i:1;i:1;i:2;i:2;i:3;i:3;i:4;i:4;i:5;}'
+    Php.serialize(input).must_equal expected
+  end
+
+  it 'should correctly serialize hashes' do
+    input = {a: 1, b: "string", c: nil, d: true, e: 3.14159}
+    expected = 'a:5:{s:1:"a";i:1;s:1:"b";s:6:"string";s:1:"c";N;s:1:"d";b:1;s:1:"e";d:3.14159;}'
+    Php.serialize(input).must_equal expected
+  end
+
+  it 'should correctly serialize arbitrary class objects' do
+    class Person
+      attr_accessor :first_name, :last_name
+    end
+    person = Person.new
+    person.first_name = 'John'
+    person.last_name = 'Doe'
+
+    input = person
+    expected = 'O:6:"Person":2:{s:10:"first_name";s:4:"John";s:9:"last_name";s:3:"Doe";}'
+    Php.serialize(input).must_equal expected
+  end
+end
+
+
+describe 'Unserialize' do
+  it 'should correctly unserialize strings' do
+    input = 's:16:"This is a string";'
+    expected = "This is a string"
+    Php.unserialize(input).must_equal expected
+  end
+
+  it 'should correctly unserialize symbols' do
+    input = 's:16:"This is a symbol";'
+    expected = "This is a symbol"
+    Php.unserialize(input).must_equal expected
+  end
+
+  it 'should correctly unserialize integers' do
+    input = 'i:20;'
+    expected = 20
+    Php.unserialize(input).must_equal expected
+  end
+
+  it 'should correctly unserialize floats' do
+    input = 'd:3.14159;'
+    expected = 3.14159
+    Php.unserialize(input).must_equal expected
+  end
+
+  it 'should correctly unserialize booleans' do
+    input = 'b:0;'
+    expected = false
+    Php.unserialize(input).must_equal expected
+
+    input = 'b:1;'
+    expected = true
+    Php.unserialize(input).must_equal expected
+  end
+
+  it 'should correctly unserialize nil' do
+    input = 'N;'
+    expected = nil
+    Php.unserialize(input).must_equal expected
+  end
+
+  it 'should correctly unserialize arrays' do
+    input = 'a:5:{i:0;i:1;i:1;i:2;i:2;i:3;i:3;i:4;i:4;i:5;}'
+    expected = [1,2,3,4,5]
+    Php.unserialize(input).must_equal expected
+  end
+
+  it 'should correctly unserialize hashes' do
+    input = 'a:5:{s:1:"a";i:1;s:1:"b";s:6:"string";s:1:"c";N;s:1:"d";b:1;s:1:"e";d:3.14159;}'
+    expected = {"a" => 1, "b" => "string", "c" => nil, "d" => true, "e" => 3.14159}
+    Php.unserialize(input).must_equal expected
+  end
+
+  it 'should correctly unserialize objects' do
+    input = 'O:6:"Person":2:{s:10:"first_name";s:4:"John";s:9:"last_name";s:3:"Doe";}'
+    expected = {"class" => "Person", "first_name" => "John", "last_name" => "Doe"}
+    Php.unserialize(input).must_equal expected
+  end
+end
+
+
+describe 'Serialize Session' do
+  it 'should correctly serialize a hash into a php session' do
+    input = {"a" => 1, "b" => "string", "c" => nil, "d" => true, "e" => 3.14159}
+    expected = 'a|i:1;b|s:6:"string";c|N;d|b:1;e|d:3.14159;'
+    Php.serialize_session(input).must_equal expected
+  end
+
+  it 'should correctly serialize a complex hash into a php session' do
+    input = {
+      "complex/key/A" => "A'A\";|$",
+      "complex/key/B" => [1,2,3,4,5,6,7,8,{},10],
+      "complex/key/C" => nil,
+      "complex/key/D" => {one: 1, "two" => "Two"},
+      "complex/key/E" => {index:{index:{index:{}}}}
+    }
+    expected = 'complex/key/A|s:7:"A\'A";|$";complex/key/B|a:10:{i:0;i:1;i:1;i:2;i:2;i:3;i:3;i:4;i:4;i:5;i:5;i:6;i:6;i:7;i:7;i:8;i:8;a:0:{}i:9;i:10;}complex/key/C|N;complex/key/D|a:2:{s:3:"one";i:1;s:3:"two";s:3:"Two";}complex/key/E|a:1:{s:5:"index";a:1:{s:5:"index";a:1:{s:5:"index";a:0:{}}}}'
+    Php.serialize_session(input).must_equal expected
+  end
+end
+
+describe 'Unserialize Session' do
+  it 'should correctly unserialize a php session into a hash' do
+    input = 'a|i:1;b|s:6:"string";c|N;d|b:1;e|d:3.14159;'
+    expected = {"a" => 1, "b" => "string", "c" => nil, "d" => true, "e" => 3.14159}
+    Php.unserialize_session(input).must_equal expected
+  end
+
+  it 'should correctly unserialize a complex php session' do
+    input = 'complex/key/A|s:7:"A\'A";|$";complex/key/B|a:10:{i:0;i:1;i:1;i:2;i:2;i:3;i:3;i:4;i:4;i:5;i:5;i:6;i:6;i:7;i:7;i:8;i:8;a:0:{}i:9;i:10;}complex/key/C|N;complex/key/D|a:2:{s:3:"one";i:1;s:3:"two";s:3:"Two";}complex/key/E|a:1:{s:5:"index";a:1:{s:5:"index";a:1:{s:5:"index";a:0:{}}}}'
+    expected = {
+      "complex/key/A" => "A'A\";|$",
+      "complex/key/B" => [1,2,3,4,5,6,7,8,{},10],
+      "complex/key/C" => nil,
+      "complex/key/D" => {"one" => 1, "two" => "Two"},
+      "complex/key/E" => {"index" => {"index" => {"index" => {}}}}
+    }
+    Php.unserialize_session(input).must_equal expected
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'php-serial'

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: php-serial
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Jorge Urias
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-14 00:00:00.000000000 Z
+dependencies: []
+description: PHP serialization/unserialization with session support
+email:
+- jurias@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/php-serial.rb
+- lib/php-serial/version.rb
+- php-serial.gemspec
+- test/php_serial_test.rb
+- test/test_helper.rb
+homepage: ''
+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.10
+signing_key: 
+specification_version: 3
+summary: PHP serialization/unserialization with session support
+test_files:
+- test/php_serial_test.rb
+- test/test_helper.rb