syndi 0.0.1 → 0.1.0

data/lib/syndi/irc/state/support.rb

@@ -0,0 +1,142 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+module Syndi
+  module IRC
+    module State
+      
+      # A state-management class which records the various capabilities of the
+      # IRC daemon.
+      #
+      # @!attribute connected
+      #   @return [Boolean] Whether we are connected and registered.
+      #
+      # @!attribute cap
+      #   @return [Array<String>] A list of enabled capabilities.
+      #
+      # @!attribute sasl_method
+      #   @return [Symbol] Method of SASL authentication (+:plain+ or +:dh_blowfish+).
+      #
+      # @!attribute sasl_id
+      #   @return [Array<String>] Identities of SASL-related timers.
+      #
+      # @!attribute server_name
+      #   @return [String] Name of the server to which we are connected (e.g. asimov.freenode.net).
+      #
+      # @!attribute nicklen
+      #   @return [Integer] The maximum length of a nickname permissible.
+      #
+      # @!attribute prefixes
+      #   @return [Hash{Symbol => String}] The list of channel user prefixes supported.
+      #
+      # @!attribute chan_modes
+      #   @return [Hash{Symbol => Array<Symbol>}] The list of channel modes supported. The keys
+      #     are +:never+, +:list+, +:set+, and +:always+. List: list mode (e.g. +b). Never:
+      #     never has a parameter. Set: has a parameter only when set. Always: always has a
+      #     parameter.
+      #
+      # @!attribute modelen
+      #   @return [Integer] The maximum number of modes permissible in a single /MODE.
+      #
+      # @!attribute topiclen
+      #   @return [Integer] The maximum length of a /TOPIC permissible.
+      #
+      # @!attribute chanlen
+      #   @return [Integer] The maximum length of a channel's name permissible.
+      class Support
+
+        attr_accessor :cap, :sasl_method, :sasl_id, :server_name, :nicklen, :prefixes,
+                      :chan_modes, :modelen, :topiclen, :chanlen, :connected
+
+        def initialize
+          # hashes
+          %w[chan_modes prefixes].each do |hsh|
+            instance_variable_set("@#{hsh}", {})
+          end
+          # arrays
+          %w[cap sasl_id].each do |arr|
+            instance_variable_set("@#{arr}", [])
+          end
+          # strings/symbols/booleans/integers
+          %w[sasl_method server_name nicklen topiclen modelen chanlen
+             connected].each do |str|
+            instance_variable_set("@#{str}", nil)
+          end
+        end
+
+        # Process ISUPPORT data.
+        #
+        # @param [Syndi::IRC::Server] irc The IRC connection.
+        # @param [String] data The ISUPPORT data string.
+        def isupport irc, data
+          
+          # Nick, channel, topic, and mode length
+          {'@nicklen'  => 'NICKLEN',
+           '@chanlen'  => 'CHANNELLEN',
+           '@topiclen' => 'TOPICLEN',
+           '@modelen'  => 'MODES' }.each_pair do |var, indic|
+            
+            if data =~ /#{indic}=(\d+)/
+              instance_variable_set(var, $1.to_i)
+            end
+
+          end
+
+          # Parse channel modes.
+          parse_channel_modes data
+
+          # Parse prefixes.
+          parse_prefixes data
+
+        end
+
+        #######
+        private
+        #######
+
+        # Parse supported channel modes.
+        #
+        # @param [String] data The data string.
+        def parse_channel_modes data
+          if match = %r{\WCHANMODES=(\w+),(\w+),(\w+),(\w+)\W}.match(data)
+            list   = match[1].split // || []
+            always = match[2].split // || []
+            set    = match[3].split // || []
+            never  = match[4].split // || []
+
+            list.map!   { |m| m.to_sym }
+            always.map! { |m| m.to_sym }
+            set.map!    { |m| m.to_sym }
+            never.map!  { |m| m.to_sym }
+
+            { list: list, always: always, set: set, never: never }
+          end
+        end
+
+        # Parse supported prefixes.
+        #
+        # @param [String] data The data string.
+        def parse_prefixes data
+          if match = %r{\WPREFIX=\((\w+)\)(\W+)\s}.match(data)
+            modes    = match[1].split //
+            prefixes = match[2].split //
+            
+            modes.map! { |m| m.to_sym }
+
+            i = 0
+            modes.each do |m|
+              @prefixes[m] = prefixes[i]
+              i += 1
+            end
+          end
+        end
+
+      end # class Support
+
+    end # module State
+
+  end # module IRC
+
+end # module Syndi
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/irc/state/user_manager.rb

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

data/lib/syndi/irc/std/commands.rb

@@ -0,0 +1,99 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+module Syndi
+
+  module IRC
+
+    module Std
+    
+      # A module which provides a number of methods for basic IRC commands,
+      # intended for inclusion in {Syndi::IRC::Server}.
+      module Commands
+      
+        # Send initial AUTHENTICATE.
+        def authenticate method = :plain
+          if method    == :plain
+            snd 'AUTHENTICATE PLAIN'
+            @supp.sasl_method = :plain
+          elsif method == :dh_blowfish
+            snd 'AUTHENTICATE DH-BLOWFISH'
+            @supp.sasl_method = :dh_blowfish
+          end
+        end
+
+        # Send CAP END.
+        def cap_end
+          # Stop any SASL-related timers
+          @supp.sasl_id.each { |t| $m.clock.del t }
+          # Send CAP END
+          snd 'CAP END'
+        end
+
+        # Disconnect from the server.
+        #
+        # @param [String] msg Reason for disconnect. 
+        def disconnect msg = 'Closing connection'
+          emit :irc, :disconnect, self, msg
+          snd "QUIT :#{msg}"
+          @socket = nil
+        end
+      
+        # Join a channel on the server.
+        #
+        # @param [String] chan Channel to join.
+        # @param [String] key Key to join, if necessary.
+        def join chan, key = nil
+          snd "JOIN #{chan}#{key.nil? ? '' : key}"
+          emit :irc, :send_join, self, chan, key
+        end
+
+        # Send /NICK to change the bot's nickname on the server.
+        #
+        # @note If the nickname is in use, the bot will append a hyphen and retry,
+        #   repeating until success is achieved.
+        #
+        # @param [String] new The new nickname.
+        def nickname= new
+
+          if connected?
+            @newnick = new
+          else
+            @nick = new
+          end
+      
+          snd "NICK :#{new}"
+          emit :irc, :send_nick, self, new
+    
+        end
+
+        # Supply server password.
+        #
+        # @param [String] pass
+        def pass password; snd "PASS :#{password}"; end
+
+        # Send /USER.
+        #
+        # @param [String] username The bot's username or ident.
+        # @param [String] hostname The bot's hostname.
+        # @param [String] server Address of the remote server.
+        # @param [String] realname The bot's real name or GECOS.
+        def user username, hostname=Socket.gethostname, server, realname
+          snd "USER #{username} #{hostname} #{server} :#{realname}"
+        end
+
+        # Request a /WHO on ourselves.
+        def who
+          snd "WHO #@nick"
+          emit :irc, :who_self, self
+        end
+
+      end # module Commands
+
+    end  # module Std
+
+  end # module IRC
+
+end # module Syndi
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/irc/std/numerics.rb

@@ -0,0 +1,216 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+# namespace Syndi
+module Syndi
+
+  # namespace IRC
+  module IRC
+
+    # namespace Std
+    module Std
+
+      # A module which provides constant representatives of all useful IRC numerics
+      # as specified by the IRC v3.1 protocol.
+      #
+      # @see http://tools.ietf.org/html/rfc1459
+      # @see http://ircv3.atheme.org/
+      module Numerics
+
+        # errors (RFC1459)
+        ERR_NOSUCHNICK          = '401'
+        ERR_NOSUCHSERVER        = '402'
+        ERR_NOSUCHCHANNEL       = '403'
+        ERR_CANNOTSENDTOCHAN    = '404'
+        ERR_TOOMANYCHANNELS     = '405'
+        ERR_WASNOSUCHNICK       = '406'
+        ERR_TOOMANYTARGETS      = '407'
+        
+        ERR_NOORIGIN            = '409'
+        
+        ERR_NORECIPIENT         = '411'
+        ERR_NOTEXTTOSEND        = '412'
+        ERR_NOTOPLEVEL          = '413'
+        ERR_WILDTOPLEVEL        = '414'
+        
+        ERR_UNKNOWNCOMMAND      = '421'
+        ERR_NOMOTD              = '422'
+        ERR_NOADMININFO         = '423'
+        ERR_FILEERROR           = '424'
+        
+        ERR_NONICKNAMEGIVEN     = '431'
+        ERR_ERRONEUSNICKNAME    = '432'
+        ERR_NICKNAMEINUSE       = '433'
+        ERR_NICKCOLLISION       = '436'
+        
+        ERR_USERNOTINCHANNEL    = '441'
+        ERR_NOTONCHANNEL        = '442'
+        ERR_USERONCHANNEL       = '443'
+        ERR_NOLOGIN             = '444'
+        ERR_SUMMONDISABLED      = '445'
+        ERR_USERSDISABLED       = '446'
+        
+        ERR_NOTREGISTERED       = '451'
+        
+        ERR_NEEDMOREPARAMS      = '461'
+        ERR_ALEADYREGISTERED    = '462'
+        ERR_NOPERMFORHOST       = '463'
+        ERR_PASSWDMISMATCH      = '464'
+        ERR_YOUREBANNEDCREEP    = '465'
+        ERR_KEYSET              = '467'
+        
+        ERR_CHANNELISFULL       = '471'
+        ERR_UNKNOWNMODE         = '472'
+        ERR_INVITEONLYCHAN      = '473'
+        ERR_BANNEDFROMCHAN      = '474'
+        ERR_BADCHANNELKEY       = '475'
+
+        ERR_NOPRIVILEGES        = '481'
+        ERR_CHANOPRIVSNEEDED    = '482'
+        ERR_CANTKILLSERVER      = '483'
+
+        ERR_NOOPERHOST          = '491'
+        
+        ERR_UMODEUNKNOWNFLAG    = '501'
+        ERR_USERSDONTMATCH      = '502'
+
+        # responses (RFC1459) 
+        RPL_AWAY                = '301'
+        RPL_USERHOST            = '302'
+        RPL_ISON                = '303'
+
+        RPL_UNAWAY              = '305'
+        RPL_NOWAWAY             = '306'
+        
+        RPL_WHOISUSER           = '311'
+        RPL_WHOISSERVER         = '312'
+        RPL_WHOISOPERATOR       = '313'
+        RPL_WHOWASUSER          = '314'
+        RPL_ENDOFWHO            = '315'
+        
+        RPL_WHOISIDLE           = '317'
+        RPL_ENDOFWHOIS          = '318'
+        RPL_WHOISCHANNELS       = '319'
+
+        RPL_LISTSTART           = '321'
+        RPL_LIST                = '322'
+        RPL_LISTEND             = '323'
+        RPL_CHANNELMODEIS       = '324'
+
+        RPL_NOTOPIC             = '331'
+        RPL_TOPIC               = '332'
+
+        RPL_INVITING            = '341'
+        RPL_SUMMONING           = '342'
+        
+        RPL_VERSION             = '351'
+        RPL_WHOREPLY            = '352'
+        RPL_NAMREPLY            = '353'
+
+        RPL_LINKS               = '364'
+        RPL_ENDOFLINKS          = '365'
+        RPL_ENDOFNAMES          = '366'
+        RPL_BANLIST             = '367'
+        RPL_ENDOFBANLIST        = '368'
+        RPL_ENDOFWHOWAS         = '369'
+
+        RPL_INFO                = '371'
+        RPL_MOTD                = '372'
+        
+        RPL_ENDOFINFO           = '374'
+        RPL_MOTDSTART           = '375'
+        RPL_ENDOFMOTD           = '376'
+        
+        RPL_YOUREOPER           = '381'
+        RPL_REHASHING           = '382'
+
+        RPL_TIME                = '391'
+        RPL_USERSSTART          = '392'
+        RPL_USERS               = '393'
+        RPL_ENDOFUSERS          = '394'
+        RPL_NOUSERS             = '395'
+
+        # more command responses in the 200-299 range (RFC1459)
+        RPL_TRACELINK           = '200'
+        RPL_TRACECONNECTING     = '201'
+        RPL_TRACEHANDSHAKE      = '202'
+        RPL_TRACEUNKNOWN        = '203'
+        RPL_TRACEOPERATOR       = '204'
+        RPL_TRACEUSER           = '205'
+        RPL_TRACESERVER         = '206'
+        
+        RPL_TRACENEWTYPE        = '208'
+
+        RPL_STATSLINKINFO       = '211'
+        RPL_STATSCOMMANDS       = '212'
+        RPL_STATSCLINE          = '213'
+        RPL_STATSNLINE          = '214'
+        RPL_STATSILINE          = '215'
+        RPL_STATSKLINE          = '216'
+        
+        RPL_STATSYLINE          = '218'
+        RPL_ENDOFSTATS          = '219'
+
+        RPL_UMODEIS             = '221'
+
+        RPL_STATSLLINE          = '241'
+        RPL_STATSUPTIME         = '242'
+        RPL_STATSOLINE          = '243'
+        RPL_STATSHLINE          = '244'
+
+        RPL_LUSERCLIENT         = '251'
+        RPL_LUSEROP             = '252'
+        RPL_LUSERUNKNOWN        = '253'
+        RPL_LUSERCHANNELS       = '254'
+        RPL_LUSERME             = '255'
+        RPL_ADMINME             = '256'
+        RPL_ADMINLOC1           = '257'
+        RPL_ADMINLOC2           = '258'
+        RPL_ADMINEMAIL          = '259'
+
+        RPL_TRACELOG            = '261'
+
+        # '900'+ and SASL
+        RPL_LOGGEDIN            = '900'
+        RPL_LOGGEDOUT           = '901'
+
+        RPL_SASLSUCCESS         = '903'
+        
+        ERR_SASLFAIL            = '904'
+        ERR_SASLTOOLONG         = '905'
+        ERR_SASLABORTED         = '906'
+        ERR_SASLALREADY         = '907'
+
+        # RFC1459 so-called 'reserved' numerics
+        RPL_TRACECLASS          = '209'
+        RPL_SERVICEINFO         = '231'
+        RPL_SERVICE             = '233'
+        RPL_SERVLISTEND         = '235'
+        RPL_WHOISCHANOP         = '316'
+        RPL_CLOSING             = '362'
+        RPL_INFOSTART           = '373'
+        RPL_STATSQLINE          = '217'
+        RPL_ENDOFSERVICES       = '232'
+        RPL_SERVLIST            = '234'
+        
+        ERR_YOUWILLBEBANNED     = '466'
+        ERR_NOSERVICEHOST       = '492'
+        ERR_BADCHANMASK         = '476'
+
+        # additional RFC2812 numerics
+        RPL_WELCOME             = '001'
+        RPL_YOURHOST            = '002'
+        RPL_CREATED             = '003'
+        RPL_MYINFO              = '004'
+        RPL_ISUPPORT            = '005' # ISUPPORT favored over BOUNCE
+        RPL_BOUNCE              = '010' # here in lieu of 005
+
+      end # module Numerics
+
+    end # module Std
+
+  end # module IRC
+
+end # module Syndi
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/irc.rb

@@ -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).
+
+require 'syndi/irc/library'
+
+LIBRARY_IRC = Syndi::IRC::Library.new
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/jewel/specification.rb

@@ -0,0 +1,121 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+require 'syndi'
+require 'syndi/jewel/util'
+
+class JewelError < StandardError; end
+
+module Syndi
+
+  module Jewel
+    include Syndi::Jewel::Util
+
+    # A specification for an Syndi jewel (i.e. plugin, extension, etc.).
+    #
+    # @!attribute name
+    class Specification
+
+      attr_reader :name, :version, :authors, :syndi_version, :our_dir,
+                  :bundle, :code_files, :doc_files, :post_message,
+                  :install_do
+
+      def omg *args
+        args.each do |unicorn|
+          puts "==> #{unicorn}".magenta
+        end
+      end
+
+      # Construct a new specification.
+      #
+      # @param [String] file The value of +__FILE__+ as accessed from the spec itself.
+      def initialize file
+        @name         = nil
+        @version      = nil
+        @authors      = []
+        @syndi_version = nil
+        @our_dir      = File.expand_path('..', file)
+        @bundle       = 'Gemfile'
+        @code_files   = []
+        @doc_files    = []
+        @post_message = nil
+
+        @install_do = proc { nil }
+
+        # Yield to block for configuration.
+        yield self
+
+        # Initiate installation.
+        install
+      end
+
+      # Sets the jewel name.
+      #
+      # @param [String] monkey The name of the jewel.
+      def name= monkey
+        raise JewelError, 'Invalid jewel name!' unless monkey.instance_of? String
+        monkey.downcase!
+        
+        @name = monkey
+        omg "Jewel name: #{monkey.green}"
+      end
+
+      # Sets the jewel version.
+      #
+      # @param [String] mascara The version of the jewel.
+      def version= mascara
+        mascara.downcase!
+
+        @version = mascara
+        omg "Jewel version: #{mascara.green}"
+      end
+
+      # Sets the jewel author (only one).
+      #
+      # @param [String] its_a_trap The (sole) author of the jewel.
+      def author= its_a_trap
+        raise JewelError, 'Invalid jewel author!' unless its_a_trap.instance_of? String
+
+        @authors.push its_a_trap
+        omg "Jewel written by #{its_a_trap.blue}"
+      end
+
+      # Sets multiple jewel authors.
+      #
+      # @param [Array] chi The authors of the jewel. (splat)
+      def authors= *chi
+        raise JewelError, 'Invalid jewel author list!'              unless chi.instance_of? Array
+        raise JewelError, 'Invalid method of author specification!' unless chi.length > 1
+
+        @authors = chi
+        omg "Jewel written by #{chi.join ', '}"
+      end
+
+      # Sets the Syndi version required by the jewel.
+      #
+      # @param [String] essie The minimum Syndi version required.
+      def syndi_version= essie
+        if Gem::Version.new(essie.dup) < Gem::Version.new(Syndi::VERSION.dup)
+          raise JewelError, "This jewel requires Syndi version >= #{essie.red} but current version is #{Syndi::VERSION}!"
+        end
+
+        @syndi_version = essie
+        omg "Jewel is compatible with your version of Syndi (requires: >= #{essie.green})!"
+      end
+
+      # Sets the name of the GemBundler Gemfile. Default is +Gemfile+.
+      #
+      # @param [String] sephora The name of the Gemfile.
+      def bundle= sephora = 'Gemfile'
+        raise JewelError, "Jewel's Gemfile is missing!" unless File.exists? File.join(@our_dir, sephora)
+
+        @bundle = sephora
+      end
+
+    end # class Specification
+
+  end # module Jewel
+
+end # module Syndi
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/jewel/util.rb

@@ -0,0 +1,27 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+require 'syndi'
+
+class JewelCutError < StandardError; end
+
+module Syndi
+
+  module Jewel
+
+    module Util
+
+      # Install the jewel.
+      def install
+
+
+      end
+
+    end
+
+  end
+
+end
+
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/jewel.rb

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

data/lib/syndi/rubyext/string.rb

@@ -0,0 +1,10 @@
+# This changes the String class in Ruby's standard library to make life easier
+# by aliasing String#uc to String#upcase and String#dc to String#downcase
+class String
+  alias_method :uc, :upcase
+  alias_method :dc, :downcase
+  alias_method :uc!, :upcase!
+  alias_method :dc!, :downcase!
+end
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/verbosity.rb

@@ -0,0 +1,10 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+$VERBOSITY = 0
+
+VSIMPLE = 1
+VUSEFUL = 2
+VNOISY  = 3
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/version.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+module Syndi
+  
+  # Standard version string.
+  #
+  # We use semantic versioning: +MAJOR.MINOR.PATCH.PRE.PRENUM+
+  VERSION      = '0.1.0'.freeze
+  
+  # Standard version plus the codename (assigned to each minor release).
+  #
+  # i.e., +VERSION-CODENAME+
+  FULLVERSION  = "#{VERSION}-phoenix".freeze
+
+  # @return [Boolean] Whether this is an alpha-stage copy.
+  def self.alpha?
+    (VERSION =~ /alpha/).nil? ? false : true
+  end
+  
+  # @return [Boolean] Whether this is a beta-stage copy.
+  def self.beta?
+    (VERSION =~ /beta/).nil?  ? false : true
+  end
+  
+  # @return [Boolean] Whether this is a release candidate copy.
+  def self.rc?
+    (VERSION =~ /rc/).nil?    ? false : true
+  end
+
+  # @return [Boolean] Whether this is an edge (i.e. testing, development, unstable) copy.
+  def self.edge?
+    alpha? || beta? || rc?
+  end
+
+end
+
+# vim: set ts=4 sts=2 sw=2 et: