pokan 0.1.0rc1

data/lib/pokan/server_messages.rb

@@ -0,0 +1,27 @@
+# lib/pokan/pokan_messages.rb
+
+module Pokan
+  module ServerMessages
+    # Gets a message for the introduction of the new peer to the seed
+    def hello_message
+      { action: 'hello', origin:"#{address}:#{port}" }.to_json
+    end
+
+    ##
+    # Gets the message that the peer needs to send when is going to stop participating of the group
+    def goodbye_message
+      { action: 'goodbye', origin:"#{address}:#{port}" }.to_json
+    end
+
+    ##
+    # Gets a digest containing all peers' key/timestamp of all peers
+    # It returns a json with all the pairs for each peer in a Digest Structure
+    def digest_message
+      data= Hash.new
+      peers = Query.new(Peer).where(role:['peer','seed'], status:'alive')
+      peers.each { |peer| data[peer.id] = peer.digest }
+
+      { action: 'digest', data: data, origin:"#{address}:#{port}" }.to_json
+    end
+  end
+end

data/lib/pokan/version.rb

@@ -0,0 +1,3 @@
+module Pokan #:nodoc:
+  VERSION = "0.1.0rc1" unless defined? Pokan::VERSION
+end

data/pokan.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "pokan"
+  s.version = "0.1.0rc1"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Renato Mascarenhas", "Rafael Regis do Prado", "Fabio Lima Pereira"]
+  s.date = "2011-11-10"
+  s.description = "pokan is an implementation of the Gossip protocol \n    (best described in http://www.cs.cornell.edu/home/rvr/papers/flowgossip.pdf),\n    which aims to have a simple, event based API capable of being used in large,\n    not previously known networks."
+  s.email = "haze-gem@googlegroups.com"
+  s.files = [
+    "pokan.gemspec"
+  ]
+  s.homepage = "http://github.com/haze/pokan"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Gossip-protocol implementation with an event based API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
+      s.add_runtime_dependency(%q<redis>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<guard>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<eventmachine>, [">= 0"])
+      s.add_dependency(%q<redis>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, [">= 0"])
+    s.add_dependency(%q<redis>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+  end
+end

data/spec/pokan/connection_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Pokan::Connection do
+  it "should instance only one Redis object" do
+    @client1 = Pokan::Connection.redis
+    @client2 = Pokan::Connection.redis
+    @client1.should == @client2
+  end
+end
+

data/spec/pokan/entity_spec.rb

@@ -0,0 +1,147 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Pokan::Entity do
+  context 'when comparing key-values' do
+    before :all do
+      Pokan::Connection.redis.flushall
+      @entity = Pokan::Entity.new
+      @entity.id = '1'
+      @entity.store(:k1, "v1")
+      @entity.store(:k2, 5.0)
+    end
+
+    it 'should return true if the internal key have the same value' do
+      @entity.match?(k1: 'v1').should be_true
+    end
+
+    it 'should return false if the internal key doesnt have the same value' do
+      @entity.match?(k1: 'v2').should_not be_true
+    end
+
+    it 'should return true if the internal key is one of the array' do
+      @entity.match?(k1: ['v1', 'v2']).should be_true
+    end
+
+    it 'should return false if the internal key isnt one of the array' do
+      @entity.match?(k1: ['v3', 'v2']).should_not be_true
+    end
+
+    it 'should return true if the value for a given key is in the range' do
+      @entity.match?(k2: { min: 3.0, max: 10.0 }).should be_true
+    end
+
+    it 'should return true if the value for a given key is in the range' do
+      @entity.match?(k2: { min:6.0, max: 10.0 }).should_not be_true
+    end
+  end
+
+  context 'when storing a value' do
+    before :all do
+      Pokan::Connection.redis.flushall
+      @entity = Pokan::Entity.new
+      @entity.id = '1'
+      @entity.store(:test, 'OK')
+      @entity.save
+      @entity.reload
+    end
+
+    it 'should store a new value for a key' do
+      @entity.value(:test).should == 'OK'
+    end
+
+    it 'should store a timestamp for a key' do
+      @entity.timestamp(:test).should < Time.now
+    end
+
+    it "should update the timestamp of an updated key" do
+      new = @entity.timestamp(:status)
+      @entity.store(:local, 'somewhere')
+      @entity.save
+      @entity.reload
+      newer = @entity.timestamp(:local)
+      newer.to_f.should > new.to_f
+    end
+  end
+
+  context 'when retrieving a value' do
+    before :all do
+      Pokan::Connection.redis.flushall
+      @entity = Pokan::Peer.new
+      @entity.id = '1'
+      @entity.store(:test, 'OK')
+      @entity.save
+      @entity.reload
+    end
+
+    it 'should get the value for a given key' do
+      @entity.value(:test).should == 'OK'
+    end
+
+    it 'should return nil if a value doesn\'t exist' do
+      @entity.value(:other_test).should be_nil
+    end
+
+    it 'should return zero to timestamp if a value doesn\'t exist' do
+      @entity.timestamp(:other_test).should == Time.at(0)
+    end
+  end
+
+  context 'when merging new data to a entity' do
+    before :each do
+      Pokan::Connection.redis.flushall
+      @entity = Pokan::Entity.new
+      @entity.id = '1'
+      @entity.store(:local, 'GREAT')
+      @entity.save
+      @entity.reload
+    end
+
+    it 'should merge with a new set preserving newer values' do
+      @entity.merge({
+        local: { value: 'GREATER', timestamp: Time.now.to_f + 2000 }
+      })
+      @entity.value(:local).should == 'GREATER'
+    end
+
+    it 'should merge with a new set discarding older values' do
+      @entity.merge({
+        local: {value: 'NOT GREAT', timestamp: 50}
+      })
+      @entity.value(:local).should == 'GREAT'
+    end
+  end
+
+  context 'when getting data for gossip' do
+    before :all do
+      Pokan::Connection.redis.flushall
+      @entity = Pokan::Entity.new
+      @entity.id = '1'
+      @entity.store(:foo, 'bar')
+      @entity.store(:local, 'OK')
+      @entity.save
+      @entity.reload
+    end
+
+    it 'should return all key/timestamps of a peer' do
+      @entity.digest.keys.should =~ [:local, :foo]
+    end
+
+    it 'should return all older keys of a peer' do
+      digest = {local: 0, foo: (Time.now.to_f + 1000).to_s}
+      @entity.older(digest).should == [:foo]
+    end
+
+    it 'should return all newer key/value/timestamps of an peer' do
+      digest = {local: 0, foo: (Time.now.to_f + 1000).to_s}
+      @entity.newer(digest)[:local][:value].should_not == nil
+    end
+
+    it 'should return all the peer\'s keys' do
+      @entity.keys.should =~ [:foo, :local]
+    end
+
+    it 'should return the keys, values and timestamps of all required keys' do
+      @entity.values([:local])[:local][:value].should == 'OK'
+    end
+  end
+end

data/spec/pokan/event_handler_spec.rb

@@ -0,0 +1,84 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Pokan::EventHandler do
+
+  before :each do
+    @event_handler = Pokan::EventHandler.new
+  end
+
+  it 'should register a new event' do
+    register_callback(:dummy)
+
+    @event_handler.events.should include :dummy
+  end
+
+  it 'should raise ArgumentError if event name is not a symbol' do
+    expect { @event_handler.register 'dummy' }.to raise_exception ArgumentError
+  end
+
+  it 'should not allow a call to `register` without a block' do
+    expect { @event_handler.register :dummy }.to raise_exception Pokan::NoBlockGivenError
+  end
+
+  it 'should list no subscribers for a not registered event' do
+    @event_handler.subscribers(:dummy).should be_empty
+  end
+
+  it 'should list all subscribers for an event' do
+    3.times { register_callback(:dummy) }
+
+    @event_handler.subscribers(:dummy).size.should == 3
+  end
+
+  it 'should do nothing when `emit` is called for an unexisting event' do
+    @event_handler.emit(:dummy).should == @event_handler
+  end
+
+  it 'should call registered callbacks after `emit`' do
+    @block_called = false
+    register_callback(:dummy)
+
+    @event_handler.emit(:dummy)
+
+    @block_called.should be_true
+  end
+
+  it 'should call registered callbacks twice' do
+    @block_called = false
+    register_callback(:dummy)
+
+    @event_handler.emit(:dummy)
+    @block_called.should be_true
+
+    @block_called = false
+    @event_handler.emit(:dummy)
+
+    @block_called.should be_true
+  end
+
+  it 'should pass correct parameters when `emit` is called using `with` option' do
+    @parameter = false
+
+    @event_handler.register :dummy do |message|
+      @parameter = message  
+    end
+
+    @event_handler.emit :dummy, :with => [true]
+    @parameter.should be_true
+  end
+
+  it 'should reset registered callbacks for an event' do
+    3.times { register_callback(:dummy) }
+
+    @event_handler.reset(:dummy)
+
+    @event_handler.subscribers(:dummy).should be_empty
+  end
+
+  def register_callback(event)
+    @event_handler.register event do
+      @block_called = true
+    end
+  end
+
+end

data/spec/pokan/network_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Pokan::Network do
+
+  context 'when sending via UDP' do
+
+    it 'should send the message' do
+      Pokan::Network.udp('dummy', '127.0.0.1', 7777).should be_true
+    end
+
+  end
+
+  context 'when sending a message via TCP without a server to accept it' do
+
+    it 'should not send the message' do
+      Pokan::Network.tcp('dummy', '127.0.0.1', 7777).should be_false
+    end
+
+  end
+
+  context 'when sending a message via TCP with a server accepting' do
+
+    before { @server = TCPServer.open(7777) }
+    after { @server.close }
+
+    it 'should send the message' do
+      Pokan::Network.tcp('dummy', '127.0.0.1', 7777).should be_true
+    end
+
+  end
+
+end

data/spec/pokan/peer_spec.rb

@@ -0,0 +1,94 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Pokan::Peer do
+  context 'when checking the status of the peer' do
+    before :all do
+      Pokan::Connection.redis.flushall
+    end
+
+    it 'should check if a peer is dead' do
+      peer = Pokan::Peer.new
+      peer.address = peer.udp_port = '3'
+      peer.kill
+      peer.save
+      peer.reload
+      peer.dead?.should be_true
+    end
+
+    it 'should check if a peer is not dead' do
+      peer = Pokan::Peer.new
+      peer.address = peer.udp_port = '3'
+      peer.save
+      peer.reload
+      peer.dead?.should be_false
+    end
+
+    it 'should check if a peer is not alive' do
+      peer = Pokan::Peer.new
+      peer.address = peer.udp_port = '3'
+      peer.kill
+      peer.save
+      peer.alive?.should be_false
+    end
+
+    it 'should check if peer is alive' do
+      peer = Pokan::Peer.new
+      peer.address = peer.udp_port = '3'
+      peer.save
+      peer.alive?.should be_true
+    end
+  end
+
+  context 'when changing the status of a peer' do
+    before :all do
+      Pokan::Connection.redis.flushall
+    end
+
+    it 'should not set a new status if the timestamp is not greater' do
+      peer = Pokan::Peer.new
+      peer.address = peer.udp_port = '3'
+      peer.store(:status, 'dead', Time.at(0))
+      peer.save
+      peer.reload
+      peer.dead?.should be_false
+    end
+
+    it 'should set a new status if the timestamp is greater' do
+      peer = Pokan::Peer.new
+      peer.address = peer.udp_port = '3'
+      peer.store('status', 'dead', Time.now + 1000)
+      peer.save
+      peer.reload
+      peer.dead?.should be_true
+    end
+  end
+
+  context 'when setting up a peer' do
+    before :all do
+      Pokan::Connection.redis.flushall
+      @peer = Pokan::Peer.new
+      @peer.address = @peer.udp_port = '3'
+      @peer.save
+    end
+
+    it 'should start as a normal peer' do
+      @peer.seed?.should be_false
+    end
+
+    it 'should start act as a seed' do
+      @peer.act_as_seed
+      @peer.save
+      @peer.seed?.should be_true
+    end
+
+    it 'should kill a peer' do
+      @peer.kill
+      @peer.dead?.should be_true
+    end
+
+    it 'should revive a peer' do
+      @peer.revive
+      @peer.dead?.should be_false
+    end
+  end
+end