cinch 0.1

data/spec/helper.rb

@@ -0,0 +1,8 @@
+spec = File.dirname(__FILE__)
+$LOAD_PATH.unshift(spec) unless $LOAD_PATH.include?(spec)
+
+lib = File.dirname(__FILE__) + '../lib/'
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'cinch'
+

data/spec/irc/helper.rb

@@ -0,0 +1,8 @@
+spec = File.dirname(__FILE__)
+$LOAD_PATH.unshift(spec) unless $LOAD_PATH.include?(spec)
+
+lib = File.dirname(__FILE__) + '../../lib/'
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'cinch/irc'
+

data/spec/irc/message_spec.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/helper'
+
+describe "IRC::Message" do
+  before do
+    @message = Cinch::IRC::Message.new('rawline', 'prefix', 'COMMAND', ['#chan', 'hello world'])
+  end
+
+  describe "#add, #[]=" do
+    it "should add an attribute" do
+      @message.add(:custom, 'something')
+      @message.data.should include :custom
+      @message.data[:custom].should == "something"
+    end
+  end
+
+  describe "#delete" do
+    it "should remove an attribute" do
+      @message.add(:custom, 'something')
+      @message.delete(:custom)
+      @message.data.should_not include :custom
+    end
+  end
+
+  describe "#to_s" do
+    it "should return the raw IRC message" do
+      @message.to_s.should == @message.raw
+    end
+  end
+
+  describe "#method_missing" do
+    it "should return an attribute if it exists" do
+      @message.add(:custom, 'something')
+      @message.custom.should == 'something'
+    end
+
+    it "should return nil if no attribute exists" do
+      @message.foobar.should == nil
+    end
+  end
+
+  describe "default attributes" do
+    it "should contain a prefix" do
+      @message.prefix.should == 'prefix'
+    end
+
+    it "should contain a command" do
+      @message.command.should == "COMMAND"
+    end
+
+    it "should contain params" do
+      @message.params.should be_kind_of(Array)
+      @message.params.size.should == 2
+    end
+
+    it "should contain a symbolized command" do
+      @message.symbol.should == :command
+    end
+  end
+
+end
+

data/spec/irc/parser_spec.rb

@@ -0,0 +1,107 @@
+require File.dirname(__FILE__) + '/helper'
+
+# Common commands
+commands = {
+  :ping => "PING :foobar",
+  :nick => ":foo!~baz@host.com NICK Baz",
+  :join => ":foo!~bar@host.com JOIN #baz",
+
+  :privmsg => {
+    "to a channel" => ":foo!~bar@host.com PRIVMSG #baz :hello world",
+    "to a user" => ":foo!~bar@host.com PRIVMSG Baz :hello world",
+    "with an action" => ":foo!~bar@host.com PRIVMSG #baz :\001ACTION hello word\001",
+  },
+
+  :notice => {
+    "to a channel" => ":foo!~bar@host.com NOTICE #baz :hello world",
+    "to a user" => ":foo!~bar@host.com NOTICE Baz :hello world",
+  },
+
+  :part => {
+    "without a message" => ":foo!~bar@host.com PART #baz",
+    "with a message" => ":foo!~bar@host.com PART #baz :beer",
+  },
+
+  :quit => {
+    "without a message" => ":foo!~bar@host.com QUIT",
+    "with a message" => ":foo!~bar@host.com QUIT :baz"
+  }
+}
+
+describe "IRC::Parser" do
+  before do
+    @parser = Cinch::IRC::Parser.new
+  end
+
+  describe "#add_pattern" do
+    it "should add a pattern" do
+      @parser.add_pattern(:custom, /foo/)
+      @parser.patterns.key?(:custom)
+    end
+
+    it "should raise ArgumentError if pattern is not Regexp" do
+      lambda { @parser.add_pattern(:custom, 'foo') }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe "#remove_pattern" do
+    it "should remove a pattern" do
+      @parser.add_pattern(:custom, /foo/)
+      @parser.remove_pattern(:custom)
+      @parser.patterns.keys.should_not include(:custom)
+    end
+
+    it "should return nil if a pattern doesn't exist" do
+      @parser.remove_pattern(:foo).should be nil
+    end
+  end
+
+  describe "#parse_servermessage" do
+    it "should return an IRC::Message" do
+      @parser.parse("foo :bar").should be_kind_of(Cinch::IRC::Message)
+    end
+
+    it "should raise if given an invalid message" do 
+      lambda { @parser.parse("#") }.should raise_error(ArgumentError)
+    end
+
+    commands.each do |cmd, passes|
+      if passes.is_a?(Hash)
+        passes.each do |extra, pass|
+          it "should parse a #{cmd.to_s.upcase} command #{extra}" do
+            m = @parser.parse(pass)
+            m.symbol.should == cmd
+          end
+        end
+      else
+        it "should parse a #{cmd.to_s.upcase} command" do
+          m = @parser.parse(passes)
+          m.symbol.should == cmd
+        end
+      end
+    end
+
+  end
+
+  describe "#parse_userhost" do
+    it "should return an Array" do
+      @parser.parse_userhost(":foo!bar@baz").should be_kind_of(Array)
+    end
+
+    it "should return 3 values" do
+      @parser.parse_userhost(":foo!bar@baz").size.should be 3
+    end
+  end
+
+  describe "#valid_channel?" do
+    it "should return true with a valid channel name" do
+      @parser.valid_channel?("#foo").should be true
+    end
+
+    it "should return false with an invalid channel name" do
+      @parser.valid_channel?("foo").should be false
+    end
+  end
+
+end
+

data/spec/irc/socket_spec.rb

@@ -0,0 +1,90 @@
+require File.dirname(__FILE__) + '/helper'
+
+class Cinch::IRC::Socket
+  def write(data)
+    return data
+  end
+
+  def read(chompstr="\r\n")
+    str = "foo bar baz\r\n"
+    str.chomp!(chompstr) if chompstr
+  end
+end
+
+commands = [
+  [:pass,    %w(foobar),                        "PASS foobar"],
+  [:nick,    %(ipsum),                          "NICK ipsum"],
+  [:user,    ["guest", 0, '*', "real name"],    "USER guest 0 * :real name"],
+  [:oper,    %w(foo bar),                       "OPER foo bar"],
+  [:mode,    %w(#foo +v bar),                   "MODE #foo +v bar"],
+  [:quit,    %w(goodbye),                       "QUIT :goodbye"],
+  [:join,    %w(#mychan),                       "JOIN #mychan"],
+  [:part,    %w(#mychan),                       "PART #mychan"],
+  [:part,    %w(#mychan cya!),                  "PART #mychan :cya!",           "with part message"],
+  [:topic,   %w(#mychan newtopic),              "TOPIC #mychan :newtopic"],
+  [:names,   %w(#foo #bar),                     "NAMES #foo,#bar"],
+  [:list,    %w(#foo #bar),                     "LIST #foo,#bar"],
+  [:invite,  %w(foo #mychan),                   "INVITE foo #mychan"],
+  [:kick,    %w(#chan villian),                 "KICK #chan villian"],
+  [:kick,    %w(#chan villian gtfo!),           "KICK #chan villian :gtfo!",    "with kick reason"],
+  [:privmsg, ['#chan', 'foo bar baz'],          "PRIVMSG #chan :foo bar baz"],
+  [:notice,  ['#chan', 'foo bar baz'],          "NOTICE #chan :foo bar baz"],
+  [:motd,    %w(someserver),                    "MOTD someserver"],
+  [:version, %w(anotherserver),                 "VERSION anotherserver"],
+  [:stats,   %w(m server),                      "STATS m server"],
+  [:time,    %w(irc.someserver.net),            "TIME irc.someserver.net"],
+  [:info,    %w(foobar),                        "INFO foobar"],
+  [:squery,  %w(irchelp HELPME),                "SQUERY irchelp :HELPME"],
+  [:who,     %w(*.com o),                       "WHO *.com o"],
+  [:whois,   %w(foo.org user),                  "WHOIS foo.org user"],
+  [:whowas,  %w(foo.org user),                  "WHOWAS foo.org user"],
+  [:kill,    ['badperson', 'get out!'],         "KILL badperson :get out!"],
+  [:ping,    %w(010123444),                     "PING 010123444"],
+  [:pong,    %w(irc.foobar.org),                "PONG irc.foobar.org"],
+  [:away,    [],                                "AWAY"],
+  [:away,    ['gone for lunch'],                "AWAY :gone for lunch"],
+  [:users,   %w(irc.foobar.org),                "USERS irc.foobar.org"],
+  [:userhost, %w(foo bar baz),                  "USERHOST foo bar baz"],
+]
+
+describe "Cinch::IRC::Socket" do
+  before do
+    @irc = Cinch::IRC::Socket.new('irc.myserver.net')
+  end
+
+  describe "::new" do
+    it "should return an Cinch::IRC::Socket" do
+      @irc.class.should == Cinch::IRC::Socket
+    end
+
+    it "should default to port 6667" do
+      @irc.port.should == 6667
+    end
+
+    it "should not automatically connect" do
+      @irc.connected.should == false
+    end
+
+    it "should set socket instance as nil" do
+      @irc.socket.should == nil
+    end
+  end
+
+  describe "#read" do
+    it "should chomp CRLF by default" do
+      @irc.read.should == "foo bar baz"
+      @irc.read.should_not == "foo bar baz\r\n"
+    end
+  end
+
+  commands.each do |requirements|
+    meth, params, pass, extra = *requirements
+    describe "##{meth}" do
+      it "should send a #{meth.to_s.upcase} command #{extra if extra}" do
+        @irc.send(meth, *params).should == pass
+      end
+    end
+  end
+
+end
+

data/spec/options_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/helper'
+
+describe "Cinch::Base options" do
+  before do
+    @base = Cinch::Base
+  end
+  
+  it "should set options via a hash" do
+    base = @base.new(:server => 'irc.foobar.org')
+    base.options.server.should == "irc.foobar.org"
+  end
+
+  it "should set options via a block" do
+    base = @base.new do
+      server "irc.foobar.org"
+    end
+    base.options.server.should == "irc.foobar.org"
+  end
+
+  it "should set options via setters" do
+    base = @base.new
+    base.options.server = "irc.foobar.org"
+    base.options.server.should == "irc.foobar.org"
+  end
+
+  it "should set specific default values" do 
+    defaults = {
+      :port => 6667,
+      :nick => 'Cinch',
+      :prefix => '!',
+    }
+
+    base = @base.new
+    defaults.each do |k, v|
+      base.options.send(k).should == v
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: cinch
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Lee 'injekt' Jarvis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-25 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+description: An IRC Microframework
+email: ljjarvis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- spec/irc/socket_spec.rb
+- spec/irc/helper.rb
+- spec/irc/message_spec.rb
+- spec/irc/parser_spec.rb
+- spec/helper.rb
+- spec/options_spec.rb
+- lib/cinch.rb
+- lib/cinch/base.rb
+- lib/cinch/irc/message.rb
+- lib/cinch/irc/socket.rb
+- lib/cinch/irc/parser.rb
+- lib/cinch/irc.rb
+has_rdoc: true
+homepage: http://rdoc.injekt.net/cinch
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --quiet
+- --title
+- "Cinch: The IRC Microframework"
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 6
+      version: 1.8.6
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: An IRC Microframework
+test_files: []
+