ceiling_cat 0.0.2 → 0.0.6

data/lib/ceiling_cat.rb

@@ -1,4 +1,4 @@
 # General
-%w{version setup connection errors event user room plugins/base services/campfire storage/base storage/yaml}.each do |file|
+%w{version setup connection errors event user room plugins/base services/campfire storage/base storage/hash storage/yaml}.each do |file|
   require "ceiling_cat/#{file}"
 end

data/lib/ceiling_cat/event.rb

@@ -23,7 +23,7 @@ module CeilingCat
     end
     
     def type # assume that all messages are just text unless the specific room type overrides it.
-      :chat
+      @type || :chat
     end
   end
 end

data/lib/ceiling_cat/plugins/base.rb

@@ -53,7 +53,7 @@ module CeilingCat
       end
       
       def self.store
-        CeilingCat::Setup.config.storage
+        CeilingCat::Setup.config ? CeilingCat::Setup.config.storage : CeilingCat::Storage::Hash
       end
 
       def body

data/lib/ceiling_cat/plugins/call_and_response.rb

@@ -3,11 +3,11 @@ module CeilingCat
     class CallAndResponse < CeilingCat::Plugin::Base
       def handle
         if event.type == :chat
-          super
           if match = self.class.list.find{|car| body =~ Regexp.new(Regexp.escape(car[:call]),true) }
             reply match[:response]
             return nil
           end
+          super
         end
         
       end
@@ -43,7 +43,7 @@ module CeilingCat
       end
 
       def add
-        message = body_without_nick_or_command("add call").split
+        message = body_without_nick_or_command("add call")
         call, response = message.split("|")
         if self.class.add(:call => call.strip,:response => response.strip)
           reply "Call and Response added."
@@ -67,7 +67,7 @@ module CeilingCat
         store["call_and_responses"] = (store["call_and_responses"] + [{:call => opts[:call], :response => opts[:response]}]).uniq
       end
 
-      def self.remove(phrase)
+      def self.remove(call)
         store["call_and_responses"] ||= []
         store["call_and_responses"] = store["call_and_responses"].reject{|car| car[:call].downcase == call.downcase }
       end

data/lib/ceiling_cat/plugins/campfire_account_monitor.rb

@@ -12,7 +12,9 @@ module CeilingCat
         if room.connection.config.service.downcase == "campfire" && event.type == :entrance
           user_count = room.connection.total_user_count
           max_users = room.connection.config.max_users || 100
-          room.plugin("notifo").new(@event).deliver("#{user_count} of #{max_users} max  connections to Campfire.") if room.plugin_installed?("notifo") && user_count > max_users-2
+          if room.plugin_installed?("notifo") && user_count > max_users-2
+            room.plugin("notifo").new(@event).deliver("#{user_count} of #{max_users} max connections to Campfire.") 
+          end
         end
         super
       end

data/lib/ceiling_cat/plugins/days.rb

@@ -1,6 +1,6 @@
 module CeilingCat
   class NotADateError < CeilingCatError; end
-  
+
   module Plugin
     class Days < CeilingCat::Plugin::Base
       def self.commands
@@ -62,8 +62,7 @@ module CeilingCat
           end
         end
 
-        store["holidays"] ||= []
-        store["holidays"] = (store["holidays"] + dates).uniq
+        store["holidays"] = (holidays + dates).uniq
       end
 
       def self.remove_from_holidays(days)
@@ -75,13 +74,12 @@ module CeilingCat
           end
         end
         
-        store["holidays"] ||= []
-        store["holidays"] = store["holidays"] - dates
+        store["holidays"] = holidays - dates
       end
       
       def self.is_a_holiday?(date=Date.today)
         if is_a_date?(date)
-          store["holidays"].include? Date.parse(date.to_s)
+          holidays.include? Date.parse(date.to_s)
         else
           raise NotADateError
         end

data/lib/ceiling_cat/plugins/greeter.rb

@@ -2,7 +2,7 @@ module CeilingCat
   module Plugin
     class Greeter < CeilingCat::Plugin::Base
       def handle
-        message = []
+        messages = []
 
         if event.type == :entrance
           members = room.users_in_room(:type => "member")
@@ -12,7 +12,7 @@ module CeilingCat
           elsif user.is_registered?
             messages << "Nice to see you again #{user.name}"
           end
-          reply message unless message.empty?
+          reply messages unless messages.empty?
         elsif event.type == :chat
           super
         end

data/lib/ceiling_cat/plugins/notifo.rb

@@ -18,14 +18,19 @@ module CeilingCat
                             :body => { :to => user, :msg => message },
                             :basic_auth => {:username => store["notifo_credentials"][:username], :password => store["notifo_credentials"][:api_secret]})
           end
-        else
-          debugger
-          puts "here"
         end
       end
 
+      def self.active?
+        if store["notifo_credentials"] && store["notifo_credentials"][:username].present? && store["notifo_credentials"][:api_secret].present? && Array(store["notifo_users"]).size > 0
+          true
+        else
+          false
+        end
+      end
+      
       def active?
-        store["notifo_credentials"] && store["notifo_credentials"][:username].present? && store["notifo_credentials"][:api_secret].present? && Array(store["notifo_users"]).size > 0
+        self.class.active?
       end
 
       def self.name
@@ -40,6 +45,11 @@ module CeilingCat
         store["notifo_users"] ||= []
         store["notifo_users"] = (Array(store["notifo_users"]) + Array(users)).uniq
       end
+      
+      def self.remove_users(users)
+        store["notifo_users"] ||= []
+        store["notifo_users"] = (Array(store["notifo_users"]) - Array(users)).uniq
+      end
 
       def self.set_credentials(username, api_secret)
         store["notifo_credentials"] = {:username => username, :api_secret => api_secret}
@@ -53,8 +63,7 @@ module CeilingCat
 
       def remove_users
         users = body_without_nick_or_command("remove notifo users").split(" ")
-        store["notifo_users"] ||= []
-        store["notifo_users"] = store["notifo_users"] - users
+        self.class.remove_users(users)
         reply "#{users.join(" ")} removed from notifo alerts."
       end
 

data/lib/ceiling_cat/room.rb

@@ -43,10 +43,6 @@ module CeilingCat
       @connection.storage
     end
 
-    def debug_mode?
-      !store["debug_mode"].nil? && store["debug_mode"] == "true"
-    end
-
     def plugin_descriptions(show_private=false)
       messages = []
       plugins.each do |plugin|

data/lib/ceiling_cat/services/campfire/connection.rb

@@ -4,7 +4,7 @@ module CeilingCat
   module Campfire
     class Connection < CeilingCat::Connection
       def initialize(config)
-        @config=config
+        super
         @config.ssl ||= "true"
       end
 

data/lib/ceiling_cat/services/campfire/event.rb

@@ -4,11 +4,11 @@ module CeilingCat
       
       def type
         case @type
-        when "EnterMessage"
+        when "EnterMessage", :entrance
           :entrance
-        when "TextMessage"
+        when "TextMessage", :chat
           :chat
-        when "LeaveMessage", "KickMessage"
+        when "LeaveMessage", "KickMessage", :exit
           :exit
         end
       end

data/lib/ceiling_cat/services/campfire/room.rb

@@ -1,24 +1,25 @@
 module CeilingCat
   module Campfire
     class Room < CeilingCat::Room
+      attr_accessor :campfire_room
 
       def initialize(opts={})
         super
         @campfire_room = @connection.campfire.find_room_by_name(opts[:room_name])
       end
-      
+
       def watch
         puts "Watching room..."
         setup_interrupts
         begin
           loop do
             begin
-              Timeout::timeout(60) do
+              Timeout::timeout(300) do
                 @campfire_room.listen do |event|
                   begin
                     if event[:type] != "TimestampMessage"
                       user = CeilingCat::User.new(event[:user][:name], :id => event[:user][:id], :role => event[:user][:type])
-                    
+
                       unless is_me?(user) # Otherwise CC will talk to itself
                         event = CeilingCat::Campfire::Event.new(self,event[:body], user, :type => event[:type])
                         event.handle
@@ -26,19 +27,20 @@ module CeilingCat
                       end
                     end
                   rescue => e
-                    say "An error occurred with Campfire: #{e}" if debug_mode?
                     raise e
                   end
                 end
               end
             rescue Timeout::Error
-              puts "timeout! trying again..."
-              retry
+              retry # Reconnect regularly to keep CC talking with Campfire
             end
           end
         rescue Faraday::Error::ParsingError
           puts "Error parsing response. Campfire may be down."
           break
+        rescue HTTP::Parser::Error
+          puts "Trouble parsing the HTTP response."
+          retry
         rescue ReloadException => e
           retry
         rescue NoMethodError => e
@@ -49,22 +51,21 @@ module CeilingCat
           retry
         rescue StandardError => e
           puts e.class
-          debugger if debug_mode?
           e.backtrace.each do |line|
             puts "Backtrace: #{line}"
           end
           retry
         end
       end
-      
+
       def is_me?(user)
         user.id == me.id
       end
-      
+
       def me
         @me ||= CeilingCat::User.new(@connection.campfire.me[:name], :id => @connection.campfire.me[:id], :role => @connection.campfire.me[:type])
       end
-      
+
       def users_in_room(opts={})
         if opts[:reload] || @users_in_room.nil?
           puts "Requesting user list"
@@ -83,13 +84,13 @@ module CeilingCat
           end
         end
       end
-            
+
       def say(something_to_say)
         Array(something_to_say).each do |line|
           @campfire_room.speak(line)
         end
       end
-      
+
       def setup_interrupts
         trap('INT') do
           puts "Leaving room...."

data/lib/ceiling_cat/storage/hash.rb

@@ -0,0 +1,29 @@
+module CeilingCat
+  module Storage
+    class Hash < CeilingCat::Storage::Base
+      class << self
+
+        # Stores +v+ in the hash.
+        def []=(k, v)
+          internal[k] = v
+        end
+
+        # Returns the value at key +k+.
+        def [](k)
+          internal[k]
+        end
+
+        private
+        # The hash the data is being stored in.
+        def internal
+          @internal ||= {}
+        end
+
+        def clear
+          @internal = nil
+        end
+
+      end
+    end
+  end
+end

data/lib/ceiling_cat/version.rb

@@ -1,3 +1,3 @@
 module CeilingCat
-  VERSION = "0.0.2"
+  VERSION = "0.0.6"
 end

data/setup/Rakefile

@@ -4,20 +4,25 @@ namespace :plugin do
     raise "You need to set a name! `rake plugin:create name=[plugin_name]`" unless ENV["name"]
     name = ENV["name"].downcase
     file = File.join("plugins", "#{name}.rb")
+      test_file = File.join("spec", "plugins", "#{name}_spec.rb")
 
-    unless File.exists? file
-      contents = plugin_base(name)
-      File.open(file, 'w') {|f| f.write(contents) }
-      puts "Plugin '#{name}' created at #{file}."
-      puts "Make sure you require it in your Chatfile and add it to your config.plugins so it runs."
-    else
-      puts "A plugin named '#{name}' already exists. Try another name."
+      unless File.exists?(file) || File.exists?(test_file)
+        contents = plugin_base(name)
+        File.open(file, 'w') {|f| f.write(contents) }
+
+        test_contents = plugin_test_base(name).gsub('\#','#')
+        File.open(test_file, 'w') {|f| f.write(test_contents) }
+
+        puts "Plugin '#{name}' created at #{file}."
+        puts "Make sure you require it in your Chatfile and add it to your config.plugins so it runs."
+      else
+        puts "A plugin named '#{name}' already exists. Try another name."
+      end
     end
   end
-end
 
-def plugin_base(name)
-%Q{module CeilingCat
+  def plugin_base(name)
+  %Q{module CeilingCat
   module Plugin
     class #{name.camelize} < CeilingCat::Plugin::Base
       # See lib/ceiling_cat/plugins/base.rb for the methods available by default.
@@ -56,6 +61,84 @@ def plugin_base(name)
   end
 end
 }
+  end
+
+  def plugin_test_base(name)
+%Q{require 'plugins/#{name}'
+
+describe "#{name.camelize}" do
+  before(:each) do
+    CeilingCat::Storage::Hash.send "clear" # Clear the calls and response each time.
+
+    user = "user"
+    token = "1234abcd"
+    plugins = [CeilingCat::Plugin::#{name.camelize}]
+
+    FakeWeb.register_uri(:get, "https://\#{token}:X@\#{user}.campfirenow.com/rooms.json", :body => fixture('campfire/rooms.json'), :status => ["200"])
+    FakeWeb.register_uri(:get, "https://\#{token}:X@\#{user}.campfirenow.com/users/me.json", :body => fixture('campfire/me.json'), :status => ["200"])
+
+    @connection = CeilingCat::Campfire::Connection.new(OpenStruct.new({:service => 'campfire', :username => user, :token => token, :room => 'Room 1', :plugins => plugins}))
+    @room = CeilingCat::Campfire::Room.new(:connection => @connection, :room_name => @connection.config.room)
+  end
+
+  describe "base methods" do
+    # Tests for any methods that run outside of a command
+  end
+
+  describe "commands" do
+    # Tests for commands
+    describe "from a guest user" do
+      before(:each) do
+        @guest_user = CeilingCat::User.new("Guest", :id => 12345, :role => "guest")
+      end
+
+      describe "calling the 'default' command" do
+        it "should not do or say anything" do
+          event = CeilingCat::Event.new(@room,"!#{name}", @guest_user)
+          @room.should_not_receive(:say)
+          CeilingCat::Plugin::#{name.camelize}.new(event).handle
+        end
+      end
+    end
+
+    describe "from a registered user" do
+      before(:each) do
+        @registered_user = CeilingCat::User.new("Guest", :id => 12345, :role => "member")
+      end
+
+      describe "calling the 'default' command" do
+        it "should call the 'default' method" do
+          event = CeilingCat::Event.new(@room,"!#{name}", @registered_user)
+          @room.should_receive(:say).with("You've created the '#{name.capitalize}' plugin. Now make it do something awesome!")
+          CeilingCat::Plugin::#{name.camelize}.new(event).handle
+        end
+      end
+    end
+  end
+
+  describe 'entrance and exit' do
+    # Tests for things to run when a user enters or exits the room
+    describe "entering the room" do
+      before(:each) do
+        @registered_user = CeilingCat::User.new("Guest", :id => 12345, :role => "member", :type => :entrance)
+      end
+
+      it "should do something" do
+      end
+    end
+
+    describe "exiting the room" do
+      before(:each) do
+        @registered_user = CeilingCat::User.new("Guest", :id => 12345, :role => "member", :type => :exit)
+      end
+
+      it "should do something" do
+      end
+    end
+  end
+end
+}
+  end
 end
 
 class String

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ceiling_cat
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Chris Warren
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-18 00:00:00 Z
+date: 2011-08-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: tinder
@@ -65,6 +65,50 @@ dependencies:
         version: 0.1.8
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
 description: Ceiling Cat is watching you chat. A Campfire chat bot!
 email: 
 - chris@zencoder.com
@@ -92,9 +136,9 @@ files:
 - lib/ceiling_cat/plugins/call_and_response.rb
 - lib/ceiling_cat/plugins/campfire_account_monitor.rb
 - lib/ceiling_cat/plugins/days.rb
-- lib/ceiling_cat/plugins/general.rb
 - lib/ceiling_cat/plugins/greeter.rb
 - lib/ceiling_cat/plugins/notifo.rb
+- lib/ceiling_cat/storage/hash.rb
 - lib/ceiling_cat/storage/yaml.rb
 - lib/ceiling_cat/services/campfire.rb
 - lib/ceiling_cat/services/campfire/connection.rb
@@ -104,7 +148,7 @@ files:
 homepage: http://zencoder.com
 licenses: []
 
-post_install_message: "  ********************************************************************************\n    Run `ceiling_cat setup` to create a Chatfile and a Rakefile - everything you\n    need to start watching your chats and making ceiling_cat do your bidding!\n  \n    Run `rake plugin:create name=plugin_name` to generate a new plugin.\n\n    Update your Chatfile with your credentials and you'll be ready to go!\n  ********************************************************************************\n"
+post_install_message: "  ********************************************************************************\n    Run `ceiling_cat setup` to create a Chatfile and a Rakefile - everything you\n    need to start watching your chats and making ceiling_cat do your bidding!\n\n    Update your Chatfile with your credentials and you'll be ready to go!\n\n    Want Ceiling Cat to do something special just for you?\n    Run `rake plugin:create name=plugin_name` to generate a new plugin.\n  ********************************************************************************\n"
 rdoc_options: []
 
 require_paths: 

data/lib/ceiling_cat/plugins/general.rb

@@ -1,56 +0,0 @@
-module CeilingCat
-  module Plugin
-    class General < CeilingCat::Plugin::Base
-      # See lib/ceiling_cat/plugins/base.rb for the methods available by default.
-      # Plugins are run in the order they are listed in the Chatfile.
-      # When a plugin returns anything other than nil the plugin execution chain is halted.
-      # If you want your plugin to do something but let the remaining plugins execute, return nil at the end of your method.
-
-      # handle manages a plugin's entire interaction with an event.
-      # If you only want to execute commands - "![command]" - leave handle alone (or remove it and define commands below)
-      def handle
-        super
-      end
-
-      # If you want the plugin to run when certain text is sent use commands instead of handle.
-      # Ceiling Cat will watch for "![command]" or "[name]: [command" and execute the method for that command.
-      def self.commands
-        [{:command => "debugger", :description => "Load the debugger", :method => "run_debug", :public => false},
-         {:command => "enable debug", :description => "Enable debuggers", :method => "enable_debug", :public => false},
-         {:command => "disable debug", :description => "Disable debuggers", :method => "disable_debug", :public => false}]
-      end
-
-      def self.description
-        "General tasks for development"
-      end
-
-      def self.name
-        "General"
-      end
-
-      def self.public?
-        false
-      end
-
-      def run_debug
-        if room.debug_mode?
-          reply "Opening debugger in terminal"
-          debugger
-        else
-          reply "Debugging is disabled - !enable debug to activate it."
-        end
-      end
-      
-      def enable_debug
-        store["debug_mode"] ||= "true"
-        reply "debugging enabled"
-      end
-      
-      def disable_debug
-        store["debug_mode"] ||= "false"
-        reply "debugging disabled"
-      end
-    end
-  end
-end
-