lita-doc 0.1.1
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/Gemfile +3 -0
- data/README.md +19 -0
- data/Rakefile +6 -0
- data/lib/lita/handlers/doc.rb +124 -0
- data/lib/lita-doc.rb +12 -0
- data/lita-doc.gemspec +24 -0
- data/locales/en.yml +4 -0
- data/spec/lita/handlers/doc_spec.rb +4 -0
- data/spec/spec_helper.rb +6 -0
- data/templates/.gitkeep +0 -0
- metadata +143 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 0d88a6dd79efc9873765ced0d9617beb14ce9929
|
4
|
+
data.tar.gz: 8b37f206c81bf4eea02b531c9685c8a953575042
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 63e7c71bb29aabf2b68959a485cfb60c1b2c46f6d86acffe0be01afc3abd7faa8c2695231f6369972beda21c4f881a1e4ae34796f2c35dff965f9909fdd4b1a0
|
7
|
+
data.tar.gz: d8b49a5124246c9df23f2fbea2d7692189bbf8377d74e67c8e0404e130d307695c4c0572eff889c1b053b3bce234137181a78a1501623a98cca4a8586e24e5b1
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
# lita-doc
|
2
|
+
|
3
|
+
TODO: Add a description of the plugin.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add lita-doc to your Lita instance's Gemfile:
|
8
|
+
|
9
|
+
``` ruby
|
10
|
+
gem "lita-doc"
|
11
|
+
```
|
12
|
+
|
13
|
+
## Configuration
|
14
|
+
|
15
|
+
TODO: Describe any configuration attributes the plugin exposes.
|
16
|
+
|
17
|
+
## Usage
|
18
|
+
|
19
|
+
TODO: Describe the plugin's features and how to use them.
|
data/Rakefile
ADDED
@@ -0,0 +1,124 @@
|
|
1
|
+
module Lita
|
2
|
+
module Handlers
|
3
|
+
class Doc < Handler
|
4
|
+
COMMANDS = {
|
5
|
+
how: {
|
6
|
+
regex: /^how do i +([^\?]+)\??$/,
|
7
|
+
command: "how do i [do thing]",
|
8
|
+
description: "Shows where to find doc."
|
9
|
+
},
|
10
|
+
show: {
|
11
|
+
regex: /^doc +(.+)$/,
|
12
|
+
command: "doc [name]",
|
13
|
+
description: "Shows where to find doc."
|
14
|
+
},
|
15
|
+
remove: {
|
16
|
+
regex: /^doc:remove +(.+)$/,
|
17
|
+
command: "docs:remove [name]",
|
18
|
+
description: "Remove doc."
|
19
|
+
},
|
20
|
+
list: {
|
21
|
+
regex: /^docs(:all)?$/,
|
22
|
+
command: "docs:all",
|
23
|
+
description: "Lists all known docs."
|
24
|
+
},
|
25
|
+
help: {
|
26
|
+
regex: /^docs[: ]help/,
|
27
|
+
command: "docs help OR docs:help",
|
28
|
+
description: "Shows all doc commands."
|
29
|
+
},
|
30
|
+
add: {
|
31
|
+
regex: /^doc:new (.+) (http:\/\/.+)$/,
|
32
|
+
command: "doc:new [name] [url]",
|
33
|
+
description: "Adds doc."
|
34
|
+
},
|
35
|
+
wtf: {
|
36
|
+
regex: /^docs ((?!help).)*$/
|
37
|
+
}
|
38
|
+
}
|
39
|
+
|
40
|
+
def self.regex_for(name)
|
41
|
+
COMMANDS[name][:regex]
|
42
|
+
end
|
43
|
+
|
44
|
+
def self.help_for(name)
|
45
|
+
{ COMMANDS[name][:command] => COMMANDS[name][:description] }
|
46
|
+
end
|
47
|
+
|
48
|
+
route(regex_for(:help), :help, command: false, help: help_for(:help))
|
49
|
+
route(regex_for(:list), :list_docs, command: false, help: help_for(:list))
|
50
|
+
route(regex_for(:remove), :remove_doc, command: false, help: help_for(:remove))
|
51
|
+
route(regex_for(:show), :show_doc, command: false, help: help_for(:show))
|
52
|
+
route(regex_for(:how), :show_doc, command: false, help: help_for(:how))
|
53
|
+
route(regex_for(:add), :add_doc, command: false, help: help_for(:add))
|
54
|
+
route(regex_for(:wtf), :wtf?, command: false)
|
55
|
+
|
56
|
+
def help(response)
|
57
|
+
msg = "```\n"
|
58
|
+
COMMANDS.each do |key, value|
|
59
|
+
msg += "#{value[:command]} - #{value[:description]}\n" if value[:command]
|
60
|
+
end
|
61
|
+
msg += "```"
|
62
|
+
response.reply msg
|
63
|
+
end
|
64
|
+
|
65
|
+
def show_doc(response)
|
66
|
+
name = response.match_data[1].strip
|
67
|
+
res = redis.get name
|
68
|
+
|
69
|
+
if res
|
70
|
+
response.reply "Go to #{res} to find out."
|
71
|
+
else
|
72
|
+
response.reply "I don't know where to find that information. Figure it out for me, then add it to my memory please: .doc:add #{name} [destination_url]"
|
73
|
+
end
|
74
|
+
end
|
75
|
+
|
76
|
+
def list_docs(response)
|
77
|
+
docs = doc_names
|
78
|
+
msg = ""
|
79
|
+
if docs.empty?
|
80
|
+
response.reply "No docs found."
|
81
|
+
else
|
82
|
+
docs.each do |doc|
|
83
|
+
msg += "`#{doc}` - #{redis.get doc}\n"
|
84
|
+
end
|
85
|
+
response.reply msg
|
86
|
+
end
|
87
|
+
|
88
|
+
end
|
89
|
+
|
90
|
+
def add_doc(response)
|
91
|
+
name = response.match_data[1].strip
|
92
|
+
location = response.match_data[2].strip
|
93
|
+
if name && location
|
94
|
+
redis.rpush :docs, name
|
95
|
+
redis.set name, location
|
96
|
+
response.reply "Sweet, added #{name} to docs list."
|
97
|
+
else
|
98
|
+
response.reply "Looks like you did something wrong, please input in the form `.doc:add [doc explanation] [doc_url]`. Note: doc_url must begin with `http://`"
|
99
|
+
end
|
100
|
+
end
|
101
|
+
|
102
|
+
def remove_doc(response)
|
103
|
+
name = response.match_data[1].strip
|
104
|
+
if doc_names.include?(name)
|
105
|
+
redis.lrem :docs, 0, name
|
106
|
+
redis.del name
|
107
|
+
response.reply "Boom! Removed #{name} from docs list."
|
108
|
+
else
|
109
|
+
response.reply "I don't have any information for #{name}, so... mission accomplished?"
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
113
|
+
def wtf?(response)
|
114
|
+
response.reply "I don't know what you mean. Have you been drinking? Try `.docs:help`"
|
115
|
+
end
|
116
|
+
|
117
|
+
def doc_names
|
118
|
+
redis.lrange :docs, 0, -1
|
119
|
+
end
|
120
|
+
|
121
|
+
Lita.register_handler(self)
|
122
|
+
end
|
123
|
+
end
|
124
|
+
end
|
data/lib/lita-doc.rb
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
require "lita"
|
2
|
+
|
3
|
+
Lita.load_locales Dir[File.expand_path(
|
4
|
+
File.join("..", "..", "locales", "*.yml"), __FILE__
|
5
|
+
)]
|
6
|
+
|
7
|
+
require "lita/handlers/doc"
|
8
|
+
|
9
|
+
Lita::Handlers::Doc.template_root File.expand_path(
|
10
|
+
File.join("..", "..", "templates"),
|
11
|
+
__FILE__
|
12
|
+
)
|
data/lita-doc.gemspec
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
Gem::Specification.new do |spec|
|
2
|
+
spec.name = "lita-doc"
|
3
|
+
spec.version = "0.1.1"
|
4
|
+
spec.authors = ["Brad Herman"]
|
5
|
+
spec.email = ["brad@hired.com"]
|
6
|
+
spec.description = "Stores documentation locations."
|
7
|
+
spec.summary = "Stores documentation locations."
|
8
|
+
spec.homepage = "http://github.com/hired/lita-doc"
|
9
|
+
spec.license = "none"
|
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
|
+
end
|
data/locales/en.yml
ADDED
data/spec/spec_helper.rb
ADDED
data/templates/.gitkeep
ADDED
File without changes
|
metadata
ADDED
@@ -0,0 +1,143 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: lita-doc
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Brad Herman
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-05-16 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
|
+
description: Stores documentation locations.
|
98
|
+
email:
|
99
|
+
- brad@hired.com
|
100
|
+
executables: []
|
101
|
+
extensions: []
|
102
|
+
extra_rdoc_files: []
|
103
|
+
files:
|
104
|
+
- ".gitignore"
|
105
|
+
- Gemfile
|
106
|
+
- README.md
|
107
|
+
- Rakefile
|
108
|
+
- lib/lita-doc.rb
|
109
|
+
- lib/lita/handlers/doc.rb
|
110
|
+
- lita-doc.gemspec
|
111
|
+
- locales/en.yml
|
112
|
+
- spec/lita/handlers/doc_spec.rb
|
113
|
+
- spec/spec_helper.rb
|
114
|
+
- templates/.gitkeep
|
115
|
+
homepage: http://github.com/hired/lita-doc
|
116
|
+
licenses:
|
117
|
+
- none
|
118
|
+
metadata:
|
119
|
+
lita_plugin_type: handler
|
120
|
+
post_install_message:
|
121
|
+
rdoc_options: []
|
122
|
+
require_paths:
|
123
|
+
- lib
|
124
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
125
|
+
requirements:
|
126
|
+
- - ">="
|
127
|
+
- !ruby/object:Gem::Version
|
128
|
+
version: '0'
|
129
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
130
|
+
requirements:
|
131
|
+
- - ">="
|
132
|
+
- !ruby/object:Gem::Version
|
133
|
+
version: '0'
|
134
|
+
requirements: []
|
135
|
+
rubyforge_project:
|
136
|
+
rubygems_version: 2.5.1
|
137
|
+
signing_key:
|
138
|
+
specification_version: 4
|
139
|
+
summary: Stores documentation locations.
|
140
|
+
test_files:
|
141
|
+
- spec/lita/handlers/doc_spec.rb
|
142
|
+
- spec/spec_helper.rb
|
143
|
+
has_rdoc:
|