ronin-web 0.3.0.rc1 → 1.0.0.beta2

data/lib/ronin/web/cli/ruby_shell.rb

@@ -0,0 +1,50 @@
+#
+# ronin-web - A collection of useful web helper methods and commands.
+#
+# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-web 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-web 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-web.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/core/cli/ruby_shell'
+
+module Ronin
+  module Web
+    class CLI
+      #
+      # The interactive Ruby shell for {Ronin::Web}.
+      #
+      class RubyShell < Core::CLI::RubyShell
+
+        #
+        # Initializes the `ronin-web` Ruby shell.
+        #
+        # @param [String] name
+        #   The name of the IRB shell.
+        #
+        # @param [Object] context
+        #   Custom context to launch IRB from within.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for
+        #   `Ronin::Core::CLI::RubyShell#initialize`.
+        #
+        def initialize(name: 'ronin-web', context: Web, **kwargs)
+          super(name: name, context: context, **kwargs)
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/web/cli.rb

@@ -0,0 +1,49 @@
+#
+# ronin-web - A collection of useful web helper methods and commands.
+#
+# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-web 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-web 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-web.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/web/version'
+
+require 'command_kit/commands'
+require 'command_kit/commands/auto_load'
+require 'command_kit/options/version'
+
+module Ronin
+  module Web
+    #
+    # The `ronin-web` command-line interface (CLI).
+    #
+    # @api private
+    #
+    # @since 1.0.0
+    #
+    class CLI
+
+      include CommandKit::Commands
+      include CommandKit::Commands::AutoLoad.new(
+        dir:       "#{__dir__}/cli/commands",
+        namespace: "#{self}::Commands"
+      )
+      include CommandKit::Options::Version
+
+      command_name 'ronin-web'
+      version Ronin::Web::VERSION
+
+    end
+  end
+end

data/lib/ronin/web/html.rb

@@ -0,0 +1,85 @@
+#
+# ronin-web - A collection of useful web helper methods and commands.
+#
+# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-web 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-web 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-web.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'nokogiri'
+
+module Ronin
+  module Web
+    #
+    # HTML helper methods.
+    #
+    # @since 1.0.0
+    #
+    module HTML
+      #
+      # Parses the body of a document into a HTML document object.
+      #
+      # @param [String, IO] html
+      #   The HTML to parse.
+      #
+      # @yield [doc]
+      #   If a block is given, it will be passed the newly created document
+      #   object.
+      #
+      # @yieldparam [Nokogiri::HTML::Document] doc
+      #   The new HTML document object.
+      #
+      # @return [Nokogiri::HTML::Document]
+      #   The new HTML document object.
+      #
+      # @see http://rubydoc.info/gems/nokogiri/Nokogiri/HTML/Document
+      #
+      # @api public
+      #
+      def self.parse(html)
+        doc = Nokogiri::HTML.parse(html)
+        yield doc if block_given?
+        return doc
+      end
+
+      #
+      # Creates a new `Nokogiri::HTML::Builder`.
+      #
+      # @yield []
+      #   The block that will be used to construct the HTML document.
+      #
+      # @return [Nokogiri::HTML::Builder]
+      #   The new HTML builder object.
+      #
+      # @example
+      #   HTML.build do
+      #     html {
+      #       body {
+      #         div(style: 'display:none;') {
+      #           object(classid: 'blabla')
+      #         }
+      #       }
+      #     }
+      #   end
+      #
+      # @see http://rubydoc.info/gems/nokogiri/Nokogiri/HTML/Builder
+      #
+      # @api public
+      #
+      def self.build(&block)
+        Nokogiri::HTML::Builder.new(&block)
+      end
+    end
+  end
+end

data/lib/ronin/web/mechanize.rb

@@ -1,49 +1,50 @@
 #
-# Ronin Web - A Ruby library for Ronin that provides support for web
-# scraping and spidering functionality.
+# ronin-web - A collection of useful web helper methods and commands.
 #
-# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2023 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
+# ronin-web 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,
+# ronin-web 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/>.
+# along with ronin-web.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/web/web'
-require 'ronin/network/http/proxy'
+require 'ronin/support/network/http'
 
 require 'mechanize'
 
 module Ronin
   module Web
+    #
+    # Convenience class based on Mechanize.
+    #
+    # @see http://rubydoc.info/gems/mechanize/Mechanize
+    #
     class Mechanize < ::Mechanize
 
       #
       # Creates a new [Mechanize](http://mechanize.rubyforge.org/) Agent.
       #
-      # @param [Hash] options
-      #   Additional options.
-      #
-      # @option options [String] :user_agent
-      #   The User-Agent string to use.
-      #
-      # @option options [String] :user_agent_alias
-      #   The User-Agent Alias to use.
-      #
-      # @option options [Network::HTTP::Proxy, Hash, String] :proxy (Web.proxy)
+      # @param [Network::HTTP::Proxy, Hash, String] proxy
       #   Proxy information.
       #
+      # @param [String, :random, :chrome, :chrome_linux, :chrome_macos,
+      #         :chrome_windows, :chrome_iphone, :chrome_ipad,
+      #         :chrome_android, :firefox, :firefox_linux, :firefox_macos,
+      #         :firefox_windows, :firefox_iphone, :firefox_ipad,
+      #         :firefox_android, :safari, :safari_macos, :safari_iphone,
+      #         :safari_ipad, :edge, :linux, :macos, :windows, :iphone,
+      #         :ipad, :android, nil] user_agent
+      #   The `User-Agent` string to use.
+      #
       # @yield [agent]
       #   If a block is given, it will be passed the newly created Mechanize
       #   agent.
@@ -51,26 +52,23 @@ module Ronin
       # @yieldparam [Mechanize] agent
       #   The new Mechanize agent.
       #
-      def initialize(options={})
+      def initialize(proxy:      Support::Network::HTTP.proxy,
+                     user_agent: Support::Network::HTTP.user_agent)
         super()
 
-        if options[:user_agent_alias]
-          self.user_agent_alias = options[:user_agent_alias]
-        elsif options[:user_agent]
-          self.user_agent = options[:user_agent]
-        elsif Web.user_agent
-          self.user_agent = Web.user_agent
-        end
+        if proxy
+          proxy = URI(proxy)
 
-        proxy = Network::HTTP::Proxy.new(options[:proxy] || Web.proxy)
+          set_proxy(proxy.host,proxy.port,proxy.user,proxy.password)
+        end
 
-        if proxy[:host]
-          set_proxy(
-            proxy[:host],
-            proxy[:port],
-            proxy[:user],
-            proxy[:password]
-          )
+        if user_agent
+          self.user_agent = case user_agent
+                            when Symbol
+                              Support::Network::HTTP::UserAgents[user_agent]
+                            else
+                              user_agent
+                            end
         end
 
         yield self if block_given?

data/lib/ronin/web/root.rb

@@ -0,0 +1,27 @@
+#
+# ronin-web - A collection of useful web helper methods and commands.
+#
+# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-web 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-web 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-web.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  module Web
+    # Path to `ronin-web` root directory.
+    #
+    # @api private
+    ROOT = File.expand_path(File.join(__dir__,'..','..','..'))
+  end
+end

data/lib/ronin/web/version.rb

@@ -1,28 +1,25 @@
 #
-# Ronin Web - A Ruby library for Ronin that provides support for web
-# scraping and spidering functionality.
+# ronin-web - A collection of useful web helper methods and commands.
 #
-# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2023 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
+# ronin-web 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,
+# ronin-web 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/>.
+# along with ronin-web.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 module Ronin
   module Web
-    # Ronin Web Version
-    VERSION = '0.3.0.rc1'
+    # ronin-web Version
+    VERSION = '1.0.0.beta2'
   end
 end

data/lib/ronin/web/xml.rb

@@ -0,0 +1,85 @@
+#
+# ronin-web - A collection of useful web helper methods and commands.
+#
+# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-web 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-web 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-web.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'nokogiri'
+
+module Ronin
+  module Web
+    #
+    # XML helper methods.
+    #
+    # @since 1.0.0
+    #
+    module XML
+      #
+      # Parses the body of a document into a HTML document object.
+      #
+      # @param [String, IO] xml
+      #   The XML to parse.
+      #
+      # @yield [doc]
+      #   If a block is given, it will be passed the newly created document
+      #   object.
+      #
+      # @yieldparam [Nokogiri::XML::Document] doc
+      #   The new XML document object.
+      #
+      # @return [Nokogiri::XML::Document]
+      #   The new HTML document object.
+      #
+      # @see http://rubydoc.info/gems/nokogiri/Nokogiri/XML/Document
+      #
+      # @api public
+      #
+      def self.parse(xml)
+        doc = Nokogiri::XML.parse(xml)
+        yield doc if block_given?
+        return doc
+      end
+
+      #
+      # Creates a new `Nokogiri::XML::Builder`.
+      #
+      # @yield []
+      #   The block that will be used to construct the XML document.
+      #
+      # @return [Nokogiri::XML::Builder]
+      #   The new XML builder object.
+      #
+      # @example
+      #   HTML.build do
+      #     html {
+      #       body {
+      #         div(style: 'display:none;') {
+      #           object(classid: 'blabla')
+      #         }
+      #       }
+      #     }
+      #   end
+      #
+      # @see http://rubydoc.info/gems/nokogiri/Nokogiri/XML/Builder
+      #
+      # @api public
+      #
+      def self.build(&block)
+        Nokogiri::XML::Builder.new(&block)
+      end
+    end
+  end
+end