dalli-elasticache 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGZlZjgwNzQyNTU3MTMzOWZkYjI4M2RiZGJlMmYwZTQ3ODBkMmMxZg==
+  data.tar.gz: !binary |-
+    YzM4Y2E3ZjlhMzA3M2NjYTc0NjZjZTU1MzA4Y2UwODM1YmZjMjNmYw==
+SHA512:
+  metadata.gz: !binary |-
+    ZjA5MmNmZjRjYTE2ZDY2NWE3ZGVkNGE0ZDYzOGY0YzI1Nzg2ODlmY2I5ZWM5
+    N2E5ZWJhZmRkYTBmYTg1Zjg3NmQ2N2Q1YjUyZTBlN2E1ZWYxMDFmMmI4MTM1
+    ZWM5ZmY0OTkzMDU2MmI4NGZiODFmY2QzNmZhMWEzY2MxZWIzZjk=
+  data.tar.gz: !binary |-
+    ZjVlMmMyMzI3ODhlMDFiMTc4NTQzMjc5ZDkyYjFlMGRmOGIwNGYxYTc5OTUw
+    YTk2YWE1MmFmMmViODZkM2UwMTliMTdhYWM2ZDRhMjljOGJkZmQ5OTc3NzAy
+    NzIyMzI5NWY1YWFmY2M5ODMwYzIzN2UzNmFhMjRiMTkwYjUwMDQ=

data/README.md

@@ -1,32 +1,79 @@
-# dalli-elasticache
+Dalli ElastiCache [![Gem Version](https://badge.fury.io/rb/dalli-elasticache.svg)](http://badge.fury.io/rb/dalli-elasticache) [![Build Status](https://travis-ci.org/zmillman/dalli-elasticache.svg?branch=request-refactor)](https://travis-ci.org/zmillman/dalli-elasticache) [![Code Climate](https://codeclimate.com/github/ktheory/dalli-elasticache.png)](https://codeclimate.com/github/ktheory/dalli-elasticache)
+=================
 
-A wrapper for the [Dalli memcached client](https://github.com/mperham/dalli) with support for [AWS ElastiCache Auto Discovery](http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/AutoDiscovery.html)
+Use [AWS ElastiCache AutoDiscovery](http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/AutoDiscovery.html) to automatically configure your [Dalli memcached client](https://github.com/mperham/dalli) with all the nodes in your cluster.
 
-## Installation
+Installation
+------------
 
 Install the [rubygem](https://rubygems.org/gems/dalli-elasticache):
 
-    # in your Gemfile
-    gem 'dalli-elasticache'
+```ruby
+# in your Gemfile
+gem 'dalli-elasticache'
+```
 
-## Usage
+Setup for Rails 3.x and Newer
+-----------------------------
 
-    # Create an ElastiCache instance with your config endpoint and options for Dalli
-    elasticache = Dalli::ElastiCache.new(config_endpoint, dalli_options={})
-    # For example:
-    elasticache = Dalli::ElastiCache.new("aaron-scratch.vfdnac.cfg.use1.cache.amazonaws.com:11211", :ttl => 3600, :namespace => "my_app")
+Configure your environment-specific application settings:
 
-    elasticache.version # => the config version returned by the ElastiCache config endpoint.
+```ruby
+# in config/environments/production.rb
+config_endpoint = "my-cluster-name.abc123.cfg.use1.cache.amazonaws.com:1211"
+elasticache     = Dalli::ElastiCache.new(endpoint)
 
-    client = elasticache.client # a regular Dalli::Client using the instance IP addresses returns by the config endpoint
+config.cache_store = :dalli_store, elasticache.servers, {:expires_in => 1.day, :compress => true}
+```
 
-    # Check the endpoint to see if the version has changed:
-    elasticache.refresh.version
-    # If so, update your dalli client:
-    client = elasticache.client
+Note that the ElastiCache server list will be refreshed each time an app server process starts.
 
+Client Usage
+------------
 
-## License
+Create an ElastiCache instance:
+
+```ruby
+config_endpoint = "aaron-scratch.vfdnac.cfg.use1.cache.amazonaws.com:11211"
+
+# Options for configuring the Dalli::Client
+dalli_options = {
+  :expires_in => 24 * 60 * 60,
+  :namespace => "my_app",
+  :compress => true
+}
+
+elasticache = Dalli::ElastiCache.new(config_endpoint, dalli_options)
+```
+
+Fetch information about the Memcached nodes:
+
+```ruby
+# Dalli::Client with configuration from the AutoDiscovery endpoint
+elasticache.client
+# => #<Dalli::Client ... @servers=["10.84.227.155:11211", ...]>
+
+# Node IP addresses and hostnames
+elasticache.servers
+# => ["10.84.227.115:11211", "10.77.71.127:11211"]
+
+# Number of times the cluster configuration has changed
+elasticache.version
+# => 12
+
+# Memcached version of the cluster
+elasticache.engine_version
+# => "1.4.14"
+
+# Refresh data from the endpoint
+elasticache.refresh
+
+# Refresh and get client with new configuration
+elasticache.refresh.client
+```
+
+License
+-------
 
 Copyright 2013 Aaron Suggs
 

data/Rakefile

@@ -0,0 +1,7 @@
+require "rubygems"
+require "bundler/setup"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test)
+
+task :default => :test

data/lib/dalli/elasticache.rb

@@ -1,59 +1,46 @@
 require 'dalli'
 require 'socket'
 require 'dalli/elasticache/version'
+require 'dalli/elasticache/auto_discovery/endpoint'
+require 'dalli/elasticache/auto_discovery/config_response'
+require 'dalli/elasticache/auto_discovery/stats_response'
 
 module Dalli
   class ElastiCache
-    attr_accessor :config_host, :config_port, :options
-
+    attr_reader :endpoint, :options
+    
     def initialize(config_endpoint, options={})
-      @config_host, @config_port = config_endpoint.split(':')
-      @config_port ||= 11211
+      @endpoint = Dalli::Elasticache::AutoDiscovery::Endpoint.new(config_endpoint)
       @options = options
-
     end
-
+    
+    # Dalli::Client configured to connect to the cluster's nodes
     def client
       Dalli::Client.new(servers, options)
     end
-
-    def refresh
-      # Reset data
-      @data = nil
-      data
-
-      self
-    end
-
-    def config_get_cluster
-      # TODO: handle timeouts
-      s = TCPSocket.new(config_host, config_port)
-      s.puts "config get cluster\r\n"
-      data = []
-      while (line = s.gets) != "END\r\n"
-        data << line
-      end
-
-      s.close
-      data
-    end
-
-    def data
-      return @data if @data
-      raw_data = config_get_cluster
-      version = raw_data[1].to_i
-      instance_data = raw_data[2].split(/\s+/)
-      instances = instance_data.map{ |raw| host, ip, port = raw.split('|'); {:host => host, :ip => ip, :port => port} }
-      @data = { :version => version, :instances => instances }
-    end
-
+    
+    # The number of times the cluster configuration has been changed
+    #
+    # Returns an integer
     def version
-      data[:version]
+      endpoint.config.version
     end
-
+    
+    # The cache engine version of the cluster
+    def engine_version
+      endpoint.engine_version
+    end
+    
+    # List of cluster server nodes with ip addresses and ports
     def servers
-      data[:instances].map{ |i| "#{i[:ip]}:#{i[:port]}" }
+      endpoint.config.nodes.map{ |h| "#{h[:ip]}:#{h[:port]}" }
+    end
+    
+    # Clear all cached data from the cluster endpoint
+    def refresh
+      @endpoint = Dalli::Elasticache::AutoDiscovery::Endpoint.new(config_endpoint)
+      
+      self
     end
-
   end
 end

data/lib/dalli/elasticache/auto_discovery/config_response.rb

@@ -0,0 +1,49 @@
+module Dalli
+  module Elasticache
+    module AutoDiscovery
+      
+      # This class wraps the raw ASCII response from an Auto Discovery endpoint
+      # and provides methods for extracting data from that response.
+      #
+      # http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/AutoDiscovery.AddingToYourClientLibrary.html
+      
+      class ConfigResponse
+        
+        # The raw response text
+        attr_reader :text
+    
+        # Matches the version line of the response
+        VERSION_REGEX = /^(\d+)$/
+    
+        # Matches strings like "my-cluster.001.cache.aws.com|10.154.182.29|11211"
+        NODE_REGEX = /(([-.a-zA-Z0-9]+)\|(\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b)\|(\d+))/
+        NODE_LIST_REGEX = /^(#{NODE_REGEX}\s*)+$/
+    
+        def initialize(response_text)
+          @text = response_text.to_s
+        end
+    
+        # The number of times the configuration has been changed
+        #
+        # Returns an integer
+        def version
+          VERSION_REGEX.match(@text)[1].to_i
+        end
+    
+        # Node hosts, ip addresses, and ports
+        #
+        # Returns an Array of Hashes with values for :host, :ip and :port
+        def nodes
+          NODE_LIST_REGEX.match(@text).to_s.scan(NODE_REGEX).map do |match|
+            {
+              :host => match[1],
+              :ip   => match[2],
+              :port => match[3].to_i
+            }
+          end
+        end
+    
+      end
+    end
+  end
+end

data/lib/dalli/elasticache/auto_discovery/endpoint.rb

@@ -0,0 +1,78 @@
+module Dalli
+  module Elasticache
+    module AutoDiscovery
+      class Endpoint
+        
+        # Endpoint configuration
+        attr_reader :host
+        attr_reader :port
+    
+        # Matches Strings like "my-host.cache.aws.com:11211"
+        ENDPOINT_REGEX = /([-.a-zA-Z0-9]+):(\d+)/
+    
+        STATS_COMMAND  = "stats\r\n"
+        CONFIG_COMMAND = "config get cluster\r\n"
+        # Legacy command for version < 1.4.14
+        OLD_CONFIG_COMMAND = "get AmazonElastiCache:cluster\r\n"
+    
+        def initialize(endpoint)
+          ENDPOINT_REGEX.match(endpoint) do |m|
+            @host = m[1]
+            @port = m[2].to_i
+          end
+        end
+    
+        # A cached ElastiCache::StatsResponse
+        def stats
+          @stats ||= get_stats_from_remote
+        end
+    
+        # A cached ElastiCache::ConfigResponse
+        def config
+          @config ||= get_config_from_remote
+        end
+    
+        # The memcached engine version
+        def engine_version
+          stats.version
+        end
+    
+        protected
+    
+        def with_socket(&block)
+          TCPSocket.new(config_host, config_port)
+        end
+    
+        def get_stats_from_remote
+          data = remote_command(STATS_COMMAND)
+          StatsResponse.new(data)
+        end
+    
+        def get_config_from_remote
+          if engine_version < Gem::Version.new("1.4.14")
+            data = remote_command(OLD_CONFIG_COMMAND)
+          else
+            data = remote_command(CONFIG_COMMAND)
+          end
+          ConfigResponse.new(data)
+        end
+      
+        # Send an ASCII command to the endpoint
+        #
+        # Returns the raw response as a String
+        def remote_command(command)
+          socket = TCPSocket.new(@host, @port)
+          socket.puts command
+        
+          data = ""
+          until (line = socket.readline) =~ /END/
+            data << line
+          end
+        
+          socket.close
+          data
+        end
+      end
+    end
+  end
+end

data/lib/dalli/elasticache/auto_discovery/stats_response.rb

@@ -0,0 +1,31 @@
+module Dalli
+  module Elasticache
+    module AutoDiscovery
+      
+      # This class wraps the raw ASCII response from an Auto Discovery endpoint
+      # and provides methods for extracting data from that response.
+      #
+      # http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/AutoDiscovery.AddingToYourClientLibrary.html
+      
+      class StatsResponse
+        
+        # The raw response text
+        attr_reader :text
+        
+        # Matches the version line of the response
+        VERSION_REGEX = /^STAT version ([0-9.]+)\s*$/
+        
+        def initialize(response_text)
+          @text = response_text.to_s
+        end
+        
+        # Extract the engine version stat
+        #
+        # Returns a Gem::Version
+        def version
+          Gem::Version.new(VERSION_REGEX.match(@text)[1])
+        end
+      end
+    end
+  end
+end

data/lib/dalli/elasticache/version.rb

@@ -1,5 +1,5 @@
 module Dalli
   class ElastiCache
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/spec/config_response_spec.rb

@@ -0,0 +1,32 @@
+require_relative 'spec_helper'
+
+describe 'Dalli::Elasticache::AutoDiscovery::ConfigResponse' do
+  let :response do
+    text = "CONFIG cluster 0 141\r\n12\nmycluster.0001.cache.amazonaws.com|10.112.21.1|11211 mycluster.0002.cache.amazonaws.com|10.112.21.2|11211 mycluster.0003.cache.amazonaws.com|10.112.21.3|11211\n\r\n"
+    Dalli::Elasticache::AutoDiscovery::ConfigResponse.new(text)
+  end
+  
+  describe '#version' do
+    it 'parses version' do
+      response.version.should == 12
+    end
+  end
+
+  describe '#nodes' do
+    it 'parses hosts' do
+      response.nodes.map{|s| s[:host]}.should == [
+        "mycluster.0001.cache.amazonaws.com",
+        "mycluster.0002.cache.amazonaws.com",
+        "mycluster.0003.cache.amazonaws.com"
+      ]
+    end
+  
+    it 'parses ip addresses' do
+      response.nodes.map{|s| s[:ip]}.should == ["10.112.21.1", "10.112.21.2", "10.112.21.3"]
+    end
+  
+    it 'parses ports' do
+      response.nodes.map{|s| s[:port]}.should == [11211, 11211, 11211]
+    end
+  end
+end

data/spec/elasticache_spec.rb

@@ -0,0 +1,45 @@
+require_relative 'spec_helper'
+
+describe 'Dalli::ElastiCache::Endpoint' do
+  let(:cache) do
+    options = {
+      :expires_in => 24*60*60,
+      :namespace => "my_app",
+      :compress => true
+    }
+    Dalli::ElastiCache.new("my-cluster.cfg.use1.cache.amazonaws.com:11211", options)
+  end
+  
+  describe '.new' do
+    it 'builds endpoint' do
+      cache.endpoint.host.should == "my-cluster.cfg.use1.cache.amazonaws.com"
+      cache.endpoint.port.should == 11211
+    end
+    
+    it 'stores Dalli options' do
+      cache.options[:expires_in].should == 24*60*60
+      cache.options[:namespace].should == "my_app"
+      cache.options[:compress].should == true
+    end
+  end
+  
+  describe '#client' do
+    it 'builds with node list'
+    it 'builds with options'
+  end
+  
+  describe '#servers' do
+    it 'lists addresses and ports'
+  end
+  
+  describe '#version' do
+  end
+  
+  describe '#engine_version' do
+  end
+  
+  describe '#refresh' do
+    it 'clears endpoint configuration'
+  end
+  
+end

data/spec/endpoint_spec.rb

@@ -0,0 +1,16 @@
+require_relative 'spec_helper'
+
+describe 'Dalli::Elasticache::AutoDiscovery::Endpoint' do
+  let(:endpoint) do
+    Dalli::Elasticache::AutoDiscovery::Endpoint.new("my-cluster.cfg.use1.cache.amazonaws.com:11211")
+  end
+  
+  describe '.new' do
+    it 'parses host' do
+      endpoint.host.should == "my-cluster.cfg.use1.cache.amazonaws.com"
+    end
+    it 'parses port' do
+      endpoint.port.should == 11211
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "bundler/setup"
+
+require "dalli/elasticache"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :should
+  end
+  config.mock_with :rspec do |c|
+    c.syntax = :should
+  end
+end

data/spec/stats_response_spec.rb

@@ -0,0 +1,14 @@
+require_relative 'spec_helper'
+
+describe 'Dalli::Elasticache::AutoDiscovery::StatsResponse' do
+  let :response do
+    text = "STAT pid 1\r\nSTAT uptime 68717\r\nSTAT time 1398885375\r\nSTAT version 1.4.14\r\nSTAT libevent 1.4.13-stable\r\nSTAT pointer_size 64\r\nSTAT rusage_user 0.136008\r\nSTAT rusage_system 0.424026\r\nSTAT curr_connections 5\r\nSTAT total_connections 1159\r\nSTAT connection_structures 6\r\nSTAT reserved_fds 5\r\nSTAT cmd_get 0\r\nSTAT cmd_set 0\r\nSTAT cmd_flush 0\r\nSTAT cmd_touch 0\r\nSTAT cmd_config_get 4582\r\nSTAT cmd_config_set 2\r\nSTAT get_hits 0\r\nSTAT get_misses 0\r\nSTAT delete_misses 0\r\nSTAT delete_hits 0\r\nSTAT incr_misses 0\r\nSTAT incr_hits 0\r\nSTAT decr_misses 0\r\nSTAT decr_hits 0\r\nSTAT cas_misses 0\r\nSTAT cas_hits 0\r\nSTAT cas_badval 0\r\nSTAT touch_hits 0\r\nSTAT touch_misses 0\r\nSTAT auth_cmds 0\r\nSTAT auth_errors 0\r\nSTAT bytes_read 189356\r\nSTAT bytes_written 2906615\r\nSTAT limit_maxbytes 209715200\r\nSTAT accepting_conns 1\r\nSTAT listen_disabled_num 0\r\nSTAT threads 1\r\nSTAT conn_yields 0\r\nSTAT curr_config 1\r\nSTAT hash_power_level 16\r\nSTAT hash_bytes 524288\r\nSTAT hash_is_expanding 0\r\nSTAT expired_unfetched 0\r\nSTAT evicted_unfetched 0\r\nSTAT bytes 0\r\nSTAT curr_items 0\r\nSTAT total_items 0\r\nSTAT evictions 0\r\nSTAT reclaimed 0\r\n"
+    Dalli::Elasticache::AutoDiscovery::StatsResponse.new(text)
+  end
+  
+  describe '#version' do
+    it 'parses version' do
+      response.version.should == Gem::Version.new("1.4.14")
+    end
+  end
+end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: dalli-elasticache
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - Aaron Suggs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-27 00:00:00.000000000 Z
+date: 2014-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,20 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
@@ -30,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: dalli
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,45 +48,59 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
-description: A wrapper for Dalli with support for AWS ElastiCache Auto Discovery
+description: ! "    This gem provides an interface for fetching cluster information
+  from an AWS\n    ElastiCache AutoDiscovery server and configuring a Dalli client
+  to connect\n    to all nodes in the cache cluster.\n"
 email: aaron@ktheory.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/dalli/elasticache/auto_discovery/config_response.rb
+- lib/dalli/elasticache/auto_discovery/endpoint.rb
+- lib/dalli/elasticache/auto_discovery/stats_response.rb
 - lib/dalli/elasticache/version.rb
 - lib/dalli/elasticache.rb
 - lib/dalli-elasticache.rb
 - README.md
 - Rakefile
+- spec/config_response_spec.rb
+- spec/elasticache_spec.rb
+- spec/endpoint_spec.rb
+- spec/spec_helper.rb
+- spec/stats_response_spec.rb
 homepage: http://github.com/ktheory/dalli-elasticache
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
-summary: Adds AWS ElastiCache Auto Discovery support to Dalli memcache client
-test_files: []
+specification_version: 4
+summary: Configure Dalli clients with ElastiCache's AutoDiscovery
+test_files:
+- spec/config_response_spec.rb
+- spec/elasticache_spec.rb
+- spec/endpoint_spec.rb
+- spec/spec_helper.rb
+- spec/stats_response_spec.rb