wifi-wand 2.12.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f241f14959069b1206de6183dc072605c5af1c65b1dbfc0f855366194bc3c68
-  data.tar.gz: 8bd1250fe4fc050b5810d1c67bd279ce6022974fc9facb236088057966712ec6
+  metadata.gz: e0669f48a732c950d64056cfdc853ac83b6afb31e35c30c514d026d05f757f80
+  data.tar.gz: 6117a6a8693b9d9730a159d049a2c442eb53cac6c92f2107c4d257ec7685513c
 SHA512:
-  metadata.gz: 3c3e3b3a1da083d30ba3289046d35506c43a6a0a56c443da10e5dc50566ada6e9c5aae829967eb5ac5c0d1a59d49063280397c1a05e5461440945c0415329c5a
-  data.tar.gz: d4791602539759a83b8d88f5dd801279559537dc5401fd003bdf2b9cd96083a5ffce957487122ed704e69a13458ef0659b7f7c52b19a74f4a4c9d1ca386d8d42
+  metadata.gz: 38d4beb5c03960e90d6e0e0f557f95fe10d319506e7543c83ab2e057e3f06718eb7f0a5ffe2239b8ccdae477b273ba39870ffa94365ef7b3e31c0992c099895a
+  data.tar.gz: dc747b5765528debc3874cdd7ea07dd5d1f4b2173c000f37854ced5a35b5ba74d5611c31c0114b3080ec3849760fa1eafedb78b6daa5bf9ae388900abc65b071

data/README.md

@@ -9,8 +9,8 @@ or, you may need to precede that command with `sudo`:
 `sudo gem install wifi-wand`
 
 The `wifi-wand` gem enables the query and management 
-of wifi configuration and environment on a Mac.
-The code encapsulates the Mac OS specific logic in a minimal class 
+of WiFi configuration and environment on a Mac.
+The code encapsulates the Mac OS specific logic in model classes 
 to more easily add support for other operating systems,
 but as of now, only Mac OS is supported. (Feel free to add an OS!)
 
@@ -30,7 +30,7 @@ $ wifi-wand -h
 
 Syntax is: exe/wifi-wand [options] command [command_options]
 
-Command Line Switches:                    [wifi-wand version 2.10.0 at https://github.com/keithrbennett/wifiwand]
+Command Line Switches:                    [wifi-wand version 2.13.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
@@ -44,7 +44,7 @@ ci                        - connected to Internet (not just wifi on)?
 co[nnect] network-name    - turns wifi on, connects to network-name
 cy[cle]                   - turns wifi off, then on, preserving network selection
 d[isconnect]              - disconnects from current network, does not turn off wifi
-f[orget] network-name     - removes network-name(s) from the preferred networks list
+f[orget] name1 [..name_n] - removes network-name(s) from the preferred networks list
 h[elp]                    - prints this help
 i[nfo]                    - a hash of wifi-related information
 l[s_avail_nets]           - details about available networks
@@ -59,17 +59,21 @@ ro[pen]                   - open resource ('ipl' (IP Location), 'ipw' (What is M
 t[ill]                    - returns when the desired Internet connection state is true. Options:
                             1) 'on'/:on, 'off'/:off, 'conn'/:conn, or 'disc'/:disc
                             2) wait interval, in seconds (optional, defaults to 0.5 seconds)
-w[ifion]                  - is the wifi on?
+w[ifi_on]                 - is the wifi on?
 x[it]                     - exits this program (interactive shell mode only) (see also 'q')
 
+When in interactive shell mode:
+  * remember to quote string literals.
+  * for pry commands, use prefix `%`.
+
+
 When in interactive shell mode:
   * use quotes for string parameters such as method names.
   * for pry commands, use prefix `%`.
 ```
 
-Internally, it uses several Mac command line utilities. This is not ideal,
-I would have preferred OS system calls, but the current approach enabled me to develop
-this script quickly and simply.
+Internally, it uses several Mac command line utilities to interact with the
+underlying operating system.
 
 
 ### Pretty Output
@@ -117,21 +121,6 @@ sudo gem install pry-coolline
 ```
 
 
-### Using It in Scripts
-
-Sometimes calling `wifi-wand` from a script is handy. I have this script that
-connects to a commonly used wifi network, and then speaks a message when it's done:
-
-```
-wifi-wand connect my_network_name my_password  && \
-wifi-wand till conn && \
-say -v Kyoko "Connected to my network."
-```
-
-(The Mac OS `say` command supports all kinds of accents that are fun to play around with.
-You can get a list of all of them by running `say -v "?"`)
-
-
 ### Using the Shell
 
 _If the program immediately exits when you try to run the shell, try upgrading `pry` and `pry-byebug`.
@@ -190,7 +179,7 @@ or constants, which will _not_ hide the methods:
 ```
 
 2) If you accidentally refer to a nonexistent variable or method name,
-the result may be mysterious.  For example, if I were write the wifi information
+the result may be mysterious.  For example, if I were write the WiFi information
 to a file, this would work:
 
 ```
@@ -284,7 +273,7 @@ puts model.available_network_names.to_yaml # etc...
 but these commands could also each be specified on a line of its own.)
 
 ```
-# Print out wifi info:
+# Print out WiFi info:
 i
 
 # Cycle (off/on) the network then connect to the specified network not requiring a password
@@ -303,11 +292,12 @@ You are connected on port en0 to .@ AIS SUPER WiFi on IP address 172.27.145.225.
 There are 341 preferred networks.
 
 # Delete all preferred networks whose names begin with "TOTTGUEST", the hard way:
-> pr.grep(/^TOTTGUEST/).each { |n| rm(n) }
+> pr.grep(/^TOTTGUEST/).each { |n| forget(n) }
 
 # Delete all preferred networks whose names begin with "TOTTGUEST", the easy way.
-# rm can take multiple network names, but they must be specified as separate parameters; thus the '*'.
-> rm(*pr.grep(/^TOTTGUEST/))
+# 'forget' can take multiple network names, 
+# but they must be specified as separate parameters; thus the '*'.
+> forget(*pr.grep(/^TOTTGUEST/))
 
 # Define a method to wait for the Internet connection to be active.
 # (This functionality is included in the `till` command.)
@@ -347,14 +337,14 @@ return this:
 
 If this happens, the public IP information will be silently omitted from the
 information hash. In this case, the web site 'https://www.iplocation.net/' is
-recommended, and `ro ipl` on the command line or `ro 'ipl'` in the shell will
+recommended, and `wifi-wand ro ipl` on the command line or `ro 'ipl'` 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 
-(`mac_wifi pa a-network-name`) using sudo, you will still be prompted 
+(`mac_wifi password a-network-name`) using sudo, you will still be prompted 
 with a graphical dialog for both a user id and password. This is no doubt
 for better security, but it's unfortunate in that it makes it impossible to fully automate this task.
 

data/RELEASE_NOTES.md

@@ -1,3 +1,8 @@
+## v2.13.0
+
+* Fix: network names could not be displayed when one contained a nonstandard character (e.g. D5 for a special apostrophe in Mac Roman encoding).
+* Fix: some operations that didn't make sense with WiFi off were attempted anyway; this was removed.
+
 ## v2.12.0
 
 * Change connected_to_internet?. Use 'dig' to test name resolution first, then HTTP get. Also, add baidu.com for China where google.com is blocked.

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

@@ -70,6 +70,7 @@ class BaseModel
   # Domains attempted are google.com and baidu.com. Success is 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
 
     # We cannot use run_os_command for the running of external processes here,
     # because they are multithreaded, and the output will get mixed up.

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

@@ -73,7 +73,7 @@ class MacOsModel < BaseModel
   #     "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_command} -s"
+    command = "#{airport_command} -s | iconv -f macroman -t utf-8"
     max_attempts = 50
 
 
@@ -145,10 +145,12 @@ class MacOsModel < BaseModel
   #
   # REXML is used here to avoid the need for the user to install Nokogiri.
   def available_network_names
+    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
     # we get data in the response:
 
-    command = "#{airport_command} -s -x"
+    command = "#{airport_command} -s -x | iconv -f macroman -t utf-8"
     stop_condition = ->(response) { ! [nil, ''].include?(response) }
     output = try_os_command_until(command, stop_condition)
     doc = REXML::Document.new(output)
@@ -238,6 +240,7 @@ class MacOsModel < BaseModel
 
   # Returns the IP address assigned to the wifi port, 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
     rescue OsCommandError => error
@@ -259,6 +262,7 @@ class MacOsModel < BaseModel
 
   # 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
@@ -267,6 +271,7 @@ class MacOsModel < BaseModel
 
   # Disconnects from the currently connected network. Does not turn off wifi.
   def disconnect
+    return nil unless wifi_on? # no need to try
     run_os_command("sudo #{airport_command} -z")
     nil
   end
@@ -337,7 +342,8 @@ class MacOsModel < BaseModel
         raise Error.new("Bad IP addresses provided: #{bad_addresses.join(', ')}")
       end
       nameservers.join(' ')
-    end
+    end # end assignment to arg variable
+
     run_os_command("networksetup -setdnsservers Wi-Fi #{arg}")
     nameservers
   end

data/lib/wifi-wand/version.rb

@@ -1,5 +1,5 @@
 module WifiWand
 
-  VERSION = '2.12.0'
+  VERSION = '2.13.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wifi-wand
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.13.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-27 00:00:00.000000000 Z
+date: 2018-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler