redis_session 0.1.6 → 0.1.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb9790be2c3f12dbe77b050d1a60c52895c9cc4721c99b50958fedc98fdd7f99
+  data.tar.gz: 4773c5684e9122430e0aa281a904f87e27b24e93d9fc87037763290b906eeabe
+SHA512:
+  metadata.gz: fec16987d0755e5d9c93c441181dbfe6f9aeafd185485c3bc5d9388a249f2490d2a8ade67deac1b3eae0b1eb778c1065ff39c5c84cd46e95b5dfe16e17a97913
+  data.tar.gz: d8826059dd08837b9f6ced06df8f7cdad72db7e4779139707bd38100a3c847e9635567b8675c366f100da051fa907497ac1736378e4f62d9356fea5b8c501b25

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 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/README.md

@@ -0,0 +1,71 @@
+# Redis Session 
+
+Redis\_session is a ruby based library that allow every ruby application to 
+store information using Redis.
+
+The design of the library was for disconnected non web based applications, but
+it can be used for web based applications just as well.
+
+By providing unique prefix for each session, you can distinguish between each 
+request.
+
+## Current features
+
+ * Adding prefix to each session instance
+ * Expiring keys globally or specific keys
+ * Saving keys with values, and possible to add expire time in seconds
+ * Set expire time to existing keys (updating time for already expiring keys)
+ * Restoring values, and giving default values (by default if no value, 
+   it returns an empty hash)
+ * Checking the remaining time of keys
+ * Checking if key exists
+ * Checking if key has a value
+ * Removing keys
+ * Changing the prefix using the prefix= method
+ * find key and value based on custom lookup
+
+### Documentation
+
+ The source code is using rdoc.
+
+Example:
+--------
+    require 'redis_session'
+
+    session = Session::SessionClient.new(:prefix => 'example')
+
+    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 ?
+    ret = session.scan_by do |x|
+       next unless x.kind_of? Hash
+       next unless x.key? :click
+   
+       x[:click] == true
+    end
+
+LICENSE
+-------
+The following library is brought to you using MIT license.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/redis_session.rb

@@ -20,12 +20,8 @@
 # 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
+require 'redis'
+require_relative 'redis_session/version'
 
    ##
    #
@@ -136,7 +132,9 @@ module Session
         @redis.set(a_key, a_data)
       end
       true
-    rescue
+    rescue Redis::BaseConnectionError
+      raise
+    rescue Exception
       false
     end
 
@@ -154,7 +152,9 @@ module Session
       a_key = make_key(key)
       data  = @redis.get(a_key)
       data.nil? ? default : Marshal.load(data)
-    rescue
+    rescue Redis::BaseConnectionError
+      raise
+    rescue Exception
       default
     end
 
@@ -171,7 +171,9 @@ module Session
     def expire(key, ttl)
       a_key = make_key(key)
       @redis.expire(a_key, ttl)
-    rescue
+    rescue Redis::BaseConnectionError
+      raise
+    rescue Exception
       false
     end
 
@@ -187,7 +189,10 @@ module Session
     def ttl(key)
       a_key = make_key(key)
       @redis.ttl(a_key)
-    rescue
+
+    rescue Redis::BaseConnectionError
+      raise
+    rescue Exception
       -1
     end
 
@@ -203,7 +208,10 @@ module Session
     def remove(key)
       a_key = make_key(key)
       @redis.del(a_key)
-    rescue
+
+    rescue Redis::BaseConnectionError
+      raise
+    rescue Exception
       false
     end
 
@@ -219,7 +227,10 @@ module Session
     def key?(key)
       a_key = make_key(key)
       @redis.exists a_key
-    rescue
+
+    rescue Redis::BaseConnectionError
+      raise
+    rescue Exception
       false
     end
     
@@ -235,7 +246,10 @@ module Session
     def value?(key)
       a_key = make_key(key)
       @redis.get(a_key) != nil
-    rescue
+
+    rescue Redis::BaseConnectionError
+      raise
+    rescue Exception
       false
     end
 
@@ -250,6 +264,50 @@ module Session
 
     alias :delete :remove
 
+    ##
+    #
+    # scan for partial value in redis
+    # Using a block you can create your own criteria for lookup:
+    #
+    # Example:
+    # let's say there is a key named "foo", and the value is a hash: {:click=>true, :reading=>0}
+    #
+    # ret = session.scan_by do |x|
+    #    next unless x.kind_of? Hash
+    #    next unless x.key? :click
+    #
+    #    x[:click] == true
+    # end
+    #
+    # => {"foo"=>{:click=>true, :reading=>0}}
+    #
+    # If found return a hash of key => value
+    # If not found, return nil
+    #
+    def scan_by(&block)
+      key   = ''
+      value = ''
+      @redis.keys('*').each do |x|
+        next unless @redis.type(x) == 'string'
+        
+        value = Marshal.load(@redis.get(x)) rescue next # not really a ruby object
+        if yield value
+          key   = x
+          break
+        end
+      end
+      
+      return nil if key.empty?
+      
+      { key => value }
+
+    rescue Redis::BaseConnectionError
+      raise
+    rescue Exception #=> e
+      # puts "exception: #{e}\n#{e.backtrace.join("\n")}"
+      nil
+    end
+    
     private
       ##
       #

data/lib/redis_session/version.rb

@@ -0,0 +1,4 @@
+module Session
+
+  VERSION = '0.1.11'
+end

data/redis_session.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_session/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redis_session'
+  spec.version       = Session::VERSION
+  spec.authors       = ['Ido Kanner']
+  spec.email         = ['idokan@gmail.com']
+
+  spec.summary       = 'A session handler using Redis DB'
+  spec.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
+  spec.homepage      = 'https://github.com/ik5/redis_session'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency             'redis'
+  spec.add_development_dependency 'bundler', '>= 2.2.10'
+  spec.add_development_dependency 'rake',    '>= 12.3.3'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+end

metadata

@@ -1,89 +1,112 @@
 --- !ruby/object:Gem::Specification
 name: redis_session
 version: !ruby/object:Gem::Version
-  version: 0.1.6
-  prerelease: 
+  version: 0.1.11
 platform: ruby
 authors:
 - Ido Kanner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-01-03 00:00:00.000000000 Z
+date: 2021-05-25 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.10
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.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
+        version: '3.0'
+description: |2
+                            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:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
 - lib/redis_session.rb
-- redis_session.gemsepc
+- lib/redis_session/version.rb
 - license
-- spec/add_restore_spec.rb
+- redis_session.gemspec
 homepage: https://github.com/ik5/redis_session
 licenses:
 - MIT
-post_install_message: 
+metadata: {}
+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
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
 summary: A session handler using Redis DB
-test_files:
-- spec/add_restore_spec.rb
-has_rdoc: 
+test_files: []

data/redis_session.gemsepc

@@ -1,23 +0,0 @@
-
-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

@@ -1,113 +0,0 @@
-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