blob: 52c259936d2135f84d7676ce9227c73861015da9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
# Del the funky robosapien
[](https://travis-ci.org/mokhan/del)
Del is a CLI/library for proxying requests to an XMPP server. It
can be used to configure chat bots to respond to direct messages or
messages in a multi user chat (MUC) room.
[Del is a funky robosapien](https://www.delhiero.com/)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'del'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install del
## Usage
Run the setup command.
$ del setup
By default all configuration is stored in a yaml file in your $HOME
directory named `.delrc`. E.g. `~/.delrc`
The setup will ask you for your XMPP password. If you are uncomfortable
storing your password in the `.delrc` you may skip that prompt. If you
choose not to store your password in `.delrc` then Del will prompt you
for your password each time you interact with Del.
Start the chat server:
$ del server
Start the server with a file containing custom chat routes:
$ del server lib/del/examples/routes.rb
Start the server with a remote file:
$ del server https://gist.githubusercontent.com/mokhan/15882e15908273f7880eaeaa336d12d9/raw/a54db41e7824315b63b3e4e88df5c2f74ce27e30/routes.rb
See [link](https://gist.githubusercontent.com/mokhan/15882e15908273f7880eaeaa336d12d9/raw/a54db41e7824315b63b3e4e88df5c2f74ce27e30/routes.rb) for content.
Once the server is started, you may use the client to issue different commands:
Send a message to another user:
$ del message 1_79@chat.btf.hipchat.com "Hello, World!"
Change your status:
$ del status busy "I am on a WebEx call"
Print your profile information:
$ del whoami
Print the profile information of another user:
$ del whois <jid>
Print all users:
$ del users
Interact with Del using a REPL:
$ del console
irb(main):001:0> Del.bot.busy!("I am really, really busy!")
irb(main):002:0> Del.bot.online!
See help for additional information:
```bash
も del help
Commands:
del console <config.rb> # start read-eval-print-loop
del help [COMMAND] # Describe available commands or one specific command
del message <jid> <message> # send a message to the Jabber ID
del server <routes.rb> # start server
del setup # setup your $HOME/.delrc
del status <status> <message> # status to online, away, or busy
del users # list all users
del version # Print the version of this gem
del whoami # send a whoami message to the local del server
del whois <jid> # whois a specific user
Options:
[--configuration-file=CONFIGURATION_FILE]
# Default: /home/del/.delrc
[--socket-file=SOCKET_FILE]
# Default: /tmp/del.sock
[--log-level=LOG_LEVEL]
# Default: 1
```
## Development
After checking out the repo, run `bin/setup` to install dependencies.
Then, run `bin/cibuild` to run the tests and linters.
You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/xlgmokha/del.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
