Class: OneAndOne::Image

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(test: false) ⇒ Image

Returns a new instance of Image.



11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/1and1/image.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/image.rb', line 7

def id
  @id
end

#specs ⇒ Object

Returns the value of attribute specs.



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

def specs
  @specs
end

Instance Method Details

#create(server_id: nil, name: nil, description: nil, frequency: nil, num_images: nil, source: nil, url: nil, os_id: nil, type: nil) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
126
127
128
129
 
# File 'lib/1and1/image.rb', line 85

def create(server_id: nil, name: nil, description: nil, frequency: nil,
  num_images: nil, source: nil, url: nil, os_id: nil, type: nil)

  # Build POST body
  new_image = {
    'server_id' => server_id,
    'name' => name,
    'description' => description,
    'frequency' => frequency,
    'num_images' => num_images,
    'source' => source,
    'url' => url,
    'os_id' => os_id,
    'type' => type
  }

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

  # Stringify the POST body
  string_body = body.to_json

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

  # 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 image ID to Image instance
  @id = json['id']
  @specs = json

  # If all good, return JSON
  json

end

#delete(image_id: @id) ⇒ Object 



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

def delete(image_id: @id)

  # If user passed in image ID, reassign
  @id = image_id

  # Build URL
  path = OneAndOne.build_url("/images/#{@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(image_id: @id) ⇒ 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
 
# File 'lib/1and1/image.rb', line 57

def get(image_id: @id)

  # If user passed in image ID, reassign
  @id = image_id

  # Build URL
  path = OneAndOne.build_url("/images/#{@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/image.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('/images')

  # 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(image_id: @id, name: nil, description: nil, frequency: nil) ⇒ Object 



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
164
165
 
# File 'lib/1and1/image.rb', line 132

def modify(image_id: @id, name: nil, description: nil, frequency: nil)

  # If user passed in image ID, reassign
  @id = image_id

  # Build PUT body
  image_specs = {
    'name' => name,
    'description' => description,
    'frequency' => frequency
  }

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

  # Stringify the PUT body
  string_body = body.to_json

  # Build URL
  path = OneAndOne.build_url("/images/#{@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 



190
191
192
193
194
195
 
# File 'lib/1and1/image.rb', line 190

def reload

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

end

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/1and1/image.rb', line 198

def wait_for(timeout: 25, interval: 15)

  # Capture start time
  start = Time.now

  # Poll image and check initial state
  initial_response = get
  image_state = initial_response['state']

  # Keep polling the image's state until good
  until $good_states.include? image_state

    # Wait 15 seconds before polling again
    sleep interval

    # Check image state again
    current_response = get
    image_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