ronin-web 0.2.1 → 0.3.0.pre1

data/lib/ronin/network/{helpers → mixins}/web.rb

@@ -2,43 +2,68 @@
 # Ronin Web - A Ruby library for Ronin that provides support for web
 # scraping and spidering functionality.
 #
-# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This program is free software; you can redistribute it and/or modify
+# This file is part of Ronin Web.
+#
+# Ronin is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
+# the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# This program is distributed in the hope that it will be useful,
+# Ronin 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 General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/network/helpers/helper'
+require 'ronin/ui/output/helpers'
 require 'ronin/network/http/proxy'
 require 'ronin/web/web'
+require 'ronin/mixin'
+
+require 'parameters'
 
 module Ronin
   module Network
-    module Helpers
+    module Mixins
       module Web
-        include Helper
+ 
+        mixin UI::Output::Helpers, Parameters
+
+        mixin do
+          # The Web Proxy host to connect to
+          parameter :web_proxy_host, :type => String,
+                                     :description => 'Web Proxy host'
+
+          # The Web Proxy port to connect to
+          parameter :web_proxy_port, :type => Integer,
+                                     :description => 'Web Proxy port'
+
+          # The Web Proxy user to authenticate with
+          parameter :web_proxy_user, :type => String,
+                                     :description => 'Web Proxy authentication user'
+
+          # The Web Proxy password to authenticate with
+          parameter :web_proxy_password, :type => String,
+                                         :description => 'Web Proxy authentication password'
+        end
 
         protected
 
         #
-        # Combines the proxy information set by the +@web_proxy_host+,
-        # +@web_proxy_port+, +@web_proxy_user+ and +@web_proxy_password+
-        # instance variables.
+        # Combines the proxy information set by the `web_proxy_host`,
+        # `web_proxy_port`, `web_proxy_user` and `web_proxy_password`
+        # parameters.
         #
         # @return [Network::HTTP::Proxy]
         #   The current proxy information.
         #
+        # @api semipublic
+        #
         def web_proxy
           HTTP::Proxy.new(
             :host => @web_proxy_host,
@@ -57,12 +82,14 @@ module Ronin
         # @option options [Hash] :proxy (web_proxy)
         #   Proxy information.
         #
-        # @option options [String] :user_agent (+@web_user_agent+)
+        # @option options [String] :user_agent (web_user_agent)
         #   User-Agent string to use.
         #
-        # @return [WWW::Mechanize]
+        # @return [Mechanize]
         #   The agent.
         #
+        # @api semipublic
+        #
         def web_agent(options={},&block)
           unless @web_agent
             options[:proxy] ||= web_proxy
@@ -86,23 +113,26 @@ module Ronin
         # @option options [Hash] :proxy (web_proxy)
         #   Proxy information.
         #
-        # @option options [String] :user_agent (+@web_user_agent+)
+        # @option options [String] :user_agent (web_user_agent)
         #   User-Agent string to use.
         #
         # @yield [page]
         #   If a block is given, it will be passed the page for the
         #   requested URL.
         #
-        # @yieldparam [WWW::Mechanize::Page] page
+        # @yieldparam [Mechanize::Page] page
         #   The requested page.
         #
-        # @return [WWW::Mechanize::Page]
+        # @return [Mechanize::Page]
         #   The requested page.
         #
-        def web_get(url,options={},&block)
+        # @api semipublic
+        #
+        def web_get(url,options={})
+          print_info "Requesting #{url}"
           page = web_agent(options).get(url)
 
-          block.call(page) if block
+          yield page if block_given?
           return page
         end
 
@@ -119,7 +149,7 @@ module Ronin
         # @option options [Hash] :proxy (web_proxy)
         #   Proxy information.
         #
-        # @option options [String] :user_agent (+@web_user_agent+)
+        # @option options [String] :user_agent (web_user_agent)
         #   User-Agent string to use.
         #
         # @yield [body]
@@ -131,13 +161,14 @@ module Ronin
         # @return [String]
         #   The requested body of the page.
         #
-        def web_get_body(url,options={},&block)
-          web_get(url,options) do |page|
-            body = page.body
+        # @api semipublic
+        #
+        def web_get_body(url,options={})
+          page = web_get(url,options)
+          body = page.body
 
-            block.call(body) if block
-            return body
-          end
+          yield body if block_given?
+          return body
         end
 
         #
@@ -156,26 +187,29 @@ module Ronin
         # @option options [Hash] :proxy (web_proxy)
         #   Proxy information.
         #
-        # @option options [String] :user_agent (+@web_user_agent+)
+        # @option options [String] :user_agent (web_user_agent)
         #   User-Agent string to use.
         #
         # @yield [page]
         #   If a block is given, it will be passed the page for the
         #   requested URL.
         #
-        # @yieldparam [WWW::Mechanize::Page] page
+        # @yieldparam [Mechanize::Page] page
         #   The requested page.
         #
-        # @return [WWW::Mechanize::Page]
+        # @return [Mechanize::Page]
         #   The requested page.
         #
-        def web_post(url,options={},&block)
+        # @api semipublic
+        #
+        def web_post(url,options={})
           query = {}
           query.merge!(options[:query]) if options[:query]
 
+          print_info "Posting #{url}"
           page = web_agent(options).post(url)
 
-          block.call(page) if block
+          yield page if block_given?
           return page
         end
 
@@ -195,25 +229,26 @@ module Ronin
         # @option options [Hash] :proxy (web_proxy)
         #   Proxy information.
         #
-        # @option options [String] :user_agent (+@web_user_agent+)
+        # @option options [String] :user_agent (web_user_agent)
         #   User-Agent string to use.
         #
         # @yield [body]
         #   If a block is given, it will be passed the body of the page.
         #
-        # @yieldparam [WWW::Mechanize::Page] page
+        # @yieldparam [Mechanize::Page] page
         #   The body of the requested page.
         #
         # @return [String]
         #   The requested body of the page.
         #
-        def web_post_body(url,options={},&block)
-          web_post(url,options) do |page|
-            body = page.body
+        # @api semipublic
+        #
+        def web_post_body(url,options={})
+          page = web_post(url,options)
+          body = page.body
 
-            block.call(body) if block
-            return body
-          end
+          yield body if block_given?
+          return body
         end
       end
     end

data/lib/ronin/web.rb

@@ -2,21 +2,22 @@
 # Ronin Web - A Ruby library for Ronin that provides support for web
 # scraping and spidering functionality.
 #
-# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This program is free software; you can redistribute it and/or modify
+# This file is part of Ronin Web.
+#
+# Ronin is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
+# the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# This program is distributed in the hope that it will be useful,
+# Ronin 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 General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 require 'ronin/web/extensions'

data/lib/ronin/web/extensions.rb

@@ -2,21 +2,22 @@
 # Ronin Web - A Ruby library for Ronin that provides support for web
 # scraping and spidering functionality.
 #
-# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This program is free software; you can redistribute it and/or modify
+# This file is part of Ronin Web.
+#
+# Ronin is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
+# the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# This program is distributed in the hope that it will be useful,
+# Ronin 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 General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 require 'ronin/web/extensions/nokogiri'

data/lib/ronin/web/extensions/nokogiri.rb

@@ -1 +1,23 @@
+#
+# Ronin Web - A Ruby library for Ronin that provides support for web
+# scraping and spidering functionality.
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Web.
+#
+# Ronin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 require 'ronin/web/extensions/nokogiri/xml'

data/lib/ronin/web/extensions/nokogiri/xml.rb

@@ -1,3 +1,25 @@
+#
+# Ronin Web - A Ruby library for Ronin that provides support for web
+# scraping and spidering functionality.
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Web.
+#
+# Ronin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 require 'ronin/web/extensions/nokogiri/xml/node'
 require 'ronin/web/extensions/nokogiri/xml/text'
 require 'ronin/web/extensions/nokogiri/xml/attr'

data/lib/ronin/web/extensions/nokogiri/xml/attr.rb

@@ -1,10 +1,44 @@
+#
+# Ronin Web - A Ruby library for Ronin that provides support for web
+# scraping and spidering functionality.
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Web.
+#
+# Ronin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 require 'nokogiri'
 
 module Nokogiri
   module XML
     class Attr < Node
 
-      def similar?(other)
+      #
+      # Determines if the attribute is similar to another attribute.
+      #
+      # @param [Nokogiri::XML::Attr] other
+      #   The other attribute.
+      #
+      # @return [Boolean]
+      #   Specifies if the attribute is similar, in indentity or value,
+      #   to the other attribute.
+      #
+      # @api public
+      #
+      def ==(other)
         super(other) && (self.value == other.value)
       end
 

data/lib/ronin/web/extensions/nokogiri/xml/document.rb

@@ -1,3 +1,25 @@
+#
+# Ronin Web - A Ruby library for Ronin that provides support for web
+# scraping and spidering functionality.
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Web.
+#
+# Ronin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 require 'nokogiri'
 
 module Nokogiri
@@ -5,12 +27,20 @@ module Nokogiri
     class Document < Node
 
       #
-      # Returns the total count of all sub-children of the document.
+      # Calculates the sum of all sub-children of the document.
+      #
+      # @return [Integer]
+      #   The total number of children and sub-children of the document.
+      #   Returns `0` if the document has no root element.
+      #
+      # @api public
       #
       def total_children
-        return 0 unless root
-
-        1 + root.total_children
+        if root
+          1 + root.total_children
+        else
+          0
+        end
       end
 
     end

data/lib/ronin/web/extensions/nokogiri/xml/element.rb

@@ -1,10 +1,44 @@
+#
+# Ronin Web - A Ruby library for Ronin that provides support for web
+# scraping and spidering functionality.
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Web.
+#
+# Ronin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 require 'nokogiri'
 
 module Nokogiri
   module XML
     class Element < Node
 
-      def similar?(other)
+      #
+      # Determines if the element is similar to another element.
+      #
+      # @param [Nokogiri::XML::Element] other
+      #   The other element.
+      #
+      # @return [Boolean]
+      #   Specifies whether the element is equal, in identity or value, to
+      #   another element.
+      #
+      # @api public
+      #
+      def ==(other)
         return false unless super(other)
         return false unless attribute_nodes.length == other.attribute_nodes.length
 
@@ -15,7 +49,7 @@ module Nokogiri
           return false unless attr1.similar?(attr2)
         end
 
-        true
+        return true
       end
 
     end