enfcli 4.0.0 → 4.1.0.pre.alpha

data/lib/enfcli/commands/captive.rb

@@ -15,21 +15,22 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require 'enfthor'
-require 'enfapi'
-require 'json'
-require 'erb'
+require "enfthor"
+require "enfapi"
+require "json"
+require "erb"
 
 module EnfCli
   module Cmd
     class Captive < EnfThor
-      desc 'list-wifi-configurations',
-           'List wifi configuration information for all or the matching records.'
-      method_option :name, default: nil, type: :string, banner: 'NAME',
-                           desc: 'where NAME will match the user-given name.'
-      method_option :domain, default: nil, type: :string, banner: 'DOMAIN',
-                             aliases: '-d'
-      method_option :ssid, default: nil, type: :string, banner: 'SSID'
+      desc "list-wifi-configurations",
+           "List wifi configuration information for all or the matching records."
+      method_option :name, default: nil, type: :string, banner: "NAME",
+                           desc: "where NAME will match the user-given name."
+      method_option :domain, default: nil, type: :string, banner: "DOMAIN",
+                             aliases: "-d"
+      method_option :ssid, default: nil, type: :string, banner: "SSID"
+
       def list_wifi_configurations
         try_with_rescue_in_session do
           ## TODO: V1 is only listing all of the wifi configurations, it is not
@@ -40,15 +41,16 @@ module EnfCli
             # display the data
             display_wifi_configs wifi_configs
           else
-            say 'No WiFi configurations found.'
+            say "No WiFi configurations found."
           end
         end
       end
 
-      desc 'create-wifi-configuration', 'Create a new wifi configuration.'
+      desc "create-wifi-configuration", "Create a new wifi configuration."
       method_option :'wifi-config-file', type: :string, required: true,
-                                         banner: '<file>',
-                                         desc: '<file> is JSON file with parameters required for configuring the router card.'
+                                         banner: "<file>",
+                                         desc: "<file> is JSON file with parameters required for configuring the router card."
+
       def create_wifi_configuration
         try_with_rescue_in_session do
           json_file_name = options[:'wifi-config-file']
@@ -65,20 +67,21 @@ module EnfCli
         end
       end
 
-      desc 'get-wifi-configuration',
-           'Get details of the specified wifi configuration. Exactly one of: ' \
-           '--wifi-id, --profile-id, --device-id, or --wifi-name must be ' \
-           'specified.'
-      method_option :'wifi-id', defaut: nil, type: :string, banner: 'WIFI-ID',
-                                desc: 'WIFI-ID is the UUID of the wifi record'
-      method_option :version, defaut: nil, type: :string, banner: 'VERSION',
-                              desc: 'Optionally used with --wifi-id'
-      method_option :'profile-id', defaut: nil, type: :string, banner: 'PROFILE-ID',
-                                   desc: 'PROFILE-ID is the UUID of the profile.'
-      method_option :'device-id', defaut: nil, type: :string, banner: 'DEVICE-ID',
-                                  desc: 'DEVICE-ID is the UUID of the device.'
-      method_option :'wifi-name', defaut: nil, type: :string, banner: 'WIFI-NAME',
-                                  desc: 'Result matches any wifi configuration that contains the substring WIFI-NAME'
+      desc "get-wifi-configuration",
+           "Get details of the specified wifi configuration. Exactly one of: " \
+           "--wifi-id, --profile-id, --device-id, or --wifi-name must be " \
+           "specified."
+      method_option :'wifi-id', defaut: nil, type: :string, banner: "WIFI-ID",
+                                desc: "WIFI-ID is the UUID of the wifi record"
+      method_option :version, defaut: nil, type: :string, banner: "VERSION",
+                              desc: "Optionally used with --wifi-id"
+      method_option :'profile-id', defaut: nil, type: :string, banner: "PROFILE-ID",
+                                   desc: "PROFILE-ID is the UUID of the profile."
+      method_option :'device-id', defaut: nil, type: :string, banner: "DEVICE-ID",
+                                  desc: "DEVICE-ID is the UUID of the device."
+      method_option :'wifi-name', defaut: nil, type: :string, banner: "WIFI-NAME",
+                                  desc: "Result matches any wifi configuration that contains the substring WIFI-NAME"
+
       def get_wifi_configuration
         try_with_rescue_in_session do
           ## TODO - Currently, this only handles wifi-id, add the others to v2
@@ -95,31 +98,30 @@ module EnfCli
           num_query_opts += 1 if device_id
           num_query_opts += 1 if wifi_name
 
-          
-          raise 'ERROR: Exactly one of: --wifi-id, --profile-id, --device-id, or --wifi-name must be specified.' if num_query_opts != 1
+          raise "ERROR: Exactly one of: --wifi-id, --profile-id, --device-id, or --wifi-name must be specified." if num_query_opts != 1
 
           if wifi_id
             wifi_config = EnfApi::Captive.instance.get_wifi_configuration wifi_id, version
 
             # display the data
             display_wifi_detail wifi_config
-
           end
         end
       end
 
-      desc 'update-wifi-configuration',
-           'Update an existing wifi configuration.'
+      desc "update-wifi-configuration",
+           "Update an existing wifi configuration."
       method_option :'wifi-id', type: :string,
                                 required: true,
-                                banner: 'WIFI-ID',
-                                desc: 'WIFI-ID is the UUID of the wifi profile'
+                                banner: "WIFI-ID",
+                                desc: "WIFI-ID is the UUID of the wifi profile"
       method_option :'wifi-config-file', type: :string,
                                          required: true,
-                                         banner: '<file>',
-                                         desc: '<file> is JSON file with ' \
-                                            'parameters required for ' \
-                                            'configuring the router card.'
+                                         banner: "<file>",
+                                         desc: "<file> is JSON file with " \
+                                         "parameters required for " \
+                                         "configuring the router card."
+
       def update_wifi_configuration
         try_with_rescue_in_session do
           json_file_name = options[:'wifi-config-file']
@@ -133,29 +135,29 @@ module EnfCli
         end
       end
 
+      desc "create-device",
+           "Add a new device to the database. This is only available to Xaptum administrators"
+      method_option :'device-id', type: :string, required: true, banner: "SERIAL-NUM",
+                                  desc: "SERIAL-NUM is the serial number of the device."
+      method_option :'device-name', type: :string, default: nil, banner: "DEVICE-NAME",
+                                    desc: "User-defined name for the device."
+      method_option :'mac-addr1', type: :string, default: nil, banner: "MAC-ADDR1",
+                                  desc: "MAC address 1 (wifi address on a wifi-enabled device)"
+      method_option :'mac-addr2', type: :string, default: nil, banner: "MAC-ADDR2",
+                                  desc: "MAC address 2"
+      method_option :'mac-addr3', type: :string, default: nil, banner: "MAC-ADDR3",
+                                  desc: "MAC address 3"
+      method_option :'mac-addr4', type: :string, default: nil, banner: "MAC-ADDR4",
+                                  desc: "MAC address 4"
+      method_option :'profile-id', type: :string, default: nil, banner: "PROFILE_ID",
+                                   desc: "UUID of the profile that the device will use. The profile must already exist."
+      method_option :model, type: :string, default: nil, banner: "MODEL",
+                            desc: "Model identifier of the device"
 
-      desc 'create-device',
-           'Add a new device to the database. This is only available to Xaptum administrators'
-      method_option :'device-id', type: :string, required: true, banner: 'SERIAL-NUM',
-                                  desc: 'SERIAL-NUM is the serial number of the device.'
-      method_option :'device-name', type: :string, default: nil, banner: 'DEVICE-NAME',
-                                    desc: 'User-defined name for the device.'
-      method_option :'mac-addr1', type: :string, default: nil, banner: 'MAC-ADDR1',
-                                  desc: 'MAC address 1 (wifi address on a wifi-enabled device)'
-      method_option :'mac-addr2', type: :string, default: nil, banner: 'MAC-ADDR2',
-                                  desc: 'MAC address 2'
-      method_option :'mac-addr3', type: :string, default: nil, banner: 'MAC-ADDR3',
-                                  desc: 'MAC address 3'
-      method_option :'mac-addr4', type: :string, default: nil, banner: 'MAC-ADDR4',
-                                  desc: 'MAC address 4'
-      method_option :'profile-id', type: :string, default: nil, banner: 'PROFILE_ID',
-                                   desc: 'UUID of the profile that the device will use. The profile must already exist.'
-      method_option :model, type: :string, default: nil, banner: 'MODEL',
-                            desc: 'Model identifier of the device'
       def create_device
         try_with_rescue_in_session do
           new_device_hash = {
-            serial_number: options[:'device-id']
+            serial_number: options[:'device-id'],
           }
 
           mac1 = options[:'mac-addr1']
@@ -192,10 +194,11 @@ module EnfCli
         end
       end
 
-      desc 'list-devices',
-           'List basic device information for all devices matching the option specified.'
-      method_option :network, default: nil, type: :string, banner: 'NETWORK',
-                              desc: 'NETWORK is the ipv6 subnet used by the device.'
+      desc "list-devices",
+           "List basic device information for all devices matching the option specified."
+      method_option :network, default: nil, type: :string, banner: "NETWORK",
+                              desc: "NETWORK is the ipv6 subnet used by the device."
+
       def list_devices
         try_with_rescue_in_session do
           network = options[:network]
@@ -205,11 +208,12 @@ module EnfCli
         end
       end
 
-      desc 'get-device',
-           'Get details of the specified device.'
+      desc "get-device",
+           "Get details of the specified device."
       method_option :'device-id', required: true, type: :string,
-                                  banner: 'DEVICE-ID',
-                                  desc: 'DEVICE-ID is either the device serial number or its ipv6 address.'
+                                  banner: "DEVICE-ID",
+                                  desc: "DEVICE-ID is either the device serial number or its ipv6 address."
+
       def get_device
         try_with_rescue_in_session do
           device_id = ERB::Util::url_encode(options[:'device-id'])
@@ -220,14 +224,15 @@ module EnfCli
         end
       end
 
-      desc 'update-device',
-           'Update an existing device record with the values specified.'
-      method_option :'device-id', type: :string, required: true, banner: 'DEVICE-ID',
-                                  desc: 'DEVICE-ID is either the device serial number or its ipv6 address.'
-      method_option :'device-name', type: :string, default: nil, banner: 'DEVICE-NAME',
-                                  desc: 'User-defined name for the device.'
-      method_option :'profile-id', type: :string, default: nil, banner: 'PROFILE_ID',
-                                  desc: 'UUID of the profile that the device will use. The profile must already exist.'
+      desc "update-device",
+           "Update an existing device record with the values specified."
+      method_option :'device-id', type: :string, required: true, banner: "DEVICE-ID",
+                                  desc: "DEVICE-ID is either the device serial number or its ipv6 address."
+      method_option :'device-name', type: :string, default: nil, banner: "DEVICE-NAME",
+                                    desc: "User-defined name for the device."
+      method_option :'profile-id', type: :string, default: nil, banner: "PROFILE_ID",
+                                   desc: "UUID of the profile that the device will use. The profile must already exist."
+
       def update_device
         try_with_rescue_in_session do
           id = ERB::Util::url_encode(options[:'device-id'])
@@ -248,11 +253,12 @@ module EnfCli
         end
       end
 
-      desc 'get-device-status',
-            'Get the latest status of the specified device.'
+      desc "get-device-status",
+           "Get the latest status of the specified device."
       method_option :'device-id', required: true, type: :string,
-                                  banner: 'DEVICE-ID',
-                                  desc: 'DEVICE-ID is either the device serial number or its ipv6 address.'
+                                  banner: "DEVICE-ID",
+                                  desc: "DEVICE-ID is either the device serial number or its ipv6 address."
+
       def get_device_status
         try_with_rescue_in_session do
           device_id = ERB::Util::url_encode(options[:'device-id'])
@@ -262,22 +268,23 @@ module EnfCli
         end
       end
 
-      desc 'create-profile',
-           'Create a new profile.'
+      desc "create-profile",
+           "Create a new profile."
       method_option :'profile-name', type: :string, required: true,
-                                     banner: 'PROFILE-NAME',
-                                     desc: 'PROFILE-NAME is the user-given name.'
+                                     banner: "PROFILE-NAME",
+                                     desc: "PROFILE-NAME is the user-given name."
       method_option :'device-mode', type: :string, required: true,
-                                    banner: 'DEVICE-MODE',
-                                    desc: 'secure-host or passthrough'
-      method_option :'wifi-id', type: :string, default: nil, banner: 'WIFI-ID',
-                                desc: 'WIFI-ID is the UUID of the wifi record that the profile will use. wifi record must already exist'
+                                    banner: "DEVICE-MODE",
+                                    desc: "secure-host or passthrough"
+      method_option :'wifi-id', type: :string, default: nil, banner: "WIFI-ID",
+                                desc: "WIFI-ID is the UUID of the wifi record that the profile will use. wifi record must already exist"
+
       def create_profile
         try_with_rescue_in_session do
           profile_name = options[:'profile-name']
           new_profile_hash = {
             name: profile_name,
-            config: { mode: options[:'device-mode'] }
+            config: { mode: options[:'device-mode'] },
           }
 
           wifi = options[:'wifi-id']
@@ -292,10 +299,11 @@ module EnfCli
         end
       end
 
-      desc 'list-profiles',
-           'List the existing profiles.'
-      method_option :name, default: nil, type: :string, banner: 'NAME',
-                           desc: 'where NAME will match all or part of the user-given profile name.'
+      desc "list-profiles",
+           "List the existing profiles."
+      method_option :name, default: nil, type: :string, banner: "NAME",
+                           desc: "where NAME will match all or part of the user-given profile name."
+
       def list_profiles
         try_with_rescue_in_session do
           query_name = options[:name]
@@ -304,14 +312,14 @@ module EnfCli
         end
       end
 
-      desc 'get-profile',
-           'Get full detail listing of the profile.'
-      method_option :'profile-id', required: true, type: :string, 
-                                   banner: 'PROFILE-ID',
-                                   desc: 'PROFILE-ID is the UUID of the profile.'
-# TODO - server doesn't support version yet. 
-#      method_option :version, default: nil, type: :integer, banner: 'VERSION',
-#                              desc: 'Get a specific version.'
+      desc "get-profile",
+           "Get full detail listing of the profile."
+      method_option :'profile-id', required: true, type: :string,
+                                   banner: "PROFILE-ID",
+                                   desc: "PROFILE-ID is the UUID of the profile."
+      # TODO - server doesn't support version yet.
+      #      method_option :version, default: nil, type: :integer, banner: 'VERSION',
+      #                              desc: 'Get a specific version.'
       def get_profile
         try_with_rescue_in_session do
           profile = EnfApi::Captive.instance.get_profile options[:'profile-id']
@@ -319,20 +327,21 @@ module EnfCli
         end
       end
 
-      desc 'update-profile',
-           'Update a previously-created profile specified by PROFILE-ID.  At ' \
-           'least one property must be changed.'
-      method_option :'profile-id', required: true, type: :string, 
-                                   banner: 'PROFILE-ID',
-                                   desc: 'UUID of the device profile.'
+      desc "update-profile",
+           "Update a previously-created profile specified by PROFILE-ID.  At " \
+           "least one property must be changed."
+      method_option :'profile-id', required: true, type: :string,
+                                   banner: "PROFILE-ID",
+                                   desc: "UUID of the device profile."
       method_option :'profile-name', type: :string, default: nil,
-                                     banner: 'PROFILE-NAME',
-                                     desc: 'PROFILE-NAME is the user-given name.'
+                                     banner: "PROFILE-NAME",
+                                     desc: "PROFILE-NAME is the user-given name."
       method_option :'device-mode', type: :string, default: nil,
-                                    banner: 'DEVICE-MODE',
-                                    desc: 'secure-host or passthrough'
-      method_option :'wifi-id', type: :string, default: nil, banner: 'WIFI-ID',
-                                desc: 'WIFI-ID is the UUID of the wifi record that the profile will use. wifi record must already exist'
+                                    banner: "DEVICE-MODE",
+                                    desc: "secure-host or passthrough"
+      method_option :'wifi-id', type: :string, default: nil, banner: "WIFI-ID",
+                                desc: "WIFI-ID is the UUID of the wifi record that the profile will use. wifi record must already exist"
+
       def update_profile
         try_with_rescue_in_session do
           id = options[:'profile-id']
@@ -353,11 +362,9 @@ module EnfCli
 
           profile = EnfApi::Captive.instance.update_profile id, update_hash
           display_profile profile
-
         end
       end
 
-
       #########################################################################
       #
       # Helper functions
@@ -367,7 +374,7 @@ module EnfCli
         # Displays the wifi configuration summary list.
         # TODO - Does non-Xaptum-admin columns only - add option to do admin list
         def display_wifi_configs(configs)
-          headings = ['ID', 'Wifi Name', 'Config Vers.']
+          headings = ["ID", "Wifi Name", "Config Vers."]
           rows = configs.map do |hash|
             [hash[:id], hash[:name], hash[:version]]
           end
@@ -376,7 +383,7 @@ module EnfCli
         end
 
         # Display a single wifi configuration in detail
-        def display_wifi_detail(wifi_data, full_listing=true)
+        def display_wifi_detail(wifi_data, full_listing = true)
           name = wifi_data[:name]
           wifi_id = wifi_data[:id]
           desc = wifi_data[:description]
@@ -392,9 +399,7 @@ module EnfCli
                 display_wifi_net(wifi_net, 1)
               end
             end
-  
           end
-
         end
 
         def display_wifi_net(wifi_net, tabs)
@@ -412,7 +417,7 @@ module EnfCli
           display_ipv6_addr(wifi_net[:IPv6], tabs + 1)
         end
 
-        def display_ipv4_addr (ipv4, tabs)
+        def display_ipv4_addr(ipv4, tabs)
           indent = "    " * tabs
           if ipv4.instance_of? String
             say indent + "IPv4         : #{ipv4}", nil, true
@@ -435,7 +440,7 @@ module EnfCli
           end
         end
 
-        def display_ipv6_addr (ipv6, tabs)
+        def display_ipv6_addr(ipv6, tabs)
           indent = "    " * tabs
           if ipv6.instance_of? String
             say indent + "IPv6         : #{ipv6}", nil, true
@@ -458,8 +463,6 @@ module EnfCli
           end
         end
 
-
-
         #
         # display the device info.
         # device_data is a hash matching the json structure
@@ -469,8 +472,8 @@ module EnfCli
           ctl_addr = device_data[:control_address]
           dev_addr = device_data[:device_address] || "\n"
           mac_addrs = device_data[:mac_address]
-          firmware = device_data[:firmware_version] || '< not available >'
-          model = device_data[:model] || '< not available >'
+          firmware = device_data[:firmware_version] || "< not available >"
+          model = device_data[:model] || "< not available >"
           profile = device_data[:profile]
           status = device_data[:status]
 
@@ -485,18 +488,18 @@ module EnfCli
             mac4 = mac_addrs[:'4']
 
             if !mac1
-              say 'Mac Address       : < not available >'
+              say "Mac Address       : < not available >"
             elsif !mac2 && !mac3 && !mac4
               say "Mac Address       : #{mac1}", nil, true
             else
-              say 'Mac Address       :'
+              say "Mac Address       :"
               say "              1   : #{mac1}", nil, true
               say "              2   : #{mac2}", nil, true if mac2
               say "              3   : #{mac3}", nil, true if mac3
               say "              4   : #{mac4}", nil, true if mac4
             end
           else
-            say 'Mac Address       : < not available >'
+            say "Mac Address       : < not available >"
           end
 
           say "Firmware Version  : #{firmware}", nil, true
@@ -508,19 +511,19 @@ module EnfCli
             say "Profile           : < not available >"
           end
           display_device_status_summary status
-          say ' ', nil, true
+          say " ", nil, true
         end
 
-        # 
+        #
         # display the status summary
         #
-        def display_device_status_summary (device_status)
+        def display_device_status_summary(device_status)
           if device_status
-            mode = device_status[:router_mode] || device_status[:mode] || '< not available >'
+            mode = device_status[:router_mode] || device_status[:mode] || "< not available >"
 
             wifi = device_status[:wifi]
 
-            say 'Status            :'
+            say "Status            :"
             say "    Router Mode   : #{mode}", nil, true
 
             if wifi
@@ -539,21 +542,21 @@ module EnfCli
         # status is a hash matching the json structure
         #
         def display_device_status(device_status)
-          sn = device_status[:serial_number] || '< not available >'
-          mode = device_status[:router_mode] || device_status[:mode] || '< not available >'
+          sn = device_status[:serial_number] || "< not available >"
+          mode = device_status[:router_mode] || device_status[:mode] || "< not available >"
 
-          uptime = device_status[:uptime] || '< not available >'
-          refresh = device_status[:refresh_time] || '< not available >'
+          uptime = device_status[:uptime] || "< not available >"
+          refresh = device_status[:refresh_time] || "< not available >"
 
           wifi = device_status[:wifi]
           if wifi
-            connected = wifi[:connected] || '< not available >'
+            connected = wifi[:connected] || "< not available >"
             ssid = wifi[:SSID]
             ipv4 = wifi[:IPv4_addresses]
             ipv6 = wifi[:IPv6_addresses]
             wifi_config = wifi[:config]
           else
-            connected = '< not available >'
+            connected = "< not available >"
             ssid = nil
             ipv4 = nil
             ipv6 = nil
@@ -583,15 +586,15 @@ module EnfCli
 
           display_wifi_detail(wifi_config, false) if wifi_config
 
-          say ' ', nil, true
+          say " ", nil, true
         end
 
         #
         # display the devices summary list
         #
         def display_device_list(devices)
-          headings = ['Serial No', 'Dev Name', 'Dev Addr', 'Router Mode',
-                      'Connected', 'SSID']
+          headings = ["Serial No", "Dev Name", "Dev Addr", "Router Mode",
+                      "Connected", "SSID"]
           rows = devices.map do |hash|
             status = hash[:status]
             if status
@@ -601,10 +604,10 @@ module EnfCli
               mode = status[:router_mode] || status[:mode]
 
               [hash[:serial_number], hash[:device_name], hash[:device_address],
-                mode, connected, ssid]
+               mode, connected, ssid]
             else
               [hash[:serial_number], hash[:device_name], hash[:device_address],
-              nil, nil, nil]
+               nil, nil, nil]
             end
           end
           # [hash[:serial_number], hash[:device_name], hash[:device_address],
@@ -618,7 +621,7 @@ module EnfCli
         # Display profile detail
         #
         def display_profile(profile, summary = false)
-          indent = summary ? '    ' : ''
+          indent = summary ? "    " : ""
 
           say indent + "Name                  : #{profile[:name]}", nil, true
           say indent + "Profile ID            : #{profile[:id]}", nil, true
@@ -632,7 +635,7 @@ module EnfCli
         #
         # Display summary of the WIFI configuration info
         #
-        def display_wifi_summary (wifi)
+        def display_wifi_summary(wifi)
           if wifi
             say "Wifi config           :"
             say "    id                : #{wifi[:id]}", nil, true
@@ -645,22 +648,19 @@ module EnfCli
           else
             say "Wifi config           : < not configured >"
           end
-
         end
 
         #
         # display the profile summary list
         #
         def display_profile_list(profiles)
-          headings = ['Profile Name', 'Profile ID', 'Version']
+          headings = ["Profile Name", "Profile ID", "Version"]
           rows = profiles.map do |hash|
             [hash[:name], hash[:id], hash[:config][:version]]
           end
 
           render_table(headings, rows)
         end
-
-
       end
     end
   end