lita-datadog 0.2.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd4e57520c88208a94b5c25e9097ddb937434faa
-  data.tar.gz: 83cb05a53cfc3fb0a92599d4ca5bf9aa3423c6fe
+  metadata.gz: 674d744f8af8eef3c2124caf7fe6f330edfed54d
+  data.tar.gz: dd9e912e13bb4ce44fd3ba42991301c68b2c8790
 SHA512:
-  metadata.gz: 6b69e3ff4a8a1929187424cef95957ee6dfcc7644fc9cf631bb0cd2438368c87eff14e628377e4fec97678b2db03e22434075ce63905d29a6423bee507c27757
-  data.tar.gz: 146518897c2d1ce891f12f0ddbaf27b130895e5f7be0ef40e03b75d1fe84f404b8178781ca54db09c5e6d7cdad4b47bd84c17c922c00589ffdc45b460388d0b6
+  metadata.gz: 1e331d216b2083724b8ee65a9c939a7be060200b8a86720362b653175315a424aae3698e292830b3c3d8a1248969f1f22d867a9647a4babd959a23c9fefc000f
+  data.tar.gz: fe96cea3e2fd8a0040f81e0be28da1a0da91ec463be3890eb137ce8ac6784c5d68f08b1f7095293f26baa29d33318f1736d5ff2de816fc6e50ec1c61060b7bb6

data/.rubocop.yml

@@ -1,12 +1,7 @@
-AllCops:
-  Excludes:
-    - lita-datadog.gemspec
-
-LineLength:
-  Max: 120
-
-MethodLength:
-  Max: 20
-
 Documentation:
-  Enabled: false
+  Exclude:
+    - lib/lita/handlers/datadog.rb
+
+FileName:
+  Exclude:
+    - lib/lita-datadog.rb

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.1.0
+  - 2.1
 script: bundle exec rake
 before_install:
   - gem update --system

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+Pull requests are awesome!  Pull requests with tests are even more awesome!
+
+## Quick steps
+
+1. Fork the repo.
+2. Run the tests: `bundle && rake`
+3. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, it needs a test!
+4. Make the test pass.
+5. Push to your fork and submit a pull request.

data/Gemfile

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

data/README.md

@@ -1,10 +1,13 @@
 # lita-datadog
 
-[![Build Status](https://travis-ci.org/esigler/lita-datadog.png?branch=master)](https://travis-ci.org/esigler/lita-datadog)
-[![Code Climate](https://codeclimate.com/github/esigler/lita-datadog.png)](https://codeclimate.com/github/esigler/lita-datadog)
-[![Coverage Status](https://coveralls.io/repos/esigler/lita-datadog/badge.png)](https://coveralls.io/r/esigler/lita-datadog)
+[![Build Status](https://img.shields.io/travis/esigler/lita-datadog/master.svg)](https://travis-ci.org/esigler/lita-datadog)
+[![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-datadog.svg)](https://rubygems.org/gems/lita-datadog)
+[![Coveralls Coverage](https://img.shields.io/coveralls/esigler/lita-datadog/master.svg)](https://coveralls.io/r/esigler/lita-datadog)
+[![Code Climate](https://img.shields.io/codeclimate/github/esigler/lita-datadog.svg)](https://codeclimate.com/github/esigler/lita-datadog)
+[![Gemnasium](https://img.shields.io/gemnasium/esigler/lita-datadog.svg)](https://gemnasium.com/esigler/lita-datadog)
 
-Interact with Datadog (https://www.datadoghq.com/).
+A [Datadog](http://datadoghq.com) plugin for [Lita](https://github.com/jimmycuadra/lita).
 
 ## Installation
 
@@ -18,25 +21,50 @@ gem "lita-datadog"
 
 ### Required attributes
 
-You will need to get your API key, and configure an application key.  Go to https://app.datadoghq.com/account/settings#api for both.
+You will need a DataDog API key, and an application key.  Go to https://app.datadoghq.com/account/settings#api for both.
 
-* `api_key` (String) - Your DataDog API key. Default: `nil`
-* `application_key` (String) - Your DataDog application key.  Default: `nil`
+Add the following variable to your Lita config file:
+```
+Lita.configure do |config|
+...
+  config.handlers.datadog.api_key = '_api_key_goes_here_'
+  config.handlers.datadog.application_key = '_app_key_goes_here_'
+...
+end
+```
 
 ### Optional attributes
 
 * `timerange` (Integer) - How long in seconds a time range will be for graphs. Default: `3600`
-* `waittime` (Integer) - How long to wait after getting a URL from Datadog to display it (sometimes the graph isn't ready yet). Default: `1`
-
-### Example
+* `waittime` (Integer) - How long to wait after getting a URL from Datadog to display it (sometimes the graph isn't ready yet). Default: `0`
 
 ## Usage
 
+### Graphs
+
+Basic graph of the load on all of your systems:
+
 ```
 Lita graph metric:"system.load.1{*}"
+```
+
+Graph of load for one specific system:
+```
 Lita graph metric:"system.load.1{host:hostname01}"
+```
+
+Multiple attributes plotted in one graph:
+```
 Lita graph metric:"system.load.1{*},system.load.5{*}"
+```
+
+Show graph, with events marked in:
+```
 Lita graph metric:"system.load.1{*}" event:"sources:sourcename"
+```
+
+Manipulate time range being graphed:
+```
 Lita graph metric:"system.load.1{*}" start:"2 hours ago"
 Lita graph metric:"system.load.1{*}" from:"2 hours ago" to:"30 minutes ago"
 ```

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-datadog.rb

@@ -5,3 +5,6 @@ Lita.load_locales Dir[File.expand_path(
 )]
 
 require 'lita/handlers/datadog'
+
+require 'dogapi'
+require 'chronic'

data/lib/lita/handlers/datadog.rb

@@ -1,61 +1,73 @@
-require 'dogapi'
-require 'chronic'
-
 module Lita
   module Handlers
     class Datadog < Handler
+      config :api_key, required: true
+      config :application_key, required: true
+      config :timerange, default: 3600
+      config :waittime, default: 0
+
       route(
         /^graph\s(.*)$/,
         :graph,
         command: true,
-        help: { 'graph metric:"simple.metric.1{*},simple.metric.5{*}"' =>
-          'Graph those metrics, for the default time range' }
+        help: { t('help.graph.syntax') => t('help.graph.desc') }
       )
 
-      def self.default_config(config)
-        config.api_key = nil
-        config.application_key = nil
-        config.timerange = 3600
-        config.waittime = 1
-      end
-
       def graph(response)
         args = parse_arguments(response.matches[0][0])
-        return_code, snapshot = graph_snapshot(args[:metric], args[:start],
-                                               args[:end], args[:event])
+        response.reply(get_response(args))
+      end
+
+      private
+
+      def get_response(args)
+        return_code, snapshot = get_graph_url(args[:metric],
+                                              args[:start],
+                                              args[:end],
+                                              args[:event])
+
         if return_code.to_s == '200'
-          sleep Lita.config.handlers.datadog.waittime
-          response.reply(snapshot['snapshot_url'])
+          sleep config.waittime
+          return snapshot['snapshot_url']
         else
-          response.reply('Error requesting Datadog graph')
+          t('errors.request')
         end
       end
 
-      private
+      def get_graph_url(metric_query, start_ts, end_ts, event_query)
+        client = Dogapi::Client.new(config.api_key, config.application_key)
 
-      def graph_snapshot(metric_query, start_ts, end_ts, event_query)
-        return nil if Lita.config.handlers.datadog.api_key.nil? ||
-                      Lita.config.handlers.datadog.application_key.nil?
+        return nil unless client
 
-        client = Dogapi::Client.new(Lita.config.handlers.datadog.api_key,
-                                    Lita.config.handlers.datadog.application_key)
-
-        return client.graph_snapshot(metric_query, start_ts, end_ts, event_query) if client
+        client.graph_snapshot(metric_query, start_ts, end_ts, event_query)
       end
 
       def parse_arguments(arg_string)
-        end_m    = /(to|end):"(.+?)"/.match(arg_string)
-        end_ts   = end_m ? Chronic.parse(end_m[2]).to_i : Time.now.to_i
-        start_m  = /(from|start):"(.+?)"/.match(arg_string)
-        start_ts = start_m ? Chronic.parse(start_m[2]).to_i : end_ts - Lita.config.handlers.datadog.timerange
-        metric_m = /metric:"(.+?)"/.match(arg_string)
-        metric   = metric_m ? metric_m[1] : 'system.load.1{*}'
-        event_m  = /event:"(.+?)"/.match(arg_string)
-        event    = event_m ? event_m[1] : ''
-        { metric: metric,
-          start: start_ts,
-          end: end_ts,
-          event: event }
+        end_ts   = parse_end(arg_string)
+        start_ts = parse_start(arg_string, end_ts)
+        metric   = parse_metric(arg_string)
+        event    = parse_event(arg_string)
+        { metric: metric, start: start_ts, end: end_ts, event: event }
+      end
+
+      def parse_end(string)
+        found = /(to|end):"(.+?)"/.match(string)
+        found ? Chronic.parse(found[2]).to_i : Time.now.to_i
+      end
+
+      def parse_start(string, end_ts)
+        found = /(from|start):"(.+?)"/.match(string)
+        found ? Chronic.parse(found[2]).to_i : end_ts - config.timerange
+      end
+
+      def parse_metric(string)
+        found = /metric:"(.+?)"/.match(string)
+        found ? found[1] : 'system.load.1{*}'
+      end
+
+      def parse_event(string)
+        found = /event:"(.+?)"/.match(string)
+        found ? found[1] : ''
       end
     end
 

data/lita-datadog.gemspec

@@ -1,26 +1,27 @@
 Gem::Specification.new do |spec|
-  spec.name          = "lita-datadog"
-  spec.version       = "0.2.0"
-  spec.authors       = ["Eric Sigler"]
-  spec.email         = ["me@esigler.com"]
-  spec.description   = %q{A Lita handler for interacting with Datadog}
-  spec.summary       = %q{Query metrics, events, and generate graphs from Datadog}
-  spec.homepage      = "http://github.com/esigler/lita-datadog"
-  spec.license       = "MIT"
-  spec.metadata      = { "lita_plugin_type" => "handler" }
+  spec.name          = 'lita-datadog'
+  spec.version       = '0.9.0'
+  spec.authors       = ['Eric Sigler']
+  spec.email         = ['me@esigler.com']
+  spec.description   = 'A Datadog plugin for Lita'
+  spec.summary       = 'A Datadog plugin for Lita'
+  spec.homepage      = 'http://github.com/esigler/lita-datadog'
+  spec.license       = 'MIT'
+  spec.metadata      = { 'lita_plugin_type' => 'handler' }
 
-  spec.files         = `git ls-files`.split($/)
-  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.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "lita", ">= 3.0"
-  spec.add_runtime_dependency "dogapi"
-  spec.add_runtime_dependency "chronic"
+  spec.add_runtime_dependency 'lita', '>= 4.0'
+  spec.add_runtime_dependency 'dogapi'
+  spec.add_runtime_dependency 'chronic'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", ">= 3.0.0.beta2"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 3.0.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
 end

data/locales/en.yml

@@ -2,3 +2,9 @@ en:
   lita:
     handlers:
       datadog:
+        errors:
+          request: Error requesting Datadog graph
+        help:
+          graph:
+            syntax: 'graph metric:"simple.metric.1{*},simple.metric.5{*}'
+            desc: 'Graph those metrics, for the default time range'

data/spec/lita/handlers/datadog_spec.rb

@@ -4,10 +4,34 @@ describe Lita::Handlers::Datadog, lita_handler: true do
   EXAMPLE_IMAGE_URL = 'http://www.example.com/path/that/ends/in.png'
   EXAMPLE_ERROR_MSG = 'Error requesting Datadog graph'
 
-  it { routes_command('graph metric:"system.load.1{*}"').to(:graph) }
-  it { routes_command('graph metric:"system.load.1{host:hostname01}"').to(:graph) }
-  it { routes_command('graph metric:"system.load.1{*},system.load.5{*}"').to(:graph) }
-  it { routes_command('graph metric:"system.load.1{*}" event:"sources:something"').to(:graph) }
+  let(:success) do
+    client = double
+    allow(client).to receive(:graph_snapshot) {
+      [200, { 'snapshot_url' => EXAMPLE_IMAGE_URL }]
+    }
+    client
+  end
+
+  let(:error) do
+    client = double
+    allow(client).to receive(:graph_snapshot) { [500, {}] }
+    client
+  end
+
+  it do
+    is_expected.to route_command(
+      'graph metric:"system.load.1{*}"')
+      .to(:graph)
+    is_expected.to route_command(
+      'graph metric:"system.load.1{host:hostname01}"')
+      .to(:graph)
+    is_expected.to route_command(
+      'graph metric:"system.load.1{*},system.load.5{*}"')
+      .to(:graph)
+    is_expected.to route_command(
+      'graph metric:"system.load.1{*}" event:"sources:something"')
+      .to(:graph)
+  end
 
   describe '.default_config' do
     it 'sets the api_key to nil' do
@@ -22,45 +46,38 @@ describe Lita::Handlers::Datadog, lita_handler: true do
       expect(Lita.config.handlers.datadog.timerange).to eq(3600)
     end
 
-    it 'sets the waittime to 1' do
-      expect(Lita.config.handlers.datadog.waittime).to eq(1)
+    it 'sets the waittime to 0' do
+      expect(Lita.config.handlers.datadog.waittime).to eq(0)
     end
   end
 
   describe '#graph' do
     it 'with valid metric returns an image url' do
-      response = { 'snapshot_url' => EXAMPLE_IMAGE_URL }
-      allow_any_instance_of(Lita::Handlers::Datadog).to \
-        receive(:graph_snapshot).with(any_args).and_return([200, response])
+      expect(Dogapi::Client).to receive(:new) { success }
       send_command('graph metric:"system.load.1{*}"')
       expect(replies.last).to eq(EXAMPLE_IMAGE_URL)
     end
 
     it 'with invalid metric returns an error' do
-      allow_any_instance_of(Lita::Handlers::Datadog).to \
-        receive(:graph_snapshot).with(any_args).and_return([500, nil])
+      expect(Dogapi::Client).to receive(:new) { error }
       send_command('graph metric:"omg.wtf.bbq{*}"')
       expect(replies.last).to eq(EXAMPLE_ERROR_MSG)
     end
 
     it 'with valid metric and event returns an image url' do
-      response = { 'snapshot_url' => EXAMPLE_IMAGE_URL }
-      allow_any_instance_of(Lita::Handlers::Datadog).to \
-        receive(:graph_snapshot).with(any_args).and_return([200, response])
+      expect(Dogapi::Client).to receive(:new) { success }
       send_command('graph metric:"system.load.1{*}"')
       expect(replies.last).to eq(EXAMPLE_IMAGE_URL)
     end
 
     it 'with an invalid metric returns an error' do
-      allow_any_instance_of(Lita::Handlers::Datadog).to \
-        receive(:graph_snapshot).with(any_args).and_return([500, nil])
+      expect(Dogapi::Client).to receive(:new) { error }
       send_command('graph metric:"omg.wtf.bbq{*}" event:"sources:sourcename"')
       expect(replies.last).to eq(EXAMPLE_ERROR_MSG)
     end
 
     it 'with an invalid event returns an error' do
-      allow_any_instance_of(Lita::Handlers::Datadog).to \
-        receive(:graph_snapshot).with(any_args).and_return([500, nil])
+      expect(Dogapi::Client).to receive(:new) { error }
       send_command('graph metric:"system.load.1{*}" event:"omg:wtf"')
       expect(replies.last).to eq(EXAMPLE_ERROR_MSG)
     end

data/spec/spec_helper.rb

@@ -8,3 +8,5 @@ SimpleCov.start { add_filter '/spec/' }
 
 require 'lita-datadog'
 require 'lita/rspec'
+
+Lita.version_3_compatibility_mode = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-datadog
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Eric Sigler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: dogapi
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,16 +100,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,7 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Lita handler for interacting with Datadog
+description: A Datadog plugin for Lita
 email:
 - me@esigler.com
 executables: []
@@ -132,6 +146,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -163,10 +178,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Query metrics, events, and generate graphs from Datadog
+summary: A Datadog plugin for Lita
 test_files:
 - spec/lita/handlers/datadog_spec.rb
 - spec/spec_helper.rb