lita-campfire 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6c09610adbd5cde7dbcba15ed189ae282565d42
+  data.tar.gz: 685c6bfafacd7ec73f258831629f2087deedabf0
+SHA512:
+  metadata.gz: d00c551bcb948b8d0f8f2da32d63ea271ca06fe06277d46c20e60ba85c36f784dd0613cc19fd662f740e3e2a5ed0af4c3936d1c901398c4f82a4e6b42badb10f
+  data.tar.gz: baf6b041d1bb6033d29317b51bf7648d3eb753b61a4df6fb4e081e0625fc5d83b02d66d4e17a90c0910711cb9975529cedba13974d57175c3705f862ef560b88

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rspec
+before_install:
+  - gem update --system

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    lita-campfire (0.1)
+      lita (~> 2.0)
+      tinder (~> 1.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    daemons (1.1.9)
+    diff-lcs (1.2.4)
+    eventmachine (1.0.3)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    hashie (1.2.0)
+    http_parser.rb (0.5.3)
+    json (1.7.7)
+    lita (2.2.0)
+      bundler (~> 1.3)
+      faraday (~> 0.8.7)
+      multi_json (~> 1.7.7)
+      rack (~> 1.5.2)
+      redis-namespace (~> 1.3.0)
+      thin (~> 1.5.1)
+      thor (~> 0.18.1)
+    mime-types (1.23)
+    multi_json (1.7.8)
+    multipart-post (1.2.0)
+    rack (1.5.2)
+    rake (10.1.0)
+    redis (3.0.4)
+    redis-namespace (1.3.1)
+      redis (~> 3.0.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.2)
+    simple_oauth (0.1.9)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thin (1.5.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thor (0.18.1)
+    tinder (1.9.2)
+      eventmachine (~> 1.0)
+      faraday (~> 0.8)
+      faraday_middleware (~> 0.9)
+      hashie (~> 1.0)
+      json (~> 1.7.5)
+      mime-types (~> 1.19)
+      multi_json (~> 1.5)
+      twitter-stream (~> 0.1)
+    twitter-stream (0.1.16)
+      eventmachine (>= 0.12.8)
+      http_parser.rb (~> 0.5.1)
+      simple_oauth (~> 0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  coveralls
+  lita-campfire!
+  rake
+  rspec (~> 2.14)
+  simplecov

data/README.md

@@ -0,0 +1,72 @@
+# Campfire adapter for Lita
+
+## Continuous Integration
+
+[![Build Status](https://secure.travis-ci.org/josacar/lita-campfire.png)](http://travis-ci.org/josacar/lita-campfire)
+[![Coverage Status](https://coveralls.io/repos/josacar/lita-campfire/badge.png)](https://coveralls.io/r/josacar/lita-campfire)
+
+**lita-campfire** is an adapter for [Lita](https://github.com/jimmycuadra/lita) that allows you to use the robot with [Campfire](https://campfirenow.com).
+
+## Installation
+
+Add lita-campfire to your Lita instance's Gemfile:
+
+```ruby
+gem "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`.
+
+**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.
+
+```ruby
+Lita.configure do |config|
+  # The name your robot will use.
+  config.robot.name = "Campfire bot"
+  config.robot.mention_name = "robot"
+
+  # The severity of messages to log.
+  config.robot.log_level = :info
+
+  # The adapter you want to connect with.
+  config.robot.adapter = :campfire
+
+  config.adapter.subdomain = ENV["CAMPFIRE_SUBDOMAIN"]
+  config.adapter.apikey = ENV["CAMPFIRE_APIKEY"]
+  config.adapter.rooms = ENV["CAMPFIRE_ROOMS"].split(',')
+  config.adapter.debug = false
+
+  config.redis.url = ENV["REDISTOGO_URL"]
+  config.http.port = ENV["PORT"]
+
+  config.handlers.google_images.safe_search = :off
+end
+```
+
+Then, set the variables like:
+
+```bash
+heroku config:set CAMPFIRE_APIKEY=43242c42270856780656360bfbee863892
+heroku config:set CAMPFIRE_SUBDOMAIN=orgname
+heroku config:set CAMPFIRE_ROOMS=5674537,324424
+```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/lita/adapters/campfire/callback.rb

@@ -0,0 +1,33 @@
+module Lita
+  module Adapters
+    class Campfire < Adapter
+      class Callback
+
+        MESSAGE_TYPES = %w( TextMessage PasteMessage ).freeze
+
+        def initialize(robot)
+          @robot = robot
+        end
+
+        def room_message(room)
+          room.listen do |m|
+            if MESSAGE_TYPES.include?(m.type)
+              text    = m.body
+              user    = get_user(m.user)
+              source  = Source.new(user, room)
+              message = Message.new(@robot, text, source)
+              @robot.receive message
+            end
+          end
+        end
+
+        private
+        def get_user(user_data)
+          user_id = user_data.delete(:id)
+          User.new(user_id, user_data)
+        end
+
+      end
+    end
+  end
+end

data/lib/lita/adapters/campfire/connector.rb

@@ -0,0 +1,46 @@
+module Lita
+  module Adapters
+    class Campfire < Adapter
+      class Connector
+        def initialize(robot, opts)
+          @robot     = robot
+          @subdomain = opts.fetch(:subdomain)
+          @apikey    = opts.fetch(:apikey)
+          @rooms     = opts.fetch(:rooms)
+          @debug     = opts.fetch(:debug) { false }
+        end
+
+        def connect
+          @campfire = Tinder::Campfire.new(@subdomain, token: @apikey)
+        end
+
+        def join_rooms(rooms)
+          rooms.each do |room_id|
+            room = fetch_room(room_id)
+            room.join
+            Callback.new(@robot).room_message(room)
+          end
+        end
+
+        def send_messages(room, messages)
+          @campfire.find_room_by_id(room.id).tap do |my_room|
+            messages.each do |message|
+              my_room.speak message
+            end
+          end
+        end
+
+        private
+
+        def fetch_room(room_id)
+          @campfire.find_room_by_id(room_id).tap do |room|
+            if room.nil?
+              raise RoomNotAvailable,
+                "Make sure you have access to room #{ room_id }"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lita/adapters/campfire/room_not_available.rb

@@ -0,0 +1,8 @@
+module Lita
+  module Adapters
+    class Campfire < Adapter
+      class RoomNotAvailable < StandardError
+      end
+    end
+  end
+end

data/lib/lita/adapters/campfire.rb

@@ -0,0 +1,57 @@
+module Lita
+  module Adapters
+    class Campfire < Adapter
+      require_configs :subdomain, :apikey, :rooms
+
+      attr_reader :connector
+
+      def initialize(robot)
+        super
+
+        @connector = Connector.new(
+          robot,
+          subdomain: config.subdomain,
+          apikey: config.apikey,
+          rooms: config.rooms,
+          debug: config.debug
+        )
+      end
+
+      def run
+        connector.connect
+        connector.join_rooms rooms
+        sleep
+      rescue Interrupt
+        disconnect
+      end
+
+      def send_messages(target, messages)
+        connector.send_messages(target.room, messages)
+      end
+
+      def set_topic(target, topic)
+        connector.set_topic(target.room, topic)
+      end
+
+      def shut_down
+        disconnect
+      end
+
+      private
+
+      def config
+          Lita.config.adapter
+      end
+
+      def rooms
+        Array(config.rooms)
+      end
+
+      def disconnect
+        connector.disconnect
+      end
+    end
+
+    Lita.register_adapter(:campfire, Campfire)
+  end
+end

data/lib/lita-campfire.rb

@@ -0,0 +1,8 @@
+require 'lita'
+require 'lita/adapters/campfire'
+require 'lita/adapters/campfire/callback'
+require 'lita/adapters/campfire/connector'
+require 'lita/adapters/campfire/room_not_available'
+require 'net/http'
+require 'tinder'
+require 'uri'

data/lita-campfire.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-campfire"
+  spec.version       = "0.1"
+  spec.authors       = ["Jose Luis Salas"]
+  spec.email         = ["josacar@gmail.com"]
+  spec.description   = %q{A Campfire adapter for Lita.}
+  spec.summary       = %q{A Campfire adapter for the Lita chat robot.}
+  spec.homepage      = "https://github.com/josacar/lita-campfire"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "lita", "~> 2.0"
+  spec.add_runtime_dependency "tinder", "~> 1.9.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/spec/lita/adapters/campfire/callback_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Campfire::Callback do
+
+  class DummyRoom < Struct.new(:message)
+    def listen
+      yield message
+    end
+  end
+
+  let(:campfire_user) { { id: 1, name: 'Bender Bending Rodriguez' } }
+  let(:message) { double('Message') }
+  let(:robot) { double('Robot', mention_name: 'Robot') }
+  let(:room) { DummyRoom.new(campfire_message) }
+  let(:source) { double('Source') }
+  let(:text) { "Yes it's the apocalypse alright. I always though is have a hand in it." }
+  let(:user) { double('User') }
+
+  subject { described_class.new(robot) }
+
+  describe '#room_message' do
+    %w( TextMessage PasteMessage ).each do |message_type|
+      describe "with a #{message_type}" do
+        let(:campfire_message) { double(
+          type: message_type,
+          body: text,
+          user: campfire_user) }
+
+        it 'passes the message to Robot#receive' do
+          expect(Lita::User).to receive(:new).with(1, name: 'Bender Bending Rodriguez').and_return(user)
+          expect(Lita::Source).to receive(:new).with(user, room).and_return(source)
+          expect(Lita::Message).to receive(:new).with(robot, text, source).and_return(message)
+          expect(robot).to receive(:receive).with(message)
+          subject.room_message(room)
+        end
+      end
+    end
+  end
+
+end

data/spec/lita/adapters/campfire/connector_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Campfire::Connector do
+  let(:robot) { double }
+  let(:subdomain) { 'mycampfire' }
+  let(:apikey) { '2e9f45bb934c0fa13e9f19ee0901c316fda9fc1' }
+  let(:rooms) { %w( 12345 41234 ) }
+  let(:options) { { subdomain: subdomain, apikey: apikey, rooms: rooms } }
+  let(:campfire) { double }
+
+  subject { described_class.new(robot, options) }
+
+  before do
+    allow(Tinder::Campfire).to receive(:new).and_return(campfire)
+  end
+
+  describe '#connect' do
+    it 'connects the campfire connection' do
+      expect(Tinder::Campfire).to receive(:new).with(subdomain, token: apikey)
+      subject.connect
+    end
+  end
+
+  describe '#join_rooms' do
+    describe 'when I have access to the room' do
+      let(:room) { double('Room', id: 666) }
+
+      before do
+        allow(campfire).to receive(:find_room_by_id).and_return(room)
+        subject.connect
+      end
+
+      it 'joins each room' do
+        expect(Campfire::Callback).to receive(:new).
+          with(robot).
+          and_return(callback = double('Callback'))
+        expect(callback).to receive(:room_message).with(room)
+
+        expect(room).to receive(:join)
+
+        subject.join_rooms [ double ]
+      end
+    end
+
+    describe "when I don't have access to the room" do
+      before do
+        allow(campfire).to receive(:find_room_by_id).and_return(nil)
+        subject.connect
+      end
+
+      it 'raises an exception' do
+        expect { subject.join_rooms [ double ] }.to raise_error(Campfire::RoomNotAvailable)
+      end
+    end
+  end
+
+  describe '#send_messages' do
+    let(:message) { "I'm gonna drink 'til I reboot." }
+
+    let(:room) { double }
+
+    before do
+      allow(campfire).to receive(:find_room_by_id).and_return(room)
+      subject.connect
+    end
+
+    it 'speaks each message into room' do
+      expect(room).to receive(:speak).with(message)
+      subject.send_messages double(id: 1), [ message ]
+    end
+  end
+end

data/spec/lita/adapters/campfire_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Lita::Adapters::Campfire do
+  before do
+    Lita.configure do |config|
+      config.adapter.subdomain = 'foodomain'
+      config.adapter.apikey = 'fooapikey'
+      config.adapter.rooms = ['fooroom']
+    end
+
+    allow(described_class::Connector).to receive(:new).and_return(connector)
+  end
+
+  subject { described_class.new(robot) }
+
+  let(:robot) { double("Lita::Robot") }
+  let(:connector) { double("Lita::Adapters::Campfire::Connector") }
+
+  it "registers with Lita" do
+    expect(Lita.adapters[:campfire]).to eql(described_class)
+  end
+
+  it "requires config.subdomain, config.apikey and config.rooms" do
+    Lita.clear_config
+    expect(Lita.logger).to receive(:fatal).with(/subdomain, apikey, rooms/)
+    expect { subject }.to raise_error(SystemExit)
+  end
+
+  describe '#run' do
+    before do
+      allow(subject.connector).to receive(:connect)
+      allow(subject.connector).to receive(:join_rooms)
+      allow(subject).to receive(:sleep)
+    end
+
+    it 'connects to campfire' do
+      expect(subject.connector).to receive(:connect)
+      subject.run
+    end
+
+    it 'join specified rooms' do
+      rooms = ['room1', 'room2']
+      Lita.config.adapter.rooms = rooms
+      expect(subject.connector).to receive(:join_rooms).with(rooms)
+      subject.run
+    end
+
+    it "sleeps the main thread" do
+      expect(subject).to receive(:sleep)
+      subject.run
+    end
+
+    it "disconnects gracefully on interrupt" do
+      expect(subject).to receive(:disconnect)
+      allow(subject).to receive(:sleep).and_raise(Interrupt)
+      subject.run
+    end
+  end
+
+  describe '#send_messages' do
+    it 'sends messages to rooms' do
+      source = double("Lita::Source", room: "room_id")
+      expect(subject.connector).to receive(:send_messages).with(
+        'room_id',
+        ["Hello!"]
+      )
+      subject.send_messages(source, ["Hello!"])
+    end
+  end
+
+  describe "#set_topic" do
+    it "sets a new topic for a room" do
+      source = double("Lita::Source", room: "room_id")
+      expect(subject.connector).to receive(:set_topic).with(
+        "room_id",
+        "Topic"
+      )
+      subject.set_topic(source, "Topic")
+    end
+  end
+
+  describe "#shut_down" do
+    it "shuts down the connector" do
+      expect(subject.connector).to receive(:disconnect)
+      subject.shut_down
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita-campfire"
+require "lita/rspec"
+
+include Lita::Adapters

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: lita-campfire
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Jose Luis Salas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: tinder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Campfire adapter for Lita.
+email:
+- josacar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/lita-campfire.rb
+- lib/lita/adapters/campfire.rb
+- lib/lita/adapters/campfire/callback.rb
+- lib/lita/adapters/campfire/connector.rb
+- lib/lita/adapters/campfire/room_not_available.rb
+- lita-campfire.gemspec
+- spec/lita/adapters/campfire/callback_spec.rb
+- spec/lita/adapters/campfire/connector_spec.rb
+- spec/lita/adapters/campfire_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/josacar/lita-campfire
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A Campfire adapter for the Lita chat robot.
+test_files:
+- spec/lita/adapters/campfire/callback_spec.rb
+- spec/lita/adapters/campfire/connector_spec.rb
+- spec/lita/adapters/campfire_spec.rb
+- spec/spec_helper.rb