scribe-rb 2.2.rc1 → 2.2.rc2

data/README.md

@@ -7,7 +7,7 @@ from generic *.thrift files.
 This gem tries to alleviate that slight annoyance and package everything
 you need to communicate with Scribe.
 
-## Usage
+## Installation
 
 Add to Gemfile:
 
@@ -15,7 +15,7 @@ Add to Gemfile:
 gem 'scribe-rb'
 ```
 
-Talk to Scribe:
+## Producer (Client)
 
 ```ruby
 # Setup
@@ -35,6 +35,35 @@ client.Log([log_entry])
 transport.close
 ```
 
+## Consumer (Server)
+
+```ruby
+# Define a handler that inherits from FacebookService::BaseHandler
+class MyScribeHandler < FacebookService::BaseHandler
+  def Log(messages)
+    # messages will be an array of LogEntry instances from Scribe
+
+    # must return either ResultCode::OK or ResultCode::TRY_LATER
+    ResultCode::OK
+  end
+end
+
+# The rest is boilerplate
+handler   = MyScribeHandler.new("My Scribe Handler")
+processor = Scribe::Processor.new(handler)
+
+transport = Thrift::ServerSocket.new(5678) # 5678 is port number
+
+transportFactory = Thrift::FramedTransportFactory.new
+protocolFactory  = Thrift::NonStrictBinaryProtocolFactory.new
+
+# Other server options exist; check Thrift documentation for details
+server = Thrift::SimpleServer.new(processor, transport, transportFactory, protocolFactory)
+
+# Blocks thread and runs until process is stopped
+server.serve
+```
+
 ## Hat Tips
 
 * [Installing and Using Scribe with Ruby on Mac OS](http://kpumuk.info/development/installing-and-using-scribe-with-ruby-on-mac-os/)

data/lib/facebook_base_handler.rb

@@ -0,0 +1,61 @@
+module FacebookService
+  # TODO: Not thread safe
+  class BaseHandler
+    def initialize(name)
+      @name     = name
+      @alive    = Time.now.to_i
+      @counters = Hash.new { |h, k| h[k] = 0 }
+      @options  = Hash.new
+    end
+
+    def getName
+      @name
+    end
+
+    def getVersion
+      ""
+    end
+
+    def getStatus
+      Fb_status::ALIVE
+    end
+
+    def getStatusDetails
+      ""
+    end
+
+    def getCounters
+      @counters
+    end
+
+    def getCounter(key)
+      @counters[key]
+    end
+
+    def setOption(key, value)
+      @options[key] = value
+    end
+
+    def getOption(key)
+      @options[key]
+    end
+
+    def getOptions
+      @options
+    end
+
+    def getCpuProfile(*)
+      ""
+    end
+
+    def aliveSince
+      @alive
+    end
+
+    def reinitialize
+    end
+
+    def shutdown
+    end
+  end
+end

data/lib/scribe-rb.rb

@@ -1 +1,3 @@
 require File.join(File.dirname(__FILE__), "scribe")
+require File.join(File.dirname(__FILE__), "facebook_base_handler")
+require File.join(File.dirname(__FILE__), "thrift_extras")

data/lib/thrift_extras.rb

@@ -0,0 +1,10 @@
+# For some reason, strict_read and strict_write need to be disabled to
+# receive messages from Scribe. The basic Thrift library generated for
+# Ruby does not appear to easily allow that.
+module Thrift
+  class NonStrictBinaryProtocolFactory < BinaryProtocolFactory
+    def get_protocol(trans)
+      return Thrift::BinaryProtocol.new(trans, false, false)
+    end
+  end
+end

data/scribe-rb.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "scribe-rb"
-  s.version     = "2.2.rc1"
+  s.version     = "2.2.rc2"
   s.authors     = ["Andy Lindeman"]
   s.email       = ["andy@highgroove.com"]
   s.homepage    = "http://github.com/highgroove/scribe-rb"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: scribe-rb
 version: !ruby/object:Gem::Version 
-  hash: 15424215
+  hash: 15424209
   prerelease: 4
   segments: 
   - 2
   - 2
   - rc
-  - 1
-  version: 2.2.rc1
+  - 2
+  version: 2.2.rc2
 platform: ruby
 authors: 
 - Andy Lindeman
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-08 00:00:00 Z
+date: 2011-09-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -62,6 +62,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- lib/facebook_base_handler.rb
 - lib/facebook_service.rb
 - lib/fb303_constants.rb
 - lib/fb303_types.rb
@@ -69,6 +70,7 @@ files:
 - lib/scribe.rb
 - lib/scribe_constants.rb
 - lib/scribe_types.rb
+- lib/thrift_extras.rb
 - scribe-rb.gemspec
 homepage: http://github.com/highgroove/scribe-rb
 licenses: []