Class: WifiWand::BaseModel

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

Direct Known Subclasses

MacOsModel

Defined Under Namespace

Classes: OsCommandError

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ BaseModel

Returns a new instance of BaseModel.



32
33
34
35
36
37
38
39
 
# File 'lib/wifi-wand/models/base_model.rb', line 32

def initialize(options)
  @verbose_mode = options.verbose

  if options.wifi_port && (! is_wifi_port?(options.wifi_port))
    raise "#{options.wifi_port} is not a Wi-Fi interface."
  end
  @wifi_port = options.wifi_port
end

Instance Attribute Details

#verbose_mode ⇒ Object

Returns the value of attribute verbose_mode.



11
12
13
 
# File 'lib/wifi-wand/models/base_model.rb', line 11

def verbose_mode
  @verbose_mode
end

#wifi_port ⇒ Object

Returns the value of attribute wifi_port.



11
12
13
 
# File 'lib/wifi-wand/models/base_model.rb', line 11

def wifi_port
  @wifi_port
end

Instance Method Details



42
43
44
 
# File 'lib/wifi-wand/models/base_model.rb', line 42

def banner_line
  @banner_line ||= '-' * 79
end

#command_attempt_as_string(command) ⇒ Object 



46
47
48
 
# File 'lib/wifi-wand/models/base_model.rb', line 46

def command_attempt_as_string(command)
  "\n\n#{banner_line}\nCommand: #{command}\n"
end

#command_result_as_string(output) ⇒ Object 



50
51
52
 
# File 'lib/wifi-wand/models/base_model.rb', line 50

def command_result_as_string(output)
  "#{output}#{banner_line}\n\n"
end

#connect(network_name, password = nil) ⇒ Object

Connects to the passed network name, optionally with password. Turns wifi on first, in case it was turned off. Relies on subclass implementation of os_level_connect().



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/wifi-wand/models/base_model.rb', line 125

def connect(network_name, password = nil)
  # Allow symbols and anything responding to to_s for user convenience
  network_name = network_name.to_s if network_name
  password     = password.to_s     if password

  if network_name.nil? || network_name.empty?
    raise "A network name is required but was not provided."
  end
  wifi_on
  os_level_connect(network_name, password)

  # Verify that the network is now connected:
  actual_network_name = connected_network_name
  unless actual_network_name == network_name
    message = %Q{Expected to connect to "#{network_name}" but }
    if actual_network_name
      message << %Q{connected to "#{connected_network_name}" instead.}
    else
      message << "unable to connect to any network. Did you "
    end
    message << (password ? "provide the correct password?" : "need to provide a password?")
    raise message
  end
  nil
end

#connected_to?(network_name) ⇒ Boolean

Returns:

  • (Boolean) 


117
118
119
 
# File 'lib/wifi-wand/models/base_model.rb', line 117

def connected_to?(network_name)
  network_name == connected_network_name
end

#connected_to_internet? ⇒ Boolean

This method returns whether or not there is a working Internet connection, which is defined as being able to get a successful response from google.com within 3 seconds..

Returns:

  • (Boolean) 


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/wifi-wand/models/base_model.rb', line 79

def connected_to_internet?
  test_site = 'https://www.google.com'
  url = URI.parse(test_site)
  success = true

  if @verbose_mode
    puts command_attempt_as_string("[Calling Net:HTTP.start(#{url.host})]")
  end

  begin
    Net::HTTP.start(url.host) do |http|
      http.read_timeout = 3 # seconds
      http.get('.')
    end
  rescue
    success = false
  end

  if @verbose_mode
    puts command_result_as_string("#{success}\n")
  end

  success
end

#cycle_network ⇒ Object

Turns wifi off and then on, reconnecting to the originally connecting network.



106
107
108
109
110
111
112
113
114
 
# File 'lib/wifi-wand/models/base_model.rb', line 106

def cycle_network
  # TODO: Make this network name saving and restoring conditional on it not having a password.
  # If the disabled code below is enabled, an error will be raised if a password is required,
  # even though it is stored.
  # network_name = connected_network_name
  wifi_off
  wifi_on
  # connect(network_name) if network_name
end

#preferred_network_password(preferred_network_name) ⇒ Object 



161
162
163
164
165
166
167
168
 
# File 'lib/wifi-wand/models/base_model.rb', line 161

def preferred_network_password(preferred_network_name)
  preferred_network_name = preferred_network_name.to_s
  if preferred_networks.include?(preferred_network_name)
    os_level_preferred_network_password(preferred_network_name)
  else
    raise "Network #{preferred_network_name} not in preferred networks list."
  end
end

#public_ip_address_info ⇒ Object

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.



223
224
225
 
# File 'lib/wifi-wand/models/base_model.rb', line 223

def public_ip_address_info
  JSON.parse(`curl -s ipinfo.io`)
end

#remove_preferred_networks(*network_names) ⇒ Object

Removes the specified network(s) from the preferred network list.

Parameters:

  • network_names —

    names of networks to remove; may be empty or contain nonexistent networks

Returns:

  • names of the networks that were removed (excludes non-preexisting networks)



155
156
157
158
 
# File 'lib/wifi-wand/models/base_model.rb', line 155

def remove_preferred_networks(*network_names)
  networks_to_remove = network_names & preferred_networks # exclude any nonexistent networks
  networks_to_remove.each { |name| remove_preferred_network(name) }
end

#run_os_command(command, raise_on_error = true) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/wifi-wand/models/base_model.rb', line 56

def run_os_command(command, raise_on_error = true)

  if @verbose_mode
    puts command_attempt_as_string(command)
  end

  output = `#{command} 2>&1` # join stderr with stdout

  if @verbose_mode
    puts command_result_as_string(output)
  end

  if $?.exitstatus != 0 && raise_on_error
    raise OsCommandError.new($?.exitstatus, command, output)
  end

  output
end

#till(target_status, wait_interval_in_secs = nil) ⇒ Object

Waits for the Internet connection to be in the desired state.

Parameters:

  • target_status —

    must be in [:conn, :disc, :off, :on]; waits for that state

  • wait_interval_in_secs (defaults to: nil) —

    sleeps this interval between retries; if nil or absent, a default will be provided



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

def till(target_status, wait_interval_in_secs = nil)

  # One might ask, why not just put the 0.5 up there as the default argument.
  # We could do that, but we'd still need the line below in case nil
  # was explicitly specified. The default argument of nil above emphasizes that
  # the absence of an argument and a specification of nil will behave identically.
  wait_interval_in_secs ||= 0.5

  finished_predicates = {
      conn: -> { connected_to_internet? },
      disc: -> { ! connected_to_internet? },
      on:   -> { wifi_on? },
      off:  -> { ! wifi_on? }
  }

  finished_predicate = finished_predicates[target_status]

  if finished_predicate.nil?
    raise ArgumentError.new(
        "Option must be one of #{finished_predicates.keys.inspect}. Was: #{target_status.inspect}")
  end

  loop do
    return if finished_predicate.()
    sleep(wait_interval_in_secs)
  end
end

#try_os_command_until(command, stop_condition, max_tries = 100) ⇒ Object

Tries an OS command until the stop condition is true.

Returns:

  • the stdout produced by the command



209
210
211
212
213
214
215
216
217
 
# File 'lib/wifi-wand/models/base_model.rb', line 209

def try_os_command_until(command, stop_condition, max_tries = 100)
  max_tries.times do
    stdout = run_os_command(command)
    if stop_condition.(stdout)
      return stdout
    end
  end
  nil
end