enfcli 3.10.4.pre.alpha → 3.11.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '060840337e5587c05f399f72499547dd919e344b560d7f8bf16027c067b9f9a9'
-  data.tar.gz: 5cecd80db91bd74922f05aba5ce31124a7aa06d0fc49888ca7416a99d8345e47
+  metadata.gz: 26b242ed9d5db128c862067ce214faddb6c8842635f947538b5be9bc2ef44de6
+  data.tar.gz: 7531477be394b40a9cacda41ac4eb781b82495443ecc32e780d2efd7a7d63e30
 SHA512:
-  metadata.gz: e8a7b06fff19daebe9463a2b808c76d3227605b1180a31db5b407beaf9bffc590997de86f80052e6aaf9198132d81f8cb96068a44a2ae4489389426c38f82acc
-  data.tar.gz: cb1c049b79375bb3a90bf94edf53fad34c9bcee1d2313c7ad010d2307ed7d55198cd1804d791d19cdac20e46035e4f32b3708ac1862fb2118588bc63f861511d
+  metadata.gz: 3aa34b98fde5eea1a318cafc26756261c3b4a069d8baaf6aedf2a1e8adc4cbfe47d6822813835f8827e3dbb4d05c0add4e43f6942e49df11ec708904c9a217b8
+  data.tar.gz: 789a4512c071c67771c20001e7339317141c27ddcd14a566a45f35f115abe91ed9928939d9f3a0128f2738f44cd1dbc2ba0c6eb25d6cd89697fac9b3adfe727d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    enfcli (3.10.4.pre.alpha)
+    enfcli (3.11.0.pre.alpha)
       rest-client (~> 2.0)
       terminal-table
       thor (~> 0.20.0)

data/lib/enfapi.rb

@@ -558,12 +558,19 @@ module EnfApi
           raise EnfApi::ERROR, "AUTHORIZATION_ERROR: User is not authorized to perform this operation!"
 
         when 404
-          # api returns and error
-          raise EnfApi::ERROR, api_error_msg(from_json(response.body))
+          # api returns an error
+          # for the 404, we're going to check if it is JSON before parsing the
+          # error message
+          begin
+            JSON.parse(response.body)
+            raise EnfApi::ERROR, api_error_msg(from_json(response.body))
+          rescue JSON::ParserError => e
+            raise EnfApi::ERROR, "Not Found"
+          end
 
         else
           raise EnfApi::ERROR, "Unexpected error! Please try again!"
-        end
+      end
     end
 
     def from_json(string)

data/lib/enfcli/commands/captive.rb

@@ -18,6 +18,7 @@
 require 'enfthor'
 require 'enfapi'
 require 'json'
+require 'erb'
 
 module EnfCli
   module Cmd
@@ -203,7 +204,8 @@ module EnfCli
                                   desc: 'DEVICE-ID is either the device serial number or its ipv6 address.'
       def get_device
         try_with_rescue_in_session do
-          device_id = options[:'device-id']
+          device_id = ERB::Util::url_encode(options[:'device-id'])
+
           data = EnfApi::Captive.instance.get_device device_id
 
           display_device data
@@ -220,7 +222,7 @@ module EnfCli
                                   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 = options[:'device-id']
+          id = ERB::Util::url_encode(options[:'device-id'])
           name = options[:'device-name']
           profile_id = options[:'profile-id']
 
@@ -245,7 +247,7 @@ module EnfCli
                                   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 = options[:'device-id']
+          device_id = ERB::Util::url_encode(options[:'device-id'])
           status = EnfApi::Captive.instance.get_device_status device_id
 
           display_device_status status
@@ -366,36 +368,36 @@ module EnfCli
         end
 
         # Display a single wifi configuration in detail
-        def display_wifi_detail(wifi_data)
+        def display_wifi_detail(wifi_data, full_listing=true)
           name = wifi_data[:name]
-          name = "\n" unless name
           wifi_id = wifi_data[:id]
-          wifi_id = "\n" unless wifi_id
           desc = wifi_data[:description]
-          desc = "\n" unless desc
           nets = wifi_data[:networks]
 
-          say "Wifi ID       : #{wifi_id}"
-          say "Name          : #{name}"
-          say "Description   : #{desc}"
-          say "WiFi Networks :"
-          if nets
-            nets.each do |wifi_net|
-              display_wifi_net(wifi_net, 1)
+          say "Wifi ID       : #{wifi_id}", nil, true
+          say "Name          : #{name}", nil, true
+          say "Description   : #{desc}", nil, true if desc
+          if full_listing
+            say "WiFi Networks :"
+            if nets
+              nets.each do |wifi_net|
+                display_wifi_net(wifi_net, 1)
+              end
             end
+  
           end
 
         end
 
         def display_wifi_net(wifi_net, tabs)
           indent = "    " * tabs
-          say indent + "Name          : #{wifi_net[:name]}"
-          say indent + "    SSID          :#{wifi_net[:SSID]}"
-          say indent + "    SSID type     :#{wifi_net[:SSID_type]}"
+          say indent + "Name          : #{wifi_net[:name]}", nil, true
+          say indent + "    SSID         : #{wifi_net[:SSID]}", nil, true
+          say indent + "    SSID type    : #{wifi_net[:SSID_type]}", nil, true
 
           auth = wifi_net[:auth]
           if auth
-            say indent + "    auth          :#{auth[:type]}"
+            say indent + "    auth         : #{auth[:type]}", nil, true
           end
 
           display_ipv4_addr(wifi_net[:IPv4], tabs + 1)  # these are subelements, so indent 1 more.
@@ -405,18 +407,18 @@ module EnfCli
         def display_ipv4_addr (ipv4, tabs)
           indent = "    " * tabs
           if ipv4.instance_of? String
-            say indent + "IPv4          :#{ipv4}"
+            say indent + "IPv4         : #{ipv4}", nil, true
           elsif ipv4.instance_of? NilClass
-            say indent + "IPv4          :off"
+            say indent + "IPv4         : off"
           elsif ipv4.instance_of? Hash
             addr_type = ipv4[:type]
             if addr_type == "dhcp"
-              say indent + "IPv4          :#{addr_type}"
+              say indent + "IPv4         : #{addr_type}"
             elsif addr_type == "static"
               addr = ipv4[:address]
               mask = ipv4[:mask]
               gw = ipv4[:gateway]
-              say indent + "IPv4          :#{addr}/#{mask}/#{gw}"
+              say indent + "IPv4         : #{addr}/#{mask}/#{gw}", nil, true
             else
               say indent + "*** Invalid ipv4 address. Type is #{addr_type} ***"
             end
@@ -428,18 +430,18 @@ module EnfCli
         def display_ipv6_addr (ipv6, tabs)
           indent = "    " * tabs
           if ipv6.instance_of? String
-            say indent + "IPv6          :#{ipv6}"
+            say indent + "IPv6         : #{ipv6}", nil, true
           elsif ipv6.instance_of? NilClass
-            say indent + "IPv6          :off"
+            say indent + "IPv6         : off"
           elsif ipv6.instance_of? Hash
             addr_type = ipv6[:type]
             if addr_type == "auto"
-              say indent + "IPv6          :#{addr_type}"
+              say indent + "IPv6         : #{addr_type}"
             elsif addr_type == "static"
               addr = ipv6[:address]
               pref = ipv6[:prefix_length]
               gw = ipv6[:gateway]
-              say indent + "IPv6          :#{addr}/#{pref}/#{gw}"
+              say indent + "IPv6         : #{addr}/#{pref}/#{gw}", nil, true
             else
               say indent + "*** Invalid ipv6 address. Type is #{addr_type} ***"
             end
@@ -463,18 +465,32 @@ module EnfCli
           profile = device_data[:profile]
           status = device_data[:status]
 
-          say "Serial Number     : #{device_data[:serial_number]}"
-          say "Device Name       : #{name}"
+          say "Serial Number     : #{device_data[:serial_number]}", nil, true
+          say "Device Name       : #{name}", nil, true
           say "Control Address   : #{ctl_addr}" if ctl_addr
-          say "Device Address    : #{dev_addr}"
-          say 'Mac Address       :'
+          say "Device Address    : #{dev_addr}", nil, true
           if mac_addrs
-            say "              1   : #{mac_addrs[:'1']}"
-            say "              2   : #{mac_addrs[:'2']}"
-            say "              3   : #{mac_addrs[:'3']}"
-            say "              4   : #{mac_addrs[:'4']}"
+            mac1 = mac_addrs[:'1']
+            mac2 = mac_addrs[:'2']
+            mac3 = mac_addrs[:'3']
+            mac4 = mac_addrs[:'4']
+
+            if !mac1
+              say 'Mac Address       : < not available >'
+            elsif !mac2 && !mac3 && !mac4
+              say "Mac Address       : #{mac1}", nil, true
+            else
+              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 >'
           end
-          say "Firmware Version  : #{firmware}"
+
+          say "Firmware Version  : #{firmware}", nil, true
           if profile
             say "Profile           :"
             display_profile profile, true
@@ -482,7 +498,7 @@ module EnfCli
             say "Profile           : < not available >"
           end
           display_device_status_summary status
-          say ''
+          say ' ', nil, true
         end
 
         # 
@@ -490,13 +506,12 @@ module EnfCli
         #
         def display_device_status_summary (device_status)
           if device_status
-            mode = device_status[:router_mode]
-            mode = device_status[:mode] unless mode
-            mode = "\n" unless mode
+            mode = device_status[:router_mode] || device_status[:mode] || '< not available >'
+
             wifi = device_status[:wifi]
 
             say 'Status            :'
-            say "    Router Mode   : #{mode}"
+            say "    Router Mode   : #{mode}", nil, true
 
             if wifi
               connected = wifi[:connected] || " < unknown >"
@@ -514,44 +529,51 @@ module EnfCli
         # status is a hash matching the json structure
         #
         def display_device_status(device_status)
-          sn = device_status[:serial_number]
-          mode = device_status[:router_mode]
-          mode = device_status[:mode] unless mode
-          mode = "\n" unless mode
+          sn = device_status[:serial_number] || '< not available >'
+          mode = device_status[:router_mode] || device_status[:mode] || '< not available >'
 
-          uptime = device_status[:uptime]
+          uptime = device_status[:uptime] || '< not available >'
           refresh = device_status[:refresh_time] || '< not available >'
-          wifi_status = device_status[:wifi][:status]
-          connected = wifi_status[:connected] || '< not available >'
-          ssid = wifi_status[:SSID]
-          ipv4 = wifi_status[:IPv4_addresses]
-          ipv6 = wifi_status[:IPv6_addresses]
-          wifi = device_status[:wifi][:config]
-
-          say "Serial Number        : #{sn}"
-          say "Router Mode          : #{mode}"
-          say "Uptime (in seconds)  : #{uptime}"
-          say "Status refresh time  : #{refresh}"
+
+          wifi = device_status[:wifi]
+          if wifi
+            connected = wifi[:connected] || '< not available >'
+            ssid = wifi[:SSID]
+            ipv4 = wifi[:IPv4_addresses]
+            ipv6 = wifi[:IPv6_addresses]
+            wifi_config = wifi[:config]
+          else
+            connected = '< not available >'
+            ssid = nil
+            ipv4 = nil
+            ipv6 = nil
+            wifi_config = nil
+          end
+
+          say "Serial Number        : #{sn}", nil, true
+          say "Router Mode          : #{mode}", nil, true
+          say "Uptime (in seconds)  : #{uptime}", nil, true
+          say "Status refresh time  : #{refresh}", nil, true
           say "WIFI                 :"
-          say "    connected        : #{connected}"
+          say "    connected        : #{connected}", nil, true
           say "    SSID             : #{ssid}" if ssid
-          if ipv4
-            say "    IPv4 addresses  :"
+          if ipv4 && !ipv4.empty?
+            say "    IPv4 addresses   :"
             ipv4.each do |addr|
               display_ipv4_addr(addr, 2)
             end
           end
 
-          if ipv6
-            say "    IPv6 addresses  :"
+          if ipv6 && !ipv6.empty?
+            say "    IPv6 addresses   :"
             ipv6.each do |addr|
               display_ipv6_addr(addr, 2)
             end
           end
 
-          display_wifi_detail(wifi) if wifi
+          display_wifi_detail(wifi_config, false) if wifi_config
 
-          say ''
+          say ' ', nil, true
         end
 
         #
@@ -566,8 +588,10 @@ module EnfCli
               wifi = status[:wifi]
               connected = wifi ? wifi[:connected] : nil
               ssid = wifi ? wifi[:SSID] : nil
+              mode = status[:router_mode] || status[:mode]
+
               [hash[:serial_number], hash[:device_name], hash[:device_address],
-              status[:router_mode], connected, ssid]
+                mode, connected, ssid]
             else
               [hash[:serial_number], hash[:device_name], hash[:device_address],
               nil, nil, nil]
@@ -586,11 +610,11 @@ module EnfCli
         def display_profile(profile, summary = false)
           indent = summary ? '    ' : ''
 
-          say indent + "Name                  : #{profile[:name]}"
-          say indent + "Profile ID            : #{profile[:id]}"
-          say indent + "Configuration version : #{profile[:config][:version]}"
+          say indent + "Name                  : #{profile[:name]}", nil, true
+          say indent + "Profile ID            : #{profile[:id]}", nil, true
+          say indent + "Configuration version : #{profile[:config][:version]}", nil, true
           unless summary
-            say "Mode                  :#{profile[:config][:mode]}"
+            say "Mode                  : #{profile[:config][:mode]}", nil, true
             display_wifi_summary profile[:config][:wifi]
           end
         end
@@ -601,13 +625,13 @@ module EnfCli
         def display_wifi_summary (wifi)
           if wifi
             say "Wifi config           :"
-            say "    id                :#{wifi[:id]}"
+            say "    id                : #{wifi[:id]}", nil, true
             # TODO - make accessible only to Xaptum admins
-            say "    domain            :#{wifi[:domain]}"
-            say "    name              :#{wifi[:name]}"
+            say "    domain            : #{wifi[:domain]}", nil, true
+            say "    name              : #{wifi[:name]}", nil, true
             desc = wifi[:description]
-            say "    description       :#{desc}" if desc
-            say "    config version    :#{wifi[:version]}"
+            say "    description       : #{desc}" if desc
+            say "    config version    : #{wifi[:version]}", nil, true
           else
             say "Wifi config           : < not configured >"
           end

data/lib/enfcli/version.rb

@@ -14,5 +14,5 @@
 # limitations under the License.
 #
 module EnfCli
-  VERSION = '3.10.4-alpha'
+  VERSION = '3.11.0-alpha'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enfcli
 version: !ruby/object:Gem::Version
-  version: 3.10.4.pre.alpha
+  version: 3.11.0.pre.alpha
 platform: ruby
 authors:
 - Venkatakumar Srinivasan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-15 00:00:00.000000000 Z
+date: 2019-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor