Auto 4.0.0.alpha.1-x86-mingw32

data/lib/auto/configure/shell.rb

@@ -0,0 +1,154 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (LICENSE.md).
+
+require 'yaml'
+
+module Auto
+
+  class Configure
+    
+    # A class which allows for interaction with the current configuration,
+    # in contrast to generation of an entirely new one.
+    class Shell
+
+      # A list of commands.
+      COMMANDS = {
+        'lib.add'                     => "Add a library to loading.",
+        'lib.ls'                      => "Display a list of libraries currently loaded and available.",
+        'lib.rm'                      => "Remove a library from loading."
+      }
+
+      # @param [HighLine] hl HighLine instance.
+      def initialize(hl)
+        
+        @hl = hl # HighLine
+
+        msg = <<-eom
+Auto Configure Shell
+
+This shell allows you to make changes to your current configuration. See
+https://github.com/Auto/Auto/wiki/Auto-Configure for guidance.
+        eom
+        puts msg.yellow
+
+        # Check for ~/.config/autobot/auto.yml
+        puts ">> I am looking for your configuration file.....".blue
+        path = nil
+        if File.exists? File.join Auto::Configure::AUTODIR, 'auto.yml'
+          puts ">> I found #{File.join(Auto::Configure::AUTODIR, 'auto.yml').bold}!".green
+          path = File.join Auto::Configure::AUTODIR, 'auto.yml'
+        end
+
+        if path.nil?
+          
+          puts ">> Sorry. I could not find your configuration file.".red
+          path = ask_for_config
+
+        else
+          
+          unless @hl.agree("#$S Should I use this configuration?  ") { |q| q.default = 'y' }
+            path = ask_for_config
+          end
+
+        end
+
+        data = nil
+        File.open(path) { |f| data = f.read }
+
+        # Parse it with ol' YAML Ain't Markup Language.
+        @conf = YAML.parse(data).to_ruby
+
+        @init = true
+        
+      end
+
+      # A wrapper for {#go_without_safety} with safety.
+      def go
+        begin
+          go_without_safety
+        rescue => e
+          puts e.backtrace
+          puts "Auto Configure Shell has suffered an error. Closing shell...".red.bold
+          exit 1
+        end
+      end
+
+      # Begin.
+      def go_without_safety
+
+        # Produce le menu.
+        @hl.choose do |menu|
+          puts ">> See 'help' for assistance using this shell.".green unless @init == false
+          @init = false
+
+          menu.shell  = true
+          menu.prompt = ">> Please enter an action:  "
+
+          # add all of our commands
+          COMMANDS.each_pair do |cmd, help|
+            menu.choice(cmd, help) { act cmd }
+          end
+
+          menu.choice(:help, "Display help.") do |cmd, data|
+            
+            p data
+            args = data.split(/\s+/)
+            p args
+            if args.length < 1
+              puts ">> See https://github.com/Auto/Auto/wiki/Auto-Configure for help using this utility.".green
+              puts ">> Command list:".green
+              COMMANDS.each_pair { |c, h| puts "- #{c}: #{h}".yellow }
+            else
+              if COMMANDS.include? args[0]
+                puts ">> Help for #{args[0].bold}:".green
+                puts COMMANDS[args[0]].yellow
+              else
+                puts ">> No help available for #{args[0].bold}!".red
+              end
+            end
+            
+            go
+
+          end
+
+        end
+
+      end
+
+      # Act.
+      def act(cmd)
+
+        case cmd
+
+        when 'lib.add'
+          
+        when 'lib.ls'
+
+        when 'lib.rm'
+
+        end
+
+        go
+
+      end # def act
+
+      #######
+      private
+      #######
+
+      def ask_for_config
+        path = @hl.ask("#$S Where is your configuration file?  ") { |q| q.default = 'conf/auto.yml' }
+        until File.exists? path
+          puts ">> Sorry. That does not appear to exist.".red
+          path = @hl.ask("#$S Where is your configuration file?  ") { |q| q.default = 'conf/auto.yml' }
+        end
+        path
+      end
+
+    end # class Shell
+
+  end # class Configure
+
+end # class Auto
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/auto/dsl/base.rb

@@ -0,0 +1,74 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (LICENSE.md).
+
+# Namespace: Auto
+module Auto
+
+  # Namespace: DSL
+  module DSL
+
+    # A domain-specific language (DSL) wrapper mixin for simple usage of the events
+    # system, {Auto::API::Events}, and the timers system, {Auto::API::Timers}.
+    #
+    # @api DSL
+    # @author noxgirl
+    # @since 4.0.0
+    #
+    # @see Auto::API::Events
+    # @see Auto::API::Timers
+    module Base
+        
+      # @see Auto::API::Timers#spawn
+      def clock_do(*args);   $m.clock.spawn(*args); end
+      # @see Auto::API::Timers#del
+      def clock_stop(*args); $m.clock.del(*args);   end
+
+      # Hook onto an event.
+      #
+      # @param [Symbol] system The events system to access.
+      # @param [Symbol] event The event onto which to hook.
+      #
+      # @see Auto::API::Events#on
+      def on(sys, event, &prc)
+        if sys == :auto # central system
+          $m.events.on(event, prc)
+        else
+          $m.send(sys).events.on(event, prc) if $m.respond_to? sys
+        end
+      end
+      
+      # Emit an event.
+      #
+      # @param [Symbol] system The events system to access.
+      # @param [Symbol] event The event onto which to hook.
+      #
+      # @see Auto::API::Events#call
+      def emit(sys, event, *args)
+        if sys == :auto # central system
+          $m.events.call(event, *args)
+        else
+          $m.send(sys).events.call(event, *args) if $m.respond_to? sys
+        end
+      end
+      
+      # Delete a hook.
+      #
+      # @param [Symbol] system The events system to access.
+      # @param [Array(Symbol, Integer, String)] hook The identification data of the hook.
+      #
+      # @see Auto::API::Events#del
+      def undo_on(sys, hook)
+        if sys == :auto # central system
+          $m.events.del(hook)
+        else
+          $m.send(sys).events.del(hook) if $m.respond_to? sys
+        end
+      end
+
+    end # module Base
+
+  end # module DSL
+
+end # module Auto
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/auto/dsl/irc.rb

@@ -0,0 +1,13 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (LICENSE.md).
+
+module Auto
+  module DSL
+    module IRC
+      # ok
+    end
+  end
+end
+
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/auto/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 (LICENSE.md).
+
+require 'auto/irc/library'
+
+LIBRARY_IRC = Auto::IRC::Library.new
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/auto/irc/common.rb

@@ -0,0 +1,63 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (LICENSE.md).
+
+module Auto
+
+  module IRC
+
+    # A class which manages such common IRC functions as autojoining channels,
+    # and identifying to services the traditional PRIVMSG way.
+    class Common
+
+      # Construct a new common function handler.
+      #
+      # @param [Auto::IRC::Library] lib The IRC library instance.
+      def initialize lib
+        @lib = lib
+        $m.events.on   :die,       &method(:do_die)
+        @lib.events.on :connected, &method(:do_autojoin)
+      end
+
+      # Automatically identify with services the traditional way, which is
+      # to say by a /msg.
+      #
+      # @param [Auto::IRC::Server] irc The IRC connection.
+      def do_identify irc
+        if $m.conf['irc'][irc.s]['nickIdentify']
+          
+          # Assume the service is NickServ if not specified
+          service = $m.conf['irc'][irc.s]['nickIdentify']['service'] || 'NickServ'
+          # and assume the command is IDENTIFY if not specified
+          command = $m.conf['irc'][irc.s]['nickIdentify']['command'] || 'IDENTIFY'
+
+          # we can't actually /msg anyone yet.....
+        end
+      end
+
+      # Automatically join IRC channels upon connection.
+      #
+      # @param [Auto::IRC::Server] irc The IRC connection.
+      def do_autojoin irc
+        if $m.conf['irc'][irc.s]['autojoin']
+          
+          $m.conf['irc'][irc.s]['autojoin'].each do |chan|
+            irc.join(chan['name'], chan['key']||nil)
+          end
+
+        end
+      end
+
+      # Disconnect from servers on termination.
+      #
+      # @param [String] reason Reason for termination.
+      def do_die reason
+        @lib.connections.each { |net, irc| irc.disconnect reason }
+      end
+
+    end # class Common
+
+  end # module IRC
+
+end # module Auto
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/auto/irc/library.rb

@@ -0,0 +1,89 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (LICENSE.md).
+
+require 'auto/irc/server'
+require 'auto/irc/object/entity'
+require 'auto/irc/object/channel'
+require 'auto/irc/object/user'
+require 'auto/irc/protocol'
+require 'auto/irc/common'
+
+module Auto
+  
+  module IRC
+    
+    # The base of the IRC framework.
+    #
+    # @!attribute [r] events
+    #   @return [Auto::API::Events] The IRC event system.
+    #
+    # @!attribute [r] connections
+    #   @return [Hash{String => Auto::IRC::Server}] Collection of IRC connections. 
+    class Library
+
+      attr_reader :events, :connections
+
+      def initialize
+
+        # Initialize our event system.
+        @events      = Auto::API::Events.new
+        # Prepare our collection of IRC server connections.
+        @connections = Hash.new
+      
+        # Be ready to accept data.
+        $m.events.on :net_receive, 1, &method(:receive)
+
+        # Start connections when Auto is started.
+        $m.events.on :start, &method(:start)
+
+        # Parse data.
+        @parser = Auto::IRC::Protocol.new self
+
+        # Handle common functions.
+        @common = Auto::IRC::Common.new self
+        
+      end # def initialize
+
+      # Process incoming network data.
+      #
+      # @param [Object] socket_object The socket object, which in the case of
+      #   ourselves should be an {Auto::IRC::Server}, or we won't handle it.
+      def receive socket_object
+        if socket_object.instance_of? Auto::IRC::Server
+          socket_object.recv
+        end
+      end
+
+      # Initiate IRC connections.
+      def start
+        
+        # Iterate through each IRC server in the config, and connect to it.
+        $m.conf['irc'].each do |name, hash|
+          begin
+            # Configure the IRC instance.
+            @connections[name] = Auto::IRC::Server.new(name) do |c|
+              c.address = hash['address']
+              c.port    = hash['port']
+              c.nick    = hash['nickname'][0] 
+              c.user    = hash['username']
+              c.real    = hash['realName']
+              c.ssl     = hash['useSSL']
+            end
+
+            # Connect.
+            $m.sockets << @connections[name]
+            @connections[name].connect
+          rescue => e
+            $m.error("Connection to #{name} failed: #{e}", false, e.backtrace)
+          end
+        end
+
+      end # def start
+
+    end # class Library
+
+  end # module IRC
+
+end # module Auto
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/auto/irc/object/channel.rb

@@ -0,0 +1,21 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (LICENSE.md).
+
+# Namespace: IRC
+module IRC
+
+  # Namespace: Object
+  module Object
+
+    # A class which represents an individual IRC channel, its associated
+    # properties, the users which it contains, and methods to interact with it.
+    class Channel
+
+
+    end # class Channel
+
+  end # module Object
+
+end # module IRC
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/auto/irc/object/entity.rb

@@ -0,0 +1,90 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (LICENSE.md).
+
+module Auto
+
+  module IRC
+  
+    module Object
+
+      # A superclass which represents an IRC 'entity'; i.e., a channel or user.
+      # It acts as a base for {Auto::IRC::Object::User} and {Auto::IRC::Object::Channel}.
+      #
+      # @api IRC
+      # @since 4.0.0
+      # @author noxgirl
+      #
+      # @!attribute [r] irc
+      #   @return [Auto::IRC::Server] The IRC server on which this entity exists.
+      #
+      # @!attribute [r] name
+      #   @return [String] The name of the entity.
+      class Entity
+
+        attr_reader :irc, :name
+
+        # New instance.
+        #
+        # @param [Auto::IRC::Server] irc The server.
+        # @param [Symbol] type Either +:channel+ or +:user+.
+        # @param [String] name The name of this entity (nickname or channel name).
+        def initialize(irc, type, name)
+          @irc         = irc
+          @entity_type = type
+          @name        = name
+        end
+
+        # @return [true, false] Whether we're a channel.
+        def channel?
+          @entity_type == :channel ? true : false
+        end
+        
+        # @return [true, false] Whether we're a user.
+        def user?
+          @entity_type == :user ? true : false
+        end
+
+        # Send a message to this entity. This will additionally divide messages
+        # which are too long into multiple messages.
+        #
+        # This will call irc:onMsg with +self+ and +message+.
+        #
+        # @param [String] message The message.
+        # @param [true, false] notice Whether this should be a /notice as opposed
+        #   to a /msg.
+        def msg(message, notice=false)
+          
+          command = (notice == false ? 'PRIVMSG' : 'NOTICE')
+          len     = ":#{@irc.nick}!#{@irc.user}@#{@irc.mask} #{command} #@name :".length
+          raw     = ":#{@irc.nick}!#{@irc.user}@#{@irc.mask} #{command} #@name :#{message}\r\n"
+
+          if raw.length > 512
+            
+            msgs     = []
+            nmessage = message 
+            until raw.length <= 512
+              msgs << nmessage.slice!(0, 512-len)
+              raw = ":#{@irc.nick}!#{@irc.user}@#{@irc.mask} #{command} #@name :#{nmessage}\r\n"
+            end
+            
+            msgs.each { |m| @irc.snd "#{command} #@name :#{m}" }
+          
+          else
+            @irc.snd "#{command} #@name :#{message}"
+          end
+
+          $m.events.call 'irc:onMsg', self, message
+
+        end # def msg
+
+        def to_s; @name; end
+
+      end # class Entity
+
+    end # module Object
+
+  end # module IRC
+
+end # module Auto
+
+# vim: set ts=4 sts=2 sw=2 et: