basecamp/lita-campfire

Name: lita-campfire

Owner: Basecamp

Description: Campfire adapter for lita

Created: 2014-09-17 17:13:30.0

Updated: 2015-12-04 19:11:27.0

Pushed: 2014-09-17 18:23:11.0

Homepage: null

Size: 150

Language: Ruby

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Campfire adapter for Lita

lita-campfire is an adapter for Lita that allows you to use the robot with Campfire.

Installation

Add lita-campfire to your Lita instance's Gemfile:

"lita-campfire"

or if you want to use the bleeding edge version:

"lita-campfire", :git => 'https://github.com/josacar/lita-campfire.git'

Configuration

Values needed to work like apikey can be found on 'My info' link when logged, subdomain and rooms, extract it from the URL to join (https://org_name_example.campfirenow.com/rooms/78744).

Required attributes

• apikey (String) - The APIKEY of your robot's Campfire account. Default: nil.
• rooms (Array) - The room ids to join by your robot. Default: nil.
• subdomain (String) - The organization name to join by your robot. Default: nil.

Optional attributes

• debug (Boolean) - If true, turns on the underlying Campfire library's (tinder) logger, which is fairly verbose. Default: false.
• tinder_options (Hash) - If set passes the options to tinder listen method when called

Note You must set also config.robot.name and config.robot.mention_name to work.

Example

This is the lita_config.rb file to work with campfire and be deployed on Heroku.

.configure do |config|
The name your robot will use.
nfig.robot.name = "Campfire bot"
nfig.robot.mention_name = "robot"

The severity of messages to log.
nfig.robot.log_level = :info

The adapter you want to connect with.
nfig.robot.adapter = :campfire

nfig.adapter.subdomain = ENV["CAMPFIRE_SUBDOMAIN"]
nfig.adapter.apikey = ENV["CAMPFIRE_APIKEY"]
nfig.adapter.rooms = ENV["CAMPFIRE_ROOMS"].split(',')
nfig.adapter.debug = false
nfig.adapter.tinder_options = { timeout: 30, user_agent: 'lita-campfire' }

nfig.redis.url = ENV["REDISTOGO_URL"]
nfig.http.port = ENV["PORT"]

nfig.handlers.google_images.safe_search = :off

Then, set the variables like:

ku config:set CAMPFIRE_APIKEY=43242c42270856780656360bfbee863892
ku config:set CAMPFIRE_SUBDOMAIN=orgname
ku config:set CAMPFIRE_ROOMS=5674537,324424

License

MIT