Auto 4.0.0.alpha.1-x86-mingw32

data/conf/example.yml

@@ -0,0 +1,125 @@
+---
+
+# Auto 4 example YAML configuration file
+
+# Core libraries to load.
+#
+# irc: IRC protocol framework.
+libraries:
+- irc
+
+# List of IRC servers to which to connect.
+irc:
+  # Server name, followed by properties.
+  freenode:
+    
+    # Server address.
+    address: irc.freenode.net
+    
+    # Server port.
+    port: 7000
+    
+    # Whether to use SSL: true or false.
+    useSSL: true
+    
+    # Nicknames. Auto will use the first one, and if it fails, it will try
+    # each one until success is achieved.
+    nickname:
+    - moobot
+    - altnick
+    
+    # Username or ident.
+    username: Auto
+    
+    # Real name or GECOS.
+    realName: Auto
+    
+    # SASL options. Remove this if you don't want to use SASL or the server
+    # does not support it.
+    SASL:
+      # Timeout in seconds. 15s is reasonable.
+      timeout: 15
+      # Account as which to identify.
+      username: moobot
+      # Password for the account.
+      password: moopass
+
+    # List of channels to join automatically.
+    autojoin:
+    - name: '#autoproject' # The channel name. Don't forget the quotes because channels have octothorpes.
+      key: ~ # Key, if necessary.
+
+  # Another server. Add as many as you wish.
+  Rizon:
+    
+    address: irc.rizon.net
+    port: 6667
+    useSSL: false
+    nickname:
+    - moobot
+    - altnick
+    username: Auto
+    realName: Auto
+
+    # Identify the traditional way; that is, by privately messaging a service.
+    nickIdentify:
+      # The name of the service--usually NickServ.
+      service: NickServ
+      # The command to use--usually identify.
+      command: identify
+      # The password to use. If the server uses Atheme, we suggest putting the accountname followed by
+      # the password here, so that identification never fails.
+      password: moopass
+
+# Database configuration
+#
+# In addition to the 'sequel' Ruby gem, you will need some additional gem(s) depending
+# upon the database management system of your choice:
+#
+# SQLite users: sqlite3
+# MySQL users: mysqlplus
+# Postgres users: pg
+#
+# If your DBMS is not supported and you would like it to be, we'll consider a feature
+# request which you may submit either to the mailing group (http://j.mp/autotalk), or
+# to the issue hub (https://github.com/Auto/Auto/issues). Alas, we regret to inform
+# our users that the official database model hasn't support for NoSQL systems, so such
+# NoSQL database management systems as MongoDB, Redis, CouchDB, Cassandra, etc. cannot
+# be officially supported at this time, although that's not to say a plugin is
+# incapable of extending Auto to support them.
+database:
+
+  # The type of database.
+  #
+  # sqlite (recommended): A very simple SQL database system which outputs to a file.
+  # [needs] name
+  #
+  # mysql: A popular SQL system based on a network server/client model.
+  # [needs] name, hostname, username, password
+  #
+  # postgres: An advanced SQL system popularly employed as an alternative to MySQL.
+  # [needs] name, hostname, username, password
+  type: sqlite
+
+  # Database name. 
+  #
+  # SQLite users should provide a path to a file (e.g., you may use 'auto.db'
+  # to write to /path/to/auto/installation/auto.db, or perhaps '/home/your_home_dir/autobot.db')
+  #
+  # MySQL and Postgres users should provide the name of the database; e.g. 'autobot'
+  name: auto.db
+
+  # Hostname to which to connect.
+  #
+  # This is needed only for MySQL and Postgres.
+  hostname: localhost
+
+  # Username as which to authenticate.
+  #
+  # This is needed only for MySQL and Postgres.
+  username: auto
+
+  # Password associated with this username.
+  #
+  # This is needed only for MySQL and Postgres.
+  password: insecurepassword123

data/docs/Contributing.md

@@ -0,0 +1,77 @@
+# @title Standards of Contributing
+# @author noxgirl
+
+Standards of Contributing
+=========================
+
+So that Auto 4 may maintain consistency, usability, and functionality,
+we ask that all contributions to Auto 4 conform with a few standards and
+conventions.
+
+While this is solely a requirement for contributions to Auto 4, we would
+suggest following it whenever extending or modifying Auto, whether your
+intention is to ship your code upstream, release it independently, or
+merely keep for your own personal use.
+
+Moreover, to further the philosophy of free software, while we do not
+demand it, we do ask that you publish code you write for Auto.
+
+**Documentation**
+
+Auto maintains thorough documentation. Please document your code employing rdoc
+and YARD standards. 
+
+When using the `@author` tag, please provide your GitHub
+username at minimum.
+
+**Coding**
+
+For indentation, ensure that you use spaces in lieu of tabs. For Ruby code and
+YAML, use two spaces. For C code, use four spaces.
+
+Vim users, observe the modelines each source file contains:
+
+    # vim: set ts=4 sts=2 sw=2 et:
+
+and
+
+    /* vim: set ts=4 sts=4 sw=4 et cindent: */
+
+Ruby coders, largely keep your code in compliance with [this style guide](https://github.com/bbatsov/ruby-style-guide).
+
+C coders, we prefer Allman (not K&R) style.
+
+**Language**
+
+In documentation, commit messages, and other such things, we require compliance
+with these three rules:
+
+1. No obscene language.
+2. It must be legible.
+3. It must be grammatically correct at least to a reasonable degree.
+
+**Membership**
+
+While we recognize and credit all individuals who contribute, no matter how
+small their contribution, we are also willing to grant commit access and
+official membership to regular contributors.
+
+Please contact Autumn Perrault (also known as noxgirl) if you wish to become
+a member of the Auto Project:
+
++ By e-mail: autumn@destellae.net
++ By IRC: "autumn" on irc.freenode.net (usually in #auto)
+
+**Releasing**
+
+To release a new version, follow this process:
+
+1. Ensure successful compilation and testing with `rake`.
+2. Update `lib/auto/version.rb`.
+3. Update `README.md` -- the version number and documentation link.
+4. Commit `lib/auto/version.rb` and `README.md` with a message of "Version bump to x."
+5. Cross-compile for Microsoft Windows with `rake cross compile`.
+6. Package the typical gem with `rake gem`.
+7. Package the Windows distribution with `rake cross native gem`.
+8. Tag the git branch with `git tag -a x -m "vX release"`.
+

data/docs/Events.md

@@ -0,0 +1,103 @@
+# @title Specification of Events
+
+Specification of Events
+=======================
+
+**Events** are managed by Auto's event systems, each of which is an instance
+of {Auto::API::Events}.
+
+`$m.events` manages the **Auto** events, which is to say the central events,
+while libraries have their own individual events systems.
+
+{Auto::DSL::Base} provides `#on`, `#emit`, `#undo_on`, etc., which all provide
+easy distinction between the individual event systems. `:auto`, for example,
+indicates the central system, whereas `:irc` indicates the IRC event system.
+
+:auto
+-----
+
+### :start
+
+This event occurs when Auto is starting, and each library is expected to await
+this event and upon its occurrence, initiate any of their processes.
+
+### :die `|reason|`
+
+**reason** (_String_): The reason for termination.
+
+This occurs when Auto is terminating.
+
+### :net_receive `|socket_object|`
+
+**socket_object** (_Object_): The object with which the socket (`.socket`) is
+associated.
+
+This occurs when the socket associated with `socket_object` has data waiting to
+be read (as determined by `select()`).
+
+### :rehash
+
+This event occurs when the configuration file is successfully reprocessed and
+reloaded.
+
+:irc
+----
+
+### :preconnect |irc|
+
+**irc** (_Auto::IRC::Server_): The IRC connection.
+
+This event occurs when we are about to register (i.e., send `USER`, `CAP LS`)
+on the server and initiate connection.
+
+### :receive |irc, data|
+
+**irc** (_Auto::IRC::Server_): The IRC connection.  
+**data** (_String_): The line of data.
+
+This event occurs when data has been removed from the receive queue and is ready
+for processing, with newlines and carriage returns stripped.
+
+### :connected |irc|
+
+**irc** (_Auto::IRC::Server_): The IRC connection.
+
+This event occurs after ISUPPORT has been received and processed, and the
+connection is fully established.
+
+Typically, at this point, any traditional service identification and autojoining
+occurs.
+
+### :disconnect |irc, reason|
+
+**irc** (_Auto::IRC::Server_): The IRC connection.  
+**reason** (_String_): The reason for which we are disconnecting.
+
+This event occurs when we're about to disconnect from the given server.
+
+### :send_join |irc, channel, key|
+
+**irc** (_Auto::IRC::Server_): The IRC connection.  
+**channel** (_String_): The channel which we are attempting to join.  
+**key** (_String_ or _nil_): The key, if provided.
+
+This event occurs when we try to join a channel.
+
+### :send_nick |irc, nickname|
+
+**irc** (_Auto::IRC::Server_): The IRC connection.  
+**nickname** (_String_): The nickname we are trying to use.
+
+This occurs when we try to change our nickname with /NICK.
+
+### :self_who |irc|
+
+**irc** (_Auto::IRC::Server_): The IRC connection.
+
+This occurs when we send a /WHO on ourselves.
+
+### irc:onWhoReply `[all strs](irc*, nick, username, host, realname, awaystatus, server)`
+
+This event occurs when the bot receives **RPL_WHOREPLY** (numeric 352) in response to a /WHO. Note that
+`awaystatus =~ /H/` will be true if the user is not away, while `awaystatus =~ /G/` will be true if the
+user is away (`H` meaning _here_, `G` meaning _gone_).

data/docs/Todo.md

@@ -0,0 +1,21 @@
+# @title Developers' To-Do List
+
+Developers' To-Do List
+======================
+
+4.0.0
+-----
+
++ [ ] Write Auto::DSL::IRC.
++ [ ] Add DSL #extend functions to Auto::API::Plugin#configure.
++ [ ] Document exceptions for #configure also.
++ [ ] Add Auto::IRC::Object::Entity#who.
++ [ ] Move IRC::Object::Channel to Auto::IRC::Object::Channel, and make it a proper
+      subclass of Auto::IRC::Object::Entity.
++ [ ] Finish Auto::Configure::Shell.
+
+**Plugins**
+
+* [ ] IRC relay.
+* [ ] Last.fm.
+* [ ] Twitter.

data/docs/Upgrade.md

@@ -0,0 +1,16 @@
+# @title Upgrade Auto 3 to 4
+
+Upgrade Auto 3 to 4
+===================
+
+Summary
+-----------
+Auto 3 was a comprehensive release of Auto, and is currently available from 
+[Arinity](https://github.com/arinity/Auto). As all things should hopefully improve
+however, this fourth major revision was begun.
+
+Nonetheless, we recognize that it is essential that we provide a means by which
+Auto users may upgrade their old configuration files and databases to function
+with Auto 4.
+
+We intend to address this matter when Auto 4 is nearer stability.

data/ext/dsl_base.c

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2013, Autumn Perrault, et al. 
+ * All rights reserved.
+ * This free software is distributed under the FreeBSD license (LICENSE.md).
+ *
+ */
+#include "ruby.h"
+
+VALUE mAuto;
+VALUE mDSL;
+VALUE mBase;
+
+static VALUE clock_do(int argc, VALUE *argv, VALUE self)
+{
+    return rb_funcall2(rb_funcall(rb_funcall(rb_gv_get("$m"), rb_intern("clock"), 0), rb_intern("spawn"), 0), argc, argv);
+}
+
+static VALUE clock_stop(int argc, VALUE *argv, VALUE self)
+{
+    return rb_funcall2(rb_funcall(rb_funcall(rb_gv_get("$m"), rb_intern("clock"), 0), rb_intern("del"), 0), argc, argc);
+}
+
+static VALUE undo_on(VALUE self, VALUE sys, VALUE hook)
+{
+    if(sys == rb_intern("auto"))
+    {
+        return rb_funcall(rb_funcall(rb_gv_get("$m"), rb_intern("events"), 0) rb_intern("del"), 1, hook);
+    }
+    else
+    {
+        if(rb_funcall(rb_gv_get("$m"), rb_intern("respond_to?"), 1, sys) == Qtrue)
+        {
+            return rb_funcall(rb_funcall(rb_funcall(rb_gv_get("$m"), sys, 0), rb_intern("events"), 0), rb_intern("del"), 1, hook);
+        }
+        else
+        {
+            return Qnil;
+        }
+    }
+}
+
+void Init_dsl_base()
+{
+    mAuto = rb_define_module("Auto");
+    mDSL  = rb_define_module_under(mAuto, "DSL");
+    mBase = rb_define_module_under(mDSL, "Base");
+}
+
+/* vim: set ts=4 sts=4 sw=4 et cindent: */

data/ext/libauto/auto.h

@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2013, Autumn Perrault, et al. 
+ * All rights reserved.
+ * This free software is distributed under the FreeBSD license (LICENSE.md).
+ *
+ */
+
+#ifndef AUTO_H
+#define AUTO_H
+
+/* include the Ruby header */
+#include "ruby.h"
+
+/* include libauto headers */
+#include "libauto.h"
+#include "logger.h"
+
+#endif // AUTO_H
+
+/* vim: set ts=4 sts=4 sw=4 et cindent: */

data/ext/libauto/extconf.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (LICENSE.md).
+
+require 'mkmf'
+
+extension = 'libauto'
+
+dir_config extension
+
+$CFLAGS << " -I./include/ "
+$CFLAGS << " -Wno-unused-function "
+
+create_makefile extension
+
+# vim: set ts=4 sts=2 sw=2 et:

data/ext/libauto/libauto.c

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2013, Autumn Perrault, et al. 
+ * All rights reserved.
+ * This free software is distributed under the FreeBSD license (LICENSE.md).
+ *
+ */
+
+#include "auto.h"
+
+/* initialize exceptions */
+void initialize_exceptions()
+{
+    eLogError = rb_define_class("LogError", rb_eStandardError);
+    ePluginError = rb_define_class("PluginError", rb_eStandardError);
+    eConfigError = rb_define_class("ConfigError", rb_eStandardError);
+    eDatabaseError = rb_define_class("DatabaseError", rb_eStandardError);
+}
+
+/* initialize Auto module */
+void Init_libauto()
+{
+    mAuto = rb_define_module("Auto");
+    /* initialize exceptions */
+    initialize_exceptions();
+    /* initialize Auto::Logger */
+    init_auto_logger();
+}
+
+/* vim: set ts=4 sts=4 sw=4 et cindent: */