kjess 1.0.0

data/spec/kestrel_server.rb

@@ -0,0 +1,137 @@
+require 'json'
+require 'spec/utils'
+require 'net/http'
+module KJess::Spec
+  class KestrelServer
+
+    class << self
+      def version
+        "2.3.4"
+      end
+
+      def dir
+        File.join( KJess::Spec.project_root, "kestrel/kestrel-#{version}" )
+      end
+
+      def zip
+        "#{dir}.zip"
+      end
+
+      def jar
+        File.join( dir, "kestrel_2.9.1-#{version}.jar" )
+      end
+
+      def queue_path
+        File.join( dir, 'data' )
+      end
+
+      def log_path
+        File.join( dir, 'logs' )
+      end
+
+      def log_file
+        File.join( log_path, 'kestrel.log' )
+      end
+
+      def config_file
+        File.join( dir, 'config', 'kjess.scala' )
+      end
+
+      def config_contents
+      contents = <<_EOC
+import com.twitter.conversions.storage._
+import com.twitter.conversions.time._
+import com.twitter.logging.config._
+import com.twitter.ostrich.admin.config._
+import net.lag.kestrel.config._
+
+new KestrelConfig {
+  listenAddress = "0.0.0.0"
+  memcacheListenPort = 22133
+
+  queuePath = "#{KJess::Spec::KestrelServer.queue_path}"
+
+  clientTimeout = 30.seconds
+
+  expirationTimerFrequency = 1.second
+
+  maxOpenTransactions = 100
+
+  // default queue settings:
+  default.defaultJournalSize = 16.megabytes
+  default.maxMemorySize = 128.megabytes
+  default.maxJournalSize = 1.gigabyte
+
+  admin.httpPort = 2223
+
+  admin.statsNodes = new StatsConfig {
+    reporters = new TimeSeriesCollectorConfig
+  }
+
+  loggers = new LoggerConfig {
+    level = Level.DEBUG
+    handlers = new FileHandlerConfig {
+      filename = "#{KJess::Spec::KestrelServer.log_file}"
+      roll = Policy.Never
+    }
+  }
+}
+_EOC
+      end
+
+      def get_response( path )
+        uri = URI.parse( "http://localhost:2223/#{path}" )
+        resp = Net::HTTP.get_response( uri )
+        JSON.parse( resp.body )
+      end
+
+      def start
+        Dir.chdir( KJess::Spec::KestrelServer.dir ) do
+          cmd = "java -server -Xmx1024m -Dstage=kjess -jar #{KJess::Spec::KestrelServer.jar} &"
+          puts cmd
+          system( cmd )
+          loop do
+            break if is_running?
+          end
+          puts "Started."
+        end
+      end
+
+      def is_running?
+        return "pong" == ping
+      rescue Exception => e
+        false
+      end
+
+      def is_stopped?
+        return !is_running?
+      end
+
+      def status
+        puts "Running" if "pong" == ping
+      rescue Exception
+        puts "Stopped."
+      end
+
+      def stop
+        shutdown
+        loop do
+          break if is_stopped?
+        end
+        puts "Stopped."
+      end
+
+      def ping
+        get_response('ping')['response']
+      end
+
+      def shutdown
+        h = get_response( 'shutdown' )
+        return h['response'] == "ok"
+      rescue => e
+        false
+      end
+    end
+
+  end
+end

data/spec/request/set_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe KJess::Request::Set do
+  it "converts to the protocol" do
+    s = KJess::Request::Set.new( :queue_name => 'test', :data => 'a job' )
+    s.to_protocol.must_equal "SET test 0 0 5\r\na job\r\n"
+  end
+
+  it "sets the expriation time" do
+    s = KJess::Request::Set.new( :queue_name => 'test', :expiration => 42, :data => 'a job' )
+    s.to_protocol.must_equal "SET test 0 42 5\r\na job\r\n"
+  end
+end

data/spec/request/version_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe KJess::Request::Version do
+
+  it "has a keyword" do
+    KJess::Request::Version.keyword.must_equal "VERSION"
+  end
+
+  it "converts to the protocol" do
+    v = KJess::Request::Version.new
+    v.to_protocol.must_equal "VERSION\r\n"
+  end
+
+  it "has a valid response" do
+    KJess::Request::Version.valid_responses.size.must_equal 1
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+class KJess::Spec::TestRequest < KJess::Request
+  keyword "TEST"
+  arity   1
+
+  def parse_options_to_args( opts )
+    opts.values
+  end
+end
+
+describe KJess::Response do
+  it "defines a keyword for child classes" do
+    KJess::Spec::TestRequest.keyword.must_equal 'TEST'
+  end
+
+  it "uses a callback to parse the options to args" do
+    r = KJess::Spec::TestRequest.new( :foo => 'this' )
+    r.args.must_equal %w[ this ]
+  end
+
+  it "converts the request into a protocol stream" do
+    r = KJess::Spec::TestRequest.new( :foo => 'that' )
+    r.to_protocol.must_equal "TEST that\r\n"
+  end
+
+  it "registers child classes" do
+    KJess::Request.registry['TEST'].must_equal KJess::Spec::TestRequest
+  end
+end

data/spec/response/client_error_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe KJess::ClientError do
+  before do
+    @client = KJess::Client.new
+  end
+
+  after do
+    KJess::Spec.reset_server( @client )
+  end
+
+  it "raises a client error if we send an invalid command" do
+    lambda { @client.send_recv( KJess::Request::Status.new ) }.must_raise KJess::ClientError
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+if RUBY_VERSION >= '1.9.2' then
+  require 'simplecov'
+  puts "Using coverage!"
+  SimpleCov.start if ENV['COVERAGE']
+end
+
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'kjess'
+require 'utils'
+

data/spec/utils.rb

@@ -0,0 +1,18 @@
+module KJess
+  module Spec
+    ROOT = File.expand_path( "..", __FILE__ )
+    def self.project_root
+      File.expand_path( "..", ROOT )
+    end
+
+    def self.reset_server( client )
+      client.flush_all
+      qlist = client.stats['queues']
+      if qlist then
+        qlist.keys.each do |q|
+          client.delete( q )
+        end
+      end
+    end
+  end
+end

data/spec/version_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'kjess'
+
+describe KJess::VERSION do
+  it 'should have a #.#.# format' do
+    KJess::VERSION.must_match( /\A\d+\.\d+\.\d+\Z/ )
+    KJess::VERSION.to_s.must_match( /\A\d+\.\d+\.\d+\Z/ )
+  end
+end

data/tasks/kestrel.rake

@@ -0,0 +1,70 @@
+load 'spec/kestrel_server.rb'
+
+namespace :kestrel do
+
+  directory 'kestrel'
+  file KJess::Spec::KestrelServer.zip => 'kestrel' do
+    require 'uri'
+    require 'net/http'
+
+    url = ::URI.parse("http://robey.github.com/kestrel/download/kestrel-#{KJess::Spec::KestrelServer.erver.version}.zip")
+
+    puts "downloading #{url.to_s} to #{KJess::Spec::KestrelServer.zip} ..."
+    File.open( KJess::Spec::KestrelServer.erver.zip, "wb+") do |f|
+      res = Net::HTTP.get_response( url )
+      f.write( res.body )
+    end
+  end
+
+
+  file KJess::Spec::KestrelServer.jar => KJess::Spec::KestrelServer.zip do
+    require 'zip'
+    puts "extracting #{KJess::Spec::KestrelServer.zip}"
+    Zip::ZipFile.open( KJess::Spec::KestrelServer.zip ) do |zipfile|
+      zipfile.entries.each do |entry|
+        next unless entry.file?
+        dest_name = File.join('kestrel', entry.name.strip)
+        dirname   = File.dirname( dest_name )
+        FileUtils.mkdir_p( dirname ) unless File.directory?( dirname )
+        entry.extract( dest_name ) { true }
+      end
+    end
+  end
+
+  desc "Unpack kestrel to use for testing"
+  task :extract => KJess::Spec::KestrelServer.jar
+
+  directory KJess::Spec::KestrelServer.queue_path
+  directory KJess::Spec::KestrelServer.log_path
+
+  file KJess::Spec::KestrelServer.config_file => [ KJess::Spec::KestrelServer.jar,
+                                                   KJess::Spec::KestrelServer.queue_path,
+                                                   KJess::Spec::KestrelServer.log_path ] do
+    File.open( KJess::Spec::KestrelServer.config_file, "w+" ) do |f|
+      puts "Writing #{KJess::Spec::KestrelServer.config_file}"
+      f.write( KJess::Spec::KestrelServer.config_contents )
+    end
+  end
+
+  desc "Start a kestrel server"
+  task :start => KJess::Spec::KestrelServer.config_file do
+    KJess::Spec::KestrelServer.start
+  end
+
+  desc "Stop a kestrel server"
+  task :stop => KJess::Spec::KestrelServer.config_file do
+    KJess::Spec::KestrelServer.stop
+  end
+
+  desc "See the status of the kestrel server"
+  task :status => KJess::Spec::KestrelServer.config_file do
+    KJess::Spec::KestrelServer.status
+  end
+
+  task :clean do
+    FileUtils.rm_rf( KJess::Spec::KestrelServer.dir, :verbose => true )
+  end
+end
+
+task :clean => 'kestrel:clean'
+task :test => KJess::Spec::KestrelServer.config_file

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification 
+name: kjess
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jeremy Hinegardner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-31 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 9
+        - 2
+        - 2
+        version: 0.9.2.2
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 3
+        - 3
+        - 0
+        version: 3.3.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 3
+        - 12
+        version: "3.12"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: zip
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 0
+        - 2
+        version: 2.0.2
+  type: :development
+  version_requirements: *id004
+description: KJess is a pure ruby Kestrel client that supports Kestrel's Memcache style protocol.
+email: jeremy@copiousfreetime.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- HISTORY.rdoc
+- Manifest.txt
+- README.rdoc
+files: 
+- CONTRIBUTING.md
+- HISTORY.rdoc
+- LICENSE
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- example/client_test.rb
+- lib/kjess.rb
+- lib/kjess/client.rb
+- lib/kjess/connection.rb
+- lib/kjess/error.rb
+- lib/kjess/protocol.rb
+- lib/kjess/request.rb
+- lib/kjess/request/delete.rb
+- lib/kjess/request/dump_stats.rb
+- lib/kjess/request/flush.rb
+- lib/kjess/request/flush_all.rb
+- lib/kjess/request/get.rb
+- lib/kjess/request/quit.rb
+- lib/kjess/request/reload.rb
+- lib/kjess/request/set.rb
+- lib/kjess/request/shutdown.rb
+- lib/kjess/request/stats.rb
+- lib/kjess/request/status.rb
+- lib/kjess/request/version.rb
+- lib/kjess/response.rb
+- lib/kjess/response/client_error.rb
+- lib/kjess/response/deleted.rb
+- lib/kjess/response/dumped_stats.rb
+- lib/kjess/response/end.rb
+- lib/kjess/response/eof.rb
+- lib/kjess/response/error.rb
+- lib/kjess/response/flushed_all_queues.rb
+- lib/kjess/response/not_found.rb
+- lib/kjess/response/not_stored.rb
+- lib/kjess/response/reloaded_config.rb
+- lib/kjess/response/server_error.rb
+- lib/kjess/response/stats.rb
+- lib/kjess/response/stored.rb
+- lib/kjess/response/unknown.rb
+- lib/kjess/response/value.rb
+- lib/kjess/response/version.rb
+- lib/kjess/stats_cache.rb
+- spec/client_spec.rb
+- spec/kestrel_server.rb
+- spec/request/set_spec.rb
+- spec/request/version_spec.rb
+- spec/request_spec.rb
+- spec/response/client_error_spec.rb
+- spec/spec_helper.rb
+- spec/utils.rb
+- spec/version_spec.rb
+- tasks/kestrel.rake
+homepage: http://github.com/copiousfreetime/kjess
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --markup
+- tomdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: KJess is a pure ruby Kestrel client that supports Kestrel's Memcache style protocol.
+test_files: 
+- spec/client_spec.rb
+- spec/kestrel_server.rb
+- spec/request/set_spec.rb
+- spec/request/version_spec.rb
+- spec/request_spec.rb
+- spec/response/client_error_spec.rb
+- spec/spec_helper.rb
+- spec/utils.rb
+- spec/version_spec.rb