persistent-cache-storage-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9eafe37996c119a0d70ec3aa45baba4d6a7f14cd
+  data.tar.gz: 4eb65e1690c5f78c620207bc7a7278d9c8b6b57c
+SHA512:
+  metadata.gz: 2b47975bcf2f513de7d94591bc6ac936359356966ff3e0c86fe3ac67d25ad522fa0f7b6658498f3454c96285476d214a48eb985e3295f3277f0f2170286b85ba
+  data.tar.gz: 18fe1c0546395cfd50dc9ab57c50e7faafb77e5e4e4afa5881c9294f653a1ddcd9c35555a4753b3ee0672242bf0e0e97467b798a54b9cf0cbbb3b18ae1eee5b9

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/.ruby-gemset

@@ -0,0 +1 @@
+persistent-cache-storage-api

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/.ruby-version-jruby

@@ -0,0 +1 @@
+jruby-9.0.4.0

data/.ruby-version-ruby

@@ -0,0 +1 @@
+ruby-2.0.0-p643

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ernst Van Graan
+
+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 @@
+# Persistent::Cache::StorageAPI
+
+This gem encodes the API that Persistent::Cache providers adhere to in order to plug in as a back-end to Persistent::Cache. Please see https://rubygems.org/gems/persistent-cache.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'persistent-cache-storage-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install persistent-cache-storage-api
+
+## Usage
+
+Create storage providers by extending this api:
+
+```
+  require 'persistent-cache-storage-api/storage_api'
+
+  module Persistent
+    class StorageDirectory < Persistent::Cache::StorageApi::API
+      def initialize(storage_details)
+        # storage_details includes connection strings, etc.
+      end
+
+      def save_key_value_pair(key, value, timestamp = nil)
+        # stores a value indexed with the key, and tagged with the timestamp
+        # provided, or the current time if timestamp is nil
+      end
+
+      def lookup_key(key)
+        # returns the value indexed at the key, or nil
+      end
+
+      def delete_entry(key)
+        # removes the key / value pair indexed at the key
+      end
+
+      def size()
+        # returns the number of keys
+      end
+
+      def keys()
+        # returns the keys in an array
+      end
+
+      def clear()
+        # removes all key / value pairs
+      end
+    end
+  end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/evangraan/persistent-cache-storage-api. This gem was sponsored by Hetzner Pty Ltd.
+
+## 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 "persistent/cache/api"
+
+# 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/lib/persistent-cache/storage_api.rb

@@ -0,0 +1,34 @@
+require "persistent-cache/version"
+
+module Persistent
+  module Cache
+    module StorageApi
+      class API
+        public 
+
+        def initialize(storage_details)
+        end
+
+        protected
+
+        def save_key_value_pair(key, value, timestamp = nil) abstract end
+
+        def lookup_key(key) abstract end
+
+        def delete_entry(key) abstract end
+
+        def size() abstract end
+
+        def keys() abstract end
+
+        def clear() abstract end
+
+        private
+
+        def abstract
+          raise NotImplementedError.new("#{self.class.name} is an abstract class.")
+        end
+      end
+    end    
+  end
+end

data/lib/persistent-cache/version.rb

@@ -0,0 +1,7 @@
+module Persistent
+  module Cache
+    module StorageApi
+      VERSION = "0.1.0"
+    end
+  end
+end

data/persistent-cache-storage-api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'persistent-cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "persistent-cache-storage-api"
+  spec.version       = Persistent::Cache::StorageApi::VERSION
+  spec.authors       = ["Ernst Van Graan"]
+  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+
+  spec.summary       = %q{This gem encodes the API that Persistent::Cache providers adhere to in order to plug in as a back-end provider.}
+  spec.description   = %q{This gem encodes the API that Persistent::Cache providers adhere to in order to plug in as a back-end provider.}
+  spec.homepage      = "https://github.com/evangraan/persistent-cache-storage-api"
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: persistent-cache-storage-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ernst Van Graan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-12 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: This gem encodes the API that Persistent::Cache providers adhere to in
+  order to plug in as a back-end provider.
+email:
+- ernst.van.graan@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".ruby-version-jruby"
+- ".ruby-version-ruby"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/persistent-cache/storage_api.rb
+- lib/persistent-cache/version.rb
+- persistent-cache-storage-api.gemspec
+homepage: https://github.com/evangraan/persistent-cache-storage-api
+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: This gem encodes the API that Persistent::Cache providers adhere to in order
+  to plug in as a back-end provider.
+test_files: []