scribe 0.1

data/CHANGELOG

@@ -0,0 +1,2 @@
+
+v0.1. First release.

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Manifest

@@ -0,0 +1,17 @@
+CHANGELOG
+LICENSE
+Manifest
+README
+Rakefile
+conf/scribe.conf
+lib/scribe.rb
+lib/scribe/safe_client.rb
+lib/scribe/scribe.rb
+test/scribe_test.rb
+test/test_helper.rb
+vendor/gen-rb/facebook_service.rb
+vendor/gen-rb/fb303_constants.rb
+vendor/gen-rb/fb303_types.rb
+vendor/gen-rb/scribe.rb
+vendor/gen-rb/scribe_constants.rb
+vendor/gen-rb/scribe_types.rb

data/README

@@ -0,0 +1,56 @@
+
+scribe
+
+A Ruby client for the Scribe distributed log server.
+
+== License
+
+Copyright 2009 Twitter, Inc. See included LICENSE file.
+
+The public certificate for this gem is here[http://rubyforge.org/frs/download.php/25331/evan_weaver-original-public_cert.pem].
+
+== Features
+
+* clean encapsulation of the Thrift API
+* Ruby 1.9 compatibility
+
+The Github source repository is {here}[http://github.com/fauna/scribe/]. Patches and contributions are very welcome.
+
+== Installation
+
+You need Ruby 1.8 or 1.9. If you have those, just run:
+
+  sudo gem install scribe
+
+== Usage
+
+Now, start IRb and require the library:
+
+  require 'scribe'
+
+Connect to a server:
+
+  client = Scribe.new('127.0.0.1')
+
+Log a line:
+
+  client.log("started up")
+
+Log a line with a category:
+
+  client.log("my app started up", "MyApp")
+
+Batch a number of log lines and send them all at once:
+
+  client.batch do
+    client.log("booting")
+    client.log("loading data")
+    client.log("success!")
+  end
+  
+That is all.
+
+== Reporting problems
+
+The Github issue tracker is {here}[http://github.com/fauna/scribe/issues]. If you have problems with Scribe itself, please use the {scribe-users mailing list}[http://sourceforge.net/mailarchive/forum.php?forum_name=scribeserver-users].
+

data/Rakefile

@@ -0,0 +1,39 @@
+
+begin
+  require 'rubygems'
+  require 'echoe'
+  
+  Echoe.new("scribe") do |p|
+    p.author = "Evan Weaver"
+    p.project = "fauna"
+    p.summary = "A Ruby client for the Scribe distributed log server."
+    p.rubygems_version = ">= 0.8"
+    p.dependencies = ['thrift', 'rake']
+    p.ignore_pattern = /^(vendor\/thrift)/
+    p.rdoc_pattern = /^(lib|bin|tasks|ext)|^README|^CHANGELOG|^TODO|^LICENSE|^COPYING$/
+    p.url = "http://blog.evanweaver.com/files/doc/fauna/scribe/"
+    p.docs_host = "blog.evanweaver.com:~/www/bax/public/files/doc/"
+  end
+rescue LoadError
+end
+
+desc "Start Scribe"
+task :scribe do
+  system("mkdir /tmp/scribetest/") unless File.exist?("/tmp/scribetest/")
+  system("scribed -c #{File.expand_path(File.dirname(__FILE__))}/conf/scribe.conf &")
+end
+
+desc "Stop Scribe"
+task :stop do
+  system("killall scribed")
+end
+
+desc "Restart Scribe"
+task :restart => ["stop", "scribe"] do
+end
+
+# desc "Regenerate thrift bindings for Cassandra" # Dev only
+task :thrift do
+  puts "Generating Thrift bindings"
+  # FIXME
+end

data/conf/scribe.conf

@@ -0,0 +1,39 @@
+##
+## Sample Scribe configuration
+##
+
+# This file configures Scribe to listen for messages on port 1463 and write
+# them to /tmp/scribetest
+
+port=1463
+max_msg_per_second=2000000
+check_interval=3
+
+# DEFAULT
+<store>
+category=default
+type=buffer
+
+target_write_size=20480
+max_write_interval=1
+buffer_send_rate=2
+retry_interval=30
+retry_interval_range=10
+
+<primary>
+type=file
+fs_type=std
+file_path=/tmp/scribetest
+base_filename=thisisoverwritten
+max_size=1000000
+add_newlines=1
+</primary>
+
+<secondary>
+type=file
+fs_type=std
+file_path=/tmp
+base_filename=thisisoverwritten
+max_size=3000000
+</secondary>
+</store>

data/lib/scribe.rb

@@ -0,0 +1,19 @@
+
+require 'rubygems'
+require 'thrift'
+
+HERE = File.expand_path(File.dirname(__FILE__))
+
+$LOAD_PATH << "#{HERE}/../vendor/gen-rb"
+require "#{HERE}/../vendor/gen-rb/scribe"
+
+Object.const_set("ScribeThrift", Scribe)
+Object.send(:remove_const, "Scribe")
+
+ScribeThrift.const_set("LogEntry", LogEntry)
+Object.send(:remove_const, "LogEntry")
+
+$LOAD_PATH << "#{HERE}"
+require 'scribe/safe_client'
+require 'scribe/scribe'
+require 'scribe/debug' if ENV['DEBUG']

data/lib/scribe/safe_client.rb

@@ -0,0 +1,23 @@
+
+module ScribeThrift #:nodoc: all
+  class SafeClient  
+    def initialize(client, transport, reset = false)
+      @client = client 
+      @transport = transport
+      @reset = reset
+    end
+    
+    def reset_transport
+      @transport.close rescue nil
+      @transport.open
+    end
+    
+    def method_missing(*args)
+      reset_transport if @reset
+      @client.send(*args)
+    rescue IOError, UnavailableException, Thrift::ProtocolException, Thrift::ApplicationException, Thrift::TransportException
+      reset_transport
+      @client.send(*args)
+    end
+  end
+end

data/lib/scribe/scribe.rb

@@ -0,0 +1,31 @@
+
+class Scribe
+  def initialize(host = "127.0.0.1", port = 1463, category = "Ruby")
+    @host = host
+    @port = port
+    @category = category
+
+    transport = Thrift::FramedTransport.new(Thrift::Socket.new(@host, @port))
+    transport.open
+    
+    @client = ScribeThrift::SafeClient.new(
+      ScribeThrift::Client.new(Thrift::BinaryProtocol.new(transport, false)),
+      transport)
+  end
+
+  def log(message, category = @category)
+    raise ArgumentError, "Message must be a string" unless message.is_a?(String)
+    raise ArgumentError, "Category must be a string" unless category.is_a?(String)
+    
+    entry = ScribeThrift::LogEntry.new(:message => message, :category => category)
+    @batch ? @batch << entry : @client.Log(Array(entry))
+  end
+  
+  def batch
+    @batch = []
+    yield
+    @client.Log(@batch)
+  ensure
+    @batch = nil
+  end
+end

data/scribe.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{scribe}
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0.8") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Evan Weaver"]
+  s.cert_chain = ["/Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-public_cert.pem"]
+  s.date = %q{2009-09-30}
+  s.description = %q{A Ruby client for the Scribe distributed log server.}
+  s.email = %q{}
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/scribe.rb", "lib/scribe/safe_client.rb", "lib/scribe/scribe.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "conf/scribe.conf", "lib/scribe.rb", "lib/scribe/safe_client.rb", "lib/scribe/scribe.rb", "test/scribe_test.rb", "test/test_helper.rb", "vendor/gen-rb/facebook_service.rb", "vendor/gen-rb/fb303_constants.rb", "vendor/gen-rb/fb303_types.rb", "vendor/gen-rb/scribe.rb", "vendor/gen-rb/scribe_constants.rb", "vendor/gen-rb/scribe_types.rb", "scribe.gemspec"]
+  s.homepage = %q{http://blog.evanweaver.com/files/doc/fauna/scribe/}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Scribe", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{fauna}
+  s.rubygems_version = %q{1.3.4}
+  s.signing_key = %q{/Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-private_key.pem}
+  s.summary = %q{A Ruby client for the Scribe distributed log server.}
+  s.test_files = ["test/scribe_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<thrift>, [">= 0"])
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+    else
+      s.add_dependency(%q<thrift>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thrift>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+  end
+end