mac-wifi 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 364ab612e99d7957d20949e0cce4800d0b2f433f9bc3d57eddc489ca2646a569
-  data.tar.gz: f0b2a0ba504546d73f399a551e2ea0f5164befbc58f7570687bcdf7109529841
+  metadata.gz: '0049361c430c1be60db595012b1e54844e16ad90df26064c059ba42a9f48fd05'
+  data.tar.gz: 8947e8e004eec02b3a2ca8bf9bc1b24c94a477ccdff7819d8e142e5d7095521a
 SHA512:
-  metadata.gz: 67f5d51bc48331beee215aeffc2896e679ca61edf94a8b614758de5658babd0820de21ef816cadfea06b0001209149e59042bc27c410448240efcdd016f33333
-  data.tar.gz: 40e35d2036816e00ea4791287557055028c7e9be1b7b0a9973e211808ceb5ec0b6d0dfa9f24addb52001c41da86c6815ce4759991226e93d2e34331eb1359ee6
+  metadata.gz: b8ac9a874c181bf0b32a4dd59edaaa2d3000a2f0197ba54e43a4425e725a18d115ae63640ed4ba2471cc7277acd70fdd5d61b3c2c0ca4ece4dc1063c3a8aaa46
+  data.tar.gz: cf18aeb2d52e73ddd9acb0444e5196b8c7126a55c6ad11314da9fabce123e5a2da70c26253944de68d10119582256cd266787da25257dc3b7cf33f69a8630428

data/README.md

@@ -28,8 +28,7 @@ output at the time of this writing:
 ```
 $ mac-wifi h
 
-
-Command Line Switches:                    [mac-wifi version 2.2.0]
+Command Line Switches:                    [mac-wifi version 2.3.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
@@ -49,11 +48,11 @@ 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
-pu[blic-ip-show]          - opens https://www.whatismyip.com/ in a browser window to show public address info
 pr[ef_nets]               - preferred (not necessarily available) networks
 q[uit]                    - exits this program (interactive shell mode only) (see also 'x')
 r[m_pref_nets] network-name - removes network-name from the preferred networks list
                           (can provide multiple names separated by spaces)
+ro[pen]                   - open resource ('ipc' (IP Chicken), 'ipw' (What is My IP), 'spe' (Speed Test), 'this' (mac-wifi Home Page))
 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)

data/RELEASE_NOTES.md

@@ -1,3 +1,14 @@
+## v2.3.0
+
+* Add public IP address info to info hash (https://github.com/keithrbennett/macwifi/issues/3).
+* Add nameserver information to info hash (issue at https://github.com/keithrbennett/macwifi/issues/5).
+* Made all info hash keys same data type to be less confusing; made them all String's.
+* Replace 'public-ip-show' with 'ropen', and provide additional targets ipchicken.com,
+ speedtest.net, and the Github page for this project
+* Speed up retrieval of network name
+* Remove BaseModel#run_os_command private restriction.
+
+
 ## v2.2.0
 
 * Add pu[blic-wifi-show] command to open https://www.whatismyip.com/ to show public IP address info.

data/lib/mac-wifi/base_model.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'tempfile'
 require_relative '../mac-wifi'
 
@@ -31,7 +32,6 @@ class BaseModel
     end
     output
   end
-  private :run_os_command
 
 
   # This method returns whether or not there is a working Internet connection.
@@ -217,5 +217,25 @@ class BaseModel
     end
     nil
   end
+
+
+  # Reaches out to ipinfo.io to get public IP address information
+  # in the form of a hash.
+  # You may need to enclose this call in a begin/rescue.
+  def public_ip_address_info
+    JSON.parse(`curl -s ipinfo.io`)
+  end
+
+
+  # @return array of nameserver IP addresses from /etc/resolv.conf, or nil if not found
+  # Though this is strictly *not* OS-agnostic, it will be used by most OS's,
+  # and can be overridden by subclasses (e.g. Windows).
+  def nameservers
+    begin
+      File.readlines('/etc/resolv.conf').grep(/^nameserver /).map { |line| line.split.last }
+    rescue Errno::ENOENT
+      nil
+    end
+  end
 end
 end

data/lib/mac-wifi/command_line_interface.rb

@@ -4,17 +4,47 @@ module MacWifi
 
 class CommandLineInterface
 
-  attr_reader :model, :interactive_mode, :options
+  attr_reader :interactive_mode, :model, :open_resources, :options
+
 
   class Command < Struct.new(:min_string, :max_string, :action); end
 
 
+  class OpenResource < Struct.new(:code, :resource, :description)
+
+    # Ex: "'ipw' (What is My IP)"
+    def help_string
+      "'#{code}' (#{description})"
+    end
+  end
+
+
+  class OpenResources < Array
+
+    def find_by_code(code)
+      detect { |resource| resource.code == code }
+    end
+
+    # Ex: "('ipc' (IP Chicken), 'ipw' (What is My IP), 'spe' (Speed Test))"
+    def help_string
+      map(&:help_string).join(', ')
+    end
+  end
+
+
   class BadCommandError < RuntimeError
     def initialize(error_message)
       super
     end
   end
 
+  OPEN_RESOURCES = OpenResources.new([
+      OpenResource.new('ipc',  'https://ipchicken.com/',     'IP Chicken'),
+      OpenResource.new('ipw',  'https://www.whatismyip.com', 'What is My IP'),
+      OpenResource.new('spe',  'http://speedtest.net/',      'Speed Test'),
+      OpenResource.new('this', 'https://github.com/keithrbennett/macwifi', 'mac-wifi Home Page'),
+  ])
+
 
   # Help text to be used when requested by 'h' command, in case of unrecognized or nonexistent command, etc.
   HELP_TEXT = "
@@ -38,11 +68,11 @@ 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
-pu[blic-ip-show]          - opens https://www.whatismyip.com/ in a browser window to show public address info
 pr[ef_nets]               - preferred (not necessarily available) networks
 q[uit]                    - exits this program (interactive shell mode only) (see also 'x')
 r[m_pref_nets] network-name - removes network-name from the preferred networks list
                           (can provide multiple names separated by spaces)
+ro[pen]                   - open resource (#{OPEN_RESOURCES.help_string})
 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)
@@ -269,7 +299,7 @@ When in interactive shell mode:
 
 
   def cmd_n
-    name = model.connected_network_name
+    name = model.current_network
     if interactive_mode
       name
     else
@@ -289,6 +319,16 @@ When in interactive shell mode:
   end
 
 
+  # Use Mac OS 'open' command line utility
+  def cmd_ro(*resource_codes)
+    resource_codes.each do |code|
+      resource = OPEN_RESOURCES.find_by_code(code)
+      if resource
+        model.run_os_command("open #{resource.resource}")
+      end
+    end
+  end
+
   def cmd_pa(network)
     password = model.preferred_network_password(network)
 
@@ -371,9 +411,9 @@ When in interactive shell mode:
         Command.new('n',   'network_name',  -> (*_options) { cmd_n             }),
         Command.new('of',  'off',           -> (*_options) { cmd_of            }),
         Command.new('on',  'on',            -> (*_options) { cmd_on            }),
+        Command.new('ro',  'ropen',         -> (*options)  { cmd_ro(*options)  }),
         Command.new('pa',  'password',      -> (*options)  { cmd_pa(*options)  }),
         Command.new('pr',  'pref_nets',     -> (*_options) { cmd_pr            }),
-        Command.new('pu',  'public_ip_show',-> (*_options) { cmd_pu            }),
         Command.new('q',   'quit',          -> (*_options) { cmd_q             }),
         Command.new('r',   'rm_pref_nets',  -> (*options)  { cmd_r(*options)   }),
         Command.new('t',   'till',          -> (*options)  { cmd_t(*options)   }),

data/lib/mac-wifi/mac_os_model.rb

@@ -181,11 +181,6 @@ class MacOsModel < BaseModel
   end
 
 
-  def connected_network_name
-    wifi_info['SSID']
-  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)}"
@@ -256,17 +251,27 @@ class MacOsModel < BaseModel
   def wifi_info
 
     info = {
-        wifi_on:     wifi_on?,
-        internet_on: connected_to_internet?,
-        port:        wifi_hardware_port,
-        network:     current_network,
-        ip_address:  ip_address,
-        timestamp:   Time.now,
+        'wifi_on'     =>    wifi_on?,
+        'internet_on' => connected_to_internet?,
+        'port'        => wifi_hardware_port,
+        'network'     => current_network,
+        'ip_address'  => ip_address,
+        'nameservers' => nameservers,
+        'timestamp'   => Time.now,
     }
     more_output = run_os_command(AIRPORT_CMD + " -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['wifi_on']
+      begin
+        info['public_ip'] = public_ip_address_info
+      rescue => e
+        puts "Error obtaining public IP address info, proceeding with everything else:"
+        puts e.to_s
+      end
+    end
     info
   end
 

data/lib/mac-wifi/version.rb

@@ -1,5 +1,5 @@
 module MacWifi
 
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mac-wifi
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-22 00:00:00.000000000 Z
+date: 2018-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler