mac-wifi 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24a41565844a201ee4416a7a5452d8859526ed7c
-  data.tar.gz: 8cfe9206c6164351d4b98b825a89543e98932719
+  metadata.gz: 2bce9a95ee880536f6e3672191ed7d343b1eafcf
+  data.tar.gz: 10aeeddeb2bc4bf946a65d9709b2306ea8567ed9
 SHA512:
-  metadata.gz: 41ba590f1fe37986621d1fee3f5c8d93af431de56b24bedf8988f2f740f20ed8e1a49ad7aeab8b2ed412e068b39ee0b9da3e0372a7821260279e6af988a61f35
-  data.tar.gz: 7e8cb0afeb5f413ff444cf1602170671976ef1a464624c58846ec6b7dc86bf09b349caa0cb889d973790d0d818d92b6a61ebbba360bbcd57f24c1ce073b9c17e
+  metadata.gz: 04224a7842e14437d0de854e6bc9566901893c547b73e4ca581b159d92816bf789d3235919b8593fdf74b32e9cfebfe7c14f7974498a268117eafeb37a0eb785
+  data.tar.gz: 5b8db8d42cb1b0284dc61d0557030ffa49f2bc3987f8272ccef93fa23d40be2553346635a9f996941a7fa2f2f19f351687c0fb2855203f6f2c8da5a5493c07b3

data/README.md

@@ -4,11 +4,16 @@ The `mac-wifi` script installed by this gem (or otherwise copied) enables the qu
 The code encapsulates the Mac OS specific logic in a minimal class to more easily add support for other operating systems,
 but as of now, only Mac OS is supported. (Feel free to add an OS!)
 
-It can be run in single-command or interactive mode. Interactive mode uses the `pry` gem,
+It can be run in single-command or interactive mode. Interactive mode uses the [pry](https://github.com/pry/pry) gem,
 providing an interface familiar to Rubyists and other 
 [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) users.
 
-It is not necessary to download this repo or even install this gem; the `bin/mac-wifi` script file is all you need to run the application.
+It is not necessary to download this repo or even install this gem; the `bin/mac-wifi` 
+script file is all you need to run the application. There are many ways to install it
+in this way; one way is by changing into the directory
+where you would like to save the script, and running:
+
+`curl -o mac-wifi https://raw.githubusercontent.com/keithrbennett/macwifi/master/exe/mac-wifi && chmod +x mac-wifi`
 
 
 ### Usage
@@ -19,24 +24,29 @@ output at the time of this writing:
 ```
 $ mac-wifi h
 
+Command Line Switches:                    [mac-wifi version 2.0.0]
+
+-o[i,j,p,y]               - outputs data in inspect, JSON, puts, or YAML format when not in shell mode
+-s                        - run in shell mode
+-v                        - verbose mode (prints OS commands and their outputs)
 
-mac-wifi version 1.3.0 -- Available commands are:
+Commands:
 
-a[vailnets]               - array of names of the available networks
+a[vail_nets]              - array of names of the available networks
 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
 h[elp]                    - prints this help
 i[nfo]                    - a hash of wifi-related information
-l[savailnets]             - details about available networks
+l[s_avail_nets]           - details about available networks
 n[etwork_name]            - name (SSID) of currently connected network
 on                        - turns wifi on
 of[f]                     - turns wifi off
 pa[ssword] network-name   - password for preferred network-name
-pr[efnets]                - preferred (not necessarily available) networks
+pr[ef_nets]               - preferred (not necessarily available) networks
 q[uit]                    - exits this program (interactive shell mode only) (see also 'x')
-r[mprefnets] network-name - removes network-name from the preferred networks list
+r[m_pref_nets] network-name - removes network-name from the preferred networks list
                             (can provide multiple names separated by spaces)
 s[hell]                   - opens an interactive pry shell (command line only)
 t[ill]                    - returns when the desired Internet connection state is true. Options:
@@ -48,7 +58,6 @@ x[it]                     - exits this program (interactive shell mode only) (se
 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,
@@ -66,42 +75,20 @@ This is accomplished by the following command:
 
 `gem install awesome_print`
 
+You may need to precede this command with `sudo `, especially if you are using the 
+version of Ruby that comes packaged with MacOS.
 
-### JSON and YAML Output
-
-For now, JSON and YAML processing are only available in the interactive mode shell, in the way
-you would usually use them in Ruby code. Their respective libraries are automatically
-`require`d for your convenience. If you want them in non-interactive mode,
-you can work around this limitation by redirecting the shell's input, e.g.:
 
-```
-echo "File.write('available_networks.json', availnets.pretty_inspect)" | mac-wifi s
-```
+### JSON and YAML Output
 
-This will create a file `available_networks.json` with content looking something like this:
+You can specify that output in _noninteractive_ mode be in JSON or YAML formats
+by specifying `-j` or `-y` on the command line, respectively.
 
-```bash
-["....MMobile 2.4G",
- ".@  3BB_WiFi",
- ".@ AIS SUPER WiFi"]
-```
 
 ### 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 setting the
-environment variable MAC_WIFI_OPTS to include `-v` (for _verbose_).
-This can be done in the following ways (using the `info` command as an example):
-
-```
-export MAC_WIFI_OPTS=-v
-./mac-wifi i
-```
-
-...or...
-
-```
-MAC_WIFI_OPTS=-v  ./mac-wifi i
-```
+If you would like to see the Mac OS commands and their output, 
+you can do so by specifying "-v" 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
@@ -122,6 +109,20 @@ sudo gem install pry-coolline
 ```
 
 
+### Using It in Scripts
+
+Sometimes calling `mac-wifi` 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:
+
+```
+mac-wifi connect my_network_name my_password  && \
+mac-wifi till conn && \
+say -v Kyoko "Connected to my network."
+```
+
+(The `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`.
@@ -243,9 +244,9 @@ expression and don't need to print it out, you can simply append `;nil` to the e
 and that will be value output to the console. For example:
 
 ```
-[10] pry(#<MacWifi::CommandLineInterface>)> available_networks = availnets; nil
+[10] pry(#<MacWifi::CommandLineInterface>)> available_networks = avail_nets; nil
 => nil
-[11] pry(#<MacWifi::CommandLineInterface>)> availnets.size
+[11] pry(#<MacWifi::CommandLineInterface>)> avail_nets.size
 => 32
 ```
 

data/RELEASE_NOTES.md

@@ -1,3 +1,21 @@
+## v2.0.0
+
+* Support output formats in batch mode: JSON, YAML, puts, and inspect modes.
+* Change some command names to include underscores.
+* Shell mode is now (only) a command line switch (-s).
+
+
+## v1.4.0
+
+* Support for "MAC-WIFI-OPTS" environment variable for configuration dropped.
+* Support for "-v" verbosity command line option added.
+* Work around pry bug whereby shell was not always starting when requested.
+* 99% fix for reporting of available network names containing leading spaces
+  (this will not correctly handle the case of network names that are identical
+  except for numbers of leading spaces).
+* Improved handling of attempting to list available networks when wifi is off.
+
+
 ## v1.3.0
 
 * Add partial JSON and YAML support.