redis_session 0.1.6

data/lib/redis_session.rb

@@ -0,0 +1,268 @@
+#The MIT License (MIT)
+#
+# Copyright (c) 2012 Ido Kanner
+#
+# 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.
+
+begin
+  require 'redis'
+rescue
+  require 'rubygems'
+  require 'redis'
+end
+
+   ##
+   #
+   # A session module
+   # 
+   
+module Session
+
+    ##
+    #
+    # == Example:
+    #   
+    #   require 'redis_session'
+    #   session = Session::SessionClient.new(:prefix => 'example', :host => '10.0.0.31')
+    #   
+    #   session.save('key', 'value') # save key with the value of value without expire, return true if successful
+    #   puts session.restore('key')  # will return "value"
+    #   
+    #   session.save('self_destruct', 'in', 10) # save the key self_destruct with the value of 'in', and will terminates in 10 seconds
+    #   sleep 10.1
+    #   session.restore('self_destruct')      # returns empty hash
+    #   session.restore('self_destruct', nil) # returns default value of nil
+    #   
+    #   session.save('boom', { :bomb => 'ball' }, 10) # saving a ruby object
+    #   puts session.ttl('boom') # should return the seconds left to the key to live or -1
+    #   
+    #   session.expire('key', 60)   # the key will be gone in 60 seconds
+    #   puts session.restore('key') # prints 'value'
+    #   
+    #   puts 'has value' if session.value? 'key' # check if key has a value
+    #   
+    #   session.delete('key')       # deleted it before time :)
+    #                               # it's alias to remove
+    #   
+    #   puts 'still here' if session.key? 'key' # do we have the key ?
+    #
+
+  class SessionClient
+    
+    ##
+    #
+    # Creates an object of SessionClient
+    #
+    # ==== Parameters
+    # :host:: the ip address or host name of the redis server default localhost
+    # :path:: the path to unix socket of redis (instead of :host)
+    # :port:: the port number for the host - default 6379
+    # :db:: the Redis database number - default 0
+    # :prefix:: a prefix string for storing and retriving information
+    # :expire:: global expiry of keys in seconds
+    #
+
+    def initialize(options={})
+      raise ArgumentError, 'options must be Hash' unless options.kind_of? Hash
+
+      options[:host]   ||= 'localhost' unless options[:path]
+      options[:port]   ||= 6379
+      options[:db]     ||= 0
+      options[:prefix] ||= ''
+      options[:expire] ||= 0
+
+      @options = options
+      @redis   = Redis.new(@options)
+    end
+
+    ##
+    #
+    # Getting the prefix name
+    #
+    # returns:: The prefix string
+    #
+
+    def prefix
+      @options[:prefix]
+    end
+
+    ##
+    #
+    # Changing the prefix string _(will not effect existing keys)_
+    #
+    # prefix:: The new prefix to be set
+    #
+    
+    def prefix=(prefix)
+      @options[:prefix] = prefix
+    end
+
+    ##
+    #
+    # Saving a key with a value
+    #
+    # key:: the name of the key to be saved
+    # value:: the value to save. Can be any Ruby object
+    # ttl:: expiry time to the key. Default nil.
+    #
+    # returns:: true if successful or false otherwise 
+    #
+    # *Note*:: If expire was set and ttl is nil, then the key will have expire by the :expire option
+    #
+
+    def save(key, value, ttl = nil)
+      a_key  = make_key(key)
+      a_data = Marshal.dump(value)
+      ttl ||= @options[:expire]
+      if ttl > 0
+        @redis.setex(a_key, ttl, a_data)
+      else
+        @redis.set(a_key, a_data)
+      end
+      true
+    rescue
+      false
+    end
+
+    ##
+    #
+    # Restoring a key's value or providing a default value instead
+    #
+    # key:: The name of the key to restore
+    # default:: The value to provide if no value was given. Default empty Hash
+    #
+    # returns:: The value of the key or default value
+    #
+
+    def restore(key, default={})
+      a_key = make_key(key)
+      data  = @redis.get(a_key)
+      data.nil? ? default : Marshal.load(data)
+    rescue
+      default
+    end
+
+    ##
+    #
+    # Set an expire time in seconds to a key. If the key already has an expire time, it reset it to a new time.
+    #
+    # key:: The name of the key to set the expire time
+    # ttl:: The time in seconds to expire the key
+    #
+    # returns:: true if successful or false if not
+    #
+
+    def expire(key, ttl)
+      a_key = make_key(key)
+      @redis.expire(a_key, ttl)
+    rescue
+      false
+    end
+
+    ##
+    #
+    # Examines how much time left to a key in seconds
+    #
+    # key:: The name of a key to check the ttl
+    # 
+    # returns:: Returns the number of seconds left, or -1 if key does not exists or no ttl exists for it
+    #
+
+    def ttl(key)
+      a_key = make_key(key)
+      @redis.ttl(a_key)
+    rescue
+      -1
+    end
+
+    ##
+    #
+    # Deleting a key from the session
+    #
+    # key:: The name of the key to be removed
+    #
+    # returns:: true if successful or false otherwise
+    #
+
+    def remove(key)
+      a_key = make_key(key)
+      @redis.del(a_key)
+    rescue
+      false
+    end
+
+    ##
+    #
+    # Check to see if a key exists
+    #
+    # key:: The name of the key to check
+    #
+    # returns:: true if it exists or false otherwise
+    #
+
+    def key?(key)
+      a_key = make_key(key)
+      @redis.exists a_key
+    rescue
+      false
+    end
+    
+    ##
+    #
+    # Check if a key has a value
+    #
+    # key:: The name of the key to check
+    #
+    # returns:: true if exists or false otherwise
+    #
+
+    def value?(key)
+      a_key = make_key(key)
+      @redis.get(a_key) != nil
+    rescue
+      false
+    end
+
+    ##
+    #
+    # Deleting a key from the session
+    #
+    # key:: The name of the key to be removed
+    #
+    # returns:: true if successful or false otherwise
+    #
+
+    alias :delete :remove
+
+    private
+      ##
+      #
+      # Generate a key with a prefix string
+      #
+      # key:: The name of the key to generate
+      #
+      # returns:: the key with the prefix
+      #
+      
+      def make_key(key)
+        "#{@options[:prefix]}#{key}"
+      end
+  end
+end
+

data/license

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2012 Ido Kanner
+
+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/redis_session.gemsepc

@@ -0,0 +1,23 @@
+
+Gem::Specification.new do |s|
+  s.name        = 'redis_session'
+  s.version     = '0.1.6'
+  s.homepage    = 'https://github.com/ik5/redis_session'
+  s.summary     = 'A session handler using Redis DB'
+  s.description = <<EOF
+A session like handler of data using the Redis Database.
+The session is built with mindset that non web applications
+can use it just as well as web applications.
+EOF
+
+  s.files            = Dir.glob('lib/**rb') + 
+                       ['redis_session.gemsepc', 'license' ]
+  s.authors          = ['Ido Kanner']
+  s.licenses         = 'MIT'
+  s.email            = 'idokan@gmail.com'
+  s.test_files       = Dir.glob('spec/*rb')
+  s.add_dependency('redis')
+  s.add_development_dependency('rspec')
+
+end
+

data/spec/add_restore_spec.rb

@@ -0,0 +1,113 @@
+require 'redis_session'
+
+describe Session::SessionClient do
+  before do
+   @session = Session::SessionClient.new(:prefix => 'add_test')
+  end
+  after do
+    @session.remove('name')
+  end
+
+  context 'With no values' do
+    it 'should return empty hash' do
+      @session.restore('name').length.should equal(0)
+    end
+  end
+
+  context 'With saving values' do
+    it 'should restore the "name" with "session"' do
+      @session.save('name', { 'name' => 'session'})
+      restored = @session.restore('name')
+      restored.class.should equal Hash and restored.should eq({'name' => 'session'})
+    end
+  end
+
+  context 'Having restoring non existed value with default' do
+    it 'should have value of false' do
+      val = @session.restore('non_existed', false)
+      val.should == false
+    end
+
+    it 'should not have value of true' do
+      val = @session.restore('non_existed', false)
+      val.should_not == true
+    end
+  end
+
+  context 'Checking if key and values exists' do
+    it 'should have existed key' do
+      @session.save('name', 1)
+      key = @session.key? 'name'
+      key.should == true
+    end
+
+    it 'should have non exited key' do
+      key = @session.key? 'no_key'
+      key.should == false
+    end
+
+    it 'should have existed value' do
+      @session.save('name', 1)
+      value = @session.value?('name')
+      value.should == true
+    end
+
+    it 'should not have value' do
+      value = @session.value? 'no_key'
+      value.should == false
+    end
+  end
+
+  context 'Dealing with prefix' do
+    it 'should return the prefix' do
+     prefix = @session.prefix
+     prefix.should == 'add_test'
+    end
+
+    it 'should change the prefix' do
+      orig_prefix = @session.prefix
+      @session.prefix = orig_prefix + '_'
+      prefix = @session.prefix
+      prefix.should == orig_prefix + '_'
+      @session.prefix = orig_prefix
+    end
+  end
+
+  context 'Working with expire' do
+    it 'should have ttl of 5 seconds when saving' do
+      @session.save('with_ttl', 1, 5)
+      ttl = @session.ttl('with_ttl')
+      ttl.should == 5
+    end
+
+    it 'ttl should not be set' do
+      @session.save('no_ttl', 1)
+      ttl = @session.ttl('no_ttl')
+      ttl.should == -1
+    end
+
+    it 'should have ttl of 5 seconds when expiring' do
+      @session.save('no_ttl', 1)
+      @session.expire('no_ttl', 5)
+      ttl = @session.ttl('no_ttl')
+      ttl.should == 5
+    end
+
+    it 'save with ttl, should not exists after 5 seconds' do
+      @session.save('with_ttl', 1, 5)
+
+      sleep 5.1
+      val = @session.value?('with_ttl')
+      val.should == false
+    end
+
+    it 'expire with of 5 seconds, should not exists after it' do
+      @session.save('no_ttl', 1)
+      @session.expire('no_ttl', 5)
+      sleep 5.1
+      val = @session.value?('no_ttl')
+      val.should == false
+    end
+  end
+
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: redis_session
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+  prerelease: 
+platform: ruby
+authors:
+- Ido Kanner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'A session like handler of data using the Redis Database.
+
+  The session is built with mindset that non web applications
+
+  can use it just as well as web applications.
+
+'
+email: idokan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/redis_session.rb
+- redis_session.gemsepc
+- license
+- spec/add_restore_spec.rb
+homepage: https://github.com/ik5/redis_session
+licenses:
+- MIT
+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.23
+signing_key: 
+specification_version: 3
+summary: A session handler using Redis DB
+test_files:
+- spec/add_restore_spec.rb
+has_rdoc: