lita-wit 0.1.0 → 0.1.1

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 +29 -5
  3. data/example.png +0 -0
  4. data/lita-wit.gemspec +21 -21
  5. metadata +2 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 2a6396a10176ffd117f4288900d89f9e721e08ba
4
- data.tar.gz: 513bdf40c3b8d6913ad28272280d6df24e0c1bd5
3
+ metadata.gz: 74ef2a835b5e8cf0ae48c1cf5fba9d9a9f42f14e
4
+ data.tar.gz: dad06bc5f297bc1371d57cca1ea060e79bdc8d9f
5
5
  SHA512:
6
- metadata.gz: b094722f4f49fec03c6640024265b1249fb7aba044c44c118d47be43d00f34ccd35b46dae80989408df8a9220b781e99c9cb046442bf9e49be20a1a615af61dc
7
- data.tar.gz: a5f15301b5966e2cb334028cdf301bd1f657ba5b01d02a4f7a836c40878949f57cb7002d4cc89ae21390d6666a819a75627ea4d686c550290e5ee28fb1831b8c
6
+ metadata.gz: 075d1dea9e0ac23cb665cf0d5a467aedc71270aac513ec742546ad74872500293623865abc25c65b4fdcc789da6f4a0d4e728f3c76d1b54fbfc2afd1aadb0f27
7
+ data.tar.gz: b0bfc96bc6b0fe4f1ebf9f60619212fb2d84effe355fb15ce924f0d205f98867fdbd28c01990fb55939bf01ec8d619b323445896dd4ef5d63554f187fef99265
data/README.md CHANGED
@@ -3,7 +3,16 @@
3
3
  [![Build Status](https://travis-ci.org/dbastin/lita-wit.png?branch=master)](https://travis-ci.org/dbastin/lita-wit)
4
4
  [![Coverage Status](https://coveralls.io/repos/dbastin/lita-wit/badge.png)](https://coveralls.io/r/dbastin/lita-wit)
5
5
 
6
- Receive structured intentions from unstructured sentences using a [Lita](https://www.lita.io) bot and [Wit](https://www.wit.ai).
6
+ This is a [Lita](https://www.lita.io) handler to converse with [Wit.ai](https://www.wit.ai)
7
+
8
+ Using Lita and Wit.ai, you can easily create text or voice based bots that humans can chat with on their preferred messaging platform.
9
+
10
+ Something like this Slack snippet...
11
+
12
+ ![Example of a conversation with Lita](https://raw.github.com/dbastin/lita-wit/master/example.png)
13
+
14
+ This above snippet is a conversation with a publically accessible pre-configured Wit.ai chatbot - https://wit.ai/dbastin/Lita.
15
+ As you can guess, Wit.ai not only enables your robot to understand humans, it also helps you discover their unforeseen needs.
7
16
 
8
17
  ## Installation
9
18
 
@@ -15,17 +24,32 @@ gem "lita-wit"
15
24
 
16
25
  ## Configuration
17
26
 
18
- You'll need to add the wit.ai API Bearer key.
27
+ You'll need to add the Wit.ai API server access token.
19
28
 
20
29
  ``` ruby
21
- config.wit_token = token-here
30
+ Lita.configure do |config|
31
+ # config... config... config...
32
+
33
+ # https://wit.ai/dbastin/Lita... Fork it!
34
+ config.handlers.wit.server_access_token = '72XXMP6VAKG2SAPLTXVQS6H5PBLVQIJW'
35
+ end
22
36
  ```
23
37
 
24
38
  ## Usage
25
39
 
26
- Rock!
40
+ Just send a message mentioning your robot by it's name or alias, either directly as a command or anywhere else in the message.
41
+
42
+ ```
43
+ > Lita, is it raining in Istanbul?
44
+ #=> Sorry, I don't know what the weather is like in Istanbul. I'm just a simple chatbot who loves a chat.
45
+
46
+ > Ok. Tell me if it is snowing lita.
47
+ #=> Where exactly?
48
+ ```
49
+
50
+ Your robot's name will be stripped from the message we send to Wit.ai
27
51
 
28
- ## Thanks Go To
52
+ ## Thanks
29
53
 
30
54
  [Tom Beynon](https://github.com/tombeynon) - Great handler for Cleverbot [lita-ai](https://github.com/tombeynon/lita-ai)
31
55
 
data/example.png ADDED
Binary file
data/lita-wit.gemspec CHANGED
@@ -1,29 +1,29 @@
1
1
  Gem::Specification.new do |spec|
2
- spec.name = "lita-wit"
3
- spec.version = "0.1.0"
4
- spec.authors = ["Damien Bastin"]
5
- spec.email = ["damien.bastin@gmail.com"]
6
- spec.description = "A Lita handler for Wit."
7
- spec.summary = "Receive structured intentions from unstructured sentences using a Lita bot and Wit."
8
- spec.homepage = "https://github.com/dbastin/lita-wit"
9
- spec.license = "MIT"
10
- spec.metadata = { "lita_plugin_type" => "handler" }
2
+ spec.name = 'lita-wit'
3
+ spec.version = '0.1.1'
4
+ spec.authors = ['Damien Bastin']
5
+ spec.email = ['damien.bastin@gmail.com']
6
+ spec.description = 'A Lita handler for Wit.'
7
+ spec.summary = 'Receive structured intentions from unstructured sentences using a Lita bot and Wit.'
8
+ spec.homepage = 'https://github.com/dbastin/lita-wit'
9
+ spec.license = 'MIT'
10
+ spec.metadata = { 'lita_plugin_type' => 'handler'}
11
11
 
12
12
  spec.files = `git ls-files`.split($/)
13
13
  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
14
14
  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
15
- spec.require_paths = ["lib"]
15
+ spec.require_paths = ['lib']
16
16
 
17
- spec.add_runtime_dependency "lita", ">= 4.7"
18
- spec.add_runtime_dependency "wit", ">= 3.3.1"
17
+ spec.add_runtime_dependency 'lita', '>= 4.7'
18
+ spec.add_runtime_dependency 'wit', '>= 3.3.1'
19
19
 
20
- spec.add_development_dependency "bundler", ">= 1.3"
21
- spec.add_development_dependency "pry-byebug"
22
- spec.add_development_dependency "rake"
23
- spec.add_development_dependency "rack-test"
24
- spec.add_development_dependency "rspec", ">= 3.0.0"
25
- spec.add_development_dependency "simplecov"
26
- spec.add_development_dependency "coveralls"
27
- spec.add_development_dependency "webmock"
28
- spec.add_development_dependency "vcr"
20
+ spec.add_development_dependency 'bundler', '>= 1.3'
21
+ spec.add_development_dependency 'pry-byebug'
22
+ spec.add_development_dependency 'rake'
23
+ spec.add_development_dependency 'rack-test'
24
+ spec.add_development_dependency 'rspec', '>= 3.0.0'
25
+ spec.add_development_dependency 'simplecov'
26
+ spec.add_development_dependency 'coveralls'
27
+ spec.add_development_dependency 'webmock'
28
+ spec.add_development_dependency 'vcr'
29
29
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: lita-wit
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Damien Bastin
@@ -177,6 +177,7 @@ files:
177
177
  - LICENSE
178
178
  - README.md
179
179
  - Rakefile
180
+ - example.png
180
181
  - lib/lita-wit.rb
181
182
  - lib/lita/handlers/wit.rb
182
183
  - lib/lita/services/wit_client.rb