Class: OneAndOne::PublicIP

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(test: false) ⇒ PublicIP

Returns a new instance of PublicIP.



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

def id
  @id
end

#specs ⇒ Object

Returns the value of attribute specs.



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

def specs
  @specs
end

Instance Method Details

#create(reverse_dns: nil, type: 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
 
# File 'lib/1and1/public_ip.rb', line 57

def create(reverse_dns: nil, type: nil, datacenter_id: nil)

  # Build POST body
  new_ip = {
    'reverse_dns' => reverse_dns,
    'type' => type,
    'datacenter_id' => datacenter_id
  }

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

  # Stringify the POST body
  string_body = body.to_json

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

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

  # If all good, return JSON
  json

end

#delete(ip_id: @id) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/1and1/public_ip.rb', line 159

def delete(ip_id: @id)

  # If user passed in IP ID, reassign
  @id = ip_id

  # Build URL
  path = OneAndOne.build_url("/public_ips/#{@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(ip_id: @id) ⇒ Object 



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
 
# File 'lib/1and1/public_ip.rb', line 97

def get(ip_id: @id)

  # If user passed in IP ID, reassign
  @id = ip_id

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

  # 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(ip_id: @id, reverse_dns: nil) ⇒ Object 



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
150
151
152
153
154
155
156
 
# File 'lib/1and1/public_ip.rb', line 125

def modify(ip_id: @id, reverse_dns: nil)

  # If user passed in shared_storage ID, reassign
  @id = ip_id

  # Build PUT body
  new_ip = {
    'reverse_dns' => reverse_dns
  }

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

  # Stringify the POST body
  string_body = body.to_json

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



181
182
183
184
185
186
 
# File 'lib/1and1/public_ip.rb', line 181

def reload

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

end