flnt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9598b2d9ec5edeb6b7bb130e680583098930677d
+  data.tar.gz: 63dbc73fe1f99ce3e4727d43932828f0a7431e5a
+SHA512:
+  metadata.gz: c3af8c77dfd7b650dcf05c5c09e71f3d5d996e9d7cbd520129ea21e51b04aae9d52311c0743d108d900b53a917671b7b27bba2a7953745f87ba069fbecd1e0c7
+  data.tar.gz: b5e50e8c86511c7cdc39a2be85f7e6a5c6580215403e57ce5b412e5185cc8e2ac62b135bd4f655d7d08107e89c9f11b6b9183ec46f0e2af5185eb01429a98385

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flnt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Uchio KONDO
+
+MIT License
+
+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,62 @@
+# Flnt
+
+Gentle post-to-fluentd log solution.
+
+## Powered by wercker
+
+[![wercker status](https://app.wercker.com/status/4c5b18d2fe3debeee48b7f0fab81eb12/m/ "wercker status")](https://app.wercker.com/project/bykey/4c5b18d2fe3debeee48b7f0fab81eb12)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flnt'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flnt
+
+## Usage
+
+### Just post log to fluent
+
+* Setting up fluentd on your localhost:24224
+* Call the methods below:
+```ruby
+Flnt.app.payment.info "Payment done"
+```
+* Then, your fluentd receives json `{message: "Payment done"}` with tag `app.payment.info`
+
+`Flnt` compiles method chaining into a tag, and when the method is called with an argument,
+it emits the information to fluentd.
+
+NOTE: You cannot use methods such as `foo?` or `foo!` for tag suffix. only `/[a-zA-Z0-9_]/` are OK.
+
+### Configuration of fluentd
+
+```ruby
+Flnt::Configuration.configure do |c|
+  c.prefix = "foobar"
+  c.host = 'fluentd.example.jp'
+  c.port = 12345
+end
+```
+
+## License
+
+see `LICENSE.txt`.
+
+
+## Contributing
+
+The usual github way.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end

data/flnt.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flnt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flnt"
+  spec.version       = Flnt::VERSION
+  spec.authors       = ["Uchio KONDO"]
+  spec.email         = ["udzura@udzura.jp"]
+  spec.description   = %q{Gentle post-to-fluentd log solution}
+  spec.summary       = %q{Gentle post-to-fluentd log solution}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "fluent-logger"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+
+  spec.add_development_dependency "rspec"
+end

data/lib/flnt/configuration.rb

@@ -0,0 +1,33 @@
+module Flnt
+  module Configuration
+    class << self
+      def host
+        @host ||= 'localhost'
+      end
+
+      def port
+        @port ||= 24224
+      end
+      attr_writer   :host, :port
+      attr_accessor :prefix
+
+      def to_fluentd_config
+        [
+          prefix,
+          {
+            host: host,
+            port: port,
+          }
+        ]
+      end
+
+      def configure &b
+        b.call(self)
+      end
+    end
+  end
+
+  def self.Configuration
+    Configuration.to_fluentd_config
+  end
+end

data/lib/flnt/logger.rb

@@ -0,0 +1,37 @@
+require 'fluent/logger'
+
+module Flnt
+  class Logger < BasicObject
+    def initialize(init_tag)
+      @tag = init_tag
+    end
+
+    def method_missing(name, *args)
+      return super if name.to_s =~ /(!|\?)$/
+
+      @tag = [@tag, name.to_s].join('.')
+      unless args.empty?
+        emit! args.first
+      end
+
+      return self
+    end
+
+    def emit!(arg)
+      info = {}
+      case arg
+      when ::Hash
+        info.merge! arg
+      when ::String
+        info[:message] = arg
+      when ::Exception
+        info[:error_class] = arg.class
+        info[:message]     = arg.message
+        info[:backtrace]   = arg.backtrace if arg.backtrace
+      else
+        info[:info] = arg
+      end
+      ::Fluent::Logger.post @tag, info
+    end
+  end
+end

data/lib/flnt/version.rb

@@ -0,0 +1,3 @@
+module Flnt
+  VERSION = "0.1.0"
+end

data/lib/flnt/version_flymake.rb

@@ -0,0 +1,3 @@
+module Flnt
+  VERSION = "0.1.0"
+end

data/lib/flnt.rb

@@ -0,0 +1,35 @@
+require "flnt/version"
+require "flnt/logger"
+require "flnt/configuration"
+
+module Flnt
+  class << self
+    # Flnt should be a Module because she is also a namespace,
+    # but should behaves like a BasicObject
+    ((Module.instance_methods + Module.private_instance_methods) -
+      (BasicObject.instance_methods + BasicObject.private_instance_methods)).
+      delete_if {|method_name| method_name.to_s =~ /([\-\[\]\/~=+*&|%<>!?])/}.
+      each do |target_method|
+      if target_method.to_sym != :object_id
+        eval %Q(undef #{target_method})
+      end
+    end
+
+    def method_missing(name, *args)
+      return super if name.to_s =~ /(!|\?)$/
+      initialize!
+      Flnt::Logger.new(name.to_s)
+    end
+
+    def initialized?
+      !! @initialized
+    end
+
+    def initialize!
+      unless initialized?
+        @initialized = true
+        Fluent::Logger::FluentLogger.open(*Flnt::Configuration())
+      end
+    end
+  end
+end

data/spec/lib/flnt/configuration_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe "Flnt::Configuration" do
+  it "should have default values" do
+    expect(Flnt::Configuration()).to eq(
+      [
+        nil,
+        {
+          host: 'localhost',
+          port: 24224,
+        }
+      ]
+    )
+  end
+
+  it "should be customized" do
+    Flnt::Configuration.configure do |c|
+      c.prefix = "foobar"
+      c.host = 'fluentd.example.jp'
+      c.port = 12345
+    end
+
+    expect(Flnt::Configuration()).to eq(
+      [
+        "foobar",
+        {
+          host: 'fluentd.example.jp',
+          port: 12345,
+        }
+      ]
+    )
+  end
+
+  after do
+    Flnt::Configuration.instance_eval do
+      @host = nil
+      @port = nil
+      @prefix = nil
+    end
+  end
+end

data/spec/lib/flnt/logger_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+describe "Flnt::Logger" do
+  before do
+    allow(Fluent::Logger::FluentLogger).to receive(:open).with(nil, an_instance_of(Hash))
+  end
+
+  def tag_of(flnt_logger)
+    return flnt_logger.instance_eval { @tag }
+  end
+
+  it "should chain the method call appending a tag" do
+    expect(tag_of Flnt.sample.foo).to eq "sample.foo"
+    expect(tag_of Flnt._sample._foo2).to eq "_sample._foo2"
+    expect(tag_of Flnt.sample.foo.bar).to eq "sample.foo.bar"
+  end
+
+  it "should raise when chained with ! or ? methods" do
+    expect {
+      Flnt.sample.warn!
+    }.to raise_error NoMethodError
+
+    expect {
+      Flnt.sample.info?
+    }.to raise_error NoMethodError
+  end
+
+  describe "should send messages when called with arg" do
+    context "when String" do
+      specify do
+        expect(Fluent::Logger).to receive(:post).with("sample.info", {message: "Hello Info"})
+        Flnt.sample.info "Hello Info"
+      end
+    end
+
+    context "when Hash" do
+      specify do
+        expect(Fluent::Logger).to receive(:post).with("sample.info", {info1: "Info", info2: 1234})
+        Flnt.sample.info({info1: "Info", info2: 1234})
+      end
+    end
+
+    context "when Error" do
+      let(:error) { StandardError.new "Error Info" }
+
+      specify do
+        expect(Fluent::Logger).to receive(:post)
+          .with("sample.info", {error_class: StandardError, message: "Error Info"})
+        Flnt.sample.info(error)
+      end
+    end
+
+    context "else" do
+      let(:obj) { Object.new }
+
+      specify do
+        expect(Fluent::Logger).to receive(:post).with("sample.info", {info: obj})
+        Flnt.sample.info(obj)
+      end
+    end
+  end
+end

data/spec/lib/flnt_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe "Flnt" do
+  it "should be a Module" do
+    expect(Flnt).to be_a_kind_of Module
+  end
+
+  it "should initialize fluentd connection" do
+    allow(Flnt).to receive(:initialized?).and_return(false)
+
+    expect(Fluent::Logger::FluentLogger).to receive(:open).with(*Flnt::Configuration())
+    Flnt.init_foo
+  end
+
+  it "should initialize fluentd connection just once" do
+    allow(Flnt).to receive(:initialized?).and_return(true)
+
+    expect(Fluent::Logger::FluentLogger).not_to receive(:open)
+    expect(Flnt).not_to receive(:Configuration)
+    Flnt.init_foo
+  end
+
+  it "should return Flnt::Logger tagged with called method name" do
+    ret = Flnt.init_foo
+    expect(ret.instance_eval { @tag }).to eq "init_foo"
+
+    expect { ret.chain_bar }.not_to raise_error
+    expect { ret.respond_to? }.to raise_error NoMethodError
+  end
+
+  it "should create a new logger for each call" do
+    logger1 = Flnt.foo_tag
+    logger2 = Flnt.foo_tag
+    expect(logger1.__id__).not_to eq logger2.__id__
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'flnt'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus if ENV['FOCUS']
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/wercker.yml

@@ -0,0 +1,23 @@
+box: wercker/rvm
+build:
+    steps:
+        - rvm-use:
+            version: ruby-2.1.0
+        - bundle-install
+        - script:
+            name: run rspec
+            code: bundle exec rake spec
+
+        - rvm-use:
+            version: ruby-2.0.0-p353
+        - bundle-install
+        - script:
+            name: run rspec
+            code: bundle exec rake spec
+
+        - rvm-use:
+            version: ruby-1.9.3-p545
+        - bundle-install
+        - script:
+            name: run rspec
+            code: bundle exec rake spec

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: flnt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Uchio KONDO
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluent-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gentle post-to-fluentd log solution
+email:
+- udzura@udzura.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- flnt.gemspec
+- lib/flnt.rb
+- lib/flnt/configuration.rb
+- lib/flnt/logger.rb
+- lib/flnt/version.rb
+- lib/flnt/version_flymake.rb
+- spec/lib/flnt/configuration_spec.rb
+- spec/lib/flnt/logger_spec.rb
+- spec/lib/flnt_spec.rb
+- spec/spec_helper.rb
+- wercker.yml
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Gentle post-to-fluentd log solution
+test_files:
+- spec/lib/flnt/configuration_spec.rb
+- spec/lib/flnt/logger_spec.rb
+- spec/lib/flnt_spec.rb
+- spec/spec_helper.rb