Class: WifiWand::CommandLineInterface

Inherits:
Object
  • Object
show all
Defined in:
lib/wifi-wand/command_line_interface.rb

Defined Under Namespace

Classes: BadCommandError, Command, OpenResource, OpenResources

Constant Summary collapse

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/wifiwand', 'wifi-wand Home Page'),
])
HELP_TEXT =

Help text to be used when requested by ‘h’ command, in case of unrecognized or nonexistent command, etc.

"
Command Line Switches:                    [wifi-wand version #{WifiWand::VERSION} 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
-s                        - run in shell mode
-v                        - verbose mode (prints OS commands and their outputs)

Commands:

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[s_avail_nets]           - details about available networks
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
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)
w[ifion]                  - is the wifi on?
x[it]                     - exits this program (interactive shell mode only) (see also 'q')

When in interactive shell mode:
  * use quotes for string parameters such as method names.
  * for pry commands, use prefix `%`.

"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ CommandLineInterface

Returns a new instance of CommandLineInterface.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/wifi-wand/command_line_interface.rb', line 92

def initialize(options)
  @options = options
  current_os = OperatingSystems.new.current_os
  raise "Could not determine operating system" if current_os.nil?
  model_options = OpenStruct.new({
      verbose:   options.verbose,
      wifi_port: options.wifi_port
  })

  unless awesome_print_available?
    HELP_TEXT << "For nicer output, `gem install awesome_print`.\n\n"
  end

  @model = current_os.create_model(model_options)
  @interactive_mode = !!(options.interactive_mode)
  run_shell if @interactive_mode
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *method_args) ⇒ Object

For use by the shell; when typing a command and options, it is passed to process_command_line



202
203
204
205
206
207
208
209
 
# File 'lib/wifi-wand/command_line_interface.rb', line 202

def method_missing(method_name, *method_args)
  method_name = method_name.to_s
  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
end

Instance Attribute Details

#interactive_mode ⇒ Object (readonly)

Returns the value of attribute interactive_mode.



9
10
11
 
# File 'lib/wifi-wand/command_line_interface.rb', line 9

def interactive_mode
  @interactive_mode
end

#model ⇒ Object (readonly)

Returns the value of attribute model.



9
10
11
 
# File 'lib/wifi-wand/command_line_interface.rb', line 9

def model
  @model
end

#open_resources ⇒ Object (readonly)

Returns the value of attribute open_resources.



9
10
11
 
# File 'lib/wifi-wand/command_line_interface.rb', line 9

def open_resources
  @open_resources
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



9
10
11
 
# File 'lib/wifi-wand/command_line_interface.rb', line 9

def options
  @options
end

Instance Method Details

#awesome_print_available? ⇒ Boolean

We’d like to use awesome_print if it is available, but not require it. So, we try to require it, but if that fails, we fall back to using pp (pretty print), which is included in Ruby distributions without the need to install a gem.

Returns:

  • (Boolean) —

    true if awesome_print is available (after requiring it), else false after requiring ‘pp’.



127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/wifi-wand/command_line_interface.rb', line 127

def awesome_print_available?
  if @awesome_print_available.nil?  # first time here
    begin
      require 'awesome_print'
      @awesome_print_available = true
    rescue LoadError
      require 'pp'
      @awesome_print_available = false
    end
  end

  @awesome_print_available
end

#call ⇒ Object 



493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/wifi-wand/command_line_interface.rb', line 493

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"
    puts '' << separator_line << error.to_s << "\n" << separator_line
    exit(-1)
  end
end

#cmd_a ⇒ Object 



239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/wifi-wand/command_line_interface.rb', line 239

def cmd_a
  info = model.available_network_names
  if interactive_mode
    info
  else
    if post_processor
      puts post_processor.(info)
    else
      puts model.wifi_on? \
          ? "Available networks are:\n\n#{fancy_string(info)}" \
          : "Wifi is off, cannot see available networks."
    end
  end
end

#cmd_ci ⇒ Object 



255
256
257
258
259
260
261
262
 
# File 'lib/wifi-wand/command_line_interface.rb', line 255

def cmd_ci
  connected = model.connected_to_internet?
  if interactive_mode
    connected
  else
    puts (post_processor ? post_processor.(connected) : "Connected to Internet: #{connected}")
  end
end

#cmd_co(network, password = nil) ⇒ Object 



265
266
267
 
# File 'lib/wifi-wand/command_line_interface.rb', line 265

def cmd_co(network, password = nil)
  model.connect(network, password)
end

#cmd_cy ⇒ Object 



270
271
272
 
# File 'lib/wifi-wand/command_line_interface.rb', line 270

def cmd_cy
  model.cycle_network
end

#cmd_d ⇒ Object 



275
276
277
 
# File 'lib/wifi-wand/command_line_interface.rb', line 275

def cmd_d
  model.disconnect
end

#cmd_h ⇒ Object 



280
281
282
 
# File 'lib/wifi-wand/command_line_interface.rb', line 280

def cmd_h
  print_help
end

#cmd_i ⇒ Object 



285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/wifi-wand/command_line_interface.rb', line 285

def cmd_i
  info = model.wifi_info
  if interactive_mode
    info
  else
    if post_processor
      puts post_processor.(info)
    else
      puts fancy_string(info)
    end
  end
end

#cmd_l ⇒ Object 



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/wifi-wand/command_line_interface.rb', line 299

def cmd_l
  info = model.available_network_info
  if interactive_mode
    info
  else
    if post_processor
      puts post_processor.(info)
    else
      message = model.wifi_on? ? fancy_string(info) : "Wifi is off, cannot see available networks."
      puts(message)
    end
  end
end

#cmd_na(*args) ⇒ Object

Performs nameserver functionality.

Parameters:

  • subcommandornoargtoget,toclear,andanarrayofIPaddressestoset ('get''clear') —

    ubcommand ‘get’ or no arg to get, ‘clear’ to clear, and an array of IP addresses to set



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/wifi-wand/command_line_interface.rb', line 316

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

#cmd_ne ⇒ Object 



348
349
350
351
352
353
354
355
356
 
# File 'lib/wifi-wand/command_line_interface.rb', line 348

def cmd_ne
  name = model.connected_network_name
  if interactive_mode
    name
  else
    display_name = name ? name : '[none]'
    puts (post_processor ? post_processor.(name) : %Q{Network (SSID) name: "#{display_name}"})
  end
end

#cmd_of ⇒ Object 



359
360
361
 
# File 'lib/wifi-wand/command_line_interface.rb', line 359

def cmd_of
  model.wifi_off
end

#cmd_on ⇒ Object 



364
365
366
 
# File 'lib/wifi-wand/command_line_interface.rb', line 364

def cmd_on
  model.wifi_on
end

#cmd_pa(network) ⇒ Object 



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/wifi-wand/command_line_interface.rb', line 381

def cmd_pa(network)
  password = model.preferred_network_password(network)

  if interactive_mode
    password
  else
    if post_processor
      puts post_processor.(password)
    else
      output =  %Q{Preferred network "#{model.connected_network_name}" }
      output << (password ? %Q{stored password is "#{password}".} : "has no stored password.")
      puts output
    end
  end
end

#cmd_pr ⇒ Object 



398
399
400
401
402
403
404
405
 
# File 'lib/wifi-wand/command_line_interface.rb', line 398

def cmd_pr
  networks = model.preferred_networks
  if interactive_mode
    networks
  else
    puts (post_processor ? post_processor.(networks) : fancy_string(networks))
  end
end

#cmd_q ⇒ Object 



408
409
410
 
# File 'lib/wifi-wand/command_line_interface.rb', line 408

def cmd_q
  quit
end

#cmd_r(*options) ⇒ Object 



413
414
415
416
417
418
419
420
 
# File 'lib/wifi-wand/command_line_interface.rb', line 413

def cmd_r(*options)
  removed_networks = model.remove_preferred_networks(*options)
  if interactive_mode
    removed_networks
  else
    puts (post_processor ? post_processor.(removed_networks) : "Removed networks: #{removed_networks.inspect}")
  end
end

#cmd_ro(*resource_codes) ⇒ Object

Use Mac OS ‘open’ command line utility



370
371
372
373
374
375
376
377
378
 
# File 'lib/wifi-wand/command_line_interface.rb', line 370

def cmd_ro(*resource_codes)
  resource_codes.each do |code|
    resource = OPEN_RESOURCES.find_by_code(code)
    if resource
      model.open_resource(resource.resource)
    end
  end
  nil
end

#cmd_t(*options) ⇒ Object 



423
424
425
426
427
 
# File 'lib/wifi-wand/command_line_interface.rb', line 423

def cmd_t(*options)
  target_status = options[0].to_sym
  wait_interval_in_secs = (options[1] ? Float(options[1]) : nil)
  model.till(target_status, wait_interval_in_secs)
end

#cmd_w ⇒ Object 



430
431
432
433
434
435
436
437
 
# File 'lib/wifi-wand/command_line_interface.rb', line 430

def cmd_w
  on = model.wifi_on?
  if interactive_mode
    on
  else
    puts (post_processor ? post_processor.(on) : "Wifi on: #{on}")
  end
end

#cmd_x ⇒ Object 



440
441
442
 
# File 'lib/wifi-wand/command_line_interface.rb', line 440

def cmd_x
  quit
end

#commands ⇒ Object 



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/wifi-wand/command_line_interface.rb', line 445

def commands
  @commands_ ||= [
      Command.new('a',   'avail_nets',    -> (*_options) { cmd_a             }),
      Command.new('ci',  'ci',            -> (*_options) { cmd_ci            }),
      Command.new('co',  'connect',       -> (*options)  { cmd_co(*options)  }),
      Command.new('cy',  'cycle',         -> (*_options) { cmd_cy            }),
      Command.new('d',   'disconnect',    -> (*_options) { cmd_d             }),
      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('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)  }),
      Command.new('pa',  'password',      -> (*options)  { cmd_pa(*options)  }),
      Command.new('pr',  'pref_nets',     -> (*_options) { cmd_pr            }),
      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)   }),
      Command.new('w',   'wifi_on',       -> (*_options) { cmd_w             }),
      Command.new('x',   'xit',           -> (*_options) { cmd_x             })
  ]
end

#fancy_puts(object) ⇒ Object Also known as: fp 



147
148
149
 
# File 'lib/wifi-wand/command_line_interface.rb', line 147

def fancy_puts(object)
  puts fancy_string(object)
end

#fancy_string(object) ⇒ Object 



142
143
144
 
# File 'lib/wifi-wand/command_line_interface.rb', line 142

def fancy_string(object)
  awesome_print_available? ? object.ai : object.pretty_inspect
end

#find_command_action(command_string) ⇒ Object 



471
472
473
474
475
476
477
478
479
 
# File 'lib/wifi-wand/command_line_interface.rb', line 471

def find_command_action(command_string)
  result = commands.detect do |cmd|
    cmd.max_string.start_with?(command_string) \
    && \
    command_string.length >= cmd.min_string.length  # e.g. 'c' by itself should not work
  end

  result ? result.action : nil
end

#post_process(object) ⇒ Object

If a post-processor has been configured (e.g. YAML or JSON), use it.



483
484
485
 
# File 'lib/wifi-wand/command_line_interface.rb', line 483

def post_process(object)
  post_processor ? post_processor.(object) : object
end

#post_processor ⇒ Object 



488
489
490
 
# File 'lib/wifi-wand/command_line_interface.rb', line 488

def post_processor
  options.post_processor
end

#print_help ⇒ Object 



118
119
120
 
# File 'lib/wifi-wand/command_line_interface.rb', line 118

def print_help
  puts HELP_TEXT
end

#process_command_line(command, args) ⇒ Object

Processes the command (ARGV) and any relevant options (ARGV).

CAUTION! In interactive mode, any strings entered (e.g. a network name) MUST 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!



218
219
220
221
222
223
224
225
226
227
 
# File 'lib/wifi-wand/command_line_interface.rb', line 218

def process_command_line(command, args)
  action = find_command_action(command)
  if action
    action.(*args)
  else
    print_help
    raise BadCommandError.new(
        %Q{Unrecognized command. Command was "#{command}" and options were #{args.inspect}.})
  end
end

#quit ⇒ Object 



230
231
232
233
234
235
236
 
# File 'lib/wifi-wand/command_line_interface.rb', line 230

def quit
  if interactive_mode
    exit(0)
  else
    puts "This command can only be run in shell mode."
  end
end

#run_pry ⇒ Object

Pry will output the content of the method from which it was called. This small method exists solely to reduce the amount of pry’s output that is not needed here.



166
167
168
169
170
171
172
 
# File 'lib/wifi-wand/command_line_interface.rb', line 166

def run_pry
  binding.pry

  # the seemingly useless line below is needed to avoid pry's exiting
  # (see https://github.com/deivid-rodriguez/pry-byebug/issues/45)
  _a = nil
end

#run_shell ⇒ Object

Runs a pry session in the context of this object. Commands and options specified on the command line can also be specified in the shell.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/wifi-wand/command_line_interface.rb', line 177

def run_shell
  begin
    require 'pry'
  rescue LoadError
    puts "The 'pry' gem and/or one of its prerequisites, required for running the shell, was not found." +
             " Please `gem install pry` or, if necessary, `sudo gem install pry`."
    exit(-1)
  end

  print_help

  # Enable the line below if you have any problems with pry configuration being loaded
  # that is messing up this runtime use of pry:
  # Pry.config.should_load_rc = false

  # Strangely, this is the only thing I have found that successfully suppresses the
  # code context output, which is not useful here. Anyway, this will differentiate
  # a pry command from a DSL command, which _is_ useful here.
  Pry.config.command_prefix = '%'

  run_pry
end

#validate_command_line ⇒ Object

Asserts that a command has been passed on the command line.



154
155
156
157
158
159
160
 
# File 'lib/wifi-wand/command_line_interface.rb', line 154

def validate_command_line
  if ARGV.empty?
    puts "Syntax is: #{$0} [options] command [command_options]"
    print_help
    exit(-1)
  end
end

#verbose_mode ⇒ Object

Until command line option parsing is added, the only way to specify verbose mode is in the environment variable MAC_WIFI_OPTS.



113
114
115
 
# File 'lib/wifi-wand/command_line_interface.rb', line 113

def verbose_mode
  options.verbose
end