ircmachine 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb3c6abf09f3ce657496ebac2b2bb384a5fa9962
-  data.tar.gz: fff381302cd8132fe6412be5837f398d500a0d0f
+  metadata.gz: 5e3830cc91efbb2027aeb162469d24efded0b4c6
+  data.tar.gz: c5834dc8320206ec114b8fc394abd037c850bbb0
 SHA512:
-  metadata.gz: ed5df1caa8891bfa3da2e627d1eccfb21d85d06d08ed4dcce37d8d5eea72aa8b3f6b6551238801be388b836f57f6c0185eea881aefa0964177e10cff4cd52dfb
-  data.tar.gz: 1b677c17b260d8c4234967a689e0fa70891c11ccacb65c0c0ad1701995d33fe2e8be0c98b1854fef39a5f767a2d0b51d47e65912dc28e16e81e9892bdb0a74ce
+  metadata.gz: 4368e32e490b74e4ee62cccf2987920e161cd69cfe3de97b33a5a05af51c8038835245c27c8f53a124aceea3dc1d9ea7c4022dd5d9eb0daa208d0291bdfc8afd
+  data.tar.gz: 0956fabcfa902d5ff9fc4ea0b3adbb74a2ef148fe15bb62ae872c1c3194b895b1d6765ca69e99053cddabdf6dadb7b067006d98ea2b1cdae9aa6445739eccd35

data/ircmachine.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['chris.davies.uk@member.mensa.org']
   spec.summary       = %q{A simple IRC protocol parser.}
   spec.description   = spec.summary
-  spec.homepage      = ''
+  spec.homepage      = 'https://github.com/north636/ircmachine'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/ircmachine.rb

@@ -1,3 +1,4 @@
 require 'ircmachine/command'
 require 'ircmachine/message'
+require 'ircmachine/reply'
 require 'ircmachine/version'

data/lib/ircmachine/command.rb

@@ -30,12 +30,8 @@ module IRCMachine
 
         klass = Class.new do
           define_method(:initialize) do |prefix = nil, *args|
-            instance_variable_set('@prefix', prefix)
-
-            arg_names.zip(args).each do |e|
-              name, value = e[0], e[1]
-              instance_variable_set("@#{name}", value)
-            end
+            @prefix = prefix
+            arg_names.zip(args).each { |name, value| instance_variable_set("@#{name}", value) }
           end
 
           # Create readers for the parameters.
@@ -47,12 +43,7 @@ module IRCMachine
 
           define_method(:to_msg) do
             param_values = arg_names.map { |k| instance_variable_get("@#{k}") }.join(' ')
-
-            IRCMachine::Message.new(
-              instance_variable_get('@prefix'),
-              cmd,
-              param_values
-            )
+            IRCMachine::Message.new(@prefix, cmd, param_values)
           end
 
           define_method(:to_s) { self.to_msg.to_s }
@@ -64,7 +55,7 @@ module IRCMachine
       private :defcmd
 
       # Same as defcmd, but arguments are passed in reverse order.  This is to
-      # support commands like WHOIS, which has an optional parameter in the
+      # support the WHOIS command, which has an optional parameter in the
       # middle, rather than at the end...
       def defrcmd(cmd, *arg_names)
         cmd = cmd.strip.upcase
@@ -73,10 +64,7 @@ module IRCMachine
           define_method(:initialize) do |prefix = nil, *args|
             instance_variable_set('@prefix', prefix)
 
-            arg_names.reverse.zip(args.reverse).each do |e|
-              name, value = e[0], e[1]
-              instance_variable_set("@#{name}", value)
-            end
+            arg_names.reverse.zip(args.reverse).each { |name, value| instance_variable_set("@#{name}", value) }
           end
 
           # Create readers for the parameters.

data/lib/ircmachine/message.rb

@@ -44,6 +44,14 @@ module IRCMachine
       str << "\r\n"
     end
 
+    def reply?
+      !!(@command =~ /^\d+$/)
+    end
+
+    def command?
+      !reply?
+    end
+
     def self.parse(str)
       unless (m = MESSAGE.match(str)).nil?
         Message.new(m[:prefix], m[:command], m[:params])

data/lib/ircmachine/reply.rb

@@ -0,0 +1,188 @@
+require 'ircmachine/message'
+
+module IRCMachine
+  module Reply
+    class << self
+      def replies
+        @replies ||= {}
+      end
+      private :replies
+
+      def from_msg(msg)
+        if (klass = replies[msg.command]).nil?
+          fail ArgumentError, "Unknown reply: #{msg.command}"
+        else
+          klass.new(msg.prefix, *msg.params)
+        end
+      end
+
+      def parse(str)
+        if (msg = IRCMachine::Message.parse(str)).nil?
+          fail ArgumentError, 'Invalid format for IRC message.'
+        else
+          from_msg(msg)
+        end
+      end
+
+      def defrpl(code, name, *arg_names)
+        raise ArgumentError, 'Code must be 3 digits.' unless code =~ /^\d{3}$/
+
+        klass = Class.new do
+          define_method(:initialize) do |prefix, *args|
+            @prefix = prefix
+            arg_names.zip(args).each { |name, value| instance_variable_set("@#{name}", value) }
+          end
+
+          arg_names.each do |name|
+            define_method(name) { instance_variable_get("@#{name}") }
+          end
+
+          define_method(:prefix)  { @prefix }
+          define_method(:code)    { code }
+
+          define_method(:to_msg) do
+            param_values = arg_names.map { |k| instance_variable_get("@#{k}") }.join(' ')
+            IRCMachine::Message.new(@prefix, code, param_values)
+          end
+
+          define_method(:to_s) { self.to_msg.to_s }
+        end
+
+        class_name = "#{name.to_s.split('_').map(&:capitalize).join('')}Reply"
+        const_set(class_name, klass)
+
+        replies[code] = klass
+      end
+      private :defrpl
+    end
+
+    defrpl '001', :welcome,                 :message
+    defrpl '002', :your_host,               :message
+    defrpl '003', :created,                 :message
+    defrpl '004', :my_info,                 :info
+    defrpl '005', :bounce,                  :message
+
+    # Ignoring trace stuff.
+
+    defrpl '212', :stats_commands,          :command, :count, :byte_count, :remote_count
+    defrpl '219', :end_of_stats,            :message
+    defrpl '221', :u_modeis,                :mode_string
+    defrpl '234', :serv_list,               :name, :server, :mask, :type, :hop_count, :info
+    defrpl '235', :serv_list_end,           :mask, :type, :message
+    defrpl '242', :stats_uptime,            :message
+    defrpl '243', :stats_o_line,            :o, :hostmask, :star, :name
+    defrpl '251', :l_user_client,           :message
+    defrpl '252', :l_user_op,               :num_ops, :message
+    defrpl '253', :l_user_unknown,          :num_unknowns, :message
+    defrpl '254', :l_user_channels,         :num_channels, :message
+    defrpl '255', :l_user_me,               :message
+    defrpl '256', :admin_me,                :server, :message
+    defrpl '257', :admin_loc1,              :info
+    defrpl '258', :admin_loc2,              :info
+    defrpl '259', :admin_email,             :info
+    defrpl '263', :try_again,               :command, :message
+
+    defrpl '301', :away,                    :nickname, :away_message
+    defrpl '302', :user_host,               :replies
+    defrpl '303', :is_on,                   :nicknames
+    defrpl '305', :unaway,                  :message
+    defrpl '306', :now_away,                :message
+    defrpl '311', :whois_user,              :nickname, :user, :host, :star, :real_name
+    defrpl '312', :whois_server,            :nickname, :server, :server_info
+    defrpl '313', :whois_operator,          :nickname, :message
+    defrpl '314', :whowas_user,             :nickname, :user, :host, :star, :real_name
+    defrpl '315', :end_of_who,              :name, :message
+    defrpl '317', :whois_idle,              :nickname, :idle_time, :message
+    defrpl '318', :end_of_whois,            :nickname, :message
+    defrpl '319', :whois_channels,          :nickname, :channels
+    defrpl '321', :list_start,              :message
+    defrpl '322', :list,                    :channel, :num_visible, :topic
+    defrpl '323', :list_end,                :message
+    defrpl '324', :channel_mode_is,         :channel, :mode, :mode_params
+    defrpl '325', :uniq_op_is,              :channel, :nickname
+    defrpl '331', :no_topic,                :channel, :message
+    defrpl '332', :topic,                   :channel, :message
+    defrpl '341', :inviting,                :channel, :nickname
+    defrpl '342', :summoning,               :user, :message
+    defrpl '346', :invite_list,             :channel, :invite_mask
+    defrpl '347', :end_of_invite_list,      :channel, :message
+    defrpl '348', :except_list,             :channel, :exception_mask
+    defrpl '349', :end_of_except_list,      :channel, :message
+    defrpl '351', :version,                 :version, :server, :comments
+    defrpl '352', :who,                     :channel, :user, :host, :server, :nickname # TODO: uhh... what comes after?
+    defrpl '353', :nam,                     :channel_type, :channel, :info
+    defrpl '364', :links,                   :mask, :server, :info
+    defrpl '365', :end_of_links,            :mask, :message
+    defrpl '366', :end_of_names,            :channel, :message
+    defrpl '367', :ban_list,                :channel, :ban_mask
+    defrpl '368', :end_of_ban_list,         :channel, :message
+    defrpl '369', :end_of_whowas,           :nickname, :message
+    defrpl '371', :info,                    :message
+    defrpl '372', :motd,                    :message
+    defrpl '374', :end_of_info,             :message
+    defrpl '375', :motd_start,              :message
+    defrpl '376', :end_of_motd,             :message
+    defrpl '381', :youre_oper,              :message
+    defrpl '382', :rehashing,               :config_file, :message
+    defrpl '383', :youre_service,           :message
+    defrpl '391', :time,                    :server, :time
+    defrpl '392', :users_start,             :info
+    defrpl '393', :users,                   :info
+    defrpl '394', :end_of_users,            :message
+    defrpl '395', :no_users,                :message
+
+    defrpl '401', :no_such_nickname_error,        :nickname, :message
+    defrpl '402', :no_such_server_error,          :server, :message
+    defrpl '403', :no_such_channel_error,         :channel, :message
+    defrpl '404', :cannot_send_to_channel_error,  :channel, :message
+    defrpl '405', :too_many_channels_error,       :channel, :message
+    defrpl '406', :was_no_such_nickname_error,    :nickname, :message
+    defrpl '407', :too_many_targets_error,        :target, :message
+    defrpl '408', :no_such_service_error,         :service, :message
+    defrpl '409', :no_origin_error,               :message
+    defrpl '411', :no_recipient_error,            :message
+    defrpl '412', :no_text_to_send_error,         :message
+    defrpl '413', :no_top_level_error,            :message
+    defrpl '414', :wild_top_level_error,          :message
+    defrpl '415', :bad_mask_error,                :mask, :message
+    defrpl '421', :unknown_command_error,         :command, :message
+    defrpl '422', :no_motd_error,                 :message
+    defrpl '423', :no_admin_info_error,           :server, :message
+    defrpl '424', :file_error_error,              :message
+    defrpl '431', :no_nickname_given_error,       :message
+    defrpl '432', :erroneous_nickname_error,      :nickname, :message
+    defrpl '433', :nickname_in_use_error,         :nickname, :message
+    defrpl '436', :nickname_collision_error,      :nickname, :message
+    defrpl '437', :unavailable_resource_error,    :what, :message
+    defrpl '441', :user_not_in_channel_error,     :nickname, :channel, :message
+    defrpl '442', :not_on_channel_error,          :channel, :message
+    defrpl '443', :user_on_channel_error,         :nickname, :channel, :message
+    defrpl '444', :no_login_error,                :nickname, :message
+    defrpl '445', :summon_disabled_error,         :message
+    defrpl '446', :users_disabled_error,          :message
+    defrpl '451', :not_registered_error,          :message
+    defrpl '461', :need_more_params_error,        :command, :message
+    defrpl '462', :already_registered_error,      :message
+    defrpl '463', :no_perm_for_host_error,        :message
+    defrpl '464', :incorrect_password_error,      :message
+    defrpl '465', :banned_error,                  :message
+    defrpl '466', :you_will_be_banned_error,      :message
+    defrpl '467', :key_set_error,                 :channel, :message
+    defrpl '471', :channel_full_error,            :channel, :message
+    defrpl '472', :unknown_mode_error,            :mode, :message
+    defrpl '473', :invite_only_channel_error,     :channel, :message
+    defrpl '474', :banned_from_channel_error,     :channel, :message
+    defrpl '475', :incorrect_key_error,           :channel, :message
+    defrpl '476', :bad_channel_mask_error,        :channel, :message
+    defrpl '477', :no_channel_modes_error,        :channel, :message
+    defrpl '478', :ban_list_full_error,           :channel, :char, :message
+    defrpl '481', :no_privileges_error,           :message
+    defrpl '482', :not_operator_error,            :channel, :message
+    defrpl '483', :cant_kill_server_error,        :message
+    defrpl '484', :restricted_error,              :message
+    defrpl '485', :not_original_operator_error,   :channel, :message
+    defrpl '491', :no_oper_host_error,            :message
+    defrpl '501', :unknown_u_mode_flag_error,     :message
+    defrpl '502', :users_dont_match_error,        :message
+  end
+end

data/lib/ircmachine/version.rb

@@ -1,3 +1,3 @@
 module IRCMachine
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/spec/reply_spec.rb

@@ -0,0 +1,47 @@
+require 'minitest/autorun'
+
+require 'ircmachine/reply'
+
+describe IRCMachine::Reply do
+  describe 'defrpl' do
+    it 'should generate properly-named classes' do
+      r = IRCMachine::Reply.parse("001 :foo\r\n")
+      r.wont_be_nil
+      r.must_be_instance_of IRCMachine::Reply::WelcomeReply
+    end
+
+    it 'should assign parameter values to names, if given' do
+      r = IRCMachine::Reply.parse(":example.com 263 JOIN :message here\r\n")
+      r.wont_be_nil
+      r.must_be_instance_of IRCMachine::Reply::TryAgainReply
+      r.prefix.must_equal ':example.com'
+      r.code.must_equal '263'
+      r.command.must_equal 'JOIN'
+      r.message.must_equal ':message here'
+    end
+
+    it 'should assign nil to parameters that are omitted' do
+      r = IRCMachine::Reply.parse(":example.com 263 JOIN\r\n")
+      r.wont_be_nil
+      r.must_be_instance_of IRCMachine::Reply::TryAgainReply
+      r.prefix.must_equal ':example.com'
+      r.code.must_equal '263'
+      r.command.must_equal 'JOIN'
+      r.message.must_be_nil
+    end
+
+    it 'provides a method for transforming back to a Message object' do
+      r = IRCMachine::Reply.parse(":example.com 263 JOIN :message here\r\n")
+      m = r.to_msg
+      m.wont_be_nil
+      m.prefix.must_equal ':example.com'
+      m.command.must_equal '263'
+      m.params.must_equal [ 'JOIN', ':message here' ]
+    end
+
+    it 'provides a sensible to_s implementation' do
+      r = IRCMachine::Reply.parse(":example.com 263 JOIN :message here\r\n")
+      r.to_s.must_equal ":example.com 263 JOIN :message here\r\n"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ircmachine
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Chris Davies
@@ -55,11 +55,13 @@ files:
 - lib/ircmachine/command.rb
 - lib/ircmachine/ircsocketadapter.rb
 - lib/ircmachine/message.rb
+- lib/ircmachine/reply.rb
 - lib/ircmachine/version.rb
 - spec/command_spec.rb
 - spec/ircsocketadapter_spec.rb
 - spec/message_spec.rb
-homepage: ''
+- spec/reply_spec.rb
+homepage: https://github.com/north636/ircmachine
 licenses:
 - MIT
 metadata: {}
@@ -87,3 +89,4 @@ test_files:
 - spec/command_spec.rb
 - spec/ircsocketadapter_spec.rb
 - spec/message_spec.rb
+- spec/reply_spec.rb