lita-metrics 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4dd851e5cdba74c0ed101f678eb7e047bc51c6f
-  data.tar.gz: 719ed64a1e3a628884b9a66e73b968bbfe5d7463
+  metadata.gz: d5810f0ec2581b26528e22e670b620434b16c654
+  data.tar.gz: 117fcf410d0e14dc77173e0e9c516e8453b14500
 SHA512:
-  metadata.gz: 36d77bf75181b61bbf202136c4b75628ce66827b258a16b615b15161ec620d1302741af174b38cf97d6f1ec596c5c41ca17727872496bc5c5543c8043bf85e52
-  data.tar.gz: e5799ba8e53eff76198b1c8f4cae47dc7bee400a2859f9204dc384304900de36eb087cc956353449045881e7e1cd04c574d0065d6d1cd8fb6fcad58e76921eee
+  metadata.gz: 60c2efa99e09277b5474dc64b846d5f9a571aaf36063beb1994e3d399b432d496e6399e8c0da7a11ac51646a67172d84870c6c2036493397557f444dd1d96fab
+  data.tar.gz: 338da017d948282a05202195ce68b9eb16f5da5a53f6312cf5bcf9ece7b9b377601580b7390c4ebb2216b62f6ce0a387b2e8e4dac8def65f578b4645cf142d3c

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AbcSize:
+  Max: 22
+
+Documentation:
+  Exclude:
+    - lib/lita/handlers/metrics.rb
+
+FileName:
+  Exclude:
+    - lib/lita-metrics.rb
+
+LineLength:
+  Max: 120

data/.travis.yml

@@ -1,8 +1,7 @@
 language: ruby
 rvm:
-  - 2.2.2
-script: bundle exec rake
-before_install:
-  - gem update --system
+  - 2.1
+  - 2.2
 services:
   - redis-server
+sudo: false

data/Gemfile

@@ -1,5 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
-
-gem "lita", github: "jimmycuadra/lita", ref: "d15f6f0ca95be03a4c76802af19b1a532c61eabc"

data/README.md

@@ -1,7 +1,11 @@
 # lita-metrics
 
-[![Build Status](https://travis-ci.org/PagerDuty/lita-metrics.png?branch=master)](https://travis-ci.org/PagerDuty/lita-metrics)
-[![Coverage Status](https://coveralls.io/repos/PagerDuty/lita-metrics/badge.png)](https://coveralls.io/r/PagerDuty/lita-metrics)
+[![Build Status](https://img.shields.io/travis/PagerDuty/lita-metrics/master.svg)](https://travis-ci.org/PagerDuty/lita-metrics)
+[![MIT License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://tldrlegal.com/license/mit-license)
+[![RubyGems :: RMuh Gem Version](http://img.shields.io/gem/v/lita-metrics.svg)](https://rubygems.org/gems/lita-metrics)
+[![Coveralls Coverage](https://img.shields.io/coveralls/PagerDuty/lita-metrics/master.svg)](https://coveralls.io/r/PagerDuty/lita-metrics)
+[![Code Climate](https://img.shields.io/codeclimate/github/PagerDuty/lita-metrics.svg)](https://codeclimate.com/github/PagerDuty/lita-metrics)
+[![Gemnasium](https://img.shields.io/gemnasium/PagerDuty/lita-metrics.svg)](https://gemnasium.com/PagerDuty/lita-metrics)
 
 **lita-metrics** is a handler for [Lita](https://github.com/jimmycuadra/lita) that keeps track of Lita usage metrics (e.g. users, rooms, handlers and methods triggered) using [Datadog](http://www.datadoghq.com/). It also logs messages that match valid chat routes, as well as attempted commands that failed to trigger any handlers.
 
@@ -29,6 +33,7 @@ gem "lita-metrics"
   * `:command` - A boolean indicating whether the message was a command
   * `:handler` - The name of the handler invoked. Not available for invalid commands
   * `:method` - The name of the handler method invoked. Not available for invalid commands
+* `ignored_methods` - An array of methods that should be ignored. Useful for handler methods that "overhear" messages not necessarily directed at the bot. Default: `[]`
 
 ``` ruby
 Lita.configure do |config|
@@ -39,6 +44,7 @@ Lita.configure do |config|
   config.handlers.metrics.valid_command_metric = 'lita.messages.all'
   config.handlers.metrics.invalid_command_metric = 'lita.messages.failed'
   config.handlers.metrics.log_fields = [:user, :handler, :message]
+  config.handlers.metrics.ignored_methods = ['Jira#ambient']
 end
 ```
 

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+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
+task default: [:spec, :rubocop]

data/lib/lita-metrics.rb

@@ -12,5 +12,5 @@ require 'lita/handlers/metrics'
 
 Lita::Handlers::Metrics.template_root File.expand_path(
   File.join('..', '..', 'templates'),
- __FILE__
+  __FILE__
 )

data/lib/lita/handlers/metrics.rb

@@ -14,6 +14,7 @@ module Lita
       config :valid_command_metric, type: String, default: 'lita.commands.valid'
       config :invalid_command_metric, type: String, default: 'lita.commands.invalid'
       config :log_fields, default: [:user, :room, :message]
+      config :ignored_methods, type: Array, default: []
 
       on :loaded, :setup
       on :message_dispatched, :valid_command
@@ -28,9 +29,11 @@ module Lita
       def valid_command(payload)
         fields = extract_fields(payload)
 
+        return if ignore?(fields)
+
         self.class.statsd.increment(
           config.valid_command_metric,
-          tags: fields.each.select { |k, v| k != :message }.map { |k, v| "#{k}:#{v}" }
+          tags: fields.each.select { |k, _v| k != :message }.map { |k, v| "#{k}:#{v}" }
         )
 
         self.class.valid_command_log.info(format_log(fields)) unless fields[:private_message]
@@ -43,7 +46,7 @@ module Lita
 
         self.class.statsd.increment(
           config.invalid_command_metric,
-          tags: fields.each.select { |k, v| k != :message }.map { |k, v| "#{k}:#{v}" }
+          tags: fields.each.select { |k, _v| k != :message }.map { |k, v| "#{k}:#{v}" }
         )
 
         self.class.invalid_command_log.info(format_log(fields)) unless fields[:private_message]
@@ -55,6 +58,8 @@ module Lita
         arg.is_a?(Array) ? arg : [arg]
       end
 
+      # rubocop:disable Metrics/MethodLength
+      # Note: This could be refactored into smaller functions at some point
       def extract_fields(payload)
         m = payload[:message]
 
@@ -77,10 +82,22 @@ module Lita
 
         fields
       end
+      # rubocop:enable Metrics/MethodLength
 
       def format_log(fields)
         CSV.generate_line(arrayize(config.log_fields).each.map { |x| fields[x] }).chomp
       end
+
+      def ignore?(fields)
+        config.ignored_methods.map { |string| string.split('#') }.each do |handler, method|
+          return true if same?(fields[:handler], "Lita::Handlers::#{handler}") && same?(fields[:method], method)
+        end
+        false
+      end
+
+      def same?(a, b)
+        a.to_s.downcase == b.to_s.downcase
+      end
     end
 
     Lita.register_handler(Metrics)

data/lita-metrics.gemspec

@@ -1,27 +1,28 @@
 Gem::Specification.new do |spec|
-  spec.name          = "lita-metrics"
-  spec.version       = "0.1.0"
-  spec.authors       = ["Tristan Chong"]
-  spec.email         = ["tristan@pagerduty.com"]
-  spec.description   = "A Lita handler that tracks Lita usage metrics."
-  spec.summary       = "A Lita handler that tracks Lita usage metrics."
-  spec.homepage      = "https://github.com/PagerDuty/lita-metrics"
-  spec.license       = "MIT"
-  spec.metadata      = { "lita_plugin_type" => "handler" }
+  spec.name          = 'lita-metrics'
+  spec.version       = '0.1.1'
+  spec.authors       = ['Tristan Chong']
+  spec.email         = ['tristan@pagerduty.com']
+  spec.description   = 'A Lita handler that tracks Lita usage metrics.'
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/PagerDuty/lita-metrics'
+  spec.license       = 'MIT'
+  spec.metadata      = { 'lita_plugin_type' => 'handler' }
 
-  spec.files         = `git ls-files`.split($/)
+  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.require_paths = ['lib']
 
-  spec.add_runtime_dependency "lita", ">= 4.5"
-  spec.add_runtime_dependency "dogstatsd-ruby", "~> 1.5.0"
+  spec.add_runtime_dependency 'lita', '>= 4.6'
+  spec.add_runtime_dependency 'dogstatsd-ruby', '~> 1.5.0'
 
-  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 "simplecov"
-  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rubocop'
 end

data/spec/lita/handlers/metrics_spec.rb

@@ -11,30 +11,27 @@ describe Lita::Handlers::Metrics, lita_handler: true do
 
       route(/message/, :test_message)
       route(/command/, :test_command, command: true)
+      route(/ignore/, :test_ignore)
 
-      def test_message(response)
-        response.reply('message')
+      def test_message(_response)
       end
 
-      def test_command(response)
-        response.reply('command')
+      def test_command(_response)
       end
 
-      route(/block/) do |response|
-        response.reply('block')
+      def test_ignore(_response)
+      end
+
+      route(/block/) do |_response|
       end
     end
   end
 
-  let(:john) do
-    Lita::User.create('U1234ABCD', name: 'John', mention_name: 'john')
-  end
+  let(:john) { Lita::User.create('U1234ABCD', name: 'John', mention_name: 'john') }
 
-  let(:general) do
-    Lita::Room.create_or_update('C1234567890', name: 'general')
-  end
+  let(:general) { Lita::Room.create_or_update('C1234567890', name: 'general') }
 
-  before do
+  before(:each) do
     robot.trigger(:loaded)
     registry.register_handler(test_handler)
   end
@@ -82,6 +79,12 @@ describe Lita::Handlers::Metrics, lita_handler: true do
         )
         send_command('command', as: john, from: general)
       end
+
+      it 'ignores methods specified in the configuration' do
+        registry.config.handlers.metrics.ignored_methods = %w(Test#test_ignore)
+        expect(described_class.statsd).not_to receive(:increment)
+        send_message('ignore')
+      end
     end
 
     describe 'logger' do

data/spec/spec_helper.rb

@@ -1,14 +1,12 @@
-require "simplecov"
-require "coveralls"
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatters = [
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter
 ]
-SimpleCov.start { add_filter "/spec/" }
+SimpleCov.start { add_filter '/spec/' }
 
-require "lita-metrics"
-require "lita/rspec"
+require 'lita-metrics'
+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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-metrics
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tristan Chong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2015-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.6'
 - !ruby/object:Gem::Dependency
   name: dogstatsd-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +42,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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'
 description: A Lita handler that tracks Lita usage metrics.
 email:
 - tristan@pagerduty.com
@@ -145,6 +159,7 @@ extra_rdoc_files: []
 files:
 - ".coveralls.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE