elasticsearch-store 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99d989d5bd8d8dd530d6ed505b9871ccdd25c711
+  data.tar.gz: c173fe470403bc659348019f7613ae2c7dc8087d
+SHA512:
+  metadata.gz: 70ccb42f0d868fa2f1077b14edf27e38bbbc7386aa2e450065009186d35bd0319f646f552d1033d72d77c40c0aa0126970021da56166f0b375ef19d517bd5396
+  data.tar.gz: 06a24205acc45f269ee667a5c93ae331828df733c2c455d2537f9980d48f00b095d2f316e70af017e5dce9b4a1e0c144c747ad98586297bd6087d3aac9c05f01

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+*emfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,11 @@
+LineLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+rvm:
+  - "2.1.1"
+  - "2.0.0"
+  - "1.9.3"
+  - jruby-19mode # JRuby in 1.9 mode
+
+gemfile:
+  - gemfiles/3.2.gemfile
+  - gemfiles/4.0.gemfile
+  - gemfiles/4.1.gemfile
+
+install: "bundle install"
+
+services:
+  - elasticsearch
+
+script: "bundle exec rake spec"

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "rails-3.2" do
+  gem "activesupport", "~>3.2.14"
+end
+
+appraise "rails-4.0" do
+  gem "activesupport", "~>4.0.8"
+end
+
+appraise "rails-4.1" do
+  gem "activesupport", "~>4.1.4"
+end

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael Pearson
+
+MIT License
+
+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,31 @@
+# Elasticsearch::Store
+
+[![Build Status](https://travis-ci.org/mipearson/elasticsearch-store.svg)](https://travis-ci.org/mipearson/elasticsearch-store) [![Code Climate](https://codeclimate.com/github/mipearson/elasticsearch-store/badges/gpa.svg)](https://codeclimate.com/github/mipearson/elasticsearch-store)
+
+ElasticSearch-backed Ruby on Rails cache.
+
+Experimental - only tested against a single, local ES instance.
+
+Compatible with Ruby 1.9.3 & Rails 3.2 and above.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'elasticsearch-store'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/elasticsearch-store/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/elasticsearch-store.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elasticsearch/store/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elasticsearch-store"
+  spec.version       = Elasticsearch::Store::VERSION
+  spec.authors       = ["Michael Pearson"]
+  spec.email         = ["mipearson@gmail.com"]
+  spec.summary       = %q{ElasticSearch-backed Ruby on Rails cache.}
+  spec.description   = %q{}
+  spec.homepage      = "http://github.com/mipearson/elasticsearch-store"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "elasticsearch", ">1.0.0"
+  spec.add_dependency "activesupport", ">3.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">=3.0.0"
+end

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "activesupport", "~>3.2.14"
+
+gemspec :path => "../"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "activesupport", "~>4.0.8"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "activesupport", "~>4.1.4"
+
+gemspec :path => "../"

data/lib/activesupport/cache/elasticsearch_store.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+
+begin
+  require 'elasticsearch'
+rescue LoadError => e
+  $stderr.puts <<-EOF
+    You don't have elasticsearch installed in your application.
+    Please add it to your Gemfile and run bundle install.
+  EOF
+  raise e
+end
+
+require 'digest/md5'
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/hash/slice'
+require 'active_support/cache'
+
+module ActiveSupport
+  module Cache
+    # A cache store implementation which stores data in ElasticSearch:
+    # http://www.elasticsearch.org/
+    #
+    # This store is experimental and was developed against a non-clustered
+    # ElasticSearch environment.
+    class ElasticsearchStore < Store
+      # Creates a new ElasticstoreSearch object, with the given elasticsearch
+      # server addresses. The addresses and the randomize_hosts,
+      # retry_on_failure and reload_connections options are passed verbatim
+      # to Elasticsearch::Client.new.
+      #
+      # Defaults to 'localhost:9200' if no addresses are specified.
+      #
+      # Will create an index named 'cache' unless the :index_name option is
+      # specified.
+      def initialize(*addresses)
+        addresses = addresses.flatten
+        options = addresses.extract_options!
+
+        es_options = options.extract!(:retry_on_failure, :randomize_hosts, :reload_connections)
+        es_options.delete_if { |k, v| v.nil? }
+        @index_name = options.delete(:index_name) || 'cache'
+
+        if options[:namespace]
+          raise ArgumentError, ":namespace option not yet supported"
+        end
+
+        super(options)
+
+        addresses = %w(localhost:9200) if addresses.length == 0
+        es_options[:addresses] = addresses
+
+        @client = Elasticsearch::Client.new(es_options)
+        @index_created = false
+      end
+
+      # Clear the entire cache in our Elasticsearch index. This method should
+      # be used with care when shared cache is being used.
+      def clear(_options = nil)
+        # TODO: Support namespaces
+        @client.delete_by_query index: @index_name, type: 'entry', body: { query: { match_all: {} } }
+      end
+
+      protected
+
+      def read_entry(key, options) # :nodoc:
+        document = @client.get index: @index_name, type: 'entry', fields: %w(_ttl _source), id: key
+
+        fields = document['fields'] || {}
+        source = document['_source'] || {}
+        expires_in = (fields['_ttl'].to_f / 1000.0) if fields.key? '_ttl'
+
+        Entry.new(
+          source["value"],
+          options.merge(expires_in: expires_in)
+        )
+      rescue Elasticsearch::Transport::Transport::Errors::NotFound
+        nil
+      end
+
+      def write_entry(key, entry, _options) # :nodoc:
+        request = { value: entry.value }
+        if entry.expires_at
+          expires_in = (entry.expires_at - Time.now.to_f) * 1000
+          # If we somehow manage to get a negative expires, force it to 1ms
+          # as ES will crack it otherwise.
+          request[:_ttl] = [expires_in, 1].max
+        end
+
+        @client.index index: @index_name, type: 'entry', id: key, body: request
+      end
+
+      def delete_entry(key, _options) # :nodoc:
+        @client.delete index: @index_name, type: 'entry', id: key
+      end
+
+      private
+
+      def create_index
+        @index_created = true
+
+        # TODO: Check index mappings to make sure they match ours, warn if they don't.
+        @client.indices.create index: @index_name, body: {
+          settings: { index: {
+            number_of_replicas: 0
+          } },
+          mappings: { entry: { properties: {
+            _ttl: { enabled: true },
+            value: { type: 'string', index: 'no' }
+          } } }
+        }
+      rescue Elasticsearch::Transport::Transport::Errors::BadRequest => e
+        raise unless e.message =~ /IndexAlreadyExists/
+      end
+    end
+  end
+end

data/lib/elasticsearch/store.rb

@@ -0,0 +1,7 @@
+require "elasticsearch/store/version"
+
+module Elasticsearch
+  module Store
+    # Your code goes here...
+  end
+end

data/lib/elasticsearch/store/version.rb

@@ -0,0 +1,5 @@
+module Elasticsearch
+  module Store
+    VERSION = "0.0.1"
+  end
+end

data/spec/elasticsearch_store_spec.rb

@@ -0,0 +1,59 @@
+require 'rspec'
+require_relative '../lib/activesupport/cache/elasticsearch_store'
+
+index_name = "cache_test_#{Process.pid}"
+
+describe ActiveSupport::Cache::ElasticsearchStore do
+
+  describe ".new" do
+    before do
+      allow_any_instance_of(Elasticsearch::Client).to receive(:create_index)
+    end
+
+    it "should pass the addresses and some options straight through to ES::Client" do
+      es_opts = { retry_on_failure: true, randomize_hosts: true, reload_connections: true }
+      expect(Elasticsearch::Client).to receive(:new).with(es_opts.merge(addresses: %w(a b)))
+
+      ActiveSupport::Cache::ElasticsearchStore.new('a', 'b', es_opts)
+    end
+
+    it "should default to localhost:9200" do
+      expect(Elasticsearch::Client).to receive(:new).with(addresses: %w(localhost:9200))
+      ActiveSupport::Cache::ElasticsearchStore.new
+    end
+
+    it "should error if we try to pass in a namespace" do
+      expect { ActiveSupport::Cache::ElasticsearchStore.new(namespace: 'derp') }.to raise_error ArgumentError
+    end
+  end
+
+  context "with an active store" do
+    let(:store) { ActiveSupport::Cache::ElasticsearchStore.new(index_name: index_name) }
+    after do
+      # rubocop:disable Style/RescueModifier
+      Elasticsearch::Client.new.indices.delete index: index_name
+    end
+
+    it "should store and retrive a cache entry" do
+      expect(store.read("hello")).to be_nil
+      store.write("hello", "sup")
+      expect(store.read("hello")).to eq("sup")
+    end
+
+    it "should expire cache entries" do
+      store.write("hi", "there", expires_in: 0.5)
+      expect(store.read("hi")).to eq("there")
+      sleep 1
+      expect(store.read("hi")).to be_nil
+    end
+
+    it "should allow clearing the entire cache" do
+      store.write("hello", "there")
+      store.write("good", "bye")
+      store.clear
+      expect(store.read('hello')).to be_nil
+      expect(store.read('good')).to be_nil
+    end
+
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: elasticsearch-store
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Pearson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: ''
+email:
+- mipearson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- elasticsearch-store.gemspec
+- gemfiles/rails_3.2.gemfile
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
+- lib/activesupport/cache/elasticsearch_store.rb
+- lib/elasticsearch/store.rb
+- lib/elasticsearch/store/version.rb
+- spec/elasticsearch_store_spec.rb
+homepage: http://github.com/mipearson/elasticsearch-store
+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.2.2
+signing_key: 
+specification_version: 4
+summary: ElasticSearch-backed Ruby on Rails cache.
+test_files:
+- spec/elasticsearch_store_spec.rb