scribe-rb 2.2.rc3 → 2.2.rc4

data/.travis.yml

@@ -5,3 +5,5 @@ rvm:
   - rbx-2.0
   - jruby
   - ree
+notifications:
+  disabled: true

data/README.md

@@ -9,14 +9,34 @@ from generic *.thrift files.
 This gem tries to alleviate that slight annoyance and package everything
 you need to communicate with Scribe.
 
+It also contains a some "extras" that alleviate a few gotchas I found
+while creating a Scribe consumer/server.
+
 ## Installation
 
-Add to Gemfile:
+### Bundler
+
+Add to `Gemfile` and run `bundle install`:
 
 ```ruby
 gem 'scribe-rb'
 ```
 
+### Without Bundler
+
+Install the gem:
+
+```bash
+gem install scribe-rb
+```
+
+Require it explicitly in your scripts:
+
+```ruby
+require "rubygems"
+require "scribe-rb"
+```
+
 ## Producer (Client)
 
 ```ruby
@@ -43,14 +63,23 @@ transport.close
 # 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
+    # Process the array of LogEntry instances passed
+    messages.each do |message|
+      puts "#{message.category}: #{message.message}"
+    end
+
+    # If messages were processed correctly, return `ResultCode::OK`
+    #
+    # To tell the Scribe producer/broker to resend messages later (e.g.,
+    # because this process is under too much load), return
+    # `ResultCode::TRY_LATER`
+
+    # Must return `ResultCode::OK` or `ResultCode::TRY_LATER`
     ResultCode::OK
   end
 end
 
-# The rest is boilerplate
+# Setup
 handler   = MyScribeHandler.new("My Scribe Handler")
 processor = Scribe::Processor.new(handler)
 
@@ -59,10 +88,12 @@ 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
+# There are multiple options for server type
+# * [Thrift::SimpleServer](http://rubydoc.info/gems/thrift/0.7.0/Thrift/SimpleServer): single threaded server (simplest)
+# * [Thrift::ThreadedServer](http://rubydoc.info/gems/thrift/0.7.0/Thrift/ThreadedServer): server that spawns a thread to handle messages
+# * [Thrift::ThreadPoolServer](http://rubydoc.info/gems/thrift/0.7.0/Thrift/ThreadPoolServer): server that uses a constant number of threads as workers
+# * [Thrift::NonblockingServer](http://rubydoc.info/gems/thrift/0.7.0/Thrift/NonblockingServer): server that uses non-blocking I/O
 server = Thrift::SimpleServer.new(processor, transport, transportFactory, protocolFactory)
-
-# Blocks thread and runs until process is stopped
 server.serve
 ```
 

data/lib/extras/facebook_base_handler.rb

@@ -1,11 +1,14 @@
 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
+      @name           = name
+      @alive          = Time.now.to_i
+
+      @counters       = Hash.new { |h, k| h[k] = 0 }
+      @counters_mutex = Mutex.new
+
+      @options        = Hash.new
+      @options_mutex  = Mutex.new
     end
 
     def getName
@@ -25,23 +28,33 @@ module FacebookService
     end
 
     def getCounters
-      @counters
+      @counters_mutex.synchronize do
+        @counters
+      end
     end
 
     def getCounter(key)
-      @counters[key]
+      @counters_mutex.synchronize do
+        @counters[key]
+      end
     end
 
     def setOption(key, value)
-      @options[key] = value
+      @options_mutex.synchronize do
+        @options[key] = value
+      end
     end
 
     def getOption(key)
-      @options[key]
+      @options_mutex.synchronize do
+        @options[key]
+      end
     end
 
     def getOptions
-      @options
+      @options_mutex.synchronize do
+        @options
+      end
     end
 
     def getCpuProfile(*)

data/lib/extras/queued_log_message_handler.rb

@@ -0,0 +1,23 @@
+require "thread"
+
+module FacebookService
+  class QueuedLogMessageHandler < BaseHandler
+    attr_reader :queue
+
+    def initialize(name)
+      super(name)
+
+      @queue = Queue.new
+    end
+
+    def Log(messages)
+      messages.each do |message|
+        @queue.push(message)
+      end
+
+      ::ResultCode::OK
+    rescue Exception => e
+      ::ResultCode::TRY_LATER
+    end
+  end
+end

data/lib/scribe-rb.rb

@@ -5,3 +5,4 @@ require File.expand_path("generated/scribe", File.dirname(__FILE__))
 
 require File.expand_path("extras/facebook_base_handler", File.dirname(__FILE__))
 require File.expand_path("extras/non_strict_binary_protocol_factory", File.dirname(__FILE__))
+require File.expand_path("extras/queued_log_message_handler", File.dirname(__FILE__))

data/scribe-rb.gemspec

@@ -3,12 +3,12 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "scribe-rb"
-  s.version     = "2.2.rc3"
+  s.version     = "2.2.rc4"
   s.authors     = ["Andy Lindeman"]
   s.email       = ["andy@highgroove.com"]
   s.homepage    = "http://github.com/highgroove/scribe-rb"
   s.summary     = %q{Generated scribe and fb303 bindings for Ruby packed into a gem}
-  s.description = %q{}
+  s.description = %q{Everything you need to build a Ruby producer/client or consumer/server of Scribe messages}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/lib/extras/queued_log_message_handler_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe FacebookService::QueuedLogMessageHandler do
+  subject do
+    described_class.new("Test Handler")
+  end
+
+  describe "#queue" do
+    it "provides access to messages received" do
+      subject.Log(["foo", "bar", "baz"])
+
+      subject.queue.pop.should eq("foo")
+      subject.queue.pop.should eq("bar")
+      subject.queue.pop.should eq("baz")
+    end
+  end
+
+  describe "#log" do
+    it "returns ResultCode::OK" do
+      subject.Log(["foo"]).should eq(ResultCode::OK)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scribe-rb
 version: !ruby/object:Gem::Version
-  version: 2.2.rc3
+  version: 2.2.rc4
   prerelease: 4
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-09 00:00:00.000000000 -04:00
-default_executable: 
+date: 2011-09-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thrift
-  requirement: &21378900 !ruby/object:Gem::Requirement
+  requirement: &2156662740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +21,10 @@ dependencies:
         version: 0.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *21378900
+  version_requirements: *2156662740
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &21378460 !ruby/object:Gem::Requirement
+  requirement: &2156662140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21378460
+  version_requirements: *2156662140
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &21377900 !ruby/object:Gem::Requirement
+  requirement: &2156661320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +43,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *21377900
+  version_requirements: *2156661320
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &21377480 !ruby/object:Gem::Requirement
+  requirement: &2156660580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,8 +54,9 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21377480
-description: ''
+  version_requirements: *2156660580
+description: Everything you need to build a Ruby producer/client or consumer/server
+  of Scribe messages
 email:
 - andy@highgroove.com
 executables: []
@@ -71,6 +71,7 @@ files:
 - Rakefile
 - lib/extras/facebook_base_handler.rb
 - lib/extras/non_strict_binary_protocol_factory.rb
+- lib/extras/queued_log_message_handler.rb
 - lib/generated/facebook_service.rb
 - lib/generated/fb303_constants.rb
 - lib/generated/fb303_types.rb
@@ -81,8 +82,8 @@ files:
 - scribe-rb.gemspec
 - spec/lib/extras/facebook_base_handler_spec.rb
 - spec/lib/extras/non_strict_binary_protocol_factory_spec.rb
+- spec/lib/extras/queued_log_message_handler_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/highgroove/scribe-rb
 licenses: []
 post_install_message: 
@@ -97,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2559920720779231407
+      hash: -57725399886143313
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -106,8 +107,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Generated scribe and fb303 bindings for Ruby packed into a gem
-test_files: []
+test_files:
+- spec/lib/extras/facebook_base_handler_spec.rb
+- spec/lib/extras/non_strict_binary_protocol_factory_spec.rb
+- spec/lib/extras/queued_log_message_handler_spec.rb
+- spec/spec_helper.rb