lita-debug 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +17 -0
- data/.travis.yml +9 -0
- data/Gemfile +3 -0
- data/README.md +52 -0
- data/Rakefile +6 -0
- data/lib/lita-debug.rb +2 -0
- data/lib/lita/handlers/debug.rb +49 -0
- data/lita-debug.gemspec +26 -0
- data/spec/lita/handlers/debug_spec.rb +69 -0
- data/spec/spec_helper.rb +14 -0
- metadata +169 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 668ec547050eb15c6262208162cbb4f1f3d29fc2
|
4
|
+
data.tar.gz: 535a19eec973f192f728a86edebe3fa83b89ddfb
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 5a3944bee32522e60e724b9eaec7b8e26d0bcc518d3023a80a3ff6bf62d7eea20718cbad5ad5009f248899023e2101c82b579b0b02d1aac6fca8df12bb7cf82d
|
7
|
+
data.tar.gz: 15077a29904d786c0c172069d41f529046fff8adc75c116d8ac6f541ce5b171e4c31baeaccbbd6a3d0d20ad0a1a1216eea28a3fb3411d99c2a0b2f54307ebd00
|
data/.gitignore
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,52 @@
|
|
1
|
+
# lita-debug
|
2
|
+
|
3
|
+
[![Build Status](https://travis-ci.org/spajus/lita-debug.png?branch=master)](https://travis-ci.org/spajus/lita-debug?branc=master)
|
4
|
+
[![Coverage Status](https://coveralls.io/repos/github/spajus/lita-debug/badge.svg?branch=master)](https://coveralls.io/github/spajus/lita-debug?branch=master)
|
5
|
+
|
6
|
+
A plugin for debugging [Lita](https://www.lita.io) interactively, in
|
7
|
+
production.
|
8
|
+
|
9
|
+
## Installation
|
10
|
+
|
11
|
+
Add lita-debug to your Lita instance's Gemfile:
|
12
|
+
|
13
|
+
``` ruby
|
14
|
+
gem "lita-debug"
|
15
|
+
```
|
16
|
+
|
17
|
+
## Configuration
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
# lita_config.rb
|
21
|
+
|
22
|
+
Lita.configure do |config|
|
23
|
+
config.handlers.debug.enable_eval = true
|
24
|
+
config.handlers.debug.restrict_eval_to = [:admins]
|
25
|
+
config.handlers.debug.restrict_debug_to = [:admins, :developers]
|
26
|
+
end
|
27
|
+
```
|
28
|
+
|
29
|
+
## Usage
|
30
|
+
|
31
|
+
```
|
32
|
+
Lita > lita debug
|
33
|
+
---
|
34
|
+
:server:
|
35
|
+
:hostname: minion.local
|
36
|
+
:room: !ruby/object:Lita::Room
|
37
|
+
id: shell
|
38
|
+
metadata: {}
|
39
|
+
name: shell
|
40
|
+
:user: !ruby/object:Lita::User
|
41
|
+
id: '1'
|
42
|
+
metadata:
|
43
|
+
name: Shell User
|
44
|
+
name: Shell User
|
45
|
+
|
46
|
+
Lita > lita eval response.room.name
|
47
|
+
"shell"
|
48
|
+
Lita > lita eval robot.name
|
49
|
+
"Lita"
|
50
|
+
Lita > lita eval 1+2
|
51
|
+
3
|
52
|
+
```
|
data/Rakefile
ADDED
data/lib/lita-debug.rb
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
module Lita
|
2
|
+
module Handlers
|
3
|
+
class Debug < Handler
|
4
|
+
config :enable_eval
|
5
|
+
config :restrict_eval_to
|
6
|
+
config :restrict_debug_to
|
7
|
+
|
8
|
+
on(:connected) do
|
9
|
+
if config.enable_eval
|
10
|
+
self.class.route(
|
11
|
+
/^eval (.+)$/,
|
12
|
+
:do_eval,
|
13
|
+
command: true,
|
14
|
+
restrict_to: config.restrict_eval_to || :admins,
|
15
|
+
help: { 'eval <something>' => 'evals ruby object from within the handler (DANGER, raw unsafe eval!!!)' }
|
16
|
+
)
|
17
|
+
end
|
18
|
+
|
19
|
+
self.class.route(
|
20
|
+
/^debug$/,
|
21
|
+
:debug,
|
22
|
+
command: true,
|
23
|
+
restrict_to: config.restrict_debug_to || :admins,
|
24
|
+
help: { 'debug' => 'Prints a bunch of lita debug information in current context' }
|
25
|
+
)
|
26
|
+
end
|
27
|
+
|
28
|
+
def do_eval(response)
|
29
|
+
query = response.matches[0][0]
|
30
|
+
result = begin
|
31
|
+
eval(query).inspect
|
32
|
+
rescue => e
|
33
|
+
"Could not eval your command: #{e}"
|
34
|
+
end
|
35
|
+
response.reply(result)
|
36
|
+
end
|
37
|
+
|
38
|
+
def debug(response)
|
39
|
+
output = {}
|
40
|
+
output[:server] = { hostname: `hostname`.strip }
|
41
|
+
output[:room] = response.room
|
42
|
+
output[:user] = response.user
|
43
|
+
response.reply(output.to_yaml)
|
44
|
+
end
|
45
|
+
|
46
|
+
Lita.register_handler(self)
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
data/lita-debug.gemspec
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
Gem::Specification.new do |spec|
|
2
|
+
spec.name = 'lita-debug'
|
3
|
+
spec.version = '0.1.0'
|
4
|
+
spec.authors = ['Tomas Varaneckas']
|
5
|
+
spec.email = ['tomas.varaneckas@gmail.com']
|
6
|
+
spec.description = 'Lita plugin debugger'
|
7
|
+
spec.summary = 'Lita plugin debugger'
|
8
|
+
spec.homepage = 'https://github.com/spajus/lita-debug'
|
9
|
+
spec.license = 'MIT'
|
10
|
+
spec.metadata = { 'lita_plugin_type' => 'handler' }
|
11
|
+
|
12
|
+
spec.files = `git ls-files`.split($/)
|
13
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
14
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
15
|
+
spec.require_paths = ['lib']
|
16
|
+
|
17
|
+
spec.add_runtime_dependency 'lita', '>= 4.7'
|
18
|
+
|
19
|
+
spec.add_development_dependency 'bundler', '~> 1.3'
|
20
|
+
spec.add_development_dependency 'pry-byebug'
|
21
|
+
spec.add_development_dependency 'rake'
|
22
|
+
spec.add_development_dependency 'rack-test'
|
23
|
+
spec.add_development_dependency 'rspec', '>= 3.0.0'
|
24
|
+
spec.add_development_dependency 'simplecov'
|
25
|
+
spec.add_development_dependency 'coveralls'
|
26
|
+
end
|
@@ -0,0 +1,69 @@
|
|
1
|
+
require "spec_helper"
|
2
|
+
|
3
|
+
describe Lita::Handlers::Debug, lita_handler: true do
|
4
|
+
let(:robot) { Lita::Robot.new(registry) }
|
5
|
+
subject { described_class.new(robot) }
|
6
|
+
let(:room) { Lita::Room.new('foo_room') }
|
7
|
+
let(:admin) { Lita::User.create(1, name: 'Admin User') }
|
8
|
+
let(:eval_enabled) { false }
|
9
|
+
|
10
|
+
before do
|
11
|
+
registry.config.robot.admins = ['1']
|
12
|
+
robot.auth.add_user_to_group!(admin, :debuggers)
|
13
|
+
robot.auth.add_user_to_group!(admin, :evaluators)
|
14
|
+
registry.config.handlers.debug.enable_eval = eval_enabled
|
15
|
+
robot.trigger(:connected)
|
16
|
+
end
|
17
|
+
|
18
|
+
context 'unconfigured' do
|
19
|
+
it 'routes debug for admins' do
|
20
|
+
expect(subject).to route('lita debug')
|
21
|
+
.with_authorization_for(:admins).to(:debug)
|
22
|
+
end
|
23
|
+
|
24
|
+
context 'with eval enabled' do
|
25
|
+
let(:eval_enabled) { true }
|
26
|
+
it 'routes eval for admins' do
|
27
|
+
expect(subject).to route('lita eval 1+2')
|
28
|
+
.with_authorization_for(:admins).to(:do_eval)
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
context 'configured' do
|
34
|
+
let(:eval_enabled) { true }
|
35
|
+
|
36
|
+
before do
|
37
|
+
registry.config.handlers.debug.restrict_debug_to = :debuggers
|
38
|
+
registry.config.handlers.debug.restrict_eval_to = :evaluators
|
39
|
+
end
|
40
|
+
|
41
|
+
it 'routes debug for debuggers' do
|
42
|
+
expect(subject).to route('lita debug')
|
43
|
+
.with_authorization_for(:debuggers).to(:debug)
|
44
|
+
end
|
45
|
+
|
46
|
+
it 'routes eval for evaluators' do
|
47
|
+
expect(subject).to route('lita eval 1+2')
|
48
|
+
.with_authorization_for(:evaluators).to(:do_eval)
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
it 'debugs objects' do
|
53
|
+
send_message('lita debug', from: room, as: admin)
|
54
|
+
expect(replies.last).to include(room.name)
|
55
|
+
end
|
56
|
+
|
57
|
+
context 'with eval enabled' do
|
58
|
+
before { registry.config.handlers.debug.enable_eval = true }
|
59
|
+
it 'evals arbitrary ruby' do
|
60
|
+
send_message('lita eval 1+2', from: room, as: admin)
|
61
|
+
expect(replies.last).to eq('3')
|
62
|
+
end
|
63
|
+
|
64
|
+
it 'evals handler context' do
|
65
|
+
send_message('lita eval response.room.name', from: room, as: admin)
|
66
|
+
expect(replies.last).to eq('"foo_room"')
|
67
|
+
end
|
68
|
+
end
|
69
|
+
end
|
data/spec/spec_helper.rb
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
require "simplecov"
|
2
|
+
require "coveralls"
|
3
|
+
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
|
4
|
+
SimpleCov::Formatter::HTMLFormatter,
|
5
|
+
Coveralls::SimpleCov::Formatter
|
6
|
+
]
|
7
|
+
SimpleCov.start { add_filter "/spec/" }
|
8
|
+
|
9
|
+
require "lita-debug"
|
10
|
+
require "lita/rspec"
|
11
|
+
|
12
|
+
# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
|
13
|
+
# was generated with Lita 4, the compatibility mode should be left disabled.
|
14
|
+
Lita.version_3_compatibility_mode = false
|
metadata
ADDED
@@ -0,0 +1,169 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: lita-debug
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Tomas Varaneckas
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-11-03 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: lita
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '4.7'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '4.7'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.3'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.3'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: pry-byebug
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rake
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rack-test
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rspec
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: 3.0.0
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: 3.0.0
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: simplecov
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: coveralls
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - ">="
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
description: Lita plugin debugger
|
126
|
+
email:
|
127
|
+
- tomas.varaneckas@gmail.com
|
128
|
+
executables: []
|
129
|
+
extensions: []
|
130
|
+
extra_rdoc_files: []
|
131
|
+
files:
|
132
|
+
- ".gitignore"
|
133
|
+
- ".travis.yml"
|
134
|
+
- Gemfile
|
135
|
+
- README.md
|
136
|
+
- Rakefile
|
137
|
+
- lib/lita-debug.rb
|
138
|
+
- lib/lita/handlers/debug.rb
|
139
|
+
- lita-debug.gemspec
|
140
|
+
- spec/lita/handlers/debug_spec.rb
|
141
|
+
- spec/spec_helper.rb
|
142
|
+
homepage: https://github.com/spajus/lita-debug
|
143
|
+
licenses:
|
144
|
+
- MIT
|
145
|
+
metadata:
|
146
|
+
lita_plugin_type: handler
|
147
|
+
post_install_message:
|
148
|
+
rdoc_options: []
|
149
|
+
require_paths:
|
150
|
+
- lib
|
151
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
152
|
+
requirements:
|
153
|
+
- - ">="
|
154
|
+
- !ruby/object:Gem::Version
|
155
|
+
version: '0'
|
156
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
157
|
+
requirements:
|
158
|
+
- - ">="
|
159
|
+
- !ruby/object:Gem::Version
|
160
|
+
version: '0'
|
161
|
+
requirements: []
|
162
|
+
rubyforge_project:
|
163
|
+
rubygems_version: 2.6.13
|
164
|
+
signing_key:
|
165
|
+
specification_version: 4
|
166
|
+
summary: Lita plugin debugger
|
167
|
+
test_files:
|
168
|
+
- spec/lita/handlers/debug_spec.rb
|
169
|
+
- spec/spec_helper.rb
|