Class: OneAndOne::Vpn
- Inherits:
-
Object
- Object
- OneAndOne::Vpn
- Defined in:
- lib/1and1/vpn.rb
Instance Attribute Summary collapse
-
#id ⇒ Object
Returns the value of attribute id.
-
#specs ⇒ Object
Returns the value of attribute specs.
Instance Method Summary collapse
- #create(name: nil, description: nil, datacenter_id: nil) ⇒ Object
- #delete(vpn_id: @id) ⇒ Object
- #download_config(vpn_id: @id) ⇒ Object
- #get(vpn_id: @id) ⇒ Object
-
#initialize(test: false) ⇒ Vpn
constructor
A new instance of Vpn.
- #list(page: nil, per_page: nil, sort: nil, q: nil, fields: nil) ⇒ Object
- #modify(vpn_id: @id, name: nil, description: nil) ⇒ Object
- #reload ⇒ Object
- #wait_for(timeout: 25, interval: 15) ⇒ Object
Constructor Details
#initialize(test: false) ⇒ Vpn
Returns a new instance of Vpn.
11 12 13 14 15 16 17 18 19 20 21 22 |
# File 'lib/1and1/vpn.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/vpn.rb', line 7 def id @id end |
#specs ⇒ Object
Returns the value of attribute specs.
8 9 10 |
# File 'lib/1and1/vpn.rb', line 8 def specs @specs end |
Instance Method Details
#create(name: nil, description: nil, datacenter_id: 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 |
# File 'lib/1and1/vpn.rb', line 85 def create(name: nil, description: nil, datacenter_id: nil) # Build POST body new_vpn = { 'name' => name, 'description' => description, 'datacenter_id' => datacenter_id } # Clean out null keys in POST body body = OneAndOne.clean_hash(new_vpn) # Stringify the POST body string_body = body.to_json # Build URL path = OneAndOne.build_url('/vpns') # 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 vpn ID to Vpn instance @id = json['id'] @specs = json # If all good, return JSON json end |
#delete(vpn_id: @id) ⇒ Object
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/1and1/vpn.rb', line 160 def delete(vpn_id: @id) # If user passed in vpn ID, reassign @id = vpn_id # Build URL path = OneAndOne.build_url("/vpns/#{@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 |
#download_config(vpn_id: @id) ⇒ Object
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/1and1/vpn.rb', line 182 def download_config(vpn_id: @id) # If user passed in vpn ID, reassign @id = vpn_id # Build URL path = OneAndOne.build_url("/vpns/#{@id}/configuration_file") # 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 |
#get(vpn_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/vpn.rb', line 57 def get(vpn_id: @id) # If user passed in vpn ID, reassign @id = vpn_id # Build URL path = OneAndOne.build_url("/vpns/#{@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/vpn.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('/vpns') # 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(vpn_id: @id, name: nil, description: 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 157 |
# File 'lib/1and1/vpn.rb', line 125 def modify(vpn_id: @id, name: nil, description: nil) # If user passed in vpn ID, reassign @id = vpn_id # Build PUT body vpn_specs = { 'name' => name, 'description' => description } # Clean out null keys in PUT body body = OneAndOne.clean_hash(vpn_specs) # Stringify the PUT body string_body = body.to_json # Build URL path = OneAndOne.build_url("/vpns/#{@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
204 205 206 207 208 209 |
# File 'lib/1and1/vpn.rb', line 204 def reload # This reload fx is just a wrapper for the get fx get end |
#wait_for(timeout: 25, interval: 15) ⇒ Object
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/1and1/vpn.rb', line 212 def wait_for(timeout: 25, interval: 15) # Capture start time start = Time.now # Poll VPN and check initial state initial_response = get vpn_state = initial_response['state'] # Keep polling the VPN's state until good until $good_states.include? vpn_state # Wait 15 seconds before polling again sleep interval # Check VPN state again current_response = get vpn_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 |