Class: OneAndOne::PrivateNetwork

Inherits:
Object
  • Object
show all
Defined in:
lib/1and1/private_network.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(test: false) ⇒ PrivateNetwork

Returns a new instance of PrivateNetwork.



11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/1and1/private_network.rb', line 11

def initialize(test: false)
  @id = nil
  @specs = nil

  # Check if hitting mock api or live api
  if test
    @connection = Excon.new($base_url, :mock => true)
  else
    @connection = Excon.new($base_url)
  end

end

Instance Attribute Details

#id ⇒ Object

Returns the value of attribute id.



7
8
9
 
# File 'lib/1and1/private_network.rb', line 7

def id
  @id
end

#specs ⇒ Object

Returns the value of attribute specs.



8
9
10
 
# File 'lib/1and1/private_network.rb', line 8

def specs
  @specs
end

Instance Method Details

#add_servers(private_network_id: @id, servers: nil) ⇒ Object 



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/1and1/private_network.rb', line 254

def add_servers(private_network_id: @id, servers: nil)

  # If user passed in private network ID, reassign
  @id = private_network_id

  # Build POST body
  new_servers = {
    'servers' => servers
  }

  # Clean out null keys in POST body
  body = OneAndOne.clean_hash(new_servers)

  # Stringify the PUT body
  string_body = body.to_json

  # Build URL
  path = OneAndOne.build_url("/private_networks/#{@id}/servers")

  # Perform request
  response = @connection.request(:method => :post,
    :path => path,
    :headers => $header,
    :body => string_body)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#create(name: nil, description: nil, network_address: nil, subnet_mask: nil, datacenter_id: nil) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/1and1/private_network.rb', line 57

def create(name: nil, description: nil, network_address: nil,
  subnet_mask: nil, datacenter_id: nil)

  # Build POST body
  new_private_network = {
    'name' => name,
    'description' => description,
    'network_address' => network_address,
    'subnet_mask' => subnet_mask,
    'datacenter_id' => datacenter_id
  }

  # Clean out null keys in POST body
  body = OneAndOne.clean_hash(new_private_network)

  # Stringify the POST body
  string_body = body.to_json

  # Build URL
  path = OneAndOne.build_url('/private_networks')

  # Perform request
  response = @connection.request(:method => :post,
    :path => path,
    :headers => $header,
    :body => string_body)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  json = JSON.parse(response.body)

  # Save new private network ID to PrivateNetwork instance
  @id = json['id']
  @specs = json

  # If all good, return JSON
  json

end

#delete(private_network_id: @id) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/1and1/private_network.rb', line 166

def delete(private_network_id: @id)

  # If user passed in private network ID, reassign
  @id = private_network_id

  # Build URL
  path = OneAndOne.build_url("/private_networks/#{@id}")

  # Perform request
  response = @connection.request(:method => :delete,
    :path => path,
    :headers => $header)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#get(private_network_id: @id) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/1and1/private_network.rb', line 100

def get(private_network_id: @id)

  # If user passed in private network ID, reassign
  @id = private_network_id

  # Build URL
  path = OneAndOne.build_url("/private_networks/#{@id}")

  # Perform request
  response = @connection.request(:method => :get,
    :path => path,
    :headers => $header)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  json = JSON.parse(response.body)

  # Reload specs attribute
  @specs = json

  # If all good, return JSON
  json

end

#list(page: nil, per_page: nil, sort: nil, q: nil, fields: nil) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/1and1/private_network.rb', line 25

def list(page: nil, per_page: nil, sort: nil, q: nil, fields: nil)

  # Build hash for query parameters
  keyword_args = {
    :page => page,
    :per_page => per_page,
    :sort => sort,
    :q => q,
    :fields => fields
  }

  # Clean out null query parameters
  params = OneAndOne.clean_hash(keyword_args)

  # Build URL
  path = OneAndOne.build_url('/private_networks')

  # Perform request
  response = @connection.request(:method => :get,
    :path => path,
    :headers => $header,
    :query => params)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#modify(private_network_id: @id, name: nil, description: nil, network_address: nil, subnet_mask: nil) ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/1and1/private_network.rb', line 128

def modify(private_network_id: @id, name: nil, description: nil,
  network_address: nil, subnet_mask: nil)

  # If user passed in private network ID, reassign
  @id = private_network_id

  # Build PUT body
  new_private_network = {
    'name' => name,
    'description' => description,
    'network_address' => network_address,
    'subnet_mask' => subnet_mask
  }

  # Clean out null keys in PUT body
  body = OneAndOne.clean_hash(new_private_network)

  # Stringify the PUT body
  string_body = body.to_json

  # Build URL
  path = OneAndOne.build_url("/private_networks/#{@id}")

  # Perform request
  response = @connection.request(:method => :put,
    :path => path,
    :headers => $header,
    :body => string_body)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#reload ⇒ Object 



288
289
290
291
292
293
 
# File 'lib/1and1/private_network.rb', line 288

def reload

  # This reload fx is just a wrapper for the get fx
  get

end

#remove_server(private_network_id: @id, server_id: nil) ⇒ Object 



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/1and1/private_network.rb', line 232

def remove_server(private_network_id: @id, server_id: nil)

  # If user passed in private network ID, reassign
  @id = private_network_id

  # Build URL
  path = OneAndOne.build_url("/private_networks/#{@id}/servers/#{server_id}")

  # Perform request
  response = @connection.request(:method => :delete,
    :path => path,
    :headers => $header)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#server(private_network_id: @id, server_id: nil) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/1and1/private_network.rb', line 210

def server(private_network_id: @id, server_id: nil)

  # If user passed in private network ID, reassign
  @id = private_network_id

  # Build URL
  path = OneAndOne.build_url("/private_networks/#{@id}/servers/#{server_id}")

  # Perform request
  response = @connection.request(:method => :get,
    :path => path,
    :headers => $header)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#servers(private_network_id: @id) ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/1and1/private_network.rb', line 188

def servers(private_network_id: @id)

  # If user passed in private network ID, reassign
  @id = private_network_id

  # Build URL
  path = OneAndOne.build_url("/private_networks/#{@id}/servers")

  # Perform request
  response = @connection.request(:method => :get,
    :path => path,
    :headers => $header)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#wait_for(timeout: 25, interval: 5) ⇒ Object 



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/1and1/private_network.rb', line 296

def wait_for(timeout: 25, interval: 5)

  # Capture start time
  start = Time.now

  # Poll private network and check initial state
  initial_response = get
  private_network_state = initial_response['state']

  # Keep polling the private network's state until good
  until $good_states.include? private_network_state

    # Wait 5 seconds before polling again
    sleep interval

    # Check private network state again
    current_response = get
    private_network_state = current_response['state']

    # Calculate current duration and check for timeout
    duration = (Time.now - start) / 60
    if duration > timeout
      puts "The operation timed out after #{timeout} minutes.\n"
      return
    end

  end

  # Return Duration
  {:duration => duration}

end