lita-debug 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 668ec547050eb15c6262208162cbb4f1f3d29fc2
+  data.tar.gz: 535a19eec973f192f728a86edebe3fa83b89ddfb
+SHA512:
+  metadata.gz: 5a3944bee32522e60e724b9eaec7b8e26d0bcc518d3023a80a3ff6bf62d7eea20718cbad5ad5009f248899023e2101c82b579b0b02d1aac6fca8df12bb7cf82d
+  data.tar.gz: 15077a29904d786c0c172069d41f529046fff8adc75c116d8ac6f541ce5b171e4c31baeaccbbd6a3d0d20ad0a1a1216eea28a3fb3411d99c2a0b2f54307ebd00

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/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,52 @@
+# lita-debug
+
+[![Build Status](https://travis-ci.org/spajus/lita-debug.png?branch=master)](https://travis-ci.org/spajus/lita-debug?branc=master)
+[![Coverage Status](https://coveralls.io/repos/github/spajus/lita-debug/badge.svg?branch=master)](https://coveralls.io/github/spajus/lita-debug?branch=master)
+
+A plugin for debugging [Lita](https://www.lita.io) interactively, in
+production.
+
+## Installation
+
+Add lita-debug to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-debug"
+```
+
+## Configuration
+
+```ruby
+# lita_config.rb
+
+Lita.configure do |config|
+  config.handlers.debug.enable_eval = true
+  config.handlers.debug.restrict_eval_to = [:admins]
+  config.handlers.debug.restrict_debug_to = [:admins, :developers]
+end
+```
+
+## Usage
+
+```
+Lita > lita debug
+---
+:server:
+  :hostname: minion.local
+:room: !ruby/object:Lita::Room
+  id: shell
+  metadata: {}
+  name: shell
+:user: !ruby/object:Lita::User
+  id: '1'
+  metadata:
+    name: Shell User
+  name: Shell User
+
+Lita > lita eval response.room.name
+"shell"
+Lita > lita eval robot.name
+"Lita"
+Lita > lita eval 1+2
+3
+```

data/Rakefile

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

data/lib/lita-debug.rb

@@ -0,0 +1,2 @@
+require 'lita'
+require 'lita/handlers/debug'

data/lib/lita/handlers/debug.rb

@@ -0,0 +1,49 @@
+module Lita
+  module Handlers
+    class Debug < Handler
+      config :enable_eval
+      config :restrict_eval_to
+      config :restrict_debug_to
+
+      on(:connected) do
+        if config.enable_eval
+          self.class.route(
+            /^eval (.+)$/,
+            :do_eval,
+            command: true,
+            restrict_to: config.restrict_eval_to || :admins,
+            help: { 'eval <something>' => 'evals ruby object from within the handler (DANGER, raw unsafe eval!!!)' }
+          )
+        end
+
+        self.class.route(
+          /^debug$/,
+          :debug,
+          command: true,
+          restrict_to: config.restrict_debug_to || :admins,
+          help: { 'debug' => 'Prints a bunch of lita debug information in current context' }
+        )
+      end
+
+      def do_eval(response)
+        query = response.matches[0][0]
+        result = begin
+                   eval(query).inspect
+                 rescue => e
+                   "Could not eval your command: #{e}"
+                 end
+        response.reply(result)
+      end
+
+      def debug(response)
+        output = {}
+        output[:server] = { hostname: `hostname`.strip }
+        output[:room] = response.room
+        output[:user] = response.user
+        response.reply(output.to_yaml)
+      end
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lita-debug.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'lita-debug'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Tomas Varaneckas']
+  spec.email         = ['tomas.varaneckas@gmail.com']
+  spec.description   = 'Lita plugin debugger'
+  spec.summary       = 'Lita plugin debugger'
+  spec.homepage      = 'https://github.com/spajus/lita-debug'
+  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.add_runtime_dependency 'lita', '>= 4.7'
+
+  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'
+end

data/spec/lita/handlers/debug_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe Lita::Handlers::Debug, lita_handler: true do
+  let(:robot) { Lita::Robot.new(registry) }
+  subject { described_class.new(robot) }
+  let(:room) { Lita::Room.new('foo_room') }
+  let(:admin) { Lita::User.create(1, name: 'Admin User') }
+  let(:eval_enabled) { false }
+
+  before do
+    registry.config.robot.admins = ['1']
+    robot.auth.add_user_to_group!(admin, :debuggers)
+    robot.auth.add_user_to_group!(admin, :evaluators)
+    registry.config.handlers.debug.enable_eval = eval_enabled
+    robot.trigger(:connected)
+  end
+
+  context 'unconfigured' do
+    it 'routes debug for admins' do
+      expect(subject).to route('lita debug')
+        .with_authorization_for(:admins).to(:debug)
+    end
+
+    context 'with eval enabled' do
+      let(:eval_enabled) { true }
+      it 'routes eval for admins' do
+        expect(subject).to route('lita eval 1+2')
+          .with_authorization_for(:admins).to(:do_eval)
+      end
+    end
+  end
+
+  context 'configured' do
+    let(:eval_enabled) { true }
+
+    before do
+      registry.config.handlers.debug.restrict_debug_to = :debuggers
+      registry.config.handlers.debug.restrict_eval_to = :evaluators
+    end
+
+    it 'routes debug for debuggers' do
+      expect(subject).to route('lita debug')
+        .with_authorization_for(:debuggers).to(:debug)
+    end
+
+    it 'routes eval for evaluators' do
+      expect(subject).to route('lita eval 1+2')
+        .with_authorization_for(:evaluators).to(:do_eval)
+    end
+  end
+
+  it 'debugs objects' do
+    send_message('lita debug', from: room, as: admin)
+    expect(replies.last).to include(room.name)
+  end
+
+  context 'with eval enabled' do
+    before { registry.config.handlers.debug.enable_eval = true }
+    it 'evals arbitrary ruby' do
+      send_message('lita eval 1+2', from: room, as: admin)
+      expect(replies.last).to eq('3')
+    end
+
+    it 'evals handler context' do
+      send_message('lita eval response.room.name', from: room, as: admin)
+      expect(replies.last).to eq('"foo_room"')
+    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-debug"
+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,169 @@
+--- !ruby/object:Gem::Specification
+name: lita-debug
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Varaneckas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !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: 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: Lita plugin debugger
+email:
+- tomas.varaneckas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/lita-debug.rb
+- lib/lita/handlers/debug.rb
+- lita-debug.gemspec
+- spec/lita/handlers/debug_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/spajus/lita-debug
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Lita plugin debugger
+test_files:
+- spec/lita/handlers/debug_spec.rb
+- spec/spec_helper.rb