stockpile_cache 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f846deab3025ca6771b8cf40a4ff55c358256164208d3dd9409667efc51aa013
+  data.tar.gz: 0d9dbe79e95be12dbbb6db1edc7f0c3e2d9d40cc9731c61362d5f415a81aaec9
+SHA512:
+  metadata.gz: c7921d065ed50ff8fab43453a2d5532d724939e55dea2f98df06e8a92ef1bbfb7b513fb87ffcf5841ac584a4a7b789220ae06ffb8e30ae6d33ef4c2469457da5
+  data.tar.gz: a61bc77c28a775e309b6f63f9af18891e54e0027e745ca58cb68fe98524cd931bc5fe1a7087bd479f8d8c1b9e557cc7797ccf309394415d83a25af589589d307

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.4
+      - image: circleci/redis
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - bundle-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: install dependencies
+          command: |
+            gem update --system
+            gem install bundler
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          key: bundle-{{ checksum "Gemfile.lock" }}
+          paths:
+            - ./vendor/bundle
+
+      - run:
+          name: rubocop
+          command: bundle exec rubocop
+
+      - run:
+          name: rspec
+          command: bundle exec rspec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--require spec_helper
+--format progress
+--profile

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at engineering@convertkit.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rubocop', '~> 0.74.0'
+end
+
+group :test do
+  gem 'rspec', '~> 3.8.0'
+end

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    stockpile_cache (1.0.0)
+      connection_pool
+      oj
+      rake
+      redis
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.3)
+    oj (3.9.1)
+    parallel (1.17.0)
+    parser (2.6.4.1)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    redis (4.1.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 3.8.0)
+  rubocop (~> 0.74.0)
+  stockpile_cache!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,135 @@
+# Stockpile [![Build Status][ci-image]][ci] [![Code Climate][codeclimate-image]][codeclimate]
+Stockpile is a simple cache written in Ruby backed by Redis. It has built in
+[cache-stampede](https://en.wikipedia.org/wiki/Cache_stampede) (also known as
+dog-piling) protection.
+
+Can be used with any Ruby or Ruby on Rails project. Can be used as a replacement for
+existing Ruby on Rails cache.
+
+Intended as a heavy usage cache to prevent concurrent execution of code when
+cache is expired that will lead to congestion collapse of your systems.
+
+Upon caching serializes cached value using [Oj](https://github.com/ohler55/oj)
+gem. While reading value from cache will deserialize value from cache using same
+gem.
+
+## How it works
+When `perform_cached` method is invoked with a key and a block of code as
+arguments Stockpile will attempt to fetch value from cache using given key. If
+no value is returned it will set a lock deferring all other requests for given
+key (for specified amount of time) and run provided block of code and storing
+it's return value at the key. After that a lock will be released allowing other
+requests to fetch their values from cache.
+
+In case there is a cache miss and an active execution lock for a given key is
+present request will go into slumber for 2 seconds (configurable by
+`STOCKPILE_SLUMBER` environment variable or by calling `slumber` method on
+configuration object). During slumber request will keep trying to read value
+from cache and if no result is returned during that time cache will be bypassed
+and value will be computed by executing passed in block.
+
+## Installation
+Add the following line to your Gemfile:
+
+```
+gem 'stockpile_cache'
+```
+And run `bundle` from your shell.
+
+To install gem manually run from your shell:
+
+```
+gem install stockpile_cache
+```
+
+## Requirements
+Only requirement to run this gem is [Redis](https://redis.io/). Other than that
+it is not dependant on any other framework or system.
+
+## Configration
+The only thing you need to set up is URL of your Redis server. You can do this
+by either setting `STOCKPILE_REDIS_URL` environment variable or by executing
+following code during runtime. For Ruby on Rails create
+`config/initializers/stockpile.rb` file and put the following code in there:
+
+```
+Stockpile.configure do |configuration|
+  configuration.redis_url = <REDIS_URL>
+end
+```
+
+There are two ways to configure Stockpile: using environment variables or
+invoking configuration block during runtime.
+
+Following settings are supported:
+
+| Variable | Method | Settings |
+| ------------- | ------------- | ------------- |
+| `STOCKPILE_CONNECTION_POOL` | `connection_pool` | Redis connection pool size to share amongst the fibers or threads in your Ruby. Defaults to `100`. |
+| `STOCKPILE_CONNECTION_TIMEOUT` | `connection_timeout`  | How long to wait for a connection from connection pool to become available (in seconds). Defaults to `3`. |
+| `STOCKPILE_LOCK_EXPIRATION` | `lock_expiration` | Time to keep execution lock alive (in seonds). Defaults to `10`. |
+| `STOCKPILE_REDIS_URL` | `redis_url` | URL of your Redis server that will be used for caching. Defaults to `redis://localhost:6379/1`. |
+| `STOCKPILE_REDIS_SENTINELS` | `sentinels` | (optional) Comma separated list of Sentinels IPs for Redis. Defaults to `nil`. Example value: `8.8.8.8:42,8.8.4.4:42`. |
+| `STOCKPILE_SLUMBER` | `slumber` | Timeout (in seconds) for stampede protection lock. After timeout passed in code will be executed instead of reading a value from cache. Defaults to `2`. |
+
+## Usage
+To use simply wrap your code into `perform_cached` block:
+
+```
+Stockpile.perform_cached(key: 'meaning_of_life', ttl: 42) do
+  21 + 21
+end
+```
+
+`perform` method accepts 3 named arguments:
+
+| Argument | Meaning |
+| ------------- | ------------- |
+| `key` | Pointer in cache by which a value will be either looked up or stored in cache once code provided in block is executed. |
+| `ttl` | (optional) Time in seconds for which a cached value will be stored. Defaults to 300 seconds (5 minutes). |
+| `&block` | Block of code to execute; it's return value will be stored in cache. |
+
+## Caveats
+There is no timeout or rescue set for code you will be running through the cache. If
+you need to do either you have to handle it outside of Stockpile.
+
+Locks are never set indefinitely and by default will expire after 10 seconds
+allowing next request to trigger cache recalculation. Lock duration is
+configurable by either setting `STOCKPILE_LOCK_EXPIRATION` environment variable
+or by calling `slumber` method on configuration object.
+
+While there is an active lock for the key each request trying to read that key
+will wait in slumber for 2 seconds (configurable by `STOCKPILE_SLUMBER`
+environment variable or by calling `slumber` method on configuration object) and
+will bypass cache after that if no value will be set in that time.
+
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rspec` 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).
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/ConvertKit/stockpile_cache. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to adhere
+to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+The gem is available as open source under the terms of the
+[Apache License Version 2.0] (http://www.apache.org/licenses/LICENSE-2.0).
+
+## Code of Conduct
+Everyone interacting in the Stockpile project’s codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/ConvertKit/stockpile_cache/blob/master/CODE_OF_CONDUCT.md).
+
+[ci]: https://circleci.com/gh/ConvertKit/stockpile_cache
+[ci-image]: https://circleci.com/gh/ConvertKit/stockpile_cache.svg?style=svg
+[codeclimate]: https://codeclimate.com/github/ConvertKit/stockpile_cache/maintainability
+[codeclimate-image]: https://api.codeclimate.com/v1/badges/f9ca3b6dda3b492b125e/maintainability

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'bundler/setup'
+require 'stockpile'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

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

data/lib/stockpile.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+# Copyright 2019 ConvertKit, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'connection_pool'
+require 'oj'
+require 'redis'
+require 'timeout'
+
+require 'stockpile/constants'
+require 'stockpile/configuration'
+require 'stockpile/redis_connection'
+
+require 'stockpile/lock'
+require 'stockpile/locked_execution_result'
+require 'stockpile/failed_lock_execution'
+
+require 'stockpile/cache'
+require 'stockpile/cached_value_reader'
+
+require 'stockpile/executor'
+
+# = Stockpile
+#
+# Simple cache with Redis as a backend and a built in cache-stampede
+# protection. For more information on general usage consider consulting
+# README.md file.
+#
+# While interacting with the cache from within your application
+# avoid re-using anything after :: notation as it is part of internal API
+# and is subject to an un-announced breaking change.
+#
+# Stockpile provides 5 methods as part of it's public API:
+# * configuration
+# * configure
+# * perform_cached
+# * redis
+# * redis_connection_pool
+module Stockpile
+  module_function
+
+  # Provides access to cache's configuration.
+  #
+  # @return [Configuration] the object holding configuration values
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  # API to configure cache dynamically during runtime.
+  #
+  # @yield [configuration] Takes in a block of code of code that is setting
+  #   or changing configuration values
+  #
+  # @example Configure during runtime changing redis URL
+  #   Stockpile.configure { |c| c.redis_url = 'foobar' }
+  #
+  # @return [void]
+  def configure
+    yield(configuration)
+    nil
+  end
+
+  # Attempts to fetch a value from cache (for a given key). In case of miss
+  # will execute given block of code and cache it's result at the provided
+  # key for a specified TTL.
+  #
+  # @param key [String] Key to use for a value lookup from cache or key
+  #   to store value at once it is computed
+  # @param ttl [Integer] (optional) Time in seconds to expire cache after.
+  #   Defaults to Stockpile::DEFAULT_TTL
+  #
+  # @yield [block] A block of code to be executed in case of cache miss
+  #
+  # @example Perform cache operation
+  #   Stockpile.perform_cached(key: 'meaning_of_life', ttl: 42) { 21 * 2 }
+  #
+  # @return Returns a result of block execution
+  def perform_cached(key:, ttl: Stockpile::DEFAULT_TTL, &block)
+    Stockpile::CachedValueReader.read_or_yield(key: key, ttl: ttl, &block)
+  end
+
+  # API to communicate with Redis database backing cache up.
+  #
+  # @yield [redis]
+  #
+  # @example Store a value in Redis at given key
+  #   Store.redis { |r| r.set('meaning_of_life', 42) }
+  #
+  # @return Returns a result of interaction with Redis
+  def redis
+    redis_connection_pool.with do |connection|
+      yield connection
+    end
+  end
+
+  # Accessor to connection pool. Defined on top level so it can be memoized
+  # on the topmost level
+  #
+  # @return [ConnectionPool] ConnectionPool object from connection_pool gem
+  def redis_connection_pool
+    @redis_connection_pool ||= Stockpile::RedisConnection.connection_pool
+  end
+end

data/lib/stockpile/cache.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Copyright 2019 ConvertKit, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Stockpile
+  # == Stockpile::Cache
+  #
+  # Wrapper around Stockpile.redis used for writing and reading from it; handles
+  # serialization and deserialization of data upon writes and reads.
+  module Cache
+    module_function
+
+    def get(key:)
+      value_from_cache = Stockpile.redis { |r| r.get(key) }
+      Oj.load(value_from_cache) if value_from_cache
+    end
+
+    def get_deferred(key:)
+      sleep(Stockpile::SLUMBER_COOLDOWN) until Stockpile.redis { |r| r.exists(key) }
+      value_from_cache = Stockpile.redis { |r| r.get(key) }
+      Oj.load(value_from_cache)
+    end
+
+    def set(key:, payload:, ttl:)
+      payload = Oj.dump(payload)
+      Stockpile.redis { |r| r.set(key, payload) }
+      Stockpile.redis { |r| r.expire(key, ttl) }
+    end
+  end
+end

data/lib/stockpile/cached_value_reader.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Copyright 2019 ConvertKit, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Stockpile
+  # == Stockpile::CachedValueReader
+  #
+  # Service class to wrap decision point of wether a value should be
+  # returned from cache or computed and stored in cache
+  module CachedValueReader
+    module_function
+
+    def read_or_yield(key:, ttl:, &block)
+      if (result = Stockpile::Cache.get(key: key))
+        result
+      else
+        Stockpile::Executor.perform(key: key, ttl: ttl, &block)
+      end
+    end
+  end
+end

data/lib/stockpile/configuration.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# Copyright 2019 ConvertKit, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Stockpile
+  # == Stockpile::Configuration
+  #
+  # Holds configuration for cache with writeable attributes allowing
+  # dynamic change of configuration during runtime
+  class Configuration
+    attr_accessor :connection_pool, :connection_timeout, :lock_expiration,
+                  :redis_url, :sentinels, :slumber
+
+    def initialize
+      @connection_pool = extract_connection_pool
+      @connection_timeout = extract_connection_timeout
+      @lock_expiration = extract_lock_expiration
+      @redis_url = extract_redis_url
+      @sentinels = process_sentinels
+      @slumber = extract_slumber
+    end
+
+    private
+
+    def extract_connection_pool
+      ENV.fetch(
+        'STOCKPILE_CONNECTION_POOL',
+        Stockpile::DEFAULT_CONNECTION_POOL
+      ).to_i
+    end
+
+    def extract_connection_timeout
+      ENV.fetch(
+        'STOCKPILE_CONNECTION_TIMEOUT',
+        Stockpile::DEFAULT_CONNECTION_TIMEOUT
+      ).to_i
+    end
+
+    def extract_lock_expiration
+      ENV.fetch(
+        'STOCKPILE_LOCK_EXPIRATION',
+        Stockpile::DEFAULT_LOCK_EXPIRATION
+      ).to_i
+    end
+
+    def extract_redis_url
+      ENV.fetch(
+        'STOCKPILE_REDIS_URL',
+        Stockpile::DEFAULT_REDIS_URL
+      )
+    end
+
+    def extract_slumber
+      ENV.fetch(
+        'STOCKPILE_SLUMBER',
+        Stockpile::DEFAULT_SLUMBER
+      ).to_i
+    end
+
+    def process_sentinels
+      ENV.fetch('STOCKPILE_REDIS_SENTINELS', '').split(',').map do |sentinel|
+        host, port = sentinel.split(':')
+        { host: host, port: port.to_i }
+      end
+    end
+  end
+end

data/lib/stockpile/constants.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Copyright 2019 ConvertKit, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Stockpile
+  DEFAULT_CONNECTION_POOL = 100
+  DEFAULT_CONNECTION_TIMEOUT = 3
+  DEFAULT_LOCK_EXPIRATION = 10
+  DEFAULT_REDIS_URL = 'redis://localhost:6379/1'
+  DEFAULT_SLUMBER = 2
+  DEFAULT_TTL = 60 * 5
+  LOCK_PREFIX = 'stockpile_lock::'
+  SLUMBER_COOLDOWN = 0.05
+  VERSION = '1.0.0'
+end

data/lib/stockpile/executor.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Copyright 2019 ConvertKit, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Stockpile
+  # == Stockpile::Executor
+  #
+  # Executes passed in block of code and writes computed result into cache
+  # with an expiration of a given TTL. If execution is locked will wait for
+  # value to appear in cache instead. Will timeout after given amount of time
+  # and will execute block if no value can be read from cache.
+  class Executor
+    attr_reader :key, :ttl
+
+    def self.perform(key:, ttl:, &block)
+      new(key, ttl).perform(&block)
+    end
+
+    def initialize(key, ttl)
+      @key = key
+      @ttl = ttl
+    end
+
+    def perform(&block)
+      if execution(&block).success?
+        cache_and_release_execution
+      else
+        wait_for_cache_or_yield(&block)
+      end
+    end
+
+    private
+
+    def execution
+      @execution ||= Stockpile::Lock.perform_locked(lock_key: lock_key) do
+        yield
+      end
+    end
+
+    def cache_and_release_execution
+      Stockpile::Cache.set(
+        key: key,
+        payload: execution.result,
+        ttl: ttl
+      )
+
+      execution.release_lock
+      execution.result
+    end
+
+    def lock_key
+      Stockpile::LOCK_PREFIX + key
+    end
+
+    def wait_for_cache_or_yield
+      Timeout.timeout(Stockpile.configuration.slumber) do
+        Stockpile::Cache.get_deferred(key: key)
+      end
+    rescue Timeout::Error
+      yield
+    end
+  end
+end

data/lib/stockpile/failed_lock_execution.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Copyright 2019 ConvertKit, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Stockpile
+  # == Stockpile::FailedLockExecution
+  #
+  # Dummy class to symbolize failed locked execution of code.
+  class FailedLockExecution; end
+end

data/lib/stockpile/lock.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Copyright 2019 ConvertKit, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Stockpile
+  # == Stockpile::Lock
+  #
+  # Attempts to set up exclusive lock to execute a block of code. Returns
+  # Stockpile::LockedExcutionResult holding result of execution. If lock
+  # can not be established (someone else is executing the code) then
+  # Stockpile::LockedExcutionResult will hold Stockpile::FailedLockExecution
+  # as a result of execution
+  class Lock
+    attr_reader :lock_key
+
+    def self.perform_locked(lock_key:, &block)
+      new(lock_key).perform_locked(&block)
+    end
+
+    def initialize(lock_key)
+      @lock_key = lock_key
+    end
+
+    def perform_locked(&block)
+      if lock
+        successful_execution(&block)
+      else
+        failed_execution
+      end
+    end
+
+    private
+
+    def failed_execution
+      Stockpile::LockedExcutionResult.new(result: failed_lock, lock_key: lock_key)
+    end
+
+    def failed_lock
+      Stockpile::FailedLockExecution.new
+    end
+
+    def lock
+      Stockpile.redis { |r| r.set(lock_key, 1, nx: true, ex: Stockpile.configuration.lock_expiration) }
+    end
+
+    def successful_execution
+      Stockpile::LockedExcutionResult.new(result: yield, lock_key: lock_key)
+    end
+  end
+end

data/lib/stockpile/locked_execution_result.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Copyright 2019 ConvertKit, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Stockpile
+  # == Stockpile::LockedExcutionResult
+  #
+  # Wrapper containing result of locked execution
+  class LockedExcutionResult
+    attr_reader :lock_key, :result
+
+    def initialize(lock_key:, result:)
+      @lock_key = lock_key
+      @result = result
+    end
+
+    def release_lock
+      Stockpile.redis { |r| r.expire(lock_key, 0) }
+    end
+
+    def success?
+      !result.is_a?(Stockpile::FailedLockExecution)
+    end
+  end
+end

data/lib/stockpile/redis_connection.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Copyright 2019 ConvertKit, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Stockpile
+  # == Stockpile::RedisConnection
+  #
+  # Wrapper around ConnectionPool and Redis to provide connectivity
+  # to Redis with desired configuration and sane connection pool
+  module RedisConnection
+    module_function
+
+    def connection_pool
+      @connection_pool = ConnectionPool.new(connection_pool_options) do
+        Redis.new(connection_options)
+      end
+    end
+
+    def connection_options
+      { url: redis_url,
+        sentinels: sentinels }
+    end
+
+    def connection_pool_options
+      { size: pool_size,
+        timeout: connection_timeout }
+    end
+
+    def connection_timeout
+      Stockpile.configuration.connection_timeout
+    end
+
+    def pool_size
+      Stockpile.configuration.connection_pool
+    end
+
+    def redis_url
+      Stockpile.configuration.redis_url
+    end
+
+    def sentinels
+      Stockpile.configuration.sentinels
+    end
+  end
+end

data/lib/stockpile_cache.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'stockpile'

data/stockpile-cache.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'stockpile/constants'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'stockpile_cache'
+  spec.version       = Stockpile::VERSION
+  spec.authors       = ['ConvertKit, LLC']
+  spec.email         = ['engineering@convertkit.com']
+
+  spec.summary       = 'Simple Redis based cache'
+  spec.description   = 'Cache with cache-stampede protection'
+  spec.homepage      = 'https://convertkit.com'
+  spec.license       = 'Apache License Version 2.0'
+
+  spec.files = `git ls-files | grep -Ev '^(spec)'`.split("\n")
+
+  spec.executables = ['console']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'connection_pool'
+  spec.add_dependency 'oj'
+  spec.add_dependency 'rake'
+  spec.add_dependency 'redis'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: stockpile_cache
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ConvertKit, LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-12 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: oj
+  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: rake
+  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'
+description: Cache with cache-stampede protection
+email:
+- engineering@convertkit.com
+executables:
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/stockpile.rb
+- lib/stockpile/cache.rb
+- lib/stockpile/cached_value_reader.rb
+- lib/stockpile/configuration.rb
+- lib/stockpile/constants.rb
+- lib/stockpile/executor.rb
+- lib/stockpile/failed_lock_execution.rb
+- lib/stockpile/lock.rb
+- lib/stockpile/locked_execution_result.rb
+- lib/stockpile/redis_connection.rb
+- lib/stockpile_cache.rb
+- stockpile-cache.gemspec
+homepage: https://convertkit.com
+licenses:
+- Apache License Version 2.0
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Simple Redis based cache
+test_files: []