syndi 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: c958f9441ff4afb8b1740fa9dfee053f85501012
-  data.tar.gz: f866670ec5f3dfec855de096c201e225e3bc9120
+  metadata.gz: 27ade4d78970ed7812bb1e4f7edb12b755e2ad84
+  data.tar.gz: cdc9beaf0aba4162ca054d0085ab053dd7929844
 !binary "U0hBNTEy":
-  metadata.gz: 96cf1ff0fd821a018f44982b7c915f582edbf6b7ec86c161fd7c83f025b44de5820dc897ebee2a070b5e07baa79c7613f2b9a07a77ae21413ec947b129378c92
-  data.tar.gz: 01debf9539a10b8efe80ed01191c56eae7e311057d904ff5de33785c6d048ede2bf1d8057c76da5ab4fe20fa8aac771af5b000e76912f09b94b78803dae3546b
+  metadata.gz: e7d8e880065a0bfdbe71e6ed8963944026214745d9f6f4351b41888faf898494db17a71dd1920f59aa9825679ce09eddc8df3c5d12bb1c77bde2a61e33ea89c8
+  data.tar.gz: d3d4ac783179808b7ae38391b0fe3cef5796f2c931e65b09806c088cf7b2c5c817488a90f2062bd53f1f1687dc861867b2f5e8eb9eee75ec094300c60af7da8f

data/.yardopts

@@ -0,0 +1,12 @@
+--title "Auto 4.0 Phoenix"
+--protected
+--private
+--markup markdown
+lib/**/*.rb
+ext/**/*.c
+- LICENSE
+- WINDOWS.md
+- INSTALL.md
+- CHANGELOG.md
+- CONTRIBUTING.md
+- docs/*

data/Gemfile

@@ -0,0 +1,8 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+source :rubygems
+
+gemspec :development_group => :dev
+
+# vim: set ts=4 sts=2 sw=2 et:

data/INSTALL.md

@@ -0,0 +1,86 @@
+*This is a copy of https://github.com/Syndi/Syndi/wiki/Install-Guide as it appeared Jan 13 2013 4:16 UTC.*
+
+Thank you for choosing **Syndi 4** to serve your needs! Please foremost read the [licensing terms](/Syndi/Syndi/wiki/License), as *by proceeding you confirm your agreement to them*.
+
+Before installing, you must decide on how you would like to install Syndi. There is a relatively easy way, and a somewhat more advanced way.
+
+For most users, the relatively easy way is advisable, and that is the **gem method**.
+
+Users who have some reason for doing so and are more advanced can install Syndi from source. See further below for that.
+
+---
+
+# Gem
+
+You must have [Ruby 1.9.2 or later](http://www.ruby-lang.org).
+
+## Installation
+
+There is a complete list of releases and links therefor on the [official releases page](http://syndi.syndiproj.org/releases.html).
+
+We recommend merely installing the latest (pre-)release from [RubyGems](https://rubygems.org/gems/Syndi):
+
+    $ gem install Syndi --pre
+
+If you downloaded the source, either from Git or in an archive, do this in the main directory to compile a gem:
+
+    $ gem build Syndi.gemspec
+    $ gem install Syndi-*.gem
+
+Depending on which database management system you wish to use, you must separately download the respective gem whether you use the distributed **Syndi** or your own build:
+
+**SQLite**: `$ gem install sqlite3`  
+**MySQL**: `$ gem install mysqlplus`  
+**PostgreSQL**: `$ gem install pg`
+
+## Configuration
+
+The indispensable [Syndi Configure](/Syndi/Syndi/wiki/Syndi-Configure) utility will help you configure Syndi, and this is the suggested method as it is the easiest.
+
+    $ syndi-conf
+
+Otherwise you must navigate to the path to which **syndibot** was installed (typically somewhere in `~/.gem/`) and find the `conf/` directory; that is unless you cloned from Git, in which case you'll find it in `Syndi/conf/`.
+
+The **Y**AML **A**in't **M**arkup **L**anguage configuration, which is suggested, is `example.yml`. Open it with your favorite editor and save it as `~/.config/syndibot/syndi.yml`. You can also save it to a path of your choosing, but remember to invoke Syndi with `--config=path/to/config.yml`:
+
+    $ syndi --config=/somewhere/where/cows/speak/syndi.yml
+
+If you prefer, the **J**ava **S**cript **O**bject **N**otation configuration is `example.json`. Modify it as above (except use a `.json` extension). Invoke Syndi with the `-j` flag (unless you specify `--config`, in which case the `--j` is superfluous).
+
+    $ syndi -j
+
+## Start
+
+    $ syndi
+
+Consult with the [Syndi Handbook](/Syndi/Syndi/wiki/Syndi-Handbook) for information on using Syndi.
+
+# Source
+
+You need at least [Ruby 1.9.2](http://www.ruby-lang.org)!
+
+The easiest way to install Syndi's gem prerequisites is to use [**GemBundler**](https://rubygems.org/gems/bundler). Install it:
+
+    $ gem install bundler
+
+After downloading the source code and entering the main directory, invoke bundler:
+
+    $ bundle install --without dev
+
+If testing and/or development are among your intentions, exclude the `--without dev` to install testing/development dependencies.
+
+Depending on which database management system you wish to use, you must separately download the respective gem:
+
+**SQLite**: `$ gem install sqlite3`  
+**MySQL**: `$ gem install mysqlplus`  
+**PostgreSQL**: `$ gem install pg`
+
+All releases can be obtained in either Git, Tar/GZ, or Zip format from the [official releases page](http://syndi.syndiproj.org/releases.html).
+
+Compile the source code:
+
+    $ rake compile
+
+To test Syndi (and you must have installed the testing dependencies), invoke:
+
+    $ rake test

data/LICENSE

@@ -0,0 +1,28 @@
+(Two-clause "FreeBSD" license.)
+
+Copyright (c) 2009-2013, Autumn Perrault
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met: 
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer. 
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution. 
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those
+of the authors and should not be interpreted as representing official policies, 
+either expressed or implied, of the Syndi Project.

data/README.md

@@ -0,0 +1,104 @@
+Syndi
+=====
+
+_A modern, elegant, extensible multi-protocol chat bot—reloaded._
+
+**Formerly known as Auto.**
+
+**Version**:            0.1.0 "Phoenix"  
+[![Build Status](https://travis-ci.org/syndibot/syndi.png?branch=master)](https://travis-ci.org/syndibot/syndi)
+[![Dependency Status](https://gemnasium.com/syndibot/syndi.png)](https://gemnasium.com/syndibot/syndi)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/syndibot/syndi)
+
++ [Homepage](http://syndibot.com) (lots of information)
++ [RubyGems](https://rubygems.org/gems/syndi)
++ [Wiki](https://github.com/syndibot/syndi/wiki)
++ [Mailing List](https://groups.google.com/group/syndibot)
++ [Issue Hub](https://github.com/syndibot/syndi/issues)
+
+
+Our official IRC channel is [#syndi on irc.freenode.net](irc://irc.freenode.net/#syndi).
+
+### Is it Production-Ready™?
+
+Not yet. Syndi 4's a fairly sizable project. We're getting close though.
+
+Synopsis
+--------
+
+Syndi is automated chat bot software, developed per this philosophy:
+
+* _Friendly_ to users, and to developers.
+* _Simple_, _smart_, and _clean_.
+* _Minimal_ but _extensible_.
+
+It is a reboot of Auto, an old IRC bot which, though featureful, suffered of design flaws.
+
+Installation
+------------
+
+Please read the [Syndi Handbook](https://github.com/syndibot/syndi/wiki/Handbook).
+
+**Compiling from source:**
+
+```shell
+$ git clone git://github.com/syndibot/syndi.git syndi
+$ cd syndi/
+```
+Use a [specific version](https://github.com/syndibot/syndi/tags):
+
+```shell
+$ git checkout v4.0.0.alpha.1
+```
+
+Or the cutting-edge HEAD:
+
+```shell
+$ git checkout master
+```
+
+```shell
+$ bundle install
+$ rake
+$ rake install
+```
+
+Syndi is currently known to function on these operating systems:
+
++ Microsoft Windows
++ Mac OS X
++ Linux
++ BSD flavors
+
+Using these Ruby virtual machines:
+
++ MRI/YARV (official) 2.0.0
+
+Support
+-------
+
+If you should find yourself in need of support, please foremost consult with the
+documentation on the [wiki](https://github.com/syndibot/syndi/wiki).
+
+If the wiki fails to address your needs, please either:
+
+1. Post to the [syndibot](https://groups.google.com/group/syndibot)
+   group under the _support_ category, **or**
+2. Join the official IRC chatroom at 
+[#syndi on irc.freenode.net](http://webchat.freenode.net/?randomnick=1&channels=#syndi&prompt=1)
+
+**Bugs** should be reported on the [issue management hub](https://github.com/syndibot/syndi/issues).
+
+Authors
+-------
+
+Syndi 4 was rewritten from scratch by Autumn Perrault (noxgirl) in Ruby and C,
+and is actively developed by the core team.
+
+Legal
+-----
+
+Copyright (c) 2009-2013, Autumn Perrault. All rights reserved.
+
+Syndi is free, open-source software, distributed per the terms of the two-clause
+("FreeBSD") license, the full terms of which are in [**LICENSE**](LICENSE).

data/Rakefile

@@ -0,0 +1,26 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+# import the gemspec
+GEMSPEC    = 'Syndi.gemspec'
+$gemspec ||= eval(File.read(GEMSPEC), binding, GEMSPEC)
+
+def perform t
+  Rake::Task[t].invoke
+end
+
+# Directives for Ruby Make (rake)
+# to test/compile Syndi 4, and optionally
+# push to RubyGems
+
+# load all of the tasks
+Dir["tasks/**/*.rake"].each do |t|
+  load File.expand_path t
+end
+
+# groups
+task :default => %i[compile native gem]
+task :typical => %i[compile spec]
+task :full    => %i[clean typical gem install]
+
+# vim: set ts=4 sts=2 sw=2 et:

data/WINDOWS.md

@@ -0,0 +1,64 @@
+Syndi on Windows
+===============
+
+Yay
+---
+
+Syndi 4.0 _Phoenix_ brings back something which hasn't existed since version 1.0:
+support for Microsoft Windows!
+
+This is because we have prioritized programming v4.0 with platform independence
+from its inception.
+
+How It Works
+------------
+
+Windows users can install Syndi easily by downloading and installing from RubyGems:
+
+    $ gem install Syndi [--pre]
+
+On Windows, this will install the native Windows distribution, which includes the
+_libsyndi_ library cross-compiled with [Minimalist GNU for Windows](http://www.mingw.org/),
+commonly called MinGW.
+
+This assumes that you have installed Ruby compiled with MinGW; this is the case
+if you used [RubyInstaller for Windows](http://rubyinstaller.org/).
+
+Compiling
+---------
+
+Users who have good cause for doing so are also welcome to compile the source
+for Syndi themselves.
+
+We should hope that [DevKit](http://rubyinstaller.org/downloads) will provide
+a sufficiently sane build environment for this on Windows. We haven't tested
+it since we cross-compile on UNIX systems when packaging gems.
+
+You must then force RubyGems to download the distribution without binaries, so
+that _libsyndi_ will be compiled:
+
+    $ gem install Syndi [--pre] --platform=ruby --development
+
+Cross-compiling
+---------------
+
+You must have a cross-compiling toolset installed on your system. Install the
+MinGW toolset.
+
+On Arch Linux, this can be installed with:
+
+    # pacman -Syu mingw32-gcc mingw32-pthreads
+
+Then configure rake-compiler:
+
+    $ rake-compiler cross-ruby VERSION=1.9.3-p362
+
+Now compile the source code for Windows:
+
+    $ rake cross compile
+
+Package the native distribution gem:
+
+    $ rake cross native gem
+
+_Et voila!_ You should find the native gem in `pkg/`.

data/bin/syndi

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+require 'English'
+require 'rbconfig'
+
+# Perform a check of the Ruby version.
+if ::RbConfig::CONFIG['ruby_version'] < '2.0.0'
+  puts 'Syndi requires Ruby v2.0.0 or later. Please read the Syndi Handbook.'
+  exit 1
+end
+
+# Forbid root.
+if ENV.include? 'USER'
+  if ENV['USER'] == 'root'
+    puts 'It is forbidden to run Syndi as the root user!'
+    exit 1
+  end
+end
+
+# Import necessary libraries.
+require 'slop'
+# Import system Syndi libraries, or fall back to internal ones.
+begin
+  require 'syndi'
+rescue LoadError
+  $LOAD_PATH.unshift File.join(__dir__, '..', 'lib')
+  require 'syndi'
+end
+require 'syndi/verbosity'
+
+# Change to the Syndi directory.
+SYNDI_DIR = File.join ENV['HOME'], '.syndi'
+Dir.mkdir SYNDI_DIR unless Dir.exists? SYNDI_DIR
+Dir.chdir SYNDI_DIR
+
+$VERBOSITY = 0
+
+# Parse options.
+opts = Slop.parse(:banner => "Usage: #$PROGRAM_NAME [options]") do
+  on :h, :help, "You're looking at it." do
+    puts self
+    exit 0
+  end
+
+  on :v, :version, 'Display version and exit.' do
+    puts <<-EOV
+Syndi #{Syndi::FULLVERSION}
+[os: #{::RbConfig::CONFIG['host_os']}] [rb: #{::RbConfig::CONFIG['ruby_version']}] [arch: #{::RbConfig::CONFIG['arch']}]
+
+http://syndiproj.org
+    EOV
+    exit 0
+  end
+
+  on(:f, :foreground, 'Disable automatic daemonizing.')
+  on(:c, :conf=,      'Specify a particular configuration file.')
+  on(:V, :verbose,    'Increase verbosity of output (more uses, the more verbose).') { $VERBOSITY += 1 }
+end
+
+# Begin start up.
+puts "* Syndi #{Syndi::VERSION} starting...".bold
+$log = Syndi::Logger.new
+
+# Create an instance of Syndi.
+begin
+  $m = Syndi::Bot.new opts
+  status = $m.init
+rescue => e
+  $log.fatal "An initialization error occurred: #{e}"
+end
+
+# Check our status.
+if status
+  time = Time.now
+  $log.info "Syndi started at #{time}."
+else
+  $log.fatal "Initialization inexplicably failed."
+end
+STARTTIME = time.freeze
+
+# We survived? We survived! Fork into the background if not in debug or foreground.
+$m.daemonize if !opts.foreground? && $VERBOSITY < 1
+
+# Signals
+sig = {
+  'TERM' => proc { $m.terminate('Caught termination signal') },
+  'INT'  => proc { $m.terminate('Ctrl-C pressed') },
+  'HUP'  => proc { $m.conf.rehash }
+}
+sig.delete 'HUP' if Syndi.windows?
+sig.each { |signal, prc| Signal.trap(signal) { prc.call } }
+
+begin
+  $m.start
+rescue => e
+  $log.error_bt "Fatal exception: #{e}", e.backtrace
+  exit 1
+end
+
+# vim: set ts=4 sts=2 sw=2 et:

data/bin/syndi-conf

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+require 'slop'
+
+# Check whether we're installed as a gem or a standalone
+unless File.expand_path(__FILE__) =~ /^#{Regexp.escape File.join(Dir.home, '.gem')}/
+  $:.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')) # Add the Syndi libraries to LOAD_PATH
+end
+
+require 'syndi/configure'
+
+# Parse options.
+opts = Slop.parse(:banner => "Usage: #$0 [options/command]") do
+  
+  on :h, :help, 'Display this help message.' do
+    puts self
+    exit 0
+  end
+
+  on :v, :version, 'Display version.' do
+    puts <<-EOV
+Syndi Configure v#{Syndi::Configure::VERSION}
+
+http://syndiproj.org
+    EOV
+    exit 0
+  end
+
+  # configuration generator
+  command :gen do
+    run do |_, _|
+      Syndi::Configure::Generator.new.generate
+    end
+  end
+
+  # configuration editor
+  command :edit do
+    run do |_, args|
+      Syndi::Configure::CLI.start(args)
+    end
+  end
+      
+end
+
+# vim: set ts=4 sts=2 sw=2 et:

data/conf/example.yml

@@ -0,0 +1,101 @@
+---
+
+# Syndi 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. Syndi 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: Syndi
+    
+    # Real name or GECOS.
+    realName: Syndi
+    
+    # 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.
+    syndijoin:
+    - name: '#syndi-bots' # 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: Syndi
+    realName: Syndi
+
+    # 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
+#
+# Syndi uses Redis for its database management, because it is the system we
+# thought most apropos to our minimalist philosophy.
+#
+# There is a wiki page on this: https://github.com/Syndi/Syndi/wiki/Setting-Up-a-Database
+#
+# All of these are commented because the defaults are typically desirable.
+database:
+
+  # This will disable database functionality. We discourage this.
+  #disable: yes
+
+  # If your Redis server is listening on a host other than the 'localhost'
+  # default, specify it here.
+  #address: '10.0.1.1'
+
+  # If it is listening on a port other than 6379, specify it here.
+  #port: 6500
+
+  # If it is using a UNIX socket, provide the path here.
+  #path: '/tmp/redis.sock'
+
+  # If a password is required, specify it here.
+  #password: insecurepassword123
+
+  # To use a different database from the default (0), specify its number here.
+  #number: 10