rotary 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e616099ac3f3a34ce265d1f42e771ac374552d0f
+  data.tar.gz: 408de669b529a19ad5364aa69c5b11629f2ead6f
+SHA512:
+  metadata.gz: c7eb3a202628eea15bf889da875abe9f92d1299f52cdfbef4bb9f0b875faae1bca35af467d3a1f28f1911aa6e5c6a99af2238579d920e79d2a19bc939edee104
+  data.tar.gz: f083d93aca69e5ccded0991225f1b32ccaffbae3e6067790effeca63af4e5809d5cf24a605b28b1ab7eff7fe4dffd05b4ed29e35795906f52e72ab4327088618

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Denis Redozubov
+
+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/Rakefile

@@ -0,0 +1,29 @@
+$LOAD_PATH << File.expand_path('./lib')
+require "rotary"
+ 
+task :build do
+  system "gem build rotary.gemspec"
+end
+ 
+task :release => :build do
+  system "gem push rotary-#{Rotary::VERSION}"
+end
+
+task :console do
+  require 'pry'
+  require 'rotary'
+  ARGV.clear
+  Pry.start
+end
+task :c => :console
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "spec"
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+task :spec => :test
+task :default => :test

data/lib/rotary/serializer/marshal.rb

@@ -0,0 +1 @@
+Rotary::Serializer::Marshal = Marshal

data/lib/rotary/serializer/string.rb

@@ -0,0 +1,15 @@
+# Needed for testing. Acts as example.
+module Rotary
+  module Serializer
+    module String
+      def self.dump(value)
+        value.to_s
+      end
+
+      def self.load(value)
+        value
+      end
+    end
+  end
+end
+

data/lib/rotary/serializer.rb

@@ -0,0 +1,38 @@
+require 'rotary/serializer/string'
+require 'rotary/serializer/marshal'
+
+module Rotary::Serializer
+
+  class Error < Exception
+  end
+
+  class << self
+    def load_serializer(serializer)
+      case serializer
+      when Symbol
+        load_const(serializer)
+      else
+        unless valid?(serializer)
+          raise Rotary::Serializer::Error,
+            "#{serializer}:#{serializer.class} doesn't respond to either '.load' or '.dump'"
+        end
+        serializer
+      end
+    end
+
+    def load_const(serializer)
+      const_get("Rotary::Serializer::#{serializer.capitalize}")
+    rescue NameError
+      raise_wrong_serializer!(serializer)
+    end
+
+    def valid?(serializer)
+      serializer.respond_to?(:dump) && serializer.respond_to?(:load)
+    end
+
+    def raise_wrong_serializer!(serializer)
+      raise Rotary::Serializer::Error, "Wrong serializer #{serializer} of class #{serializer.class}"
+    end
+  end
+end
+

data/lib/rotary/storage/memory.rb

@@ -0,0 +1,26 @@
+module Rotary
+  module Storage
+    class Memory
+      def initialize(*)
+        clear
+      end
+
+      def push(session)
+        @storage.unshift(session)
+        self
+      end
+
+      def pop
+        @storage.pop
+      end
+
+      def size
+        @storage.size
+      end
+
+      def clear
+        @storage = []
+      end
+    end
+  end
+end

data/lib/rotary/storage/redis.rb

@@ -0,0 +1,66 @@
+require 'digest/sha1'
+require 'redis'
+
+module Rotary
+  module Storage
+    class Redis
+
+      class Retry < Exception
+      end
+
+      def self.default_connection
+        ::Redis.new
+      end
+
+      def initialize(connection:, ttl:, serializer:, prefix: 'rotary')
+        @redis = connection
+        @prefix = "#{prefix}::"
+        @ttl = ttl # in seconds
+        @serializer = serializer
+        @pool_list = "#{@prefix}pool"
+      end
+
+      def push(obj)
+        serialized = @serializer.dump(obj)
+        # TODO: make lpush + set/expire transactional somehow
+        @redis.lpush(@pool_list, serialized)
+        if @ttl
+          key = ttl_key(serialized)
+          @redis.multi do
+            @redis.set(key, 1)
+            @redis.expire(key, @ttl)
+          end
+        end
+        self
+      end
+
+      def pop
+        serialized = @redis.rpop(@pool_list)
+        obj = serialized ? @serializer.load(serialized) : nil
+        return obj unless @ttl
+        # TTL-only logic below
+        key = ttl_key(serialized)
+        raise Retry unless @redis.get(key)
+        @redis.del(key)
+        obj
+      rescue Retry
+        retry
+      end
+
+      def size
+        @redis.llen(@pool_list)
+      end
+
+      def clear
+        @redis.del(@pool_list)
+      end
+
+      protected
+
+      def ttl_key(obj)
+        "#{@prefix}#{Digest::SHA1.hexdigest(obj)}"
+      end
+    end
+  end
+end
+

data/lib/rotary/storage.rb

@@ -0,0 +1,17 @@
+require 'rotary/storage/memory'
+require 'rotary/storage/redis'
+
+module Rotary
+  module Storage
+
+    class Error < Exception
+    end
+
+    def self.load_storage(storage)
+      const_get("Rotary::Storage::#{storage.capitalize}")
+    rescue NameError
+      raise Rotary::Storage::Error,
+        "Wrong storage #{storage} of class #{storage.class}"
+    end
+  end
+end

data/lib/rotary/version.rb

@@ -0,0 +1,4 @@
+module Rotary
+  VERSION = '0.1.0'
+end
+

data/lib/rotary.rb

@@ -0,0 +1,69 @@
+require 'rotary/version'
+require 'rotary/storage'
+require 'rotary/serializer'
+
+module Rotary
+  SERIALIZER = :marshal
+  STORAGE = :redis
+  LIMIT = 100
+  PREFIX = 'rotary'
+  TTL = nil # must be nil or seconds
+
+  class OverflowError < Exception; end
+
+  def self.pool(**options)
+    Pool.new(**options)
+  end
+
+  class Pool
+    def initialize(
+      storage: STORAGE,
+      connection: nil,
+      serializer: SERIALIZER,
+      limit: LIMIT,
+      ttl: TTL,
+      prefix: PREFIX,
+      on_overflow: ->(obj) { raise OverflowError },
+      create: create
+    )
+      @limit = limit
+      storage_options = connection ? { connection: connection } : {}
+      @create_obj = create
+      @on_overflow = on_overflow
+      storage = Rotary::Storage.load_storage(storage)
+      @serializer = Rotary::Serializer.load_serializer(serializer)
+      @storage = storage.new(
+        connection: connection || storage.default_connection,
+        ttl: ttl,
+        serializer: @serializer,
+        prefix: prefix
+      )
+    end
+
+    def get
+      @storage.pop || @create_obj.call
+    end
+
+    # block should return object, because object could've been mutated
+    def with
+      object = get
+      object = yield(object)
+      set(object)
+    end
+
+    def size
+      @storage.size
+    end
+
+    def clear
+      @storage.clear
+    end
+
+    def set(obj)
+      return @on_overflow.call(obj) if @limit && @storage.size >= @limit
+      @storage.push(obj)
+    end
+
+  end
+end
+

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: rotary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Denis Redozubov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12.6
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+description: |2
+    Generic pool with pluggable backends for external storage. This way pool can be used by multiple application servers. It can be used to store sessions for external services.
+email: denis.redozubov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/rotary.rb
+- lib/rotary/serializer.rb
+- lib/rotary/serializer/marshal.rb
+- lib/rotary/serializer/string.rb
+- lib/rotary/storage.rb
+- lib/rotary/storage/memory.rb
+- lib/rotary/storage/redis.rb
+- lib/rotary/version.rb
+homepage: http://github.com/dredozubov/rotary
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Generic pool with pluggable backends.
+test_files: []