lita-log 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aefe79b6d9c34c113510fa54055503666b92e250
+  data.tar.gz: 8fe1a8717d17c892ec19d3bd2b6afda0062da4ef
+SHA512:
+  metadata.gz: 58190bfe29365aaf331fcfec401edd84bd911f903034731cb68391d65e4fa9d431a7c3cd5d8cb002d714e2f8edd467878886516ae7d17af8d981c054adcb7339
+  data.tar.gz: 596939074ea5c4a9670e397ad7c721a1bd758f4d61ab8c12eb1a0843bcbf5a2fb6055ed37f31254c9dc41dc203f30a636fbe97088cb0b020b4dc1a6dfe859be0

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,15 @@
+FileName:
+  Exclude:
+    - lib/lita-log.rb
+
+LineLength:
+  Max: 130
+
+AbcSize:
+  Max: 30
+
+MethodLength:
+  Max: 20
+
+ClassLength:
+  Max: 150

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Tristan Chong
+
+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,36 @@
+# lita-log
+
+[![Build Status](https://travis-ci.org/tristaneuan/lita-log.png?branch=master)](https://travis-ci.org/tristaneuan/lita-log)
+[![Coverage Status](https://coveralls.io/repos/tristaneuan/lita-log/badge.png)](https://coveralls.io/r/tristaneuan/lita-log)
+
+**lita-log** is a handler for [Lita](https://github.com/litaio/lita) that logs arbitrary messages to the bot's Logger object.
+
+## Installation
+
+Add lita-log to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-log"
+```
+
+## Usage
+
+In order to record a message in Lita's log, a user must be a member of the `:log_admins` [authorization group](http://docs.lita.io/getting-started/usage/#authorization-groups). Valid log levels are: UNKNOWN, FATAL, ERROR, WARN, INFO, DEBUG
+
+```
+<me>   lita: log info Hello world!
+<lita> Successfully logged 'Hello world!' with level INFO
+<me>   lita: log fatal This is a test. This is a test of the incident alerting system. This is only a test.
+<lita> Successfully logged 'This is a test. This is a test of the incident alerting system. This is only a test.' with level FATAL
+```
+
+The resulting log entries will look like this:
+
+```
+[2015-12-15 19:45:36 UTC] INFO: Hello world!
+[2015-12-15 19:45:44 UTC] FATAL: This is a test. This is a test of the incident alerting system. This is only a test.
+```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:spec, :rubocop]

data/lib/lita-log.rb

@@ -0,0 +1,12 @@
+require 'lita'
+
+Lita.load_locales Dir[File.expand_path(
+  File.join('..', '..', 'locales', '*.yml'), __FILE__
+)]
+
+require 'lita/handlers/log'
+
+Lita::Handlers::Log.template_root File.expand_path(
+  File.join('..', '..', 'templates'),
+  __FILE__
+)

data/lib/lita/handlers/log.rb

@@ -0,0 +1,30 @@
+module Lita
+  # What about us loggers?
+  module Handlers
+    # Hard-workin' men who like to stand up after they've taken a poo and then
+    # turn around and cut their poo in half with their urine?
+    class Log < Handler
+      LEVELS = %w(unknown fatal error warn info debug)
+
+      route(
+        /^log\s+(?<level>\w+)\s+(?<message>.*)/i,
+        :log_message,
+        command: true,
+        restrict_to: :log_admins,
+        help: { t('help.log_key') => t('help.log_value') }
+      )
+
+      def log_message(response)
+        level = response.match_data[:level].downcase
+        message = response.match_data[:message].strip
+
+        return response.reply(t('log.invalid', level: level)) unless LEVELS.include?(level)
+
+        log.send(level.to_sym, message)
+        response.reply(t('log.success', level: level.upcase, message: message))
+      end
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lita-log.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'lita-log'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Tristan Chong']
+  spec.email         = ['ong@tristaneuan.ch']
+  spec.description   = "A Lita handler that logs arbitrary messages to Lita's Logger object"
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/tristaneuan/lita-log'
+  spec.license       = 'MIT'
+  spec.metadata      = { 'lita_plugin_type' => 'handler' }
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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_runtime_dependency 'lita', '>= 4.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rspec', '>= 3.0.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+end

data/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  lita:
+    handlers:
+      log:
+        help:
+          log_key: "log LEVEL MESSAGE"
+          log_value: "Log a message to Lita's Logger object. Valid levels: UNKNOWN, FATAL, ERROR, WARN, INFO, DEBUG"
+        log:
+          invalid: "%{level} is not a valid log level. Try: UNKNOWN, FATAL, ERROR, WARN, INFO, DEBUG"
+          success: "Successfully logged '%{message}' with level %{level}"

data/spec/lita/handlers/log_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Lita::Handlers::Log, lita_handler: true do
+  let(:alice) { Lita::User.create('U1', name: 'Alice', mention_name: 'alice') }
+  let(:bob) { Lita::User.create('U2', name: 'Bob', mention_name: 'bob') }
+  let(:logger) { double('Logger') }
+
+  before do
+    robot.auth.add_user_to_group!(alice, :log_admins)
+    allow_any_instance_of(described_class).to receive(:log).and_return(logger)
+  end
+
+  it { is_expected.not_to route_command('log info foo bar').to(:log_message) }
+  it { is_expected.not_to route_command('log foo bar baz').to(:log_message) }
+  it { is_expected.to route_command('log info foo bar').with_authorization_for(:log_admins).to(:log_message) }
+  it { is_expected.to route_command('LOG foo bar baz').with_authorization_for(:log_admins).to(:log_message) }
+
+  describe '#log_message' do
+    context 'when the user is authorized' do
+      it 'logs a message with a valid level' do
+        expect(logger).to receive(:info).with('foo bar baz')
+        send_command('log Info foo bar baz', as: alice)
+        expect(replies.count).to eq(1)
+        expect(replies.last).to eq("Successfully logged 'foo bar baz' with level INFO")
+      end
+
+      it 'complains with an invalid level' do
+        expect(logger).not_to receive(:foo)
+        send_command('log foo bar baz', as: alice)
+        expect(replies.count).to eq(1)
+        expect(replies.last).to eq('foo is not a valid log level. Try: UNKNOWN, FATAL, ERROR, WARN, INFO, DEBUG')
+      end
+    end
+
+    context 'when the user is not authorized' do
+      it 'does nothing' do
+        expect(logger).not_to receive(:info)
+        send_command('log info foo bar baz', as: bob)
+        expect(replies.count).to eq(0)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter '/spec/' }
+
+require 'lita-log'
+require 'lita/rspec'
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: lita-log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tristan Chong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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'
+- !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: pry-byebug
+  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: 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: rack-test
+  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: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: 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
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: A Lita handler that logs arbitrary messages to Lita's Logger object
+email:
+- ong@tristaneuan.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-log.rb
+- lib/lita/handlers/log.rb
+- lita-log.gemspec
+- locales/en.yml
+- spec/lita/handlers/log_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/tristaneuan/lita-log
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+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.5
+signing_key: 
+specification_version: 4
+summary: A Lita handler that logs arbitrary messages to Lita's Logger object
+test_files:
+- spec/lita/handlers/log_spec.rb
+- spec/spec_helper.rb