wifi-wand 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9019eb4d32759d13110c74b96015eced6ee71a3536c1b9690da24d3a54e812d
-  data.tar.gz: b5e805734cf53495aaeab2e1c67c7bb8104af0759980e2836d14c115dd15e5be
+  metadata.gz: 69ff4a48a042ef648c1cca4f2aca1722f5a56bfb8b4bd78ee6cc9f4ba732b9db
+  data.tar.gz: 0e5c99698650885c01a08caa740dfc5a4c5d35a8a2b0ff5c0eda31ce9297cf80
 SHA512:
-  metadata.gz: 87872063dd2b7d1093a9340263ca742f2006d337dd43c6f2d30a4e12ba9985c3315b6072c9eb2d234f2b75e9b523d8f688a95f890e2feb7e567e4be7904a6bc7
-  data.tar.gz: 9e84a5e8a3a69d425e6c7982571daf3f497e43b845cb5fc663b6c59227af2fda116e6196ad555df0b91b2cca9ed15086c8146052ac4c4e0613b3680ab21ca3de
+  metadata.gz: a5c2067026a31c0e0b976d5d5c63f2680d7324838583060d70d50c9289d3f360ea4c11210ebb062803a680dffadb9996fad2a65c0027c7524318b6bc27942c45
+  data.tar.gz: aeedfe2437d7f11cb8ad3dbde4cebc63ad518f72f5e4bd52106850e8c856364471ffc036a89f12755748fc95ed835a2965d4da832b470534f3e3ae3009349225

data/README.md

@@ -28,7 +28,7 @@ output at the time of this writing:
 ```
 $ wifi-wand -h
 
-Command Line Switches:                    [wifi-wand version 2.7.0 at https://github.com/keithrbennett/wifiwand]
+Command Line Switches:                    [wifi-wand version 2.8.0 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
@@ -88,14 +88,14 @@ version of Ruby that comes packaged with MacOS.
 ### JSON, YAML, and Other Output Formats
 
 You can specify that output in _noninteractive_ mode be in a certain format.
-Currently, JSON, YAML, inspect, and puts formats are supported.
+Currently, JSON, "Pretty" JSON, YAML, inspect, and puts formats are supported.
 See the help for which command line switches to use.
 
 
 ### Seeing the Underlying OS Commands and Output
 
 If you would like to see the Mac OS commands and their output, 
-you can do so by specifying "-v" (for _verbose) on the command line.
+you can do so by specifying "-v" (for _verbose_) on the command line.
 
 You may notice that some commands are executed more than once. This is to simplify the application logic
 and eliminate the need for the complexity of balancing the speed that a cache offers and the risk
@@ -325,15 +325,31 @@ Connected!
 
 ### Dependent Gems
 
-Currently, the only gems used directly by the program are:
+Currently, no dependent gems are installed when this gem is installed.
+However, the program _will_ use other gems as follows:
 
-* `pry`, to provide the interactive shell
-* `awesome_print` (optional), to more nicely format output in non-interactive mode
+* `pry`, when the interactive shell is requested with the `-s` option
+* `awesome_print`, if it is found, to more nicely format output in non-interactive mode
 
-So the user can avoid installing gems altogether as long as they don't need to use the interactive shell,
+So the user can avoid installing gems other than this one altogether
+as long as they don't need to use the interactive shell,
 and as long as they are comfortable with the less pretty output.
 
 
+### Public IP Information
+
+The information hash will normally include information about the public IP address.
+However, the command that provides this information, `curl -s ipinfo.io`, will sometimes
+return this:
+
+`Rate limit exceeded. Subscribe to a paid plan to increase your usage limits` 
+
+If this happens, the public IP information will be silently omitted from the
+information hash. In this case, the web site 'https://www.whatismyip.com' is
+recommended, and `ro ipw` on the command line or `ro 'ipw'` in the shell will
+open that page in your browser for you.
+
+
 ### Password Lookup Oddity
 
 You may find it odd (I did, anyway) that even if you issue the password command 

data/RELEASE_NOTES.md

@@ -1,3 +1,10 @@
+## v2.8.0
+
+* Substantial simplifications of model implementations of connected_to_internet?, available_network_names.
+* Fixed network name reporting problems regarding leading/trailing spaces.
+* Improve verbose output by printing command when issued, not after completed.
+
+
 ## v2.7.0
 
 * Fix models not being loadable after requiring the gem.

data/lib/wifi-wand/command_line_interface.rb

@@ -374,6 +374,7 @@ When in interactive shell mode:
         model.open_resource(resource.resource)
       end
     end
+    nil
   end
 
 
@@ -404,11 +405,6 @@ When in interactive shell mode:
   end
 
 
-  def cmd_pu
-    `open https://www.whatismyip.com/`
-  end
-
-
   def cmd_q
     quit
   end

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

@@ -1,5 +1,7 @@
 require 'json'
+require 'net/http'
 require 'tempfile'
+require 'uri'
 require_relative '../../wifi-wand'
 
 module WifiWand
@@ -29,6 +31,7 @@ class BaseModel
 
   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
@@ -36,13 +39,30 @@ class BaseModel
   end
 
 
+  def banner_line
+    @banner_line ||= '-' * 79
+  end
+
+  def command_attempt_as_string(command)
+    "\n\n#{banner_line}\nCommand: #{command}\n"
+  end
+
+  def command_result_as_string(output)
+    "#{output}#{banner_line}\n\n"
+  end
+
+
+
   def run_os_command(command, raise_on_error = true)
 
+    if @verbose_mode
+      puts command_attempt_as_string(command)
+    end
+
     output = `#{command} 2>&1` # join stderr with stdout
 
     if @verbose_mode
-      puts "\n\n#{'-' * 79}\nCommand: #{command}\n\n"
-      puts "#{output}#{'-' * 79}\n\n"
+      puts command_result_as_string(output)
     end
 
     if $?.exitstatus != 0 && raise_on_error
@@ -53,73 +73,32 @@ class BaseModel
   end
 
 
-  # This method returns whether or not there is a working Internet connection.
-  # Because of a Mac issue which causes a request to hang if the network is turned
-  # off during its lifetime, we give it only 5 seconds per try,
-  # and limit the number of tries to 3.
-  #
-  # This implementation will probably strike you as overly complex. The following
-  # code looks like it is all that should be necessary, but unfortunately
-  # this implementation often hangs when wifi is turned off while curl is active
-  #
-  # def connected_to_internet?
-  #   script = "curl --silent --head http://www.google.com/ > /dev/null ; echo $?"
-  #   result = `#{script}`.chomp
-  #   puts result
-  #   result == '0'
-  # end
-
-  # TODO Investigate using Curl options: --connect-timeout 1 --max-time 2 --retry 0
-  # to greatly simplify this method.
+  # This method returns whether or not there is a working Internet connection,
+  # which is defined as being able to get a successful response
+  # from google.com within 3 seconds..
   def connected_to_internet?
+    test_site = 'https://www.google.com'
+    url = URI.parse(test_site)
+    success = true
 
-    tempfile = Tempfile.open('wifi-wand-')
+    if @verbose_mode
+      puts command_attempt_as_string("[Calling Net:HTTP.start(#{url.host})]")
+    end
 
     begin
-      start_status_script = -> do
-        script = "curl --silent --head https://www.google.com/ > /dev/null ; echo $? > #{tempfile.path} &"
-        pid = Process.spawn(script)
-        Process.detach(pid)
-        pid
-      end
-
-      process_is_running = ->(pid) do
-        script = %Q{ps -p #{pid} > /dev/null; echo $?}
-        output = `#{script}`.chomp
-        output == "0"
+      Net::HTTP.start(url.host) do |http|
+        http.read_timeout = 3 # seconds
+        http.get('.')
       end
+    rescue
+      success = false
+    end
 
-      get_connected_state_from_curl = -> do
-        tempfile.close
-        File.read(tempfile.path).chomp == '0'
-      end
-
-      # Do one run, iterating during the timeout period to see if the command has completed
-      do_one_run = -> do
-        end_time = Time.now + 3
-        pid = start_status_script.()
-        while Time.now < end_time
-          if process_is_running.(pid)
-            sleep 0.5
-          else
-            return get_connected_state_from_curl.()
-          end
-        end
-        Process.kill('KILL', pid) if process_is_running.(pid)
-        :hung
-      end
-
-      3.times do
-        connected = do_one_run.()
-        return connected if connected != :hung
-      end
-
-      raise "Could not determine Internet status."
-
-    ensure
-      tempfile.unlink
+    if @verbose_mode
+      puts command_result_as_string("#{success}\n")
     end
 
+    success
   end
 
 
@@ -225,7 +204,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 commands stdout as its sole parameter
+  # @stop_condition a lambda taking the command's stdout as its sole parameter
   # @return the stdout produced by the command
   def try_os_command_until(command, stop_condition, max_tries = 100)
     max_tries.times do

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

@@ -19,6 +19,7 @@ class MacOsModel < BaseModel
   # Identifies the (first) wireless network hardware port 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
+
     lines = run_os_command("networksetup -listallhardwareports").split("\n")
     # Produces something like this:
     # Hardware Port: Wi-Fi
@@ -28,9 +29,11 @@ class MacOsModel < BaseModel
     # 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
@@ -89,68 +92,21 @@ class MacOsModel < BaseModel
   end
 
 
-  def parse_network_names(info)
-    if info.nil?
-      nil
-    else
-      info[1..-1] \
-      .map { |line| line[0..32].rstrip } \
-      .uniq \
-      .sort { |s1, s2| s1.casecmp(s2) }
-    end
-  end
-
-
   # @return an array of unique available network names only, sorted alphabetically
-  # Kludge alert: the tabular data does not differentiate between strings with and without leading whitespace
-  # Therefore, we get the data once in tabular format, and another time in XML format.
-  # The XML element will include any leading whitespace. However, it includes all <string> elements,
-  # many of which are not network names.
-  # As an improved approximation of the correct result, for each network name found in tabular mode,
-  # we look to see if there is a corresponding string element with leading whitespace, and, if so,
-  # replace it.
-  #
-  # This will not behave correctly if a given name has occurrences with different amounts of whitespace,
-  # e.g. ' x' and '     x'.
-  #
   # The reason we don't use an XML parser to get the exactly correct result is that we don't want
   # users to need to install any external dependencies in order to run this script.
   def available_network_names
 
-    # Parses the XML text (using grep, not XML parsing) to find
-    # <string> elements, and extracts the network name candidates
-    # containing leading spaces from it.
-    get_leading_space_names = ->(text) do
-      text.split("\n") \
-        .grep(%r{<string>}) \
-        .sort \
-        .uniq \
-        .map { |line| line.gsub("<string>", '').gsub('</string>', '').gsub("\t", '') } \
-        .select { |s| s[0] == ' ' }
-    end
-
-
-    output_is_valid = ->(output) { ! ([nil, ''].include?(output)) }
-    tabular_data = try_os_command_until("#{AIRPORT_CMD} -s", output_is_valid)
-    xml_data     = try_os_command_until("#{AIRPORT_CMD} -s -x", output_is_valid)
-
-    if tabular_data.nil? || xml_data.nil?
-      raise "Unable to get available network information; please try again."
-    end
-
-    tabular_data_lines = tabular_data[1..-1] # omit header line
-    names_no_spaces    = parse_network_names(tabular_data_lines.split("\n")).map(&:strip)
-    names_maybe_spaces =  get_leading_space_names.(xml_data)
-
-    names = names_no_spaces.map do |name_no_spaces|
-      match = names_maybe_spaces.detect do |name_maybe_spaces|
-        %r{[ \t]?#{name_no_spaces}$}.match(name_maybe_spaces)
-      end
-
-      match ? match : name_no_spaces
-    end
+    # awk command below kindly provided by @nohillside at https://apple.stackexchange.com/questions/320323/how-to-programmatically-get-available-wifi-networks-without-airport-utility.
+    command = %q{airport -s -x | awk '{ if (catch == 1) { print; catch=0 } } /SSID_STR/ { catch=1 }'}
+    stop_condition = ->(response) { ! [nil, ''].include?(response) }
 
-    names.sort { |s1, s2| s1.casecmp(s2) }    # sort alphabetically, case insensitively
+    output = try_os_command_until(command, stop_condition)
+    output = output.split("\n")
+    output.map!(&:strip)
+    output.map! { |s| s.gsub(/<\/?string>/, '') }
+    output.sort! { |s1, s2| s1.casecmp(s2) }    # sort alphabetically, case insensitively
+    output.uniq!
   end
 
 
@@ -255,7 +211,7 @@ class MacOsModel < BaseModel
   def connected_network_name
     lines = run_os_command("#{AIRPORT_CMD} -I").split("\n")
     ssid_lines = lines.grep(/ SSID:/)
-    ssid_lines.empty? ? nil : ssid_lines.first.split('SSID: ').last.strip
+    ssid_lines.empty? ? nil : ssid_lines.first.split('SSID: ').last.lstrip
   end
 
 

data/lib/wifi-wand/version.rb

@@ -1,5 +1,5 @@
 module WifiWand
 
-  VERSION = '2.7.0'
+  VERSION = '2.8.0'
 
 end

data/test-data/invalid-byte-sequence-network-names.txt

@@ -0,0 +1 @@
+"\t\t<string>Tenants</string>\n\t\t<string>iPad</string>\n\t\t<string>Robinsonsmalls</string>\n\t\t<string>Counter_07959</string>\n\t\t<string>Tenants</string>\n\t\t<string>RDS</string>\n\t\t<string>Lenovo PHAB2</string>\n\t\t<string>SHAKEYS FREE WIFI</string>\n\t\t<string>Meldrick\xD5s iPhone</string>\n\t\t<string>quikstop cyber</string>\n\t\t<string>PLDTHOMEDSL</string>\n\t\t<string>Robinsonsmalls</string>\n\t\t<string>Tenants</string>\n\t\t<string>Robinsonsmalls</string>\n\t\t<string>islandtea</string>\n\t\t<string>PLDTHOMEDSL52919</string>\n\t\t<string>PLDTHOMEDSLCHEF</string>\n\t\t<string>PLDTMyDSLBiz5G06370</string>\n\t\t<string>AustinPowrovich</string>\n"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wifi-wand
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2018-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,7 @@ files:
 - sample-available-networks.json
 - sample-available-networks.yaml
 - spec/wifi-wand/models/mac_os_model_spec.rb
+- test-data/invalid-byte-sequence-network-names.txt
 - wifi-wand.gemspec
 homepage: https://github.com/keithrbennett/wifi-wand
 licenses: