documentation: Update forge urls

Fix dependency name

.gitignore

@@ -6,3 +6,4 @@
 # Libraries don't need dependency lock
 # Dependencies will be locked in application that uses them
 /shard.lock
+/docs

.travis.yml

@@ -1 +1,14 @@
 language: crystal
+
+script:
+  - crystal spec
+  - crystal docs
+
+deploy:
+  provider: pages
+  skip_cleanup: true
+  github_token: $GITHUB_TOKEN
+  project_name: Crirc
+  on:
+    branch: master
+  local_dir: docs

CHANGELOG.md

@@ -0,0 +1,23 @@
+# v0.1.0
+* Initialize the project
+* IRC API
+  * Objects
+    * User (represent a nick, id, whois)
+    * Chan (a chan with users, name)
+    * Client (a socket associated to an user)
+    * Nick (availability, ...)
+  * Actions
+    * Handles one <-> one messages)
+    * Handles one <-> many messages
+    * Handles the connection and IO (connect, send, recv)
+    * Masks (rights, ...)
+    * Use Commands (Talk, Chan, User)
+      * JOIN, PRIVSG, NOTICE, MODE, ...
+      * OP, DEOP, BAN, ...
+* Bot Framework
+  * Set hooks and rules to trigger actions
+  * Manage connected Users and Channels
+* Robust testing and documentation
+  * Specs on the complete API and protocol
+  * Specs on the Framwork with basic and advanced use-cases
+  * Real bot samples

LICENSE

@@ -1,23 +1,21 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
                             Preamble
 
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
 
   The licenses for most software and other practical works are designed
 to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
+our General Public Licenses are intended to guarantee your freedom to
 share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
+software for all its users.
 
   When we speak of free software, we are referring to freedom, not
 price.  Our General Public Licenses are designed to make sure that you
@@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
 want it, that you can change the software or use pieces of it in new
 free programs, and that you know you can do these things.
 
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
 
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
 
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
 
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
 
   The precise terms and conditions for copying, distribution and
 modification follow.
@@ -72,7 +60,7 @@ modification follow.
 
   0. Definitions.
 
-  "This License" refers to version 3 of the GNU General Public License.
+  "This License" refers to version 3 of the GNU Affero General Public License.
 
   "Copyright" also means copyright-like laws that apply to other kinds of
 works, such as semiconductor masks.
@@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
 the Program, the only way you could satisfy both those terms and this
 License would be to refrain entirely from conveying the Program.
 
-  13. Use with the GNU Affero General Public License.
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
 
   Notwithstanding any other provision of this License, you have
 permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
+under version 3 of the GNU General Public License into a single
 combined work, and to convey the resulting work.  The terms of this
 License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
 
   14. Revised Versions of this License.
 
   The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
 address new problems or concerns.
 
   Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
+Program specifies that a certain numbered version of the GNU Affero General
 Public License "or any later version" applies to it, you have the
 option of following the terms and conditions either of that numbered
 version or of any later version published by the Free Software
 Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
+GNU Affero General Public License, you may choose any version ever published
 by the Free Software Foundation.
 
   If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
+versions of the GNU Affero General Public License can be used, that proxy's
 public statement of acceptance of a version permanently authorizes you
 to choose that version for the Program.
 
@@ -631,44 +629,33 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    {one line to give the program's name and a brief idea of what it does.}
-    Copyright (C) {year}  {name of author}
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
 
     This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.
 
     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
+    GNU Affero General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    {project}  Copyright (C) {year}  {fullname}
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
 
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<https://www.gnu.org/licenses/>.

Makefile

@@ -3,9 +3,7 @@ all: deps_opt test
 test:
 	crystal spec
 deps:
-	crystal deps install
-deps_update:
-	crystal deps update
+	shards install
 deps_opt:
 	@[ -d lib/ ] || make deps
 doc:

README.md

@@ -2,36 +2,36 @@
 
 A crystal library to create irc client/bot/server.
 
-Works with crystal v0.23.0
-
-
 ## Installation
 
-[![travis](https://travis-ci.org/Meoowww/Crirc.svg)](https://travis-ci.org/Meoowww/Crirc)
+github mirror: [![travis](https://travis-ci.org/Meoowww/Crirc.svg)](https://travis-ci.org/Meoowww/Crirc)
 
-To install the lib, you will have to add the CrystalIrc dependancy to your project.
+To install the lib, you will have to add the Crirc dependency to your project.
 
 Add this to your application's `shard.yml`:
 
 ```yaml
 dependencies:
-  CrystalIrc:
-    github: Meoowww/Crirc
+  crirc:
+    git: https://git.sceptique.eu/Sceptique/Crirc
+    branch: master
 ```
 
 Then, run ``crystal deps install`` to fetch the lib.
 
-## Development
+## Documentation
 
-- Network: A network object manage a socket / IO
-- Controller: A controller belongs to a network object, and handle the logic and data
-- Protocol: A protocol object represent a IRC entity (chan, user, message, ...)
-- Binding: The binding socket to allow the system to respond to incoming transmissions
+The documentation is built automaticaly when a commit is pushed on master on github, via Travis: <https://meoowww.github.io/Crirc/>.
+This explains the architecture and design on the library, and details the technical informations about the internal & external API.
+
+Specifications (unit tests) are written into the `/spec` directory.
+
+A full implementation of a bot is published and maintained on <https://git.sceptique.eu/Sceptique/DashBot>.
 
 
 ## Contributing
 
-1. Fork it ( https://github.com/Meoowww/Crirc/fork )
+1. Fork it ( https://git.sceptique.eu/Sceptique/Crirc/fork )
 2. Create your feature branch (git checkout -b my-new-feature)
 3. Commit your changes (git commit -am 'Add some feature')
 4. Push to the branch (git push origin my-new-feature)
@@ -40,5 +40,5 @@ Then, run ``crystal deps install`` to fetch the lib.
 
 ## Contributors
 
-- [Nephos](https://github.com/Nephos) Arthur Poulet - creator, maintainer
+- [Sceptique](https://git.sceptique.eu/Sceptique) Arthur Poulet - creator, maintainer
 - [Damaia](https://github.com/Lucie-Dispot) Lucie Dispot - developer

shard.yml

@@ -1,9 +1,9 @@
 name: crirc
-version: 0.1.0
+version: 0.5.1
 
 authors:
   - Arthur Poulet <arthur.poulet@sceptique.eu>
 
-crystal: 0.23.1
+crystal: 1.0.0
 
 license: MIT

spec/binding/trigger.cr

@@ -1,10 +1,10 @@
-describe Crirc::Binding::HookTest do
+describe Crirc::Binding::Trigger do
   it "simple test" do
     m1 = Crirc::Protocol::Message.new ":source PRIVMSG arguments :message"
-    t1 = Crirc::Binding::HookTest.new "PRIVMSG"
-    t2 = Crirc::Binding::HookTest.new "PRIVMSG", "source"
-    t3 = Crirc::Binding::HookTest.new "PRIVMSG", "source", "arguments"
-    t4 = Crirc::Binding::HookTest.new "PRIVMSG", "source", "arguments", "message"
+    t1 = Crirc::Binding::Trigger.new "PRIVMSG"
+    t2 = Crirc::Binding::Trigger.new "PRIVMSG", "source"
+    t3 = Crirc::Binding::Trigger.new "PRIVMSG", "source", "arguments"
+    t4 = Crirc::Binding::Trigger.new "PRIVMSG", "source", "arguments", "message"
     t1.test(m1).should be_true
     t2.test(m1).should be_true
     t3.test(m1).should be_true
@@ -13,7 +13,7 @@ describe Crirc::Binding::HookTest do
 
   it "simple test" do
     m = Crirc::Protocol::Message.new ":source PRIVMSG nick :!ping me"
-    t = Crirc::Binding::HookTest.new "PRIVMSG", message: /^!ping/
+    t = Crirc::Binding::Trigger.new "PRIVMSG", message: /^!ping/
     t.test(m).should be_a(Regex::MatchData)
   end
 end

spec/controller/command/chan.cr

@@ -3,7 +3,7 @@ module Crirc::Test::Controller::Command::Chan
   extend self
 
   def puts(data)
-    data
+    data.strip
   end
 end
 
@@ -12,9 +12,9 @@ describe Crirc::Controller::Command::Chan do
     chan = Crirc::Protocol::Chan.new "#patate"
     chan2 = Crirc::Protocol::Chan.new "#nyu"
 
-    Crirc::Test::Controller::Command::Chan.join({chan}).should eq("JOIN #patate ")
-    Crirc::Test::Controller::Command::Chan.join(chan).should eq("JOIN #patate ")
-    Crirc::Test::Controller::Command::Chan.join({chan, chan2}).should eq("JOIN #patate,#nyu ")
+    Crirc::Test::Controller::Command::Chan.join({chan}).should eq("JOIN #patate")
+    Crirc::Test::Controller::Command::Chan.join(chan).should eq("JOIN #patate")
+    Crirc::Test::Controller::Command::Chan.join({chan, chan2}).should eq("JOIN #patate,#nyu")
     Crirc::Test::Controller::Command::Chan.join({chan}, {"bloup"}).should eq("JOIN #patate bloup")
     Crirc::Test::Controller::Command::Chan.join({chan, chan2}, {"bloup", "blip"}).should eq("JOIN #patate,#nyu bloup,blip")
   end
@@ -23,9 +23,9 @@ describe Crirc::Controller::Command::Chan do
     chan = Crirc::Protocol::Chan.new "#patate"
     chan2 = Crirc::Protocol::Chan.new "#nyu"
 
-    Crirc::Test::Controller::Command::Chan.part({chan}).should eq("PART #patate ")
-    Crirc::Test::Controller::Command::Chan.part(chan).should eq("PART #patate ")
-    Crirc::Test::Controller::Command::Chan.part({chan, chan2}).should eq("PART #patate,#nyu ")
+    Crirc::Test::Controller::Command::Chan.part({chan}).should eq("PART #patate")
+    Crirc::Test::Controller::Command::Chan.part(chan).should eq("PART #patate")
+    Crirc::Test::Controller::Command::Chan.part({chan, chan2}).should eq("PART #patate,#nyu")
     Crirc::Test::Controller::Command::Chan.part({chan}, "I'm out").should eq("PART #patate :I'm out")
     Crirc::Test::Controller::Command::Chan.part(chan, "I'm out").should eq("PART #patate :I'm out")
     Crirc::Test::Controller::Command::Chan.part({chan, chan2}, "I'm out").should eq("PART #patate,#nyu :I'm out")
@@ -36,10 +36,10 @@ describe Crirc::Controller::Command::Chan do
     chan = Crirc::Protocol::Chan.new "#patate"
     chan2 = Crirc::Protocol::Chan.new "#nyu"
 
-    Crirc::Test::Controller::Command::Chan.mode(chan, "+a").should eq("MODE #patate +a ")
+    Crirc::Test::Controller::Command::Chan.mode(chan, "+a").should eq("MODE #patate +a")
     Crirc::Test::Controller::Command::Chan.mode(chan, "+b", target).should eq("MODE #patate +b nyupnyup")
 
-    Crirc::Test::Controller::Command::Chan.topic(chan).should eq("TOPIC #patate ")
+    Crirc::Test::Controller::Command::Chan.topic(chan).should eq("TOPIC #patate")
     Crirc::Test::Controller::Command::Chan.topic(chan, "bloup").should eq("TOPIC #patate :bloup")
 
     Crirc::Test::Controller::Command::Chan.invite(chan, target).should eq("INVITE nyupnyup #patate")
@@ -49,7 +49,7 @@ describe Crirc::Controller::Command::Chan do
     chan = Crirc::Protocol::Chan.new "#patate"
     chan2 = Crirc::Protocol::Chan.new "#nyu"
 
-    Crirc::Test::Controller::Command::Chan.names(nil).should eq("NAMES ")
+    Crirc::Test::Controller::Command::Chan.names(nil).should eq("NAMES")
     Crirc::Test::Controller::Command::Chan.names(chan).should eq("NAMES #patate")
     Crirc::Test::Controller::Command::Chan.names({chan}).should eq("NAMES #patate")
     Crirc::Test::Controller::Command::Chan.names({chan, chan2}).should eq("NAMES #patate,#nyu")
@@ -59,7 +59,7 @@ describe Crirc::Controller::Command::Chan do
     chan = Crirc::Protocol::Chan.new "#patate"
     chan2 = Crirc::Protocol::Chan.new "#nyu"
 
-    Crirc::Test::Controller::Command::Chan.list(nil).should eq("LIST ")
+    Crirc::Test::Controller::Command::Chan.list(nil).should eq("LIST")
     Crirc::Test::Controller::Command::Chan.list(chan).should eq("LIST #patate")
     Crirc::Test::Controller::Command::Chan.list({chan}).should eq("LIST #patate")
     Crirc::Test::Controller::Command::Chan.list({chan, chan2}).should eq("LIST #patate,#nyu")
@@ -71,13 +71,13 @@ describe Crirc::Controller::Command::Chan do
     chan = Crirc::Protocol::Chan.new "#patate"
     chan2 = Crirc::Protocol::Chan.new "#nyu"
 
-    Crirc::Test::Controller::Command::Chan.kick({chan}, {target}).should eq("KICK #patate nyupnyup ")
-    Crirc::Test::Controller::Command::Chan.kick(chan, target).should eq("KICK #patate nyupnyup ")
-    Crirc::Test::Controller::Command::Chan.kick({chan, chan2}, {target}).should eq("KICK #patate,#nyu nyupnyup ")
-    Crirc::Test::Controller::Command::Chan.kick({chan, chan2}, target).should eq("KICK #patate,#nyu nyupnyup ")
-    Crirc::Test::Controller::Command::Chan.kick({chan}, {target, target2}).should eq("KICK #patate nyupnyup,gloubi ")
-    Crirc::Test::Controller::Command::Chan.kick(chan, {target, target2}).should eq("KICK #patate nyupnyup,gloubi ")
-    Crirc::Test::Controller::Command::Chan.kick({chan, chan2}, {target, target2}).should eq("KICK #patate,#nyu nyupnyup,gloubi ")
+    Crirc::Test::Controller::Command::Chan.kick({chan}, {target}).should eq("KICK #patate nyupnyup")
+    Crirc::Test::Controller::Command::Chan.kick(chan, target).should eq("KICK #patate nyupnyup")
+    Crirc::Test::Controller::Command::Chan.kick({chan, chan2}, {target}).should eq("KICK #patate,#nyu nyupnyup")
+    Crirc::Test::Controller::Command::Chan.kick({chan, chan2}, target).should eq("KICK #patate,#nyu nyupnyup")
+    Crirc::Test::Controller::Command::Chan.kick({chan}, {target, target2}).should eq("KICK #patate nyupnyup,gloubi")
+    Crirc::Test::Controller::Command::Chan.kick(chan, {target, target2}).should eq("KICK #patate nyupnyup,gloubi")
+    Crirc::Test::Controller::Command::Chan.kick({chan, chan2}, {target, target2}).should eq("KICK #patate,#nyu nyupnyup,gloubi")
     Crirc::Test::Controller::Command::Chan.kick({chan, chan2}, {target, target2}, "Get out").should eq("KICK #patate,#nyu nyupnyup,gloubi :Get out")
     Crirc::Test::Controller::Command::Chan.kick({chan}, {target}, "Get out").should eq("KICK #patate nyupnyup :Get out")
     Crirc::Test::Controller::Command::Chan.kick(chan, target, "Get out").should eq("KICK #patate nyupnyup :Get out")

spec/controller/command/ping.cr

@@ -3,7 +3,7 @@ module Crirc::Test::Controller::Command::Ping
   extend self
 
   def puts(data)
-    data
+    data.strip
   end
 end
 

spec/controller/command/talk.cr

@@ -3,7 +3,7 @@ module Crirc::Test::Controller::Command::Talk
   extend self
 
   def puts(data)
-    data
+    data.strip
   end
 end
 

spec/controller/command/user.cr

@@ -3,7 +3,7 @@ module Crirc::Test::Controller::Command::User
   extend self
 
   def puts(data)
-    data
+    data.strip
   end
 end
 

src/crirc.cr

@@ -1,3 +1,20 @@
+# The Crirc module contains all the object related to the project.
+# It uses 4 layers of objects:
+#
+# 1. **Network**: A network object manage a socket / I0.
+#    The interface is described by `Crirc::Network::Network`.
+# 2. **Controller**: A controller belongs to a network object,
+#    and handle the logic and data. Its interface is described by
+#    `Crirc::Controller::Controller`.
+# 3. **Protocol**: A protocol object represent a IRC entity
+#    (chan, user, message, ...).
+# 4. **Broadcast**: The `Broadcast` allows the system to send transmission to
+#    several IRC entity as one.
+# 5. **Binding**: The `Binding::Handler` allows a given `Controller` to respond
+#    to incoming transmissions.
+module Crirc
+end
+
 require "./crirc/network/*"
 require "./crirc/controller/*"
 require "./crirc/protocol/*"

src/crirc/binding/handler.cr

@@ -1,29 +1,55 @@
-require "./hook_test"
+require "./trigger"
 
-# Register hooks to handle the behavior of a system based on a message.
+# This class is designed to be able to automaticaly respond to incoming IRC
+# messages on a set conditions.
+# The flow of this system is the following:
+# 1. With `.on()`, defines a Trigger and the associated Hook
+# 2. Call `.handle()` to process the incoming IRC message.
+#
+# ```
+# bot.on("PRIVMSG", message: /^(Hello|Hi)$/) { |msg, data| bot.reply(msg, "Hello !") }
+# while (incoming_message = io.gets) do
+#   bot.handle(incoming_message)
+# end
+# ```
 module Crirc::Binding::Handler
   alias HookRule = String | Regex | Nil
   alias Hook = (Crirc::Protocol::Message, Regex::MatchData?) ->
 
-  getter hooks : Hash(HookTest, Array(Hook))
+  # Hooks associated with `Trigger`
+  getter hooks : Hash(Trigger, Array(Hook))
+
+  # Documentation lines for each hook
+  getter docs : Hash(String, String)
 
   def initialize(**opts)
     super(**opts)
-    @hooks = Hash(HookTest, Array(Hook)).new
+    @hooks = Hash(Trigger, Array(Hook)).new
+    @docs = Hash(String, String).new
   end
 
-  # Register a hook on a command name (JOIN, PRIVMSG, ...) and other rules
-  def on(command : String, source : HookRule = nil, arguments : HookRule = nil, message : HookRule = nil, &hook : Hook)
-    rule = HookTest.new(command, source, arguments, message)
+  # Register a news Hook that is called when the incoming messages meet a set
+  # of conditions: command name (JOIN, PRIVMSG, ...), source, arguments, message.
+  #
+  # - command : Condition that match exactly with the command of the incomming message.
+  # - source : Condition that match with the source of the incomming message.
+  # - arguments : Condition that match with the arguments of the incomming message.
+  # - message : Condition that match with the message of the incomming message.
+  # - doc : Documentation lines (`{short, long}`)
+  # - hook : function to call if the conditions are met (with the parameters `message` and `match`).
+  def on(command : String = "PRIVMSG", source : HookRule = nil, arguments : HookRule = nil, message : HookRule = nil,
+         doc : {String, String}? = nil, &hook : Hook)
+    rule = Trigger.new(command, source, arguments, message)
     self.hooks.fetch(rule) { self.hooks[rule] = Array(Hook).new }
     self.hooks[rule] << hook
+    @docs[doc[0]] = doc[1] unless doc.nil?
     self
   end
 
   # Handle one `Message`
   # It goes through the registred hooks, select the one to trigger.
   # Then, it execute every hooks associated, and send as parameters the current message and the regex match if possible
-  # TODO: msg should NEVER be modified in the hook. (copy ? readonly ?)
+  # TODO: msg should NEVER be modified in the hook. (copy ? readonly ? struct ?)
   def handle(msg : Crirc::Protocol::Message)
     selected_hooks = self.hooks.select { |rule, hooks| rule.test(msg) }
     selected_hooks.each do |rule, hooks|
@@ -40,6 +66,7 @@ module Crirc::Binding::Handler
     self
   end
 
+  # Sugar for `handle` that parse the string as a `Crirc::Protocol::Message`
   def handle(msg : String)
     handle Crirc::Protocol::Message.new(msg)
   end

src/crirc/binding/trigger.cr

@@ -1,6 +1,6 @@
-# The `HookRules` define a set of rules.
+# The `Trigger` define a set of rules.
 # Theses rules can test an event (message) to "match" with.
-class Crirc::Binding::HookTest
+class Crirc::Binding::Trigger
   @source : String | Regex | Nil
   @command : String | Regex
   @arguments : String | Regex | Nil
@@ -19,6 +19,7 @@ class Crirc::Binding::HookTest
   def initialize(@command = "PRIVMSG", @source = nil, @arguments = nil, @message = nil)
   end
 
+  # returns true if the the message match with the condition of this trigger
   def test(msg : Crirc::Protocol::Message)
     test_command(msg) && test_source(msg) && test_arguments(msg) && test_message(msg)
   end

src/crirc/broadcast/broadcast.cr

@@ -1,3 +1,5 @@
+# Allow to send data to several IRC entity as one.
 module Crirc::Broadcast
+  # TODO
   abstract def puts(context : Controller::Controller, data)
 end

src/crirc/broadcast/chan_list.cr

@@ -2,6 +2,10 @@ require "../protocol/chan"
 require "./user_list"
 require "./broadcast"
 
+# TODO
+# A ChanList is the associated list of `Protocol::Chan` and a `UserList`.
+# It is useful for a server that need to keep a track of all the uers
+# connected to any of its chans.
 class Crirc::ChanList
   getter chans : Hash(Protocol::Chan, UserList)
   include Broadcast
@@ -10,6 +14,7 @@ class Crirc::ChanList
     @chans = Hash(Protocol::Chan, UserList).new
   end
 
+  # TODO
   # Broadcast a message to the users
   def puts(context : Controller::Controller, data)
     @chans.each { |chan, userlist| userlist.puts context, data }

src/crirc/broadcast/user_list.cr

@@ -2,6 +2,14 @@ require "../protocol/user"
 require "./broadcast"
 require "../controller/controller"
 
+# TODO.
+# UserList is used to send message to a list of `Protocol::User`.
+#
+# ```
+# chan1 = UserList.new
+# chan1.users << user_joined
+# chan1.puts current_controller, crafted_message
+# ```
 class Crirc::UserList
   getter users : Array(Protocol::User)
   include Broadcast
@@ -10,8 +18,10 @@ class Crirc::UserList
     @users = Array(Protocol::User)
   end
 
+  # TODO
+  # NOTE: combine data+user
   # Broadcast a message to the users
   def puts(context : Controller::Controller, data)
-    @users.each { context.puts data }
+    @users.each { |user| context.puts data }
   end
 end

src/crirc/controller/client.cr

@@ -15,28 +15,50 @@ class Crirc::Controller::Client
   include Binding::Handler
 
   getter network : Network::Client
+
+  # TODO Not used yet
   getter chanlist : ChanList
 
+  # delegated to the `Network`
   delegate nick, to: :network
+  # delegated to the `Network`
   delegate puts, to: :network
+  # delegated to the `Network`
   delegate gets, to: :network
 
+  # New `Client` that controls the given `Network`.
   def initialize(@network)
     super()
     @chanlist = ChanList.new
   end
 
+  # Initialize the connection with the IRC server (send pass, nick and user).
   def init
     puts "PASS #{@network.pass}" if @network.pass
     puts "NICK #{@network.nick.to_s}"
     puts "USER #{@network.user.to_s} \"#{@network.domain}\" \"#{@network.irc_server}\" :#{@network.realname.to_s}"
   end
 
+  # Start the callback when the server is ready to receive messages.
+  #
+  # ```
+  # bot.on_ready do
+  #   amazing_stuff(bot)
+  # end
+  # ```
   def on_ready(&b) : Client
     self.on("001") { b.call }
     self
   end
 
+  # Reply to a given message with a privmsg.
+  #
+  # ```
+  # bot.on("JOIN") do |msg, _|
+  #   nick = msg.source.source_nick
+  #   context.reply(msg, "Welcome to #{nick}")
+  # end
+  # ```
   def reply(msg, data)
     target = msg.argument_list.first
     target_object = (target[0] == '#' ? Crirc::Protocol::Chan : Crirc::Protocol::User).new(target).as(Crirc::Protocol::Target)

src/crirc/controller/command.cr

@@ -0,0 +1,7 @@
+# The module `Command` is the scope for the IRC commands
+# defined in the standard.
+# Each of these commands is included by a `Controller`, so the `puts` function
+# is implemented by the `Controller`.
+module Crirc::Controller::Command
+  abstract def puts(data)
+end

src/crirc/controller/command/chan.cr

@@ -1,7 +1,8 @@
-require "./command"
+require "../command"
 
+# Defines the IRC commands that are related to chans (join, part, ...).
 module Crirc::Controller::Command::Chan
-  include Crirc::Controller::Command::Command
+  include Crirc::Controller::Command
 
   # Format the chans to join: #chan1,#chan2 (works with users by the same way)
   protected def format_list(chans : Enumerable(Crirc::Protocol::Target)) : String

src/crirc/controller/command/command.cr

@@ -1,3 +0,0 @@
-module Crirc::Controller::Command::Command
-  abstract def puts(data)
-end

src/crirc/controller/command/ping.cr

@@ -1,7 +1,8 @@
-require "./command"
+require "../command"
 
+# Defines the IRC ping.
 module Crirc::Controller::Command::Ping
-  include Crirc::Controller::Command::Command
+  include Crirc::Controller::Command
 
   # Send a ping to check if the other end is alive
   def ping(msg : String? = "0")

src/crirc/controller/command/talk.cr

@@ -1,7 +1,8 @@
-require "./command"
+require "../command"
 
+# Defines the IRC commands related to communicating between "humans".
 module Crirc::Controller::Command::Talk
-  include Crirc::Controller::Command::Command
+  include Crirc::Controller::Command
 
   # Send a notice to a target
   def notice(target : Crirc::Protocol::Target, msg : String)

src/crirc/controller/command/user.cr

@@ -1,7 +1,8 @@
-require "./command"
+require "../command"
 
+# Defines the IRC commands related to the users (whois, mode).
 module Crirc::Controller::Command::User
-  include Crirc::Controller::Command::Command
+  include Crirc::Controller::Command
 
   # Request data about a given target
   def whois(target : Crirc::Protocol::Target)

src/crirc/controller/controller.cr

@@ -1,4 +1,9 @@
-module Crirc::Controller::Controller
-  abstract def puts(data)
-  abstract def gets
+# A `Controller` is controlling a `Network`.
+# It is in charge to manage IRC messages at the IRC protocol level.
+module Crirc::Controller
+  # Interface implemented by every `Crirc::Controller`
+  module Controller
+    abstract def puts(data)
+    abstract def gets
+  end
 end

src/crirc/controller/server.cr

@@ -1,6 +1,7 @@
 require "../network/server"
 require "./controller"
 
+# TODO
 class Crirc::Controller::Server
   include Controller
 

src/crirc/controller/server_client.cr

@@ -1,6 +1,8 @@
 require "../network/server_client"
 require "./controller"
 
+# TODO
+# Handles the clients connected to a `Server`
 class Crirc::Controller::ServerClient
   include Controller
 

src/crirc/network/client.cr

@@ -37,7 +37,7 @@ class Crirc::Network::Client
     @socket.as(IrcSocket)
   end
 
-  # Connect to the server
+  # Connect to the target server
   def connect
     tcp_socket = TCPSocket.new(@ip, @port)
     tcp_socket.read_timeout = @read_timeout
@@ -62,7 +62,9 @@ class Crirc::Network::Client
 
   # Send a message to the server
   def puts(data)
-    socket.puts data
+    socket.puts data.strip
+    socket.puts "\r\n"
+    socket.flush
   end
 
   # End the connection

src/crirc/network/network.cr

@@ -1,4 +1,9 @@
-module Crirc::Network::Network
-  abstract def puts(data)
-  abstract def gets
+# A `Network` is controlling a I/O.
+# It is in charge to manage TCP messages at the TCP protocol level.
+module Crirc::Network
+  # Interface implemented by every `Crirc::Network`.
+  module Network
+    abstract def puts(data)
+    abstract def gets
+  end
 end

src/crirc/protocol/chan.cr

@@ -1,6 +1,6 @@
 require "./target"
 
-# Represent an IRC channel.
+# Represents an IRC channel.
 class Crirc::Protocol::Chan < Crirc::Protocol::Target
   class Motd
     getter message : String
@@ -8,11 +8,11 @@ class Crirc::Protocol::Chan < Crirc::Protocol::Target
     getter timestamp : Int64
 
     def initialize(@message, @user)
-      @timestamp = Time.now.epoch
+      @timestamp = Time.utc.to_unix
     end
 
     def set_motd(@message, @user)
-      @timestamp = Time.now.epoch
+      @timestamp = Time.utc.to_unix
     end
   end
 

src/crirc/protocol/message.cr

@@ -1,8 +1,22 @@
+# `Message` is the object that parse the raw TCP body as a IRC message.
+#
+# Message are a IRC core part. They contain a command, the arguments, and
+# the message (last argument in the IRC protocol).
+# TODO: improve the message to appear in as the last argument. cf: fast_irc
 class Crirc::Protocol::Message
+  # Raw message without parsing
   getter raw : String
+
+  # Source of the message (ex: "0", "abc@xyz", ...)
   getter source : String
+
+  # The command ("PRIVMSG", "PING", ...)
   getter command : String
+
+  # The arguments as a string ("user1 +0", "pingmessage", ...)
   getter arguments : String?
+
+  # The last argument when ":" ("This is a privmsg message", ...)
   getter message : String?
 
   R_SRC     = "(\\:(?<src>[^[:space:]]+) )"
@@ -20,7 +34,12 @@ class Crirc::Protocol::Message
     @message = m["msg"]?
   end
 
-  # Concatenation of `arguments` and `message`. If the message exists, it is preceded by ':'
+  # Concatenation of `arguments` and `message`.
+  # If the message exists, it is preceded by ':'
+  #
+  # ```
+  # msg.raw_arguments # => "user1 +0 :do something"
+  # ```
   def raw_arguments : String
     return "" if @arguments.nil? && @message.nil?
     return @arguments.to_s if @message.nil?
@@ -28,6 +47,11 @@ class Crirc::Protocol::Message
     return "#{@arguments} :#{@message}"
   end
 
+  # The arguments formated into an Array.
+  #
+  # ```
+  # msg.argument_list # => ["user1", "+0"]
+  # ```
   def argument_list : Array(String)
     return Array(String).new if @arguments.nil? && @message.nil?
     return (@arguments.as(String)).split(" ") if @message.nil?

src/crirc/protocol/target.cr

@@ -1,4 +1,4 @@
-# A target is a virtuel IRC entity that can receive message (`User`, `Chan`)
+# A target is a virtuel IRC entity that can receive message (`User`, `Chan`).
 abstract class Crirc::Protocol::Target
   abstract def name : String
 end

src/crirc/version.cr

@@ -1,3 +1,3 @@
 module Crirc
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

src/example_bot.cr

@@ -12,16 +12,22 @@ private def bind_example(bot)
   end.on("JOIN") do |msg|
     # Greet message on join
     if extract_nick(msg.source) == bot.nick
-      chan = msg.message if msg.message
-      bot.privmsg Crirc::Protocol::Chan.new(chan), "Hello, world!" if chan
+      bot.reply msg, "Hello, world!"
     end
   end.on("PING") do |msg|
     # Server pong
     bot.pong(msg.message)
-  end.on("PRIVMSG", message: /^!ping */) do |msg|
+  end.on("PRIVMSG", message: /^!ping */, doc: {"!ping", "the bot respond by `pong nick`"}) do |msg|
     # !ping command : answer !pong to the user
     chan = msg.arguments if msg.arguments
-    bot.privmsg Crirc::Protocol::Chan.new(chan), "pong #{extract_nick msg.source}" if chan
+    bot.reply msg, "pong #{extract_nick msg.source}" if chan
+  end.on(message: /^!help *$/, doc: {"!help", "`!help` to list the modules\n`!help cmd` to advanced description of the cmd"}) do |msg|
+    # take each documented bind (those with on("...", doc: ....)) and send the short documentation
+    bot.reply msg, bot.docs.keys.join(", ")
+  end.on(message: /^!help *(.*[^ ]) *$/) do |msg, match|
+    # take one documented bind (those with on("...", doc: ....)) and send the long documentation
+    doc = bot.docs[match.as(Regex::MatchData)[1]]?
+    doc.split("\n").each { |split| bot.reply msg, split } unless doc.nil?
   end
 end
 

src/example_server.cr

@@ -0,0 +1,7 @@
+require "./crirc"
+
+
+server = Crirc::Network::Server.new "0.0.0.0", 6667, ssl: false
+server.start
+
+client.close