scamp 0.0.4 → 0.1.0

data/spec/lib/scamp_spec.rb

@@ -2,11 +2,24 @@ require "spec_helper"
 
 describe Scamp do
   before do
-    @valid_params = {:api_key => "6124d98749365e3db2c9e5b27ca04db6", :subdomain => "oxygen"}
+    @valid_params = {:api_key => "6124d98749365e3db2c9e5b27ca04db6", :subdomain => "oxygen"} 
     @valid_user_cache_data = {123 => {"name" => "foo"}, 456 => {"name" => "bar"}}
-    @valid_channel_cache_data = {123 => {"name" => "foo"}, 456 => {"name" => "bar"}}
+    
+    # Stub fetch for room data
+    @valid_room_cache_data = {
+      123 => {
+        "id" => 123,
+        "name" => "foo",
+        "users" => []
+      },
+      456 => {
+        "id" => 456,
+        "name" => "bar",
+        "users" => []
+      }
+    }
   end
-
+  
   describe "#initialize" do
     it "should work with valid params" do
       a(Scamp).should be_a(Scamp)
@@ -93,32 +106,32 @@ describe Scamp do
   describe "matching" do
     
     context "with conditions" do
-      it "should limit matches by channel id" do
+      it "should limit matches by room id" do
         canary = mock
         canary.expects(:lives).once
         canary.expects(:bang).never
         
         bot = a Scamp
         bot.behaviour do
-          match("a string", :conditions => {:channel => 123}) {canary.lives}
-          match("a string", :conditions => {:channel => 456}) {canary.bang}
+          match("a string", :conditions => {:room => 123}) {canary.lives}
+          match("a string", :conditions => {:room => 456}) {canary.bang}
         end
         
         bot.send(:process_message, {:room_id => 123, :body => "a string"})
       end
       
-      it "should limit matches by channel name" do
+      it "should limit matches by room name" do
         canary = mock
         canary.expects(:lives).once
         canary.expects(:bang).never
         
         bot = a Scamp
         bot.behaviour do
-          match("a string", :conditions => {:channel => "foo"}) {canary.lives}
-          match("a string", :conditions => {:channel => "bar"}) {canary.bang}
+          match("a string", :conditions => {:room => "foo"}) {canary.lives}
+          match("a string", :conditions => {:room => "bar"}) {canary.bang}
         end
         
-        bot.channel_cache = @valid_channel_cache_data
+        bot.room_cache = @valid_room_cache_data
         
         bot.send(:process_message, {:room_id => 123, :body => "a string"})
       end
@@ -153,18 +166,18 @@ describe Scamp do
         bot.send(:process_message, {:user_id => 123, :body => "a string"})
       end
       
-      it "should limit matches by channel and user" do
+      it "should limit matches by room and user" do
         canary = mock
         canary.expects(:lives).once
         canary.expects(:bang).never
         
         bot = a Scamp
         bot.behaviour do
-          match("a string", :conditions => {:channel => 123, :user => 123}) {canary.lives}
-          match("a string", :conditions => {:channel => 456, :user => 456}) {canary.bang}
+          match("a string", :conditions => {:room => 123, :user => 123}) {canary.lives}
+          match("a string", :conditions => {:room => 456, :user => 456}) {canary.bang}
         end
         
-        bot.channel_cache = @valid_channel_cache_data
+        bot.room_cache = @valid_room_cache_data
         bot.user_cache = @valid_user_cache_data
         bot.send(:process_message, {:room_id => 123, :user_id => 123, :body => "a string"})
         bot.send(:process_message, {:room_id => 123, :user_id => 456, :body => "a string"})
@@ -187,8 +200,33 @@ describe Scamp do
         
         bot.send(:process_message, {:body => "a string"})
       end
+      
+      it "should not match without prefix when required_prefix is true" do
+        canary = mock
+        canary.expects(:bang).never
+        
+        bot = a Scamp, :required_prefix => 'Bot: '
+        bot.behaviour do
+          match("a string") {canary.bang}
+        end
+        
+        bot.send(:process_message, {:body => "a string"})
+      end
+
+      it "should match with exact prefix when required_prefix is true" do
+        canary = mock
+        canary.expects(:lives).once
+        
+        bot = a Scamp, :required_prefix => 'Bot: '
+        bot.behaviour do
+          match("a string") {canary.lives}
+        end
+        
+        bot.send(:process_message, {:body => "Bot: a string"})
+      end
     end
     
+
     describe "regexes" do
       it "should match a regex" do
         canary = mock
@@ -236,6 +274,360 @@ describe Scamp do
         
         bot.send(:process_message, {:body => "please match first and the rest of it"})
       end
+      
+      it "should not match without prefix when required_prefix is present" do
+        canary = mock
+        canary.expects(:bang).never
+        
+        bot = a Scamp, :required_prefix => /^Bot[\:,\s]+/i
+        bot.behaviour do
+          match(/a string/) {canary.bang}
+        end
+        
+        bot.send(:process_message, {:body => "a string"})
+        bot.send(:process_message, {:body => "some kind of a string"})
+        bot.send(:process_message, {:body => "a string!!!"})
+      end
+
+      it "should match with regex prefix when required_prefix is present" do
+        canary = mock
+        canary.expects(:lives).times(4)
+        
+        bot = a Scamp, :required_prefix => /^Bot\W{1,2}/i
+        bot.behaviour do
+          match(/a string/) {canary.lives}
+        end
+        
+        bot.send(:process_message, {:body => "Bot, a string"})
+        bot.send(:process_message, {:body => "Bot a string"})
+        bot.send(:process_message, {:body => "bot: a string"})
+        bot.send(:process_message, {:body => "Bot: a string oh my!"})
+      end
+    end
+  end
+  
+  describe "match block" do
+    it "should make the room details available to the action block" do
+      canary = mock
+      canary.expects(:id).with(123)
+      canary.expects(:name).with(@valid_room_cache_data[123]["name"])
+      
+      bot = a Scamp
+      bot.behaviour do
+        match("a string") {
+          canary.id(room_id)
+          canary.name(room)
+        }
+      end
+      
+      bot.room_cache = @valid_room_cache_data
+      bot.send(:process_message, {:room_id => 123, :body => "a string"})
+    end
+    
+    it "should make the speaking user details available to the action block" do
+      canary = mock
+      canary.expects(:id).with(123)
+      canary.expects(:name).with(@valid_user_cache_data[123]["name"])
+      
+      bot = a Scamp
+      bot.behaviour do
+        match("a string") {
+          canary.id(user_id)
+          canary.name(user)
+        }
+      end
+      
+      bot.user_cache = @valid_user_cache_data
+      bot.send(:process_message, {:user_id => 123, :body => "a string"})
+    end
+    
+    it "should make the message said available to the action block" do
+      canary = mock
+      canary.expects(:message).with("Hello world")
+      
+      bot = a Scamp
+      bot.behaviour do
+        match("Hello world") {
+          canary.message(message)
+        }
+      end
+      
+      bot.send(:process_message, {:body => "Hello world"})
+    end
+    
+    it "should provide a command list" do
+      canary = mock
+      canary.expects(:commands).with([["Hello world", {}], ["Hello other world", {:room=>123}], [/match me/, {:user=>123}]])
+      
+      bot = a Scamp
+      bot.behaviour do
+        match("Hello world") {
+          canary.commands(command_list)
+        }
+        match("Hello other world", :conditions => {:room => 123}) {}
+        match(/match me/, :conditions => {:user => 123}) {}
+      end
+      
+      bot.send(:process_message, {:body => "Hello world"})
+    end
+    
+    it "should be able to play a sound to the room the action was triggered in" do
+      bot = a Scamp
+      bot.behaviour do
+        match("Hello world") {
+          play "yeah"
+        }
+      end
+      
+      EM.run_block {
+        room_id = 123
+        stub_request(:post, "https://#{@valid_params[:subdomain]}.campfirenow.com/room/#{room_id}/speak.json").
+          with(
+            :body => "{\"message\":{\"body\":\"yeah\",\"type\":\"SoundMessage\"}}",
+            :headers => {'Authorization'=>[@valid_params[:api_key], 'X'], 'Content-Type'=>'application/json'}
+          )
+            
+        bot.send(:process_message, {:room_id => room_id, :body => "Hello world"})
+      }
+    end
+    
+    it "should be able to play a sound to an arbitrary room" do
+      play_room = 456
+      
+      bot = a Scamp
+      bot.behaviour do
+        match("Hello world") {
+          play "yeah", play_room
+        }
+      end
+      
+      EM.run_block {
+        room_id = 123
+        stub_request(:post, "https://#{@valid_params[:subdomain]}.campfirenow.com/room/#{play_room}/speak.json").
+          with(
+            :body => "{\"message\":{\"body\":\"yeah\",\"type\":\"SoundMessage\"}}",
+            :headers => {'Authorization'=>[@valid_params[:api_key], 'X'], 'Content-Type'=>'application/json'}
+          )
+            
+        bot.send(:process_message, {:room_id => room_id, :body => "Hello world"})
+      }
+    end
+    
+    it "should be able to say a message to the room the action was triggered in" do
+      bot = a Scamp
+      bot.behaviour do
+        match("Hello world") {
+          say "yeah"
+        }
+      end
+      
+      EM.run_block {
+        room_id = 123
+        stub_request(:post, "https://#{@valid_params[:subdomain]}.campfirenow.com/room/#{room_id}/speak.json").
+          with(
+            :body => "{\"message\":{\"body\":\"yeah\",\"type\":\"Textmessage\"}}",
+            :headers => {'Authorization'=>[@valid_params[:api_key], 'X'], 'Content-Type'=>'application/json'}
+          )
+            
+        bot.send(:process_message, {:room_id => room_id, :body => "Hello world"})
+      }
+    end
+    
+    it "should be able to say a message to an arbitrary room" do
+      play_room = 456
+      
+      bot = a Scamp
+      bot.behaviour do
+        match("Hello world") {
+          say "yeah", play_room
+        }
+      end
+      
+      EM.run_block {
+        room_id = 123
+        stub_request(:post, "https://#{@valid_params[:subdomain]}.campfirenow.com/room/#{play_room}/speak.json").
+          with(
+            :body => "{\"message\":{\"body\":\"yeah\",\"type\":\"Textmessage\"}}",
+            :headers => {'Authorization'=>[@valid_params[:api_key], 'X'], 'Content-Type'=>'application/json'}
+          )
+            
+        bot.send(:process_message, {:room_id => room_id, :body => "Hello world"})
+      }
+    end
+  end
+
+  describe "API" do
+    context "user operations" do
+      it "should fetch user data" do
+        bot = a Scamp
+        
+        EM.run_block {
+          stub_request(:get, "https://#{@valid_params[:subdomain]}.campfirenow.com/users/123.json").
+            with(:headers => {'Authorization'=>[@valid_params[:api_key], 'X'], 'Content-Type'=>'application/json'}).
+            to_return(:status => 200, :body => Yajl::Encoder.encode(:user => @valid_user_cache_data[123]), :headers => {})
+          bot.username_for(123)
+        }
+      end
+      
+      it "should handle HTTP errors fetching user data" do
+        mock_logger
+        bot = a Scamp
+
+        url = "https://#{@valid_params[:subdomain]}.campfirenow.com/users/123.json"
+        EM.run_block {
+          stub_request(:get, url).
+            with(:headers => {'Authorization'=>[@valid_params[:api_key], 'X'], 'Content-Type'=>'application/json'}).
+            to_return(:status => 502, :body => "", :headers => {'Content-Type'=>'text/html'})
+          lambda {bot.username_for(123)}.should_not raise_error
+        }
+        logger_output.should =~ /ERROR.*Couldn't fetch user data for user 123 with url #{url}, http response from API was 502/
+      end
+      
+      it "should handle network errors fetching user data" do
+        mock_logger
+        bot = a Scamp
+        
+        url = "https://#{@valid_params[:subdomain]}.campfirenow.com/users/123.json"
+        EM.run_block {
+          stub_request(:get, url).
+            with(:headers => {'Authorization'=>[@valid_params[:api_key], 'X'], 'Content-Type'=>'application/json'}).to_timeout
+          lambda {bot.username_for(123)}.should_not raise_error
+        }
+        logger_output.should =~ /ERROR.*Couldn't connect to #{url} to fetch user data for user 123/
+      end
+    end
+    
+    context "room operations" do
+      before do
+        @room_list_url = "https://#{@valid_params[:subdomain]}.campfirenow.com/rooms.json"
+        @room_url = "https://#{@valid_params[:subdomain]}.campfirenow.com/room/123.json"
+        @stream_url = "https://streaming.campfirenow.com/room/123/live.json"
+      end
+      
+      it "should fetch a room list" do
+        mock_logger
+        bot = a Scamp
+        
+        EM.run_block {
+          stub_request(:get, @room_list_url).
+            with(:headers => {'Authorization'=>[@valid_params[:api_key], 'X']}).
+            to_return(:status => 200, :body => Yajl::Encoder.encode(:rooms => @valid_room_cache_data.values), :headers => {})
+          bot.send(:populate_room_list)
+        }
+        logger_output.should =~ /DEBUG.*Fetched room list/
+      end
+      
+      it "should handle HTTP errors fetching the room list" do
+        mock_logger
+        bot = a Scamp
+      
+        EM.run_block {
+          # stub_request(:get, url).
+          #   with(:headers => {'Authorization'=>[@valid_params[:api_key], 'X'], 'Content-Type'=>'application/json'}).
+          #   to_return(:status => 502, :body => "", :headers => {'Content-Type'=>'text/html'})
+          stub_request(:get, @room_list_url).
+            with(:headers => {'Authorization'=>[@valid_params[:api_key], 'X']}).
+            to_return(:status => 502, :body => "", :headers => {'Content-Type'=>'text/html'})
+          lambda {bot.send(:populate_room_list)}.should_not raise_error
+        }
+        logger_output.should =~ /ERROR.*Couldn't fetch room list with url #{@room_list_url}, http response from API was 502/
+      end
+      
+      it "should handle network errors fetching the room list" do
+        mock_logger
+        bot = a Scamp
+        EM.run_block {
+          stub_request(:get, @room_list_url).
+            with(:headers => {'Authorization'=>[@valid_params[:api_key], 'X']}).to_timeout
+          lambda {bot.send(:populate_room_list)}.should_not raise_error
+        }
+        logger_output.should =~ /ERROR.*Couldn't connect to url #{@room_list_url} to fetch room list/
+      end
+      
+      it "should fetch individual room data" do
+        mock_logger
+        bot = a Scamp
+        
+        EM.run_block {
+          stub_request(:get, @room_url).
+            with(:headers => {'Authorization'=>[@valid_params[:api_key], 'X']}).
+            to_return(:status => 200, :body => Yajl::Encoder.encode(:room => @valid_room_cache_data[123]), :headers => {})
+          bot.room_name_for(123)
+        }
+        logger_output.should =~ /DEBUG.*Fetched room data for 123/
+      end
+      
+      it "should handle HTTP errors fetching individual room data" do
+        mock_logger
+        bot = a Scamp
+
+        EM.run_block {
+          stub_request(:get, @room_url).
+            with(:headers => {'Authorization'=>[@valid_params[:api_key], 'X']}).
+            to_return(:status => 502, :body => "", :headers => {'Content-Type'=>'text/html'})
+          lambda {bot.room_name_for(123)}.should_not raise_error
+        }
+        logger_output.should =~ /ERROR.*Couldn't fetch room data for room 123 with url #{@room_url}, http response from API was 502/
+      end
+      
+      it "should handle network errors fetching individual room data" do
+        mock_logger
+        bot = a Scamp
+        
+        EM.run_block {
+          stub_request(:get, @room_url).
+            with(:headers => {'Authorization'=>[@valid_params[:api_key], 'X']}).to_timeout
+          lambda {bot.room_name_for(123)}.should_not raise_error
+        }
+        logger_output.should =~ /ERROR.*Couldn't connect to #{@room_url} to fetch room data for room 123/
+      end
+      
+      it "should stream a room"
+      it "should handle HTTP errors streaming a room"
+      it "should handle network errors streaming a room"
+    end
+    
+    context "message operations" do
+      before do
+        @message_post_url = "https://#{@valid_params[:subdomain]}.campfirenow.com/room/123/speak.json"
+      end
+      it "should send a message" do
+        mock_logger
+        bot = a Scamp
+        
+        EM.run_block {
+          stub_request(:post, @message_post_url).
+            with(:headers => {'Authorization'=>[@valid_params[:api_key], 'X'], 'Content-Type' => 'application/json'}).
+            to_return(:status => 200, :body => Yajl::Encoder.encode(:room => @valid_room_cache_data[123]), :headers => {})
+          bot.send(:send_message, 123, "Hi", "Textmessage")
+        }
+        logger_output.should =~ /DEBUG.*Posted message "Hi" to room 123/
+      end
+      
+      it "should handle HTTP errors fetching individual room data" do
+        mock_logger
+        bot = a Scamp
+
+        EM.run_block {
+          stub_request(:post, @message_post_url).
+            with(:headers => {'Authorization'=>[@valid_params[:api_key], 'X'], 'Content-Type' => 'application/json'}).
+            to_return(:status => 502, :body => "", :headers => {'Content-Type'=>'text/html'})
+          lambda {bot.send(:send_message, 123, "Hi", "Textmessage")}.should_not raise_error
+        }
+        logger_output.should =~ /ERROR.*Couldn't post message "Hi" to room 123 using url #{@message_post_url}, http response from the API was 502/
+      end
+      
+      it "should handle network errors fetching individual room data" do
+        mock_logger
+        bot = a Scamp
+        
+        EM.run_block {
+          stub_request(:post, @message_post_url).
+            with(:headers => {'Authorization'=>[@valid_params[:api_key], 'X'], 'Content-Type' => 'application/json'}).to_timeout
+          lambda {bot.send(:send_message, 123, "Hi", "Textmessage")}.should_not raise_error
+        }
+        logger_output.should =~ /ERROR.*Couldn't connect to #{@message_post_url} to post message "Hi" to room 123/
+      end
     end
   end
 
@@ -249,7 +641,7 @@ describe Scamp do
   def mock_logger
     @logger_string = StringIO.new
     @fake_logger = Logger.new(@logger_string)
-    Scamp.any_instance.should_receive(:logger).and_return(@fake_logger)
+    Scamp.any_instance.expects(:logger).returns(@fake_logger)
   end
 
   # Bleurgh

data/spec/spec_helper.rb

@@ -1,2 +1,8 @@
 require File.expand_path("../lib/scamp", File.dirname(__FILE__))
-require 'mocha'
+
+require 'mocha'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.mock_framework = :mocha
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scamp
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-20 00:00:00.000000000Z
+date: 2011-09-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &2152335860 !ruby/object:Gem::Requirement
+  requirement: &2152463380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0.beta.4
   type: :runtime
   prerelease: false
-  version_requirements: *2152335860
+  version_requirements: *2152463380
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &2152335100 !ruby/object:Gem::Requirement
+  requirement: &2152461660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.8.3
   type: :runtime
   prerelease: false
-  version_requirements: *2152335100
+  version_requirements: *2152461660
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &2152334240 !ruby/object:Gem::Requirement
+  requirement: &2152459120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0.beta.4
   type: :runtime
   prerelease: false
-  version_requirements: *2152334240
+  version_requirements: *2152459120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152333240 !ruby/object:Gem::Requirement
+  requirement: &2152457780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2152333240
+  version_requirements: *2152457780
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2152332420 !ruby/object:Gem::Requirement
+  requirement: &2152454380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,18 @@ dependencies:
         version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *2152332420
+  version_requirements: *2152454380
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &2152453060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.6
+  type: :development
+  prerelease: false
+  version_requirements: *2152453060
 description: Eventmachine based Campfire bot framework
 email:
 - will@willj.net
@@ -81,15 +92,16 @@ files:
 - examples/bot.rb
 - lib/scamp.rb
 - lib/scamp/action.rb
-- lib/scamp/channels.rb
 - lib/scamp/connection.rb
 - lib/scamp/matcher.rb
+- lib/scamp/messages.rb
+- lib/scamp/rooms.rb
 - lib/scamp/users.rb
 - lib/scamp/version.rb
 - scamp.gemspec
 - spec/lib/scamp_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/wjessop/Scamp
 licenses: []
 post_install_message: 
 rdoc_options: []