memcache_check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93a54941a1ac5c17564d14f5ab974f3d1ace1148
+  data.tar.gz: faf2d53e47d3f989b43960978f7682b449f423a8
+SHA512:
+  metadata.gz: 3f9f221d9aba6cc31ab5c560abf0e48e369e7cc8e18471f8bec4f953d6a2a60b7e7e7bb179678317fcfc5671ef58063ead40d7f29d623c07c1bb24ccd8fc48c6
+  data.tar.gz: 506bdb02a49042a93ff2c2316fdd9aa242a9c5b815ffeb5e688e229e2a073392d451a3f9b724393082f0efc6b72d4e025c5714b716f24c12dc140b566c9db7cc

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Admire
+
+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,67 @@
+# MemcacheCheck
+
+  This gem is intended to help find problems with Memcached servers.
+  MemcacheCheck runs a series of set and get commands against a Memcached
+  server and validates the data returned. It also returns the benchmark
+  time that it takes to run the get and set commands to help find slow
+  responding servers.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'memcache_check'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install memcache_check
+
+
+## Usage
+
+Create an instance of MemcacheCheck::Checker and pass in an argument of
+the server's IP address as a string. If you don't pass an IP address in it
+will default to localhost.  You can optionally pass in a second argument of
+the port number if you are running memcached on a non-standard port.
+
+Once you have an instance you simply run the start method and pass it the
+number of key value pairs you want to test against the server. If you don't
+pass a value in it will default to 50.
+
+The start method returns an array of 3 numbers:
+
+    - Number of passing set/get pairs
+    - Number of failing set/get pairs
+    - Benchmark time to run the test
+
+example.rb
+
+    require 'memcache_check'
+
+    memcache_check = MemcacheCheck::Checker.new('127.0.0.1')
+    passes, fails, time = memcache_check.start(500)
+
+    puts "Number of passes: #{passes}"
+    puts "Number of failures: #{fails}"
+    puts "Total time: #{time} seconds"
+
+Running on my local machine this produces:
+
+    Number of passes: 500
+    Number of failures: 0
+    Total time: 0.61212 seconds
+
+
+
+## Contributing
+
+    1. Fork it
+    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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/autotest/discover.rb

@@ -0,0 +1,3 @@
+#./autotest/discover.rb
+
+Autotest.add_discovery { "rspec2" }

data/lib/memcache_check/version.rb

@@ -0,0 +1,3 @@
+module MemcacheCheck
+  VERSION = "0.1.0"
+end

data/lib/memcache_check.rb

@@ -0,0 +1,78 @@
+require "memcache_check/version"
+require 'dalli'
+require 'faker'
+require 'benchmark'
+
+module MemcacheCheck
+    class Checker
+        attr_reader :passes, :fails
+
+        def initialize(server = 'localhost', port = '11211')
+            @server = Server.new(server, port)
+            @passes = 0
+            @fails = 0
+        end
+
+        def start(num_times = 50)
+            time = Benchmark.measure do
+                num_times.times do
+                    test_server
+                end
+            end
+            [@passes, @fails, time.real]
+        end
+
+        def test_server
+            key, value = create_key_value_pair
+            begin
+                @server.set(key, value)
+                if is_valid?(key, value)
+                    @passes += 1
+                else
+                    @fails += 1
+                end
+            rescue
+                @fails += 1
+            end
+        end
+
+        def create_key_value_pair
+            [Utils.generate_key, Utils.generate_test_data]
+        end
+
+        def is_valid?(key, value)
+            value == @server.get(key)
+        end
+    end
+
+    class Server
+        def initialize(host, port)
+            @memcache = Dalli::Client.new("#{host}:#{port}")
+        end
+
+        def set(key, value)
+            @memcache.set(key, value)
+        end
+
+        def get(key)
+            @memcache.get(key)
+        end
+    end
+
+    class Utils
+        def self.generate_key
+            "MemcacheCheck" + Time.now.strftime("%s%6N")
+        end
+
+        def self.generate_test_data
+            {
+                name: Faker::Name.name,
+                email: Faker::Internet.email,
+                phone: Faker::PhoneNumber.phone_number,
+                city: Faker::Address.city,
+                state: Faker::Address.state,
+                bio: Faker::Lorem.words(num = 100).join(", ")
+            }
+        end
+    end
+end

data/memcache_check.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memcache_check/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "memcache_check"
+  spec.version       = MemcacheCheck::VERSION
+  spec.authors       = ["Mike Admire"]
+  spec.email         = ["mike@mikeadmire.com"]
+  spec.description   = %q{Run checks against a Memcached server}
+  spec.summary       = %q{MemcacheCheck runs a series of set and get commands against a Memcache host to validate data integrity, verify that the host is responding correctly, and benchmark host speed.}
+  spec.homepage      = "https://github.com/mikeadmire/memcache_check"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "ZenTest", "~> 4.9.2"
+
+  spec.add_runtime_dependency "dalli"
+  spec.add_runtime_dependency "faker"
+end

data/spec/lib/memcache_check_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+require 'memcache_check'
+
+
+describe MemcacheCheck do
+
+  describe "Checker" do
+
+    before(:each) do
+      @checker = MemcacheCheck::Checker.new
+    end
+
+    it { MemcacheCheck::Checker.should respond_to(:new) }
+
+    context "start" do
+        it { @checker.should respond_to(:start).with(1).arguments }
+
+        it "returns an array" do
+            expect(@checker.start).to be_an_instance_of(Array)
+        end
+
+        it "returns an array with 3 numeric elements" do
+            passes, fails, time = @checker.start
+            expect(passes).to be_an_instance_of(Fixnum)
+            expect(fails).to be_an_instance_of(Fixnum)
+            expect(time).to be_an_instance_of(Float)
+        end
+
+        it "passes and fails should add up to correct number" do
+            passes, fails, time = @checker.start(50)
+            expect(passes + fails).to eq(50)
+        end
+    end
+
+  end
+
+  context "Server" do
+    before(:each) do
+      @tester = MemcacheCheck::Server.new('localhost', '11211')
+    end
+
+    it "can be instantiated" do
+      expect(@tester).to be_an_instance_of(MemcacheCheck::Server)
+    end
+
+    it { @tester.should respond_to(:set).with(2).arguments }
+    it { @tester.should respond_to(:get).with(1).argument }
+
+    it "set and retrieve data from memcached" do
+      key = "abc123"
+      value = {name: 'Mike Admire',
+               text: "Lorem ipsum dolor sit amet, consectetur adipisicing" }
+      @tester.set(key, value)
+      expect(@tester.get(key)).to eq(value)
+    end
+  end
+
+
+  describe "Utils" do
+    it { MemcacheCheck::Utils.should respond_to :generate_key }
+    it { MemcacheCheck::Utils.should respond_to :generate_test_data }
+
+    context "generate_key" do
+      before(:each) do
+        @key = MemcacheCheck::Utils.generate_key
+      end
+
+      it "can generate an appropriate sized key" do
+        expect(@key.length).to be >= 25
+      end
+
+      it "starts with the string MemCacheCheck in key" do
+        expect(@key).to start_with("MemcacheCheck")
+      end
+
+      it "is unique" do
+        key1 = MemcacheCheck::Utils.generate_key
+        key2 = MemcacheCheck::Utils.generate_key
+        key3 = MemcacheCheck::Utils.generate_key
+        expect(@key).to_not eq(key1)
+        expect(@key).to_not eq(key2)
+        expect(@key).to_not eq(key3)
+        expect(key1).to_not eq(key2)
+        expect(key1).to_not eq(key3)
+        expect(key2).to_not eq(key3)
+      end
+    end # generate_key
+
+    context "generate_test_data" do
+      before(:each) do
+        @data = MemcacheCheck::Utils.generate_test_data
+      end
+
+      it "generates a data hash" do
+        expect(@data).to be_an_instance_of(Hash)
+      end
+
+      it "is a reasonable amount of data" do
+        expect(@data.length).to be >= 5
+        expect(@data.to_s.length).to be >= 500
+      end
+
+      it "is unique" do
+        data1 = MemcacheCheck::Utils.generate_test_data
+        data2 = MemcacheCheck::Utils.generate_test_data
+        data3 = MemcacheCheck::Utils.generate_test_data
+        expect(@data).to_not eq(data1)
+        expect(@data).to_not eq(data2)
+        expect(@data).to_not eq(data3)
+        expect(data1).to_not eq(data2)
+        expect(data1).to_not eq(data3)
+        expect(data2).to_not eq(data3)
+      end
+    end # generate_test_data
+  end # Utils
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: memcache_check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Admire
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ZenTest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.9.2
+- !ruby/object:Gem::Dependency
+  name: dalli
+  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: faker
+  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: Run checks against a Memcached server
+email:
+- mike@mikeadmire.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- autotest/discover.rb
+- lib/memcache_check.rb
+- lib/memcache_check/version.rb
+- memcache_check.gemspec
+- spec/lib/memcache_check_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mikeadmire/memcache_check
+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.0.6
+signing_key: 
+specification_version: 4
+summary: MemcacheCheck runs a series of set and get commands against a Memcache host
+  to validate data integrity, verify that the host is responding correctly, and benchmark
+  host speed.
+test_files:
+- spec/lib/memcache_check_spec.rb
+- spec/spec_helper.rb