scamp-campfire 1.0.0.pre

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+examples/Gemfile
+examples/Gemfile.lock
+coverage/
+.DS_Store
+.rvmrc

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "scamp", :git => "git@github.com:wjessop/Scamp.git", :branch => '2.0.0'

data/LICENCE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Adam Holt
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Scamp Campfire Adapter
+
+This is the campfire adapter for Scamp, the bot framework
+
+## Installation
+
+Put this in your gemfile!
+
+``` ruby
+  gem 'scamp-campfire'
+```
+
+
+## Usage
+
+See ./examples
+
+## How to contribute
+
+Here's the most direct way to get your work merged into the project:
+
+1. Fork the project
+2. Clone down your fork
+3. Create a feature branch
+4. Add your feature + tests
+5. Document new features in the README
+6. Make sure everything still passes by running the tests
+7. If necessary, rebase your commits into logical chunks, without errors
+8. Push the branch up
+9. Send a pull request for your branch
+
+Take a look at the TODO list or known issues for some inspiration if you
+need it.
+
+## Thanks
+
+First class support, commits and pull requests, thanks guys!
+
+* [Adam Holt](http://adamholt.co.uk/)
+* [Caius Durling](http://caius.name/)
+* [Will Jessop](http://willj.net/)
+
+## License
+
+See LICENSE.md

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => e
+  task "spec" do
+    puts "RSpec not loaded - make sure it's installed and you're using bundle exec"
+    exit 1
+  end
+end
+
+task :default => :spec

data/examples/v2.rb

@@ -0,0 +1,29 @@
+require "bundler/setup"
+
+require 'scamp'
+require 'scamp-campfire'
+
+Scamp.new do |bot|
+  bot.adapter :campfire, Scamp::Campfire::Adapter, :subdomain => 'SUBDOMAIN', 
+                                                   :api_key => 'YOUR_API_KEY',
+                                                   :rooms => [123]
+
+  bot.match /^ping/ do |channel, msg|
+    channel.reply "pong"
+  end
+
+  bot.match /^come to the pub (?<name>\w+)/ do |channel, msg|
+    channel.say "ROGER DODGER  #{msg.matches.name.upcase}!"
+    channel.reply "ON MY WAY!"
+    channel.paste <<-STR
+      bot.match /^come to the pub (?<name>\w+)/ do |channel, msg|
+        channel.say "ROGER DODGER!"
+        channel.reply "ON MY WAY! #{msg.matches.name}"
+        channel.play(:nyan)
+      end
+    STR
+    channel.play(:nyan)
+  end
+
+  bot.connect!
+end

data/lib/scamp-campfire.rb

@@ -0,0 +1,6 @@
+require "scamp"
+require "scamp-campfire/users"
+require "scamp-campfire/version"
+require "scamp-campfire/adapter"
+require "scamp-campfire/channel"
+require "scamp-campfire/message"

data/lib/scamp-campfire/adapter.rb

@@ -0,0 +1,76 @@
+require 'em-campfire'
+require 'scamp/adapter'
+
+class Scamp
+  module Campfire
+    class Adapter < Scamp::Adapter
+      include Scamp::Campfire::Users
+
+      def connect!
+        connection.on_message do |message|
+          if matches_required_format?(message[:body])
+            msg = Scamp::Campfire::Message.new self, :body => strip_prefix(message[:body]),
+                                                     :room_id => message[:room_id],
+                                                     :user_id => message[:user_id],
+                                                     :type => message[:type]
+
+            channel = Scamp::Campfire::Channel.new self, msg
+            push [channel, msg]
+          end
+        end
+
+        @opts[:rooms].each do |room|
+          connection.join(room) do |room_id|
+            pre_populate_user_cache_from_room_data(room_id)
+            connection.stream(room_id)
+          end
+        end
+      end
+
+      def say(message, room_id)
+        connection.say(room_id, message)
+      end
+
+      def paste(message, room_id)
+        connection.paste(room_id, message)
+      end
+
+      def play(sound, room_id)
+        connection.play(room_id, sound)
+      end
+
+      def required_prefix
+        @opts[:required_prefix]
+      end
+
+      def ignore_self?
+        @opts[:ignore_self] || false
+      end
+
+      def user_agent
+        @opts[:user_agent] || "scamp-campfire"
+      end
+
+      private
+
+      def pre_populate_user_cache_from_room_data(room_id)
+        connection.room_data_from_room_id(room_id) do |room_data|
+          room_data['users'].each do |user_data|
+            cache_data_for_user(user_data['id'], user_data)
+          end
+        end
+      end
+
+      def connection
+        @connection ||= EM::Campfire.new(
+          :subdomain => @opts[:subdomain],
+          :api_key => @opts[:api_key], 
+          :verbose => @opts[:verbose],
+          :ignore_self => @opts[:ignore_self],
+          :logger => @opts[:logger],
+          :user_agent => user_agent
+        )
+      end
+    end
+  end
+end

data/lib/scamp-campfire/channel.rb

@@ -0,0 +1,28 @@
+class Scamp
+  module Campfire
+    class Channel
+      attr_reader :adapter, :message
+
+      def initialize adapter, msg
+        @adapter = adapter
+        @message = msg
+      end
+
+      def say msg
+        adapter.say(message.room_id, msg)
+      end
+
+      def reply msg
+        adapter.say(message.room_id, "#{message.user_id}: #{msg}")
+      end
+
+      def paste text
+        adapter.paste(message.room_id, text)
+      end
+
+      def play sound
+        adapter.play(message.room_id, sound.to_s)
+      end
+    end
+  end
+end

data/lib/scamp-campfire/message.rb

@@ -0,0 +1,70 @@
+require 'scamp/message'
+
+class Scamp
+  module Campfire
+    class Message < Scamp::Message
+      def valid?(conditions={})
+        room_match?(conditions[:room]) &&
+        user_match?(conditions[:user])
+      end
+
+      def matches? trigger
+        adapter.bot.logger.debug "Matching message body #{body} against trigger #{trigger}"
+        if adapter.required_prefix
+          if satisfies_required_prefix?
+            msg = body.split(adapter.required_prefix, 2)[1]
+            match? trigger, msg
+          else
+            return false
+          end
+        else
+          match? trigger, body
+        end
+      end
+
+      def user_name
+        adapter.username_for_user_id(user_id)
+      end
+
+      private
+
+      def room_match?(condition)
+        return true if condition.nil?
+
+        if condition.is_a? Array
+          return (condition.include?(room.id) || condition.include?(room.name))
+        elsif condition.is_a? Fixnum
+          return room.id == condition
+        else
+          return room.name.downcase == condition.to_s.downcase
+        end
+      end
+
+      def user_match?(condition)
+        return true if condition.nil?
+
+        if condition.is_a? Array
+          return (condition.include?(user.id) || condition.include?(user.name))
+        elsif condition.is_a? Fixnum
+          return user.id == condition
+        else
+          return user.name.downcase == condition.to_s.downcase
+        end
+      end
+
+      def satisfies_required_prefix?
+        if adapter.required_prefix
+          if adapter.required_prefix.is_a? String
+            return true if adapter.required_prefix == body[0...adapter.required_prefix.length]
+          elsif adapter.required_prefix.is_a? Regexp
+            return true if adapter.required_prefix.match body
+          end
+          return false
+        else
+          return true
+        end
+      end
+
+    end
+  end
+end

data/lib/scamp-campfire/users.rb

@@ -0,0 +1,39 @@
+class Scamp
+  module Campfire
+    module Users
+      def username_for_user_id(user_id)
+        user_data(user_id)['name'] rescue user_id
+      end
+
+      private
+
+      def user_data(user_id)
+        ensure_user_data_is_cached(user_id)
+        puts user_cache.inspect
+        user_cache[user_id]
+      end
+
+      def ensure_user_data_is_cached(user_id)
+        user_cache[user_id] || begin
+          puts "Fetching user data for #{user_id}"
+          fetch_and_cache_user_data(user_id)
+        end
+      end
+
+      def fetch_and_cache_user_data(user_id)
+        connection.fetch_user_data_for_user_id(user_id) do |user_data|
+          puts "Setting cache to #{user_data.inspect}"
+          cache_data_for_user(user_id, user_data)
+        end
+      end
+
+      def cache_data_for_user(user_id, user_data_hash)
+        user_cache[user_id] = user_data_hash
+      end
+
+      def user_cache
+        @user_cache ||= {}
+      end
+    end
+  end
+end

data/lib/scamp-campfire/version.rb

@@ -0,0 +1,5 @@
+class Scamp
+  module Campfire
+    VERSION = "1.0.0.pre"
+  end
+end

data/scamp-campfire.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "scamp-campfire/version"
+
+Gem::Specification.new do |s|
+  s.name        = "scamp-campfire"
+  s.version     = Scamp::Campfire::VERSION
+  s.authors     = ["Adam Holt", "Will Jessop"]
+  s.email       = ["me@adamholt.co.uk", "will@willj.net"]
+  s.homepage    = ""
+  s.summary     = %q{A Campfire adapter for Scamp}
+  s.description = %q{scamp-campfire is an adapter for Scamp that uses the em-campfire lib to provide Campfire support}
+
+  s.rubyforge_project = "scamp-campfire"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "em-campfire", '~> 1.1'
+  s.add_dependency "scamp"
+  s.add_dependency "eventmachine", '~> 1.0'
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "rake"
+end

data/spec/lib/adapter_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Scamp::Campfire::Adapter do
+
+end

data/spec/lib/channel_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Scamp::Campfire::Channel do
+  
+end

data/spec/lib/message_spec.rb

@@ -0,0 +1,242 @@
+require 'spec_helper'
+
+describe Scamp::Campfire::Message do
+  before :each do
+    Scamp::Campfire::Adapter.any_instance.stubs(:pre_populate_user_cache_from_room_data)
+  end
+    
+  let(:adapter) { Scamp::Campfire::Adapter.new(stub, {:api_key => "foo", :subdomain => "foo"}) }
+  let(:room) { stub(:id => 1234, :name => "Room") }
+  let(:user) { stub(:id => 1234, :name => "User") }
+  let(:body) { "Hello" }
+  let(:message) { Scamp::Campfire::Message.new(adapter, :body => body, :room => room, :user => user) }
+
+  describe ".matches?" do
+    describe "with string trigger" do
+      it "matches with valid trigger" do
+        message.matches?("Hello").should be_true
+      end
+
+      it "does not match with invalid trigger" do
+        message.matches?("Goodbye").should be_false
+      end
+    end
+
+    describe "with regex trigger" do
+      it "matches with valid trigger" do
+        message.matches?(/^Hello/).should be_true
+      end
+
+      it "does not match with invalid trigger" do
+        message.matches?(/^Goodbye/).should be_false
+      end
+    end
+
+    describe "required prefix" do
+      describe "with no prefix" do
+        it "matches" do
+          message.matches?(/^Hello/).should be_true
+        end
+      end
+
+      describe "with string prefix" do
+        let(:adapter) { Scamp::Campfire::Adapter.new stub, :required_prefix => "User: " }
+
+        context "with valid message" do
+          let(:body) { "User: Hello" }
+
+          it "matches" do
+            message.matches?(/^Hello/).should be_true
+          end
+        end
+
+        context "with invalid message" do
+          let(:body) { "Another User: Hello" }
+
+          it "does not match" do
+            message.matches?(/^Hello/).should be_false
+          end
+        end
+      end
+
+      describe "with regex prefix" do
+        let(:adapter) { Scamp::Campfire::Adapter.new stub, :required_prefix => /^User: / }
+
+        context "with valid prefix" do
+          let(:body) { "User: Hello" }
+
+          it "matches" do
+            message.matches?(/^Hello/).should be_true
+          end
+        end
+
+        context "with invalid prefix" do
+          let(:body) { "Another User: Hello" }
+
+          it "does not match" do
+            message.matches?(/^Hello/).should be_false
+          end
+        end
+      end
+    end
+  end
+
+  describe ".valid?" do
+    describe "ignoring messages from self" do
+      let(:adapter) { Scamp::Campfire::Adapter.new stub, :ignore_self => true }
+
+      context "when message is from self" do
+        before do
+          adapter.stubs(:user).returns(stub(:id => 1234, :name => "User"))
+        end
+
+        it "is not valid" do
+          message.valid?().should be_false
+        end
+      end
+
+      context "message from another user" do
+        before do
+          adapter.stubs(:user).returns(stub(:id => 5678, :name => "Another User"))
+        end
+
+        it "is valid" do
+          message.valid?().should be_true
+        end
+      end
+    end
+
+
+    describe "matching rooms" do
+      describe "on no room condition" do
+        it "is valid" do
+          message.valid?().should be_true
+        end
+      end
+
+      describe "on room id" do
+        context "with valid room" do
+          it "is valid with a fixnum" do
+            message.valid?(:room => 1234).should be_true
+          end
+
+          it "is valid with an array" do
+            message.valid?(:room => [1234]).should be_true
+          end
+
+          it "is valid with an array of multiple rooms" do
+            message.valid?(:room => [1234, 5678]).should be_true
+          end
+        end
+
+        context "with invalid room" do
+          it "is invalid with a fixnum" do
+            message.valid?(:room => 5678).should be_false
+          end
+
+          it "is invalid with an array of fixnums" do
+            message.valid?(:room => [5678, 9012]).should be_false
+          end
+        end
+      end
+
+      describe "on room name" do
+        context "with valid room" do
+          it "is valid with a string" do
+            message.valid?(:room => "Room").should be_true
+          end
+
+          it "is valid with a symbol" do
+            message.valid?(:room => :room).should be_true
+          end
+
+          it "is valid with a string array" do
+            message.valid?(:room => ["Room"]).should be_true
+          end
+
+          it "is valid with a string array of multiple rooms" do
+            message.valid?(:room => ["Room", "Another"]).should be_true
+          end
+        end
+
+        context "with invalid room" do
+          it "is invalid with a string" do
+            message.valid?(:room => "Another").should be_false
+          end
+
+          it "is invalid with an array of strings" do
+            message.valid?(:room => ["Another", "One More"]).should be_false
+          end
+        end
+      end
+    end
+
+    describe "matching users" do
+      context "on no user condition" do
+        it "is valid" do
+          message.should be_valid
+        end
+      end
+
+      context "on user id" do
+        context "with valid user" do
+          it "is valid with a fixnum" do
+            message.valid?(:user => 1234).should be_true
+          end
+
+          it "is valid with a fixnum array" do
+            message.valid?(:user => [1234]).should be_true
+          end
+
+          it "is valid with a fixnum array of multiple users" do
+            message.valid?(:user => [1234, 5678]).should be_true
+          end
+        end
+
+        context "with invalid user" do
+          it "is invalid with fixnum" do
+            message.valid?(:user => 5678).should be_false
+          end
+
+          it "is invalid with a fixnum array" do
+            message.valid?(:user => [5678]).should be_false
+          end
+
+          it "is invalid with a fixnum array of multiple users" do
+            message.valid?(:user => [5678, 9012]).should be_false
+          end
+        end
+      end
+
+      context "on user user name" do
+        context "with valid user" do
+          it "is valid with string" do
+            message.valid?(:user => "User").should be_true
+          end
+
+          it "is valid with a string array" do
+            message.valid?(:user => ["User"]).should be_true
+          end
+
+          it "is valid with a string array of multiple users" do
+            message.valid?(:user => ["User", "Two"]).should be_true
+          end
+        end
+
+        context "with invalid user" do
+          it "is invalid with string" do
+            message.valid?(:user => "Two").should be_false
+          end
+
+          it "is invalid with a string array" do
+            message.valid?(:user => ["Two"]).should be_false
+          end
+
+          it "is invalid with a string array of multiple users" do
+            message.valid?(:user => ["Two", "Three"]).should be_false
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
+require 'scamp-campfire'
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.mock_framework = :mocha
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: scamp-campfire
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Adam Holt
+- Will Jessop
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-campfire
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: scamp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: scamp-campfire is an adapter for Scamp that uses the em-campfire lib
+  to provide Campfire support
+email:
+- me@adamholt.co.uk
+- will@willj.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENCE.md
+- README.md
+- Rakefile
+- examples/v2.rb
+- lib/scamp-campfire.rb
+- lib/scamp-campfire/adapter.rb
+- lib/scamp-campfire/channel.rb
+- lib/scamp-campfire/message.rb
+- lib/scamp-campfire/users.rb
+- lib/scamp-campfire/version.rb
+- scamp-campfire.gemspec
+- spec/lib/adapter_spec.rb
+- spec/lib/channel_spec.rb
+- spec/lib/message_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3060748957179309889
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: scamp-campfire
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: A Campfire adapter for Scamp
+test_files:
+- spec/lib/adapter_spec.rb
+- spec/lib/channel_spec.rb
+- spec/lib/message_spec.rb
+- spec/spec_helper.rb