wifi-wand 2.19.0 → 2.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3d9a52dffd83c2be845f91172481ee2df4c140d188c3374573f9c76cb43d199
-  data.tar.gz: 2962e28498baa51617b5ec42b65304065c1e4aaafd109f2de3e3da1ba8ffde30
+  metadata.gz: f6064b0904166cac0ccc9768c6bd385f422616d42418e6c42db8f38235fde354
+  data.tar.gz: 07a0a469d659dd82a5fbb80562dfbef16629aa2344ca22134e1f92c585717cac
 SHA512:
-  metadata.gz: 23a13c3964972c417dd20131718cb5614ad5a1bfccdd30ee2a52173fd0761ebe40981bd4b11e6c8808dfb3aaefc0a0178ccd8fad8d247fd6413776676af5bf3e
-  data.tar.gz: 603dbd8e5eb821df3b42112eac3c5ba92b92e953a2913a56b813190491a69b8a4a91172a2963b05f350bf65340bd007332f63e0e94601130862316970cfafeef
+  metadata.gz: 4366219cfc3d754a69f21055ee489e2e458d7d969f6103353b203acbf8bc2d3419389288e90dc039c350f77bb8dbe90d8821e61e884fa8098483036810a7f9eb
+  data.tar.gz: cd4fe96013c357f5cea0e09d740ef723a460c046b0f8f48d2726b957675e87f305455a6f46f91d38d50b49c27ba87c8a7b7cdb39c55333a02e60cd689b0dc1b7

data/RELEASE_NOTES.md

@@ -1,8 +1,21 @@
+## v2.20.0
+
+* Change detect_wifi_interface and available_network_names to use system_profiler JSON output.
+* Previously, detect_wifi_interface parsed human readable text; parsing JSON is more reliable.
+* Previously, available_network_names used Swift and CoreLAN and required XCode installation.
+
+
+## v2.19.1
+
+* Fix connected_network_name when wifi is on but no network is connected.
+
+
 ## v2.19.0
 
 * Replace `networksetup` with Swift script for connecting to a network.
 * For getting connected network name, replace `networksetup` with `ipconfig`. 
 
+
 ## v2.18.0
 
 * Remove 'hotspot_login_required' informational item and logic (was not working correctly).

data/lib/wifi-wand/command_line_interface.rb

@@ -219,9 +219,17 @@ When in interactive shell mode:
       if post_processor
         puts post_processor.(info)
       else
-        puts model.wifi_on? \
-            ? "Available networks are:\n\n#{fancy_string(info)}" \
-            : "Wifi is off, cannot see available networks."
+        message = if model.wifi_on?
+          <<~MESSAGE
+            Available networks, in descending signal strength order, 
+            and not including any currently connected network, are:
+  
+            #{fancy_string(info)}"
+          MESSAGE
+        else
+          "Wifi is off, cannot see available networks."
+        end
+        puts message
       end
     end
   end

data/lib/wifi-wand/models/base_model.rb

@@ -14,17 +14,16 @@ class BaseModel
   def initialize(options)
     @verbose_mode = options.verbose
 
-    if options.wifi_interface && (! is_wifi_interface?(options.wifi_interface))
-      raise Error.new("#{options.wifi_interface} is not a Wi-Fi interface.")
+    if options.wifi_interface
+      if is_wifi_interface?(options.wifi_interface)
+        @wifi_interface = options.wifi_interface
+      else
+        raise Error.new("#{options.wifi_interface} is not a Wi-Fi interface.")
+      end
     end
-    @wifi_interface = options.wifi_interface
   end
 
-
-
-
   def run_os_command(command, raise_on_error = true)
-
     if verbose_mode
       puts CommandOutputFormatter.command_attempt_as_string(command)
     end
@@ -46,16 +45,15 @@ class BaseModel
 
 
   # This method returns whether or not there is a working Internet connection,
-  # which is defined as name resolution and HTTP get being successful.
-  # Domains attempted are google.com and baidu.com. Success is either being successful.
+  # which is defined as success for both name resolution and an HTTP get.
+  # Domains attempted are google.com and baidu.com.
+  # Success is defined as either being successful.
   # Commands for the multiple sites are run in parallel, in threads, to save time.
   def connected_to_internet?
-    return nil unless wifi_on? # no need to try
+    return false unless wifi_on? # no need to try
 
     # We cannot use run_os_command for the running of external processes here,
     # because they are multithreaded, and the output will get mixed up.
-
-    # First pass to fail quickly if name resolving does not work.
     test_using_dig = -> do
       domains = %w(google.com  baidu.com)
       puts "Calling dig on domains #{domains}..." if verbose_mode
@@ -185,8 +183,8 @@ class BaseModel
   # @param wait_interval_in_secs sleeps this interval between retries; if nil or absent,
   #        a default will be provided
   #
+  # Connected is defined as being able to connect to an external web site.
   def till(target_status, wait_interval_in_secs = nil)
-
     # One might ask, why not just put the 0.5 up there as the default argument.
     # We could do that, but we'd still need the line below in case nil
     # was explicitly specified. The default argument of nil above emphasizes that
@@ -217,7 +215,7 @@ class BaseModel
   # Tries an OS command until the stop condition is true.
   # @command the command to run in the OS
   # @stop_condition a lambda taking the command's stdout as its sole parameter
-  # @return the stdout produced by the command
+  # @return the stdout produced by the command, or nil if max_tries was reached
   def try_os_command_until(command, stop_condition, max_tries = 100)
 
     report_attempt_count = ->(attempt_count) do
@@ -225,10 +223,10 @@ class BaseModel
     end
 
     max_tries.times do |n|
-      stdout = run_os_command(command)
-      if stop_condition.(stdout)
+      stdout_text = run_os_command(command)
+      if stop_condition.(stdout_text)
         report_attempt_count.(n + 1)
-        return stdout
+        return stdout_text
       end
     end
 

data/lib/wifi-wand/models/mac_os_model.rb

@@ -16,7 +16,7 @@ class MacOsModel < BaseModel
 
   # Identifies the (first) wireless network hardware interface in the system, e.g. en0 or en1
   # This may not detect wifi ports with nonstandard names, such as USB wifi devices.
-  def detect_wifi_interface
+  def detect_wifi_interface_using_networksetup
 
     lines = run_os_command("networksetup -listallhardwareports").split("\n")
     # Produces something like this:
@@ -39,10 +39,34 @@ class MacOsModel < BaseModel
     end
   end
 
+  # Identifies the (first) wireless network hardware interface in the system, e.g. en0 or en1
+  # This may not detect wifi ports with nonstandard names, such as USB wifi devices.
+  def detect_wifi_interface
+    json_text = run_os_command('system_profiler -json SPNetworkDataType')
+    net_data = JSON.parse(json_text)
+    nets = net_data['SPNetworkDataType']
+    wifi = nets.detect { |net| net['_name'] == 'Wi-Fi'}
+    wifi['interface']
+  end
+
+  # Returns the network names sorted in descending order of signal strength.
   def available_network_names
     return nil unless wifi_on? # no need to try
 
-    run_swift_command('AvailableWifiNetworkLister').split("\n")
+    # run_swift_command('AvailableWifiNetworkLister').split("\n").uniq
+
+    json_text = run_os_command('system_profiler -json SPAirPortDataType')
+    data = JSON.parse(json_text)
+
+    inner_key = connected_network_name ? 'spairport_airport_other_local_wireless_networks' : 'spairport_airport_local_wireless_networks'
+
+    nets = data['SPAirPortDataType'] \
+       .detect { |h| h.key?('spairport_airport_interfaces') } \
+        ['spairport_airport_interfaces'] \
+       .detect { |h| h['_name'] == wifi_interface } \
+        [inner_key] \
+        .sort_by { |net| -net['spairport_signal_noise'].split('/').first.to_i }
+    nets.map { |h| h['_name']}.uniq
   end
 
 
@@ -163,7 +187,7 @@ class MacOsModel < BaseModel
     return nil unless wifi_on? # no need to try
 
     command_output = run_os_command("ipconfig getsummary #{wifi_interface} | grep ' SSID :'", false)
-    return nil if command_output.nil?
+    return nil if command_output.empty?
 
     command_output.split('SSID :').last.strip
   end

data/lib/wifi-wand/version.rb

@@ -1,3 +1,3 @@
 module WifiWand
-  VERSION = '2.19.0' unless defined?(VERSION)
+  VERSION = '2.20.0' unless defined?(VERSION)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wifi-wand
 version: !ruby/object:Gem::Version
-  version: 2.19.0
+  version: 2.20.0
 platform: ruby
 authors:
 - Keith Bennett