Git Product home page Git Product logo

zircon's Introduction

Zircon

IRC client library written in Pure Ruby.

Installation

$ gem install zircon

Example

require "zircon"

client = Zircon.new(
  :server   => "example.com",
  :port     => "6667",
  :channel  => "#chatroid",
  :username => "zircon"
)

client.on_privmsg do |message|
  client.privmsg "#chatroid", ":zircon!"
end

client.on_message do |message|
  puts "*** `on_message` responds with all received message ***"
  puts message.from
  puts message.to
  puts message.type
  puts message.body
end

client.run!

Features

IRC has following commands.

ADMIN   KICK    MOTD     QUIT     VERSION
AWAY    KNOCK   NAMES    RULES    VHOST
CREDITS LICENSE NICK     SETNAME  WATCH
CYCLE   LINKS   NOTICE   SILENCE  WHO
DALINFO LIST    PART     STATS    WHOIS
INVITE  LUSERS  PING     TIME     WHOWAS
ISON    MAP     PONG     TOPIC    USER
JOIN    MODE    PASS     USERHOST PRIVMSG

You can use sender and receiver methods for each commands.

# For example about PRIVMSG
# [sender - privmsg]
privmsg("#channel", ":Hello")

# [receiver - on_privmsg]
on_privmsg {|message| puts message.body }

zircon's People

Contributors

r7kamura avatar toqoz avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.