zircon 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zircon.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ryo NAKAMURA
+
+MIT License
+
+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.md

@@ -0,0 +1,27 @@
+# Zircon
+IRC client library written in Pure Ruby.
+
+## Installation
+
+```
+$ gem install zircon
+```
+
+## Example
+
+```ruby
+require "zircon"
+
+client = Zircon.new(
+  :server   => "chat.freenode.net",
+  :port     => "6667",
+  :channel  => "#chatroid",
+  :username => "zircon"
+)
+
+client.on_privmsg do |message|
+  client.privmsg "#chatroid", ":zircon!"
+end
+
+client.run!
+```

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/zircon.rb

@@ -0,0 +1,114 @@
+require "zircon/version"
+require "zircon/callback"
+require "zircon/message"
+require "socket"
+
+class Zircon
+  include Callback
+
+  attr_accessor(
+    :server,
+    :port,
+    :channel,
+    :username,
+    :nickname,
+    :realname
+  )
+
+  COMMAND_NAMES = %w[
+    ADMIN
+    AWAY
+    CREDITS
+    CYCLE
+    DALINFO
+    INVITE
+    ISON
+    JOIN
+    KICK
+    KNOCK
+    LICENSE
+    LINKS
+    LIST
+    LUSERS
+    MAP
+    MODE
+    MOTD
+    NAMES
+    NICK
+    NOTICE
+    PART
+    PASS
+    PING
+    PONG
+    PRIVMSG
+    QUIT
+    RULES
+    SETNAME
+    SILENCE
+    STATS
+    TIME
+    TOPIC
+    USER
+    USERHOST
+    VERSION
+    VHOST
+    WATCH
+    WHO
+    WHOIS
+    WHOWAS
+  ].freeze
+
+  def initialize(args = {})
+    @server       = args[:server]
+    @port         = args[:port]
+    @channel      = args[:channel]
+    @password     = args[:password]
+    @username     = args[:username]
+    @nickname     = args[:nickname] || @username
+    @realname     = args[:realname] || @username
+    on_ping { |message| pong(message.text) }
+  end
+
+  def run!
+    login
+    wait_message
+  end
+
+  COMMAND_NAMES.each do |name|
+    define_method(name.downcase) do |*params|
+      command(name, *params)
+    end
+  end
+
+  private
+
+  def login
+    pass @password if @password
+    nick @nickname
+    user @username, 0, "*", ":" + @realname
+    join @channel if @channel
+  end
+
+  def wait_message
+    loop do
+      message = Message.new(gets)
+      send("trigger_#{message.type}", message)
+    end
+  end
+
+  def command(*args)
+    write(args * " " + "\r\n")
+  end
+
+  def write(text)
+    socket << text
+  end
+
+  def gets
+    socket.gets
+  end
+
+  def socket
+    @socket ||= TCPSocket.new(@server, @port)
+  end
+end

data/lib/zircon/callback.rb

@@ -0,0 +1,37 @@
+class Zircon
+  # You can call methods like this:
+  # * list_message    : return Array of callbacks for "message"
+  # * on_message      : store a given block as callback for "message"
+  # * trigger_message : trigger callbacks for "message" with given args
+  module Callback
+    private
+
+    def method_missing(method_name, *args, &block)
+      if method_name =~ /(list|on|trigger)_([a-z0-9]+)/
+        send($1, $2, *args, &block)
+      else
+        super
+      end
+    end
+
+    def list(type)
+      callbacks[type]
+    end
+
+    def on(type, &block)
+      callbacks[type] << block
+    end
+
+    def trigger(type, *args)
+      callbacks[type].each do |callback|
+        callback.call(*args)
+      end
+    end
+
+    def callbacks
+      @callbacks ||= Hash.new do |hash, key|
+        hash[key] = []
+      end
+    end
+  end
+end

data/lib/zircon/message.rb

@@ -0,0 +1,48 @@
+require "zircon/message/patterns"
+
+class Zircon
+  class Message
+    attr_reader :prefix, :command, :text
+
+    def initialize(text)
+      if match = Patterns::MESSAGE_PATTERN.match(text)
+        @text    = text
+        @prefix  = match[1]
+        @command = match[2]
+        @rest    = match[3..-1]
+      else
+        raise ArgumentError.new("Invalid message")
+      end
+    end
+
+    def type
+      @type ||= @command.to_s.downcase
+    end
+
+    def name
+      @name ||= begin
+        @prefix && @prefix.split("!").first
+      end
+    end
+
+    def params
+      @params ||= begin
+        params = []
+        case
+        when !@rest[0].blank?
+          middle, trailer, = *@rest
+          params = middle.split(" ")
+        when !@rest[2].blank?
+          middle, trailer, = *@rest[2, 2]
+          params = middle.split(" ")
+        when @rest[1]
+          trailer = @rest[1]
+        when @rest[3]
+          trailer = @rest[3]
+        end
+        params << trailer if trailer
+        params
+      end
+    end
+  end
+end

data/lib/zircon/message/patterns.rb

@@ -0,0 +1,47 @@
+# coding: ASCII-8BIT
+
+class Zircon
+  class Message
+    module Patterns
+      # IRC Message Pseudo BNF code
+      # http://www.haun.org/kent/lib/rfc1459-irc-ja.html
+      # ------------------------------------------------
+      # <message>  ::= [':' <prefix> <SPACE> ] <command> <params> <crlf>
+      # <prefix>   ::= <servername> | <nick> [ '!' <user> ] [ '@' <host> ]
+      # <command>  ::= <letter> { <letter> } | <number> <number> <number>
+      # <SPACE>    ::= ' ' { ' ' }
+      # <params>   ::= <SPACE> [ ':' <trailing> | <middle> <params> ]
+      # <middle>   ::= <先頭が':'ではなく,SPACE,NUL,CR,CFを含まない、空でないオクテットの列>
+      # <trailing> ::= <SPACE,NUL,CR,CFを含まないオクテットの列(空のオクッテトの列も可)>
+      # <crlf>     ::= CR LF
+
+      # unit
+      DIGIT      = "0-9"
+      LETTER     = "A-Za-z"
+      HEXDIGIT   = "#{DIGIT}A-Fa-f"
+      CRLF       = '\x0D\x0A'
+      NOSPCRLFCL = '\x01-\x09\x0B-\x0C\x0E-\x1F\x21-\x39\x3B-\xFF'
+
+      # units
+      COMMAND    = "(?:[#{LETTER}]+|[#{DIGIT}]{3})"
+      SHORTNAME  = "[#{LETTER}#{DIGIT}](?:[-#{LETTER}#{DIGIT}]*[#{LETTER}#{DIGIT}])?"
+      HOSTNAME   = "#{SHORTNAME}(?:\\.#{SHORTNAME})*"
+      SERVERNAME = HOSTNAME
+      IP4ADDR    = "\d{1,3}(?:\\.\d{1,3}){3}"
+      IP6ADDR    = "(?:[#{HEXDIGIT}]+(?::[#{HEXDIGIT}]+){7}|0:0:0:0:0:(?:0|FFFF):#{IP4ADDR})"
+      HOSTADDR   = "(?:#{IP4ADDR}|#{IP6ADDR})"
+      HOST       = "(?:#{HOSTNAME}|#{HOSTADDR})"
+      USER       = '[\x01-\x09\x0B-\x0C\x0E-\x1F\x21-\x3F\x41-\xFF]+'
+      NICKNAME   = "\\S+"
+      MIDDLE     = "[#{NOSPCRLFCL}][:#{NOSPCRLFCL}]*"
+      TRAILING   = "[: #{NOSPCRLFCL}]*"
+      PARAMS     = "(?:((?: #{MIDDLE}){0,14})(?: :(#{TRAILING}))?|((?: #{MIDDLE}){14}):?(#{TRAILING}))"
+      PREFIX     = "(?:#{NICKNAME}(?:(?:!#{USER})?@#{HOST})?|#{SERVERNAME})"
+      MESSAGE    = "(?::(#{PREFIX}) )?(#{COMMAND})#{PARAMS}\s*#{CRLF}"
+
+      # pattern
+      CLIENT_PATTERN  = /\A#{NICKNAME}(?:(?:!#{USER})?@#{HOST})\z/on
+      MESSAGE_PATTERN = /\A#{MESSAGE}\z/on
+    end
+  end
+end

data/lib/zircon/version.rb

@@ -0,0 +1,3 @@
+class Zircon
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "zircon"

data/spec/zircon_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe Zircon do
+  describe "#run!" do
+    it "should try to login and wait message from server" do
+      Zircon.any_instance.should_receive(:login)
+      Zircon.any_instance.should_receive(:wait_message)
+      Zircon.new.run!
+    end
+  end
+
+  describe "#wait_message" do
+    it "should trigger callback related to message type" do
+      message = mock
+      message.stub(:type).and_return("xxx")
+      Zircon::Message.stub(:new).and_return(message)
+      Zircon.any_instance.stub(:loop) { |&block| block.call }
+      Zircon.any_instance.stub(:login)
+      Zircon.any_instance.stub(:gets)
+      Zircon.any_instance.should_receive(:trigger_xxx).with(message)
+      Zircon.new.run!
+    end
+  end
+
+  describe "IRC command method (#join, #kick, #notice, ...)" do
+    it "should write type and args in space-separated form to socket" do
+      Zircon.any_instance.should_receive(:write).with("PRIVMSG channel :message\r\n")
+      Zircon.new.privmsg("channel", ":message")
+    end
+  end
+end

data/zircon.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/zircon/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ryo NAKAMURA"]
+  gem.email         = ["r7kamura@gmail.com"]
+  gem.description   = "Zircon is a mineral belonging to the group of nesosilicates."
+  gem.summary       = "IRC client library written in Pure Ruby"
+  gem.homepage      = "https://github.com/r7kamura/zircon"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "zircon"
+  gem.require_paths = ["lib"]
+  gem.version       = Zircon::VERSION
+
+  gem.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: zircon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryo NAKAMURA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70144831922480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70144831922480
+description: Zircon is a mineral belonging to the group of nesosilicates.
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/zircon.rb
+- lib/zircon/callback.rb
+- lib/zircon/message.rb
+- lib/zircon/message/patterns.rb
+- lib/zircon/version.rb
+- spec/spec_helper.rb
+- spec/zircon_spec.rb
+- zircon.gemspec
+homepage: https://github.com/r7kamura/zircon
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: IRC client library written in Pure Ruby
+test_files:
+- spec/spec_helper.rb
+- spec/zircon_spec.rb
+has_rdoc: