cinch-logger-canonical 0.0.1

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brian Haberer
+
+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,34 @@
+# Cinch::Logger::Canonical
+
+This Logger will log the channels that the bot joins in a very simple format:
+
+    [YYYY-MM-DD HH:MM:SS] <NICK> MESSAGE
+    [YYYY-MM-DD HH:MM:SS] * NICK ACTION
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cinch-logger-canonical'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cinch-logger-canonical
+
+## Usage
+
+All you need to do is add the new logger to your @bot:
+
+    @bot.loggers << Cinch::Logger::CanonicalLogger.new(channel, @bot)
+
+## Contributing
+
+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 @@
+require "bundler/gem_tasks"

data/cinch-logger-canonical.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cinch-logger-canonical/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cinch-logger-canonical"
+  gem.version       = Cinch::Logger::Canonical::VERSION
+  gem.authors       = ["Brian Haberer"]
+  gem.email         = ["bhaberer@gmail.com"]
+  gem.description   = %q{Cinch logger that logs basic irc channel chatter}
+  gem.summary       = %q{Simple Cinch Logger}
+  gem.homepage      = "https://github.com/bhaberer/cinch-logger-canonical"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/cinch-logger-canonical.rb

@@ -0,0 +1,73 @@
+require "cinch-logger-canonical/version"
+require "cinch/logger"
+
+module Cinch
+  class Logger
+    class CanonicalLogger < Cinch::Logger
+      # (see Logger#log)
+      def log(messages, event = :debug, level = event)
+        return unless will_log?(level)
+
+        @mutex.synchronize do
+          # Ensure that we're logging to the right file.
+          Array(messages).each do |message|
+            next unless message.match(Regexp.new("PRIVMSG ##{@channel}"))
+            message = format_general(message)
+            message = format_message(message, event)
+
+            next if message.nil?
+            sync_logfile
+            @output.puts message.encode("locale", {:invalid => :replace, :undef => :replace})
+          end
+        end
+      end
+
+      def initialize(channel, bot)
+        @bot_name     = bot.nick
+        @channel      = channel
+        @output       = File.open(today_log, 'a')
+        @output.sync  = true
+        @mutex        = Mutex.new
+        @level        = :debug
+      end
+
+      private
+
+      def today_log
+        # TODO allow for custom log paths
+        Dir.mkdir('./logs') unless Dir.exist?('./logs')
+        File.join('.', 'logs', "#{@channel}_#{Time.now.strftime("%Y-%m-%d")}.log")
+      end
+
+      def format_incoming(message)
+        nick = message.match(/^:(\S+)!/)[1] rescue 'NONICK'
+        msg  = message.match(/#\S+ :(.+)$/)[1] rescue 'NOMSG'
+        generic_format(nick, msg)
+      end
+
+      def format_outgoing(message)
+        msg = message.match(/#\S+ :(.+)$/)[1] rescue 'NOMSG'
+        generic_format(@bot_name, msg)
+      end
+
+      def generic_format(nick, m)
+        message = '[' + Time.now.strftime("%Y-%m-%d %H:%M:%S") + '] '
+        # This seems gross, fix this with better rubies.
+        if m.codepoints.first == 1 && m.match(/ACTION/)
+          message << " * #{nick} #{m.gsub(/^.?ACTION /, '')}"
+        else
+          message << "<#{nick}> #{m}"
+        end
+        return message
+      end
+
+      def sync_logfile
+        unless @output.path == today_log
+          @output.close
+          @output = File.open(today_log, 'a')
+          @output.sync = true
+        end
+      end
+    end
+  end
+end

data/lib/cinch-logger-canonical/version.rb

@@ -0,0 +1,7 @@
+module Cinch
+  class Logger
+    module Canonical
+      VERSION = "0.0.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: cinch-logger-canonical
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian Haberer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-19 00:00:00.000000000 Z
+dependencies: []
+description: Cinch logger that logs basic irc channel chatter
+email:
+- bhaberer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cinch-logger-canonical.gemspec
+- lib/cinch-logger-canonical.rb
+- lib/cinch-logger-canonical/version.rb
+homepage: https://github.com/bhaberer/cinch-logger-canonical
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Simple Cinch Logger
+test_files: []