fraggle-block 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+*.swp
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fraggle-block.gemspec
+gemspec

data/README.md

@@ -0,0 +1,26 @@
+# Fraggle::Block
+
+A synchronous Ruby client for [Doozer](https://github.com/ha/doozer). 
+
+## Install
+
+    $ gem install fraggle-block
+
+## Use
+
+    >> require 'rubygems'
+    >> require 'fraggle/block'
+    >> client = Fraggle::Block.connect
+    => #<Fraggle::Block::Client:0x10217b260 @connection=#<Fraggle::Block::Connection:0x10217bbc0 @cn=#<TCPSocket:0x10217b3c8>, host"127.0.0.1", port8046
+    >> client.set('/foo', 'test', 0)
+    => Fraggle::Block::Response tag: 0, flags: 3, rev: 482
+    >> foo = client.get('/foo')
+    => Fraggle::Block::Response value: "test", tag: 0, flags: 3, rev: 482
+    >> foo = client.getdir('/')
+    => [Fraggle::Block::Response path: "foo", tag: 0, flags: 1, Fraggle::Block::Response path: "ctl", tag: 0, flags: 1, Fraggle::Block::Response tag: 0, flags: 2]
+    >> foo = client.del('/foo', 482)
+    => Fraggle::Block::Response tag: 0, flags: 3
+    >> client.disconnect
+    => nil 
+
+See [examples](https://github.com/dylanegan/fraggle-block/tree/master/examples) for more.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+HOME  = ENV["HOME"]
+PBDIR = HOME+"/Code/heroku/doozer/src/pkg/proto"
+
+namespace :proto do
+  task :update do
+    ENV["BEEFCAKE_NAMESPACE"] = "Fraggle::Block"
+    sh(
+      "protoc",
+      "--beefcake_out", "lib/fraggle/block",
+      "-I",  PBDIR,
+      PBDIR+"/msg.proto"
+    )
+  end
+end
+
+require 'rake/testtask'
+
+namespace :test do
+  Rake::TestTask.new(:all) do |t|
+    t.libs << "test"
+    t.pattern = 'test/**/*_test.rb'
+    t.verbose = true
+  end
+end

data/bin/fraggle-block

@@ -0,0 +1,5 @@
+require 'fraggle/block'
+require 'irb'
+
+@client = Fraggle::Block.connect ARGV.shift
+IRB.start

data/examples/client.rb

@@ -0,0 +1,27 @@
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'rubygems'
+require 'fraggle/block'
+
+client = Fraggle::Block.connect
+
+rev = client.set('/foo', 'test', 0).rev
+puts "Setting /foo to test with rev #{rev}"
+
+foo = client.get('/foo')
+puts "Got /foo with #{foo.value}"
+
+root = client.getdir('/')
+puts "Directly under / is #{root.collect { |file| file.path }.join(', ')}"
+
+client.del('/foo', rev)
+puts "Deleted /foo"
+
+foo = client.get('/foo')
+puts foo.inspect
+
+walk = client.walk('/**')
+walk.each do |file|
+  puts "#{file.path} #{file.rev} #{file.value}"
+end
+
+client.disconnect

data/fraggle-block.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fraggle/block/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fraggle-block"
+  s.version     = Fraggle::Block::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Dylan Egan", "Blake Mizerany"]
+  s.email       = ["dylanegan@gmail.com", "blake.mizerany@gmail.com"]
+  s.homepage    = "https://github.com/dylanegan/fraggle-block"
+  s.summary     = %q{A synchronous Ruby client for Doozer.}
+  s.description = %q{A synchronous Ruby client for Doozer.}
+
+  s.rubyforge_project = "fraggle-block"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "beefcake", "~>0.3"
+  s.add_dependency "system_timer", "1.0"
+
+  s.add_development_dependency "turn"
+end

data/lib/fraggle/block/client.rb

@@ -0,0 +1,86 @@
+require 'fraggle/block/connection'
+
+module Fraggle
+  module Block
+    class Client
+      include Request::Verb
+
+      class OutOfNodes < StandardError; end
+
+      attr_accessor :addrs
+      attr_reader :connection
+
+      def initialize(addrs = [])
+        @addrs = addrs
+        connect
+      end
+
+      def rev
+        request = Request.new(:verb => REV)
+        send(request).first
+      end
+
+      def get(path, rev = nil)
+        request = Request.new(:path => path, :rev => rev, :verb => GET)
+        send(request).first
+      end
+
+      def getdir(path, rev = nil, offset = nil, limit = nil)
+        request = Request.new(:path => path, :rev => rev, :offset => offset, :limit => limit, :verb => GETDIR)
+        send(request)
+      end
+
+      def set(path, value, rev)
+        request = Request.new(:path => path, :value => value, :rev => rev, :verb => SET)
+        send(request).first
+      end
+
+      def del(path, rev)
+        request = Request.new(:path => path, :rev => rev, :verb => DEL)
+        send(request).first
+      end
+
+      def walk(path, rev = nil)
+        request = Request.new(:path => path, :rev => rev, :verb => WALK)
+        send(request)
+      end
+
+      def disconnect
+        @connection.disconnect
+      end
+
+      def reconnect
+        disconnect
+        connect
+      end
+
+      def connect
+        begin
+          host, port = @addrs.shift.split(':')
+          @connection = connection_to(host, port)
+          find_all_of_the_nodes
+        rescue => e
+          retry if @addrs.any?
+          raise OutOfNodes, "where did they go?"
+        end
+      end
+
+      def connection_to(host, port)
+        Connection.new(host, port)
+      end
+
+      def find_all_of_the_nodes
+        walk('/ctl/node/*/addr').each do |node|
+          @addrs << node.value unless @addrs.include? node.value
+        end
+      end
+
+    protected
+
+      def send(request)
+        @connection.send(request)
+        @connection.read
+      end
+    end
+  end
+end

data/lib/fraggle/block/connection.rb

@@ -0,0 +1,53 @@
+require 'fraggle/block/msg.pb'
+require 'socket'
+require "system_timer"
+
+module Fraggle
+  module Block
+    class Connection
+      attr_accessor :host, :port, :sock
+
+      def initialize(host, port)
+        @host = host
+        @port = port
+        @sock = connect
+      end
+
+      def address
+        "#{@host}:#{@port}"
+      end
+
+      def connect
+        SystemTimer.timeout_after(10) do
+          s = TCPSocket.new(@host, @port)
+          s.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
+          s
+        end
+      end
+
+      def disconnect
+        @sock.close
+      end
+
+      def send(req)
+        req.tag = 0
+        data = req.encode
+        head = [data.length].pack("N")
+        @sock.write(head+data)
+      end
+
+      def read
+        responses = []
+        loop do
+          head = @sock.read(4)
+          length = head.unpack("N")[0]
+          data = @sock.read(length)
+          response = Response.decode(data)
+          responses << response if response.valid? 
+          break if response.done?
+        end
+        responses
+      end
+    end
+  end
+end

data/lib/fraggle/block/msg.pb.rb

@@ -0,0 +1,63 @@
+## Generated from msg.proto for proto
+require "beefcake"
+
+module Fraggle
+  module Block
+
+    class Request
+      include Beefcake::Message
+
+      module Verb
+        GET = 1
+        SET = 2
+        DEL = 3
+        ESET = 4
+        REV = 5
+        NOP = 7
+        WATCH = 8
+        WALK = 9
+        CANCEL = 10
+        GETDIR = 14
+        STAT = 16
+      end
+
+      required :tag, :int32, 1
+      required :verb, Request::Verb, 2
+      optional :path, :string, 4
+      optional :value, :bytes, 5
+      optional :other_tag, :int32, 6
+      optional :offset, :int32, 7
+      optional :limit, :int32, 8
+      optional :rev, :int64, 9
+
+    end
+
+    class Response
+      include Beefcake::Message
+
+      module Err
+        OTHER = 127
+        TAG_IN_USE = 1
+        UNKNOWN_VERB = 2
+        REDIRECT = 3
+        TOO_LATE = 4
+        REV_MISMATCH = 5
+        BAD_PATH = 6
+        MISSING_ARG = 7
+        NOTDIR = 20
+        ISDIR = 21
+        NOENT = 22
+      end
+
+      required :tag, :int32, 1
+      required :flags, :int32, 2
+      optional :rev, :int64, 3
+      optional :path, :string, 5
+      optional :value, :bytes, 6
+      optional :len, :int32, 8
+      optional :err_code, Response::Err, 100
+      optional :err_detail, :string, 101
+
+    end
+  end
+end

data/lib/fraggle/block/response.rb

@@ -0,0 +1,16 @@
+module Fraggle
+  module Block
+    class Response
+      VALID = 1
+      DONE = 2
+
+      def valid?
+        (flags & VALID) > 0
+      end
+
+      def done?
+        (flags & DONE) > 0
+      end
+    end
+  end
+end

data/lib/fraggle/block/version.rb

@@ -0,0 +1,5 @@
+module Fraggle
+  module Block
+    VERSION = '0.1.0'
+  end
+end

data/lib/fraggle/block.rb

@@ -0,0 +1,42 @@
+require 'fraggle/block/client'
+require 'fraggle/block/response'
+
+module Fraggle
+  module Block
+    DEFAULT_URI = "doozerd:?" + [
+      "ca=127.0.0.1:8046",
+      "ca=127.0.0.1:8041",
+      "ca=127.0.0.1:8042",
+      "ca=127.0.0.1:8043"
+    ].join("&")
+
+    def self.connect(uri=nil)
+      uri = uri || ENV["DOOZER_URI"] || DEFAULT_URI
+
+      addrs = URI.parse(uri)
+
+      if addrs.length == 0
+        raise ArgumentError, "there were no addrs supplied in the uri (#{uri.inspect})"
+      end
+
+      Client.new(addrs)
+    end
+
+    module URI
+      def self.parse(u)
+        if u =~ /^doozerd:\?(.*)$/
+          parts = $1.split("&")
+          parts.inject([]) do |m, pt|
+            k, v = pt.split("=")
+            if k == "ca"
+              m << v
+            end
+            m
+          end
+        else
+          raise ArgumentError, "invalid doozerd uri"
+        end
+      end
+    end
+  end
+end

data/test/client_test.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/helper'
+
+module Fraggle
+  module Block
+    class ClientTest < Test::Unit::TestCase
+      include Request::Verb
+      def setup
+        @client = Fraggle::Block::MockClient.new(['1.1.1.1:1'])
+        @connection = @client.connection
+      end
+
+      def test_simple_reconnect
+        assert_equal '1.1.1.1:1', @client.connection.address
+        @client.addrs = ['127.0.0.1:8047', '127.0.0.1:8048']
+        @client.reconnect
+        assert_equal '127.0.0.1:8047', @client.connection.address
+        @client.reconnect
+        assert_equal '127.0.0.1:8048', @client.connection.address
+        assert_raises(Fraggle::Block::Client::OutOfNodes) { @client.reconnect }
+      end
+
+      def test_simple_rev
+        exp = write_response(Response.new(:rev => 0))
+        assert_equal exp.first, @client.rev
+        assert_equal [Request.new(:verb => REV, :tag => 0)], @connection.sent
+      end
+
+      def test_simple_get
+        exp = write_response(Response.new(:value => 'bar'))
+        assert_equal exp.first, @client.get('/foo')
+        assert_equal [Request.new(:verb => GET, :tag => 0, :path => '/foo')], @connection.sent
+      end
+
+      def test_simple_getdir
+        exp = write_response([Response.new(:verb => GETDIR, :path => '/foo/bar', :flags => 1), Response.new(:verb => GETDIR, :path => '/foo/baz')])
+        response = @client.getdir('/foo')
+        assert_equal exp, response
+        assert_equal '/foo/baz', response.last.path
+        assert_equal [Request.new(:verb => GETDIR, :tag => 0, :path => '/foo')], @connection.sent
+      end
+
+      def test_simple_set
+        exp = write_response(Response.new(:rev => 10))
+        assert_equal exp.first, @client.set('/foo', 'bar', 0)
+        assert_equal [Request.new(:verb => SET, :tag => 0, :path => '/foo', :value => 'bar', :rev => 0)], @connection.sent
+      end
+
+      def test_simple_del
+        exp = write_response(Response.new(:flags => 1|2))
+        assert_equal exp.first, @client.del('/foo', 0)
+        assert_equal [Request.new(:verb => DEL, :tag => 0, :path => '/foo', :rev => 0)], @connection.sent
+      end
+
+      def test_simple_walk
+        exp = write_response([Response.new(:verb => WALK, :path => '/foo/bar', :flags => 1), Response.new(:verb => WALK, :path => '/foo/baz')])
+        assert_equal exp, @client.walk('/foo/*')
+        assert_equal [Request.new(:verb => WALK, :tag => 0, :path => '/foo/*')], @connection.sent
+      end
+    end
+  end
+end

data/test/connection_test.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/helper'
+
+module Fraggle
+  module Block
+    class ConnectionTest < Test::Unit::TestCase
+      include Request::Verb 
+      def setup
+        @connection = Fraggle::Block::MockConnection.new('1.1.1.1', 1)
+      end
+
+      def test_simple_request
+        request = Fraggle::Block::Request.new(:verb => GET, :path => '/foo')
+        @connection.send(request)
+        @connection.sock.rewind
+
+        request.tag = 0
+        encoded = request.encode
+        head = [encoded.length].pack("N")
+        assert_equal head+encoded, @connection.sock.read
+      end
+
+      def test_simple_response
+        exp = write_response(Response.new(:value => 'test', :rev => 0))
+        @connection.sock.rewind
+        assert_equal exp, @connection.read
+      end
+
+      def test_simple_disconnect
+        assert !@connection.sock.closed?
+        @connection.disconnect
+        assert @connection.sock.closed?
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,54 @@
+require 'test/unit'
+require 'stringio'
+
+require 'rubygems'
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'fraggle/block'
+
+module Fraggle
+  module Block
+    class MockConnection < Connection
+      attr_reader :sent
+
+      def connect
+        StringIO.new
+      end
+
+      def send(request)
+        @sent = [request]
+        super
+      end
+    end
+
+    class MockClient < Client
+      def send(request)
+        @connection.send(request)
+        @connection.sock.rewind
+        @connection.read
+      end
+
+      def connection_to(host, port)
+        MockConnection.new(host, port)
+      end
+
+      def find_all_of_the_nodes
+        @addrs
+      end
+    end
+  end
+end
+
+class Test::Unit::TestCase
+  def write_response(responses)
+    @connection.sock.reopen
+    responses = Array(responses)
+    responses.each do |response|
+      response.tag = 0
+      response.flags ||= 1|2
+      encoded = response.encode.to_s
+      head = [response.encode.length].pack("N")
+      @connection.sock.write head+encoded
+    end
+    responses
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: fraggle-block
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dylan Egan
+- Blake Mizerany
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: beefcake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 3
+        version: "0.3"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: system_timer
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: turn
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: A synchronous Ruby client for Doozer.
+email: 
+- dylanegan@gmail.com
+- blake.mizerany@gmail.com
+executables: 
+- fraggle-block
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/fraggle-block
+- examples/client.rb
+- fraggle-block.gemspec
+- lib/fraggle/block.rb
+- lib/fraggle/block/client.rb
+- lib/fraggle/block/connection.rb
+- lib/fraggle/block/msg.pb.rb
+- lib/fraggle/block/response.rb
+- lib/fraggle/block/version.rb
+- test/client_test.rb
+- test/connection_test.rb
+- test/helper.rb
+homepage: https://github.com/dylanegan/fraggle-block
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: fraggle-block
+rubygems_version: 1.7.1
+signing_key: 
+specification_version: 3
+summary: A synchronous Ruby client for Doozer.
+test_files: 
+- test/client_test.rb
+- test/connection_test.rb
+- test/helper.rb