reserve 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f141fe333f536dbae5929d71ebeaf1494ec6ff1
+  data.tar.gz: 425e55a52012154a1da31d770359c527002a72ef
+SHA512:
+  metadata.gz: 7245340a40f8bd78c3de35d976eceddbae0c3841b69c191f4c2f805b238374292246684c75e478bdc1f41b126739940a732a8cc559d3efec9e5b031b360d5ecf
+  data.tar.gz: 8dcb7ab8dae8c269d0d69367982a156577c83cc6378352c38c3a3f042394dd99e23d5ceb91e446fd38d734bef129e2c2128feafcd1f8a3cc0ec8e38ec37cc5f9

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+    - 2.0.0
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nick Charlton
+
+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,67 @@
+# reserve - caching library based around Redis EXPIRE
+
+[![Build Status](https://travis-ci.org/nickcharlton/reserve-ruby.svg?branch=master)](https://travis-ci.org/nickcharlton/reserve-ruby)
+[![Coverage Status](https://img.shields.io/coveralls/nickcharlton/reserve-ruby.svg)](https://coveralls.io/r/nickcharlton/reserve-ruby)
+[![Inline docs](http://inch-ci.org/github/nickcharlton/reserve-ruby.svg?branch=master)](http://inch-ci.org/github/nickcharlton/reserve-ruby)
+
+This gem provides simple object caching support using Redis.
+
+It works around the concept of "faulting"; you request an object from the
+cache and if it already exists it will return the cached object. If not, it'll
+execute the associated block to generate it instead.
+
+Using Redis' `EXPIRE` functionality, the cached object can be set to
+automatically disappear after a set period of time.
+
+## Installation
+
+Reserve isn't (yet) on [RubyGems][], so add the repo to your [Gemfile][]:
+
+```ruby
+gem 'reserve', :git => 'https://github.com/nickcharlton/reserve-ruby.git'
+```
+
+## Usage
+
+```ruby
+reserve = Reserve.new(Redis.new)
+
+# store an item with a given key
+item = reserve.store :item do
+  { value: "this is item" }
+end
+
+item # => { value: "this is item" }
+```
+
+Both `Reserve.new` and `store` accept a hash of options, but they're a little
+bit different for each:
+
+For `Reserve.new`:
+
+```ruby
+default_timeout: 3600 # the default timeout to use with store.
+key_prefix: 'reserve' # the prefix to use in Redis.
+```
+
+For `store`:
+
+```ruby
+timeout: 3600 # the timeout to use when storing this item.
+skip_cache: true # skip the cache in this invokation (great for testing).
+```
+
+## 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 a new Pull Request
+
+## Author
+
+Copyright (c) 2014 Nick Charlton <nick@nickcharlton.net>
+
+[RubyGems]: http://rubygems.org
+[Gemfile]: http://bundler.io

data/Rakefile

@@ -0,0 +1,27 @@
+##
+# Initialise Bundler, catch errors.
+##
+require 'bundler'
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+##
+# Configure the test suite.
+##
+require 'rake/testtask'
+
+Rake::TestTask.new :spec do |t|
+  t.test_files = Dir['spec/*_spec.rb']
+end
+
+##
+# By default, just run the tests.
+##
+task :default => :spec

data/lib/reserve.rb

@@ -0,0 +1,9 @@
+require "reserve/version"
+require "reserve/store"
+
+module Reserve
+  # Create a new Reserve instance.
+  def self.new redis, opts={}
+    Reserve::Store.new redis, opts
+  end
+end

data/lib/reserve/store.rb

@@ -0,0 +1,68 @@
+require 'json'
+
+module Reserve
+  class Store
+    attr_accessor :redis
+    attr_accessor :default_timeout
+    attr_accessor :key_prefix
+
+    # Returns a new instance of Store
+    #
+    # @example
+    #   item = Reserve::Store.new(Redis.new)
+    #
+    # @param redis [Object] Redis-like instance for storing items.
+    # @param [Hash] opts the options to configure a new instance.
+    # @option opts [Integer] :default_timeout The default key expiry.
+    # @option opts [String] :key_prefix The word to prefix redis keys with.
+    def initialize redis, opts={}
+      @redis = redis
+
+      @default_timeout = opts[:default_timeout] || 10800
+      @key_prefix = opts[:key_prefix] || 'reserve'
+    end
+
+    # Cache a block with a given key.
+    #
+    # @example Simple
+    #   item = reserve.store :item do
+    #     { value: 'this is item' }
+    #   end
+    #
+    # @param key [String] key to store the block under.
+    # @param [Hash] opts the options to cache the block
+    # @option opts [String] :timeout value to set the key expiry to be.
+    # @option opts [String] :skip_cache skip the cache and execute the block
+    #                         regardess of whether or not it's stored.
+    def store key, opts={}, &block
+      real_key = "#{@key_prefix}_#{key.to_s}"
+      timeout = opts[:timeout] || @default_timeout
+
+      if opts[:skip_cache]
+        return block.call
+      end
+
+      item = @redis.get real_key
+      if item
+        item = JSON.parse item, {symbolize_names: true}
+      else
+        item = block.call
+
+        @redis.pipelined do
+          @redis.set real_key, item.to_json
+          @redis.expire real_key, timeout
+        end
+      end
+
+      item
+    end
+
+    # Clears all of the stored items.
+    def clear
+      keys = @redis.keys "#{@key_prefix}*"
+      unless keys.empty?
+        @redis.del keys
+      end
+    end
+  end
+end

data/lib/reserve/version.rb

@@ -0,0 +1,3 @@
+module Reserve
+  VERSION = '1.0.0'
+end

data/reserve.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reserve/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'reserve'
+  spec.version       = Reserve::VERSION
+  spec.authors       = ['Nick Charlton']
+  spec.email         = ['nick@nickcharlton.net']
+  spec.summary       = %q{An object caching library for Redis.}
+  spec.description   = %q{An object caching library for Redis.}
+  spec.homepage      = 'https://github.com/nickcharlton/reserve-ruby'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency 'redis', '~> 3.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'mock_redis'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'yard'
+end

data/spec/reserve_spec.rb

@@ -0,0 +1,65 @@
+# test helpers
+require File.expand_path 'spec_helper.rb', __dir__
+
+describe 'Reserve Main Methods' do
+  before do
+    # use MockRedis if just testing, real redis if in CI or if USE_REDIS is set.
+    if ENV['CI'] || ENV['USE_REDIS']
+      @redis = Redis.new
+    else
+      @redis = MockRedis.new
+    end
+
+    @reserve = Reserve.new(@redis)
+  end
+
+  after do
+    @reserve.clear
+  end
+
+  it 'stores a simple object using a key' do
+    item = @reserve.store :item do
+      { value: "this is item" }
+    end
+
+    item.wont_be_nil
+    item.must_be_kind_of Hash
+    item.must_equal({value: "this is item"})
+  end
+
+  it 'sets the (default) timeout correctly on an object' do
+    item = @reserve.store :item do
+      { value: "this is item" }
+    end
+
+    item.wont_be_nil
+    item_ttl = @redis.ttl("reserve_#{:item.to_s}")
+    item_ttl.must_equal 10800
+  end
+
+  it 'works with a custom timeout' do
+    item = @reserve.store :item, timeout: 3600 do
+      { value: "this is item" }
+    end
+
+    item.wont_be_nil
+    item_ttl = @redis.ttl("reserve_#{:item.to_s}")
+    item_ttl.must_equal 3600
+  end
+
+  it 'can skip the cache with an option' do
+    standard_item = @reserve.store :item do
+      { value: "this is item" }
+    end
+
+    standard_item.wont_be_nil
+
+    clean_item = @reserve.store :item, skip_cache: true do
+      { value: "this is a different item" }
+    end
+
+    clean_item.wont_be_nil
+
+    standard_item.wont_equal clean_item
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# test coverage
+require 'coveralls'
+
+# enable coveralls
+Coveralls.wear!
+
+# test framework
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'redis'
+require 'mock_redis'
+
+# pull in the library
+require File.expand_path '../lib/reserve.rb', __dir__

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: reserve
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nick Charlton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: mock_redis
+  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: pry
+  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'
+description: An object caching library for Redis.
+email:
+- nick@nickcharlton.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/reserve.rb
+- lib/reserve/store.rb
+- lib/reserve/version.rb
+- reserve.gemspec
+- spec/reserve_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nickcharlton/reserve-ruby
+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: An object caching library for Redis.
+test_files:
+- spec/reserve_spec.rb
+- spec/spec_helper.rb
+has_rdoc: