hitnmiss-redis_driver 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e79badb4a968f6df9e5df85ef8f4ac40c30799e2
+  data.tar.gz: 64cc756fa94c2334cf13b605393223cc118d295a
+SHA512:
+  metadata.gz: 12c42b84876f8eb3c7f1d8201e36ce09ef045b2ed427028e3e5173e89496429d846ff2a373c209750a0ffef2c1853a45045aac19ff5094acfdab623ad410118c
+  data.tar.gz: df5d260cda99a42020c821e543efbbc69fd16b3239db6f5478e4a69aa0c5310845812c1675bcbbb97ef4fad5f264fbec3ba884c329f9e42eb352359123701380

data/.codeclimate.yml

@@ -0,0 +1,10 @@
+---
+engines:
+  fixme:
+    enabled: true
+  rubcop:
+    enabled: true
+ratings:
+  paths:
+  - "lib/**/*"
+  - "**.rb"

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,6 @@
+language: ruby
+rvm:
+  - 2.2.3
+services:
+  - redis-server
+before_install: gem install bundler -v 1.11.2

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+# ChangeLog
+
+The following are lists of the notable changes included with each release.  This
+is intended to help keep people informed about notable changes between versions,
+as well as provide a rough history.  Each item is prefixed with one of the
+following labels: `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`,
+`Security`. We also use [Semantic Versioning](http://semver.org) to manage the
+versions of this gem so that you can set version constraints properly.
+
+#### [Unreleased][]
+
+#### [v1.1.0][] - 2016-07-02
+
+* Updated docs for official open source release
+
+#### [v1.0.0][] - 2016-04-12
+
+* Updated Hitnmiss dependency to 2.0
+
+#### [v0.3.0][] - 2016-03-18
+
+* Updated Hitnmiss dependency to 1.0
+
+#### [v0.2.0][] - 2016-03-17
+
+* Changed driver to implement `#all`, `#delete`, and `#clear`
+
+#### [v0.1.1][] - 2016-01-25
+
+* Fix gemspec build requirements so we can actually build the gem
+
+#### [v0.1.0][] - 2016-01-25
+
+* Add initial Minimum Viable Product version of the library
+
+[Unreleased]: https://github.com/Acornsgrow/hitnmiss-redis_driver/compare/v1.1.0...HEAD
+[v1.1.0]: https://github.com/Acornsgrow/hitnmiss-redis_driver/compare/v1.0.0...v1.1.0
+[v1.0.0]: https://github.com/Acornsgrow/hitnmiss-redis_driver/compare/v0.3.0...v1.0.0
+[v0.3.0]: https://github.com/Acornsgrow/hitnmiss-redis_driver/compare/v0.2.0...v0.3.0
+[v0.2.0]: https://github.com/Acornsgrow/hitnmiss-redis_driver/compare/v0.1.1...v0.2.0
+[v0.1.1]: https://github.com/Acornsgrow/hitnmiss-redis_driver/compare/v0.1.0...v0.1.1
+[v0.1.0]: https://github.com/Acornsgrow/hitnmiss-redis_driver/compare/6be4b1a...v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at oss@acorns.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/CONTRIBUTING.md

@@ -0,0 +1,57 @@
+# Where should I start?
+
+We recommend first starting to learn about `hitnmiss-redis_driver` by reading
+the
+[README](https://github.com/Acornsgrow/hitnmiss-redis_driver/blob/master/README.md).
+Beyond that you can explore the sections below to identify the path that best
+fits you.  **Note:** This project follows a contribution [code of
+conduct](https://github.com/Acornsgrow/hitnmiss-redis_driver/blob/master/CODE_OF_CONDUCT.md).
+
+## How can I help?
+
+There are a number of ways you can help.
+
+- Report Bugs
+- Add Feature Requests
+- Add/Update Documentation
+- Triage Bugs
+- Code Contributions
+
+### Report Bugs
+
+As a user a relatively easy way to contribute is to report bugs that you run
+into. Generally, this should be done via our
+[ISSUES](https://github.com/Acornsgrow/hitnmiss-redis_driver/issues) page.
+However, if it is a security issue please send an e-mail directly to one of the
+core authors found in the
+[gemspec](https://github.com/Acornsgrow/hitnmiss-redis_driver/blob/master/hitnmiss-redis_driver.gemspec#L10)
+rather than creating a public issue for it. This will give us some time to
+review it and resolve it before people can abuse the security flaw.
+
+### Add Feature Requests
+
+One simple way to get involved after starting to use the project is to
+contribute by adding feature requests for things that you see as gaps for the
+project. This can be done by creating an issue or our
+[ISSUES](https://github.com/Acornsgrow/hitnmiss-redis_driver/issues) page.
+
+### Add/Update Documentation
+
+You can also contribute by correcting, updating, or adding additional
+documentation. This can be done by making a pull request for documentation in
+any of our top level markdown files.
+
+### Triage Bugs
+
+Triaging bugs is also very important. This is the practice of the reviewing
+[ISSUES](https://github.com/Acornsgrow/hitnmiss-redis_driver/issues), making
+sure that the submitter provided necessary information to review the bugs, and
+classify them appropriately.
+
+### Code Contributions
+
+The most involved type of contribution you can make is to actually submit code
+to implement features, fix bugs, etc. This is done by submitting a pull request.
+See
+[DEVELOPING](https://github.com/Acornsgrow/hitnmiss-redis_driver/blob/master/DEVELOPMENT.md)
+for further details on getting started with a code contribution.

data/DEVELOPMENT.md

@@ -0,0 +1,7 @@
+# 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`.

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hitnmiss-redis_driver.gemspec
+gemspec
+
+source 'https://bpuKoa5fdZZxNCU_uJ8N@gem.fury.io/acorns/' do
+  gem 'hitnmiss', '~> 2.0', '>= 2.0.0'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Acorns Grow, Inc.
+
+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,69 @@
+[![Build Status](https://travis-ci.com/Acornsgrow/hitnmiss-redis_driver.svg?token=GGEgqzL4zt7sa3zVgspU&branch=master)](https://travis-ci.com/Acornsgrow/hitnmiss-redis_driver)
+[![Code Climate](https://codeclimate.com/repos/567a3c3140bbd1610000173b/badges/9a198fe818cfd8a5e5d6/gpa.svg)](https://codeclimate.com/repos/567a3c3140bbd1610000173b/feed)
+[![Test Coverage](https://codeclimate.com/repos/567a3c3140bbd1610000173b/badges/9a198fe818cfd8a5e5d6/coverage.svg)](https://codeclimate.com/repos/567a3c3140bbd1610000173b/coverage)
+[![Issue Count](https://codeclimate.com/repos/567a3c3140bbd1610000173b/badges/9a198fe818cfd8a5e5d6/issue_count.svg)](https://codeclimate.com/repos/567a3c3140bbd1610000173b/feed)
+
+# Hitnmiss::RedisDriver
+
+This gem provides a Redis driver for the
+[Hitnmiss](https://github.com/Acornsgrow/hitnmiss) caching library.  It
+does this so that people can easily use Redis as a cache store when
+using [Hitnmiss](https://github.com/Acornsgrow/hitnmiss).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hitnmiss-redis_driver'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hitnmiss-redis_driver
+
+## Usage
+
+You can use this driver by simply doing the following in your
+[Hitnmiss](https://github.com/Acornsgrow/hitnmiss) cache repository.
+
+
+Register the driver with `Hitnmiss` in your application using the following.
+
+```ruby
+Hitnmiss.register_driver(:redis_driver, Hitnmiss::RedisDriver.new("redis://your_redis_url"))
+```
+
+Then use the registered driver in your cache repository as follows.
+
+```ruby
+# lib/cache_repositories/most_recent_price.rb
+class MostRecentPrice
+  include Hitnmiss::Repository
+
+  driver :redis_driver
+end
+```
+
+Thats it. *Note:* Registering a driver basically creates a singleton version of
+that driver instance. So, if you want multiple redis drivers with different
+configurations you will need to register multiple instances of the redis driver.
+
+More details about how to set drivers can be found at
+[Hitnmiss](https://github.com/Acornsgrow/hitnmiss).
+
+## Contributing
+
+If you are interested in contributing to Hitnmiss. There is a guide (both code
+and general help) over in
+[CONTRIBUTING](https://github.com/Acornsgrow/hitnmiss-redis_driver/blob/master/CONTRIBUTING.md).
+
+## 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 "hitnmiss/redis_driver"
+
+# 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,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/hitnmiss-redis_driver.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hitnmiss/redis_driver-version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hitnmiss-redis_driver"
+  spec.version       = Hitnmiss::RedisDriver::VERSION
+  spec.authors       = ["Andrew De Ponte"]
+  spec.email         = ["cyphactor@gmail.com"]
+
+  spec.summary       = %q{Redis driver for Hitnmiss cache library}
+  spec.description   = %q{Redis driver for Hitnmiss cache library}
+  spec.homepage      = "https://github.com/Acornsgrow/hitnmiss-redis_driver"
+  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 "hitnmiss", "~> 2.0"
+  spec.add_dependency "redis", "~> 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+	spec.add_development_dependency "simplecov", "~> 0.11"
+	spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
+end

data/lib/hitnmiss/redis_driver-version.rb

@@ -0,0 +1,5 @@
+module Hitnmiss
+  class RedisDriver
+    VERSION = "1.1.0"
+  end
+end

data/lib/hitnmiss/redis_driver.rb

@@ -0,0 +1,90 @@
+require "hitnmiss"
+require "redis"
+require "hitnmiss/redis_driver-version"
+
+module Hitnmiss
+  class RedisDriver
+    include Hitnmiss::Driver::Interface
+
+    def initialize(redis_url)
+      @redis = Redis.new(:url => redis_url)
+    end
+
+    def set(key, entity)
+      value = { value: entity.value }
+      value[:updated_at] = internal_timestamp
+      value[:fingerprint] = entity.fingerprint if entity.fingerprint
+      value[:last_modified] = entity.last_modified if entity.last_modified
+      if entity.expiration
+        @redis.setex(key, entity.expiration, serialize_value(value))
+      else
+        @redis.set(key, serialize_value(value))
+      end
+    end
+
+    def get(key)
+      cached_item = @redis.get(key)
+      return Hitnmiss::Driver::Miss.new if cached_item.nil?
+      deserialized_value = deserialize_value(cached_item)
+      Hitnmiss::Driver::Hit.new(deserialized_value[:value], build_hit_keyword_args(deserialized_value))
+    end
+
+    def delete(key)
+      @redis.del(key)
+    end
+
+    def all(keyspace)
+      separator = Hitnmiss::Repository::KeyGeneration::KEY_COMPONENT_SEPARATOR
+      keys = get_keys("#{keyspace}#{separator}*")
+      return [] if keys.empty?
+      values = @redis.mget(*keys)
+      loaded_values = []
+      values.each do |value|
+        loaded_values << deserialize_value(value).delete(:value) unless value.nil?
+      end
+      return loaded_values
+    end
+
+    def clear(keyspace)
+      separator = Hitnmiss::Repository::KeyGeneration::KEY_COMPONENT_SEPARATOR
+      keys = get_keys("#{keyspace}#{separator}*")
+      @redis.del(*keys) unless keys.empty?
+    end
+
+    private
+
+    def internal_timestamp
+      Time.now.utc.iso8601
+    end
+
+    def get_keys(pattern)
+      keys = []
+      @redis.scan_each(match: pattern) do |key|
+        keys << key
+      end
+      return keys
+    end
+
+    def deserialize_value(value)
+      Marshal.load(value)
+    end
+
+    def serialize_value(value)
+      Marshal.dump(value)
+    end
+
+    def build_hit_keyword_args(cached_entity)
+      options = {}
+      if cached_entity.has_key?(:fingerprint)
+        options[:fingerprint] = cached_entity[:fingerprint]
+      end
+      if cached_entity.has_key?(:updated_at)
+        options[:updated_at] = Time.parse(cached_entity[:updated_at])
+      end
+      if cached_entity.has_key?(:last_modified)
+        options[:last_modified] = cached_entity[:last_modified]
+      end
+      return **options
+    end
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: hitnmiss-redis_driver
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Andrew De Ponte
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hitnmiss
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Redis driver for Hitnmiss cache library
+email:
+- cyphactor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- DEVELOPMENT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hitnmiss-redis_driver.gemspec
+- lib/hitnmiss/redis_driver-version.rb
+- lib/hitnmiss/redis_driver.rb
+homepage: https://github.com/Acornsgrow/hitnmiss-redis_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.5.1
+signing_key: 
+specification_version: 4
+summary: Redis driver for Hitnmiss cache library
+test_files: []