quandl_logger 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2daf464eccd4bab4435ee8e3413249830f10e609
+  data.tar.gz: 5b23255401743582835db28440282f8cfd3e1d13
+SHA512:
+  metadata.gz: 504be25a3329ddf185f1372e50eca7b20430dbca7e04bafcbe50a60a614f9aebe8cecc0f431cdc3074fddd081e99957284d03a602f01287abcd35b2c0ceef83a
+  data.tar.gz: 249e179dc509c4c3916ebb80faa04074218168de6d7983b1a8e365baea4557664bd131bfdcb4797706fc7bda4756bcb91ac1c9eb4133db27cf31eeb6f74631b6

data/.gitignore

@@ -1,4 +1,6 @@
 /Gemfile.lock
 /pkg
 /tmp
-*.gem
+*.gem
+coverage/*
+log/*

data/README.md

@@ -1 +1,25 @@
-## Quandl logger class for use in quandl gems.
+# Installation
+
+```ruby
+
+gem 'quandl_logger'
+
+```
+
+
+
+
+# Configuration
+
+
+## Logger
+
+```ruby
+
+require 'quandl/logger'
+
+file = ::Logger.new('/path/to/development.log')
+Quandl::Logger.use(file)
+
+
+```

data/UPGRADE.md

@@ -1,3 +1,9 @@
+## 0.2
+
+* add Quandl::Logger::GrayLog2
+* add Quandl::Configuration
+
+
 ## 0.1
 
-Initial
+* Initial

data/development.log

@@ -0,0 +1 @@
+# Logfile created on 2013-10-21 13:57:00 -0400 by logger.rb/36483

data/examples/graylog.rb

@@ -0,0 +1,19 @@
+require 'quandl/logger'
+
+# configure with block
+# configures :host, :port, :max_size, :facility, :version, :level
+Quandl::Logger::GrayLog2.configure do |c|
+  c.facility = 'quandl_logger:test'
+end
+
+# or configure from file
+# Quandl::Logger::GrayLog2.configuration.from_file('config/graylog2.yml', 'development')
+
+# use graylog2 class directly
+Quandl::Logger::GrayLog2.info('hi')
+
+# or replace quandl logger with GrayLog2
+Quandl::Logger.use( Quandl::Logger::GrayLog2 )
+
+# send your message
+Quandl::Logger.info('hello')

data/examples/logger.rb

@@ -0,0 +1,8 @@
+require 'quandl/logger'
+
+# use ruby old logger
+logger = Logger.new( File.join(Rails.root, "log/example.log") )
+
+Quandl::Logger.use( logger )
+
+Quandl::Logger.info('hello')

data/lib/quandl/configuration.rb

@@ -0,0 +1,75 @@
+require 'yaml'
+
+module Quandl
+class Configuration
+  class << self
+    
+    def configures(*names)
+      define_attributes(*names)
+    end
+    
+    def define_attributes(*names)
+      Array(names).each{|name| define_attribute(name) }
+    end
+    
+    def define_attribute(name)
+      name = name.to_sym
+      define_method(name) do
+        read_attribute(name)
+      end
+      define_method("#{name}=") do |value|
+        write_attribute(name, value)
+      end
+      define_method("#{name}?") do
+        read_attribute(name).present?
+      end
+      # store an array of defined attriubte names
+      attribute_names << name unless attribute_names.include?(name)
+    end
+    
+    def attribute_names
+      @attribute_names ||= []
+    end
+    
+  end
+
+  def from_file(path, env)
+    config = YAML.load_file( path )[ env ]
+    config.each{|k,v| self.send("#{k}=",v) if respond_to?("#{k}=") }
+  end
+  
+  def initialize(*args)
+    attrs = args.extract_options!
+    self.attributes
+    # assign attributes
+    self.assign_attributes(attrs)
+  end
+  
+  def assign_attributes(hash)
+    hash.each do |k,v|
+      send("#{k}=", v) if self.class.attribute_names.include?(k) && respond_to?("#{k}=")
+    end
+  end
+  
+  def inspect
+    "#{self.class.name} " + attributes.inspect
+  end
+  
+  def attributes
+    @attributes ||= self.class.attribute_names.inject({}){|m,k| m[k] ||= nil; m }
+  end
+  
+  def attributes=(value)
+    @attributes = value.symbolize_keys! if value.is_a?(Hash)
+  end
+  
+  def write_attribute(attribute, value)
+    @attributes[:"#{attribute}"] = value
+  end
+  
+  def read_attribute(attribute)
+    @attributes[:"#{attribute}"]
+  end
+  
+end
+end

data/lib/quandl/logger/graylog2.rb

@@ -0,0 +1,38 @@
+require 'gelf'
+require 'quandl/configuration'
+
+class Quandl::Logger::GrayLog2
+  class << self
+    
+    def method_missing(method_sym, *args, &block) 
+      gelf.send(method_sym, *args)
+    end
+    
+    def gelf
+      @gelf ||= GELF::Notifier.new( configuration.host, configuration.port, configuration.max_size, configuration.options )
+    end
+    
+    def configure
+      yield(configuration)
+    end
+    
+    def configuration
+      @configuration ||= Quandl::Logger::GrayLog2::Configuration.new({
+        host:       'metrics.quandl.com',
+        port:       '12201',
+        max_size:   'WAN',
+      })
+    end
+    
+  end
+  
+  class Configuration < Quandl::Configuration
+    configures :host, :port, :max_size, :facility, :version, :level
+    
+    def options
+      [:facility, :version, :level].inject({}){|m,k| m[k] = attributes[k] if attributes[k].present?; m }
+    end
+    
+  end
+  
+end

data/lib/quandl/logger/version.rb

@@ -1,5 +1,5 @@
 module Quandl
 class Logger
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end
 end

data/lib/quandl/logger.rb

@@ -7,6 +7,8 @@ require "active_support/inflector"
 require "active_support/core_ext/hash"
 require "active_support/core_ext/object"
 
+require 'quandl/logger/graylog2'
+
 module Quandl
   class Logger
     class << self
@@ -21,6 +23,10 @@ module Quandl
         @@logger if defined?(@@logger)
       end
       
+      def use(value)
+        return use_file(value)  if value.kind_of?( ::Logger ) || value.kind_of?(String)
+      end
+      
       def info_with_elapsed(message=nil, &block)
         timer = Time.now
         result = block.call
@@ -28,11 +34,15 @@ module Quandl
         result
       end
       
-      def use(log_file)
-        log_file = ::Logger.new(log_file) if log_file.is_a?(String)
-        @@logger = log_file
+      protected
+      
+      def use_file(file)
+        # convert string to logger
+        file = ::Logger.new(file) if file.kind_of?(String)
+        # assign Logger
+        @@logger = file
       end
-  
+      
     end
     
   end

data/quandl_logger.gemspec

@@ -19,8 +19,11 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rake", "~> 10.0"
   s.add_development_dependency "rspec", "~> 2.13"
+  s.add_development_dependency "factory_girl_rails"
   s.add_development_dependency "fivemat", "~> 1.2"
   s.add_development_dependency "pry"
+  s.add_development_dependency "simplecov"
 
   s.add_runtime_dependency "activesupport", ">= 3.0.0"
+  s.add_runtime_dependency "gelf", "~> 1.3.2"
 end

data/spec/fixtures/config/graylog2.yml

@@ -0,0 +1,4 @@
+test:
+  host:           'localhost'
+  port:           '8888'
+  facility:       'test-quandl_logger'

data/spec/lib/quandl/logger/graylog2_spec.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Quandl::Logger::GrayLog2 do
+  let(:logger){ Quandl::Logger::GrayLog2 }
+  subject{ logger }
+  
+  config_path = Pathname.new("spec/fixtures/config/graylog2.yml")
+  config_env = 'test'
+  config = YAML.load_file( config_path )[config_env]
+
+  [:debug, :info, :warn, :error, :fatal, :unknown].each do |level|
+    it ".#{level}('message')" do
+      subject.send(level, 'message')
+    end
+  end
+  
+  describe ".configure" do
+    before(:each){
+      logger.configure do |c|
+        config.each do |key, value|
+          c.send("#{key}=", value)
+        end
+      end
+    }
+    subject{ logger.configuration }
+    
+    config.each do |key, value|
+      its(key){ should eq value }
+    end
+  end
+  
+  describe ".configuration" do
+    subject{ logger.configuration }
+    
+    describe "#from_file" do
+      
+      before(:each){ logger.configuration.from_file( config_path, config_env) }
+      subject{ logger.configuration.attributes }
+      
+      config.each do |key, value|
+        its([key.to_sym]){ should eq value }
+      end
+      
+    end
+  end
+  
+end

data/spec/lib/quandl/logger_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Quandl::Logger do
+  
+  describe "#use" do
+    
+    subject{ Quandl::Logger }
+    
+    context "given String" do
+      before(:each){ subject.use('development.log') }
+      its(:logger){ should be_a ::Logger }
+    end
+    
+    context "given Logger" do
+      before(:each){ subject.use( ::Logger.new('development.log') ) }
+      its(:logger){ should be_a ::Logger }
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start
+end
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require "rspec"
+require 'factory_girl'
+require 'pry'
+
+factory_dir = File.join( File.dirname(__FILE__), 'factories/**/*.rb' )
+Dir.glob( factory_dir ).each{|f| require(f); puts f }
+
+require "quandl/logger"
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end
+
+# binding.pry

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: quandl_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Blake Hilscher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-06 00:00:00.000000000 Z
+date: 2013-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,15 +34,27 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  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: fivemat
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -70,7 +76,20 @@ dependencies:
   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
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -78,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -86,11 +104,24 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: gelf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
 description: Quandl logger class for use in quandl gems.
 email:
 - blake@hilscher.ca
@@ -104,32 +135,44 @@ files:
 - README.md
 - Rakefile
 - UPGRADE.md
+- development.log
+- examples/graylog.rb
+- examples/logger.rb
+- lib/quandl/configuration.rb
 - lib/quandl/logger.rb
+- lib/quandl/logger/graylog2.rb
 - lib/quandl/logger/version.rb
 - quandl_logger.gemspec
+- spec/fixtures/config/graylog2.yml
+- spec/lib/quandl/logger/graylog2_spec.rb
+- spec/lib/quandl/logger_spec.rb
+- spec/spec_helper.rb
 homepage: http://blake.hilscher.ca/
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.1.10
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Quandl logger class for use in quandl gems.
-test_files: []
+test_files:
+- spec/fixtures/config/graylog2.yml
+- spec/lib/quandl/logger/graylog2_spec.rb
+- spec/lib/quandl/logger_spec.rb
+- spec/spec_helper.rb