rails_kvs_driver 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbaf6fd75ff39b74ea85707b45a3500cca71e3a8
+  data.tar.gz: d2b015e79daa282a8fd27c29b393d19506c6a078
+SHA512:
+  metadata.gz: 6648bdb2a961f6c47cef36b5c7b5d51b88a66a1a4efe7749b1c8341c5f8242ecfb1938d28b791b3ff24858f8ade7adcb2a2eabdabb399e0c5075dee44f9393f7
+  data.tar.gz: bd42ee65d4696cb8cc5914619a1615e01670788b513945cf40ec9136ba5bf6f5dcb69c66ee8387586fdd2fb1c71e70279317c7e76f1ae90e63c57427bb7cf1eb

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.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
+
+rails kvs driver wrap access key-value store.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_kvs_driver'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_kvs_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.rb

@@ -0,0 +1,246 @@
+require 'rails_kvs_driver/version'
+require 'connection_pool'
+
+module RailsKvsDriver
+  # This abstract class wrap accessing to Key-Value Store.
+  # @abstract
+  class Base
+
+    # @attr DriverConnectionPool [Hash] This Constants pools the connecting driver.
+    # {
+    #   driver_class_name => [{:config => driver_config, :pool => ConnectionPool }, ....  ]
+    #
+    #   ...
+    #
+    # }
+    DriverConnectionPool = Hash.new
+
+    # @attr @kvs_instance [Object] instance of KVS.
+    attr_accessor :kvs_instance
+
+    # @attr @driver_config [Hash] config of driver.
+    # {
+    #   :host           => 'localhost' # host of KVS.
+    #   :port           => 6379        # port of KVS.
+    #   :namespace      => 'Example'   # namespace of avoid a conflict with key
+    #   :timeout_sec    => 5           # timeout seconds.
+    #   :pool_size      => 5           # connection pool size.
+    # }
+    attr_accessor :driver_config
+
+    # initialize driver, and connect kvs.
+    # @param driver_config [Hash] driver config.
+    def initialize(driver_config)
+      @driver_config = validate_driver_config!(driver_config)
+      connect
+    end
+
+    # connect with driver config.
+    # @return [Boolean] result
+    def connect
+      raise NoMethodError
+    end
+
+    # get value from kvs.
+    # @param key [String] key.
+    # @return [String] value
+    # @abstract get value from kvs.
+    def [](key)
+      raise NoMethodError
+    end
+
+    # set value to kvs.
+    # @param key    [String] key.
+    # @param value  [String] value.
+    # @return [Boolean] result
+    # @abstract set value to kvs.
+    def []=(key, value)
+      raise NoMethodError
+    end
+
+    # get all keys from kvs.
+    # @return [Array<String>] array of key names.
+    # @abstract get all keys from kvs.
+    def all_keys
+      raise NoMethodError
+    end
+
+    # delete key from kvs.
+    # @return [Boolean] result.
+    # @abstract delete key from kvs.
+    def delete(key)
+      raise NoMethodError
+    end
+
+    # delete all keys from kvs.
+    # @return [Boolean] result.
+    # @abstract delete all keys from kvs.
+    def delete_all(key)
+      raise NoMethodError
+    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.
+    # @abstract add sorted set to kvs.
+    def add_sorted_set(key, member, score)
+      raise NoMethodError
+    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)
+      raise NoMethodError
+    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)
+      raise NoMethodError
+    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 get_sorted_set_score(key, member)
+      raise NoMethodError
+    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 get_sorted_set(key, start=0, stop=-1, reverse=false)
+      raise NoMethodError
+    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)
+      raise NoMethodError
+    end
+
+
+    # connect kvs and exec block.
+    # This function pools the connecting driver.
+    #
+    # @example
+    #   config = {
+    #     :host           => 'localhost' # host of KVS.
+    #     :port           => 6379        # port of KVS.
+    #     :namespace      => 'Example'   # namespace of avoid a conflict with key
+    #     :timeout_sec    => 5           # timeout seconds.
+    #     :pool_size      => 5           # connection pool size.
+    #   }
+    #   result = Driver.session(config) do |kvs|
+    #     kvs['example'] = 'abc'
+    #     kvs['example']
+    #   end
+    #
+    #   puts result  # => 'abc'
+    #
+    # @param driver_config [Hash] driver_config.
+    # @param &block [{|driver_instance| #something... }] exec block.
+    # @return [Object] status
+    def self.session(driver_config, &block)
+      driver_connection_pool(self, driver_config).with &block
+    end
+
+
+    private
+    # get driver connection pool
+    # if doesn't exist pool, it's made newly.
+    #
+    # @param driver_class   [RailsKvsDriver::Base]  driver_class
+    # @param driver_config  [Hash]                  driver_config
+    # @return [ConnectionPool] connection pool of driver
+    def self.driver_connection_pool(driver_class, driver_config)
+      pool = search_driver_connection_pool(driver_class, driver_config)
+      return (pool.nil?) ? set_driver_connection_pool(driver_class, driver_config) : pool
+    end
+
+    # set driver connection pool
+    #
+    # @param driver_class   [RailsKvsDriver::Base]  driver_class
+    # @param driver_config  [Hash]                  driver_config
+    # @return [ConnectionPool] connection pool of driver
+    def self.set_driver_connection_pool(driver_class, driver_config)
+      conf = {
+          size:     driver_config[:pool_size],
+          timeout:  driver_config[:timeout_sec]
+      }
+      pool = ConnectionPool.new(conf) { driver_class.new(driver_config) }
+
+      DriverConnectionPool[driver_class.name] = Array.new unless DriverConnectionPool.has_key?(driver_class.name)
+      DriverConnectionPool[driver_class.name].push({config: driver_config, pool: pool})
+
+      return pool
+    end
+
+    # search driver connection pool
+    #
+    # @param driver_class   [RailsKvsDriver::Base]  driver_class
+    # @param driver_config  [Hash]                  driver_config
+    # @return [ConnectionPool] connection pool of driver, or nil
+    def self.search_driver_connection_pool(driver_class, driver_config)
+      DriverConnectionPool[driver_class.name].each do |pool_set|
+        if pool_set[:config] == driver_config
+          return pool_set[:pool]
+        end
+      end if DriverConnectionPool.has_key?(driver_class.name)
+
+      return nil
+    end
+
+    # Validate driver_config.
+    # This method raise ArgumentError, if missing driver_config.
+    #
+    # @param driver_config [Hash] driver config.
+    # @return [Hash] driver_config
+    def validate_driver_config!(driver_config)
+      raise_argument_error!(:host)        unless driver_config.has_key? :host
+      raise_argument_error!(:port)        unless driver_config.has_key? :port
+      raise_argument_error!(:namespace)   unless driver_config.has_key? :namespace
+      raise_argument_error!(:timeout_sec) unless driver_config.has_key? :timeout_sec
+      raise_argument_error!(:pool_size)   unless driver_config.has_key? :pool_size
+
+      return driver_config
+    end
+
+    # raise argument error.
+    #
+    # @param key [String] not exists key.
+    def raise_argument_error!(key)
+      raise "driver_config does not include #{key}", ArgumentError
+    end
+  end
+end

data/lib/rails_kvs_driver/version.rb

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

data/rails_kvs_driver.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_kvs_driver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_kvs_driver"
+  spec.version       = RailsKvsDriver::VERSION
+  spec.authors       = ["alfa-jpn"]
+  spec.email         = ["a.nkmr.ja@gmail.com"]
+  spec.description   = "rails kvs driver wrap access key-value store."
+  spec.summary       = "rails kvs driver wrap access key-value store."
+  spec.homepage      = "https://github.com/alfa-jpn/rails-kvs-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 "connection_pool"
+end

data/spec/rails_kvs_driver_spec.rb

@@ -0,0 +1,150 @@
+require 'rspec'
+require 'spec_helper'
+require 'rails_kvs_driver'
+
+describe RailsKvsDriver do
+
+  before(:each) do
+    @driver_config = {
+        :host           => 'localhost', # host of KVS.
+        :port           => 6379,        # port of KVS.
+        :namespace      => 'Example',   # namespace of avoid a conflict with key
+        :timeout_sec    => 5,           # timeout seconds.
+        :pool_size      => 5,           # connection pool size.
+    }
+
+    class MockDriver < RailsKvsDriver::Base
+      def connect
+      end
+    end
+
+  end
+
+  it 'raise NoMethodError when does not override connect' do
+    expect{RailsKvsDriver::Base.new}.to raise_error
+  end
+
+  it 'raise NoMethodError when does not override []' do
+    expect{MockDriver.new.respond_to?('[]')}.to be_true
+    expect{MockDriver.new['a']}.to raise_error
+  end
+
+  it 'raise NoMethodError when does not override []=' do
+    expect{MockDriver.new.respond_to?('[]=')}.to be_true
+    expect{MockDriver.new['a']='b'}.to raise_error
+  end
+
+  it 'raise NoMethodError when does not override all_keys' do
+    expect{MockDriver.new.respond_to?(:all_keys)}.to be_true
+    expect{MockDriver.new.all_keys}.to raise_error
+  end
+
+  it 'raise NoMethodError when does not override delete' do
+    expect{MockDriver.new.respond_to?(:delete)}.to be_true
+    expect{MockDriver.new.delete}.to raise_error
+  end
+
+  it 'raise NoMethodError when does not override delete_all' do
+    expect{MockDriver.new.respond_to?(:delete_all)}.to be_true
+    expect{MockDriver.new.delete_all}.to raise_error
+  end
+
+  it 'raise NoMethodError when does not override add_sorted_set' do
+    expect{MockDriver.new.respond_to?(:add_sorted_set)}.to be_true
+    expect{MockDriver.new.add_sorted_set}.to raise_error
+  end
+
+  it 'raise NoMethodError when does not override remove_sorted_set' do
+    expect{MockDriver.new.respond_to?(:remove_sorted_set)}.to be_true
+    expect{MockDriver.new.remove_sorted_set}.to raise_error
+  end
+
+  it 'raise NoMethodError when does not override increment_sorted_set' do
+    expect{MockDriver.new.respond_to?(:increment_sorted_set)}.to be_true
+    expect{MockDriver.new.increment_sorted_set}.to raise_error
+  end
+
+  it 'raise NoMethodError when does not override get_sorted_set' do
+    expect{MockDriver.new.respond_to?(:get_sorted_set)}.to be_true
+    expect{MockDriver.new.get_sorted_set}.to raise_error
+  end
+
+  it 'raise NoMethodError when does not override count_sorted_set_member' do
+    expect{MockDriver.new.respond_to?(:count_sorted_set_member)}.to be_true
+    expect{MockDriver.new.count_sorted_set_member}.to raise_error
+  end
+
+  context 'call initialize' do
+    it 'exec validation' do
+      expect{ MockDriver.new(@driver_config) }.not_to raise_error
+    end
+
+    it 'coping instance of driver_config' do
+      expect(MockDriver.new(@driver_config).driver_config).to eq(@driver_config)
+    end
+  end
+
+  context 'call validate_driver_config' do
+    it 'raise ArgumentError when there is not host.' do
+      @driver_config.delete(:host)
+      expect{ MockDriver.new(@driver_config) }.to raise_error
+    end
+
+    it 'raise ArgumentError when there is not port.' do
+      @driver_config.delete(:port)
+      expect{ MockDriver.new(@driver_config) }.to raise_error
+    end
+
+    it 'raise ArgumentError when there is not namespace.' do
+      @driver_config.delete(:namespace)
+      expect{ MockDriver.new(@driver_config) }.to raise_error
+    end
+
+    it 'raise ArgumentError when there is not timeout_sec.' do
+      @driver_config.delete(:timeout_sec)
+      expect{ MockDriver.new(@driver_config) }.to raise_error
+    end
+
+    it 'raise ArgumentError when there is not pool_size.' do
+      @driver_config.delete(:pool_size)
+      expect{ MockDriver.new(@driver_config) }.to raise_error
+    end
+  end
+
+  context 'call session' do
+    before(:each) do
+      class MockDriver2 < RailsKvsDriver::Base
+        def connect
+        end
+      end
+    end
+
+    it 'DriverConnectionPool is same instance.' do
+      expect(MockDriver::DriverConnectionPool.equal?(RailsKvsDriver::Base::DriverConnectionPool)).to be_true
+    end
+
+    it 'to hand over driver instance to the block' do
+      MockDriver.session(@driver_config) do |instance|
+        expect(instance.class).to eq(MockDriver)
+      end
+
+      MockDriver2.session(@driver_config) do |instance|
+        expect(instance.class).to eq(MockDriver2)
+      end
+    end
+
+    it 'The structure of DriverConnectionPool is correct.' do
+      MockDriver.session(@driver_config)  {}
+      MockDriver2.session(@driver_config) {}
+      MockDriver2.session(@driver_config.merge(a:0)) {}
+      MockDriver2.session(@driver_config.merge(a:1)) {}
+
+      expect(MockDriver::DriverConnectionPool.length).to eq(2)
+      expect(MockDriver::DriverConnectionPool['MockDriver2'].length).to eq(3)
+      expect(MockDriver::DriverConnectionPool['MockDriver2'][0].length).to  eq(2)
+      expect(MockDriver::DriverConnectionPool['MockDriver2'][0].has_key? :config).to  be_true
+      expect(MockDriver::DriverConnectionPool['MockDriver2'][0].has_key? :pool).to    be_true
+    end
+
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: rails_kvs_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: connection_pool
+  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'
+description: rails kvs driver wrap access key-value store.
+email:
+- a.nkmr.ja@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_kvs_driver.rb
+- lib/rails_kvs_driver/version.rb
+- rails_kvs_driver.gemspec
+- spec/rails_kvs_driver_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alfa-jpn/rails-kvs-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: rails kvs driver wrap access key-value store.
+test_files:
+- spec/rails_kvs_driver_spec.rb
+- spec/spec_helper.rb
+has_rdoc: