lita-onewheel-doc 2.0.1 → 2.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +15 -3
  3. data/lib/lita/handlers/onewheel_doc.rb +2 -2
  4. data/lita-onewheel-doc.gemspec +1 -1
  5. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: a29f86f184df7b62ce3eac8a49ac382e0f82b556
4
- data.tar.gz: f2959735443a998afca4e95ec1b3d6a291ffc2b9
3
+ metadata.gz: a783f12e825048240cb607a24fc5ff98a376d7c8
4
+ data.tar.gz: e43d1a7d495e338d36918366ab0fcbc0da14d807
5
5
  SHA512:
6
- metadata.gz: 3db715192a58260ffaf75b8c4e7bfac51e712fb25a80dfbaf7a148b083c7c1ccbd310111419557ca552829c45d485a1a909ffe502360ac666e51f51120668fc4
7
- data.tar.gz: 366726188178562b20d6548fe6c4ac7e8233bfe7db8934715b5f32a7cee4a8d65184038b78c036c6f2ecb1027a9c5adf279d7ff90fbdc6e7bfd597e4924811cd
6
+ metadata.gz: 15c6243d6b7384ba31f97fcf14212b3b0472fa6cdffe79edd73bb3bc7ca2ef0f8b08d5bf0455800c542c2b61d93716644dbcc8d2f984562e474d5533ada9b29f
7
+ data.tar.gz: 54459243e71de2872fcbb7efbbb6e3a36f0b081a5c20a6503855554c24d4a968a599356b267fe90b9974184fa54892648f22329032897299a7e29dd205ea28fb
data/README.md CHANGED
@@ -3,7 +3,11 @@
3
3
  [![Build Status](https://travis-ci.org/onewheelskyward/lita-onewheel-doc.png?branch=master)](https://travis-ci.org/onewheelskyward/lita-onewheel-doc)
4
4
  [![Coverage Status](https://coveralls.io/repos/onewheelskyward/lita-onewheel-doc/badge.png)](https://coveralls.io/r/onewheelskyward/lita-onewheel-doc)
5
5
 
6
- TODO: Add a description of the plugin.
6
+ This plugin was designed as sort of a shared bookmark store for work. We use Confluence, which has a pretty
7
+ ridiculous URI structure, and I wanted to find a way to store the location of things like the deploy instructions,
8
+ how to nombom, and ways to make fun of my coworkers.
9
+
10
+ Thus, the plugin was born. It'll store, quite literally, anything you like.
7
11
 
8
12
  ## Installation
9
13
 
@@ -15,8 +19,16 @@ gem "lita-onewheel-doc"
15
19
 
16
20
  ## Configuration
17
21
 
18
- TODO: Describe any configuration attributes the plugin exposes.
22
+ Just needs redis which you have because you're already running Lita.
19
23
 
20
24
  ## Usage
25
+ Command | Description
26
+ ------------------------- | -------------
27
+ `!doc key https://value` | Stores https://value under the key key. Note, web links are not enforced. You can store emoji if you like.
28
+ `!doc key` | Find all documents starting with, or equal to key.
29
+ `!doc` | list all keys.
30
+ `!docdel key` | Remove key from the store.
31
+
32
+ ## To be implemented
21
33
 
22
- TODO: Describe the plugin's features and how to use them.
34
+ Make !doc key substring search instead of starts-with.
data/lib/lita/handlers/onewheel_doc.rb CHANGED
@@ -10,7 +10,7 @@ module Lita
10
10
  route /^doc\s+([\w\/+_-]+)\s+(.*)$/,
11
11
  :command_add_key,
12
12
  command: true,
13
- help: {'!doc key http://' => 'Add a key using key_val and the http link'}
13
+ help: {'!doc key value' => 'Add a document key which references value'}
14
14
  route /^doc$/,
15
15
  :command_list_keys,
16
16
  command: true,
@@ -18,7 +18,7 @@ module Lita
18
18
  route /^doc\s+(\w+)$/,
19
19
  :command_fetch_key,
20
20
  command: true,
21
- help: {'!doc key ' => 'fetch the value for key_val'}
21
+ help: {'!doc key ' => 'fetch the value for key'}
22
22
 
23
23
  def command_add_key(response)
24
24
  key = response.matches[0][0]
data/lita-onewheel-doc.gemspec CHANGED
@@ -1,6 +1,6 @@
1
1
  Gem::Specification.new do |spec|
2
2
  spec.name = 'lita-onewheel-doc'
3
- spec.version = '2.0.1'
3
+ spec.version = '2.0.2'
4
4
  spec.authors = ['Andrew Kreps']
5
5
  spec.email = ['andrew.kreps@gmail.com']
6
6
  spec.description = 'Basic key/value store designed for http links.'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: lita-onewheel-doc
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.1
4
+ version: 2.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Andrew Kreps
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2015-10-21 00:00:00.000000000 Z
11
+ date: 2016-07-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: lita
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
146
146
  version: '0'
147
147
  requirements: []
148
148
  rubyforge_project:
149
- rubygems_version: 2.4.5
149
+ rubygems_version: 2.5.1
150
150
  signing_key:
151
151
  specification_version: 4
152
152
  summary: Will do it's best to store urls under the key specified.