ronin-support 0.5.1 → 1.0.0.beta1

data/lib/ronin/network/unix.rb

@@ -1,286 +0,0 @@
-#
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of Ronin Support.
-#
-# Ronin Support is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin Support 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 Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
-#
-
-require 'socket'
-require 'timeout'
-
-module Ronin
-  module Network
-    #
-    # Provides helper methods for communicating with UNIX sockets.
-    #
-    # @since 0.5.0
-    #
-    module UNIX
-      #
-      # Tests whether a UNIX socket is open.
-      #
-      # @param [String] path
-      #   The path to the socket.
-      #
-      # @param [Integer] timeout (5)
-      #   The maximum time to attempt connecting.
-      #
-      # @return [Boolean, nil]
-      #   Specifies whether the UNIX socket is open.
-      #   If the connection was not accepted, `nil` will be returned.
-      #
-      # @api public
-      #
-      # @since 0.5.0
-      #
-      def unix_open?(path,timeout=nil)
-        timeout ||= 5
-
-        begin
-          Timeout.timeout(timeout) { unix_session(path) }
-          return true
-        rescue Timeout::Error
-          return nil
-        rescue SocketError, SystemCallError
-          return false
-        end
-      end
-
-      #
-      # Connects to a UNIX socket.
-      #
-      # @param [String] path
-      #   The path to the UNIX socket.
-      #
-      # @yield [socket]
-      #   If a block is given, it will be passed an UNIX socket object.
-      #
-      # @yieldparam [UNIXSocket] socket
-      #   The UNIX socket.
-      #
-      # @return [UNIXSocket]
-      #   The UNIX socket.
-      #
-      # @example
-      #   unix_connect('/tmp/haproxy.stats.socket')
-      #
-      # @see http://rubydoc.info/stdlib/socket/UNIXSocket
-      #
-      # @api public
-      #
-      def unix_connect(path)
-        socket = UNIXSocket.new(path)
-
-        yield socket if block_given?
-        return socket
-      end
-
-      #
-      # Connects to a UNIX Socket and sends the given data.
-      #
-      # @param [String] data
-      #   The data to send to the socket.
-      #
-      # @param [String] path
-      #   The path to the socket.
-      #
-      # @yield [socket]
-      #   If a block is given, it will be passed the newly created socket.
-      #
-      # @yieldparam [UNIXSocket] socket
-      #   The newly created UNIXSocket object.
-      #
-      # @return [UNIXSocket]
-      #   The newly created UNIXSocket object.
-      #
-      # @api public
-      #
-      def unix_connect_and_send(data,path)
-        socket = unix_connect(path)
-        socket.write(data)
-
-        yield socket if block_given?
-        return socket
-      end
-
-      #
-      # Temporarily connects to a UNIX socket.
-      #
-      # @param [String] path
-      #   The path to the UNIX socket.
-      #
-      # @yield [socket]
-      #   If a block is given, it will be passed an UNIX socket object.
-      #
-      # @yieldparam [UNIXSocket] socket
-      #   The UNIX socket.
-      #
-      # @example
-      #   unix_session('/tmp/haproxy.stats.socket') do |socket|
-      #     # ...
-      #   end
-      #
-      # @api public
-      #
-      def unix_session(path)
-        socket = unix_connect(path)
-
-        yield socket if block_given?
-        socket.close
-        return nil
-      end
-
-      #
-      # Connects to a UNIX socket, sends the given data and then closes the
-      # socket.
-      #
-      # @param [String] data
-      #   The data to send to the UNIX socket.
-      #
-      # @param [String] path
-      #   The UNIX socket to connect to.
-      #
-      # @return [true]
-      #   The data was successfully sent.
-      #
-      # @example
-      #   buffer = "GET /" + ('A' * 4096) + "\n\r"
-      #   unix_send(buffer,'/tmp/thin.socket')
-      #   # => true
-      #
-      # @api public
-      #
-      def unix_send(data,path)
-        unix_session(path) do |socket|
-          socket.write(data)
-        end
-
-        return true
-      end
-
-      #
-      # Opens a UNIX socket.
-      #
-      # @param [String] path
-      #   The path for the new UNIX socket.
-      #
-      # @yield [server]
-      #   If a block is given, it will be passed an UNIX socket object.
-      #
-      # @yieldparam [UNIXServer] server
-      #   The new UNIX socket.
-      #
-      # @return [UNIXServer]
-      #   The new UNIX socket.
-      #
-      # @example
-      #   unix_server('/tmp/test.socket')
-      #
-      # @see http://rubydoc.info/stdlib/socket/UNIXServer
-      #
-      # @api public
-      #
-      def unix_server(path)
-        socket = UNIXServer.new(path)
-
-        yield socket if block_given?
-        return socket
-      end
-
-      #
-      # Temporarily opens a UNIX socket.
-      #
-      # @param [String] path
-      #   The path for the new UNIX socket.
-      #
-      # @yield [server]
-      #   If a block is given, it will be passed an UNIX socket object.
-      #
-      # @yieldparam [UNIXServer] server
-      #   The new UNIX socket.
-      #
-      # @example
-      #   unix_server_session('/tmp/test.socket') do |server|
-      #     # ...
-      #   end
-      #
-      # @api public
-      #
-      def unix_server_session(path,&block)
-        socket = unix_server(path,&block)
-        socket.close
-        return nil
-      end
-
-      #
-      # Opens a UNIX socket, accepts connections in a loop.
-      #
-      # @param [String] path
-      #   The path for the new UNIX socket.
-      #
-      # @yield [client]
-      #   If a block is given, it will be passed each accepted connection.
-      #
-      # @yieldparam [UNIXSocket] client
-      #   An accepted connection to UNIX socket.
-      #
-      # @example
-      #   unix_server_loop('/tmp/test.socket') do |client|
-      #     # ...
-      #   end
-      #
-      # @api public
-      #
-      def unix_server_loop(path)
-        unix_server_session(path) do |server|
-          loop do
-            client = server.accept
-
-            yield client if block_given?
-            client.close
-          end
-        end
-      end
-
-      #
-      # Opens a UNIX socket, accepts a connection, then closes the socket.
-      #
-      # @param [String] path
-      #   The path for the new UNIX socket.
-      #
-      # @yield [client]
-      #   If a block is given, it will be passed the accepted connection.
-      #
-      # @yieldparam [UNIXSocket] client
-      #   The accepted connection to UNIX socket.
-      #
-      # @example
-      #   unix_accept('/tmp/test.socket') do |client|
-      #     # ...
-      #   end
-      #
-      # @api public
-      #
-      def unix_accept(path)
-        unix_server_session(path) do |server|
-          client = server.accept
-
-          yield client if block_given?
-          client.close
-        end
-      end
-    end
-  end
-end

data/lib/ronin/network.rb

@@ -1,31 +0,0 @@
-#
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of Ronin Support.
-#
-# Ronin Support is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin Support 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 Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
-#
-
-require 'ronin/network/dns'
-require 'ronin/network/tcp'
-require 'ronin/network/udp'
-require 'ronin/network/ssl'
-require 'ronin/network/unix'
-require 'ronin/network/smtp'
-require 'ronin/network/esmtp'
-require 'ronin/network/pop3'
-require 'ronin/network/imap'
-require 'ronin/network/telnet'
-require 'ronin/network/ftp'
-require 'ronin/network/http'

data/lib/ronin/path.rb

@@ -1,137 +0,0 @@
-#
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of Ronin Support.
-#
-# Ronin Support is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin Support 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 Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
-#
-
-require 'pathname'
-
-module Ronin
-  #
-  # The {Path} class extends `Pathname` to allow representing directory
-  # traversal paths.
-  #
-  class Path < Pathname
-
-    # The separator to join paths together with
-    attr_accessor :separator
-
-    def initialize(path)
-      @separator = File::SEPARATOR
-
-      super(path)
-    end
-
-    #
-    # The root path.
-    #
-    # @return [Path]
-    #   The root path.
-    #
-    # @api public
-    #
-    def Path.root
-      Path.new('/')
-    end
-
-    #
-    # Creates a new path object for upward directory traversal.
-    #
-    # @param [Integer, Array, Range] n
-    #   The number of directories to go up.
-    #
-    # @param [String] separator
-    #   Path separator.
-    #
-    # @return [Path]
-    #   The new path object.
-    #
-    # @raise [ArgumentError]
-    #   A negative number was given as the first argument.
-    #
-    # @example Generate a relative path that goes up 7 directories:
-    #   Path.up(7)
-    #   # => #<Ronin::Path:../../../../../../..>
-    #
-    # @example Generate multiple relative paths, going up 1 to 3 directories:
-    #   Path.up(1..3)
-    #   # => [#<Ronin::Path:..>, #<Ronin::Path:../..>,
-    #   #<Ronin::Path:../../..>]
-    #
-    # @api public
-    #
-    def self.up(n,separator=File::SEPARATOR)
-      case n
-      when Integer
-        if n == 0
-          return separator
-        elsif n < 0
-          raise(ArgumentError,"negative argument")
-        end
-
-        path = new('..')
-        path.separator = separator
-
-        dirs = (['..'] * (n-1))
-
-        Path.new(path.join(*dirs))
-      when Enumerable
-        n.map { |i| up(i) }
-      else
-        raise(ArgumentError,"The first argument of Path.up must be either an Integer or Enumerable")
-      end
-    end
-
-    #
-    # Joins directory names together with the path, but does not resolve
-    # the resulting path.
-    #
-    # @param [Array] names
-    #   The names to join together.
-    #
-    # @return [Path]
-    #   The joined path.
-    #
-    # @example
-    #   Path.up(7).join('etc/passwd')
-    #   # => #<Ronin::Path:../../../../../../../etc/passwd>
-    #
-    # @api public
-    #
-    def join(*names)
-      names.map! { |name| name.to_s }
-
-      # filter out errant directory separators
-      names.reject! { |dir| dir == @separator }
-
-      # join the path
-      sub_path = names.join(@separator)
-
-      path = if root?
-               # prefix the root dir
-               self.to_s + sub_path
-             else
-               # join the path with the sub-path
-               [self.to_s, sub_path].join(@separator)
-             end
-
-      return self.class.new(path)
-    end
-
-    alias / join
-
-  end
-end

data/lib/ronin/spec/ui/output.rb

@@ -1,22 +0,0 @@
-#
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of Ronin Support.
-#
-# Ronin Support is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin Support 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 Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
-#
-
-require 'ronin/ui/output'
-
-Ronin::UI::Output.silent! unless ENV['DEBUG']

data/lib/ronin/support/inflector.rb

@@ -1,92 +0,0 @@
-#
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of Ronin Support.
-#
-# Ronin Support is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin Support 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 Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
-#
-
-module Ronin
-  module Support
-    # The Inflectors supported by ronin-support
-    INFLECTORS = {
-      :data_mapper => {
-        :path => 'dm-core',
-        :const => 'DataMapper::Inflector'
-      },
-      :active_support => {
-        :path => 'active_support/inflector',
-        :const => 'ActiveSupport::Inflector'
-      }
-    }
-
-    #
-    # Loads an Inflector library and sets the `Ronin::Support::Inflector`
-    # constant.
-    #
-    # @param [Symbol, String] name
-    #   The name of the Inflector library to load. May be either
-    #   `:datamapper` or `:active_support`.
-    #
-    # @return [true]
-    #   Specifies that the Inflector library was successfully loaded.
-    #
-    # @raise [ArgumentError]
-    #   The Inflector library is not supported.
-    #
-    # @raise [LoadError]
-    #   The Inflector library could not be loaded.
-    #
-    # @raise [NameError]
-    #   The constant could not be found.
-    #
-    # @api private
-    #
-    def Support.load_inflector!(name)
-      name = name.to_sym
-
-      unless (inflector = INFLECTORS[name])
-        raise(ArgumentError,"unsupported Inflector: #{name}")
-      end
-
-      begin
-        require inflector[:path]
-      rescue Gem::LoadError => e
-        raise(e)
-      rescue ::LoadError
-        raise(LoadError,"unable to load #{inflector[:path]}")
-      end
-
-      begin
-        const_set('Inflector', eval("::#{inflector[:const]}"))
-      rescue NameError
-        raise(NameError,"unable to find #{inflector[:const]}")
-      end
-
-      return true
-    end
-
-    [:data_mapper, :active_support].each do |name|
-      begin
-        Support.load_inflector!(name)
-        break
-      rescue LoadError
-      end
-    end
-
-    unless const_defined?('Inflector')
-      raise(LoadError,"unable to load or find any Inflectors")
-    end
-  end
-end

data/lib/ronin/support/support.rb

@@ -1,42 +0,0 @@
-#
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of Ronin Support.
-#
-# Ronin Support is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin Support 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 Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
-#
-
-require 'ronin/ui/output'
-require 'ronin/network'
-
-module Ronin
-  #
-  # The main namespace for `ronin-support`.
-  #
-  module Support
-    include UI::Output::Helpers
-    include Network::DNS
-    include Network::TCP
-    include Network::UDP
-    include Network::SSL
-    include Network::UNIX
-    include Network::SMTP
-    include Network::ESMTP
-    include Network::POP3
-    include Network::IMAP
-    include Network::Telnet
-    include Network::FTP
-    include Network::HTTP
-  end
-end

data/lib/ronin/templates/erb.rb

@@ -1,78 +0,0 @@
-#
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of Ronin Support.
-#
-# Ronin Support is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin Support 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 Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
-#
-
-require 'ronin/templates/template'
-
-require 'erb'
-
-module Ronin
-  module Templates
-    #
-    # The {Erb} module uses the {Template} module to find and render
-    # Embedded Ruby (ERB) templates.
-    #
-    module Erb
-      include Template
-
-      #
-      # Renders the inline ERB template in the scope of the object.
-      #
-      # @param [String] template
-      #   Source of the ERB template.
-      #
-      # @return [String]
-      #   Result of the rendered template.
-      #
-      # @example
-      #   @user = 'lolcats'
-      #
-      #   erb %{
-      #   USER: <%= @user %>
-      #   PASSWORD: <%= @user.reverse %>
-      #   }
-      #   # => "\nUSER: lolcats\nPASSWORD: staclol\n"
-      #
-      # @api public
-      #
-      def erb(template)
-        ERB.new(template,nil,'-').result(binding)
-      end
-
-      #
-      # Renders an ERB template file in the scope of the object.
-      #
-      # @param [String] template_path
-      #   The relative path of the ERB template.
-      #
-      # @return [String]
-      #   Result of the rendered template.
-      #
-      # @example
-      #   erb_file 'path/to/template.erb'
-      #
-      # @api public
-      #
-      def erb_file(template_path)
-        read_template(template_path) do |template|
-          erb(template)
-        end
-      end
-    end
-  end
-end