siberite-client 0.8.0

data/spec/siberite/client_spec.rb

@@ -0,0 +1,175 @@
+require 'spec_helper'
+
+describe Siberite::Client do
+  describe "Instance Methods" do
+    before do
+      @client = Siberite::Client.new('localhost:22133')
+    end
+
+    describe "#get and #set" do
+      it "basic operation" do
+        @client.flush(queue = "test_queue")
+        @client.set(queue, value = "russell's reserve")
+        @client.get(queue).should == value
+      end
+
+      it "returns nil when getting from a queue that does not exist" do
+        @client.get('nonexistent_queue').should == nil
+      end
+
+      it "gets from the same server :gets_per_server times" do
+        client = @client.instance_variable_get(:@read_client)
+        mock(client).get("a_queue/t=10", true).times(102).returns('item')
+
+        102.times { @client.get("a_queue") }
+      end
+
+      it "gets from a different server when the last result was nil" do
+        client = @client.instance_variable_get(:@read_client)
+        mock(client).get("a_queue/t=10", true).returns(nil).twice
+
+        2.times { @client.get("a_queue") }
+      end
+
+      it "returns nil if there is a recoverable exception" do
+        mock(@client).shuffle_if_necessary!(@queue) { raise Memcached::SystemError }
+        @client.get(@queue).should == nil
+      end
+
+      it "raises the exception if the exception is not recoverable" do
+        mock(@client).shuffle_if_necessary!(@queue) { raise ArgumentError }
+        lambda { @client.get(@queue) }.should raise_error(ArgumentError)
+      end
+    end
+
+    describe "retry behavior" do
+      it "does not retry gets" do
+        mock(@client).with_retries.never
+        @client.get("a_queue")
+      end
+
+      it "retries sets" do
+        mock(@client).with_retries
+        @client.set("a_queue", "value")
+      end
+    end
+
+    describe "#flush" do
+      before do
+        @queue = "some_random_queue_#{Time.now.to_i}_#{rand(10000)}"
+      end
+
+      it "counts the number of items flushed and passes each of them to a given block" do
+        %w{A B C}.each { |item| @client.set(@queue, item) }
+        @client.flush(@queue).should == 3
+      end
+
+      it "does not attempt to Marshal load the data being flushed" do
+        @client.set(@queue, "some_stuff", 0, true)
+        mock(Marshal).load.never
+        @client.flush(@queue).should == 1
+      end
+    end
+
+    describe "#peek" do
+      it "should return first item from the queue and reenqueue" do
+        @queue = "some_random_queue_#{Time.now.to_i}_#{rand(10000)}"
+        @client.set(@queue, "item_1")
+        @client.set(@queue, "item_2")
+        @client.peek(@queue).should == "item_1"
+        @client.sizeof(@queue).should == 2
+      end
+    end
+
+    describe "#with_retries" do
+      it "retries a specified number of times" do
+        mock(@client).set(anything, anything) { raise Memcached::SystemError }.times(6)
+
+        lambda do
+          @client.send(:with_retries) { @client.set("a_queue", "foo") }
+        end.should raise_error(Memcached::SystemError)
+      end
+
+      it "does not raise if within the retry limit" do
+        mock(@client).set(anything, anything) { raise Memcached::SystemError }.times(5).
+          then.set(anything, anything) { true }
+
+        lambda do
+          @client.send(:with_retries) { @client.set("a_queue", "foo") }
+        end.should_not raise_error
+      end
+
+      it "does not catch unknown errors" do
+        mock(@client).set(anything, anything) { raise ArgumentError }
+
+        lambda do
+          @client.send(:with_retries) { @client.set("a_queue", "foo") }
+        end.should raise_error(ArgumentError)
+      end
+    end
+
+    describe "#stats" do
+      it "retrieves stats" do
+        @client.set("test-queue-name", 97)
+
+        stats = @client.stats
+        %w{uptime time version curr_items total_items bytes curr_connections total_connections
+           cmd_get cmd_set get_hits get_misses bytes_read bytes_written queues}.each do |stat|
+          stats[stat].should_not be_nil
+        end
+
+        stats['queues']["test-queue-name"].should_not be_nil
+        Siberite::Client::QUEUE_STAT_NAMES.each do |queue_stat|
+          stats['queues']['test-queue-name'][queue_stat].should_not be_nil
+        end
+      end
+
+      it "merge in stats from all the servers" do
+        server = @client.servers.first
+        stub(@client).servers { [server] }
+        stats_for_one_server = @client.stats
+
+        server = @client.servers.first
+        stub(@client).servers { [server] * 2 }
+        stats_for_two_servers = @client.stats
+
+        stats_for_two_servers['bytes'].should == 2*stats_for_one_server['bytes']
+      end
+    end
+
+    describe "#stat" do
+      it "get stats for single queue" do
+        @client.set(queue = "test-queue-name", 97)
+        all_stats = @client.stats
+        single_queue_stats = @client.stat(queue).except("age")
+
+        expect(single_queue_stats).to eq all_stats['queues'][queue].except("age")
+      end
+    end
+
+    describe "#sizeof" do
+      before do
+        @queue = "some_random_queue_#{Time.now.to_i}_#{rand(10000)}"
+      end
+
+      it "reports the size of the queue" do
+        100.times { @client.set(@queue, true) }
+        @client.sizeof(@queue).should == 100
+      end
+
+      it "reports the size of a non-existant queue as 0" do
+        queue = "some_random_queue_#{Time.now.to_i}_#{rand(10000)}"
+        @client.sizeof(queue).should == 0
+      end
+    end
+
+    describe "#available_queues" do
+      it "returns all the queue names" do
+        @client.set("test-queue-name1", 97)
+        @client.set("test-queue-name2", 155)
+        @client.available_queues.should include('test-queue-name1')
+        @client.available_queues.should include('test-queue-name2')
+      end
+    end
+  end
+end

data/spec/siberite/config/siberite.yml

@@ -0,0 +1,42 @@
+defaults: &defaults
+  distribution: :random
+  timeout: 0.1
+  connect_timeout: 0.5
+  server_failure_limit: 10
+  auto_eject_hosts: false
+
+production: &production
+  <<: *defaults
+  auto_eject_hosts: true
+  server_failure_limit: 4
+  servers:
+    - localhost:22133
+
+staging:
+    <<: *production
+    servers:
+      - localhost:22133
+
+development: &development
+  <<: *defaults
+  show_backtraces: true
+  servers:
+    - localhost:22133
+
+benchmark:
+  <<: *development
+
+test:
+  <<: *development
+
+replication_lag:
+  <<: *development
+
+selenium:
+  <<: *development
+
+foo_space:
+  production:
+    <<: *production
+  development:
+    <<: *development

data/spec/siberite/config_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Siberite::Config do
+  before do
+    # to sniff namespace foo_space
+    Siberite::Config.config['foo_space']['development']['connect_timeout'] = 8
+  end
+
+  describe "load" do
+    it "loads a yaml file" do
+      Siberite::Config.config = nil
+      lambda { Siberite::Config.default }.should raise_error
+
+      Siberite::Config.load TEST_CONFIG_FILE
+      lambda { Siberite::Config.default }.should_not raise_error
+    end
+  end
+
+  shared_examples_for "config getters" do
+    it "returns a tuple of [servers, options]" do
+      config = @configurer.call
+      config.should be_a(Array)
+
+      [String, Array].should include(config.first.class)
+      config.last.should be_a(Hash)
+
+      config.last.keys.map{|k| k.class }.uniq.should == [Symbol]
+    end
+
+    it "defaults to development enviroment" do
+      @configurer.call.last[:server_failure_limit].should == 10 # development options should pull 10 from defaults
+    end
+
+    it "returns config for the specified environment" do
+      Siberite::Config.environment = :production
+      @configurer.call.last[:server_failure_limit].should == 4 # production is set to 4
+    end
+  end
+
+  describe "namespace" do
+    before { @configurer = lambda { Siberite::Config.namespace(:foo_space) } }
+
+    it_should_behave_like "config getters"
+
+    it "returns args for Siberite::Client.new for the appropriate namespace" do
+      Siberite::Config.foo_space.last[:connect_timeout].should == 8
+    end
+
+    it "is aliased to method_missing" do
+      Siberite::Config.foo_space.should == Siberite::Config.namespace(:foo_space)
+    end
+  end
+
+  describe "default" do
+    before { @configurer = lambda { Siberite::Config.default } }
+
+    it_should_behave_like "config getters"
+  end
+
+  describe "new_client" do
+    it "returns a Siberite::Client instance" do
+      client = Siberite::Config.new_client
+      client.should be_a(Siberite::Client)
+    end
+
+    it "can take a namespace" do
+      client = Siberite::Config.new_client(:foo_space)
+      client.should be_a(Siberite::Client)
+      client.options[:connect_timeout].should == 8
+    end
+  end
+end

data/spec/siberite_benchmark.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'benchmark'
+
+describe Siberite::Client do
+  before do
+    @queue = "a_queue"
+    @client = Siberite::Client.new(*Siberite::Config.default)
+
+    @client.delete(@queue) rescue nil # Memcache::ServerEnd bug
+  end
+
+  it "is fast" do
+    @client.flush(@queue)
+    @value = { :value => "a value" }
+    @raw_value = Marshal.dump(@value)
+
+    times = 10_000
+
+    Benchmark.bm do |x|
+      x.report("set:") { for i in 1..times; @client.set(@queue, @value); end }
+      x.report("get:") { for i in 1..times; @client.get(@queue); end }
+      x.report("set (raw):") { for i in 1..times; @client.set(@queue, @raw_value, 0, true); end }
+      x.report("get (raw):") { for i in 1..times; @client.get(@queue, :raw => true); end }
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--colour
+--format progress
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'rspec'
+require 'pry'
+require 'pry-byebug'
+require "active_support/core_ext/hash"
+
+spec_dir = File.dirname(__FILE__)
+
+# make sure we load local libs rather than gems first
+$: << File.expand_path("#{spec_dir}/../lib")
+
+require 'siberite'
+
+TEST_CONFIG_FILE = File.expand_path("#{spec_dir}/siberite/config/siberite.yml")
+
+RSpec.configure do |config|
+  config.mock_with :rr
+
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+
+  config.before do
+    Siberite::Config.environment = nil
+    Siberite::Config.load TEST_CONFIG_FILE
+  end
+
+  config.after do
+    c = Siberite::Client.new(*Siberite::Config.default)
+    c.available_queues.uniq.each do |q|
+      c.delete(q) rescue nil
+    end
+  end
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: siberite-client
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Matt Freels
+- Rael Dornfest
+- Anton Bogdanovich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: memcached
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.19.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.19.6
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Ruby client for the Siberite queue server
+email: anton@bogdanovich.co
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/siberite-client.rb
+- lib/siberite.rb
+- lib/siberite/client.rb
+- lib/siberite/client/blocking.rb
+- lib/siberite/client/envelope.rb
+- lib/siberite/client/json.rb
+- lib/siberite/client/namespace.rb
+- lib/siberite/client/partitioning.rb
+- lib/siberite/client/proxy.rb
+- lib/siberite/client/stats_helper.rb
+- lib/siberite/client/transactional.rb
+- lib/siberite/client/unmarshal.rb
+- lib/siberite/client/version.rb
+- lib/siberite/config.rb
+- siberite-client.gemspec
+- spec/siberite/client/blocking_spec.rb
+- spec/siberite/client/envelope_spec.rb
+- spec/siberite/client/json_spec.rb
+- spec/siberite/client/namespace_spec.rb
+- spec/siberite/client/partitioning_spec.rb
+- spec/siberite/client/transactional_spec.rb
+- spec/siberite/client/unmarshal_spec.rb
+- spec/siberite/client_spec.rb
+- spec/siberite/config/siberite.yml
+- spec/siberite/config_spec.rb
+- spec/siberite_benchmark.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: http://github.com/bogdanovich/siberite-ruby
+licenses:
+- Apache-2
+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: Ruby Siberite client
+test_files:
+- spec/siberite/client/blocking_spec.rb
+- spec/siberite/client/envelope_spec.rb
+- spec/siberite/client/json_spec.rb
+- spec/siberite/client/namespace_spec.rb
+- spec/siberite/client/partitioning_spec.rb
+- spec/siberite/client/transactional_spec.rb
+- spec/siberite/client/unmarshal_spec.rb
+- spec/siberite/client_spec.rb
+- spec/siberite/config/siberite.yml
+- spec/siberite/config_spec.rb
+- spec/siberite_benchmark.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: