lita-enhance 0.9.0

data/spec/lita/handlers/enhance/session_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Lita::Handlers::Enhance::Session do
+  include_context 'indexed'
+
+  let(:session) { Lita::Handlers::Enhance::Session.new(redis, 'foo', 30) }
+
+  it 'should return nil for last_level and last_message if no message has been enhanced' do
+    expect(session.last_message).to be_nil
+    expect(session.last_level).to be_nil
+  end
+
+  it 'should return the last message and level after enhancing a message' do
+    session.enhance!('hello world', 2)
+    expect(session.last_message).to eq('hello world')
+    expect(session.last_level).to eq(2)
+  end
+
+  it 'should edit the message to enhance it' do
+    message = 'hello world box01'
+    enhanced_message = session.enhance!(message, 1)
+    expect(enhanced_message).to eq('hello world *box01*')
+  end
+
+  it 'should enhance at the supplied level' do
+    message = 'hello world box01'
+    enhanced_message = session.enhance!(message, 2)
+    expect(enhanced_message).to eq('hello world *box01 (us-west-2b)*')
+  end
+
+  it 'should should take care to not double enhance text', focus: true do
+    message = 'hello world 10.254.74.122'
+    enhanced_message = session.enhance!(message, 2)
+    expect(enhanced_message).to eq('hello world *stg-web01 (us-west-2b)*')
+  end
+
+  it 'should be able to enhance multiple items' do
+    message = 'box01 box02'
+    enhanced_message = session.enhance!(message, 2)
+    expect(enhanced_message).to eq('*box01 (us-west-2b)* *box02 (us-west-1c)*')
+  end
+
+  it 'should be able to correctly apply substitutions that result in shorter text' do
+    message = 'before 22:00:0A:FE:4A:79 F2:3C:91:56:A2:00 after'
+    enhanced_message = session.enhance!(message, 1)
+    expect(enhanced_message).to eq('before *box01* *box03* after')
+  end
+end

data/spec/lita/handlers/enhance_spec.rb

@@ -0,0 +1,136 @@
+require "spec_helper"
+
+describe Lita::Handlers::Enhance, lita_handler: true do
+  include_context 'indexed'
+
+  # Make sure that we are indexing into the same Redis namespace that the handler uses.
+  let(:redis) { subject.redis }
+
+  let(:alice) { Lita::User.create("2", name: "Alice") }
+
+  it { routes_command('refresh enhance').to(:refresh) }
+  it { routes_command('enhance stats').to(:stats) }
+
+  it { routes_command('enhance 127.0.0.1').to(:enhance) }
+  it { routes_command("enhance lvl:1 blah\nblah").to(:enhance) }
+  it { routes_command("enhance").to(:enhance) }
+  it { routes_command("enhance lvl:2").to(:enhance) }
+
+  it 'should show stats about itself' do
+    send_command('enhance stats')
+    expect(replies.last).to include('Last refreshed')
+  end
+
+  it 'should be possible to force a refresh of the index' do
+    expect(subject).to receive(:lock_and_refresh_index)
+
+    send_command('refresh enhance')
+
+    # Give the timer a chance to run
+    sleep(0.5)
+
+    expect(replies).to include('Will refresh enhance index...')
+    expect(replies).to include('Refreshed enhance index')
+  end
+
+  it 'should require a message to enhance' do
+    send_command('enhance')
+    expect(replies).to include('I need a string to enhance')
+  end
+
+  it 'should enhance IP addresses' do
+    send_command('enhance 54.214.188.37')
+    expect(replies).to include('*box01*')
+  end
+
+  it 'should return text that is the same format with enhancements applied' do
+    send_command('enhance Finished hinted handoff of 8826 rows to endpoint /10.254.74.121')
+    expect(replies).to include('Finished hinted handoff of 8826 rows to endpoint /*box01*')
+  end
+
+  it 'should allow increasing the level of enhancement' do
+    send_command('enhance lvl:2 54.214.188.37')
+    expect(replies).to include('*box01 (us-west-2b)*')
+  end
+
+  it 'should return an error when the enhancement level is too high' do
+    send_command('enhance lvl:9 54.214.188.37')
+    expect(replies).to include('Cannot enhance above level 5')
+  end
+
+  it 'should allow implicitly enhancing the last enhanced message at a higher level' do
+    # Messages are enhanced at level 1 by default
+    send_command('enhance 54.214.188.37')
+    expect(replies).to include('*box01*')
+
+    # Now we're re-enhancing at level 2
+    send_command('enhance')
+    expect(replies).to include('*box01 (us-west-2b)*')
+  end
+
+  it 'should allow implicitly enhancing the last message at an explicit level' do
+    # If we explicitly enhance at level 3, the next level would be 4
+    send_command('enhance lvl:3 54.214.188.37')
+    expect(replies).to include('*box01 (us-west-2b, _default)*')
+
+    # A user can choose an explicit level....
+    send_command('enhance lvl:1')
+    expect(replies).to include('*box01*')
+
+    # ... which then is retained for the next implicit enhancement
+    send_command('enhance')
+    expect(replies).to include('*box01 (us-west-2b)*')
+  end
+
+  it 'implicit messages are remembered per-source' do
+    send_command('enhance test user 54.214.188.37')
+    expect(replies).to include('test user *box01*')
+
+    send_command('enhance alice 54.214.188.37', as: alice)
+    expect(replies).to include('alice *box01*')
+
+    send_command('enhance lvl:3')
+    expect(replies).to include('test user *box01 (us-west-2b, _default)*')
+
+    send_command('enhance', as: alice)
+    expect(replies).to include('alice *box01 (us-west-2b)*')
+  end
+
+  it 'should call out when nothing could be enhanced' do
+    send_command('enhance bubbles')
+    expect(replies).to include('I could not find anything to enhance')
+  end
+
+  describe 'under HipChat' do
+    before do
+      robot.config.robot.adapter = :hipchat
+    end
+
+    it 'should mark success using an emoji' do
+      expect(subject).to receive(:lock_and_refresh_index)
+
+      send_command('refresh enhance')
+
+      # Give the timer a chance to run
+      sleep(0.5)
+
+      expect(replies).to include('Will refresh enhance index...')
+      expect(replies).to include('(successful) Refreshed enhance index')
+    end
+
+    it 'mark failure using an emoji' do
+      send_command('enhance')
+      expect(replies).to include('(failed) I need a string to enhance')
+    end
+
+    it 'should use /quote to render mono text' do
+      send_command('enhance 54.214.188.37')
+      expect(replies).to include('/quote *box01*')
+    end
+
+    it 'should use emoji to call out when nothing was found to enhance' do
+      send_command('enhance bubbles')
+      expect(replies).to include('(nothingtodohere) I could not find anything to enhance')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,64 @@
+require "lita-enhance"
+require "lita/rspec"
+
+require 'pry'
+
+RSpec.shared_context 'mocks' do
+  include_context 'redis'
+
+  def spec_data(file_name)
+    File.read(File.expand_path("../data/#{file_name}", __FILE__))
+  end
+
+  let(:west2_chef_node) do
+    chef_nodes.detect {|n| n.name == 'box01' }
+  end
+
+  let(:west1_chef_node) do
+    chef_nodes.detect {|n| n.name == 'box02' }
+  end
+
+  let(:linode_chef_node) do
+    chef_nodes.detect {|n| n.name == 'box03' }
+  end
+
+  let(:chef_nodes) do
+    Dir['spec/data/*.json'].map do |node_json|
+      Chef::Node.json_create(JSON.parse(IO.read(node_json)))
+    end
+  end
+
+  let(:nodes) do
+    chef_indexer = Lita::Handlers::Enhance::ChefIndexer.new(redis, {})
+    chef_nodes.map do |chef_node| 
+      node = chef_indexer.node_from_chef_node(chef_node)
+      node.store!(redis)
+      node
+    end
+  end
+
+  let(:nodes_and_chef_nodes) do
+    nodes.zip(chef_nodes)
+  end
+end
+
+RSpec.shared_context 'redis' do
+  let(:redis) { Redis.new }
+
+  before do
+    redis.flushdb
+  end
+end
+
+RSpec.shared_context 'indexed' do
+  include_context 'mocks'
+  include_context 'redis'
+
+  let(:chef_indexer) { Lita::Handlers::Enhance::ChefIndexer.new(redis, {}) }
+
+  before do
+    chef_nodes.each do |chef_node|
+      chef_indexer.index_chef_node(chef_node)
+    end
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: lita-enhance
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Doug Barth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+description: A Lita handler that enhances text by replacing opaque identifiers with
+  Chef node names
+email:
+- doug@pagerduty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-enhance.rb
+- lib/lita/handlers/enhance.rb
+- lib/lita/handlers/enhance/chef_indexer.rb
+- lib/lita/handlers/enhance/enhancer.rb
+- lib/lita/handlers/enhance/enhancers/hostname_enhancer.rb
+- lib/lita/handlers/enhance/enhancers/instance_id_enhancer.rb
+- lib/lita/handlers/enhance/enhancers/ip_enhancer.rb
+- lib/lita/handlers/enhance/enhancers/mac_address_enhancer.rb
+- lib/lita/handlers/enhance/node.rb
+- lib/lita/handlers/enhance/node_index.rb
+- lib/lita/handlers/enhance/session.rb
+- lita-enhance.gemspec
+- locales/en.yml
+- spec/data/box01.json
+- spec/data/box02.json
+- spec/data/box03.json
+- spec/data/stg-web01.json
+- spec/data/web01.json
+- spec/lita/handlers/enhance/chef_indexer_spec.rb
+- spec/lita/handlers/enhance/enhancer_example.rb
+- spec/lita/handlers/enhance/enhancers/hostname_enhancer_spec.rb
+- spec/lita/handlers/enhance/enhancers/instance_id_enhancer_spec.rb
+- spec/lita/handlers/enhance/enhancers/ip_enhancer_spec.rb
+- spec/lita/handlers/enhance/enhancers/mac_address_enhancer_spec.rb
+- spec/lita/handlers/enhance/node_index_spec.rb
+- spec/lita/handlers/enhance/node_spec.rb
+- spec/lita/handlers/enhance/session_spec.rb
+- spec/lita/handlers/enhance_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/PagerDuty/lita-enhance
+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 enhances text by replacing opaque identifiers with Chef
+  node names
+test_files:
+- spec/data/box01.json
+- spec/data/box02.json
+- spec/data/box03.json
+- spec/data/stg-web01.json
+- spec/data/web01.json
+- spec/lita/handlers/enhance/chef_indexer_spec.rb
+- spec/lita/handlers/enhance/enhancer_example.rb
+- spec/lita/handlers/enhance/enhancers/hostname_enhancer_spec.rb
+- spec/lita/handlers/enhance/enhancers/instance_id_enhancer_spec.rb
+- spec/lita/handlers/enhance/enhancers/ip_enhancer_spec.rb
+- spec/lita/handlers/enhance/enhancers/mac_address_enhancer_spec.rb
+- spec/lita/handlers/enhance/node_index_spec.rb
+- spec/lita/handlers/enhance/node_spec.rb
+- spec/lita/handlers/enhance/session_spec.rb
+- spec/lita/handlers/enhance_spec.rb
+- spec/spec_helper.rb