cinch-tinychat 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/README.md +43 -0
- metadata +51 -1
data/README.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
[](http://badge.fury.io/rb/cinch-tinychat) [](https://gemnasium.com/Namasteh/cinch-tinychat) [](https://travis-ci.org/Namasteh/cinch-tinychat) [](https://coveralls.io/r/Namasteh/cinch-tinychat)
|
|
2
|
+
|
|
3
|
+
### Authors
|
|
4
|
+
@doubledave
|
|
5
|
+
@Namasteh
|
|
6
|
+
|
|
7
|
+
### Files
|
|
8
|
+
tiny_chat.rb
|
|
9
|
+
|
|
10
|
+
### Dependencies
|
|
11
|
+
* [Cinch](http://rubygems.org/gems/cinch)
|
|
12
|
+
* OpenURI
|
|
13
|
+
* [Nokogiri](http://rubygems.org/gems/nokogiri)
|
|
14
|
+
* CGI
|
|
15
|
+
|
|
16
|
+
### Description
|
|
17
|
+
The _TinyChat_ gem (created for the Cinch IRC Bot Framework) is used to parse an XML API from apigee.com for TinyChat the browser chat client. Using it's commands you can have essential information of a TinyChat room returned to the channel.
|
|
18
|
+
|
|
19
|
+
### Installation
|
|
20
|
+
To install the gem:
|
|
21
|
+
|
|
22
|
+
> gem install cinch-tinychat
|
|
23
|
+
|
|
24
|
+
### Configuration
|
|
25
|
+
Firstly, the _TinyChat_ gem does not need an API key as it simply parses VML data from a link delivered through the bot.
|
|
26
|
+
|
|
27
|
+
Secondly, in order for this plugin to work you **must** load it into the bot. In most Cinch IRC bot formats you will do the following:
|
|
28
|
+
|
|
29
|
+
At the top of bot.rb put this line:
|
|
30
|
+
```ruby
|
|
31
|
+
require 'cinch-tinychat'
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
In the c.plugins section of bot.rb insert this:
|
|
35
|
+
```ruby
|
|
36
|
+
[Cinch::Plugins::TinyChat]
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Usage
|
|
40
|
+
|
|
41
|
+
The TinyChat plugin will query the room you ask it to and return with information on it.
|
|
42
|
+
|
|
43
|
+
* !(tinychat|tc) \<room\>: The bot will return with room information.
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: cinch-tinychat
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.
|
|
4
|
+
version: 1.0.1
|
|
5
5
|
prerelease:
|
|
6
6
|
platform: ruby
|
|
7
7
|
authors:
|
|
@@ -43,6 +43,54 @@ dependencies:
|
|
|
43
43
|
- - ! '>='
|
|
44
44
|
- !ruby/object:Gem::Version
|
|
45
45
|
version: '0'
|
|
46
|
+
- !ruby/object:Gem::Dependency
|
|
47
|
+
name: coveralls
|
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
|
49
|
+
none: false
|
|
50
|
+
requirements:
|
|
51
|
+
- - ! '>='
|
|
52
|
+
- !ruby/object:Gem::Version
|
|
53
|
+
version: '0'
|
|
54
|
+
type: :development
|
|
55
|
+
prerelease: false
|
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
57
|
+
none: false
|
|
58
|
+
requirements:
|
|
59
|
+
- - ! '>='
|
|
60
|
+
- !ruby/object:Gem::Version
|
|
61
|
+
version: '0'
|
|
62
|
+
- !ruby/object:Gem::Dependency
|
|
63
|
+
name: jeweler
|
|
64
|
+
requirement: !ruby/object:Gem::Requirement
|
|
65
|
+
none: false
|
|
66
|
+
requirements:
|
|
67
|
+
- - ! '>='
|
|
68
|
+
- !ruby/object:Gem::Version
|
|
69
|
+
version: '0'
|
|
70
|
+
type: :development
|
|
71
|
+
prerelease: false
|
|
72
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
73
|
+
none: false
|
|
74
|
+
requirements:
|
|
75
|
+
- - ! '>='
|
|
76
|
+
- !ruby/object:Gem::Version
|
|
77
|
+
version: '0'
|
|
78
|
+
- !ruby/object:Gem::Dependency
|
|
79
|
+
name: rspec
|
|
80
|
+
requirement: !ruby/object:Gem::Requirement
|
|
81
|
+
none: false
|
|
82
|
+
requirements:
|
|
83
|
+
- - ! '>='
|
|
84
|
+
- !ruby/object:Gem::Version
|
|
85
|
+
version: '0'
|
|
86
|
+
type: :development
|
|
87
|
+
prerelease: false
|
|
88
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
89
|
+
none: false
|
|
90
|
+
requirements:
|
|
91
|
+
- - ! '>='
|
|
92
|
+
- !ruby/object:Gem::Version
|
|
93
|
+
version: '0'
|
|
46
94
|
description: The TinyChat plugin will query the room you ask it to and return with
|
|
47
95
|
information on it.
|
|
48
96
|
email: namaste@rawrnet.net
|
|
@@ -50,11 +98,13 @@ executables: []
|
|
|
50
98
|
extensions: []
|
|
51
99
|
extra_rdoc_files:
|
|
52
100
|
- LICENSE
|
|
101
|
+
- README.md
|
|
53
102
|
- README.rdoc
|
|
54
103
|
files:
|
|
55
104
|
- LICENSE
|
|
56
105
|
- README.rdoc
|
|
57
106
|
- lib/cinch/plugins/tiny_chat.rb
|
|
107
|
+
- README.md
|
|
58
108
|
homepage: http://github.com/namasteh/cinch-tinychat
|
|
59
109
|
licenses: []
|
|
60
110
|
post_install_message:
|