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}]

-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
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[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.



91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/wifi-wand/command_line_interface.rb', line 91

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
  })
  @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, *options) ⇒ Object

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



196
197
198
199
200
201
202
203
204
 
# File 'lib/wifi-wand/command_line_interface.rb', line 196

def method_missing(method_name, *options)
  method_name = method_name.to_s
  method_exists = !! find_command_action(method_name)
  if method_exists
    process_command_line(method_name, options)
  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’.



121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/wifi-wand/command_line_interface.rb', line 121

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 



457
458
459
460
461
462
463
464
465
466
 
# File 'lib/wifi-wand/command_line_interface.rb', line 457

def call
  validate_command_line
  begin
    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 



234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/wifi-wand/command_line_interface.rb', line 234

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 



250
251
252
253
254
255
256
257
 
# File 'lib/wifi-wand/command_line_interface.rb', line 250

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 



260
261
262
 
# File 'lib/wifi-wand/command_line_interface.rb', line 260

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

#cmd_cy ⇒ Object 



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

def cmd_cy
  model.cycle_network
end

#cmd_d ⇒ Object 



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

def cmd_d
  model.disconnect
end

#cmd_h ⇒ Object 



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

def cmd_h
  print_help
end

#cmd_i ⇒ Object 



280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/wifi-wand/command_line_interface.rb', line 280

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 



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/wifi-wand/command_line_interface.rb', line 294

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_n ⇒ Object 



309
310
311
312
313
314
315
316
317
 
# File 'lib/wifi-wand/command_line_interface.rb', line 309

def cmd_n
  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 



320
321
322
 
# File 'lib/wifi-wand/command_line_interface.rb', line 320

def cmd_of
  model.wifi_off
end

#cmd_on ⇒ Object 



325
326
327
 
# File 'lib/wifi-wand/command_line_interface.rb', line 325

def cmd_on
  model.wifi_on
end

#cmd_pa(network) ⇒ Object 



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/wifi-wand/command_line_interface.rb', line 340

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 



357
358
359
360
361
362
363
364
 
# File 'lib/wifi-wand/command_line_interface.rb', line 357

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

#cmd_pu ⇒ Object 



367
368
369
 
# File 'lib/wifi-wand/command_line_interface.rb', line 367

def cmd_pu
  `open https://www.whatismyip.com/`
end

#cmd_q ⇒ Object 



372
373
374
 
# File 'lib/wifi-wand/command_line_interface.rb', line 372

def cmd_q
  quit
end

#cmd_r(*options) ⇒ Object 



377
378
379
380
381
382
383
384
 
# File 'lib/wifi-wand/command_line_interface.rb', line 377

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



331
332
333
334
335
336
337
338
 
# File 'lib/wifi-wand/command_line_interface.rb', line 331

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
end

#cmd_t(*options) ⇒ Object 



387
388
389
390
391
 
# File 'lib/wifi-wand/command_line_interface.rb', line 387

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 



394
395
396
397
398
399
400
401
 
# File 'lib/wifi-wand/command_line_interface.rb', line 394

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 



404
405
406
 
# File 'lib/wifi-wand/command_line_interface.rb', line 404

def cmd_x
  quit
end

#commands ⇒ Object 



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/wifi-wand/command_line_interface.rb', line 409

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('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('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',   'wifion',        -> (*_options) { cmd_w             }),
      Command.new('x',   'xit',           -> (*_options) { cmd_x             })
  ]
end

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



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

def fancy_puts(object)
  puts fancy_string(object)
end

#fancy_string(object) ⇒ Object 



136
137
138
 
# File 'lib/wifi-wand/command_line_interface.rb', line 136

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

#find_command_action(command_string) ⇒ Object 



434
435
436
437
438
439
440
441
442
 
# File 'lib/wifi-wand/command_line_interface.rb', line 434

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.



446
447
448
 
# File 'lib/wifi-wand/command_line_interface.rb', line 446

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

#post_processor ⇒ Object 



452
453
454
 
# File 'lib/wifi-wand/command_line_interface.rb', line 452

def post_processor
  options.post_processor
end

#print_help ⇒ Object 



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

def print_help
  puts HELP_TEXT
end

#process_command_line(command, options) ⇒ 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!



213
214
215
216
217
218
219
220
221
222
 
# File 'lib/wifi-wand/command_line_interface.rb', line 213

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

#quit ⇒ Object 



225
226
227
228
229
230
231
 
# File 'lib/wifi-wand/command_line_interface.rb', line 225

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.



160
161
162
163
164
165
166
 
# File 'lib/wifi-wand/command_line_interface.rb', line 160

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.



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/wifi-wand/command_line_interface.rb', line 171

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.



148
149
150
151
152
153
154
 
# File 'lib/wifi-wand/command_line_interface.rb', line 148

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.



107
108
109
 
# File 'lib/wifi-wand/command_line_interface.rb', line 107

def verbose_mode
  options.verbose
end