enfcli 4.1.0.pre.beta → 4.2.1.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27d832f6ee49be44d9463b1b77931d15db08f79f6d382c1bc243635ef9eca137
-  data.tar.gz: 070eabadf3b810b47c948dd5ca84cc362852dde237dba5a95a7e4e90e011f8b0
+  metadata.gz: 27b28906253cb5aa863c719da49ea29361254f44d7cc638e332d531f404e3887
+  data.tar.gz: b6c231170699644a0628d9911368b822214b47916c61b66424384d19b5eb48fd
 SHA512:
-  metadata.gz: afc068399c4e7477a16388c3ead24346520823cb214b19befe9a4a4d58a19f14b4f45868b31c66b7841c24073970241fb81b68f54e5bc23534d547e586436de4
-  data.tar.gz: 3d9e53a84414a42d17e35c8c01852af895a149d5e906000d3e84fa7282150d49542a91c130c73b35b8a010139771adcac0267a31991686799b62346f42daf6ba
+  metadata.gz: 84a41a3805664bf9e341d6a545daf92bc82c1271f5ccb92695808ae9e4737ecd8c148259d904f28f0bdbf65a8e6f34333c503adccf39b63c261d7b6bb1976d41
+  data.tar.gz: 94706731090498b60bde0dcc0181cabf7ba7bddd9088c879cc049f4f7e87990bdf5e5bc05774a61506f3c3b9cffd1dff0314b75fb9fb2b65c43c7fa7875e2549

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    enfcli (4.1.0.pre.beta)
+    enfcli (4.2.1.pre.alpha)
       clipboard
       ffi
       readline
@@ -32,13 +32,13 @@ GEM
     io-console (0.5.6)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
+    mime-types-data (3.2020.0425)
     netrc (0.11.0)
     public_suffix (4.0.3)
     rake (10.5.0)
     readline (0.0.2)
       reline
-    reline (0.1.3)
+    reline (0.1.4)
       io-console (~> 0.5)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)

data/lib/enfapi.rb

@@ -1,5 +1,5 @@
 #
-# Copyright 2018 Xaptum,Inc
+# Copyright 2020 Xaptum,Inc
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -284,6 +284,89 @@ module EnfApi
       json = EnfApi.to_json(profile_updates)
       EnfApi::API.instance.put "/api/captive/v1/profile/#{id}", json
     end
+
+    # Get the list of devices
+    ## NO_TEST
+    def list_firmware_images()
+      url = "/api/captive/v1/firmware/release"
+      EnfApi::API.instance.get url
+    end
+
+    # Upload the firmware image
+    # Current version sends an empty body - captive server doesn't support
+    # sending the binary image yet.
+    ## NO_TEST
+    def upload_firmware_image(version, image_name)
+      url = "/api/captive/v1/firmware/release/#{version}/#{image_name}"
+      EnfApi::API.instance.put url
+    end
+
+    # gets the details for a specific firmware version
+    ## NO_TEST
+    def get_firmware_info(version)
+      url = "/api/captive/v1/firmware/release/#{version}"
+      EnfApi::API.instance.get url
+    end
+
+    # creates a new schedule object via POST
+    ## NO_TEST
+    def create_schedule(sched_hash)
+      json = EnfApi.to_json(sched_hash)
+      EnfApi::API.instance.post "/api/captive/v1/schedule", json
+    end
+
+    # GETs a list of all existing schedules
+    ## NO_TEST
+    def list_schedules
+      EnfApi::API.instance.get "/api/captive/v1/schedule"
+    end
+
+    # GETs the details of a specific schedule
+    ## NO_TEST
+    def get_schedule(id)
+      EnfApi::API.instance.get "/api/captive/v1/schedule/#{id}"
+    end
+
+    # update the details of a specific schedule
+    ## NO_TEST
+    def update_schedule(id, sched_hash)
+      json = EnfApi.to_json(sched_hash)
+      url = "/api/captive/v1/schedule/#{id}"
+      EnfApi::API.instance.put url, json
+    end
+
+    # DELETEs the specified schedule
+    ## NO_TEST
+    def delete_schedule(id)
+      EnfApi::API.instance.delete "/api/captive/v1/schedule/#{id}"
+    end
+
+    # GET the list of existing update objects
+    ## NO_TEST
+    def list_firmware_updates()
+      EnfApi::API.instance.get "/api/captive/v1/firmware/update"
+    end
+
+    # GET details of a specified firmware update task
+    ## NO_TEST
+    def get_firmware_update(update_id)
+      EnfApi::API.instance.get "/api/captive/v1/firmware/update/#{update_id}"
+    end
+
+    # POSTs a new firmware-udpate object
+    ## NO_TEST
+    def create_firmware_update(update_hash)
+      json = EnfApi.to_json(update_hash)
+      EnfApi::API.instance.post "/api/captive/v1/firmware/update", json
+    end
+
+    # uses PUT to modify an existing firmware update task
+    ## NO_TEST
+    def modify_firmware_update(update_id, update_hash)
+      url = "/api/captive/v1/firmware/update/#{update_id}"
+      json = EnfApi.to_json(update_hash)
+      EnfApi::API.instance.put url, json
+    end
   end
 
   class NetworkManager
@@ -569,6 +652,13 @@ module EnfApi
         rescue JSON::ParserError => e
           raise EnfApi::ERROR, "Not Found"
         end
+      when 500
+        begin
+          JSON.parse(response.body)
+          raise EnfApi::ERROR, api_error_msg(from_json(response.body))
+        rescue JSON::ParserError => e
+          raise EnfApi::ERROR, "Server error was received without details."
+        end
       else
         raise EnfApi::ERROR, "Unexpected error! Please try again!"
       end

data/lib/enfcli/commands/captive.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Copyright 2018-2019 Xaptum,Inc
+# Copyright 2018-2020 Xaptum,Inc
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -278,6 +278,10 @@ module EnfCli
                                     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"
+      method_option :'update-id', type: :string, default: nil,
+                                  banner: "UPDATE-ID",
+                                  desc: "UPDATE-ID is the UUID of the firmware update record. " \
+                                        "The firmware-update record must already exist."
 
       def create_profile
         try_with_rescue_in_session do
@@ -293,6 +297,12 @@ module EnfCli
             new_profile_hash[:config][:wifi][:id] = wifi
           end
 
+          fw_update = options[:'update-id']
+          if fw_update
+            new_profile_hash[:config][:firmware] = {}
+            new_profile_hash[:config][:firmware][:id] = fw_update if fw_update
+          end
+
           # send the POST to create a new profile
           profile = EnfApi::Captive.instance.create_profile new_profile_hash
           display_profile profile
@@ -341,6 +351,10 @@ module EnfCli
                                     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"
+      method_option :'update-id', type: :string, default: nil,
+                                  banner: "UPDATE-ID",
+                                  desc: "UPDATE-ID is the UUID of the firmware update record. " \
+                                        "The firmware-update record must already exist."
 
       def update_profile
         try_with_rescue_in_session do
@@ -348,23 +362,250 @@ module EnfCli
           name = options[:'profile-name']
           mode = options[:'device-mode']
           wifi_id = options[:'wifi-id']
+          fw_update = options[:'update-id']
 
-          raise "At least one option needs to change." if name == nil && mode == nil && wifi_id == nil
+          raise "At least one option needs to change." if name == nil && mode == nil && wifi_id == nil && fw_update == nil
 
           update_hash = {}
           update_hash[:name] = name if name
-          update_hash[:config] = {} if wifi_id || mode
+          update_hash[:config] = {} if wifi_id || mode || fw_update
           update_hash[:config][:mode] = mode if mode
           if wifi_id
             update_hash[:config][:wifi] = {}
             update_hash[:config][:wifi][:id] = wifi_id
           end
 
+          if fw_update
+            update_hash[:config][:firmware] = {}
+            update_hash[:config][:firmware][:id] = fw_update
+          end
           profile = EnfApi::Captive.instance.update_profile id, update_hash
           display_profile profile
         end
       end
 
+      desc "list-firmware-images",
+           "Lists all of the available versions of the firmware"
+
+      def list_firmware_images
+        try_with_rescue_in_session do
+          data = EnfApi::Captive.instance.list_firmware_images
+          display_firmware_image_list data
+        end
+      end
+
+      desc "upload-firmware-image",
+           "Uploads a new firmware image. Each version will have multiple " \
+           "images -- one for each type of hardware. \nNOTE: This version " \
+           "doesn't actually upload the file, it merely informs the server of " \
+           "its existance."
+      method_option :'image-file', required: true, type: :string,
+                                   banner: "<file>", desc: "<file> is the firmware binary image."
+      method_option :version, required: true, type: :string,
+                              banner: "VERSION",
+                              desc: "VERSION is the release version."
+      method_option :'image-name', type: :string, default: nil, banner: "NAME",
+                                   desc: "NAME is the name to associate with the firmware " \
+                                   "image. This is usually the generated filename. " \
+                                   "Defaults to the base name of <file>"
+
+      def upload_firmware_image
+        try_with_rescue_in_session do
+          filename = options[:'image-file']
+          version = options[:version]
+          image_name = options[:'image-name']
+
+          temp_img_name = File.basename(filename)
+          image_name ||= temp_img_name
+
+          raise "image-name does not match image-file" if temp_img_name != image_name
+
+          # This version PUTs an empty body
+          resp = EnfApi::Captive.instance.upload_firmware_image version, image_name
+
+          if (resp.code == 200)
+            say "Upload complete."
+          else
+            say "Upload failed with code #{resp.code}"
+          end
+        end
+      end
+
+      desc "get-firmware-info",
+           "Prints details of an existing firmware version."
+      method_option :version, required: true, type: :string,
+                              banner: "VERSION", desc: "VERSION is the release version."
+
+      def get_firmware_info
+        try_with_rescue_in_session do
+          version = options[:version]
+
+          fw_info = EnfApi::Captive.instance.get_firmware_info version
+
+          display_firmware_detail fw_info
+        end
+      end
+
+      desc "create-schedule",
+           "Creates a schedule object that will be used to determine when a " \
+           "device or group of devices may be upgraded. The schedule will be " \
+           "uploaded from a JSON-formatted file."
+      method_option :schedule, required: true, type: :string,
+                               banner: "<file>",
+                               desc: "<file> is a JSON file containing the desired schedule."
+
+      def create_schedule
+        try_with_rescue_in_session do
+          filename = options[:schedule]
+
+          # reading the whole file - shouldn't get more than a few KB
+          content = File.read filename
+          sched_hash = JSON.parse(content)
+
+          resp_data = EnfApi::Captive.instance.create_schedule sched_hash
+          display_schedule_detail resp_data
+        end
+      end
+
+      desc "list-schedules",
+           "Prints a summary list of all existing schedules."
+
+      def list_schedules
+        try_with_rescue_in_session do
+          sched_list = EnfApi::Captive.instance.list_schedules
+          display_schedule_list sched_list
+        end
+      end
+
+      desc "get-schedule",
+           "Prints the detail of a specific, existing schedule."
+      method_option :'schedule-id', type: :string, required: true, banner: "ID",
+                                    desc: "ID is the system-assigned UUID of the schedule " \
+                                          "to retrieve."
+
+      def get_schedule
+        try_with_rescue_in_session do
+          sched_id = options[:'schedule-id']
+          sched_data = EnfApi::Captive.instance.get_schedule sched_id
+          display_schedule_detail sched_data
+        end
+      end
+
+      desc "update-schedule",
+           "Modifies an existing schedule by uploading an updated schedule in " \
+           "the form of a JSON file."
+      method_option :'schedule-id', type: :string, required: true, banner: "ID",
+                                    desc: "ID is the UUID of the schedule to update."
+      method_option :schedule, type: :string, required: true, bannder: "<file>",
+                               desc: "<file> is a JSON file containing the desired schedule."
+
+      def update_schedule
+        try_with_rescue_in_session do
+          sched_id = options[:'schedule-id']
+          filename = options[:schedule]
+
+          # read in whole schedule file
+          content = File.read filename
+          sched_hash = JSON.parse(content)
+
+          resp_data = EnfApi::Captive.instance.update_schedule sched_id, sched_hash
+          display_schedule_detail resp_data
+        end
+      end
+
+      desc "delete-schedule",
+           "Deletes the specified, existing schedule."
+      method_option :'schedule-id', type: :string, required: true, banner: "ID",
+                                    desc: "ID is the system-assigned UUID of the schedule " \
+                                          "to delete."
+
+      def delete_schedule
+        try_with_rescue_in_session do
+          sched_id = options[:'schedule-id']
+
+          # get the name of the schedule
+          resp = EnfApi::Captive.instance.get_schedule(sched_id)
+          name = resp[:name]
+
+          resp = EnfApi::Captive.instance.delete_schedule sched_id
+
+          if (resp.code == 200)
+            say "Successfully deleted schedule named: #{name}"
+          elsif (resp.code == 409)
+            say "Schedule #{name} is being used by pending updates and cannot be deleted."
+          else
+            say "Failed to delete schedule #{name} with code #{resp.code}"
+          end
+        end
+      end
+
+      desc "list-firmware-updates",
+           "Lists the existing firmware update tasks."
+
+      def list_firmware_updates
+        try_with_rescue_in_session do
+          updates_list = EnfApi::Captive.instance.list_firmware_updates
+          display_updates_list updates_list
+        end
+      end
+
+      desc "get-firmware-update",
+           "Prints the details of the specified firmware update task."
+      method_option :'update-id', type: :string, required: true, banner: "ID",
+                                  desc: "ID is the UUID of the firmware update task"
+
+      def get_firmware_update
+        try_with_rescue_in_session do
+          update_id = options[:'update-id']
+
+          update_data = EnfApi::Captive.instance.get_firmware_update update_id
+          display_update_detail update_data
+        end
+      end
+
+      desc "create-firmware-update",
+           "Creates a firmware-update task that the system will use to update " \
+           "router-card firmware as prescribed in the specified JSON file."
+      method_option :update, type: :string, required: true, banner: "<file>",
+                             desc: "<file> is a JSON file containing the details of " \
+                                   "the update task."
+
+      def create_firmware_update
+        try_with_rescue_in_session do
+          filename = options[:update]
+
+          # reading the whole file - shouldn't get more than a few KB
+          content = File.read filename
+          update_hash = JSON.parse(content)
+
+          resp_data = EnfApi::Captive.instance.create_firmware_update update_hash
+          display_update_detail resp_data
+        end
+      end
+
+      desc "modify-firmware-update",
+           "Modifies an existing firmware-update task with the information " \
+           "contained in the specified JSON file"
+      method_option :'update-id', type: :string, required: true, banner: "ID",
+                                  desc: "ID is the UUID of the firmware update task to be modified."
+      method_option :update, type: :string, required: true, banner: "<file>",
+                             desc: "<file> is a JSON file containing the details of " \
+                                   "the update task."
+
+      def modify_firmware_update
+        try_with_rescue_in_session do
+          update_id = options[:'update-id']
+          filename = options[:update]
+
+          # reading the whole file - shouldn't get more than a few KB
+          content = File.read filename
+          update_hash = JSON.parse(content)
+
+          resp_data = EnfApi::Captive.instance.modify_firmware_update update_id, update_hash
+          display_update_detail resp_data
+        end
+      end
+
       #########################################################################
       #
       # Helper functions
@@ -613,7 +854,6 @@ module EnfCli
           # [hash[:serial_number], hash[:device_name], hash[:device_address],
           # hash[:status][:router_mode], hash[:status][:wifi][:connected],
           # hash[:status][:wifi][:SSID]]
-
           render_table(headings, rows)
         end
 
@@ -623,11 +863,20 @@ module EnfCli
         def display_profile(profile, summary = false)
           indent = summary ? "    " : ""
 
+          firmware = profile[:config][:firmware]
+          fw_id = "< not configured >"
+          if firmware
+            fw_id = firmware[:id]
+            fw_version = firmware[:version]
+          end
+
           say indent + "Name                  : #{profile[:name]}", nil, true
           say indent + "Profile ID            : #{profile[:id]}", nil, true
           say indent + "Configuration version : #{profile[:config][:version]}", nil, true
+          say indent + "Firmware Update ID    : #{fw_id}", nil, true
           unless summary
-            say "Mode                  : #{profile[:config][:mode]}", nil, true
+            say indent + "    Update version    : #{fw_version}", nil, true if fw_version
+            say indent + "Mode                  : #{profile[:config][:mode]}", nil, true
             display_wifi_summary profile[:config][:wifi]
           end
         end
@@ -654,13 +903,114 @@ module EnfCli
         # display the profile summary list
         #
         def display_profile_list(profiles)
-          headings = ["Profile Name", "Profile ID", "Version"]
+          headings = ["Profile Name", "Profile ID", "Version", "Mode", "Wifi ID", "Firmware Update ID"]
           rows = profiles.map do |hash|
-            [hash[:name], hash[:id], hash[:config][:version]]
+            config = hash[:config]
+            fw_id = config[:firmware] ? config[:firmware][:id] : "none"
+            [hash[:name], hash[:id], config[:version], config[:mode],
+             config[:wifi][:id], fw_id]
           end
+          render_table(headings, rows)
+        end
 
+        #
+        # Displays the list of firmware releases
+        #
+        def display_firmware_image_list(images)
+          headings = ["Firmware Version"]
+          rows = images.map do |element|
+            [element[:version]]
+          end
           render_table(headings, rows)
         end
+
+        #
+        # Displays firmware detail
+        #
+        def display_firmware_detail(fw_info)
+          version = fw_info[:version] || "< not available >"
+          images = fw_info[:images]
+
+          say "Release version: #{version}"
+          display_image_list images
+        end
+
+        #
+        # Displays the list of images available for a release version.
+        #
+        def display_image_list(images)
+          headings = ["Image Name", "Hardware Model", "Update Type", "SHA256"]
+          rows = images.map do |hash|
+            [hash[:name], hash[:model], hash[:type], hash[:sha256]]
+          end
+          render_table(headings, rows)
+        end
+
+        #
+        # Displays the full SCHEDULE object detail
+        #
+        def display_schedule_detail(sched_data)
+          name = sched_data[:name]
+          id = sched_data[:id]
+          domain = sched_data[:domain]
+          times = sched_data[:times]
+
+          say "Schedule Name    : #{name}", nil, true
+          say "Shedule ID       : #{id}", nil, true
+          say "domain           : #{domain}", nil, true
+          say "Times:", nil, true
+          display_time_list(times)
+        end
+
+        #
+        # Displays the list of times in a schedule as a table
+        #
+        def display_time_list(times)
+          headings = ["Name", "year", "Month", "Date", "Weekday", "Hour",
+                      "Minute", "id"]
+          rows = times.map do |hash|
+            [hash[:name], hash[:year], hash[:month], hash[:day_of_month],
+             hash[:day_of_week], hash[:hour], hash[:minute], hash[:id]]
+          end
+          render_table(headings, rows)
+        end
+
+        #
+        # Displays a list of schedules
+        #
+        def display_schedule_list(sched_list)
+          headings = ["Name", "ID"]
+          rows = sched_list.map do |hash|
+            [hash[:name], hash[:id]]
+          end
+          render_table(headings, rows)
+        end
+
+        #
+        # Displays a list of firmware updates
+        #
+        def display_updates_list(updates_list)
+          headings = ["Update ID", "Update Version"]
+          rows = updates_list.map do |hash|
+            [hash[:id], hash[:version]]
+          end
+          render_table(headings, rows)
+        end
+
+        #
+        # Displays detail of a specific firmware update task
+        #
+        def display_update_detail(update_data)
+          id = update_data[:id]
+          sched_id = update_data[:schedule_id]
+          version = update_data[:version]
+          percent = update_data[:update_percentage]
+
+          say "Update Task ID               : #{id}"
+          say "Schedule ID                  : #{sched_id}"
+          say "Firmware Version             : #{version}"
+          say "Percent of devices to update : #{percent}"
+        end
       end
     end
   end

data/lib/enfcli/version.rb

@@ -1,5 +1,5 @@
 #
-# Copyright 2018 Xaptum,Inc
+# Copyright 2018-2020 Xaptum,Inc
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,5 +14,5 @@
 # limitations under the License.
 #
 module EnfCli
-  VERSION = "4.1.0-beta"
+  VERSION = "4.2.1-alpha"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enfcli
 version: !ruby/object:Gem::Version
-  version: 4.1.0.pre.beta
+  version: 4.2.1.pre.alpha
 platform: ruby
 authors:
 - Venkatakumar Srinivasan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor