smirc 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Adam Pearson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,47 @@
+= smirc
+
+A simple Ruby IRC client.
+
+Features:
+* Message Queueing to prevent flood disconnects
+* Simple event handling 
+* No DSL required, easy access to Irc#join and Irc#message
+
+
+== Example
+
+  options = {
+    :server => "my.irc.net",
+    :nickname => "Hal",
+    :realname => "Daisy, Daisy",
+    :port => 6667,
+  }
+
+  @irc = Smirc::Client.new(options)
+  @irc.on(:connect) do |irc|
+    irc.join("#mychannel")
+  end
+
+  @irc.on(:message) do |irc, channel, message, user|
+    case message
+    when /open the bomb-bay doors/
+      irc.message(channel, "I'm sorry, I cannot do that, Dave")
+    end
+  end
+
+  begin
+    @irc.connect
+  ensure
+    @irc.disconnect
+  end
+
+
+
+
+== Contributions and Credit
+
+This gem is based heavily on ichverstehe's Isaac gem. There's no way this would be written without that gem as a reference.
+
+== Copyright
+
+Copyright (c) 2009 Adam Pearson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name     = "smirc"
+    gem.summary  = "A Simple IRC Client Library for RUby" 
+    gem.email    = "ampearson@gmail.com"
+    gem.homepage = "http://github.com/radamant/smirc"
+    gem.authors  = ["Adam Pearson"]
+    gem.add_dependency('mash')
+    gem.add_dependency('eventful')
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "smirc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/smirc.rb

@@ -0,0 +1,7 @@
+require 'socket'
+require 'rubygems'
+require 'eventful'
+require 'mash'
+
+require 'smirc/queue'
+require 'smirc/client'

data/lib/smirc/client.rb

@@ -0,0 +1,124 @@
+module Smirc
+  # A Simple Irc Client
+  # Events:
+  #   <tt>:connected</tt>
+  #     Fires when a connection has successfully been made
+  #
+  #   <tt>:message</tt> |irc, channel, message, user|
+  #     Fires when a PRIVMSG is sent from the server
+  #   
+  #   <tt>:log</tt> |irc, message|
+  #     Fires when message is logged by the client
+  #
+  # TODO:
+  #   * Implement Queueing (based on Isaac gem)
+  #   * Add :error event
+  # 
+  class Client
+    include Eventful
+    attr_accessor :queue
+
+    # Configuration options
+    # * :server
+    # * :nickname
+    # * :realname
+    # * :port
+    # * :password
+    def initialize(configuration={})
+      @configuration = Mash.new(configuration)
+      @queue = Smirc::Queue.new
+
+      @queue.on(:lock) { send("PING :#{@configuration.server}\r\n") }
+      @queue.on(:send) { |q, msg| send(msg) }
+    end
+
+    # Attempt to connect to the server.  Will fire :connect if successful
+    def connect
+      @registrations = []
+      @registered = false
+
+      server  = config.server || 'localhost'
+      port    = config.port || 6667
+
+      log("Connecting to #{server} #{port}")
+      @socket = TCPSocket.new(server, port)
+
+      send("PASS #{config.password}\r\n") if config.password
+      send("NICK #{config.nickname}\r\n")
+      send("USER #{config.nickname} 0 * :#{config.realname}\r\n")
+
+      listen
+    end
+
+    def config
+      return @configuration
+    end
+
+    # Disconnect from the server
+    def disconnect
+      send("QUIT\r\n")
+      log "Disconnecting"
+      @socket.close
+    end
+
+   
+    # Send a message to <tt>channel</tt> with <tt>text</tt>
+    def message(channel, text)
+      @queue << "PRIVMSG #{channel} :#{text}\r\n"
+    end
+
+    # Join the <tt>channel</tt>
+    def join (channel)
+      send ("JOIN #{channel}\r\n")
+    end
+    
+
+    def parse(line)
+      log "<- #{line}"
+      case line.chomp
+      when /(^:\S+ )?00([1-4])/
+        @registrations << $2.to_i
+      when /(^:(\S+)!\S+ )?PRIVMSG \S+ :?\001VERSION\001/
+        send "NOTICE #{$2} :\001VERSION ruby.irk\001"
+      when /^PING (\S+)/
+        send "PONG #{$1}\r\n"
+        @queue.unlock
+      when /(^:\S+)?PONG/
+        @queue.unlock
+             
+      when /(^:(\S+)!(\S+) )?PRIVMSG (\S+) :?(.*)/
+        env = Mash.new({ :nick => $2, :userhost => $3, :channel => $4, :message => $5 })
+        type = env[:channel].match(/^#/) ? :channel : :private
+        fire(:message, env.channel, env.message, env.nick)
+      when /(^:\S+ )?([4-5]\d\d) \S+ (\S+)/
+        env = {:error => $2.to_i, :message => $2, :nick => $3, :channel => $3}
+        fire(:error, env)
+      end
+    end
+
+
+    private
+
+    def log(message)
+      fire(:log, message)
+    end
+
+    def listen
+      while(line = @socket.gets)
+        parse(line)
+        if !@registered && ([1,2,3,4] - @registrations).empty?
+          fire(:connected)
+          @registered = true
+        end
+      end
+    end
+
+
+    def send(data)
+      log "-> #{data}"
+      @socket.print(data)
+    end
+
+
+  end
+end

data/lib/smirc/queue.rb

@@ -0,0 +1,66 @@
+module Smirc
+  class Queue
+    include Eventful
+    attr_accessor :locked, :messages, :transferred, :limit
+
+    def initialize
+      @locked = false
+      @messages = []
+      @transferred = 0
+      @limit = 1400
+    end
+
+    def lock
+      @locked = true
+      fire(:lock)
+    end
+    
+    def unlock
+      @locked = false
+      @transferred = 0
+      fire(:unlock)
+      invoke
+    end
+
+    def locked?
+      @locked
+    end
+
+    def <<(message)
+      @messages << message
+      invoke
+    end
+
+    def size
+      @messages.size
+    end
+
+    def should_invoke?
+      !locked? && size > 0
+    end
+
+    
+    def invoke
+      while(should_invoke?) do
+        unless limit_exceeded?(messages.first.size)
+          message = messages.shift
+          send(message) unless limit_exceeded?
+          @transferred += message.size
+          lock if limit_exceeded? 
+        else
+          lock
+        end
+      end
+    end
+
+    def limit_exceeded?(additional = 0)
+      @transferred + additional > @limit
+    end
+
+    def send(message)
+      fire(:send, message)
+    end
+
+
+  end
+end

data/smirc.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{smirc}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Adam Pearson"]
+  s.date = %q{2010-02-27}
+  s.email = %q{ampearson@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/smirc.rb",
+     "lib/smirc/client.rb",
+     "lib/smirc/queue.rb",
+     "smirc.gemspec",
+     "spec/client_spec.rb",
+     "spec/queue_spec.rb",
+     "spec/smirc_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/radamant/smirc}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A Simple IRC Client Library for RUby}
+  s.test_files = [
+    "spec/client_spec.rb",
+     "spec/queue_spec.rb",
+     "spec/smirc_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mash>, [">= 0"])
+      s.add_runtime_dependency(%q<eventful>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<mash>, [">= 0"])
+      s.add_dependency(%q<eventful>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<mash>, [">= 0"])
+    s.add_dependency(%q<eventful>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/client_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Smirc::Client do
+
+  context "with flood-prevention queue" do
+    before(:each) do
+      @client = Smirc::Client.new(:server => 'foo')
+      @client.stub!(:send)
+    end
+
+    it "should ping the server when the queue is locked" do
+      @client.should_receive(:send).with("PING :foo\r\n")
+      @client.queue.lock
+    end
+
+    it "should unlock the queue when a pong is received from the server" do
+      @client.queue.should_receive(:unlock)
+      @client.parse("PONG")
+    end
+
+    it "should unlock the queue when a ping is received from the server" do
+      @client.queue.should_receive(:unlock)
+      @client.parse("PING :foo") 
+    end
+
+    it "should pass messages through the queue before directly sending them" do
+      @client.should_not_receive(:send)
+      @client.queue.should_receive(:<<)
+      @client.queue.stub!(:invoke)
+      @client.message("#random", "message")
+    end
+
+    it "should call #send when the queue fires :send" do
+      @client.should_receive(:send).and_return(true)
+      @client.queue.fire(:send, "foo")
+    end
+
+  end
+end

data/spec/queue_spec.rb

@@ -0,0 +1,104 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Smirc::Queue do
+  before(:each) do
+    @queue = Smirc::Queue.new()
+  end
+
+  context "#invoke" do
+    before(:each) do
+      @queue.messages = %w(foo bar you baz)
+    end
+
+    it "should lock if message size has exceeded limit" do
+      @queue.transferred = @queue.limit - 2
+      @queue << "foo"
+      @queue.locked?.should be_true
+    end
+
+    it "should send messages to the server if limit has not been exceeded" do
+      @queue.should_receive(:send).exactly(4).times
+      @queue.stub!(:limit_exceeded?).and_return(false)
+      @queue.invoke
+    end
+
+    it "should not send messages to the server if limit has been exceeded" do
+      @queue.should_not_receive(:send)
+      @queue.stub!(:limit_exceeded?).and_return(true)
+      @queue.invoke
+    end
+
+    it "should not shift the queue if the limit would be exceeded" do
+      @queue.transferred = @queue.limit - 2
+      lambda{ @queue.invoke}.should_not change(@queue, :size)
+    end
+
+    it "should increase transferred amount with each message" do
+      lambda{ @queue.invoke}.should change(@queue, :transferred).by(12)
+    end
+
+
+  end
+
+  it "should add messages to the queue when << is called" do
+    @queue.stub!(:invoke)
+    lambda{
+      @queue << "hi message"
+    }.should change(@queue, :size).by(1)
+  end
+
+  it "should invoke messages when << is called" do
+    @queue.should_receive(:invoke)
+    @queue << "foo"
+  end
+    
+  context "#lock" do
+    it "should lock when #lock is called" do
+      Smirc::Queue.new.lock
+      @queue.lock
+      @queue.locked?.should be_true
+    end
+    it "should fire the :lock event" do 
+      @event_handled = false
+      @queue.on(:lock) { @event_handled = true }
+      @queue.lock
+      @event_handled.should be_true
+    end
+  end
+  
+  context "#unlock" do
+    it "should unlock when #unlock is called" do
+      @queue.lock
+      @queue.unlock
+      @queue.locked?.should be_false
+    end
+
+    it "should invoke when unlock is called" do
+      @queue.should_receive(:invoke)
+      @queue.unlock
+    end
+
+    it "should reset transfer counter" do
+      @queue.transferred = 60
+      @queue.unlock
+      @queue.transferred.should == 0
+    end
+
+    it "should fire :unlock when unlock is called" do
+      @event_handled = false
+      @queue.on(:unlock) { @event_handled = true}
+      @queue.unlock
+      @event_handled.should be_true
+    end
+
+  end
+
+  context "#send" do
+    it "should fire :send with the given message" do
+      @queue.on(:send) { |q, msg| @message = msg}
+      @queue.send("foo")
+      @message.should == "foo"
+    end
+  end
+
+end

data/spec/smirc_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Smirc" do
+  #it "fails" do
+    #fail "hey buddy, you should probably rename this file and start specing for real"
+  #end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'smirc'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: smirc
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Adam Pearson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-27 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mash
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: eventful
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+description: 
+email: ampearson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/smirc.rb
+- lib/smirc/client.rb
+- lib/smirc/queue.rb
+- smirc.gemspec
+- spec/client_spec.rb
+- spec/queue_spec.rb
+- spec/smirc_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/radamant/smirc
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+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: A Simple IRC Client Library for RUby
+test_files: 
+- spec/client_spec.rb
+- spec/queue_spec.rb
+- spec/smirc_spec.rb
+- spec/spec_helper.rb