enfcli 3.7.0.pre.alpha → 3.8.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db8db881fd3ddf2776c8b0d4f0eac562fe296866c7a5c4ceb36dd3a0f1f5bf43
-  data.tar.gz: 85d26d33f9d9019dd5f37a894d1ff748f2c1162b2ff2eb25fe8547fda7165248
+  metadata.gz: fef441dacffa981c271943ac40b3e5f51578398af87480e38ce66b3c1e4e1ecb
+  data.tar.gz: a4a9cf8bf7744a3c531acd0b8910486e77d48c1ee20d07d5bdb21eb6640560e2
 SHA512:
-  metadata.gz: 02c0690082f3a6457f7e33a3ec053a5cec315bc7a61fef59ffc3c72a650a4b6bf4fec2b0e237acc775928e9717a64dca536cc543ec06a7dde5853bd96b6f17a0
-  data.tar.gz: deaaa92d2a9ec1b57f628ac10fa0390fc1530e425b698f87ea1a36d0f679414a3682eeb8bc278cc7ee6bd9da3012fa2791fc04dd5d89b65e27ae801165805459
+  metadata.gz: 12a28d52907530654463ecb3aa8a836ea5e09fcadb255ca4b1ea39c53e7990d227db5a679baf40fe125d8a7bd1cbc7bf7acd9588a90763bc3f6ac71b3136009e
+  data.tar.gz: ceb7a1bea95832a792842fda3307d5fc9dfe86b73ba39d7b4756fe2f4a6dc41df306ccd3b553c13db92f3b3186443ab077779cb0facab08a1cd94a5eeb7dfbcc

data/Gemfile.lock

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

data/lib/enfapi.rb

@@ -241,6 +241,14 @@ module EnfApi
         EnfApi::API.instance.get "/api/captive/v1/device/#{dev_id}"
     end
 
+    # Update a device
+    ## NO_TEST
+    def update_device(id, dev_updates)
+      json = EnfApi.to_json(dev_updates)
+      EnfApi::API.instance.put "/api/captive/v1/device/#{id}", json
+    end
+
+
     # Get the status of a device
     ## NO_TEST
     def get_device_status(dev_id)

data/lib/enfcli/commands/captive.rb

@@ -158,9 +158,13 @@ module EnfCli
             }
           }
           dev_name = options[:'device-name']
-          profile = options[:profile_id]
+          profile_id = options[:profile_id]
           new_device_hash[:device_name] = dev_name if dev_name
-          new_device_hash[:profile] = profile if profile
+          if profile_id
+            profile_hash = {}
+            profile_hash[:id] = profile_id
+            new_device_hash[:profile] = profile_hash
+          end
 
           # send the new device request
           device_data = EnfApi::Captive.instance.create_device new_device_hash
@@ -197,6 +201,34 @@ 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.'
+      def update_device
+        try_with_rescue_in_session do
+          id = options[:'device-id']
+          name = options[:'device-name']
+          profile_id = options[:'profile-id']
+
+          raise "At least one option needs to change." if name == nil && profile_id == nil
+
+          update_hash = {}
+          update_hash[:device_name] = name if name
+          if profile_id
+            update_hash[:profile] = {}
+            update_hash[:profile][:id] = profile_id
+          end
+
+          data = EnfApi::Captive.instance.update_device id, update_hash
+          display_device data
+        end
+      end
+
       desc 'get-device-status',
             'Get the latest status of the specified device.'
       method_option :'device-id', required: true, type: :string,
@@ -419,10 +451,8 @@ module EnfCli
           mac_addrs = device_data[:mac_address]
           firmware = device_data[:firmware_version]
           firmware = '< not available >' unless firmware
-          profile_id = device_data[:profile]
-          profile_id = '< not available >' unless profile_id
+          profile = device_data[:profile]
           status = device_data[:status]
-          status = '< not available >' unless status
 
           say "Serial Number     : #{device_data[:serial_number]}"
           say "Device Name       : #{name}"
@@ -436,11 +466,43 @@ module EnfCli
             say "              4   : #{mac_addrs[:'4']}"
           end
           say "Firmware Version  : #{firmware}"
-          say "Profile ID        : #{profile_id}"
-          say "Status            : #{status}"
+          if profile
+            say "Profile           :"
+            display_profile profile, true
+          else
+            say "Profile           : < not available >"
+          end
+          display_device_status_summary status
           say ''
         end
 
+        # 
+        # display the status summary
+        #
+        def display_device_status_summary (device_status)
+          if device_status
+            sn = device_status[:serial_number]
+            mode = device_status[:router_mode]
+            mode = device_status[:mode] unless mode
+            mode = "\n" unless mode
+            wifi = device_status[:wifi]
+
+            say 'Status            :'
+            say "    Serial Number : #{sn}" if sn
+            say "    Router Mode   : #{mode}"
+
+            if wifi
+              connected = wifi[:connected]
+              connected = " < unknown >" unless connected
+              ssid = wifi[:SSID]
+              say "    wifi connected: #{connected}"
+              say "    SSID          : #{ssid}" if ssid
+            end
+          else
+            say "Status            : < not available >"
+          end
+        end
+
         #
         # display the status of the device.
         # status is a hash matching the json structure
@@ -518,26 +580,39 @@ module EnfCli
         #
         # Display profile detail
         #
-        def display_profile (profile)
-          say "Name                  :#{profile[:name]}"
-          say "Profile ID            :#{profile[:id]}"
-          say "Configuration version :#{profile[:config][:version]}"
-          say "Mode                  :#{profile[:config][:mode]}"
-          display_wifi_summary profile[:config][:wifi]
+        def display_profile (profile, summary = false)
+          if summary
+            indent = '    '
+          else
+            indent = ''
+          end
+
+          say indent + "Name                  : #{profile[:name]}"
+          say indent + "Profile ID            : #{profile[:id]}"
+          say indent + "Configuration version : #{profile[:config][:version]}"
+          unless summary
+            say "Mode                  :#{profile[:config][:mode]}"
+            display_wifi_summary profile[:config][:wifi]
+          end
         end
 
         #
         # Display summary of the WIFI configuration info
         #
         def display_wifi_summary (wifi)
-          say "Wifi config           :"
-          say "    id                :#{wifi[:id]}"
-          # TODO - make accessible only to Xaptum admins
-          say "    domain            :#{wifi[:domain]}"
-          say "    name              :#{wifi[:name]}"
-          desc = wifi[:description]
-          say "    description       :#{desc}" if desc
-          say "    config version    :#{wifi[:version]}"
+          if wifi
+            say "Wifi config           :"
+            say "    id                :#{wifi[:id]}"
+            # TODO - make accessible only to Xaptum admins
+            say "    domain            :#{wifi[:domain]}"
+            say "    name              :#{wifi[:name]}"
+            desc = wifi[:description]
+            say "    description       :#{desc}" if desc
+            say "    config version    :#{wifi[:version]}"
+          else
+            say "Wifi config           : < not configured >"
+          end
+
         end
 
         #

data/lib/enfcli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enfcli
 version: !ruby/object:Gem::Version
-  version: 3.7.0.pre.alpha
+  version: 3.8.0.pre.alpha
 platform: ruby
 authors:
 - Venkatakumar Srinivasan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-07 00:00:00.000000000 Z
+date: 2019-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor