beerbot 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 878a3f275715d57e32aeeb9778313111ec256f08
-  data.tar.gz: 9c173bbd514a2395150c80ddcdf65ebfdcd0a03b
+  metadata.gz: 36f864e883bbc7374b90bc57465a35e14ebc9f7d
+  data.tar.gz: df19b2f182e991e2db92400d0dd29764a751f237
 SHA512:
-  metadata.gz: 4dca80dd8d697d5cb1edd5e7fc4c0a56814126e9796ebff2df2a8de92572c2e77682ee37702e497804b554f8980d9b883957bb22fa2d193f8a5d2651ba7cdf83
-  data.tar.gz: 505d47e74bcf67876065b7e9575402f011d2fa662a967999b7adc1ea4856008f37589710f367623a72c6130538d2a13e2c561efb770456080fce998f2a4fc944
+  metadata.gz: fa4f36bd206392242e866a96756e57a38a8e9178bb1928b4eaf6f45ec608b6a368cea96c19aab781f7e2b7c71c12b0a5f52502741dca3f6755df2f2941a54547
+  data.tar.gz: 4201d0fc06a58b7cc6cdd6dbb91ef7d680600eefb52b6f74963cd3753dbbe41b3945099d45ddd77292b1b3817da894cbc3efa04bf6c669228aef4398c816f7e6

data/lib/BeerBot/00.utils/DataFile.rb

@@ -6,20 +6,34 @@
 # see <http://www.gnu.org/licenses/>.
 
 require 'json'
+
 module BeerBot
+
   module Utils
+
     # A class that loads data from a file and allows you to access it
     # using the #data method.
     #
     # If the file is updated (after >=1 sec), #data will reload.
+
     class DataFile
+
       attr_reader :reloaded  # true if last call to #data reloaded file
+
+      def self.create! filepath
+        File.open(filepath,'w'){}
+        self.new(filepath)
+      end
+
       def initialize filepath
         @filepath = filepath
         @data = File.read(filepath)
         @mtime = File.stat(filepath).mtime
         @reloaded = false
       end
+
+      # Load data from file.
+
       def data
         @reloaded = false
         return @data unless File.exists?(@filepath)
@@ -31,14 +45,33 @@ module BeerBot
         @reloaded = true
         @data
       end
+
+      def save thing
+        File.open(@filepath,'w') {|f|
+          f.write(thing)
+        }
+      end
+
     end
+
     # Specialised DataFile that parses json.
+
     class JsonDataFile < DataFile
+
       attr_reader :json
+
+      def self.create! filepath,data={}
+        File.open(filepath,'w') {|f| f.puts(data.to_json)}
+        self.new(filepath)
+      end
+
       def initialize filepath
         super
         @json = JSON.parse(@data)
       end
+
+      # Load data from file and parse as json data.
+
       def data
         super
         begin
@@ -51,6 +84,20 @@ module BeerBot
         end
         @json
       end
+
+      # Save thing back to file.
+      #
+      # Thing is assumed to be a hash or array that we call to_json on.
+
+      def save thing=nil
+        if thing.nil? then
+          thing = @json  # the thing self.data returns
+        end
+        super(thing.to_json)
+      end
+
     end
+
   end
+
 end

data/lib/BeerBot/00.utils/world/IRCWorld.rb

@@ -21,11 +21,6 @@ module BeerBot
         nick.sub(/^@/,'')
       end
 
-      def user nick
-        nick = self.remove_op(nick)
-        super
-      end
-
       def nick oldnick,nick
         oldnick = self.remove_op(oldnick)
         nick = self.remove_op(nick)
@@ -41,6 +36,11 @@ module BeerBot
         nick = self.remove_op(nick)
         super
       end
+
+      def quit nick
+        nick = self.remove_op(nick)
+        super
+      end
     end
 
   end

data/lib/BeerBot/00.utils/world/World.rb

@@ -25,26 +25,11 @@ module BeerBot
 
       end
 
-      # Fetch a user.
-      def user user
-        if self[:users].has_key?(user) then
-          self[:users][user]
-        else
-        end
-      end
-
-      # Fetch a channel.
-      def channel channel
-        if self[:channels].has_key?(channel) then
-          self[:channels][channel]
-        else
-        end
-      end
-
       # Someone joins channel.
       def join nick,channel
         self[:channels][channel][:users].add(nick)
         self[:users][nick][:channels].add(channel)
+        self[:users][nick][:quit] = false
         self
       end
 
@@ -58,9 +43,9 @@ module BeerBot
       # Someone changes nick.
       def nick oldnick,nick
         self[:channels].each_pair{|name,chan|
-          if chan.member?(oldnick) then
-            chan.delete(oldnick)
-            chan.add(nick)
+          if chan[:users].member?(oldnick) then
+            chan[:users].delete(oldnick)
+            chan[:users].add(nick)
           end
         }
         self[:users][nick] = self[:users][oldnick]
@@ -72,8 +57,13 @@ module BeerBot
         self
       end
 
-      # TODO: User quits altogether.
-      def quit user
+      def quit nick
+        self[:channels].each_pair{|name,chan|
+          chan[:users].delete(nick)
+        }
+        self[:users][nick][:channels] = Set.new
+        self[:users][nick][:quit] = true
+        self
       end
 
     end

data/lib/BeerBot/01.connect/IRCConnection.rb

@@ -7,7 +7,6 @@
 
 require 'socket'
 require 'set'
-require_relative 'Connection'
 
 module BeerBot
 
@@ -17,7 +16,7 @@ module BeerBot
   # We also do some low-level bookkeeping, like returning pong and
   # looking for welcome message.
 
-  class IRCConnection < Connection
+  class IRCConnection
 
     # Queue containing received messages from the server.
     attr_accessor :queue,:writeq,:readyq

data/lib/BeerBot/02.protocols/irc.rb

@@ -9,8 +9,121 @@ module BeerBot
 
   module Protocol
 
+    # IRC Protcol module.
+    #
+    # Main method is parse, whose job is to receive incoming irc
+    # strings and convert to a generalised format that higher layers
+    # like the dispatcher can use.
+
     module IRC
 
+      # Parse raw irc string and then yield or return a generic
+      # representation of the event.
+      #
+      # Returns [event,*args]
+      #
+      # Parse's job is to take the constituents parts of an irc
+      # message, identify the type of event and return a generic
+      # representation of it.
+      #
+      # So for instance, an irc privmsg (message) is represented as
+      #   [:msg,from,to,msg]
+      # 
+      # Note that connection readiness and PONG protocol are handled by
+      # the irc connection, not here.
+
+      def self.parse str
+
+        m = IRCMessage.new(str)
+        result = []
+
+        case m[:command]
+
+        when 'NICK'  # change of nick
+          case s=m.check(:prefix,:nick,:trailing)
+          when Symbol
+            puts "* NICK expected #{s}"
+            return nil
+          end
+          old = m[:prefix][:nick]
+          nick = m[:trailing]
+          result = [:nick,old,nick]
+
+
+        when 'QUIT' # someone leaves irc
+          case s=m.check(:prefix,:nick,:trailing)
+          when Symbol
+            puts "* QUIT expected #{s}"
+            return nil
+          end
+          nick = m[:prefix][:nick]
+          msg = m[:trailing]
+          result = [:quit,nick,msg]
+
+        when 'PART' # someone leaves channel
+          case s=m.check(:prefix,:nick,:params)
+          when Symbol
+            puts "* PART expected #{s}"
+            return nil
+          end
+          if channel=m[:params][0] then
+          elsif channel=m[:trailing].strip.split(/\s+/).first then
+          else
+            channel=nil
+            puts "* PART can't determine what is being parted from: '#{str}'"
+            return nil
+          end
+          nick = m[:prefix][:nick]
+          result = [:part,nick,channel]
+
+        when 'INVITE' # someone invites us, oo
+          ournick = m[:params][0]
+          chan = m[:trailing].strip.split(/\s+/).first
+          result = [:invite,chan]
+
+        when 'JOIN' # someone joins channel
+          case s=m.check(:prefix,:nick,:trailing)
+          when Symbol
+            puts "* JOIN expected #{s}"
+            return nil
+          end
+          channel = m[:trailing]
+          nick = m[:prefix][:nick]
+          result = [:join,nick,channel]
+
+        when '353'  # channel user list when we join the channel
+          case s=m.check(:params,:trailing)
+          when Symbol
+            puts "* 353 expected #{s}"
+            return nil
+          end
+          channel = m[:params][2]
+          users = m[:trailing].split(/\s+/)
+          result = [:chanlist,channel,users]
+          #puts "[parse/353] #{result}"
+
+        when '366'  # end of 353
+          result = [:chanlistend]
+
+        when 'PRIVMSG'
+          case s=m.check(:prefix,:nick,:params,:trailing)
+          when Symbol
+            #puts "* PRIVMSG expected #{s}"
+            return nil
+          end
+
+          msg  = m[:trailing].strip
+          from = m[:prefix][:nick].strip
+          to   = m[:params][0].strip unless m[:params].empty?
+          result = [:msg,from,to,msg]
+
+        else # command we don't handle
+          result = [:default,m]
+        end
+
+        result
+      end
+
       # This class represents an irc message broken down into its
       # major constituent parts.
       #
@@ -113,90 +226,6 @@ module BeerBot
 
       end
 
-      # Parse raw irc string and then yield or return a generic
-      # representation of the event.
-      #
-      # Returns [event,*args]
-      #
-      # Parse's job is to take the constituents parts of an irc
-      # message, identify the type of event and return a generic
-      # representation of it.
-      #
-      # So for instance, an irc privmsg (message) is represented as
-      #   [:msg,from,to,msg]
-      # 
-      # Note that connection readiness and PONG protocol are handled by
-      # the irc connection, not here.
-
-      def self.parse str
-
-        m = IRCMessage.new(str)
-        result = []
-
-        case m[:command]
-
-        when 'NICK'  # change of nick
-          case s=m.check(:prefix,:nick,:trailing)
-          when Symbol
-            puts "* NICK expected #{s}"
-            return nil
-          end
-          old = m[:prefix][:nick]
-          nick = m[:trailing]
-          result = [:nick,old,nick]
-
-        when 'PART' # someone leaves channel
-          case s=m.check(:prefix,:nick,:params)
-          when Symbol
-            puts "* PART expected #{s}"
-            return nil
-          end
-          channel = m[:params][0]
-          nick = m[:prefix][:nick]
-          result = [:part,nick,channel]
-
-        when 'JOIN' # someone joins channel
-          case s=m.check(:prefix,:nick,:trailing)
-          when Symbol
-            puts "* JOIN expected #{s}"
-            return nil
-          end
-          channel = m[:trailing]
-          nick = m[:prefix][:nick]
-          result = [:join,nick,channel]
-
-        when '353'  # channel user list when we join the channel
-          case s=m.check(:params,:trailing)
-          when Symbol
-            puts "* 353 expected #{s}"
-            return nil
-          end
-          channel = m[:params][2]
-          users = m[:trailing].split(/\s+/)
-          result = [:chanlist,channel,users]
-          #puts "[parse/353] #{result}"
-
-        when '366'  # end of 353
-          result = [:chanlistend]
-
-        when 'PRIVMSG'
-          case s=m.check(:prefix,:nick,:params,:trailing)
-          when Symbol
-            #puts "* PRIVMSG expected #{s}"
-            return nil
-          end
-
-          msg  = m[:trailing].strip
-          from = m[:prefix][:nick].strip
-          to   = m[:params][0].strip unless m[:params].empty?
-          result = [:msg,from,to,msg]
-
-        else # command we don't handle
-          result = [:default,m]
-        end
-
-        result
-      end
 
       # Return irc-conformat string from a botmsg hash.
       #
@@ -249,6 +278,12 @@ module BeerBot
         "JOIN #{chan}"
       end
 
+      # Leave channel. 
+
+      def self.leave chan
+        "PART #{chan}"
+      end
+
     end
   end
 

data/lib/BeerBot/06.dispatchers/dispatcher.rb

@@ -81,10 +81,15 @@ module BeerBot
           replies = @bot.event(event,args:args)
         when :default
           replies = @bot.event(event,args:args)
+
         when :nick
           old,nick = args
           @world.nick(old,nick) if @world
           replies = @bot.event(event,old:old,nick:nick)
+
+        when :quit
+          nick,msg = args
+          @world.quit(nick) if @world
         when :part
           nick,channel = args
           @world.part(nick,channel) if @world
@@ -102,6 +107,8 @@ module BeerBot
             }
           end
           replies = @bot.event(event,channel:channel,users:users)
+        when :chanlistend
+          # ignore
 
         when :msg
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beerbot
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Daniel Bush
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-21 00:00:00.000000000 Z
+date: 2014-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -96,7 +96,6 @@ files:
 - lib/BeerBot/00.utils/More.rb
 - lib/BeerBot/00.utils/world/World.rb
 - lib/BeerBot/00.utils/world/IRCWorld.rb
-- lib/BeerBot/01.connect/Connection.rb
 - lib/BeerBot/01.connect/IRCConnection.rb
 - lib/BeerBot/01.bot/botmsg.rb
 - lib/BeerBot/01.bot/BotModule.rb

data/lib/BeerBot/01.connect/Connection.rb

@@ -1,23 +0,0 @@
-# The files in this directory are part of BeerBot, a a ruby irc bot library.
-# Copyright (C) 2013,2014 Daniel Bush
-# This program is distributed under the terms of the GNU
-# General Public License.  A copy of the license should be
-# enclosed with this project in the file LICENSE.  If not
-# see <http://www.gnu.org/licenses/>.
-
-module BeerBot
-  class Connection
-    attr_accessor :queue
-    def initialize
-      @queue = Queue.new
-    end
-    def open
-    end
-    def close
-    end
-    def write str
-    end
-    def ready? &block
-    end
-  end
-end