wifi-wand 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9c498e8044e8913348ab143847be13dd0e1683d72c0e26448ae63d817a0675d
-  data.tar.gz: 440847dc2ddc905172a60cf090b863669ec5fef41d5a23f93e7540326d257583
+  metadata.gz: 3dcc159a696bb6c5802164faa4364c372d12478c38027cc0cef1b8efcd28f4a8
+  data.tar.gz: f6dcd8a61c97e38c6fe1cd35d6e1c46a5112993c9e3d319dbcd6cc6105b6c963
 SHA512:
-  metadata.gz: 5ab2bfebaf3c9dd5ad50e8cc7f9aeaa96c1f9799c504153616e920e278419b4f9d004f32083997f1f5c9cc0794557d6b5af093f2b483f519c1d4691b25346772
-  data.tar.gz: 48cc73787df1b6d8a5cb0aa641047bd7b796c9e2c7cf8b25d112427122c780101d7847d3b380cb704ac2f173eb3e8ba9b294295e26e6cca5ee299b93cc95a449
+  metadata.gz: f2e6bf5a8ad731631e464826ec096a5ba10e61111aab1ca66232a5f1453ea98d26c0e3b5a670d754f6ff16d0829b9b4177a5276def708f3fe0be6d9385cbe6f5
+  data.tar.gz: aee01f531189ace41937a7722a413873018792e9a2e161b8dd2634e87c1952763c85f7648ed7b7ac0d0d7b0b205955f70143aaa67f9961abd21eed69176647f9

data/README.md

@@ -28,11 +28,9 @@ output at the time of this writing:
 ```
 $ wifi-wand -h
 
+Command Line Switches:                    [wifi-wand version 2.6.0]
 
-
-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,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)
@@ -47,7 +45,8 @@ d[isconnect]              - disconnects from current network, does not turn off
 h[elp]                    - prints this help
 i[nfo]                    - a hash of wifi-related information
 l[s_avail_nets]           - details about available networks
-n[etwork_name]            - name (SSID) of currently connected network
+na[meservers]             - nameservers: 'show' or no arg to show, 'clear' to clear, or IP addresses to set, e.g. '9.9.9.9  8.8.8.8'
+ne[twork_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

data/RELEASE_NOTES.md

@@ -1,3 +1,9 @@
+## v2.6.0
+
+* Add support for getting and setting DNS nameservers with 'na'/'nameservers' command.
+* Improve error output readability for top level error catching.
+
+
 ## v2.5.0
 
 * Add limited support for nonstandard wifi devices (https://github.com/keithrbennett/wifiwand/issues/6).

data/lib/wifi-wand/command_line_interface.rb

@@ -67,7 +67,8 @@ d[isconnect]              - disconnects from current network, does not turn off
 h[elp]                    - prints this help
 i[nfo]                    - a hash of wifi-related information
 l[s_avail_nets]           - details about available networks
-n[etwork_name]            - name (SSID) of currently connected network
+na[meservers]             - nameservers: 'show' or no arg to show, 'clear' to clear, or IP addresses to set, e.g. '9.9.9.9  8.8.8.8'
+ne[twork_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
@@ -193,11 +194,10 @@ When in interactive shell mode:
 
 
   # For use by the shell; when typing a command and options, it is passed to process_command_line
-  def method_missing(method_name, *options)
+  def method_missing(method_name, *method_args)
     method_name = method_name.to_s
-    method_exists = !! find_command_action(method_name)
-    if method_exists
-      process_command_line(method_name, options)
+    if find_command_action(method_name)
+      process_command_line(method_name, method_args)
     else
       puts(%Q{"#{method_name}" is not a valid command or option. If you intend for this to be a string literal, use quotes or %q/Q{}.})
     end
@@ -210,14 +210,14 @@ When in interactive shell mode:
   # be in a form that the Ruby interpreter will recognize as a string,
   # i.e. single or double quotes, %q, %Q, etc.
   # Otherwise it will assume it's a method name and pass it to method_missing!
-  def process_command_line(command, options)
+  def process_command_line(command, args)
     action = find_command_action(command)
     if action
-      action.(*options)
+      action.(*args)
     else
       print_help
       raise BadCommandError.new(
-          %Q{Unrecognized command. Command was "#{command}" and options were #{options.inspect}.})
+          %Q{Unrecognized command. Command was "#{command}" and options were #{args.inspect}.})
     end
   end
 
@@ -306,7 +306,41 @@ When in interactive shell mode:
   end
 
 
-  def cmd_n
+  # Performs nameserver functionality.
+  # @param subcommand 'get' or no arg to get, 'clear' to clear, and an array of IP addresses to set
+  def cmd_na(*args)
+
+    subcommand = if [[], ['get']].include?(args)
+      :get
+    elsif args == ['clear']
+      :clear
+    else
+      :put
+    end
+
+    case(subcommand)
+      when :get
+        current_nameservers = model.nameservers_using_networksetup
+        if interactive_mode
+          current_nameservers
+        else
+          if post_processor
+            puts post_processor.(current_nameservers)
+          else
+            current_nameservers_as_string = current_nameservers.empty? ? "[None]" : current_nameservers.join(', ')
+            puts "Nameservers: #{current_nameservers_as_string}"
+          end
+        end
+      when :clear
+        model.set_nameservers(:clear)
+      when :put
+        new_nameservers = args
+        model.set_nameservers(new_nameservers)
+    end
+  end
+
+
+  def cmd_ne
     name = model.connected_network_name
     if interactive_mode
       name
@@ -416,7 +450,8 @@ When in interactive shell mode:
         Command.new('h',   'help',          -> (*_options) { cmd_h             }),
         Command.new('i',   'info',          -> (*_options) { cmd_i             }),
         Command.new('l',   'ls_avail_nets', -> (*_options) { cmd_l             }),
-        Command.new('n',   'network_name',  -> (*_options) { cmd_n             }),
+        Command.new('na',  'nameservers',   -> (*options)  { cmd_na(*options)  }),
+        Command.new('ne',  'network_name',  -> (*_options) { cmd_ne            }),
         Command.new('of',  'off',           -> (*_options) { cmd_of            }),
         Command.new('on',  'on',            -> (*_options) { cmd_on            }),
         Command.new('ro',  'ropen',         -> (*options)  { cmd_ro(*options)  }),
@@ -457,6 +492,8 @@ When in interactive shell mode:
   def call
     validate_command_line
     begin
+      # By this time, the Main class has removed the command line options, and all that is left
+      # in ARGV is the commands and their options.
       process_command_line(ARGV[0], ARGV[1..-1])
     rescue BadCommandError => error
       separator_line = "! #{'-' * 75} !\n"

data/lib/wifi-wand/main.rb

@@ -62,7 +62,8 @@ class Main
     begin
       WifiWand::CommandLineInterface.new(options).call
     rescue => e
-      puts "Error: #{e.message}"
+      # require 'pry'; binding.pry
+      puts "Error: #{e.backtrace.join("\n")}\n\n#{e.message}"
     end
   end
 end

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

@@ -77,7 +77,7 @@ class BaseModel
 
     begin
       start_status_script = -> do
-        script = "curl --silent --head http://www.google.com/ > /dev/null ; echo $? > #{tempfile.path} &"
+        script = "curl --silent --head https://www.google.com/ > /dev/null ; echo $? > #{tempfile.path} &"
         pid = Process.spawn(script)
         Process.detach(pid)
         pid
@@ -246,27 +246,6 @@ class BaseModel
   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_using_resolv_conf
-    begin
-      File.readlines('/etc/resolv.conf').grep(/^nameserver /).map { |line| line.split.last }
-    rescue Errno::ENOENT
-      nil
-    end
-  end
-
-
-  def nameservers_using_scutil
-    output = run_os_command('scutil --dns')
-    nameserver_lines_scoped_and_unscoped = output.split("\n").grep(/^\s*nameserver\[/)
-    unique_nameserver_lines = nameserver_lines_scoped_and_unscoped.uniq # take the union
-    nameservers = unique_nameserver_lines.map { |line| line.split(' : ').last.strip }
-    nameservers
-  end
-
-
   def wifi_port
     @wifi_port ||= detect_wifi_port
   end

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

@@ -1,3 +1,4 @@
+require 'ipaddr'
 require 'ostruct'
 require 'shellwords'
 
@@ -300,6 +301,29 @@ class MacOsModel < BaseModel
   end
 
 
+  def set_nameservers(nameservers)
+    arg = if nameservers == :clear
+      'empty'
+    else
+      bad_addresses = nameservers.reject do |ns|
+        begin
+          IPAddr.new(ns).ipv4?
+          true
+        rescue => e
+          puts e
+          false
+        end
+      end
+
+      unless bad_addresses.empty?
+        raise "Bad IP addresses provided: #{bad_addresses.join(', ')}"
+      end
+      nameservers.join(' ')
+    end
+    run_os_command("networksetup -setdnsservers Wi-Fi #{arg}")
+  end
+
+
   def open_resource(resource_url)
     run_os_command('open ' + resource_url)
   end
@@ -319,5 +343,31 @@ class MacOsModel < BaseModel
     end
   end
   private :colon_output_to_hash
+
+  # @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_using_resolv_conf
+    begin
+      File.readlines('/etc/resolv.conf').grep(/^nameserver /).map { |line| line.split.last }
+    rescue Errno::ENOENT
+      nil
+    end
+  end
+
+
+  def nameservers_using_scutil
+    output = run_os_command('scutil --dns')
+    nameserver_lines_scoped_and_unscoped = output.split("\n").grep(/^\s*nameserver\[/)
+    unique_nameserver_lines = nameserver_lines_scoped_and_unscoped.uniq # take the union
+    nameservers = unique_nameserver_lines.map { |line| line.split(' : ').last.strip }
+    nameservers
+  end
+
+
+  def nameservers_using_networksetup
+    output = run_os_command("networksetup -getdnsservers Wi-Fi")
+    output.split("\n")
+  end
 end
 end

data/lib/wifi-wand/version.rb

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

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

@@ -1,9 +1,12 @@
 # The functionality of this software is very difficult to test,
-# sinece it relies on external conditions that cannot be faked.
+# since it relies on external conditions that cannot be faked.
 # These tests merely run the commands and assert that no
 # error has occurred; they don't make any attempt to verify the data.
 # Many of them are run once with the wifi on, and once when it's off.
-
+#
+# This test is in no way pretending to be thorough or accurate.
+# Furthermore, since it modifies machine-global state and can interfere with
+# other processes running on the host, it should be used with utmost care.
 
 require_relative '../../../lib/wifi-wand/models/mac_os_model'
 

metadata

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