irconnect 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dceeaa4921ecd73f225a56d9d117012c87a3d21d
+  data.tar.gz: 973ba8dd099a6004a67712c85ffc225186a32876
+SHA512:
+  metadata.gz: 7526d562c12c5be0dafa89a712b06c5d7822c936d418f1e842e2e75398f269c0e54f1471ce61c9ccf0aa63cb51062aebf3f5cc6de89a1f222d9517e53e59b7d1
+  data.tar.gz: 70326593920dcb75fe539d10cdfca50b30586c4d06a5b67dc3ee427640978812ba74a0d965e4348422ae38fc4dbb5601495f56a01ae3b0f7fc2d62f8f4281e4e

data/lib/command.rb

@@ -0,0 +1,41 @@
+
+module IRConnect
+  # represents an IRC Command received from the server
+  class Command
+    attr_reader :prefix, :command, :params, :last_param
+
+    # IRC message format:
+    # :<prefix> <command> <params> :<trailing>
+    # info on parsing commands:
+    # http://goo.gl/N3YGLq
+    def initialize(command_string)
+      fail 'Bad IRC command format' unless command_string =~ /
+          \A (?::([^\040]+)\040)?  # prefix
+          ([A-Za-z]+|\d{3})        # command
+          ((?:\040[^:][^\040]+)*)  # all but the last param
+          (?:\040:?(.*))?          # last param
+          \Z
+        /x
+      @prefix, @command = Regexp.last_match(1), Regexp.last_match(2)
+      parse_params(Regexp.last_match(3), Regexp.last_match(4))
+    end
+
+    def ==(other)
+      prefix == other.prefix &&
+        command == other.command &&
+        params == other.params
+    end
+
+    private
+
+    def parse_params(param, param_last)
+      if param.empty?
+        @params = []
+      else
+        @params = param.split
+        @params << param_last unless param_last.nil?
+      end
+      @last_param = params.last
+    end
+  end
+end

data/lib/connection.rb

@@ -0,0 +1,123 @@
+require 'socket'
+require './lib/command'
+
+module IRConnect
+  # Simple wrapper around common IRC commands
+  class Connection
+    DEFAULT_OPTIONS = { port: 6667, socket_class: TCPSocket }
+
+    attr_reader :socket, :port, :connected, :nick, :server, :command_buffer
+
+    LOGIN_COMMANDS = {
+      '001' => 'RPL_WELCOME',
+      '431' => 'ERR_NONICKNAMEGIVEN',
+      '432' => 'ERR_ERRONEUSNICKNAME',
+      '433' => 'ERR_NICKNAMEINUSE',
+      '436' => 'ERR_NICKCOLLISION',
+      '461' => 'ERR_NEEDMOREPARAMS',
+      '462' => 'ERR_ALREADYREGISTERED'
+    }
+
+    JOIN_COMMANDS = {
+      '461' => 'ERR_NEEDMOREPARAMS',
+      '471' => 'ERR_CHANNELISFULL',
+      '473' => 'ERR_INVITEONLYCHAN',
+      '474' => 'ERR_BANNEDFROMCHAN',
+      '475' => 'ERR_BADCHANNELKEY',
+      '476' => 'ERR_BADCHANMASK',
+      '403' => 'ERR_NOSUCHCHANNEL',
+      '405' => 'ERR_TOOMANYCHANNELS',
+      '332' => 'RPL_TOPIC',
+      '353' => 'RPL_NAMREPLY'
+    }
+
+    def initialize(server, options = {})
+      options         = DEFAULT_OPTIONS.merge(options)
+      @server         = server
+      @port           = options[:port]
+      @nick           = options[:nick]
+      @socket         = options[:socket_class].new(@server, @port)
+      @command_buffer = []
+    end
+
+    def nick(name)
+      unless name =~ /\A[a-z_\-\[\]\\^{}|`][a-z0-9_\-\[\]\\^{}|`]+\z/i
+        fail 'Invalid NICK'
+      end
+      send("NICK #{name}")
+    end
+
+    # host and server are typically ignored by servers
+    # for security reasons
+    def user(nickname, hostname, servername, fullname)
+      send("USER #{nickname} #{hostname} #{servername} :#{fullname}")
+    end
+
+    def login(nickname, hostname, servername, fullname)
+      nick(nickname)
+      user(nickname, hostname, servername, fullname)
+      reply = receive_until { |c| LOGIN_COMMANDS.include?(c.command) }
+
+      fail 'Login error, no response from server' if reply.nil?
+      if reply.command != '001'
+        fail "Login error: #{reply.last_param}\n" \
+          "Received: #{reply.command} -> #{LOGIN_COMMANDS[reply.command]}"
+      end
+    end
+
+    def join_channel(chan)
+      send("JOIN #{chan}")
+      reply = receive_until { |c| JOIN_COMMANDS.include?(c.command) }
+
+      fail 'Unable to join channel, unknown error' if reply.nil?
+      unless reply.command == '332' || reply.command == '353'
+        fail "Error joining #{chan}: #{reply.last_param} \n" \
+          "Received: #{reply.command} -> #{JOIN_COMMANDS[reply.command]}"
+      end
+    end
+
+    def privmsg(target, message)
+      send("PRIVMSG #{target} :#{message}")
+    end
+
+    def receive
+      return command_buffer.shift unless command_buffer.empty?
+
+      command = receive_command
+      command.nil? ? nil : IRConnect::Command.new(command)
+    end
+
+    def receive_until
+      skip_commands = []
+
+      while (command = receive)
+        if yield(command)
+          command_buffer.unshift(*skip_commands)
+          return command
+        else
+          skip_commands << command
+        end
+      end
+    end
+
+    private
+
+    def receive_command
+      command = socket.gets
+      return nil if command.nil?
+
+      if command =~ /\APING (.*?)\r\n\Z/
+        send("PONG #{Regexp.last_match(1)}")
+        receive_command
+      else
+        command.sub(/\r\n\Z/, '')
+      end
+    end
+
+    def send(cmd)
+      socket.print("#{cmd}\r\n")
+    rescue IOError
+      raise
+    end
+  end
+end

data/lib/irconnect.rb

@@ -0,0 +1,3 @@
+require './lib/command.rb'
+require './lib/connection.rb'
+

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: irconnect
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Justin Speers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-05 00:00:00.000000000 Z
+dependencies: []
+description: Wrapper around basic IRC Client functionality
+email: speersj@fastmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/command.rb
+- lib/connection.rb
+- lib/irconnect.rb
+homepage: https://github.com/jaspeers/irconnect
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: irconnect
+test_files: []