fluent-plugin-couchbase 0.0.1

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--backtrace
+--default_path spec

data/.simplecov

@@ -0,0 +1,5 @@
+# configure code coverage
+SimpleCov.start do
+  # exclude directories and files
+  add_filter "/spec/"
+end

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "fluentd", ">=0.10.28"
+gem "couchbase"
+gem "activesupport"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development, :test do
+  gem "rdoc", ">= 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", ">= 1.8.4"
+  gem "rspec", ">= 0"
+  gem "simplecov", "= 0.5.4" # need to use an older version b/c the most recent one throws an UTF/ASCII conversion error
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 obie quelland
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# Couchbase 2.0 plugin for Fluentd
+
+Couchbase 2.0 output plugin for Fluentd.
+
+# Installation
+
+via RubyGems
+
+    fluent-gem install fluent-plugin-couchbase
+
+# Quick Start
+
+## Setup Couchbase Server 2.0 Environment
+    # install couchbase server 2.0
+      http://www.couchbase.com/download
+
+    # install libcouchbase
+      http://www.couchbase.com/develop/c/current
+
+    # install couchbase gem
+      gem install couchbase
+
+## Fluentd.conf Configuration
+    <match couchbase.**>
+      type couchbase      # fluent output plugin file name (sans fluent_plugin_ prefix)
+      hostname localhost  # host name
+      port 8091           # port name
+      pool default        # pool name
+      bucket default      # bucket name
+      ttl 0               # number of seconds before document expires. 0 = no expiration
+      include_ttl false   # store the ttl value w/ each document
+    </match>
+
+# Tests
+
+rake
+
+    NOTE: requires the following:
+          1) Couchbase Server 2.0
+          2) libcouch
+          3) couchbase gem
+          4) update spec/out_couchbase_spec.rb with your
+             hostname, port, pool, and bucket prior to running the tests
+
+# TODOs
+    1) specify multiple nodes?

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fluent-plugin-couchbase"
+  gem.homepage = "http://github.com/obieq/fluent-plugin-couchbase"
+  gem.license = "MIT"
+  gem.summary = %Q{Fluent output plugin for Couchbase}
+  gem.description = %Q{Fluent output plugin for Couchbase via the waz-storage gem}
+  gem.email = "quelland@gmail.com"
+  gem.authors = ["obie quelland"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fluent-plugin-couchbase #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Get spec rake tasks working in RSpec 2.0
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/fluent-plugin-couchbase.gemspec

@@ -0,0 +1,73 @@
+# 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 = "fluent-plugin-couchbase"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["obie quelland"]
+  s.date = "2012-12-27"
+  s.description = "Fluent output plugin for Couchbase via the waz-storage gem"
+  s.email = "quelland@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".rspec",
+    ".simplecov",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "fluent-plugin-couchbase.gemspec",
+    "lib/fluent/plugin/out_couchbase.rb",
+    "spec/out_couchbase_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb",
+    "spec/support/helpers.rb"
+  ]
+  s.homepage = "http://github.com/obieq/fluent-plugin-couchbase"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Fluent output plugin for Couchbase"
+
+  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<fluentd>, [">= 0.10.28"])
+      s.add_runtime_dependency(%q<couchbase>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, ["= 0.5.4"])
+    else
+      s.add_dependency(%q<fluentd>, [">= 0.10.28"])
+      s.add_dependency(%q<couchbase>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<simplecov>, ["= 0.5.4"])
+    end
+  else
+    s.add_dependency(%q<fluentd>, [">= 0.10.28"])
+    s.add_dependency(%q<couchbase>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<simplecov>, ["= 0.5.4"])
+  end
+end
+

data/lib/fluent/plugin/out_couchbase.rb

@@ -0,0 +1,66 @@
+require 'couchbase'
+require 'msgpack'
+require 'json'
+require 'active_support/core_ext/hash'
+
+module Fluent
+
+  class CouchbaseOutput < BufferedOutput
+    Fluent::Plugin.register_output('couchbase', self)
+
+    config_param :hostname,      :string
+    config_param :port,          :integer
+    config_param :pool,          :string
+    config_param :bucket,        :string
+    config_param :ttl,           :integer, :default => 0
+    config_param :include_ttl,   :bool, :default => false
+
+    def connection
+      @connection ||= get_connection(self.hostname, self.port, self.pool, self.bucket)
+    end
+
+    def configure(conf)
+      super
+
+      # perform validations
+      raise ConfigError, "'hostname' is required by Couchbase output (ex: localhost)" unless self.hostname
+      raise ConfigError, "'port' is required by Couchbase output (ex: 8091)" unless self.port
+      raise ConfigError, "'pool' is required by Couchbase output (ex: default)" unless self.pool
+      raise ConfigError, "'bucket' is required by Couchbase output (ex: default)" unless self.bucket
+      raise ConfigError, "'ttl' is required by Couchbase output (ex: 0)" unless self.ttl
+    end
+
+    def start
+      super
+      connection
+    end
+
+    def shutdown
+      super
+    end
+
+    def format(tag, time, record)
+      record.to_msgpack
+    end
+
+    def write(chunk)
+      chunk.msgpack_each  { |record|
+        # store ttl in the document itself?
+        record[:ttl] = self.ttl if self.include_ttl
+
+        # persist
+        connection[record.delete('key'), :ttl => self.ttl] = record
+      }
+    end
+
+    private
+
+    def get_connection(hostname, port, pool, bucket)
+      Couchbase.connect(:hostname => hostname,
+                        :port => port,
+                        :pool => pool,
+                        :bucket => bucket)
+    end
+
+  end
+end

data/spec/out_couchbase_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+require 'couchbase'
+Fluent::Test.setup
+
+SPEC_HOSTNAME = 'localhost'
+SPEC_PORT = 8091
+SPEC_POOL_NAME = 'default'
+SPEC_BUCKET_NAME = 'default'
+SPEC_TTL = 10
+SPEC_INCLUDE_TTL_IN_DOCUMENT = true
+
+CONFIG = %[
+  hostname #{SPEC_HOSTNAME}
+  port #{SPEC_PORT}
+  pool #{SPEC_POOL_NAME}
+  bucket #{SPEC_BUCKET_NAME}
+  ttl #{SPEC_TTL}
+  include_ttl #{SPEC_INCLUDE_TTL_IN_DOCUMENT}
+]
+
+describe Fluent::CouchbaseOutput do
+  include Helpers
+
+  let(:driver) { Fluent::Test::BufferedOutputTestDriver.new(Fluent::CouchbaseOutput, 'test') }
+
+  def set_config_value(config, config_name, value)
+    search_text = config.split("\n").map {|text| text if text.strip!.to_s.start_with? config_name.to_s}.compact![0]
+    config.gsub(search_text, "#{config_name} #{value}")
+  end
+
+  context 'configuring' do
+
+    it 'should be properly configured' do
+      driver.configure(CONFIG)
+      driver.instance.hostname.should eq(SPEC_HOSTNAME)
+      driver.instance.port.should eq(SPEC_PORT)
+      driver.instance.pool.should eq(SPEC_POOL_NAME)
+      driver.instance.bucket.should eq(SPEC_BUCKET_NAME)
+      driver.instance.ttl.should eq(SPEC_TTL)
+      driver.instance.include_ttl.should eq(SPEC_INCLUDE_TTL_IN_DOCUMENT)
+    end
+
+    describe 'exceptions' do
+      it 'should raise an exception if hostname is not configured' do
+        expect { driver.configure(CONFIG.gsub("hostname", "invalid_config_name")) }.to raise_error Fluent::ConfigError
+      end
+
+      it 'should raise an exception if port is not configured' do
+        expect { driver.configure(CONFIG.gsub("port", "invalid_config_name")) }.to raise_error Fluent::ConfigError
+      end
+
+      it 'should raise an exception if pool is not configured' do
+        expect { driver.configure(CONFIG.gsub("pool", "invalid_config_name")) }.to raise_error Fluent::ConfigError
+      end
+
+      it 'should raise an exception if bucket is not configured' do
+        expect { driver.configure(CONFIG.gsub("bucket", "invalid_config_name")) }.to raise_error Fluent::ConfigError
+      end
+    end
+
+  end # context configuring
+
+  context 'logging' do
+
+    it 'should start' do
+      driver.configure(CONFIG)
+      driver.instance.start
+    end
+
+    it 'should shutdown' do
+      driver.configure(CONFIG)
+      driver.instance.start
+      driver.instance.shutdown
+    end
+
+    it 'should format' do
+      driver.configure(CONFIG)
+      time = Time.now.to_i
+      record = {:key => generate_document_key, :tag => 'test', :time => time, :a => 1}
+
+      driver.emit(record)
+      driver.expect_format(record.to_msgpack)
+      driver.run
+    end
+
+    context 'writing' do
+
+      it 'should write' do
+        driver.configure(CONFIG)
+        write(driver)
+      end
+
+    end # context writing
+  end # context logging
+end # CouchbaseOutput

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'simplecov'
+require 'rspec'
+require 'fluent/test'
+
+# require the library files
+Dir["./lib/**/*.rb"].each {|f| require f}
+
+# require the shared example files
+Dir["./spec/support/**/*.rb"].each {|f| require f}

data/spec/support/helpers.rb

@@ -0,0 +1,45 @@
+module Helpers
+
+  def generate_document_key(min=1, max=999)
+    "spec_pk_#{Random.rand(min..max)}"
+  end
+
+  def write(driver)
+    key1 = generate_document_key(1, 500)
+    key2 = generate_document_key(501, 999) # must be greater than the first key
+    tag1 = "spec test1"
+    tag2 = "spec test2"
+    time1 = Time.now.to_i
+    time2 = time1 + 2
+
+    record1 = {:key => key1, :tag => tag1, :time => time1, :a => 10, :b => 'Tesla'}
+    record2 = {:key => key2, :tag => tag2, :time => time2, :a => 20, :b => 'Edison'}
+
+    # store both records in an array to aid with verification
+    test_records = [record1, record2]
+
+    test_records.each do |rec|
+      driver.emit(rec)
+    end
+    driver.run # persists to couchbase
+
+    # query couchbase to verify data was correctly persisted
+    db_records = driver.instance.connection.get(key1, key2)
+
+    db_records.count.should eq(test_records.count)
+    db_records.each_with_index do |db_record, idx| # records should be sorted by row_key asc
+      test_record = test_records[idx]
+      db_record['tag'].should eq(test_record[:tag])
+      db_record['time'].should eq(test_record[:time])
+      db_record['a'].should eq(test_record[:a])
+      db_record['b'].should eq(test_record[:b])
+      if driver.instance.include_ttl
+        db_record['ttl'].should_not be_nil
+      else
+        db_record['ttl'].should be_nil
+      end
+    end
+
+  end # def write
+
+end # module Helpers

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-couchbase
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- obie quelland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.28
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.28
+- !ruby/object:Gem::Dependency
+  name: couchbase
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+description: Fluent output plugin for Couchbase via the waz-storage gem
+email: quelland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .rspec
+- .simplecov
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- fluent-plugin-couchbase.gemspec
+- lib/fluent/plugin/out_couchbase.rb
+- spec/out_couchbase_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+homepage: http://github.com/obieq/fluent-plugin-couchbase
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -112864881918532391
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Fluent output plugin for Couchbase
+test_files: []