Decouple module authentication methods

Author: rastating

lib/wpxf/core.rb

@@ -6,6 +6,7 @@
 require 'wpxf/core/event_emitter'
 require 'wpxf/core/output_emitters'
 require 'wpxf/core/module_info'
+require 'wpxf/core/module_authentication'
 
 require 'wpxf/versioning/browser_versions'
 require 'wpxf/versioning/os_versions'

lib/wpxf/core/module.rb

@@ -9,6 +9,7 @@ class Module
     include Wpxf::WordPress::Login
     include Wpxf::WordPress::Options
     include Wpxf::WordPress::Urls
+    include Wpxf::ModuleAuthentication
 
     def initialize
       super
@@ -31,29 +32,9 @@ def initialize
         )
       ])
 
-      if requires_authentication
-        register_options([
-          StringOption.new(
-            name: 'username',
-            desc: 'The WordPress username to authenticate with',
-            required: true
-          ),
-          StringOption.new(
-            name: 'password',
-            desc: 'The WordPress password to authenticate with',
-            required: true
-          )
-        ])
-      end
-
       self.event_emitter = EventEmitter.new
     end
 
-    # @return [Boolean] true if the module requires the user to authenticate.
-    def requires_authentication
-      false
-    end
-
     # @return [Boolean] true if all the required options are set.
     def can_execute?
       all_options_valid? && (
@@ -93,11 +74,8 @@ def set_option_value(name, value)
       res = super(name, value)
 
       if payload
-        if res == :not_found
-          return payload.set_option_value(name, value)
-        else
-          payload.set_option_value(name, value)
-        end
+        return payload.set_option_value(name, value) if res == :not_found
+        payload.set_option_value(name, value)
       end
 
       res
@@ -110,23 +88,6 @@ def unset_option(name)
       payload.unset_option(name) if payload
     end
 
-    # Authenticate with WordPress and return the cookie.
-    # @param username [String] the username to authenticate with.
-    # @param password [String] the password to authenticate with.
-    # @return [CookieJar, Boolean] the cookie in a CookieJar if successful,
-    #   otherwise, returns false.
-    def authenticate_with_wordpress(username, password)
-      emit_info "Authenticating with WordPress using #{username}:#{password}..."
-      cookie = wordpress_login(username, password)
-      if cookie.nil?
-        emit_error 'Failed to authenticate with WordPress'
-        return false
-      else
-        emit_success 'Authenticated with WordPress', true
-        return cookie
-      end
-    end
-
     # Run the module.
     # @return [Boolean] true if successful.
     def run

lib/wpxf/core/module_authentication.rb

@@ -0,0 +1,45 @@
+module Wpxf
+  # Provides functionality for authenticating modules with a WordPress target.
+  module ModuleAuthentication
+    def initialize
+      super
+
+      if requires_authentication
+        register_options([
+          StringOption.new(
+            name: 'username',
+            desc: 'The WordPress username to authenticate with',
+            required: true
+          ),
+          StringOption.new(
+            name: 'password',
+            desc: 'The WordPress password to authenticate with',
+            required: true
+          )
+        ])
+      end
+    end
+
+    # @return [Boolean] true if the module requires the user to authenticate.
+    def requires_authentication
+      false
+    end
+
+    # Authenticate with WordPress and return the cookie.
+    # @param username [String] the username to authenticate with.
+    # @param password [String] the password to authenticate with.
+    # @return [CookieJar, Boolean] the cookie in a CookieJar if successful,
+    #   otherwise, returns false.
+    def authenticate_with_wordpress(username, password)
+      emit_info "Authenticating with WordPress using #{username}:#{password}..."
+      cookie = wordpress_login(username, password)
+      if cookie.nil?
+        emit_error 'Failed to authenticate with WordPress'
+        return false
+      else
+        emit_success 'Authenticated with WordPress', true
+        return cookie
+      end
+    end
+  end
+end