wifi-wand 2.4.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c55ac27fd01ee88c6ff0551ca7ff6a57b577531938a5d7bd1c0a2ef976886a5b
-  data.tar.gz: c6ae8d9baa9970467bf804506e6922427687d968ef19dd23f96144767d337a62
+  metadata.gz: c9c498e8044e8913348ab143847be13dd0e1683d72c0e26448ae63d817a0675d
+  data.tar.gz: 440847dc2ddc905172a60cf090b863669ec5fef41d5a23f93e7540326d257583
 SHA512:
-  metadata.gz: 06c3a288948f71a3d370f1f3411b822fc43fccde8b8242a595ee1e8996e4df6d13c1e42bb9837f227d79da62217bb440430bf67ef41908e67f87d96aaa22ef9d
-  data.tar.gz: 519f272c7a5cf9a0d5c196e80baf65fb17afb229ebdafece9063afda8705e61d1a4af68561b1a3c90132e2846cd7691eb7967b461750e6d7e065950569295eff
+  metadata.gz: 5ab2bfebaf3c9dd5ad50e8cc7f9aeaa96c1f9799c504153616e920e278419b4f9d004f32083997f1f5c9cc0794557d6b5af093f2b483f519c1d4691b25346772
+  data.tar.gz: 48cc73787df1b6d8a5cb0aa641047bd7b796c9e2c7cf8b25d112427122c780101d7847d3b380cb704ac2f173eb3e8ba9b294295e26e6cca5ee299b93cc95a449

data/README.md

@@ -28,9 +28,12 @@ output at the time of this writing:
 ```
 $ wifi-wand -h
 
+
+
 Command Line Switches:                    [wifi-wand version 2.4.2]
 
--o[i,j,p,y]               - outputs data in inspect, JSON, puts, or YAML format when not in shell mode
+-o {i,j,p,y}              - outputs data in inspect, JSON, puts, or YAML format when not in shell mode
+-p wifi_port_name         - override automatic detection of port name with this name
 -s                        - run in shell mode
 -v                        - verbose mode (prints OS commands and their outputs)
 

data/RELEASE_NOTES.md

@@ -1,3 +1,8 @@
+## v2.5.0
+
+* Add limited support for nonstandard wifi devices (https://github.com/keithrbennett/wifiwand/issues/6).
+
+
 ## v2.4.2
 
 * Fix test.
@@ -5,7 +10,7 @@
 
 ## v2.4.1
 
-* Fix bug: undefined local variable or method `connected_network_name'
+* Fix bug: undefined local variable or method `connected_network_name'.
 
 
 ## v2.4.0

data/exe/wifi-wand

@@ -1,24 +1,5 @@
 #!/usr/bin/env ruby
 
-# This script brings together several useful wifi-related functions.
-#
-# It is a bit of a kludge in that it calls Mac OS commands and uses
-# the text output for its data. At some point I would like to replace
-# that with system calls. Currently this script can break if Apple
-# decides to modify the name, options, behavior, and/or format of its utilities.
-#
-# What would be *really* nice, would be for Apple to retrofit all
-# system commands to optionally output JSON and/or YAML. Some offer XML, but that
-# is not convenient to use.
-#
-# Mac OS commands currently used are: airport, ipconfig, networksetup, security.
-#
-# Author: keithrbennett (on Github, GMail, Twitter)
-# I am available for Ruby development, troubleshooting, training, tutoring, etc.
-#
-# License: MIT License
-
-
 require_relative '../lib/wifi-wand/main'
 
 WifiWand::Main.new.call

data/lib/wifi-wand/command_line_interface.rb

@@ -1,5 +1,6 @@
-require_relative 'version'
 require_relative 'operating_systems'
+require 'ostruct'
+require_relative 'version'
 
 module WifiWand
 
@@ -51,7 +52,8 @@ class CommandLineInterface
   HELP_TEXT = "
 Command Line Switches:                    [wifi-wand version #{WifiWand::VERSION}]
 
--o[i,j,p,y]               - outputs data in inspect, JSON, puts, or YAML format when not in shell mode
+-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
 -s                        - run in shell mode
 -v                        - verbose mode (prints OS commands and their outputs)
 
@@ -90,7 +92,11 @@ When in interactive shell mode:
     @options = options
     current_os = OperatingSystems.new.current_os
     raise "Could not determine operating system" if current_os.nil?
-    @model = current_os.create_model(verbose_mode)
+    model_options = OpenStruct.new({
+        verbose:   options.verbose,
+        wifi_port: options.wifi_port
+    })
+    @model = current_os.create_model(model_options)
     @interactive_mode = !!(options.interactive_mode)
     run_shell if @interactive_mode
   end
@@ -141,7 +147,7 @@ When in interactive shell mode:
   # Asserts that a command has been passed on the command line.
   def validate_command_line
     if ARGV.empty?
-      puts "Syntax is: #{__FILE__} [options] command [command_options]"
+      puts "Syntax is: #{$0} [options] command [command_options]"
       print_help
       exit(-1)
     end
@@ -285,7 +291,7 @@ When in interactive shell mode:
   end
 
 
-  def cmd_lsa
+  def cmd_l
     info = model.available_network_info
     if interactive_mode
       info
@@ -409,7 +415,7 @@ When in interactive shell mode:
         Command.new('d',   'disconnect',    -> (*_options) { cmd_d             }),
         Command.new('h',   'help',          -> (*_options) { cmd_h             }),
         Command.new('i',   'info',          -> (*_options) { cmd_i             }),
-        Command.new('l',   'ls_avail_nets', -> (*_options) { cmd_lsa           }),
+        Command.new('l',   'ls_avail_nets', -> (*_options) { cmd_l             }),
         Command.new('n',   'network_name',  -> (*_options) { cmd_n             }),
         Command.new('of',  'off',           -> (*_options) { cmd_of            }),
         Command.new('on',  'on',            -> (*_options) { cmd_on            }),

data/lib/wifi-wand/main.rb

@@ -1,66 +1,69 @@
+require 'json'
+require 'optparse'
+require 'ostruct'
+require 'yaml'
+
 require_relative 'command_line_interface'
 require_relative 'operating_systems'
 
 
 module WifiWand
+class Main
 
-  require 'json'
-  require 'optparse'
-  require 'ostruct'
-  require 'yaml'
-
-  class Main
-
-    # Parses the command line with Ruby's internal 'optparse'.
-    # Looks for "-v" flag to set verbosity to true.
-    # optparse removes what it processes from ARGV, which simplifies our command parsing.
-    def parse_command_line
-      options = OpenStruct.new
-      OptionParser.new do |parser|
-        parser.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-          options.verbose = v
-        end
+  # Parses the command line with Ruby's internal 'optparse'.
+  # optparse removes what it processes from ARGV, which simplifies our command parsing.
+  def parse_command_line
+    options = OpenStruct.new
 
-        parser.on("-s", "--shell", "Start interactive shell") do |v|
-          options.interactive_mode = true
-        end
+    OptionParser.new do |parser|
+      parser.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+        options.verbose = v
+      end
 
-        parser.on("-o", "--output_format FORMAT", "Format output data") do |v|
+      parser.on("-s", "--shell", "Start interactive shell") do |v|
+        options.interactive_mode = true
+      end
 
-          transformers = {
-              'i' => ->(object) { object.inspect },
-              'j' => ->(object) { JSON.pretty_generate(object) },
-              'p' => ->(object) { sio = StringIO.new; sio.puts(object); sio.string },
-              'y' => ->(object) { object.to_yaml }
-          }
+      parser.on("-o", "--output_format FORMAT", "Format output data") do |v|
 
-          choice = v[0].downcase
+        formatters = {
+            'i' => ->(object) { object.inspect },
+            'j' => ->(object) { object.to_json },
+            'k' => ->(object) { JSON.pretty_generate(object) },
+            'p' => ->(object) { sio = StringIO.new; sio.puts(object); sio.string },
+            'y' => ->(object) { object.to_yaml }
+        }
 
-          unless transformers.keys.include?(choice)
-            raise %Q{Output format "#{choice}" not in list of available formats} +
-                      " (#{transformers.keys.inspect})."
-          end
+        choice = v[0].downcase
 
-          options.post_processor = transformers[choice]
+        unless formatters.keys.include?(choice)
+          raise %Q{Output format "#{choice}" not in list of available formats} +
+                    " (#{formatters.keys.inspect})."
         end
 
-        parser.on("-h", "--help", "Show help") do |_help_requested|
-          ARGV << 'h' # pass on the request to the command processor
-        end
-      end.parse!
-      options
-    end
+        options.post_processor = formatters[choice]
+      end
 
+      parser.on("-p", "--wifi-port PORT", "WiFi port name") do |v|
+        options.wifi_port = v
+      end
 
-    def call
-      operating_systems = OperatingSystems.new
-      unless operating_systems.current_id == :mac
-        raise "OS not in supported list of #{operating_systems.supported_os_names.inspect}"
+      parser.on("-h", "--help", "Show help") do |_help_requested|
+        ARGV << 'h' # pass on the request to the command processor
       end
+    end.parse!
+    options
+  end
+
 
-      options = parse_command_line
+  def call
+    options = parse_command_line
 
+    begin
       WifiWand::CommandLineInterface.new(options).call
+    rescue => e
+      puts "Error: #{e.message}"
     end
   end
+end
 end

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

@@ -6,6 +6,8 @@ module WifiWand
 
 class BaseModel
 
+  attr_accessor :wifi_port, :verbose_mode
+
   class OsCommandError < RuntimeError
     attr_reader :exitstatus, :command, :text
 
@@ -14,22 +16,39 @@ class BaseModel
       @command = command
       @text = text
     end
+
+    def to_s
+      "#{self.class.name}: Error code #{exitstatus}, command = #{command}, text = #{text}"
+    end
+
+    def to_h
+      { exitstatus: exitstatus, command: command, text: text }
+    end
   end
 
 
-  def initialize(verbose = false)
-    @verbose_mode = verbose
+  def initialize(options)
+    @verbose_mode = options.verbose
+    if options.wifi_port && (! is_wifi_port?(options.wifi_port))
+      raise "#{options.wifi_port} is not a Wi-Fi interface."
+    end
+    @wifi_port = options.wifi_port
   end
 
 
-  def run_os_command(command)
+  def run_os_command(command, raise_on_error = true)
+
     output = `#{command} 2>&1` # join stderr with stdout
-    if $?.exitstatus != 0
+
+    if $?.exitstatus != 0 && raise_on_error
       raise OsCommandError.new($?.exitstatus, command, output)
     end
+
     if @verbose_mode
-      puts "\n\n#{'-' * 79}\nCommand: #{command}\n\nOutput:\n#{output}#{'-' * 79}\n\n"
+      puts "\n\n#{'-' * 79}\nCommand: #{command}\n\n"
+      puts "#{output}#{'-' * 79}\n\n"
     end
+
     output
   end
 
@@ -246,5 +265,10 @@ class BaseModel
     nameservers = unique_nameserver_lines.map { |line| line.split(' : ').last.strip }
     nameservers
   end
+
+
+  def wifi_port
+    @wifi_port ||= detect_wifi_port
+  end
 end
 end

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

@@ -1,3 +1,4 @@
+require 'ostruct'
 require 'shellwords'
 
 require_relative 'base_model'
@@ -8,31 +9,31 @@ class MacOsModel < BaseModel
 
   AIRPORT_CMD = '/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport'
 
-  def initialize(verbose = false)
+  # Takes an OpenStruct containing options such as verbose mode and port name.
+  def initialize(options = OpenStruct.new)
     super
   end
 
 
   # Identifies the (first) wireless network hardware port in the system, e.g. en0 or en1
-  def wifi_hardware_port
-    @wifi_hardware_port ||= begin
-      lines = run_os_command("networksetup -listallhardwareports").split("\n")
-      # Produces something like this:
-      # Hardware Port: Wi-Fi
-      # Device: en0
-      # Ethernet Address: ac:bc:32:b9:a9:9d
-      #
-      # Hardware Port: Bluetooth PAN
-      # Device: en3
-      # Ethernet Address: ac:bc:32:b9:a9:9e
-      wifi_port_line_num = (0...lines.size).detect do |index|
-        /: Wi-Fi$/.match(lines[index])
-      end
-      if wifi_port_line_num.nil?
-        raise %Q{Wifi port (e.g. "en0") not found in output of: networksetup -listallhardwareports}
-      else
-        lines[wifi_port_line_num + 1].split(': ').last
-      end
+  # This may not detect wifi ports with nonstandard names, such as USB wifi devices.
+  def detect_wifi_port
+    lines = run_os_command("networksetup -listallhardwareports").split("\n")
+    # Produces something like this:
+    # Hardware Port: Wi-Fi
+    # Device: en0
+    # Ethernet Address: ac:bc:32:b9:a9:9d
+    #
+    # Hardware Port: Bluetooth PAN
+    # Device: en3
+    # Ethernet Address: ac:bc:32:b9:a9:9e
+    wifi_port_line_num = (0...lines.size).detect do |index|
+      /: Wi-Fi$/.match(lines[index])
+    end
+    if wifi_port_line_num.nil?
+      raise %Q{Wifi port (e.g. "en0") not found in output of: networksetup -listallhardwareports}
+    else
+      lines[wifi_port_line_num + 1].split(': ').last
     end
   end
 
@@ -41,6 +42,14 @@ class MacOsModel < BaseModel
   # For some reason, this often returns no results, so I've put the operation in a loop.
   # I was unable to detect a sort strategy in the airport utility's output, so I sort
   # the lines alphabetically, to show duplicates and for easier lookup.
+  #
+  # Sample Output:
+  #
+  # => ["SSID                             BSSID             RSSI CHANNEL HT CC SECURITY (auth/unicast/group)",
+  #     "ByCO-U00tRzUzMEg                 64:6c:b2:db:f3:0c -56  6       Y  -- NONE",
+  #     "Chancery                         0a:18:d6:0b:b9:c3 -82  11      Y  -- NONE",
+  #     "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
     return nil unless wifi_on? # no need to try
     command = "#{AIRPORT_CMD} -s"
@@ -61,6 +70,7 @@ class MacOsModel < BaseModel
         # Reformat the line so that the name is left instead of right justified
         reformat_line.(line)
       end
+      # TODO: Need to sort case insensitively?:
       data_lines.sort!
       [reformat_line.(header_line)] + data_lines
     end
@@ -145,7 +155,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_hardware_port}").split("\n")
+    lines = run_os_command("networksetup -listpreferredwirelessnetworks #{wifi_port}").split("\n")
     # Produces something like this, unsorted, and with leading tabs:
     # Preferred networks on en0:
     #         LibraryWiFi
@@ -158,6 +168,14 @@ 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")
+    exit_status = $?.exitstatus
+    exit_status != 10
+  end
+
+
   # Returns true if wifi is on, else false.
   def wifi_on?
     lines = run_os_command("#{AIRPORT_CMD} -I").split("\n")
@@ -168,7 +186,7 @@ class MacOsModel < BaseModel
   # Turns wifi on.
   def wifi_on
     return if wifi_on?
-    run_os_command("networksetup -setairportpower #{wifi_hardware_port} on")
+    run_os_command("networksetup -setairportpower #{wifi_port} on")
     wifi_on? ? nil : raise("Wifi could not be enabled.")
   end
 
@@ -176,14 +194,14 @@ class MacOsModel < BaseModel
   # Turns wifi off.
   def wifi_off
     return unless wifi_on?
-    run_os_command("networksetup -setairportpower #{wifi_hardware_port} off")
+    run_os_command("networksetup -setairportpower #{wifi_port} off")
     wifi_on? ? 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_hardware_port} " + "#{Shellwords.shellescape(network_name)}"
+    command = "networksetup -setairportnetwork #{wifi_port} " + "#{Shellwords.shellescape(network_name)}"
     if password
       command << ' ' << Shellwords.shellescape(password)
     end
@@ -214,7 +232,7 @@ class MacOsModel < BaseModel
   # Returns the IP address assigned to the wifi port, or nil if none.
   def ip_address
     begin
-      run_os_command("ipconfig getifaddr #{wifi_hardware_port}").chomp
+      run_os_command("ipconfig getifaddr #{wifi_port}").chomp
     rescue OsCommandError => error
       if error.exitstatus == 1
         nil
@@ -228,7 +246,7 @@ class MacOsModel < BaseModel
   def remove_preferred_network(network_name)
     network_name = network_name.to_s
     run_os_command("sudo networksetup -removepreferredwirelessnetwork " +
-                       "#{wifi_hardware_port} #{Shellwords.shellescape(network_name)}")
+                       "#{wifi_port} #{Shellwords.shellescape(network_name)}")
   end
 
 
@@ -250,10 +268,16 @@ class MacOsModel < BaseModel
   # Returns some useful wifi-related information.
   def wifi_info
 
+    connected = begin
+      connected_to_internet?
+    rescue
+      false
+    end
+
     info = {
-        'wifi_on'     =>    wifi_on?,
-        'internet_on' => connected_to_internet?,
-        'port'        => wifi_hardware_port,
+        'wifi_on'     => wifi_on?,
+        'internet_on' => connected,
+        'port'        => wifi_port,
         'network'     => connected_network_name,
         'ip_address'  => ip_address,
         'nameservers' => nameservers_using_scutil,
@@ -264,7 +288,7 @@ class MacOsModel < BaseModel
     info.merge!(more_info)
     info.delete('AirPort') # will be here if off, but info is already in wifi_on key
 
-    if info['wifi_on']
+    if info['internet_on']
       begin
         info['public_ip'] = public_ip_address_info
       rescue => e

data/lib/wifi-wand/operating_systems.rb

@@ -39,11 +39,6 @@ class OperatingSystems
   end
 
 
-  def supported_os_names
-    supported_operating_systems.map(&:display_name)
-  end
-
-
   def current_id;            current_os&.id;            end
   def current_display_name;  current_os&.display_name;  end
 

data/lib/wifi-wand/os/base_os.rb

@@ -17,7 +17,7 @@ class BaseOs
     raise MethodNotImplementedError.new
   end
 
-  def create_model(want_verbose)
+  def create_model(options)
     raise MethodNotImplementedError.new
   end
 

data/lib/wifi-wand/os/imaginary_os.rb

@@ -12,7 +12,7 @@ class ImaginaryOs < BaseOs
     false
   end
 
-  def create_model(want_verbose)
+  def create_model(options)
     raise "I was only kidding. This class is imaginary."
   end
 end

data/lib/wifi-wand/os/mac_os.rb

@@ -12,9 +12,9 @@ class MacOs < BaseOs
     !! /darwin/.match(RbConfig::CONFIG["host_os"])
   end
 
-  def create_model(want_verbose)
+  def create_model(options)
     require_relative '../models/mac_os_model'
-    MacOsModel.new(want_verbose)
+    MacOsModel.new(options)
   end
 end
 end

data/lib/wifi-wand/version.rb

@@ -1,5 +1,5 @@
 module WifiWand
 
-  VERSION = '2.4.2'
+  VERSION = '2.5.0'
 
 end

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

@@ -53,7 +53,7 @@ describe MacOsModel do
 
     it 'can get wifi port' do
       wifi_starts_on ? subject.wifi_on : subject.wifi_off
-      subject.wifi_hardware_port
+      subject.wifi_port
     end
 
     it 'can list info' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wifi-wand
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.5.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-05 00:00:00.000000000 Z
+date: 2018-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Mac wifi utility