numbr5 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Pat Allan
+
+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.textile

@@ -0,0 +1,33 @@
+h1. Number 5
+
+A wary IRC bot, tracking people thanking other people, and tallying those thanks as beers owed.
+
+h2. Installation
+
+<pre><code>gem install numbr5</code></pre>
+
+h2. Usage
+
+Specify a channel name without the hash suffix.
+
+<pre><code>numbr5 railscamp</code></pre>
+
+In the channel, if you thank someone (using emotes/actions) for something, then you have a beer logged from you to that person.
+
+<pre><code>/me thanks ben_a for running rails camps</code></pre>
+
+Currently, the order must be "/me thanks [username] [reason]". If you can figure out a way to make this flexible and smart, please fork.
+
+You'll also need the website running as well, otherwise there'll be no API around to use.
+
+h2. Limitations
+
+Currently hard-coded to irc.freenode.net on port 6667, and only accepts one channel. I'd like it to support multiple channels, and specify the server, so multiple bots can be running for different servers.
+
+It's also expecting the corresponding website to be hosted locally and running on port 3000. This is far from ideal - a patch to make the bot understand the concepts of environments would be fantastic.
+
+What also would be cool is the concept of a source for each thank-you - ie: IRC/channel. This way, the service could be extended beyond just IRC (although there's already a few Twitter-equivalents out there).
+
+h2. Copyright
+
+Copyright (c) 2009 Pat Allan, and released under an MIT License. Heavily inspired by "Lachie Cox's":http://smartbomb.com.au/ "numbr5 bot":http://github.com/lachie/numbr5 for the #roro channel on irc.freenode.net. This new version was initially built at "Rails Camp UK 2":http://railscamps.com, October 2009.

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/numbr5

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'numbr5'
+
+EventMachine.run do
+  EventMachine.connect 'irc.freenode.net', 6667, Numbr5::Bot, *ARGV
+end

data/config/cucumber.yml

@@ -0,0 +1 @@
+default: features

data/lib/numbr5.rb

@@ -0,0 +1,9 @@
+require 'eventmachine'
+require 'rest_client'
+require 'json'
+
+require 'numbr5/bot'
+
+module Numbr5
+  #
+end

data/lib/numbr5/bot.rb

@@ -0,0 +1,90 @@
+module Numbr5
+  class Bot < EventMachine::Connection
+    include EventMachine::Protocols::LineText2
+    
+    attr_reader :channel
+    
+    def initialize(channel)
+      @channel = channel
+    end
+    
+    def receive_data(data)
+      case data
+      when /no ident/i
+        identify_and_join
+      when /^PING /
+        pong data.gsub(/^PING /i, '')
+      when / PRIVMSG numbr5 /
+        match = data.match(/:([^!]+).+ PRIVMSG numbr5 :(.+)/)
+        private_message match[1], match[2]
+      when / PRIVMSG ##{channel}/
+        match = data.match(/:([^!]+).+ PRIVMSG ##{channel} :(.+)$/)
+        public_message match[1], match[2]
+      end
+    end
+    
+    private
+    
+    def send_data(data)
+      puts "SENDING #{data}"
+      super(data + "\r\n")
+    end
+    
+    def identify_and_join
+      send_data "NICK numbr5"
+      send_data "USER numbr5 0 * :Number 5"
+      send_data "JOIN ##{channel}"
+    end
+    
+    def pong(data = 'irc')
+      send_data "PONG #{data}"
+    end
+    
+    def private_message(user, message)
+      case message.strip
+      when 'stats'
+        stats user
+      else
+        send_data "PRIVMSG #{user} :hello"
+      end
+    end
+    
+    def public_message(user, message)
+      if message[/^.ACTION/]
+        match = message.match(/^.ACTION (\w+)($| .+$)/)
+        action user, match[1], match[2].strip
+      end
+    end
+    
+    def action(user, action, message)
+      case action
+      when 'thanks'
+        match = message.match(/^(\w+) (.+)$/)
+        thank user, match[1], match[2]
+      end
+    end
+    
+    def thank(from, to, reason)
+      if from == to
+        send_data "PRIVMSG ##{channel} :#{from}: no masturbation!"
+        return
+      end
+      
+      RestClient.post 'http://localhost:3000/api/beers.json', :beer => {
+        :from   => from,
+        :to     => to,
+        :reason => reason
+      }
+      send_data "PRIVMSG ##{channel} :#{from}: you owe #{to} a beer #{reason}"
+    end
+    
+    def stats(user)
+      json = RestClient.get "http://localhost:3000/api/users/#{user}.json"
+      json = JSON.parse json
+      
+      send_data "PRIVMSG #{user} :You owe #{json['user']['beers_owing']} beers and are owed #{json['user']['beers_owed']} beers"
+    rescue RestClient::ResourceNotFound
+      send_data "PRIVMSG #{user} :You owe 0 beers and are owed 0 beers"
+    end
+  end
+end

data/spec/numbr5/bot_spec.rb

@@ -0,0 +1,136 @@
+require 'spec/spec_helper'
+
+describe Numbr5::Bot do
+  before :each do
+    @bot = Numbr5::Bot.new(:event_machine_placeholder, 'spec')
+    @bot.stub!(:send_data => true)
+  end
+  
+  describe '#receive_data' do
+    context 'No Ident response' do
+      it "should send the user nickname" do
+        @bot.should_receive(:send_data).with("NICK numbr5")
+        
+        @bot.receive_data '*** No Ident response'
+      end
+      
+      it "should send the user details" do
+        @bot.should_receive(:send_data).with("USER numbr5 0 * :Number 5")
+        
+        @bot.receive_data '*** No Ident response'
+      end
+      
+      it "should join the given channel" do
+        @bot.should_receive(:send_data).with("JOIN #spec")
+        
+        @bot.receive_data '*** No Ident response'
+      end
+    end
+    
+    context 'PING' do
+      it "should respond with a pong" do
+        @bot.should_receive(:send_data) do |data|
+          data.should match(/^PONG /)
+        end
+        
+        @bot.receive_data 'PING :default'
+      end
+      
+      it "should direct the pong at a server" do
+        @bot.should_receive(:send_data) do |data|
+          data.should match(/PONG :default/)
+        end
+        
+        @bot.receive_data 'PING :default'
+      end
+      
+      it "should respect the given server name" do
+        @bot.should_receive(:send_data) do |data|
+          data.should match(/PONG :spec/)
+        end
+        
+        @bot.receive_data 'PING :spec'
+      end
+    end
+    
+    context 'PRIVMSG numbr5' do
+      it "should respond with a private message" do
+        @bot.should_receive(:send_data) do |data|
+          data.should match(/^PRIVMSG/)
+        end
+        
+        @bot.receive_data ':pat!~pat@freelancing-god PRIVMSG numbr5 :hello?'
+      end
+      
+      it "should direct the message to the sender" do
+        @bot.should_receive(:send_data) do |data|
+          data.should match(/^PRIVMSG pat/)
+        end
+        
+        @bot.receive_data ':pat!~pat@freelancing-god PRIVMSG numbr5 :hello?'
+      end
+      
+      it "should provide beer stats if asked for" do
+        RestClient.stub!(
+          :get => '{"user":{"name":"pat","beers_owing":2,"beers_owed":0}}'
+        )
+        @bot.should_receive(:send_data).with('PRIVMSG pat :You owe 2 beers and are owed 0 beers')
+        
+        @bot.receive_data ':pat!~pat@freelancing-god PRIVMSG numbr5 :stats'
+      end
+      
+      it "should handle 404 errors if the user doesn't have any stats" do
+        RestClient.stub(:get).and_raise(RestClient::ResourceNotFound)
+        
+        @bot.should_receive(:send_data).with('PRIVMSG pat :You owe 0 beers and are owed 0 beers')
+        
+        @bot.receive_data ':pat!~pat@freelancing-god PRIVMSG numbr5 :stats'
+      end
+    end
+    
+    context 'PRIVMSG #channel' do
+      before :each do
+        RestClient.stub!(:post => true)
+      end
+      
+      it "should not do anything if there was no action" do
+        @bot.should_not_receive(:send_data)
+        
+        @bot.receive_data ':pat!~pat@freelancing-god PRIVMSG #spec :cough'
+      end
+      
+      it "should ignore actions that aren't thanks" do
+        @bot.should_not_receive(:send_data)
+        
+        @bot.receive_data ":pat!~pat@freelancing-god PRIVMSG #spec :\001ACTION wave"
+      end
+      
+      it "should confirm thanks" do
+        @bot.should_receive(:send_data).
+          with("PRIVMSG #spec :pat: you owe user a beer for action")
+        @bot.receive_data ":pat!~pat@freelancing-god PRIVMSG #spec :\001ACTION thanks user for action"
+      end
+      
+      it "should create the beer via the API" do
+        RestClient.should_receive(:post) do |url, payload|
+          url.should == 'http://localhost:3000/api/beers.json'
+          payload.should == {
+            :beer => {
+              :from   => 'pat',
+              :to     => 'user',
+              :reason => 'for action'
+            }
+          }
+        end
+        
+        @bot.receive_data ":pat!~pat@freelancing-god PRIVMSG #spec :\001ACTION thanks user for action"
+      end
+      
+      it "should send a warning if the from and to users are different" do
+        @bot.should_receive(:send_data).
+          with("PRIVMSG #spec :pat: no masturbation!")
+        @bot.receive_data ":pat!~pat@freelancing-god PRIVMSG #spec :\001ACTION thanks pat for action"
+      end
+    end
+  end
+end

data/spec/numbr5_spec.rb

@@ -0,0 +1,5 @@
+require 'spec/spec_helper'
+
+describe Numbr5 do
+  #
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'numbr5'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  #
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: numbr5
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-06 00:00:00 +11:00
+default_executable: numbr5
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.12.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A multi-server bot that tracks thanks between accounts
+email: pat@freelancing-gods.com
+executables: 
+- numbr5
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- LICENSE
+- README.textile
+- VERSION
+- bin/numbr5
+- lib/numbr5.rb
+- lib/numbr5/bot.rb
+has_rdoc: true
+homepage: http://github.com/freelancing-god/numbr5
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "Number 5: Universal Thanking Bot"
+test_files: 
+- config/cucumber.yml
+- spec/numbr5/bot_spec.rb
+- spec/numbr5_spec.rb
+- spec/spec_helper.rb