log4r-sequel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22db2c5c31f8fbb61fac792ab52976a26e6e0984
+  data.tar.gz: 2ea605f5b25ebc37a19c912403e6e502ca7751a4
+SHA512:
+  metadata.gz: eb146d274d9e4bddeb666218f54edb4bda8d26fd95d5b36479c05f42727fb70ea7ce341d1a293b8d089723eb101e897d094dea0fd3720c54933a63ae9cc5f053
+  data.tar.gz: a791ae9d859a3854a88b38f174e8774d2ec53f577c5aa3d291fb4022a1a87c03d2f69053f76101ba8bc8be3a01c3bc0e2cde389819df095507cbe9dd9989f836

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.2
+  - 2.3.0
+
+notifications:
+  email: false
+
+bundler_args: --without test --jobs 3 --retry 3
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,29 @@
+## travis really doesn't like this
+#ruby '2.0.0'
+
+source 'https://rubygems.org'
+
+gem 'log4r', '~> 1.1.9', '> 1.1'
+
+# ugh this is so stupid - jeweler pulls in the latest version of this -
+# through it's own dependency, causing a hard requirement on ruby 2.3.x,
+# locking it down this way
+gem 'rack', '= 1.6.4'
+
+gem 'sequel', '~> 4.6', '>= 4.6.0'
+
+# making ruby 2.3.0 happy
+gem 'hoe', '~> 3.15', '>= 3.15.1'
+
+group :development do
+  gem 'jeweler', '~> 2.0', '>= 2.0.0'
+  gem 'test-unit', '~> 2.0', '>= 2.0.0'
+end
+
+group :sqlite do
+  gem 'sqlite3', '~> 1.3', '>= 1.3.11'
+end
+
+group :postgres do
+  gem 'pg', '~> 0.18', '>= 0.18.4'
+end

data/Gemfile.lock

@@ -0,0 +1,70 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github_api (0.13.1)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      oauth2
+    hashie (3.4.4)
+    highline (1.7.8)
+    hoe (3.15.1)
+      rake (>= 0.8, < 12.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.1)
+    log4r (1.1.10)
+    mini_portile2 (2.0.0)
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    oauth2 (1.1.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0, < 1.5.2)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    pg (0.18.4)
+    rack (1.6.4)
+    rake (11.2.2)
+    rdoc (4.2.2)
+      json (~> 1.4)
+    sequel (4.37.0)
+    sqlite3 (1.3.11)
+    test-unit (2.0.0.0)
+    thread_safe (0.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hoe (~> 3.15, >= 3.15.1)
+  jeweler (~> 2.0, >= 2.0.0)
+  log4r (~> 1.1.9, > 1.1)
+  pg (~> 0.18, >= 0.18.4)
+  rack (= 1.6.4)
+  sequel (~> 4.6, >= 4.6.0)
+  sqlite3 (~> 1.3, >= 1.3.11)
+  test-unit (~> 2.0, >= 2.0.0)
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -0,0 +1,45 @@
+# log4r-sequel
+Log4r outputter to a Sequel database handle
+
+## usage
+
+### pre-built gem installation (stable)
+
+[![Gem Version](https://badge.fury.io/rb/log4r-sequel.png)](https://rubygems.org/gems/log4r-sequel)
+
+```sh
+gem install log4r-sequel
+irb
+...
+irb(main):001:0> require 'log4r/outputter/sequeloutputter'
+=> true
+irb(main):002:0> logger = Log4r::Logger.new('foo')
+=> #<Log4r::Logger:0x007f889b056df8 @fullname="foo" ...>
+```
+
+
+### from-source installation (latest)
+
+[![build status](https://travis-ci.org/chorankates/log4r-sequel.svg)](https://travis-ci.org/chorankates/log4r-sequel)
+
+```sh
+git clone https://github.com/chorankates/log4r-sequel.git
+cd log4r-sequel
+rake clean build
+gem install --local pkg/log4r-sequel*.gem
+irb
+...
+irb(main):001:0> require 'log4r/outputter/sequeloutputter'
+=> true
+```
+
+## supported databases
+  * sqlite3
+  * Postgres
+  
+## TODO
+  * allow database name to be semi-dynamically generated - via YAML config, not just by passing the hash directly
+  * tests
+    * unit tests
+  * marketing
+    * screencast / sample output in README.md

data/Rakefile

@@ -0,0 +1,34 @@
+require 'jeweler'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+CLEAN.include('**/*.sqlite')
+CLEAN.include('pkg/*')
+
+Jeweler::Tasks.new do |gem|
+  gem.name        = 'log4r-sequel'
+  gem.summary     = 'Log4r::Outputter::Sequel'
+  gem.description = 'Log4r::Outputter that writes to a Sequel database'
+  gem.email       = ['conor.code@gmail.com']
+  gem.homepage    = 'http://github.com/chorankates/log4r-sequel'
+  gem.authors     = ['Conor Horan-Kates']
+  gem.licenses    =  'MIT'
+
+  gem.files.exclude 'examples/*'
+  gem.files.exclude 'pkg/*'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+namespace :test do
+
+  Rake::TestTask.new do |t|
+    t.name = 'functional'
+    t.libs << 'lib'
+    t.test_files = FileList['test/functional/**/test_*.rb']
+    #t.verbose = true
+  end
+
+end
+desc 'run all tests'
+task :test => ['clean', 'test:functional'] do; end

data/VERSION

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

data/example/log2postgres.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH << sprintf('%s/../lib', File.dirname(__FILE__))
+
+#require 'log4r-sequel'
+require 'log4r/outputter/sequeloutputter'
+
+file = sprintf('%s/log4r-postgres.yaml', File.dirname(__FILE__))
+Log4r::YamlConfigurator.load_yaml_file(file)
+
+logger  = Log4r::Logger.get('bar')
+
+[logger].each do |l|
+  ## log some garbage
+  l.debug('this is a debug message')
+  l.info('this is an info message')
+  l.warn('this is a warning')
+  l.error('this is an error')
+  l.fatal('this is a fatal')
+end

data/example/log2sqlite.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH << sprintf('%s/../lib', File.dirname(__FILE__))
+
+require 'sqlite3'
+
+#require 'log4r-sequel'
+require 'log4r/outputter/sequeloutputter'
+require 'log4r/yamlconfigurator'
+
+## instantiate a logger following the log4r pattern
+file = sprintf('%s/log4r-sqlite.yaml', File.dirname(__FILE__))
+Log4r::YamlConfigurator.load_yaml_file(file)
+
+logger  = Log4r::Logger.get('foo')
+
+[logger].each do |l|
+  ## log some garbage
+  l.debug('this is a debug message')
+  l.info('this is an info message')
+  l.warn('this is a warning')
+  l.error('this is an error')
+  l.fatal('this is a fatal')
+end

data/example/log4r-postgres.yaml

@@ -0,0 +1,53 @@
+---
+log4r_config:
+  loggers:
+  - name: 'bar'
+    outputters:
+      - sequel
+      - stdout
+  outputters:
+  # not needed, but feedback is useful
+  - type: StdoutOutputter
+    name: stdout
+    formatter:
+      type: PatternFormatter
+      date_pattern: '%Y/%m/%d %H:%M.%s'
+      pattern: '%d | %C | %l | %m'
+
+  - type: SequelOutputter
+    # traditional Log4r settings
+    name: sequel
+    level: DEBUG
+    formatter:
+      type: PatternFormatter
+      date_pattern: '%Y/%m/%d %H:%M.%s'
+      pattern: '%d!@#$%l!@#$%C!@#$%c!@#$%h!@#$%p!@#$%m' # kitchen sink
+    # log4r-sequel settings
+    engine: postgres
+    server: localhost
+    port: 5432
+    database: logs
+    table: logs
+    username: postgres
+    password: postgres
+    delimiter: '!@#$' # this is used to determine columns needed based on log4 configuration
+    map:
+      0: 'date'
+      1: 'level'
+      2: 'class'
+      3: 'relative_class'
+      4: 'thread'
+      5: 'pid'
+      6: 'message'
+
+# truncated map from http://log4r.rubyforge.org/rdoc/Log4r/PatternFormatter.html
+#  %c - event short name
+#  %C - event fullname
+#  %d - date
+#  %g - Global Diagnostic Context (GDC)
+#  %t - trace
+#  %m - message
+#  %h - thread name
+#  %p - process ID aka PID
+#  %M - formatted message
+#  %l - Level in string form

data/example/log4r-sqlite.yaml

@@ -0,0 +1,46 @@
+---
+log4r_config:
+  loggers:
+  - name: 'foo'
+    outputters:
+      - sequel
+      - stdout
+  outputters:
+  # not needed, but feedback is useful
+  - type: StdoutOutputter
+    name: stdout
+    formatter:
+      type: PatternFormatter
+      date_pattern: '%Y/%m/%d %H:%M.%s'
+      pattern: '%d | %C | %l | %m'
+
+  - type: SequelOutputter
+    # traditional Log4r settings
+    name: sequel
+    level: DEBUG
+    formatter:
+      type: PatternFormatter
+      date_pattern: '%Y/%m/%d %H:%M.%s'
+      pattern: '%d!@#$%C!@#$%l!@#$%m' # date|level|event/class fullname|message
+    # log4r-sequel settings
+    engine: sqlite
+    file: log.sqlite
+    table: logs
+    delimiter: '!@#$' # this is used to determine columns needed based on log4 configuration
+    map:
+      0: 'date'
+      1: 'level'
+      2: 'class'
+      3: 'message'
+
+# truncated map from http://log4r.rubyforge.org/rdoc/Log4r/PatternFormatter.html
+#  %c - event short name
+#  %C - event fullname
+#  %d - date
+#  %g - Global Diagnostic Context (GDC)
+#  %t - trace
+#  %m - message
+#  %h - thread name
+#  %p - process ID aka PID
+#  %M - formatted message
+#  %l - Level in string form

data/lib/log4r/outputter/sequeloutputter.rb

@@ -0,0 +1,127 @@
+require 'log4r'
+require 'log4r/yamlconfigurator'
+require 'sequel'
+require 'yaml'
+
+# TODO  should we move this to ../logger.rb
+# TODO .. or should we remove this entirely? it was implemented to let us call connect/configure, but since we do that in initiliaze now, maybe we just pull it
+class Log4r::Logger
+  # +method+ String or Symbol representing the name of the method in the Log4r::Outputter::SequelOutputter class you want to use
+  # +parameters+ arbitrary data type to be passed to :methods
+  def sequel(method, parameters = { })
+    # TODO support methods that take more than one parameter
+    self.outputters.each do |op|
+      next unless op.is_a?(SequelOutputter)
+      return op.send(method.to_sym, parameters)
+    end
+  end
+
+  # no parameters, returns the first Log4r::Outputter::Sequel object
+  # TODO is there ever a case where there would be more than one?
+  def get_outputter
+    self.outputters.each do |op|
+      next unless op.is_a?(SequelOutputter)
+      return op
+    end
+  end
+
+end
+
+class SequelOutputter < Log4r::Outputter
+
+  KNOWN_ENGINES = [
+    :postgres,
+    :sqlite,
+  ]
+
+  attr_reader :database, :delimiter, :engine, :file, :map, :table
+  attr_accessor :dbh
+
+  def initialize(name, hash)
+    super(name, hash) # make us a real Log4r::Outputter object
+    dbh = configure(hash) # validate settings passed
+    connect(dbh) # actually connect to the DBH
+  end
+
+  # +input+ Hash of configuration options
+  def configure(input)
+    config = input
+
+    # convert all keys to symbols
+    new_config = Hash.new
+    config.keys.each do |key|
+      new_config[key.to_sym] = config[key]
+    end
+    config = new_config
+
+    @engine = config[:engine].to_sym
+
+    # error checking on table/column settings
+    @table = config[:table].to_sym
+    @map = config[:map]
+    @delimiter = config[:delimiter]
+    [@delimiter, @map, @table].each do |required|
+      raise Log4r::ConfigError.new(sprintf("required '%s' key missing from configuration", required)) if required.nil?
+    end
+
+    if @engine.eql?(:postgres)
+      @database = config[:database]
+      @file     = nil
+      server    = config[:server]
+      port      = config[:port]
+      username  = config[:username]
+      password  = config[:password]
+      @dbh = Sequel.connect(sprintf('postgres://%s:%s@%s:%s/%s', username, password, server, port, @database))
+    elsif @engine.eql?(:sqlite)
+      @database = nil # sqlite has one DB per file
+      @file = config[:file]
+      @dbh = Sequel.connect(sprintf('sqlite://%s', @file))
+    else
+      raise Log4r::ConfigError.new(sprintf('unable to use engine[%s], allowed[%s]', @engine, KNOWN_ENGINES))
+    end
+
+    @dbh
+  end
+
+  # +dbh+ a Sequel::Database handle
+  ## while not really supported, if you take care of the database/table creation, you could hack it in here by <your_logger>.outputters[<sequel outputter>].connect(<dbh>)
+  def connect(dbh)
+    raise StandardError.new(sprintf('invalid parameter class[%s] expecting[Sequel::Database]', dbh.class)) unless dbh.is_a?(Sequel::Database)
+
+    @dbh = dbh
+
+    # idempotently create table/columns
+    initialize_db
+  end
+
+  def connected?
+    # this is sufficient since we throw an exception during #connect if we don't get a good handle
+    ! @dbh.nil?
+  end
+
+  private
+
+  def write(data)
+    raise StandardError.new(sprintf('%s is not connected, run %s.connect(yaml_file)', self.class, self.class)) unless connected?
+     # INSERT INTO `logs`(`id`,`date`,`level`,`class`,`message`) VALUES (1,NULL,NULL,NULL,NULL);
+    tokens = data.split(@delimiter)
+    hash = Hash.new
+
+    tokens.each_with_index do |token, i|
+      hash[@map[i].to_sym] = token
+    end
+
+    @dbh[@table].insert(hash)
+  end
+
+  def initialize_db
+    map = @map # we're in a different class in the block below, can't access
+    @dbh.create_table? @table do
+      primary_key :id
+      map.values.each do |v|
+        String v.to_sym
+      end
+    end
+  end
+
+end

data/test/functional/test_sqlite.rb

@@ -0,0 +1,49 @@
+$LOAD_PATH << sprintf('%s/../../lib', File.dirname(__FILE__))
+require 'log4r/outputter/sequeloutputter'
+
+
+require 'test/unit'
+
+class TestSqlite < Test::Unit::TestCase
+
+  def setup
+    @good_config = sprintf('%s/../log4r-sqlite_test.yaml', File.expand_path(File.dirname(__FILE__)))
+    @table = :logs
+  end
+
+  def teardown
+    # TODO remove the database.. assume it's just '*.sqlite' in this path?
+  end
+
+
+  def test_happy_yaml
+    file = @good_config
+    Log4r::YamlConfigurator.load_yaml_file(file)
+
+    logger = nil
+
+    assert_nothing_raised do
+      logger  = Log4r::Logger.get('test')
+    end
+
+    assert_not_nil(logger)
+    assert_equal(0, logger.get_outputter.dbh[@table].count)
+
+    assert_nothing_raised do
+      logger.debug('this is a debug message')
+      logger.info('this is an info message')
+      logger.warn('this is a warning')
+      logger.error('this is an error')
+      logger.fatal('this is a fatal')
+    end
+
+    assert_not_equal(0, logger.get_outputter.dbh[@table].count)
+
+  end
+
+  def test_sad_config
+    # TODO pass in bad configs as hashes
+  end
+
+
+end

data/test/log4r-sqlite_test.yaml

@@ -0,0 +1,46 @@
+---
+log4r_config:
+  loggers:
+  - name: 'test'
+    outputters:
+      - sequel
+      - stdout
+  outputters:
+  # not needed, but feedback is useful
+  - type: StdoutOutputter
+    name: stdout
+    formatter:
+      type: PatternFormatter
+      date_pattern: '%Y/%m/%d %H:%M.%s'
+      pattern: '%d | %C | %l | %m'
+
+  - type: SequelOutputter
+    # traditional Log4r settings
+    name: sequel
+    level: DEBUG
+    formatter:
+      type: PatternFormatter
+      date_pattern: '%Y/%m/%d %H:%M.%s'
+      pattern: '%d!@#$%C!@#$%l!@#$%m' # date|level|event/class fullname|message
+    # log4r-sequel settings
+    engine: sqlite
+    file: log.sqlite
+    table: logs
+    delimiter: '!@#$' # this is used to determine columns needed based on log4 configuration
+    map:
+      0: 'date'
+      1: 'level'
+      2: 'class'
+      3: 'message'
+
+# truncated map from http://log4r.rubyforge.org/rdoc/Log4r/PatternFormatter.html
+#  %c - event short name
+#  %C - event fullname
+#  %d - date
+#  %g - Global Diagnostic Context (GDC)
+#  %t - trace
+#  %m - message
+#  %h - thread name
+#  %p - process ID aka PID
+#  %M - formatted message
+#  %l - Level in string form

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: log4r-sequel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Conor Horan-Kates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.15.1
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.15.1
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.15'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Log4r::Outputter that writes to a Sequel database
+email:
+- conor.code@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- example/log2postgres.rb
+- example/log2sqlite.rb
+- example/log4r-postgres.yaml
+- example/log4r-sqlite.yaml
+- lib/log4r/outputter/sequeloutputter.rb
+- test/functional/test_sqlite.rb
+- test/log4r-sqlite_test.yaml
+homepage: http://github.com/chorankates/log4r-sequel
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Log4r::Outputter::Sequel
+test_files: []