vbot 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6638d3e56a06aa3491948ea1af4e83d2199f87ff
-  data.tar.gz: f68559f25822c839c8a64636fb83904ef6be47c9
+SHA256:
+  metadata.gz: a26eb16cc5392ac9be8eedf0b9c706e9c5358b8a7029d6d981ef985dc2a8fef3
+  data.tar.gz: 9cfddd516be8857a36329ad1a0ab491d32d2a356818abb7f1169ec877bd374f6
 SHA512:
-  metadata.gz: be0e29c412a2f540d28af93035060b8e7a58adf2ebfb5237fb2c81590a52bd2455d1e33a7fa57d46b8c3e26e67bf3e2169cd75ca2b42cb1434c75aa1b6ba1c71
-  data.tar.gz: eb4a63f793f7517567763364b409d4b33ffd028616eae979959fc1c195d55977e50c1c191ac660d7449f316a26c0a4c32b414ed45b4eb9ea3b484ce77666d67f
+  metadata.gz: 2cb333b49d753ca52d3f32bee79931a12d5e0dc7cf4c4940bd429676ebb8ef22443fd9b46f244522307471ba63951a86d06295028dd42fb1c3aa86acf2a0ef46
+  data.tar.gz: d784544a5bde7f884d27e15099493f48ce9690814b52bf117b6ddb14e39d196fc7e943b7db38c400a3bd0afcc43d6652365eda266906be71195bd6c7b1a0578e

data/lib/vbot.rb

@@ -1,6 +1,30 @@
-##
-# vbot
+# frozen_string_literal: true
+
+# Copyright 2018 Richard Davis
+#
+# This file is part of vbot.
+#
+# vbot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# Copyright 2016 Richard Davis LGPL-2.1
+# vbot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with vbot.  If not, see <http://www.gnu.org/licenses/>.
+
 require 'vbot/base.rb'
 
+##
+# = Vbot
+# Author::    Richard Davis
+# Copyright:: Copyright 2018 Richard Davis
+# License::   GNU Public License 3
+#
+# This module namespaces Vbot project files.
+module Vbot
+end

data/lib/vbot/base.rb

@@ -1,2 +1,20 @@
-require 'vbot/vbotcontroller.rb'
-require 'vbot/vbotmsglogic.rb'
+# frozen_string_literal: true
+
+# Copyright 2018 Richard Davis
+#
+# This file is part of vbot.
+#
+# vbot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# vbot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with vbot.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'vbot/bot_controller'

data/lib/vbot/bot_controller.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Richard Davis
+#
+# This file is part of vbot.
+#
+# vbot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# vbot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with vbot.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'socket'
+
+module Vbot
+  ##
+  # = BotController
+  # Author::    Richard Davis
+  # Copyright:: Copyright 2018 Richard Davis
+  # License::   GNU Public License 3
+  #
+  # This class establishes, maintains, and closes the connection
+  # to the IRC server.
+  class BotController
+    # The IRC server to connect to.
+    attr_reader :server
+    # The port to connect over.
+    attr_reader :port
+    # The nick for the bot.
+    attr_reader :nick
+    # The name to identify to the server with.
+    attr_reader :ident
+    # The gecos for the bot.
+    attr_reader :gecos
+    # The channel on the IRC server to join.
+    attr_reader :chan
+
+    ##
+    # Initializes a VbotController object
+    def initialize config
+      @server = config['server']
+      @port = config['port']
+      @nick = config['nick']
+      @ident = config['ident']
+      @gecos = config['gecos']
+      @chan = config['chan']
+      start_connection
+    end
+
+    ##
+    # Starts the connection to the server and provides identification.
+    def start_connection
+      @socket = TCPSocket.open @server, @port
+      send_message nick_to_server
+      send_message ident_with_server
+    end
+
+    ##
+    # Handles the connection to the server.
+    def handle_connection
+      begin
+        until @socket.eof? do
+          buffer = @socket.gets
+          puts buffer
+          msg = buffer.split
+          response = parse_message msg
+          unless response.nil?
+            send_message response
+            puts "#{@nick.upcase} => #{response}"
+          end
+        end
+      rescue SocketError => e
+        puts e
+        close_connection
+        puts "\nERROR IN CONNECTION. Terminating...\n"
+      end
+    end
+
+    ##
+    # Closes the connection to the server.
+    def close_connection
+      send_message quit_from_server
+      @socket.close
+    end
+
+    private
+
+    ##
+    # Gives nick to server.
+    def nick_to_server
+      "NICK #{@nick}\r\n"
+    end
+
+    ##
+    # Identifies with server.
+    def ident_with_server
+      "USER #{@ident} * 8 :#{@gecos}\r\n"
+    end
+
+    ##
+    # Joins to channel on IRC server.
+    def join_to_channel
+      "JOIN #{@chan}\r\n"
+    end
+
+    ##
+    # Quits IRC server.
+    def quit_from_server
+      'QUIT'
+    end
+
+    ##
+    # Handles ping message from server.
+    def handle_ping token
+      "PONG #{token}"
+    end
+
+    ##
+    # Gets the nick to reply to.
+    def get_nick_rt(raw_rt)
+      last = 1
+      raw_rt.each_char.with_index do |char, i|
+        last = i-1 if char == '!'
+      end
+      raw_rt.slice(1, last)
+    end
+
+    ##
+    # Determines if private message.
+    def is_private_message?(window)
+      return false if window == @chan
+      true
+    end
+
+    ##
+    # Parses the message from the server into a hash.
+    def interpret_command(data)
+      {
+        reply_to: get_nick_rt(data[0]),
+        pm: is_private_message?(data[2]),
+        command: data[4],
+        arguments: data.slice(5..-1)
+      }
+    end
+
+    ##
+    # Executes command subroutines.
+    def exec_command_subroutine(command_hash)
+      if command_hash[:command].upcase == 'HOWDY' && command_hash[:pm] == true
+        "PRIVMSG #{command_hash[:reply_to]} :Howdy, #{command_hash[:reply_to]}.\r\n"
+      elsif command_hash[:command].upcase == 'HOWDY' && command_hash[:pm] == false
+        "PRIVMSG #{@chan} :Howdy, #{command_hash[:reply_to]}.\r\n"
+      end
+    end
+
+    ##
+    # Performs logic on message to determine response.
+    def parse_message(data)
+      return handle_ping data[1] if data[0] == 'PING'
+      return join_to_channel if data[1] == '376' || data[1] == '422'
+      return exec_command_subroutine(interpret_command(data)) if data[1] == 'PRIVMSG' && data[3] == ":#{@nick}"
+    end
+
+    ##
+    # Writes to socket output.
+    def send_message(msg)
+      @socket.puts msg
+    end
+  end
+end

data/test/test_bot_controller.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Richard Davis
+#
+# This file is part of vbot.
+#
+# vbot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# vbot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with vbot.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'minitest/autorun'
+require_relative '../lib/vbot/bot_controller'
+
+##
+# = BotControllerTest
+# Author::    Richard Davis
+# Copyright:: Copyright 2018 Richard Davis
+# License::   GNU Public License 3
+#
+# Contains tests for the BotController class.
+class BotControllerTest < Minitest::Test
+  ##
+  # Initializes test with sample data
+  def setup
+  end
+
+  ##
+  # Ensures the greeter is behaving as expected
+  def test_default
+  end
+end

metadata

@@ -1,34 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: vbot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Richard Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2018-11-04 00:00:00.000000000 Z
 dependencies: []
 description: 'vbot is an IRC bot library that aims to be make building and extending
   IRC bots more efficient.
 
 '
-email: dick@sbdsec.com
-executables:
-- vbot
+email: rv@member.fsf.org
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/vbot
 - lib/vbot.rb
 - lib/vbot/base.rb
-- lib/vbot/vbotcontroller.rb
-- lib/vbot/vbotmsglogic.rb
-- test/test_vbot.rb
+- lib/vbot/bot_controller.rb
+- test/test_bot_controller.rb
 homepage: http://github.com/d3d1rty/vbot
 licenses:
-- LGPL-2.1
+- GPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -46,10 +43,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby library for building IRC bots
 test_files:
-- test/test_vbot.rb
-has_rdoc: 
+- test/test_bot_controller.rb

data/bin/vbot

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-begin
-	require 'vbot'
-rescue LoadError
-	require 'rubygems'
-	require 'vbot'
-end

data/lib/vbot/vbotcontroller.rb

@@ -1,74 +0,0 @@
-##
-# VbotController
-#
-# Copyright 2016 Richard Davis LGPL-2.1
-require 'socket'
-require 'vbot/vbotmsglogic'
-
-##
-# This class establishes, maintains, and closes the connection
-# to the IRC server
-#
-class VbotController
-  attr_reader :server, :port, :nick, :ident, :gecos, :chan
-
-  ##
-  # Initializes a VbotController object
-  #
-  def initialize config
-    @server = config['server']
-    @port = config['port']
-    @nick = config['nick']
-    @ident = config['ident']
-    @gecos = config['gecos']
-    @chan = config['chan']
-    @msg_logic = VbotMsgLogic.new config
-    start_connection
-  end
-
-  ##
-  # Writes to socket output
-  #
-  def send_msg msg
-    @socket.puts msg
-  end
-
-  ##
-  # Starts the connection to the server and provides identification
-  #
-  def start_connection
-    @socket = TCPSocket.open @server, @port
-    send_msg "#{@msg_logic.nick_to_server}"
-    send_msg "#{@msg_logic.ident_with_server}"
-  end
-
-  ##
-  # Handles the connection to the server
-  #
-  def handle_connection
-    begin
-      until @socket.eof? do
-        buffer = @socket.gets
-        puts buffer
-        puts '--------------EOM (server)-------------'
-        msg = buffer.split
-        response = @msg_logic.discern msg
-        unless response.nil?
-          send_msg response
-          puts "#{@nick.upcase} => #{response}"
-        end
-      end
-    rescue
-      puts "\nTerminating connection."
-    end
-  end
-
-  ##
-  # Closes the connection to the server
-  #
-  def close_connection
-    send_msg 'QUIT'
-    @socket.close
-  end
-end
-

data/lib/vbot/vbotmsglogic.rb

@@ -1,81 +0,0 @@
-##
-# VbotMsgLogic
-#
-# Copyright 2016 Richard Davis LGPL-2.1
-
-##
-# This class serves as the controlling logic for responding
-# to messages from the IRC server
-#
-class VbotMsgLogic
-
-  ##
-  # Initializes a VbotMsgLogic object
-  #
-  def initialize config
-    @nick = config['nick']
-    @ident = config['ident']
-    @gecos = config['gecos']
-    @chan = config['chan']
-  end
-
-  ##
-  # Gives nick to server
-  #
-  def nick_to_server
-    "NICK #{@nick}\r\n"
-  end
-
-  ##
-  # Identifies with server
-  #
-  def ident_with_server
-    "USER #{@ident} * 8 :#{@gecos}\r\n"
-  end
-
-  ##
-  # Joins to channel on IRC server
-  #
-  def join_channel
-    "JOIN #{@chan}\r\n"
-  end
-
-  ##
-  # Handles ping message from server
-  #
-  def handle_ping token
-    "PONG #{token}"
-  end
-
-  ##
-  # Handles private message commands
-  #
-  def hear_command data
-      rt = get_nick_rt data[0]
-      command = data[4]
-      if command.upcase == "HELLO"
-        "PRIVMSG #{rt} Hello, #{rt}.\r\n"
-      end
-  end
-
-  ##
-  # Gets the nick to reply to
-  #
-  def get_nick_rt msg
-    last = 1
-    msg.each_char.with_index do |char, i|
-      last = i-1 if char == '!'
-    end
-    rt = msg.slice(1, last)
-  end
-
-  ##
-  # Performs logic on message to determine response
-  #
-  def discern data
-    return handle_ping data[1] if data[0] == 'PING'
-    return join_channel if data[1] == '376' || data[1] == '422'
-    return hear_command data if data[1] == 'PRIVMSG' && data[3] == ":#{@nick}"
-  end
-end
-

data/test/test_vbot.rb

@@ -1,7 +0,0 @@
-require 'test/unit'
-require 'vbot'
-class HelloWorldTest < Test::Unit::TestCase
-	def test_hello_world
-		assert_equal(HelloWorld.hello, 'Hello world!')
-	end
-end