rails_kvs_driver-redis_driver 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f5068e39bff48ce20cf53e9c5ccc0f97d8953115
+  data.tar.gz: f51c7417cf8ae8cf4b230230f6269a99bc7decff
+SHA512:
+  metadata.gz: 4e546a1b2d7fc2ac5af8ed89c7628cb003d9e0194b091b9476ad6e35f6a2b108d31de37ee524eeecb31198eb58dea2354032ffd21b57317b5849ac124617b218
+  data.tar.gz: 84a26af274a07d9374bdd802916ba71d2e89625333cda6beb42ac4474e8d70f0e7d9874328b16e67c6a68489d74e02ade5fa79ac61da2f54a814a68b17b07dcd

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+vendor
+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 rails_kvs_driver-redis_driver.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Atsushi Nakamura
+
+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 @@
+# RailsKvsDriver::RedisDriver
+
+Redis Driver for Rails_Kvs_Driver.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_kvs_driver-redis_driver'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_kvs_driver-redis_driver
+
+## Usage
+
+comming soon.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rails_kvs_driver/redis_driver.rb

@@ -0,0 +1,143 @@
+require "rails_kvs_driver/redis_driver/version"
+require "rails_kvs_driver"
+require "redis"
+
+module RailsKvsDriver::RedisDriver
+  class Driver < RailsKvsDriver::Base
+    # connect with driver config.
+    # @return [Boolean] result
+    def connect
+      begin
+        @kvs_inst = Redis.new(host: @driver_config[:host], port: @driver_config[:port])
+        return true
+      rescue
+        return false
+      end
+    end
+
+    # get value from kvs.
+    # @param key [String] key.
+    # @return [String] value.
+    def [](key)
+      @kvs_inst.get(safe_key(key))
+    end
+
+    # set value to kvs.
+    # @param key    [String] key.
+    # @param value  [String] value.
+    # @return [Boolean] result
+    def []=(key, value)
+      @kvs_inst.set(safe_key(key), value)
+    end
+
+    # get all keys from kvs.
+    # @return [Array<String>] array of key names.
+    def all_keys
+      result      = Array.new
+      pattern     = safe_key('*')
+      header_len  = pattern.length - 1
+
+      @kvs_inst.keys(pattern).each do |key|
+        result.push key[header_len .. -1]
+      end
+
+      return result
+    end
+
+    # delete key from kvs.
+    # @return [Boolean] result.
+    def delete(key)
+      (@kvs_inst.del(safe_key(key)) == 1)
+    end
+
+    # delete all keys from kvs.
+    # @return [Boolean] result.
+    def delete_all
+      keys    = @kvs_inst.keys(safe_key('*'))
+      del_num = @kvs_inst.del(keys) if keys.length > 0
+
+      (del_num == keys.length)
+    end
+
+    # add sorted set to kvs.
+    # when the key doesn't exist, it's made newly.
+    # @note same as sorted set of redis. refer to redis.
+    #
+    # @param key    [String]  key of sorted set.
+    # @param member [String]  member of sorted set.
+    # @param score  [Float]   score of sorted set.
+    # @return [Boolean] result.
+    def add_sorted_set(key, member, score)
+      @kvs_inst.zadd(safe_key(key), score, member)
+    end
+
+    # remove sorted set from kvs.
+    # This function doesn't delete a key.
+    # @note same as sorted set of redis. refer to redis.
+    #
+    # @param key    [String]  key of sorted set.
+    # @param member [String]  member of sorted set.
+    # @return [Boolean] result.
+    # @abstract remove sorted set from kvs.
+    def remove_sorted_set(key, member)
+      @kvs_inst.zrem(safe_key(key), member)
+    end
+
+    # increment score of member from sorted set.
+    # @note same as sorted set of redis. refer to redis.
+    #
+    # @param key    [String]  key of sorted set.
+    # @param member [String]  member of sorted set.
+    # @param score  [Float]   increment score.
+    # @return [Float] value after increment
+    # @abstract increment score of member from sorted set.
+    def increment_sorted_set(key, member, score)
+      @kvs_inst.zincrby(safe_key(key), score, member)
+    end
+
+    # get the score of member.
+    # @note same as sorted set of redis. refer to redis.
+    #
+    # @param key    [String]  key of sorted set.
+    # @param member [String]  member of sorted set.
+    # @return [Float] score of member.
+    # @abstract get the score of member.
+    def sorted_set_score(key, member)
+      @kvs_inst.zscore(safe_key(key), member)
+    end
+
+    # get array of sorted set.
+    # @note same as sorted set of redis. refer to redis.
+    #
+    # @param key      [String]  key of sorted set.
+    # @param start    [Integer] start index
+    # @param stop     [Integer] stop index
+    # @param reverse  [Boolean] order by desc
+    # @return [Array<String, Float>>] array of the member and score.
+    # @abstract get array of sorted set.
+    def sorted_set(key, start=0, stop=-1, reverse=false)
+      if reverse
+        @kvs_inst.zrevrange(safe_key(key), start, stop, with_scores: true)
+      else
+        @kvs_inst.zrange(safe_key(key), start, stop, with_scores: true)
+      end
+    end
+
+    # count members of sorted set
+    # @note same as sorted set of redis. refer to redis.
+    #
+    # @param key [String]  key of sorted set.
+    # @return [Integer] members num
+    def count_sorted_set_member(key)
+      @kvs_inst.zcard(safe_key(key))
+    end
+
+    private
+    # get safe key name with @driver_config[:namespace]
+    # @param key [String] key
+    # @return [String] safe key name
+    def safe_key(key)
+      "#{@driver_config[:namespace]}::#{key}"
+    end
+  end
+end

data/lib/rails_kvs_driver/redis_driver/version.rb

@@ -0,0 +1,5 @@
+module RailsKvsDriver
+  module RedisDriver
+    VERSION = "0.0.1"
+  end
+end

data/rails_kvs_driver-redis_driver.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_kvs_driver/redis_driver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_kvs_driver-redis_driver"
+  spec.version       = RailsKvsDriver::RedisDriver::VERSION
+  spec.authors       = ["alfa-jpn"]
+  spec.email         = ["a.nkmr.ja@gmail.com"]
+  spec.description   = "redis driver for rails kvs driver."
+  spec.summary       = "redis driver for rails kvs driver."
+  spec.homepage      = "https://github.com/alfa-jpn/rails_kvs_driver-redis_driver"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+
+  spec.add_dependency "redis"
+  spec.add_dependency "rails_kvs_driver", "0.0.2"
+end

data/spec/common_example.rb

@@ -0,0 +1,132 @@
+# How to use
+# copying #{ProjectRoot}/spec
+#
+# require "common_example"
+#
+# it_should_behave_like 'RailsKvsDriver example', driver_class, driver_config
+#
+
+shared_examples_for 'RailsKvsDriver example' do |driver_class, driver_config|
+
+  it 'inheritance RailsKvsDriver::Base' do
+    expect(driver_class.ancestors.include?(RailsKvsDriver::Base)).to be_true
+  end
+
+  context 'connect kvs' do
+    before(:each) do
+      driver_class::session(driver_config) do |kvs|
+        kvs.delete_all
+      end
+    end
+
+    after(:each) do
+      driver_class::session(driver_config) do |kvs|
+        kvs.delete_all
+      end
+    end
+
+    it 'call set value' do
+      driver_class::session(driver_config) do |kvs|
+        expect{ kvs['example'] = 'nico-nico' }.to change{ kvs.all_keys.length }.by(1)
+      end
+    end
+
+    it 'call get value' do
+      driver_class::session(driver_config) do |kvs|
+        expect{ kvs['example'] = 'nico-nico' }.to change{ kvs.all_keys.length }.by(1)
+        expect(kvs['example']).to eq('nico-nico')
+      end
+    end
+
+    it 'call all keys' do
+      driver_class::session(driver_config) do |kvs|
+        expect{ kvs['example'] = 'nico-nico' }.to change{ kvs.all_keys.length }.by(1)
+        expect(kvs.all_keys.length).to eq(1)
+      end
+    end
+
+    it 'call delete value' do
+      driver_class::session(driver_config) do |kvs|
+        kvs['example']  = 'nico-nico'
+        kvs['example2'] = 'movie'
+
+        expect{ kvs.delete('example') }.to change{ kvs.all_keys.length }.by(-1)
+
+        expect(kvs['example']).to eq(nil)
+        expect(kvs['example2']).to eq('movie')
+      end
+    end
+
+    it 'call delete_all' do
+      driver_class::session(driver_config) do |kvs|
+        kvs['example']  = 'nico-nico'
+        kvs['example2'] = 'movie'
+
+        expect{ kvs.delete_all }.to change{ kvs.all_keys.length }.by(-2)
+
+        expect(kvs['example']).to   eq(nil)
+        expect(kvs['example2']).to  eq(nil)
+      end
+    end
+
+    it 'call add_sorted_set' do
+      driver_class::session(driver_config) do |kvs|
+        expect{
+          kvs.add_sorted_set('example', 'element', 1)
+        }.to change{ kvs.all_keys.length }.by(1)
+      end
+    end
+
+    it 'call remove_sorted_set' do
+      driver_class::session(driver_config) do |kvs|
+        kvs.add_sorted_set('example', 'element', 1)
+        kvs.add_sorted_set('example', 'element2', 1)
+
+        expect{
+          kvs.remove_sorted_set('example', 'element')
+        }.to change{ kvs.count_sorted_set_member('example') }.by(-1)
+      end
+    end
+
+    it 'call increment_sorted_set' do
+      driver_class::session(driver_config) do |kvs|
+        kvs.add_sorted_set('example', 'element', 1)
+
+        expect{
+          kvs.increment_sorted_set('example', 'element', 10)
+        }.to change{ kvs.sorted_set_score('example', 'element') }.by(10)
+      end
+    end
+
+    it 'call sorted_set' do
+      driver_class::session(driver_config) do |kvs|
+        kvs.add_sorted_set('example', 'element1', 1)
+        kvs.add_sorted_set('example', 'element5', 5)
+        kvs.add_sorted_set('example', 'element2', 2)
+
+        sorted_set = kvs.sorted_set('example')
+
+        expect(sorted_set[0][0]).to eq('element1')
+        expect(sorted_set[1][0]).to eq('element2')
+        expect(sorted_set[2][0]).to eq('element5')
+      end
+    end
+
+    it 'call sorted_set_score' do
+      driver_class::session(driver_config) do |kvs|
+        kvs.add_sorted_set('example', 'element5', 5)
+        expect(kvs.sorted_set('example')[0][1]).to eq(5)
+      end
+    end
+
+    it 'call count_sorted_set_member' do
+      driver_class::session(driver_config) do |kvs|
+        kvs.add_sorted_set('example', 'element1', 5)
+        kvs.add_sorted_set('example', 'element2', 5)
+        kvs.add_sorted_set('example', 'element3', 5)
+        expect(kvs.count_sorted_set_member('example')).to eq(3)
+      end
+    end
+  end
+end
+

data/spec/rails_kvs_driver/redis_driver_spec.rb

@@ -0,0 +1,17 @@
+require 'rspec'
+require 'spec_helper'
+require 'common_example'
+
+describe RailsKvsDriver::RedisDriver::Driver do
+
+  driver_config = {
+    :host           => 'localhost',           # host of KVS.
+    :port           => 6379,                  # port of KVS.
+    :namespace      => 'SPEC::RedisDriver',   # namespace of avoid a conflict with key
+    :timeout_sec    => 5,                     # timeout seconds.
+    :pool_size      => 5                      # connection pool size.
+  }
+
+  it_should_behave_like 'RailsKvsDriver example', RailsKvsDriver::RedisDriver::Driver, driver_config
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rails_kvs_driver'
+require 'rails_kvs_driver/redis_driver'
+
+RSpec.configure do |config|
+  config.mock_framework = :rspec
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: rails_kvs_driver-redis_driver
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- alfa-jpn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails_kvs_driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+description: redis driver for rails kvs driver.
+email:
+- a.nkmr.ja@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_kvs_driver/redis_driver.rb
+- lib/rails_kvs_driver/redis_driver/version.rb
+- rails_kvs_driver-redis_driver.gemspec
+- spec/.keep
+- spec/common_example.rb
+- spec/rails_kvs_driver/redis_driver_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alfa-jpn/rails_kvs_driver-redis_driver
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: redis driver for rails kvs driver.
+test_files:
+- spec/.keep
+- spec/common_example.rb
+- spec/rails_kvs_driver/redis_driver_spec.rb
+- spec/spec_helper.rb
+has_rdoc: