Include review feedback

Use '@api private' for private classes, so they are excluded from REFERENCES.md

Use 'String[1]' for username parameter. If it is specified, then it should not
be empty.

Use 'Sensitive[String[1]]' for password parameter.

Use ruby-style way of conditionally setting a variable.

Author: joshcooper

Diff for: REFERENCE.md

@@ -6,6 +6,8 @@
 
 ### Classes
 
+#### Public Classes
+
 * [`puppet_agent`](#puppet_agent): Upgrades Puppet 4 and newer to the requested version.
 * [`puppet_agent::configure`](#puppet_agent--configure): Uses $puppet_agent::config to manage settings in puppet.conf.
 * [`puppet_agent::install`](#puppet_agent--install): This class is called from puppet_agent for install.
@@ -22,10 +24,13 @@
 * [`puppet_agent::osfamily::windows`](#puppet_agent--osfamily--windows): Determines the puppet-agent package location for Windows OSes.
 * [`puppet_agent::params`](#puppet_agent--params): Sets variables according to platform.
 * [`puppet_agent::prepare`](#puppet_agent--prepare): This class is called from puppet_agent to prepare for the upgrade.
-* [`puppet_agent::prepare::package`](#puppet_agent--prepare--package): Ensures correct puppet-agent package is downloaded locally.
 * [`puppet_agent::prepare::puppet_config`](#puppet_agent--prepare--puppet_config): Private class called from puppet_agent::prepare class.
 * [`puppet_agent::service`](#puppet_agent--service): Ensures that managed services are running.
 
+#### Private Classes
+
+* `puppet_agent::prepare::package`: Ensures correct puppet-agent package is downloaded locally.
+
 ### Resource types
 
 * [`puppet_agent_end_run`](#puppet_agent_end_run): Stops the current Puppet run if a puppet-agent upgrade was performed. Used on platforms that manage the Puppet Agent upgrade with a package r
@@ -614,35 +619,6 @@ The puppet-agent version to install.
 
 Default value: `undef`
 
-### <a name="puppet_agent--prepare--package"></a>`puppet_agent::prepare::package`
-
-for installation. This is used on platforms without package managers capable of
-working with a remote https repository.
-
-#### Parameters
-
-The following parameters are available in the `puppet_agent::prepare::package` class:
-
-* [`source`](#-puppet_agent--prepare--package--source)
-* [`package_file_name`](#-puppet_agent--prepare--package--package_file_name)
-
-##### <a name="-puppet_agent--prepare--package--source"></a>`source`
-
-Data type: `Variant[String, Array]`
-
-The source file for the puppet-agent package. Can use any of the data types
-and protocols that the File resource's source attribute can.
-
-##### <a name="-puppet_agent--prepare--package--package_file_name"></a>`package_file_name`
-
-Data type: `Optional[String]`
-
-The destination file name for the puppet-agent package. If no destination
-is given, then the basename component of the source will be used as the
-destination filename.
-
-Default value: `undef`
-
 ### <a name="puppet_agent--prepare--puppet_config"></a>`puppet_agent::prepare::puppet_config`
 
 Private class called from puppet_agent::prepare class.
@@ -1006,13 +982,13 @@ The number of retries in case of network connectivity failures
 
 ##### `username`
 
-Data type: `Optional[String]`
+Data type: `Optional[String[1]]`
 
 The username to use when downloading from a source location requiring authentication
 
 ##### `password`
 
-Data type: `Optional[String]`
+Data type: `Optional[Sensitive[String[1]]]`
 
 The password to use when downloading from a source location requiring authentication
 
@@ -1086,13 +1062,13 @@ The number of retries in case of network connectivity failures
 
 ##### `username`
 
-Data type: `Optional[String]`
+Data type: `Optional[String[1]]`
 
 The username to use when downloading from a source location requiring authentication
 
 ##### `password`
 
-Data type: `Optional[String]`
+Data type: `Optional[String[1]]`
 
 The password to use when downloading from a source location requiring authentication
 

Diff for: manifests/prepare/package.pp

@@ -2,32 +2,26 @@
 # for installation. This is used on platforms without package managers capable of
 # working with a remote https repository.
 #
-# @param source
-#   The source file for the puppet-agent package. Can use any of the data types
-#   and protocols that the File resource's source attribute can.
-# @param destination_name
-#   The destination file name for the puppet-agent package. If no destination
-#   is given, then the basename component of the source will be used as the
-#   destination name.
+# @api private
 class puppet_agent::prepare::package (
   Variant[String, Array] $source,
-  Optional[String] $destination_name = undef
+  Optional[String[1]] $destination_name = undef
 ) {
   assert_private()
 
   file { $puppet_agent::params::local_packages_dir:
     ensure => directory,
   }
 
-  if $destination_name {
-    $package_file_name = $destination_name
+  $package_file_name = if $destination_name {
+    $destination_name
   } else {
     # In order for the 'basename' function to work correctly we need to change
     # any \s to /s (even for windows UNC paths) so that it will correctly pull off
     # the filename. Since this operation is only grabbing the base filename and not
     # any part of the path this should be safe, since the source will simply remain
     # what it was before and we can still pull off the filename.
-    $package_file_name = basename(regsubst($source, "\\\\", '/', 'G'))
+    basename(regsubst($source, "\\\\", '/', 'G'))
   }
 
   if $facts['os']['family'] =~ /windows/ {

Diff for: tasks/install_powershell.json

@@ -45,11 +45,11 @@
     },
     "username": {
       "description": "The username to use when downloading from a source location requiring authentication",
-      "type": "Optional[String]"
+      "type": "Optional[String[1]]"
     },
     "password": {
       "description": "The password to use when downloading from a source location requiring authentication",
-      "type": "Optional[String]"
+      "type": "Optional[Sensitive[String[1]]]"
     }
   },
   "supports_noop": true

Diff for: tasks/install_shell.json

@@ -46,11 +46,11 @@
     },
     "username": {
       "description": "The username to use when downloading from a source location requiring authentication",
-      "type": "Optional[String]"
+      "type": "Optional[String[1]]"
     },
     "password": {
       "description": "The password to use when downloading from a source location requiring authentication",
-      "type": "Optional[String]"
+      "type": "Optional[Sensitive[String[1]]]"
     }
   },
   "files": ["facts/tasks/bash.sh"],