-
Notifications
You must be signed in to change notification settings - Fork 32
/
dynect_rest.rb
231 lines (210 loc) · 7.85 KB
/
dynect_rest.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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
55
56
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
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
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
164
165
166
167
168
169
170
171
172
173
174
175
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
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
230
231
#
# Author:: Adam Jacob (<adam@opscode.com>)
# Copyright:: Copyright (c) 2010 Opscode, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
class DynectRest
require 'dynect_rest/exceptions'
require 'dynect_rest/gslb'
require 'dynect_rest/resource'
require 'rest_client'
require 'json'
attr_accessor :customer_name, :user_name, :password, :rest, :zone
# Creates a new base object for interacting with Dynect's REST API
#
# @param [String] Your dynect customer name
# @param [String] Your dnyect user name
# @param [String] Your dynect password
# @param [String] The zone you are going to be editing
# @param [Boolean] Whether to connect immediately or not - runs login for you
# @param [Boolean] Verbosity
def initialize(customer_name, user_name, password, zone=nil, connect=true, verbose=false, max_redirects=10)
@customer_name = customer_name
@user_name = user_name
@password = password
@rest = RestClient::Resource.new('https://api2.dynect.net/REST/', :headers => { :content_type => 'application/json' }, :max_redirects=>max_redirects)
@zone = zone
@verbose = verbose
login if connect
end
##
# Session Management
##
# Login to Dynect - must be done before any other methods called.
#
# See: https://manage.dynect.net/help/docs/api2/rest/resources/Session.html
#
# @return [Hash] The dynect API response
def login
response = post('Session', { 'customer_name' => @customer_name, 'user_name' => @user_name, 'password' => @password })
@rest.headers[:auth_token] = response["token"]
response
end
# Logout of Dynect - must be done before any other methods called.
#
# See: https://manage.dynect.net/help/docs/api2/rest/resources/Session.html
#
# @return [Hash] The dynect API response
def logout
delete('Session')
end
##
# Zone
##
# Get a zone from dynect
#
# See: https://manage.dynect.net/help/docs/api2/rest/resources/Zone.html
#
# @param [String] The zone to fetch - if one is provided when instantiated, we use that.
# @return [Hash] The dynect API response
def get_zone(zone=nil)
zone ||= @zone
get("Zone/#{zone}")
end
# Publish any pending changes to the zone - required to make any alterations permanent.
#
# See: https://manage.dynect.net/help/docs/api2/rest/resources/Zone.html
#
# @param [String] The zone to publish - if one is provided when instantiated, we use that.
# @return [Hash] The dynect API response
def publish(zone=nil)
zone ||= @zone
put("Zone/#{zone}", { "publish" => true })
end
# Freeze the zone.
#
# See: https://manage.dynect.net/help/docs/api2/rest/resources/Zone.html
#
# @param [String] The zone to freeze - if one is provided when instantiated, we use that.
# @return [Hash] The dynect API response
def freeze(zone=nil)
zone ||= @zone
put("Zone/#{zone}", { "freeze" => true })
end
# Thaw the zone.
#
# See: https://manage.dynect.net/help/docs/api2/rest/resources/Zone.html
#
# @param [String] The zone to thaw - if one is provided when instantiated, we use that.
# @return [Hash] The dynect API response
def thaw(zone=nil)
zone ||= @zone
put("Zone/#{zone}", { "thaw" => true })
end
# Convert a CamelCasedString to an under_scored_string.
def self.underscore(string)
word = string.dup
word.gsub!(/::/, '/')
word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
word.tr!("-", "_")
word.downcase!
word
end
##
# Resource Records
##
%w{AAAA A CNAME DNSKEY DS KEY LOC MX NS PTR RP SOA SRV TXT}.each do |record_type|
define_method underscore(record_type) do
DynectRest::Resource.new(self,"#{record_type}" , @zone)
end
end
##
# GSLB Service
##
def gslb
DynectRest::GSLB.new(:dynect => self, :zone => @zone)
end
# Raw GET request, formatted for Dyn. See list of endpoints at:
#
# https://manage.dynect.net/help/docs/api2/rest/resources/
#
# @param [String] The partial path to GET - for example, 'User' or 'Zone'.
# @param [Hash] Additional HTTP headers
def get(path_part, additional_headers = {}, &block)
api_request { @rest[path_part].get(additional_headers, &block) }
end
# Raw DELETE request, formatted for Dyn. See list of endpoints at:
#
# https://manage.dynect.net/help/docs/api2/rest/resources/
#
# @param [String] The partial path to DELETE - for example, 'User' or 'Zone'.
# @param [Hash] Additional HTTP headers
def delete(path_part, additional_headers = {}, &block)
api_request { @rest[path_part].delete(additional_headers, &block) }
end
# Raw POST request, formatted for Dyn. See list of endpoints at:
#
# https://manage.dynect.net/help/docs/api2/rest/resources/
#
# Read the API documentation, and submit the proper data structure from here.
#
# @param [String] The partial path to POST - for example, 'User' or 'Zone'.
# @param [Hash] The data structure to submit as the body, is automatically turned to JSON.
# @param [Hash] Additional HTTP headers
def post(path_part, payload, additional_headers = {}, &block)
api_request { @rest[path_part].post(payload.to_json, additional_headers, &block) }
end
# Raw PUT request, formatted for Dyn. See list of endpoints at:
#
# https://manage.dynect.net/help/docs/api2/rest/resources/
#
# Read the API documentation, and submit the proper data structure from here.
#
# @param [String] The partial path to PUT - for example, 'User' or 'Zone'.
# @param [Hash] The data structure to submit as the body, is automatically turned to JSON.
# @param [Hash] Additional HTTP headers
def put(path_part, payload, additional_headers = {}, &block)
api_request { @rest[path_part].put(payload.to_json, additional_headers, &block) }
end
# Handles making Dynect API requests and formatting the responses properly.
def api_request(&block)
response_body = begin
response = block.call
response.body
rescue RestClient::Exception => e
if @verbose
puts "I have #{e.inspect} with #{e.http_code}"
end
if e.http_code == 307
e.response.sub!('/REST/','') if e.response =~ /^\/REST\//
get(e.response)
end
e.response
end
parse_response(JSON.parse(response_body || '{}'))
end
def parse_response(response)
case response["status"]
when "success"
response["data"]
when "incomplete"
# we get 'incomplete' when the API is running slow and claims the session has a previous job running
# raise an error and return the job ID in case we want to ask the API what the job's status is
error_messages = []
error_messages.push( "This session may have a job _still_ running (slowly). Call /REST/Job/#{response["job_id"]} to get its status." )
response["msgs"].each do |error_message|
error_messages << "#{error_message["LVL"]} #{error_message["ERR_CD"]} #{error_message["SOURCE"]} - #{error_message["INFO"]}"
end
raise DynectRest::Exceptions::IncompleteRequest.new( "#{error_messages.join("\n")}", response["job_id"] )
when "failure"
error_messages = []
response["msgs"].each do |error_message|
error_messages << "#{error_message["LVL"]} #{error_message["ERR_CD"]} #{error_message["SOURCE"]} - #{error_message["INFO"]}"
end
raise DynectRest::Exceptions::RequestFailed, "Request failed: #{error_messages.join("\n")}"
end
end
end