enfcli 3.5.0 → 3.5.2.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 131b57ab3f2a4584c8474f155f551361ba8668cb502b7cbe305fb822dedc9544
-  data.tar.gz: 411cb6af276ea545f7a7d991cb5e2726dad76ec69e5500b74e4855fef196185b
+  metadata.gz: e6af8d561223bdd6c26e0eba12c88a4a299053483aac5b011c37dd509a72835e
+  data.tar.gz: 8bcd07d80348541069042dd5e27b5c8b23476881add8df2f24ed9afc8546d21f
 SHA512:
-  metadata.gz: bbfd0d2f80f9610ebcca20c3ce574fbad97a8639cb39db73cfc1fb0611c3f4612714a5050d88e3762686ca98d8305a15cf444381cfbf4bfdb7018b3ec2b8a971
-  data.tar.gz: 2df4253529a69a7d80d8100108dd997f35de16a9fb18446da3c4d646de797c641e524ce372a7ec6f17c0ad8e8704a552cddbb28c76aa9d03d17073c8d2b7c613
+  metadata.gz: dd995bff0e655b7011998377eb30f5a6ff8d615481a469332efad4c2ac2fbab33f06d604664d5e89f4b737c7f305a3f97e9d8bca314a28a112d39bd8e2efdb78
+  data.tar.gz: 6fdbd6f6a9d8ae5c3eb1db554c233fc9b57e7fef2d213e8f313055b6f377645ee7600a7fd97d762905a8360289cfa1846200933f8fb4f4df63996811fd4bf1aa

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    enfcli (3.5.0)
+    enfcli (3.5.2.pre.alpha)
       rest-client (~> 2.0)
       terminal-table
       thor (~> 0.20.0)
@@ -78,4 +78,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/lib/enfapi.rb

@@ -187,7 +187,7 @@ module EnfApi
 
   ##############################################################################
   #
-  # Captive 
+  # Captive
   #
   ##############################################################################
   class Captive
@@ -212,7 +212,7 @@ module EnfApi
       EnfApi::API.instance.get url
     end
 
-    # Update an existing wifi configuration 
+    # Update an existing wifi configuration
     ## NO_TEST
     def update_wifi_configuration(wifi_id, updated_wifi_config)
       json = EnfApi::to_json(updated_wifi_config)
@@ -241,6 +241,12 @@ module EnfApi
         EnfApi::API.instance.get "/api/captive/v1/device/#{dev_id}"
     end
 
+    # Get the status of a device
+    ## NO_TEST
+    def get_device_status(dev_id)
+      EnfApi::API.instance.get "/api/captive/v1/device/#{dev_id}/status"
+    end
+
     # Post the new profile
     ## NO_TEST
     def create_profile(new_profile_hash)
@@ -271,7 +277,7 @@ module EnfApi
       EnfApi::API.instance.put "/api/captive/v1/profile/#{id}", json
     end
   end
-  
+
   class NetworkManager
     include Singleton
   end
@@ -536,6 +542,10 @@ module EnfApi
           # api returns and error
           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))
+
         else
           raise EnfApi::ERROR, "Unexpected error! Please try again!"
         end

data/lib/enfcli/commands/captive.rb

@@ -197,6 +197,20 @@ module EnfCli
         end
       end
 
+      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.'
+      def get_device_status
+        try_with_rescue_in_session do
+          device_id = options[:'device-id']
+          status = EnfApi::Captive.instance.get_device_status device_id
+
+          display_device_status status
+        end
+      end
+
       desc 'create-profile',
            'Create a new profile.'
       method_option :'profile-name', type: :string, required: true,
@@ -311,33 +325,37 @@ module EnfCli
         # Display a single wifi configuration in detail
         def display_wifi_detail(wifi_data)
           name = wifi_data[:name]
+          name = "\n" unless name
           wifi_id = wifi_data[:id]
           desc = wifi_data[:description]
-          configs = wifi_data[:config]
+          desc = "\n" unless desc
+          nets = wifi_data[:networks]
 
           say "Wifi ID       : #{wifi_id}"
           say "Name          : #{name}"
           say "Description   : #{desc}"
           say "WiFi Networks :"
-          configs.each do |wifi_net|
-            display_wifi_net(wifi_net, 1)
+          if nets
+            nets.each do |wifi_net|
+              display_wifi_net(wifi_net, 1)
+            end
           end
 
         end
 
         def display_wifi_net(wifi_net, tabs)
           indent = "    " * tabs
-          say "Name          : #{wifi_net[:name]}"
-          say indent + "SSID          :#{wifi_net[:SSID]}"
-          say indent + "SSID type     :#{wifi_net[:SSID_type]}"
+          say indent + "Name          : #{wifi_net[:name]}"
+          say indent + "    SSID          :#{wifi_net[:SSID]}"
+          say indent + "    SSID type     :#{wifi_net[:SSID_type]}"
 
           auth = wifi_net[:auth]
           if auth
-            say indent + "auth          :#{auth[:type]}"
+            say indent + "    auth          :#{auth[:type]}"
           end
 
-          display_ipv4_addr(wifi_net[:IPv4], tabs)
-          display_ipv6_addr(wifi_net[:IPv6], tabs)
+          display_ipv4_addr(wifi_net[:IPv4], tabs + 1)  # these are subelements, so indent 1 more.
+          display_ipv6_addr(wifi_net[:IPv6], tabs + 1)
         end
 
         def display_ipv4_addr (ipv4, tabs)
@@ -398,16 +416,19 @@ module EnfCli
           dev_addr = device_data[:device_address]
           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
           status = device_data[:status]
+          status = '< not available >' unless status
 
           say "Serial Number     : #{device_data[:serial_number]}"
           say "Device Name       : #{name}"
-          say "Control Address   : #{ctl_addr}"
+          say "Control Address   : #{ctl_addr}" if ctl_addr
           say "Device Address    : #{dev_addr}"
           say 'Mac Address       :'
           if mac_addrs
-            say "              1   : #{mac_addrs[:wifi]}"
+            say "              1   : #{mac_addrs[:'1']}"
             say "              2   : #{mac_addrs[:'2']}"
             say "              3   : #{mac_addrs[:'3']}"
             say "              4   : #{mac_addrs[:'4']}"
@@ -415,6 +436,50 @@ module EnfCli
           say "Firmware Version  : #{firmware}"
           say "Profile ID        : #{profile_id}"
           say "Status            : #{status}"
+          say ''
+        end
+
+        #
+        # display the status of the device.
+        # status is a hash matching the json structure
+        #
+        def display_device_status(device_status)
+          sn = device_status[:serial_number]
+          mode = device_status[:router_mode]
+          uptime = device_status[:uptime]
+          refresh = device_status[:refresh_time]
+          connected = device_status[:wifi][:connected]
+          ssid = device_status[:wifi][:SSID]
+          ipv4 = device_status[:wifi][:IPv4_addresses]
+          ipv6 = device_status[:wifi][: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}"
+          say "WIFI                 :"
+          say "    connected        : #{connected}"
+          say "    SSID             : #{ssid}"
+          if ipv4
+            say "    IPv4 addresses   :"
+            ipv4.each do |addr|
+              display_ipv4_addr(addr, 2)
+            end
+          end
+
+          if ipv6
+            say "    IPv6 addresses   :"
+            ipv6.each do |addr|
+              display_ipv6_addr(addr, 2)
+            end
+          end
+
+          if wifi
+            display_wifi_detail(wifi)
+          end
+
+          say ''
         end
 
         #

data/lib/enfcli/commands/user.rb

@@ -17,7 +17,7 @@ require 'enfthor'
 require 'enfapi'
 
 module EnfCli
-  
+
   module Cmd
 
     class User < EnfThor
@@ -30,7 +30,7 @@ module EnfCli
 
           render_table(headings, rows)
         end
-        
+
         def display_users users
           headings = ['User Name', 'Full Name', 'Last Login', 'Type', 'Reset Code', 'Reset Time']
           rows = users.map{ |hash|
@@ -39,34 +39,13 @@ module EnfCli
           render_table(headings, rows)
         end
 
-        def send_invite options, user_type          
+        def send_invite options, user_type
           # Get options
           domain_network = options.domain
-        
-          # Get user role
-          user_role = EnfCli::CTX.instance.session[:type]
-
-          # check user roles
-          if user_role == "XAPTUM_ADMIN"
-            # make sure that a domain is specified in domain option for XAPTUM_ADMIN 
-            raise EnfCli::ERROR, "No domain specified. Please use --domain option!" unless domain_network
-          else
-            # use the domain network of the user
-            domain_network = EnfCli::CTX.instance.session[:domain_network]
-            raise EnfCli::ERROR, "User not in a valid domain!" unless domain_network          
-          end
 
           # get params
-          case user_type
-          when "DOMAIN_USER"
-            name = options[:'name'].join(" ").gsub(/\A"+(.*?)"+\Z/m, '\1')
-            email = options[:'email']
-
-          when "DOMAIN_ADMIN"
-            name = options[:'admin-name'].join(" ").gsub(/\A"+(.*?)"+\Z/m, '\1')
-            email = options[:'admin-email']
-            
-          end
+          name = options[:'name'].join(" ").gsub(/\A"+(.*?)"+\Z/m, '\1')
+          email = options[:'email']
 
           # call api
           hash = { :email => email, :full_name => name, :welcome_text => "", :user_type => user_type }
@@ -82,21 +61,95 @@ module EnfCli
       method_option :'email', :type => :string, :required => true, :banner => "EMAIL"
       def invite_read_only_user
         try_with_rescue_in_session do
-          send_invite options, "DOMAIN_USER"                             
+          # use the domain network of the user
+          domain_network = EnfCli::CTX.instance.session[:domain_network]
+          raise EnfCli::ERROR, "User not in a valid domain!" unless domain_network
+
+          # Get user role
+          user_role = EnfCli::CTX.instance.session[:type]
+
+          # check user roles
+          if user_role == "XAPTUM_ADMIN"
+            domain_network = options[:domain] if options[:domain]
+          else
+            say "Warning: Ignoring command option --domain #{options[:domain]}", :yellow if options[:domain]
+          end
+
+          send_invite options, "DOMAIN_USER"
         end
       end
 
-      desc "invite-admin-user", "Invite a domain administrator"
+      desc "invite-domain-admin-user", "Invite a domain administrator"
       method_option :domain, :default => nil, :type => :string, :aliases => "-d"
-      method_option :'admin-name', :type => :array, :required => true, :banner => "NAME"
-      method_option :'admin-email', :type => :string, :required => true, :banner => "EMAIL"
-      def invite_admin_user
+      method_option :'name', :type => :array, :required => true, :banner => "NAME"
+      method_option :'email', :type => :string, :required => true, :banner => "EMAIL"
+      def invite_domain_admin_user
         try_with_rescue_in_session do
-          send_invite options, "DOMAIN_ADMIN"                             
+          # use the domain network of the user
+          domain_network = EnfCli::CTX.instance.session[:domain_network]
+          raise EnfCli::ERROR, "User not in a valid domain!" unless domain_network
+
+          # Get user role
+          user_role = EnfCli::CTX.instance.session[:type]
+
+          # check user roles
+          if user_role == "XAPTUM_ADMIN"
+            domain_network = options[:domain] if options[:domain]
+          else
+            say "Warning: Ignoring command option --domain #{options[:domain]}", :yellow if options[:domain]
+          end
+
+          send_invite options, "DOMAIN_ADMIN"
         end
       end
 
-      
+      desc "invite-enf-admin-user", "Invite an ENF administrator"
+      method_option :'name', :type => :array, :required => true, :banner => "NAME"
+      method_option :'email', :type => :string, :required => true, :banner => "EMAIL"
+      def invite_enf_admin_user
+        try_with_rescue_in_session do
+          # Get user role
+          user_role = EnfCli::CTX.instance.session[:type]
+
+          raise EnfCli::ERROR, "Only ENF Administrators can invite ENF Administrator" unless user_role == "XAPTUM_ADMIN"
+
+          options[:domain] = EnfCli::CTX.instance.session[:domain_network]
+          send_invite options, "XAPTUM_ADMIN"
+        end
+      end
+
+      desc "invite-iam-admin-user", "Invite an IAM administrator"
+      method_option :'name', :type => :array, :required => true, :banner => "NAME"
+      method_option :'email', :type => :string, :required => true, :banner => "EMAIL"
+      def invite_iam_admin_user
+        try_with_rescue_in_session do
+          # Get user role
+          user_role = EnfCli::CTX.instance.session[:type]
+
+          raise EnfCli::ERROR, "Only ENF Administrators can invite IAM Administrator" unless user_role == "XAPTUM_ADMIN"
+
+          options[:domain] = EnfCli::CTX.instance.session[:domain_network]
+          send_invite options, "IAM_ADMIN"
+        end
+      end
+
+      desc "invite-captive-admin-user", "Invite a captive administrator"
+      method_option :'captive-domain', :type => :string, :required => true, :banner => "CAPTIVE CONTROL DOMAIN"
+      method_option :'name', :type => :array, :required => true, :banner => "NAME"
+      method_option :'email', :type => :string, :required => true, :banner => "EMAIL"
+      def invite_captive_admin_user
+        try_with_rescue_in_session do
+          # Get user role
+          user_role = EnfCli::CTX.instance.session[:type]
+
+          raise EnfCli::ERROR, "Only ENF Administrators can invite CAPTIVE Administrator" unless user_role == "XAPTUM_ADMIN"
+
+          options[:domain] = options[:'captive-domain']
+          send_invite options, "CAPTIVE_ADMIN"
+        end
+      end
+
+
       desc "cancel-user-invite", "Cancel an invite"
       method_option :email, :type => :string, :required => true
       def cancel_user_invite
@@ -120,25 +173,23 @@ module EnfCli
           say "Resent invite email!", :green
         end
       end
-      
-      desc "list-domain-invites", "List domain invites"
+
+      desc "list-invites", "List user invites"
       method_option :domain, :default => nil, :type => :string, :aliases => "-d"
-      def list_domain_invites
+      def list_invites
         try_with_rescue_in_session do
-          # Get options
-          domain_network = options.domain
-        
+          # use the domain network of the user
+          domain_network = EnfCli::CTX.instance.session[:domain_network]
+          raise EnfCli::ERROR, "User not in a valid domain!" unless domain_network
+
           # Get user role
           user_role = EnfCli::CTX.instance.session[:type]
 
           # check user roles
           if user_role == "XAPTUM_ADMIN"
-            # make sure that a domain is specified in domain option for XAPTUM_ADMIN 
-            raise EnfCli::ERROR, "No domain specified. Please use --domain option!" unless domain_network
+            domain_network = options[:domain] if options[:domain]
           else
-            # use the domain network of the user
-            domain_network = EnfCli::CTX.instance.session[:domain_network]
-            raise EnfCli::ERROR, "User not in a valid domain!" unless domain_network          
+            say "Warning: Ignoring command option --domain #{options[:domain]}", :yellow if options[:domain]
           end
 
           # call the api
@@ -147,26 +198,24 @@ module EnfCli
 
           display_invites invites
         end
-      end      
+      end
 
-      desc "list-domain-users", "List domain users"
+      desc "list-users", "List users"
       method_option :domain, :default => nil, :type => :string, :aliases => "-d"
-      def list_domain_users
+      def list_users
         try_with_rescue_in_session do
-          # Get options
-          domain_network = options.domain
-        
+          # use the domain network of the user
+          domain_network = EnfCli::CTX.instance.session[:domain_network]
+          raise EnfCli::ERROR, "User not in a valid domain!" unless domain_network
+
           # Get user role
           user_role = EnfCli::CTX.instance.session[:type]
 
           # check user roles
           if user_role == "XAPTUM_ADMIN"
-            # make sure that a domain is specified in domain option for XAPTUM_ADMIN 
-            raise EnfCli::ERROR, "No domain specified. Please use --domain option!" unless domain_network
+            domain_network = options[:domain] if options[:domain]
           else
-            # use the domain network of the user
-            domain_network = EnfCli::CTX.instance.session[:domain_network]
-            raise EnfCli::ERROR, "User not in a valid domain!" unless domain_network          
+            say "Warning: Ignoring command option -d #{options[:domain]}", :yellow if options[:domain]
           end
 
           # call the api
@@ -177,9 +226,9 @@ module EnfCli
         end
       end
 
-      
+
     end
-    
+
   end
 
 end

data/lib/enfcli/commands/xdns.rb

@@ -278,7 +278,8 @@ module EnfCli
 
       desc "create-record", "Create a DNS record"
       method_option :'zone-id', :type => :string, :required => true
-      method_option :name, :type => :string, :required => true
+      method_option :name, :type => :string, :required => true, :banner => '<name>',
+                    :desc => '<name> is DNS record name. Enter . to create a record with the zone domain name'
       method_option :'type',  :type => :string, :required => true, :enum => DnsRecordTypes
       method_option :ttl, :type => :numeric, :required => true
       method_option :value, :type => :array, :required => true, :banner => 'VALUE'

data/lib/enfcli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enfcli
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.5.2.pre.alpha
 platform: ruby
 authors:
 - Venkatakumar Srinivasan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-09 00:00:00.000000000 Z
+date: 2019-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -209,9 +209,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.1
 signing_key: