baseirc 1.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 spox <spox@modspox.com>
+
+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,59 @@
+== BaseIRC
+
+BaseIRC is a very simple library for talking to an IRC server. The only thing
+this library provides is the outgoing communication from your application. (If
+you are looking to handle incoming messages take a look at the MessageFactory
+library.)
+
+=== install (easy):
+
+    gem install baseirc
+
+=== install (less easy)
+
+    git clone http://github.com/spox/baseirc.git
+    cd baseirc
+    gem build *.gemspec
+    gem install ./
+
+=== install (less easy that's a little easier)
+
+{rip}[http://hellorip.com/about.html] makes it easy to install directly from a github repository.
+
+=== Testing
+
+BaseIRC is currently tested on:
+
+* Ruby 1.8.6-p383
+* Ruby 1.8.7-p248
+* Ruby 1.9.1-p376
+* JRuby 1.4.0
+
+== Example
+
+=== Code:
+
+    require 'baseirc'
+
+    socket = []
+    irc = BaseIRC::IRC.new(socket)
+    irc.privmsg('spox', 'hi')
+
+    p socket
+
+=== Result:
+
+    ["PRIVMSG spox :hi"]
+
+The BaseIRC::IRC object takes a socket, or socket like, object. The only thing
+the library requires of this object is that it has << defined.
+
+== Last remarks
+
+If you find any bugs, please report them through {github}[http://github.com/spox/baseirc/issues].
+If you are in need of any help, you can generally find me on DALnet and Freenode.
+
+== License
+
+    BaseIRC is licensed under the MIT License
+    Copyright (c) 2009 spox <spox@modspox.com>

data/Rakefile

@@ -0,0 +1,46 @@
+
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'spec/rake/spectask'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'baseirc'
+  s.version = '1.0'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.rdoc', 'LICENSE']
+  s.summary = 'Library for sending to an IRC server'
+  s.description = s.summary
+  s.author = 'spox'
+  s.email = 'spox@modspox.com'
+  s.files = %w(LICENSE README.rdoc Rakefile) + Dir.glob("{bin,lib,spec}/**/*")
+  s.require_path = "lib"
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  files =['README.rdoc', 'LICENSE', 'lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.rdoc" # page to start on
+  rdoc.title = "BaseIRC Docs"
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*.rb']
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.libs << Dir["lib"]
+end

data/lib/baseirc.rb

@@ -0,0 +1,328 @@
+# BaseIRC module
+module BaseIRC
+    # IRC class for sending communcation to an IRC server
+    class IRC
+        # s:: Socket to send through
+        # Create a new IRC object
+        def initialize(s)
+            @socket = nil
+            self.socket = s
+        end
+
+        # s:: Socket to send through
+        # Set the socket to use
+        def socket=(s)
+            unless(s.respond_to?(:<<))
+                raise ArgumentError.new('Please supply a socket')
+            end
+            @socket = s
+        end
+        
+        # Return currently used socket
+        def socket
+            @socket
+        end
+
+        # password:: Password to send
+        # Sends PASS message
+        def pass(password)
+            @socket << "PASS #{password}"
+        end
+
+        # nick:: Nick to send
+        # Sends NICK message
+        def nick(nick)
+            @socket << "NICK #{nick}"
+        end
+
+        # u:: Username
+        # m:: Mode
+        # r: Real name
+        # Sends USER message
+        def user(u, m, r)
+            @socket << "USER #{u} #{m} * :#{r}"
+        end
+
+        # n:: Name
+        # p:: Password
+        # Sends OPER message
+        def oper(n, p)
+            @socket << "OPER #{n} #{p}"
+        end
+
+        def mode(t, m, c=nil)
+            if(c)
+                @socket << "MODE #{c} #{m} #{t}"
+            else
+                @socket << "MODE #{t} #{m}"
+            end
+        end
+
+        # message:: Quit message
+        # Sends QUIT message
+        def quit(message)
+            @socket << "QUIT :#{message}"
+        end
+
+        # s:: Server
+        # c:: Comment
+        # Sends SQUIT message
+        def squit(s, c)
+            @socket << "SQUIT #{s} :#{c}"
+        end
+
+        # c:: Channel
+        # k:: Key
+        # Sends JOIN message
+        def join(c, k=nil)
+            @socket << "JOIN #{c} #{k}".strip
+        end
+
+        # c:: Channel
+        # r:: Reason
+        # Sends PART message
+        def part(c, r='')
+            @socket << "PART #{c} :#{r}"
+        end
+
+        # c:: Channel
+        # t:: topic
+        # Sends TOPIC message
+        def topic(c, t)
+            @socket << "TOPIC #{c} :#{t}"
+        end
+
+        # c:: Channel
+        # t:: Target server
+        # Sends NAMES message
+        def names(c, t=nil)
+            @socket << "NAMES #{c} #{t}".strip
+        end
+
+        # c:: Channel
+        # Sends LIST message
+        def list(c=nil)
+            @socket << "LIST #{c}".strip
+        end
+
+        # n:: Nick
+        # c:: Channel
+        # Sends INVITE message
+        def invite(n, c)
+            @socket << "INVITE #{n} #{c}"
+        end
+
+        # n:: Nick
+        # c:: Channel
+        # r:: Reason
+        # Sends KICK message
+        def kick(n, c, r)
+            @socket << "KICK #{c} #{n} :#{r}"
+        end
+
+        # t:: Target
+        # m:: Message
+        # Sends PRIVMSG message
+
+        def privmsg(t, m)
+            @socket << "PRIVMSG #{t} :#{m}"
+        end
+
+        # t:: Target
+        # m:: Message
+        # Sends NOTICE message
+        def notice(t, m)
+            @socket << "NOTICE #{t} :#{m}"
+        end
+
+        # t:: Target
+        # Sends MOTD message
+        def motd(t)
+            @socket << "MOTD #{t}"
+        end
+
+        # m:: Mask
+        # t:: Target
+        # Sends LUSERS message
+        def lusers(m, t)
+            @socket << "LUSERS #{m} #{t}"
+        end
+
+        # t:: Target
+        # Sends VERSION message
+        def version(t)
+            @socket << "VERSION #{t}"
+        end
+
+        # q:: Query (single character within set a-z)
+        # t:: Target
+        # Sends STATS message
+        def stats(q, t)
+            unless(q =~ /^[a-z]$/)
+                raise ArgumentError.new('Query must be a single character')
+            end
+            @socket << "STATS #{q} #{t}"
+        end
+
+        # s:: Server
+        # m:: Mask
+        # Sends LINKS message
+        def links(s, m)
+            @socket << "LIST #{s} #{m}"
+        end
+
+        # t:: Target
+        # Sends TIME message
+        def time(t)
+            @socket << "TIME #{t}"
+        end
+
+        # t:: Target server
+        # p:: Port
+        # r:: Remove server
+        # Sends CONNECT message
+        def connect(t, p, r)
+            @socket << "CONNECT #{t} #{p} #{r}"
+        end
+
+        # t:: Target
+        # Sends TRACE message
+        def trace(t)
+            @socket << "TRACE #{t}"
+        end
+
+        # t:: Target
+        # Sends ADMIN message
+        def admin(t)
+            @socket << "ADMIN #{t}"
+        end
+
+        # t:: Target
+        # Sends INFO message
+        def info(t)
+            @socket << "INFO #{t}"
+        end
+
+        # m:: Mask
+        # t:: Type
+        # Sends SERVLIST message
+        def servlist(m, t)
+            @socket << "SERVLIST #{m} #{t}"
+        end
+
+        # s:: Service name
+        # m:: Message
+        # Sends SQUERY message
+        def squery(s, m)
+            @socket << "SQUERY #{s} #{m}"
+        end
+
+        # m:: Mask
+        # o:: Ops only
+        # Sends WHO message
+        def who(m, o=false)
+            o = o ? 'o' : ''
+            @socket << "WHO #{m} #{o}".strip
+        end
+
+        # n:: Nick
+        # s:: Server
+        # Sends WHOIS message
+        # Sends WHOIS message to server
+        def whois(n, s=nil)
+            @socket << "WHOIS #{[s,n].compact.join(' ')}"
+        end
+
+        # n:: Nick
+        # c:: Count
+        # t:: Target
+        # Sends WHOWAS message
+        def whowas(n, c=nil, t=nil)
+            @socket << "WHOWAS #{[n,c,t].compact.join(' ')}"
+        end
+
+        # n:: Nick
+        # c:: Comment
+        # Sends KILL message
+        def kill(n, c)
+            @socket << "KILL #{n} :#{c}"
+        end
+
+        # m:: Message
+        # Sends PING message
+        def ping(m=nil)
+            @socket << "PING #{m}".strip
+        end
+
+        # s:: Server
+        # m:: Message
+        # Sends PONG message
+        def pong(s, m)
+            @socket << "PONG #{s} #{m}"
+        end
+
+        # m:: Message
+        # Sends AWAY message to mark as away
+        def away(m=nil)
+            @socket << "AWAY :#{m}"
+        end
+
+        # Sends AWAY message to mark as unaway
+        def unaway
+            @socket << "AWAY"
+        end
+
+        # Sends REHASH message
+        def rehash
+            @socket << "REHASH"
+        end
+
+        # Sends DIE message
+        def die
+            @socket << "DIE"
+        end
+
+        # Sends RESTART message
+        def restart
+            @socket << "RESTART"
+        end
+
+        # n:: Nick
+        # t:: Target
+        # c:: Channel
+        # Sends SUMMON message
+        def summon(n, t, c)
+            @socket << "SUMMON #{n} #{t} #{c}"
+        end
+
+        # t:: Target
+        # Sends USERS message
+        def users(t)
+            @socket << "USERS #{t}"
+        end
+
+        # m:: Message
+        # Sends WALLOPS message
+        def wallops(m)
+            @socket << "WALLOPS :#{m}"
+        end
+
+        # n:: Nick
+        # Sends USERHOST message to server
+        def userhost(n)
+            @socket << "USERHOST #{n}"
+        end
+
+        # n:: Nick
+        # Sends ISON message to server
+        def ison(n)
+            @socket << "ISON #{n}"
+        end
+
+        # m:: Raw string
+        # Send raw message
+        def raw(m)
+            @socket << m
+        end
+    end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: baseirc
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- spox
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-18 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Library for sending to an IRC server
+email: spox@modspox.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/baseirc.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Library for sending to an IRC server
+test_files: []
+