carrier-pigeon 0.5.0 → 0.6.0

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/README.org

@@ -1,40 +1,64 @@
+[[https://secure.travis-ci.org/portertech/carrier-pigeon.png]]
+
 * Install
 
 : gem install carrier-pigeon
 
 * Usage
 
-: require 'carrier-pigeon'
-: 
-: # In the open
+: require "carrier-pigeon"
+
+Send a private message
+
 : CarrierPigeon.send(
 :   :uri => "irc://nick:password@irc.domain.com:6667/#channel",
 :   :message => "cooooo, coo coo"
 : )
-: 
-: # SSL
+
+Send a notice
+
+: CarrierPigeon.send(
+:   :uri => "irc://nick:password@irc.domain.com:6667/#channel",
+:   :message => "cooooo, coo coo",
+:   :notice => true
+: )
+
+Use SSL
+
 : CarrierPigeon.send(
 :   :uri => "irc://nick:password@irc.domain.com:6667/#channel",
 :   :message => "coo, secret plan",
 :   :ssl => true
 : )
-: 
-: # Join a channel (required for most Freenode channels)
+
+Join a channel (required for most Freenode channels)
+
 : CarrierPigeon.send(
 :   :uri => "irc://nick:password@irc.domain.com:6667/#channel",
 :   :message => "cooooo, part of the flock",
 :   :join => true
 : )
-: 
-: # Join a channel that requires a password
+
+Join a channel that requires a password
+
 : CarrierPigeon.send(
 :   :uri => "irc://nick:password@irc.domain.com:6667/#channel",
 :   :message => "coo, the password is ..."
 :   :channel_password => "secret",
 :   :join => true
 : )
-: 
-: # Register (ping reply) prior to joining or messaging a channel (required for some private servers)
+
+Identify with NickServ
+
+: CarrierPigeon.send(
+:   :uri => "irc://nick:password@irc.domain.com:6667/#channel",
+:   :message => "nickserv, coo coo",
+:   :nickserv_password => "secret"
+: )
+
+Register (ping reply) prior to joining or messaging a channel
+(required for some private servers)
+
 : CarrierPigeon.send(
 :   :uri => "irc://nick:password@irc.domain.com:6667/#channel",
 :   :message => "cooooo, coo coo",

data/Rakefile

@@ -1,2 +1,10 @@
-require 'bundler'
+require "bundler"
+require "rake/testtask"
+
 Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |test|
+  test.pattern = "test/*_tests.rb"
+end
+
+task :default => "test"

data/carrier-pigeon.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "carrier-pigeon"
-  s.version     = "0.5.0"
+  s.version     = "0.6.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Sean Porter"]
   s.email       = ["portertech@gmail.com"]
@@ -14,6 +14,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency("addressable")
 
+  s.add_development_dependency("rake")
+
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ["lib"]
 end

data/lib/carrier-pigeon.rb

@@ -32,11 +32,16 @@ class CarrierPigeon
         end
       end
     end
-    sendln "JOIN #{options[:channel]} #{options[:channel_password]}" if options[:join]
+    if options[:join]
+      join = "JOIN #{options[:channel]}"
+      join += " #{options[:channel_password]}" if options[:channel_password]
+      sendln join
+    end
   end
 
-  def message(channel, message)
-    sendln "PRIVMSG #{channel} :#{message}"
+  def message(channel, message, notice = false)
+    command = notice ? "NOTICE" : "PRIVMSG"
+    sendln "#{command} #{channel} :#{message}"
   end
 
   def die
@@ -59,7 +64,7 @@ class CarrierPigeon
         "PRIVMSG NICKSERV :IDENTIFY #{options[:nickserv_password]}"
     end
     pigeon = new(options)
-    pigeon.message(options[:channel], options[:message])
+    pigeon.message(options[:channel], options[:message], options[:notice])
     pigeon.die
   end
 

data/test/send_tests.rb

@@ -0,0 +1,139 @@
+require "minitest/spec"
+require "minitest/autorun"
+require "socket"
+
+require File.join(File.dirname(__FILE__), "..", "lib", "carrier-pigeon")
+
+PRIVATE_MESSAGE = <<"EXPECTED"
+NICK foo
+USER foo 0 * :foo
+PRIVMSG #test :test
+QUIT :quit
+EXPECTED
+
+NOTICE = <<"EXPECTED"
+NICK foo
+USER foo 0 * :foo
+NOTICE #test :test
+QUIT :quit
+EXPECTED
+
+JOIN = <<"EXPECTED"
+NICK foo
+USER foo 0 * :foo
+JOIN #test
+PRIVMSG #test :test
+QUIT :quit
+EXPECTED
+
+JOIN_PASSWORD = <<"EXPECTED"
+NICK foo
+USER foo 0 * :foo
+JOIN #test bar
+PRIVMSG #test :test
+QUIT :quit
+EXPECTED
+
+REGISTER = <<"EXPECTED"
+NICK foo
+USER foo 0 * :foo
+PONG :hello
+PRIVMSG #test :test
+QUIT :quit
+EXPECTED
+
+NICKSERV_PASSWORD = <<"EXPECTED"
+NICK foo
+USER foo 0 * :foo
+PRIVMSG NICKSERV :IDENTIFY bar
+PRIVMSG #test :test
+QUIT :quit
+EXPECTED
+
+describe CarrierPigeon do
+
+  before do
+    @server_received = ""
+    @tcp_server = TCPServer.new(16667)
+    Thread.new do
+      socket = @tcp_server.accept
+      socket.puts "PING :hello"
+      while line = socket.gets
+        @server_received << line
+        socket.close if line =~ /:quit/
+      end
+    end
+  end
+
+  after do
+    @tcp_server.close
+    sleep 1
+  end
+
+  it "can send a private message to an irc channel" do
+    CarrierPigeon.send(
+      :uri => "irc://foo@localhost:16667/#test",
+      :message => "test"
+    )
+    @server_received.must_equal(PRIVATE_MESSAGE)
+  end
+
+  it "can send a notice to an irc channel" do
+    CarrierPigeon.send(
+      :uri => "irc://foo@localhost:16667/#test",
+      :message => "test",
+      :notice => true
+    )
+    @server_received.must_equal(NOTICE)
+  end
+
+  it "can join an irc channel and send a private message" do
+    CarrierPigeon.send(
+      :uri => "irc://foo@localhost:16667/#test",
+      :message => "test",
+      :join => true
+    )
+    @server_received.must_equal(JOIN)
+  end
+
+  it "can join an irc channel with a password and send a private message" do
+    CarrierPigeon.send(
+      :uri => "irc://foo@localhost:16667/#test",
+      :message => "test",
+      :channel_password => "bar",
+      :join => true
+    )
+    @server_received.must_equal(JOIN_PASSWORD)
+  end
+
+  it "can identify with nickserv and send a private message to an irc channel" do
+    CarrierPigeon.send(
+      :uri => "irc://foo@localhost:16667/#test",
+      :message => "test",
+      :nickserv_password => "bar"
+    )
+    @server_received.must_equal(NICKSERV_PASSWORD)
+  end
+
+  it "can require registration and send a private message to an irc channel" do
+    CarrierPigeon.send(
+      :uri => "irc://foo@localhost:16667/#test",
+      :message => "test",
+      :register_first => true
+    )
+    @server_received.must_equal(REGISTER)
+  end
+
+  it "must be provided an irc uri" do
+    lambda {
+      CarrierPigeon.send(:message => "test")
+    }.must_raise RuntimeError
+  end
+
+  it "must be provided an irc message" do
+    lambda {
+      CarrierPigeon.send(:uri => "irc://foo@localhost:16667/#test")
+    }.must_raise RuntimeError
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: carrier-pigeon
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Sean Porter
@@ -15,12 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-04 00:00:00 -07:00
+date: 2012-09-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: addressable
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -31,7 +29,23 @@ dependencies:
         - 0
         version: "0"
   type: :runtime
+  name: addressable
+  prerelease: false
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rake
+  prerelease: false
+  version_requirements: *id002
 description: The simplest library to say something on IRC
 email: 
 - portertech@gmail.com
@@ -43,12 +57,14 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - Gemfile
 - MIT-LICENSE.txt
 - README.org
 - Rakefile
 - carrier-pigeon.gemspec
 - lib/carrier-pigeon.rb
+- test/send_tests.rb
 has_rdoc: true
 homepage: https://github.com/portertech/carrier-pigeon
 licenses: