pwn 0.5.708 → 0.5.709

data/lib/pwn/plugins/hacker_one.rb

@@ -658,49 +658,173 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          h1_obj = #{self}.login(
-            username: 'optional - default PWN::Env[:plugins][:hackerone][:username]',
-            api_key: 'optional - default PWN::Env[:plugins][:hackerone][:api_key]'
+          # Run login and return its result
+          #{self}.login(
+            username: 'optional - username (default PWN::Env[:plugins][:hackerone][:username])',
+            api_key: 'optional - api token (default PWN::Env; will prompt if still nil)',
+            token: 'optional - alias for api_key'
           )
 
-          reports = #{self}.get_me_reports(h1_obj: h1_obj)
-          report  = #{self}.get_report(id: 12345)
-          report  = #{self}.create_report(
-            team_handle: 'security',
-            title: 'Example',
-            vulnerability_information: 'Details...'
+          # Run api and return its result
+          #{self}.api(
+            path: 'required - path relative to /v1/hackers (e.g. me/reports)',
+            method: 'optional - :get|:post|:put|:patch|:delete (default :get)',
+            params: 'optional - query params Hash',
+            body: 'optional - request body Hash/Array/String (defaults to opts[:http_body])',
+            username: 'optional - username value consumed by #api',
+            api_key: 'optional - api key value consumed by #api',
+            h1_obj: 'optional - session from #login (supplies username/api_key)',
+            raw: 'optional - return raw response (default false)',
+            http_method: 'optional - http method value consumed by #api (defaults to :get)',
+            http_body: 'optional - http body value consumed by #api'
           )
 
-          balance  = #{self}.get_balance
-          earnings = #{self}.get_earnings
-          payouts  = #{self}.get_payouts
-
-          programs = #{self}.get_programs
-          program  = #{self}.get_program(handle: 'security')
-          scopes   = #{self}.get_structured_scopes(handle: 'security')
-          excl     = #{self}.get_scope_exclusions(handle: 'security')
-          weak     = #{self}.get_weaknesses(handle: 'security')
-
-          items = #{self}.get_hacktivity
-
-          intents = #{self}.get_report_intents
-          intent  = #{self}.get_report_intent(id: 1)
-          intent  = #{self}.create_report_intent(body: { data: { type: 'report-intent', attributes: {} } })
-          intent  = #{self}.update_report_intent(id: 1, body: { data: { type: 'report-intent', attributes: {} } })
-          #{self}.submit_report_intent(id: 1)
-          #{self}.delete_report_intent(id: 1)
-          atts = #{self}.get_report_intent_attachments(report_intent_id: 1)
-          #{self}.delete_report_intent_attachment(report_intent_id: 1, id: 2)
-
-          json = #{self}.api(
-            path: 'me/reports',
-            method: :get,
-            params: { page: { number: 1 } }
+          # ---- Reports -------------------------------------------------------
+          #{self}.get_me_reports(
+            params: 'optional - query params Hash (e.g. page/filter)',
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
           )
 
-          #{self}.logout(h1_obj: h1_obj)
+          # Run get report and return its result
+          #{self}.get_report(
+            id: 'required - report id',
+            username: 'optional - optional, api_key: optional, h1_obj: optional',
+            params: 'optional - params value consumed by #get_report'
+          )
+
+          # Run create report and return its result
+          #{self}.create_report(
+            team_handle: 'required - program handle',
+            title: 'required - report title',
+            vulnerability_information: 'required - detailed description',
+            impact: 'optional - impact text',
+            severity_rating: 'optional - none|low|medium|high|critical',
+            weakness_id: 'optional - weakness id integer',
+            structured_scope_id: 'optional - structured scope id value consumed by #create_report',
+            body: 'optional - full JSON:API body Hash (overrides attribute kwargs)',
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
+          )
+
+          # ---- Payments ------------------------------------------------------
+          #{self}.get_balance(
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
+          )
+
+          # Run get earnings and return its result
+          #{self}.get_earnings(
+            params: 'optional - query params Hash',
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
+          )
+
+          # Run get payouts and return its result
+          #{self}.get_payouts(
+            params: 'optional - query params Hash',
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
+          )
+
+          # ---- Programs -------------------------------------------------------
+          #{self}.get_programs(
+            params: 'optional - query params Hash',
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
+          )
+
+          # Run get program and return its result
+          #{self}.get_program(
+            handle: 'required - program handle',
+            username: 'optional - optional, api_key: optional, h1_obj: optional',
+            params: 'optional - params value consumed by #get_program'
+          )
+
+          # Run get structured scopes and return its result
+          #{self}.get_structured_scopes(
+            handle: 'required - program handle',
+            params: 'optional - params value consumed by #get_structured_scopes',
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
+          )
+
+          # Run get scope exclusions and return its result
+          #{self}.get_scope_exclusions(
+            handle: 'required - program handle',
+            params: 'optional - params value consumed by #get_scope_exclusions',
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
+          )
+
+          # Run get weaknesses and return its result
+          #{self}.get_weaknesses(
+            handle: 'required - program handle',
+            params: 'optional - params value consumed by #get_weaknesses',
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
+          )
+
+          # ---- Hacktivity -----------------------------------------------------
+          #{self}.get_hacktivity(
+            params: 'optional - query params Hash',
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
+          )
+
+          # ---- Report Intents ------------------------------------------------
+          #{self}.get_report_intents(
+            params: 'optional - params value consumed by #get_report_intents',
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
+          )
+
+          # Run get report intent and return its result
+          #{self}.get_report_intent(
+            id: 'required - report intent id',
+            username: 'optional - optional, api_key: optional, h1_obj: optional',
+            params: 'optional - params value consumed by #get_report_intent'
+          )
+
+          # Run create report intent and return its result
+          #{self}.create_report_intent(
+            body: 'required - full JSON:API body Hash',
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
+          )
+
+          # Run update report intent and return its result
+          #{self}.update_report_intent(
+            id: 'required - report intent id',
+            body: 'required - full JSON:API body Hash',
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
+          )
+
+          # Run delete report intent and return its result
+          #{self}.delete_report_intent(
+            id: 'required - report intent id',
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
+          )
+
+          # Run submit report intent and return its result
+          #{self}.submit_report_intent(
+            id: 'required - report intent id',
+            body: 'optional - JSON:API body Hash',
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
+          )
+
+          # Run get report intent attachments and return its result
+          #{self}.get_report_intent_attachments(
+            report_intent_id: 'required - report intent id value consumed by #get_report_intent_attachments (defaults to opts[:id])',
+            username: 'optional - optional, api_key: optional, h1_obj: optional',
+            id: 'required - id value consumed by #get_report_intent_attachments',
+            params: 'optional - params value consumed by #get_report_intent_attachments'
+          )
+
+          # Run delete report intent attachment and return its result
+          #{self}.delete_report_intent_attachment(
+            report_intent_id: 'required - report intent id value consumed by #delete_report_intent_attachment',
+            id: 'required - attachment id',
+            username: 'optional - optional, api_key: optional, h1_obj: optional'
+          )
+
+          # Clears the session hash in-place (no server-side session to destroy)
+          #{self}.logout(
+            h1_obj: 'required - required h1_obj returned from #login method'
+          )
+
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/hunter.rb

@@ -142,18 +142,21 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          search_results = #{self}.query(
-            api_key: 'required hunter api key',
+          # Run a search using the open session.
+          #{self}.search(
+            api_key: 'required - required hunter api key',
             query: 'required - hunter search query',
             start_time: 'required - start date for the search (format is yyyy-mm-dd)',
             end_time: 'required - end date for the search (format is yyyy-mm-dd)',
             start_page: 'optional - starting page number for pagination (default is 1)',
             page_size: 'optional - number of results per page (default is 10)',
-            fields: 'optional - comma-separated list of fields 'product,transport_protocol,protocol,banner,country,province,city,asn,org,web,updated_at' (default is nil)'
+            fields: 'optional - comma-separated list of fields product,transport_protocol,protocol,banner,country,province,city,asn,org,web,updated_at (default is nil)'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/ip_info.rb

@@ -235,29 +235,34 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          is_rfc1918 = #{self}.check_rfc1918(
+          # Run check rfc1918 and return its result
+          #{self}.check_rfc1918(
             ip: 'required - IP to check'
           )
 
-          ip_info_struc = #{self}.get(
+          # Run get and return its result
+          #{self}.get(
             target: 'required - IP or Host to lookup',
             proxy: 'optional - use a proxy',
-            tls_port: 'optional port to check cert for Domain Name (default: 443). Will not execute if proxy parameter is set.',
+            tls_port: 'optional - optional port to check cert for Domain Name (default: 443). Will not execute if proxy parameter is set.',
             skip_api: 'optional - skip the API call',
             dns_server: 'optional - DNS server to use for lookup (default: your default DNS server)'
           )
 
+          # Run bruteforce subdomains and return its result
           #{self}.bruteforce_subdomains(
             parent_domain: 'required - Parent Domain to brute force',
             dictionary: 'required - Dictionary to use for subdomain brute force',
             max_threads: 'optional - Maximum number of threads to use (default: 9)',
             proxy: 'optional - use a proxy',
-            tls_port: 'optional port to check cert for Domain Name (default: 443). Will not execute if proxy parameter is set.',
+            tls_port: 'optional - optional port to check cert for Domain Name (default: 443). Will not execute if proxy parameter is set.',
             results_file: 'optional - File to write results to (default: /tmp/parent_domain-timestamp-pwn_bruteforce_subdomains.txt)'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/irc.rb

@@ -249,63 +249,76 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          irc_obj = #{self}.connect(
-            host: 'required - host or ip',
-            port: 'required - host port',
-            nick: 'required - nickname',
+          # Run connect and return its result
+          #{self}.connect(
+            host: 'required - host or ip (defaults to 127.0.0.1)',
+            port: 'required - host port (defaults to 6667)',
+            nick: 'required - nick value consumed by #connect',
             real: 'optional - real name (defaults to value of nick)',
             tls: 'optional - boolean connect to host socket using TLS (defaults to false)'
           )
 
-          #{self}.ping(
+          # Run join and return its result
+          #{self}.join(
             irc_obj: 'required - irc_obj returned from #connect method',
-            message: 'required - message to send'
+            nick: 'required - nick value consumed by #join',
+            chan: 'required - channel to join'
           )
 
-          #{self}.pong(
+          # Run names and return its result
+          #{self}.names(
             irc_obj: 'required - irc_obj returned from #connect method',
-            message: 'required - message to send'
+            chan: 'required - channel to list names'
           )
 
+          # Run privmsg and return its result
           #{self}.privmsg(
             irc_obj: 'required - irc_obj returned from #connect method',
             chan: 'required - channel to send message',
-            message: 'required - message to send'
+            message: 'required - message to send',
+            nick: 'optional - nick value consumed by #privmsg'
           )
 
-          #{self}.join(
+          # Run ping and return its result
+          #{self}.ping(
             irc_obj: 'required - irc_obj returned from #connect method',
-            nick: 'required - nickname',
-            chan: 'required - channel to join'
+            message: 'required - message to send'
           )
 
-          #{self}.names(
+          # Run pong and return its result
+          #{self}.pong(
             irc_obj: 'required - irc_obj returned from #connect method',
-            chan: 'required - channel to list names'
+            message: 'required - message to send'
           )
 
+          # Run part and return its result
           #{self}.part(
             irc_obj: 'required - irc_obj returned from #connect method',
             chan: 'required - channel to part',
             message: 'optional - message to send when parting'
           )
 
+          # Run quit and return its result
           #{self}.quit(
             irc_obj: 'required - irc_obj returned from #connect method',
             message: 'optional - message to send when quitting'
           )
 
+          # Run listen and return its result
           #{self}.listen(
             irc_obj: 'required - irc_obj returned from #connect method',
             verbose: 'optional - boolean to enable verbose output (defaults to false)'
           )
 
-          irc_obj = #{self}.disconnect(
+          # Run disconnect and return its result
+          #{self}.disconnect(
             irc_obj: 'required - irc_obj returned from #connect method'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/jenkins.rb

@@ -442,95 +442,103 @@ module PWN
       # Display Usage for this Module
 
       public_class_method def self.help
-        puts %{USAGE:
-          jenkins_obj = #{self}.connect(
-            ip: 'required host/ip of Jenkins Server',
-            port: 'optional tcp port (defaults to 8080),
-            username: 'optional username (functionality will be limited if ommitted)',
-            api_key: 'optional api_key (functionality will be limited if ommitted)',
-            identity_file: 'optional ssh private key path to AuthN w/ Jenkins PREFERRED over username/api_key',
-            ssl: 'optional connect over TLS (defaults to true),
-            proxy: 'optional debug proxy rest api requests to jenkins (e.g. "http://127.0.0.1:8080")''
+        puts "USAGE:
+          # Run connect and return its result
+          #{self}.connect(
+            ip: 'required - required host/ip of Jenkins Server',
+            port: 'optional - optional tcp port (defaults to 8080',
+            username: 'optional - optional username (functionality will be limited if ommitted)',
+            api_key: 'optional - optional api_key (functionality will be limited if ommitted)',
+            identity_file: 'optional - optional ssh private key path to AuthN w/ Jenkins PREFERRED over username/api_key',
+            ssl: 'optional - optional connect over TLS (defaults to true',
+            proxy: 'optional - optional debug proxy rest api requests to jenkins (e.g. http://127.0.0.1:8080)'
           )
-          puts jenkins_obj.public_methods
 
+          # Run create user and return its result
           #{self}.create_user(
-            jenkins_obj: 'required - jenkins_obj returned from #connect method',
-            username: 'required - user to create',
-            password: 'optional - password for new user (will prompt if nil)'
-            fullname: 'required - full name of new user'
-            email: 'required - email address of new user'
+            jenkins_obj: 'optional - jenkins obj value consumed by #create_user',
+            username: 'optional - username value consumed by #create_user',
+            password: 'optional - password value consumed by #create_user',
+            fullname: 'optional - fullname value consumed by #create_user',
+            email: 'optional - email value consumed by #create_user'
           )
 
+          # Run create ssh credential and return its result
           #{self}.create_ssh_credential(
-            jenkins_obj: 'required - jenkins_obj returned from #connect method',
-            username: 'required - username for new credential'
-            private_key_path: 'required - path of private ssh key for new credential'
-            key_passphrase: 'optional - private key passphrase for new credential'
-            credential_id: 'optional but recommended - useful when creating userland jobs',
-            description: 'optional - description of new credential'
-            domain: 'optional - defaults to GLOBAL',
-            scope: 'optional - GLOBAL or SYSTEM (defaults to GLOBAL)'
+            jenkins_obj: 'optional - jenkins obj value consumed by #create_ssh_credential',
+            username: 'optional - username value consumed by #create_ssh_credential',
+            private_key_path: 'optional - private key path value consumed by #create_ssh_credential',
+            key_passphrase: 'optional - key passphrase value consumed by #create_ssh_credential',
+            credential_id: 'optional - credential id value consumed by #create_ssh_credential',
+            description: 'optional - description value consumed by #create_ssh_credential',
+            domain: 'optional - FQDN to query (e.g. example.com)',
+            scope: 'optional - scope value consumed by #create_ssh_credential'
           )
 
-          git_repo_arr = #{self}.get_all_job_git_repos(
-            jenkins_obj: 'required jenkins_obj returned from connect method'
+          # Run get all job git repos and return its result
+          #{self}.get_all_job_git_repos(
+            jenkins_obj: 'required - required jenkins_obj returned from #connect method'
           )
 
-          git_repo_branches = #{self}.get_all_git_repo_branches_by_commit_date(
-            jenkins_obj: 'required jenkins_obj returned from #connect method',
-            job_name: 'required jenkins job name',
-            git_url: 'required git url for git_repo'
+          # Run list nested jobs and return its result
+          #{self}.list_nested_jobs(
+            jenkins_obj: 'required - required jenkins_obj returned from #connect method',
+            view_path: 'required - required view path to list jobs'
           )
 
-          nested_jobs_arr = #{self}.list_nested_jobs(
-            jenkins_obj: 'required jenkins_obj returned from #connect method',
-            view_path: 'required view path list jobs'
+          # Run list nested views and return its result
+          #{self}.list_nested_views(
+            jenkins_obj: 'required - required jenkins_obj returned from #connect method',
+            view_path: 'required - required view path list sub-views'
           )
 
-          nested_views_arr = #{self}.list_nested_views(
-            jenkins_obj: 'required jenkins_obj returned from #connect method',
-            view_path: 'required view path list sub-views'
+          # Run create nested view and return its result
+          #{self}.create_nested_view(
+            jenkins_obj: 'optional - jenkins obj value consumed by #create_nested_view',
+            view_name: 'optional - view name value consumed by #create_nested_view',
+            create_in_view_path: 'optional - create in view path value consumed by #create_nested_view'
           )
 
-          view_created_bool = #{self}.create_nested_view(
-            jenkins_obj: 'required jenkins_obj returned from #connect method',
-            view_path: 'required view path create',
-            create_in_view_path: 'optional creates nested view within an existing nested view, defaults to / views'
+          # Run add job to nested view and return its result
+          #{self}.add_job_to_nested_view(
+            jenkins_obj: 'required - required jenkins_obj returned from #connect method',
+            view_path: 'required - required view path associate job',
+            job_name: 'required - required view path attach to a view'
           )
 
-          add_job_to_nested_view_resp = #{self}.add_job_to_nested_view(
-            jenkins_obj: 'required jenkins_obj returned from #connect method',
-            view_path: 'required view path associate job',
-            job_name: 'required view path attach to a view',
-          )
-
-          copy_job_resp = #{self}.copy_job_no_fail_on_exist(
-            jenkins_obj: 'required jenkins_obj returned from #connect method',
-            existing_job_name: 'required existing job to copt to new job',
-            new_job_name: 'required name of new job'
+          # Run copy job no fail on exist and return its result
+          #{self}.copy_job_no_fail_on_exist(
+            jenkins_obj: 'required - required jenkins_obj returned from #connect method',
+            existing_job_name: 'required - required existing job to copt to new job',
+            new_job_name: 'required - required name of new job'
           )
 
+          # Run disable jobs by regex and return its result
           #{self}.disable_jobs_by_regex(
-            jenkins_obj: 'required jenkins_obj returned from #connect method',
-            regex: 'required regex pattern for matching jobs to disable e.g. :regex => "^M[0-9]"',
+            jenkins_obj: 'required - required jenkins_obj returned from #connect method',
+            regex: 'required - required regex pattern for matching jobs to disable e.g. :regex => ^M[0-9]'
           )
 
-          #{self}.delete_job_by_regex(
-            jenkins_obj: 'required jenkins_obj returned from #connect method',
-            regex: 'required regex pattern for matching jobs to disable e.g. :regex => "^M[0-9]"',
+          # Run delete jobs by regex and return its result
+          #{self}.delete_jobs_by_regex(
+            jenkins_obj: 'required - required jenkins_obj returned from #connect method',
+            regex: 'required - required regex pattern for matching jobs to disable e.g. :regex => ^M[0-9]'
           )
 
+          # Run clear build queue and return its result
           #{self}.clear_build_queue(
-            jenkins_obj: 'required jenkins_obj returned from #connect method',
+            jenkins_obj: 'required - required jenkins_obj returned from #connect method'
           )
 
+          # Run disconnect and return its result
           #{self}.disconnect(
-            jenkins_obj: 'required jenkins_obj returned from connect method'
+            jenkins_obj: 'required - required jenkins_obj returned from #connect method'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
-        }
+        "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/jira_data_center.rb

@@ -607,67 +607,75 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          all_fields = #{self}.get_all_fields
+          # Run get all fields and return its result
+          #{self}.get_all_fields
 
-          user = #{self}.get_user(
-            username: 'required - username to lookup (e.g. jane.doe')',
+          # Run get user and return its result
+          #{self}.get_user(
+            username: 'required - username to lookup (e.g. jane.doe) (defaults to PWN::Plugins::AuthenticationHelper.username)',
             params: 'optional - additional parameters to pass in the URI (e.g. expand, etc.)'
           )
 
-          issue_resp = #{self}.get_issue(
+          # Run get issue and return its result
+          #{self}.get_issue(
             issue: 'required - issue to lookup (e.g. Bug, Issue, Story, or Epic ID)',
             params: 'optional - additional parameters to pass in the URI (e.g. fields, expand, etc.)'
           )
 
-          issue_resp = #{self}.create_issue(
+          # Run create issue and return its result
+          #{self}.create_issue(
             project_key: 'required - project key (e.g. PWN)',
             summary: 'required - summary of the issue (e.g. Epic for PWN-1337)',
             issue_type: 'required - issue type (e.g. :epic, :story, :bug)',
             description: 'optional - description of the issue',
             epic_name: 'optional - name of the epic',
             additional_fields: 'optional - additional fields to set in the issue (e.g. labels, components, custom fields, etc.)',
-            attachments: 'optional - array of attachment paths to upload to the issue (e.g. [\"/tmp/file1.txt\", \"/tmp/file2.txt\"])',
-            comment: 'optional - comment to add to the issue (e.g. \"This is a comment\")'
+            attachments: 'optional - array of attachment paths to upload to the issue (e.g. [/tmp/file1.txt, /tmp/file2.txt])',
+            comment: 'optional - comment to add to the issue (e.g. This is a comment)'
           )
 
-          issue_resp = #{self}.update_issue(
-            issue: 'required - issue to update (e.g. Bug, Issue, Story, or Epic ID)',
+          # Run update issue and return its result
+          #{self}.update_issue(
             fields: 'required - fields to update in the issue (e.g. summary, description, labels, components, custom fields, etc.)',
-            attachments: 'optional - array of attachment paths to upload to the issue (e.g. [\"/tmp/file1.txt\", \"/tmp/file2.txt\"])'
+            attachments: 'optional - array of attachment paths to upload to the issue (e.g. [/tmp/file1.txt, /tmp/file2.txt])',
+            issue: 'required - issue value consumed by #update_issue'
           )
 
-          issue_resp = #{self}.issue_comment(
-            issue: 'required - issue to comment on (e.g. Bug, Issue, Story, or Epic ID)',
+          # Run issue comment and return its result
+          #{self}.issue_comment(
+            issue: 'required - issue to delete (e.g. Bug, Issue, Story, or Epic ID)',
             comment_action: 'required - action to perform on the issue comment (e.g. :delete, :add, :update - Defaults to :add)',
             comment_id: 'optional - comment ID to delete or update (e.g. 10000)',
-            author: 'optional - author of the comment (e.g. \"jane.doe\")',
-            comment: 'optional - comment to add or update in the issue (e.g. \"This is a comment\")'
+            author: 'optional - author of the comment (e.g. jane.doe)',
+            comment: 'optional - comment to add or update in the issue (e.g. This is a comment)'
           )
 
-          issue_type_metadata = #{self}.get_issue_type_metadata(
+          # Run get issue type metadata and return its result
+          #{self}.get_issue_type_metadata(
             project_key: 'required - project key (e.g. PWN)',
             issue_type_id: 'required - issue type ID (e.g. issue[:fields][:issuetype][:id] from #get_issue method)'
           )
 
-          issue_resp = #{self}.clone_issue(
+          # Run clone issue and return its result
+          #{self}.clone_issue(
             issue: 'required - issue to clone (e.g. Bug, Issue, Story, or Epic ID)',
             copy_attachments: 'optional - boolean to indicate whether to copy attachments (Defaults to false)'
           )
 
-          issue_resp = #{self}.delete_issue(
+          # Run delete issue and return its result
+          #{self}.delete_issue(
             issue: 'required - issue to delete (e.g. Bug, Issue, Story, or Epic ID)'
           )
 
-          issue_resp = #{self}.delete_attachment(
+          # Run delete attachment and return its result
+          #{self}.delete_attachment(
             id: 'required - attachment ID to delete (e.g. 10000) found in #get_issue method'
           )
 
-          **********************************************************************
-          * For more information on the Jira Server REST API, see:
-          * https://developer.atlassian.com/server/jira/platform/rest-apis/
-
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end