cachext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3072a5999fa8a90d21259de13caec3f355eebdc4
+  data.tar.gz: 7ef116659a1bfa08174f3c27157752a3bdd13c8d
+SHA512:
+  metadata.gz: 1c7308ee711bb3c43522f1801fe51f6de0653057a2e6cccd7e9ae0e27be8d42e7ce5285b3287a371f1fe5b26b6ffee1e789db1a1a793ec26fdc991a7ded85489
+  data.tar.gz: 3cb8a48dcd02fac5070bb695e35064fe5562f8303265c334e8846c44bf0a358e6b011e5a63ce60dfe1ea5d61e096f5f070652668ec2dea0fe929fd29d9cf84fe

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/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Donald Plummer
+
+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,48 @@
+# Cachext
+
+Extensions to normal Rails caching:
+
+* Lock
+* Backup
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cachext'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Replace `Rails.cache.fetch` with `Cachext.fetch`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+Having trouble with a test? Set the `CACHEXT_DEBUG` environmental variable to
+"true" to get debug logs.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/dplummer/cachext.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cachext"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cachext.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cachext/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cachext"
+  spec.version       = Cachext::VERSION
+  spec.authors       = ["Donald Plummer"]
+  spec.email         = ["donald.plummer@gmail.com"]
+
+  spec.summary       = %q{Cache with lock and backup extensions}
+  spec.description   = %q{Don't calculate the cached value twice at the same time. Use a backup of the data if the service is down.}
+  spec.homepage      = "https://github.com/dplummer/cachext"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "redis"
+  spec.add_dependency "redis-namespace"
+  spec.add_dependency "redlock"
+  spec.add_dependency "faraday"
+  spec.add_dependency "dalli"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "thread"
+end

data/lib/cachext.rb

@@ -0,0 +1,39 @@
+require "cachext/version"
+require "faraday/error"
+
+module Cachext
+  autoload :Client, "cachext/client"
+  autoload :Configuration, "cachext/configuration"
+  autoload :Key, "cachext/key"
+  autoload :Features, "cachext/features"
+  autoload :Options, "cachext/options"
+
+  def self.Key raw_key
+    raw_key.is_a?(Key) ? raw_key : Key.new(raw_key)
+  end
+
+  def self.fetch raw_key, overrides = {}, &block
+    client.fetch Key(raw_key), overrides, &block
+  end
+
+  def self.clear raw_key
+    Key(raw_key).clear
+  end
+
+  def self.locked? raw_key
+    Key(raw_key).locked?
+  end
+
+  def self.client
+    @client ||= Client.new config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.flush
+    config.cache.clear
+    config.redis.del "cachext:*"
+  end
+end

data/lib/cachext/client.rb

@@ -0,0 +1,55 @@
+require "digest/sha1"
+
+module Cachext
+  class Client
+    prepend Features::DebugLogging
+    prepend Features::Lock
+    prepend Features::Backup
+    prepend Features::Default
+
+    def initialize config
+      @config = config
+    end
+
+    def fetch key, options_hash, &block
+      options = Options.new @config, options_hash
+
+      retval = read key, options
+      return retval unless retval.nil?
+
+      call_block key, options, &block
+
+    rescue *Array(options.not_found_error) => e
+      handle_not_found key, options, e
+    rescue Features::Lock::TimeoutWaitingForLock, *options.errors => e
+      handle_error key, options, e
+    end
+
+    private
+
+    def call_block key, options, &block
+      fresh = block.call
+
+      write key, fresh, options
+
+      fresh
+    end
+
+    def handle_not_found key, options, error
+      raise if options.reraise_errors
+    end
+
+    def handle_error key, options, error
+      @config.error_logger.error error
+      raise if @config.raise_errors && reraise_errors
+    end
+
+    def read key, options
+      key.read
+    end
+
+    def write key, fresh, options
+      key.write fresh, expires_in: options.expires_in
+    end
+  end
+end

data/lib/cachext/configuration.rb

@@ -0,0 +1,40 @@
+require "redlock"
+require "redis-namespace"
+
+module Cachext
+  class Configuration
+    attr_accessor :raise_errors,       # raise all errors all the time? (for tests)
+                  :default_expires_in, # in seconds
+                  :cache,              # conform to ActiveSupport::Cache interface
+                  :redis,              # redis client for locking
+                  :error_logger,       # conform to Honeybadger interface
+                  :default_errors,     # array of errors to catch and not reraise
+                  :not_found_errors,   # array of errors where we delete the backup and reraise
+                  :max_lock_wait,      # time in seconds to wait for a lock
+                  :debug,              # output debug messages to STDERR
+                  :heartbeat_expires   # time in seconds for process heardbeat to expire
+
+    def initialize
+      self.raise_errors = false
+      self.default_errors = [
+        Faraday::Error::ConnectionFailed,
+        Faraday::Error::TimeoutError,
+      ]
+      self.not_found_errors = [
+        Faraday::Error::ResourceNotFound,
+      ]
+      self.default_expires_in = 60
+      self.max_lock_wait = 5
+      self.debug = ENV['CACHEXT_DEBUG'] == "true"
+      self.heartbeat_expires = 2
+    end
+
+    def lock_manager
+      @lock_manager ||= Redlock::Client.new [lock_redis], retry_count: 1
+    end
+
+    def lock_redis
+      @lock_redis ||= Redis::Namespace.new :cachext, redis: redis
+    end
+  end
+end

data/lib/cachext/features.rb

@@ -0,0 +1,8 @@
+module Cachext
+  module Features
+    autoload :Backup, "cachext/features/backup"
+    autoload :DebugLogging, "cachext/features/debug_logging"
+    autoload :Default, "cachext/features/default"
+    autoload :Lock, "cachext/features/lock"
+  end
+end

data/lib/cachext/features/backup.rb

@@ -0,0 +1,20 @@
+module Cachext
+  module Features
+    module Backup
+      def handle_not_found key, options, error
+        key.delete_backup
+        super
+      end
+
+      def handle_error key, options, error
+        super
+        key.read_backup
+      end
+
+      def write key, fresh, options
+        super
+        key.write_backup fresh
+      end
+    end
+  end
+end

data/lib/cachext/features/debug_logging.rb

@@ -0,0 +1,50 @@
+module Cachext
+  module Features
+    module DebugLogging
+
+      private
+
+      def read key, options
+        retval = super
+        debug_log { { m: :read, key: key, retval: retval } }
+        retval
+      end
+
+      def handle_not_found key, options, error
+        debug_log { { m: :handle_not_found, key: key, error: error, reraise_errors: options.reraise_errors } }
+        super
+      end
+
+      def handle_error key, options, error
+        debug_log { { m: :handle_error, key: key, error: error } }
+        super
+      end
+
+      def obtain_lock key, options
+        lock_info = super
+        debug_log { { m: :obtain_lock, key: key }.merge(lock_info) }
+        lock_info
+      end
+
+      def wait_for_lock key, start_time
+        debug_log { { m: :wait_for_lock, key: key, waited: (Time.now - start_time) } }
+        super
+      end
+
+      def write key, fresh, options
+        super
+        debug_log { { m: :write, key: key, fresh: fresh, expires_in: options.expires_in, read: key.read } }
+      end
+
+      def debug_log
+        if @config.debug
+          Thread.exclusive do
+            log = yield
+            msg = log.is_a?(String) ? log : log.inspect
+            $stderr.puts "[#{Time.now.to_s(:db)}] [#{Process.pid} #{Thread.current.object_id.to_s(16)}] #{msg}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cachext/features/default.rb

@@ -0,0 +1,14 @@
+module Cachext
+  module Features
+    module Default
+      def handle_not_found key, options, error
+        super
+        options.default.respond_to?(:call) ? options.default.call(key) : options.default
+      end
+
+      def handle_error key, options, error
+        super || (options.default.respond_to?(:call) ? options.default.call(key) : options.default)
+      end
+    end
+  end
+end

data/lib/cachext/features/lock.rb

@@ -0,0 +1,64 @@
+module Cachext
+  module Features
+    module Lock
+      TimeoutWaitingForLock = Class.new(StandardError)
+
+      def read key, options
+        retval = super
+        return retval unless retval.nil?
+
+        @lock_info = obtain_lock key, options
+
+        retval = super
+
+        if !retval.nil?
+          @config.lock_manager.unlock @lock_info
+        end
+
+        retval
+      end
+
+      def call_block key, options, &block
+        with_heartbeat_extender key.digest, options.heartbeat_expires do
+          super
+        end
+      end
+
+      def with_heartbeat_extender lock_key, heartbeat_expires, &block
+        done = false
+        heartbeat_frequency = heartbeat_expires / 2
+
+        Thread.new do
+          loop do
+            break if done
+            sleep heartbeat_frequency
+            break if done
+            @config.lock_manager.lock lock_key, (heartbeat_expires * 1000).ceil, extend: @lock_info
+          end
+        end
+
+        block.call
+      ensure
+        @config.lock_manager.unlock @lock_info
+        done = true
+      end
+
+      def obtain_lock key, options
+        start_time = Time.now
+
+        until lock_info = @config.lock_manager.lock(key.digest, (options.heartbeat_expires * 1000).ceil)
+          wait_for_lock key, start_time
+        end
+
+        lock_info
+      end
+
+      def wait_for_lock key, start_time
+        sleep rand
+        if Time.now - start_time > @config.max_lock_wait
+          raise TimeoutWaitingForLock
+        end
+      end
+    end
+  end
+end

data/lib/cachext/key.rb

@@ -0,0 +1,60 @@
+module Cachext
+  class Key
+    attr_reader :raw
+
+    def initialize(raw, config: Cachext.config)
+      @raw = Array(raw)
+      @config = config
+    end
+
+    def inspect
+      "#<Cachext::Key:#{object_id.to_s(16)} @raw=#{@raw.inspect} digest=#{digest}>"
+    end
+
+    def digest
+      ::Digest::SHA1.hexdigest ::Marshal.dump(raw)
+    end
+
+    def backup
+      [:backup_cache] + raw
+    end
+
+    def locked?
+      lock_redis.exists digest
+    end
+
+    def read
+      cache.read raw
+    end
+
+    def write value, options = {}
+      cache.write raw, value, options
+    end
+
+    def clear
+      cache.delete raw
+    end
+
+    def read_backup
+      cache.read backup
+    end
+
+    def write_backup value
+      cache.write backup, value
+    end
+
+    def delete_backup
+      cache.delete backup
+    end
+
+    private
+
+    def cache
+      @config.cache
+    end
+
+    def lock_redis
+      @config.lock_redis
+    end
+  end
+end

data/lib/cachext/options.rb

@@ -0,0 +1,25 @@
+require "ostruct"
+module Cachext
+  class Options
+    attr_reader :expires_in,
+                :default,
+                :errors,
+                :reraise_errors,
+                :not_found_error,
+                :heartbeat_expires
+
+    def initialize config, expires_in: config.default_expires_in,
+                   default: nil,
+                   errors: config.default_errors,
+                   reraise_errors: true,
+                   not_found_error: config.not_found_errors,
+                   heartbeat_expires: config.heartbeat_expires
+      @expires_in = expires_in
+      @default = default
+      @errors = errors
+      @reraise_errors = reraise_errors
+      @not_found_error = not_found_error
+      @heartbeat_expires = heartbeat_expires
+    end
+  end
+end

data/lib/cachext/version.rb

@@ -0,0 +1,3 @@
+module Cachext
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: cachext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Donald Plummer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: 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: redis-namespace
+  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: redlock
+  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: faraday
+  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: dalli
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: 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: thread
+  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: Don't calculate the cached value twice at the same time. Use a backup
+  of the data if the service is down.
+email:
+- donald.plummer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cachext.gemspec
+- lib/cachext.rb
+- lib/cachext/client.rb
+- lib/cachext/configuration.rb
+- lib/cachext/features.rb
+- lib/cachext/features/backup.rb
+- lib/cachext/features/debug_logging.rb
+- lib/cachext/features/default.rb
+- lib/cachext/features/lock.rb
+- lib/cachext/key.rb
+- lib/cachext/options.rb
+- lib/cachext/version.rb
+homepage: https://github.com/dplummer/cachext
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Cache with lock and backup extensions
+test_files: []