wifi-wand 2.15.0 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51d32000847efd2e81288f34905ef2622d875d460b3f4bd3f3a823a7bfc53ff5
-  data.tar.gz: 9a9bd05cac4003f148387c877a2e47cf37cea9fdd793cc848e3e5b01a6bc0887
+  metadata.gz: 4729288451e02d7b968dac5ef6bfd703383e3e7a759386ae6b74d82527e2dea6
+  data.tar.gz: '085c16eba0b518c4be31609cfd8847788f8d0e0985ae9b167c41585c66a18182'
 SHA512:
-  metadata.gz: 6c82d035c66e289ff335f774313fde6a9bfec1bf403dc4f71f375d2ea825ebb12b0c265e27ee61361455466606ccfb898c9ab7588efde854a909f9bc1a023224
-  data.tar.gz: f75163a1ec497cf8010ddd28306cd4d1c621042c4af6e6835d55aeaad20f2751d8ad6c9f479c748fe26c65259d3c19015200612aa297349db3b59d4df0dcfb16
+  metadata.gz: 83b47a2b64ba1a6b436f38c7da2f546156076891cb73fae03a6b90f57b72119c4d6affd25bff7bac42523fd0e4abfcbf45eb9fb7363739cc9641a7992881fdad
+  data.tar.gz: 365bd3f24ed79803b100ab0785c16a4257dadb18c25f9a8a6c0617eda4e4bba8786104000c559d24932bffc6cda95e428bf617b1c39b50db675b87a8170eabed

data/LICENSE.txt

@@ -1,22 +1,201 @@
-Copyright (c) 2017 Keith Bennett
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 Bennett Business Solutions, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -69,6 +69,15 @@ When in interactive shell mode:
 Internally, it uses several Mac command line utilities to interact with the
 underlying operating system.
 
+> [!WARNING]  
+> Starting in Mac OS version 14.4, the `airport` utility on which some of this project's
+> functionality relies has been disabled and will presumably eventually be removed.
+> 
+> The following commands will result in a runtime error if `airport` is no longer available:
+> 
+> * listing names of available wifi networks
+> * listing detailed information about available wifi networks
+> * disconnecting from a wifi network
 
 ### Pretty Output
 
@@ -359,6 +368,11 @@ wifi-wand  connect  my-usual-network  its-password
 
 MIT License (see LICENSE.txt)
 
+### Logo
+
+Logo designed and generously contributed by Anhar Ismail (Github: [@anharismail](https://github.com/anharismail), Twitter: [@aizenanhar](https://twitter.com/aizenanhar)).
+
+
 ### Shameless Ad
 
 I am available for consulting, development, tutoring, training, troubleshooting, etc.

data/RELEASE_NOTES.md

@@ -1,3 +1,24 @@
+## v2.16.0 (2024-04)
+
+* Handle deprecation of the `airport` command starting at Mac OS 14.4.
+* Add hotspot_login_required functionality.
+* Change 'port' to 'interface' in some names.
+* Add to external resources: captive.apple.com, librespeed.org
+* Change license from MIT to Apache 2.
+
+
+## v2.15.2
+
+* Improve support for 'hotspot login required'.
+* Add 'hotspot_login_required' field to info hash, & on connect, opens captive.aple.com page if needed.
+* Change license from MIT to Apache 2.
+
+
+## v2.15.1
+
+* Fix bug; when calling connect with an SSID with leading spaces, a warning was erroneously issued about the SSID.
+
+
 ## v2.15.0
 
 * Allow using symbols in the 'nameservers' subcommands.

data/{spec → integration-tests}/wifi-wand/models/mac_os_model_spec.rb

@@ -54,9 +54,9 @@ describe MacOsModel do
       subject.connected_to_internet?
     end
 
-    it 'can get wifi port' do
+    it 'can get wifi interface' do
       wifi_starts_on ? subject.wifi_on : subject.wifi_off
-      subject.wifi_port
+      subject.wifi_interface
     end
 
     it 'can list info' do

data/lib/wifi-wand/command_line_interface.rb

@@ -1,3 +1,4 @@
+require 'awesome_print'
 require_relative 'operating_systems'
 require 'ostruct'
 require_relative 'error'
@@ -43,8 +44,10 @@ class CommandLineInterface
   end
 
   OPEN_RESOURCES = OpenResources.new([
+      OpenResource.new('cap',  'https://captive.apple.com/',                'Portal Logins'),
       OpenResource.new('ipl',  'https://www.iplocation.net/',               'IP Location'),
       OpenResource.new('ipw',  'https://www.whatismyip.com',                'What is My IP'),
+      OpenResource.new('libre','https://www.librespeed.org',                'LibreSpeed'),
       OpenResource.new('spe',  'http://speedtest.net/',                     'Speed Test'),
       OpenResource.new('this', 'https://github.com/keithrbennett/wifiwand', 'wifi-wand home page'),
   ])
@@ -55,7 +58,7 @@ class CommandLineInterface
 Command Line Switches:                    [wifi-wand version #{WifiWand::VERSION} at https://github.com/keithrbennett/wifiwand]
 
 -o {i,j,k,p,y}            - outputs data in inspect, JSON, pretty JSON, puts, or YAML format when not in shell mode
--p wifi_port_name         - override automatic detection of port name with this name
+-p wifi_interface_name    - override automatic detection of interface name with this name
 -s                        - run in shell mode
 -v                        - verbose mode (prints OS commands and their outputs)
 
@@ -93,18 +96,19 @@ When in interactive shell mode:
 "
 
   def initialize(options)
-    @options = options
     current_os = OperatingSystems.new.current_os
-    raise Error.new("Could not determine operating system") if current_os.nil?
+    if current_os.nil?
+      puts "This application currently runs only on Mac OS."
+      exit(1)
+    end
+
+    @options = options
+
     model_options = OpenStruct.new({
-        verbose:   options.verbose,
-        wifi_port: options.wifi_port
+      verbose:        options.verbose,
+      wifi_interface: options.wifi_interface
     })
 
-    unless awesome_print_available?
-      HELP_TEXT << "For nicer output, `gem install awesome_print`.\n\n"
-    end
-
     @model = current_os.create_model(model_options)
     @interactive_mode = !!(options.interactive_mode)
     run_shell if @interactive_mode
@@ -121,27 +125,8 @@ When in interactive shell mode:
   end
 
 
-  # @return true if awesome_print is available (after requiring it), else false after requiring 'pp'.
-  # We'd like to use awesome_print if it is available, but not require it.
-  # So, we try to require it, but if that fails, we fall back to using pp (pretty print),
-  # which is included in Ruby distributions without the need to install a gem.
-  def awesome_print_available?
-    if @awesome_print_available.nil?  # first time here
-      begin
-        require 'awesome_print'
-        @awesome_print_available = true
-      rescue LoadError
-        require 'pp'
-        @awesome_print_available = false
-      end
-    end
-
-    @awesome_print_available
-  end
-
-
   def fancy_string(object)
-    awesome_print_available? ? object.ai : object.pretty_inspect
+    object.awesome_inspect
   end
 
 
@@ -161,30 +146,11 @@ When in interactive shell mode:
   end
 
 
-  # Pry will output the content of the method from which it was called.
-  # This small method exists solely to reduce the amount of pry's output
-  # that is not needed here.
-  def run_pry
-    binding.pry
-
-    # the seemingly useless line below is needed to avoid pry's exiting
-    # (see https://github.com/deivid-rodriguez/pry-byebug/issues/45)
-    _a = nil
-  end
-
-
   # Runs a pry session in the context of this object.
   # Commands and options specified on the command line can also be specified in the shell.
   def run_shell
-    begin
-      require 'pry'
-    rescue LoadError
-      message = "The 'pry' gem and/or one of its prerequisites, required for running the shell, was not found." +
-          " Please `gem install pry` or, if necessary, `sudo gem install pry`."
-      raise Error.new(message)
-    end
-
     print_help
+    require 'pry'
 
     # Enable the line below if you have any problems with pry configuration being loaded
     # that is messing up this runtime use of pry:
@@ -195,7 +161,7 @@ When in interactive shell mode:
     # a pry command from a DSL command, which _is_ useful here.
     Pry.config.command_prefix = '%'
 
-    run_pry
+    binding.pry
   end
 
 
@@ -385,7 +351,13 @@ When in interactive shell mode:
 
   # Use Mac OS 'open' command line utility
   def cmd_ro(*resource_codes)
+    if resource_codes.empty?
+      puts "Please specify a resource to open:\n #{OPEN_RESOURCES.help_string.gsub(',', "\n")}"
+      return
+    end
+
     resource_codes.each do |code|
+      code = code.to_s  # accommodate conversion of parameter from other types, esp. symbols
       resource = OPEN_RESOURCES.find_by_code(code)
       if resource
         if code == 'spe' && Dir.exist?('/Applications/Speedtest.app/')
@@ -524,4 +496,4 @@ When in interactive shell mode:
     end
   end
 end
-end
+end

data/lib/wifi-wand/main.rb

@@ -46,8 +46,8 @@ class Main
         options.post_processor = formatters[choice]
       end
 
-      parser.on("-p", "--wifi-port PORT", "WiFi port name") do |v|
-        options.wifi_port = v
+      parser.on("-p", "--wifi-interface interface", "WiFi interface name") do |v|
+        options.wifi_interface = v
       end
 
       parser.on("-h", "--help", "Show help") do |_help_requested|
@@ -64,9 +64,8 @@ class Main
     begin
       WifiWand::CommandLineInterface.new(options).call
     rescue => e
-      # require 'pry'; binding.pry
       puts "Error: #{e.backtrace.join("\n")}\n\n#{e.message}"
     end
   end
 end
-end
+end

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

@@ -4,13 +4,12 @@ require 'tempfile'
 require 'uri'
 require_relative 'helpers/command_output_formatter'
 require_relative '../error'
-require_relative '../../wifi-wand'
 
 module WifiWand
 
 class BaseModel
 
-  attr_accessor :wifi_port, :verbose_mode
+  attr_accessor :wifi_interface, :verbose_mode
 
   class OsCommandError < RuntimeError
     attr_reader :exitstatus, :command, :text
@@ -34,10 +33,10 @@ class BaseModel
   def initialize(options)
     @verbose_mode = options.verbose
 
-    if options.wifi_port && (! is_wifi_port?(options.wifi_port))
-      raise Error.new("#{options.wifi_port} is not a Wi-Fi interface.")
+    if options.wifi_interface && (! is_wifi_interface?(options.wifi_interface))
+      raise Error.new("#{options.wifi_interface} is not a Wi-Fi interface.")
     end
-    @wifi_port = options.wifi_port
+    @wifi_interface = options.wifi_interface
   end
 
 
@@ -102,16 +101,16 @@ class BaseModel
         Thread.new do
           url = URI.parse(site)
           success = true
+          start = Time.now
 
           begin
             Net::HTTP.start(url.host) do |http|
-              start = Time.now
               http.read_timeout = 3 # seconds
               http.get('.')
-              duration = Time.now - start
-              puts "Finished HTTP get #{url.host} in #{duration} seconds" if verbose_mode
+              puts "Finished HTTP get #{url.host} in #{Time.now - start} seconds" if verbose_mode
             end
-          rescue
+          rescue => e
+            puts "Got error for host #{url.host} in #{Time.now - start} seconds:\n#{e.inspect}" if verbose_mode
             success = false
           end
 
@@ -131,6 +130,13 @@ class BaseModel
   end
 
 
+  def hotspot_login_required
+    response_text = run_os_command('curl --max-time 3 http://captive.apple.com', false)
+    required = ['Error', '302', 'Hotspot login required'].all? { |s| response_text.include?(s) }
+    required
+  end
+
+
   # Turns wifi off and then on, reconnecting to the originally connecting network.
   def cycle_network
     # TODO: Make this network name saving and restoring conditional on it not having a password.
@@ -164,7 +170,13 @@ class BaseModel
 
     # Verify that the network is now connected:
     actual_network_name = connected_network_name
-    unless actual_network_name == network_name
+
+    if actual_network_name == network_name
+      if hotspot_login_required
+        puts "Hotspot login required. Opening browser to captive.apple.com."
+        `open https://captive.apple.com`
+      end
+    else
       message = %Q{Expected to connect to "#{network_name}" but }
       if actual_network_name.nil? || actual_network_name.empty?
         message << "unable to connect to any network."
@@ -271,8 +283,8 @@ class BaseModel
   end
 
 
-  def wifi_port
-    @wifi_port ||= detect_wifi_port
+  def wifi_interface
+    @wifi_interface ||= detect_wifi_interface
   end
 end
-end
+end

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

@@ -6,36 +6,76 @@ require 'shellwords'
 require_relative 'base_model'
 require_relative '../error'
 
+# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+# 2024-04-18:
+#
+# Apple has deprecated the 'airport' utility and has already disabled its
+# functionality. This utility is used for the following wifi-wand commands:
+
+# 1) cmd: info, fn: wifi_info - adds information to the info output
+# 2) cmd: avail_nets, fn: available_network_names - available wifi network names
+# 3) cmd: ls_avail_nets, fn: available_network_info - available wifi networks details
+# 4) cmd: wifi_on, fn: wifi_on?
+# 5) cmd: network_name, fn: connected_network_name
+# 6) cmd: disconnect, fn: disconnect
+
+# Functions 4 and 5 have been fixed to use `networksetup` instead of `airport`.
+# The others are not yet fixed.
+
+# An AskDifferent (Mac StackExchange site) question has been posted to
+# https://apple.stackexchange.com/questions/471886/how-to-replace-functionality-of-deprecated-airport-command-line-application.
+# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
 module WifiWand
 
 class MacOsModel < BaseModel
 
-  AIRPORT_CMD = '/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport'
+  DEFAULT_AIRPORT_FILESPEC = '/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport'
+
+  attr_reader :airport_deprecated, :mac_os_version_major, :mac_os_version_minor, :mac_os_version_string
 
-  # Takes an OpenStruct containing options such as verbose mode and port name.
+  # Takes an OpenStruct containing options such as verbose mode and interface name.
   def initialize(options = OpenStruct.new)
     super
+    populate_mac_os_version
+    @airport_deprecated = @mac_os_version_major > 14 || (@mac_os_version_major == 14 && @mac_os_version_minor >= 4)
+  end
+
+  # Provides Mac OS major and minor version numbers
+  def populate_mac_os_version
+    @mac_os_version_string = `sw_vers --productVersion`.chomp
+    @mac_os_version_major, @mac_os_version_minor = mac_os_version_string.split('.').map(&:to_i)
+    [@mac_os_version_major, @mac_os_version_minor]
   end
 
+  def airport_deprecated_message
+    <<~MESSAGE
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      This method requires the airport utility which is no longer functional in Mac OS >= 14.4.
+      You are running Mac OS version #{mac_os_version_string}.
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+    MESSAGE
+  end
 
   # Although at this time the airport command utility is predictable,
   # allow putting it elsewhere in the path for overriding and easier fix
   # if that location should change.
   def airport_command
     airport_in_path = `which airport`.chomp
-    if ! airport_in_path.empty?
-      airport_in_path
-    elsif File.exist?(AIRPORT_CMD)
-      AIRPORT_CMD
-    else
-      raise Error.new("Airport command not found.")
-    end
+
+    return airport_in_path unless airport_in_path.empty?
+
+    return DEFAULT_AIRPORT_FILESPEC if File.exist?(DEFAULT_AIRPORT_FILESPEC)
+
+    raise Error.new("Airport command not found.") unless airport_deprecated
+
+    nil # no error, no data
   end
 
 
-  # Identifies the (first) wireless network hardware port in the system, e.g. en0 or en1
+  # 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_port
+  def detect_wifi_interface
 
     lines = run_os_command("networksetup -listallhardwareports").split("\n")
     # Produces something like this:
@@ -47,14 +87,14 @@ class MacOsModel < BaseModel
     # Device: en3
     # Ethernet Address: ac:bc:32:b9:a9:9e
 
-    wifi_port_line_num = (0...lines.size).detect do |index|
+    wifi_interface_line_num = (0...lines.size).detect do |index|
       /: Wi-Fi$/.match(lines[index])
     end
 
-    if wifi_port_line_num.nil?
-      raise Error.new(%Q{Wifi port (e.g. "en0") not found in output of: networksetup -listallhardwareports})
+    if wifi_interface_line_num.nil?
+      raise Error.new(%Q{Wifi interface (e.g. "en0") not found in output of: networksetup -listallhardwareports})
     else
-      lines[wifi_port_line_num + 1].split(': ').last
+      lines[wifi_interface_line_num + 1].split(': ').last
     end
   end
 
@@ -72,6 +112,9 @@ class MacOsModel < BaseModel
   #     "Chancery                         2a:a4:3c:03:33:99 -59  60,+1   Y  -- NONE",
   #     "DIRECT-sq-BRAVIA                 02:71:cc:87:4a:8c -76  6       Y  -- WPA2(PSK/AES/AES) ",  #
   def available_network_info
+
+    raise RuntimeError, airport_deprecated_message if airport_deprecated
+
     return nil unless wifi_on? # no need to try
     command = "#{airport_command} -s | iconv -f macroman -t utf-8"
     max_attempts = 50
@@ -147,6 +190,8 @@ class MacOsModel < BaseModel
   #
   # REXML is used here to avoid the need for the user to install Nokogiri.
   def available_network_names
+    raise RuntimeError, airport_deprecated_message if airport_deprecated
+
     return nil unless wifi_on? # no need to try
 
     # For some reason, the airport command very often returns nothing, so we need to try until
@@ -166,7 +211,7 @@ class MacOsModel < BaseModel
 
   # Returns data pertaining to "preferred" networks, many/most of which will probably not be available.
   def preferred_networks
-    lines = run_os_command("networksetup -listpreferredwirelessnetworks #{wifi_port}").split("\n")
+    lines = run_os_command("networksetup -listpreferredwirelessnetworks #{wifi_interface}").split("\n")
     # Produces something like this, unsorted, and with leading tabs:
     # Preferred networks on en0:
     #         LibraryWiFi
@@ -179,9 +224,9 @@ class MacOsModel < BaseModel
   end
 
 
-  # Returns whether or not the specified interface is a WiFi interfae.
-  def is_wifi_port?(port)
-    run_os_command("networksetup -listpreferredwirelessnetworks #{port} 2>/dev/null")
+  # Returns whether or not the specified interface is a WiFi interface.
+  def is_wifi_interface?(interface)
+    run_os_command("networksetup -listpreferredwirelessnetworks #{interface} 2>/dev/null")
     exit_status = $?.exitstatus
     exit_status != 10
   end
@@ -189,15 +234,16 @@ class MacOsModel < BaseModel
 
   # Returns true if wifi is on, else false.
   def wifi_on?
-    lines = run_os_command("#{airport_command} -I").split("\n")
-    lines.grep("AirPort: Off").none?
+    output = run_os_command("networksetup -getairportpower #{wifi_interface}")
+    output.chomp.match?(/\): On$/)
   end
 
 
   # Turns wifi on.
   def wifi_on
     return if wifi_on?
-    run_os_command("networksetup -setairportpower #{wifi_port} on")
+
+    run_os_command("networksetup -setairportpower #{wifi_interface} on")
     wifi_on? ? nil : Error.new(raise("Wifi could not be enabled."))
   end
 
@@ -205,14 +251,16 @@ class MacOsModel < BaseModel
   # Turns wifi off.
   def wifi_off
     return unless wifi_on?
-    run_os_command("networksetup -setairportpower #{wifi_port} off")
+
+    run_os_command("networksetup -setairportpower #{wifi_interface} off")
+
     wifi_on? ? Error.new(raise("Wifi could not be disabled.")) : nil
   end
 
 
   # This method is called by BaseModel#connect to do the OS-specific connection logic.
   def os_level_connect(network_name, password = nil)
-    command = "networksetup -setairportnetwork #{wifi_port} " + "#{Shellwords.shellescape(network_name)}"
+    command = "networksetup -setairportnetwork #{wifi_interface} #{Shellwords.shellescape(network_name)}"
     if password
       command << ' ' << Shellwords.shellescape(password)
     end
@@ -240,11 +288,11 @@ class MacOsModel < BaseModel
   end
 
 
-  # Returns the IP address assigned to the wifi port, or nil if none.
+  # Returns the IP address assigned to the wifi interface, or nil if none.
   def ip_address
     return nil unless wifi_on? # no need to try
     begin
-      run_os_command("ipconfig getifaddr #{wifi_port}").chomp
+      run_os_command("ipconfig getifaddr #{wifi_interface}").chomp
     rescue OsCommandError => error
       if error.exitstatus == 1
         nil
@@ -258,21 +306,25 @@ class MacOsModel < BaseModel
   def remove_preferred_network(network_name)
     network_name = network_name.to_s
     run_os_command("sudo networksetup -removepreferredwirelessnetwork " +
-                       "#{wifi_port} #{Shellwords.shellescape(network_name)}")
+                       "#{wifi_interface} #{Shellwords.shellescape(network_name)}")
   end
 
 
   # Returns the network currently connected to, or nil if none.
   def connected_network_name
     return nil unless wifi_on? # no need to try
-    lines = run_os_command("#{airport_command} -I").split("\n")
-    ssid_lines = lines.grep(/ SSID:/)
-    ssid_lines.empty? ? nil : ssid_lines.first.split('SSID: ').last.lstrip
+
+    command_output = run_os_command("networksetup -getairportnetwork #{wifi_interface}")
+    connected_prefix = 'Current Wi-Fi Network: '
+    connected = Regexp.new(connected_prefix).match?(command_output)
+    connected ? command_output.split(connected_prefix).last.chomp : nil
   end
 
 
   # Disconnects from the currently connected network. Does not turn off wifi.
   def disconnect
+    raise RuntimeError, airport_deprecated_message if airport_deprecated
+
     return nil unless wifi_on? # no need to try
     run_os_command("sudo #{airport_command} -z")
     nil
@@ -286,7 +338,7 @@ class MacOsModel < BaseModel
   # then this method returns the current address if none is provided,
   # but sets to the specified address if it is.
   def mac_address
-    run_os_command("ifconfig #{wifi_port} | awk '/ether/{print $2}'").chomp
+    run_os_command("ifconfig #{wifi_interface} | awk '/ether/{print $2}'").chomp
   end
 
 
@@ -299,22 +351,28 @@ class MacOsModel < BaseModel
       false
     end
 
+    need_hotspot_login = hotspot_login_required
+
     info = {
         'wifi_on'     => wifi_on?,
         'internet_on' => connected,
-        'port'        => wifi_port,
+        'hotspot_login_required' => need_hotspot_login,
+        'interface'   => wifi_interface,
         'network'     => connected_network_name,
         'ip_address'  => ip_address,
         'mac_address' => mac_address,
         'nameservers' => nameservers_using_scutil,
         'timestamp'   => Time.now,
     }
-    more_output = run_os_command(airport_command + " -I")
-    more_info   = colon_output_to_hash(more_output)
-    info.merge!(more_info)
-    info.delete('AirPort') # will be here if off, but info is already in wifi_on key
 
-    if info['internet_on']
+    unless airport_deprecated
+      more_output = run_os_command(airport_command + " -I")
+      more_info   = colon_output_to_hash(more_output)
+      info.merge!(more_info)
+      info.delete('AirPort') # will be here if off, but info is already in wifi_on key
+    end
+
+    if info['internet_on'] && (! need_hotspot_login)
       begin
         info['public_ip'] = public_ip_address_info
       rescue => e
@@ -406,4 +464,4 @@ class MacOsModel < BaseModel
     output.split("\n")
   end
 end
-end
+end

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

@@ -16,8 +16,8 @@ module WifiWand
         :try_os_command_until,
         :verbose_mode,
         :verbose_mode=,
-        :wifi_port,
-        :wifi_port=
+        :wifi_interface,
+        :wifi_interface=
     ]
 
 
@@ -30,10 +30,10 @@ module WifiWand
         :available_network_info,
         :available_network_names,
         :connected_network_name,
-        :detect_wifi_port,
+        :detect_wifi_interface,
         :disconnect,
         :ip_address,
-        :is_wifi_port?,
+        :is_wifi_interface?,
         :mac_address,
         :nameservers_using_networksetup,
         :nameservers_using_resolv_conf,
@@ -57,4 +57,4 @@ module WifiWand
 
 
   end
-end
+end

data/lib/wifi-wand/version.rb

@@ -1,5 +1,3 @@
 module WifiWand
-
-  VERSION = '2.15.0'
-
+  VERSION = '2.16.0' unless defined?(VERSION)
 end

data/lib/wifi-wand.rb

@@ -5,4 +5,4 @@ require_relative 'wifi-wand/main'  # recursively requires the other files
 # When additional operating systems are added, we will need to modify this
 # to load only the model appropriate for the environment:
 
-require_relative 'wifi-wand/models/mac_os_model'
+require_relative 'wifi-wand/models/mac_os_model'

data/spec/wifi-wand/models/base_model_spec.rb

@@ -0,0 +1,18 @@
+require_relative '../../../lib/wifi-wand/models/base_model'
+
+module WifiWand
+
+  describe BaseModel::OsCommandError do
+    subject { BaseModel::OsCommandError.new(1, 'the command', 'failed to produce an x') }
+
+    specify 'to_h produces a correct hash' do
+      expect(subject.to_h).to eq(exitstatus: 1, command: 'the command', text: 'failed to produce an x')
+    end
+
+    specify 'raising the error produces the correct string' do
+      expect(subject.to_s).to eq(
+        "WifiWand::BaseModel::OsCommandError: Error code 1, command = the command, text = failed to produce an x"
+      )
+    end
+  end
+end

data/wifi-wand.gemspec

@@ -19,10 +19,16 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.add_dependency('awesome_print', '>= 1.9.2', '< 2')
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  # still on version 0, no need to exclude future versions, but need bug fix for pry not pry'ing
+  # on last line of method:
+  spec.add_dependency('pry', '>= 0.14.2')
 
-end
+  spec.add_dependency('rexml', '>= 3.2.6', '< 4')
+
+  spec.add_development_dependency "bundler", ">= 2.5.9"
+  spec.add_development_dependency "rake", ">= 13.2.1"
+  spec.add_development_dependency "rspec", ">= 3.13.0", "< 4"
 
+end

metadata

@@ -1,57 +1,117 @@
 --- !ruby/object:Gem::Specification
 name: wifi-wand
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.16.0
 platform: ruby
 authors:
 - Keith Bennett
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-02-21 00:00:00.000000000 Z
+date: 2024-04-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.5.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.5.9
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.2.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4'
 description: A command line interface for managing WiFi on a Mac.
 email:
 - keithrbennett@gmail.com
@@ -66,6 +126,7 @@ files:
 - README.md
 - RELEASE_NOTES.md
 - exe/wifi-wand
+- integration-tests/wifi-wand/models/mac_os_model_spec.rb
 - lib/wifi-wand.rb
 - lib/wifi-wand/command_line_interface.rb
 - lib/wifi-wand/error.rb
@@ -93,14 +154,14 @@ files:
 - sample-avail-network-data.xml
 - sample-available-networks.json
 - sample-available-networks.yaml
-- spec/wifi-wand/models/mac_os_model_spec.rb
+- spec/wifi-wand/models/base_model_spec.rb
 - test-data/invalid-byte-sequence-network-names.txt
 - wifi-wand.gemspec
 homepage: https://github.com/keithrbennett/wifiwand
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,8 +176,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.5.7
+signing_key:
 specification_version: 4
 summary: Mac WiFi utility
 test_files: []