/weechat-slacklog

Pull chat history into newly opened buffers
  1. Ruby 100.0%
Ruby
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit 87424ce Oct 17, 2017 @mschaaf mschaaf committed with pbrisbin Add ability to fetch history for direct chats
Permalink
Failed to load latest commit information.
spec Replace user id/names in join/part messages Nov 26, 2014
.gitignore Move everything into one file Jun 15, 2014
Gemfile Add Slacklog::SlackAPI Jun 14, 2014
README.md Correct link to Slack API documentation Jan 24, 2016
Rakefile Add coverage on weechat integration Jun 15, 2014
shot.png Better screen shot Jun 14, 2014
slacklog.rb Add ability to fetch history for direct chats Oct 18, 2017

README.md

Slacklog

Pull Slack chat history in when opening a new buffer.

shot

Installation

This script is not yet released, please install manually:

% curl -o ~/.weechat/ruby/slacklog.rb \
  "https://raw.githubusercontent.com/thoughtbot/weechat-slacklog/master/slacklog.rb"

Optionally set the script to autoload when WeeChat starts:

% cd ~/.weechat/ruby/autoload && ln -s ../slacklog.rb .

Restart WeeChat or load the script manually:

/script load slacklog.rb

Required Settings

Note: You can generate an API token here.

/set plugins.var.ruby.slacklog.servers "thoughtbot"
/set plugins.var.ruby.slacklog.thoughtbot.api_token "abc-123"

These variables can also be modified via the /slacklog command:

/slacklog add thoughtbot abc-123

Optional Settings

By default, the Slack API returns 100 messages when no count is specified. You can change this by setting a value between 1 and 1000:

/set plugins.var.ruby.slacklog.count 500

To change the color of Slacklog lines, change the following WeeChat setting:

/set logger.color.backlog_line darkgray

Usage

Whenever you open a buffer for a server in your servers list (and which has a token defined), 100 messages of history will be fetched via the Slack API and printed into the buffer.

The /slacklog command can be used without arguments to actively fetch and print history for an already open buffer.

Implementation Details

The script can be used outside of WeeChat like so:

% ruby ./slacklog.rb fetch API-TOKEN CHANNEL

This prints history messages on stdout and has no dependencies on the Weechat module. The implementation is contained in a normal SlackAPI class which is well tested.

Global functions wire this up as a WeeChat plugin in the following way:

  • Whenever a channel is joined or the /slacklog command is invoked, we determine the token and channel then ask Weechat to asynchronously execute our script as above with a callback.
  • The callback will receive the lines output by our script, and print them into the buffer.