persistent-cache-storage-sqlite 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69bfd51c30b5d12fe63503a76e7f944aa43df6be
+  data.tar.gz: 05bd972a027eb0aeb6db6a5d8c3608d5d1563ff6
+SHA512:
+  metadata.gz: 3c0c402494d4bf3d84c06e396ea238d3728f210df12ff90188b02d49cb75b13735de836cc4118e7934234b529bd5dd5bb0084a772b02d7582bc3576f9829a60e
+  data.tar.gz: e984e9874264abd53b97a0ca9fe8a029119fc09469d3b47188be70c95cbbbe063ee7d6fa2a493031bf85942028514a4389615e4f3272a3f1c267b6b7dbc07909

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-sqlite

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-storage-sqlite.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,46 @@
+# Persistent::Cache::StorageSQLite
+
+This gem provides a SQLite storage 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-sqlite'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install persistent-cache-storage-sqlite
+
+## Usage
+
+Updates to the cache are written to the sqlite3 storage, with SQL driver timeout set to 30 seconds.
+
+Tell Persistent::Cache to use this provider so:
+
+    require 'persistent-cache/storage_sqlite'
+    require 'persistent-cache'
+
+    freshness = nil # forever or freshness in seconds
+    cache = Persistent::Cache.new('sqlite-cache-name', freshness, Persistent::Cache::STORAGE_SQLITE)
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/evangraan/persistent-cache-storage-sqlite. This gem was sponsored by Hetzner (Pty) Ltd - http://hetzner.co.za
+
+## 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/storage/sqlite"
+
+# 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_sqlite.rb

@@ -0,0 +1,99 @@
+require 'persistent-cache/storage_api'
+require 'persistent-cache/version'
+require "sqlite3"
+require "base64"
+require "eh/eh"
+
+module Persistent
+  class StorageSQLite < Persistent::Cache::StorageApi::API
+    DB_TABLE = "key_value" unless defined? DB_TABLE; DB_TABLE.freeze
+    DB_TIMEOUT = 30000 unless defined? DB_TIMEOUT; DB_TIMEOUT.freeze
+
+    attr_accessor :storage_details
+    attr_accessor :storage_handler
+
+    def initialize(storage_details)
+      raise ArgumentError.new("Storage details not provided") if storage_details.nil? or storage_details == ""
+      @storage_details = storage_details
+      @storage_handler = connect_to_database
+      @storage_handler.busy_timeout = 30000
+    end
+
+    def save_key_value_pair(key, value, timestamp = nil)
+      delete_entry(key)
+      time_entry = timestamp.nil? ? Time.now.to_s : timestamp.to_s
+      EH::retry!(:args => [serialize(key), serialize(value), time_entry]) do
+        @storage_handler.execute("INSERT INTO #{DB_TABLE} (key, value, timestamp) VALUES(?, ?, ?)",serialize(key), serialize(value), time_entry)
+      end
+    end
+
+    def lookup_key(key)
+      EH::retry!(:args => [serialize(key)]) do
+        result = @storage_handler.execute("SELECT value, timestamp FROM #{DB_TABLE} WHERE key=?", serialize(key))
+        !result.nil? && !result.empty? ? [deserialize(result[0][0]), result[0][1]] : nil
+      end
+    end
+
+    def delete_entry(key)
+      EH::retry!(:args => [serialize(key)]) do
+        @storage_handler.execute("DELETE FROM #{DB_TABLE} WHERE key=?", serialize(key))
+      end
+    end
+
+    def size
+      EH::retry!(:args => []) do
+        @storage_handler.execute("SELECT value FROM #{DB_TABLE}").size
+      end
+    end
+
+    def keys
+      EH::retry!(:args => []) do
+        @storage_handler.execute("SELECT key FROM #{DB_TABLE}").collect { |k| deserialize(k[0]) }
+      end
+    end
+
+    def clear
+      EH::retry!(:args => []) do
+        @storage_handler.execute("DELETE FROM #{DB_TABLE}")
+      end
+    end
+
+    private
+
+    def serialize(data)
+      Base64.encode64(Marshal.dump(data))
+    end
+
+    def deserialize(data)
+      Marshal.load(Base64.decode64(data))
+
+      rescue TypeError => ex
+        Marshal.load(data)
+    end
+
+    def connect_to_database
+      File.exists?(@storage_details) ? open_database : create_database
+    end
+
+    def open_database
+      EH::retry!(:args => []) do
+        SQLite3::Database.open(@storage_details)
+      end
+    end
+
+    def create_database
+      EH::retry!(:args => []) do
+        @storage_handler = SQLite3::Database.new(@storage_details)
+        create_table
+      end
+      @storage_handler
+    end
+
+    def create_table
+      EH::retry!(:args => []) do
+        @storage_handler.execute("CREATE TABLE #{DB_TABLE}(key TEXT PRIMARY KEY, value TEXT, timestamp TEXT)")
+      end
+      @storage_handler
+    end
+  end
+end

data/lib/persistent-cache/version.rb

@@ -0,0 +1,9 @@
+module Persistent
+  module Cache
+    module Storage
+      module Sqlite
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

data/persistent-cache-storage-sqlite.gemspec

@@ -0,0 +1,28 @@
+# 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-sqlite"
+  spec.version       = Persistent::Cache::Storage::Sqlite::VERSION
+  spec.authors       = ["Ernst Van Graan"]
+  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+
+  spec.summary       = %q{Provides a SQLite storage back-end to Persistent::Cache}
+  spec.description   = %q{Provides a SQLite storage back-end to Persistent::Cache}
+  spec.homepage      = "https://github.com/evangraan/persistent-cache-storage-sqlite"
+  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"
+  spec.add_dependency 'sqlite3', '1.3.10'
+  spec.add_dependency "persistent-cache-storage-api"  
+  spec.add_dependency 'eh'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: persistent-cache-storage-sqlite
+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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: persistent-cache-storage-api
+  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: eh
+  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: Provides a SQLite storage back-end to Persistent::Cache
+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_sqlite.rb
+- lib/persistent-cache/version.rb
+- persistent-cache-storage-sqlite.gemspec
+homepage: https://github.com/evangraan/persistent-cache-storage-sqlite
+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: Provides a SQLite storage back-end to Persistent::Cache
+test_files: []