Class: Payload::ARMRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/payload/arm/request.rb

Instance Method Summary collapse

Constructor Details

#initialize(cls = nil, session = nil) ⇒ ARMRequest

Returns a new instance of ARMRequest.



12
13
14
15
16
17
18
19
20
21
 
# File 'lib/payload/arm/request.rb', line 12

def initialize(cls=nil, session=nil)
	@cls = cls
	@session = session || Payload::Session.new(Payload::api_key, Payload::api_url)
	@filters = {}
	@group_by = []
	@order_by = []
	@limit = nil
	@offset = nil
	@filter_objects = []
end

Instance Method Details

#[](key) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
 
# File 'lib/payload/arm/request.rb', line 64

def [](key)
	case key
	when Range
		raise ArgumentError, 'Negative slice indices not supported' if key.begin && key.begin < 0
		raise ArgumentError, 'Negative slice indices not supported' if key.end && key.end < 0
		offset(key.begin).limit(key.size).all()
	else
		raise TypeError, "invalid key or index: #{key.inspect}"
	end
end

#_execute_request(http, request) ⇒ Object 



167
168
169
 
# File 'lib/payload/arm/request.rb', line 167

def _execute_request(http, request)
	http.request(request)
end

#_request(method, id: nil, json: nil) ⇒ Object 



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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/payload/arm/request.rb', line 181

def _request(method, id: nil, json: nil)
	if !@cls.nil?
		if @cls.spec.key?("endpoint")
			endpoint = @cls.spec["endpoint"]
		else
			obj = @cls.spec["object"]
			endpoint = "/" + (obj.end_with?("s") ? obj : obj + "s")
		end
	else
		if json.is_a? Array
			if json.all? {|obj| obj.key?("object") }
				obj = json[0]["object"]
				endpoint = (obj.end_with?("s") ? obj : obj + "s")
			end
		end
	end

	if id
		endpoint = File.join(endpoint, id)
	end

	params = request_params
	url = URI.join(@session.api_url, endpoint)
	url.query = URI.encode_www_form(params)

	http = Net::HTTP.new(url.host, url.port)

	if url.port == 443
		http.use_ssl = true
	end

	request = Net::HTTP.const_get(method).new(url.request_uri)
	request.basic_auth(@session.api_key, '')

	if json
		request.body = json.to_json
		request.add_field('Content-Type', 'application/json')
	end

	if @session.api_version
		request.add_field('X-API-Version', @session.api_version)
	end

	response = self._execute_request(http, request)

	begin
		data = JSON.parse(response.body)
	rescue JSON::ParserError
		if response.code == '500'
			raise Payload::InternalError.new
		else
			raise Payload::UnknownResponse.new
		end
	end

	if response.code == '200'
		if data['object'] == 'list'
			return data['values'].map do |obj|
				cls = Payload::get_cls(obj)
				cls = @cls if cls.nil? && !@cls.nil?
				if cls.nil?
					obj
				else
					ret = cls.new(obj, @session)
					ret
				end
			end
		else
			cls = Payload::get_cls(data)
			cls = @cls if cls.nil? && !@cls.nil?
			if cls.nil?
				return data
			else
				return cls.new(data, @session)
			end
		end
	else
		for error in Payload::subclasses(Payload::PayloadError)
			if error.code != response.code or error.name.split('::')[-1] != data['error_type']
				next
			end

			raise error.new(data['error_description'], data)
		end

		raise Payload::BadRequest.new(data['error_description'], data)
	end
end

#all ⇒ Object 



59
60
61
62
 
# File 'lib/payload/arm/request.rb', line 59

def all()
	# TODO: I don't think this applies the @poly variable as intended?
	return self._request('Get')
end

#create(data) ⇒ Object 



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/payload/arm/request.rb', line 134

def create(data)
	if data.is_a? Array
		data = data.map do |obj|
			if obj.kind_of?(ARMObject)
				if @cls and not obj.instance_of?(@cls)
					throw "All objects must be of the same type"
				end

				@cls = obj.class
				obj = obj.data
			end

			if @cls.poly
				obj = obj.merge(@cls.poly)
			end

			obj
		end

		data = { object: 'list', values: data }
	else
		if data.kind_of?(ARMObject)
			@cls = data.class
			data = data.data
		end
		if @cls.poly
			data = data.merge(@cls.poly)
		end
	end

	return self._request('Post', json: data)
end

#delete ⇒ Object 



129
130
131
132
 
# File 'lib/payload/arm/request.rb', line 129

def delete()
	return self.filter_by(mode: 'query')
		._request('Delete')
end

#delete_all(objects) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/payload/arm/request.rb', line 110

def delete_all(objects)
	deletes = objects.map do |obj|
		if obj.kind_of?(ARMObject)
			if @cls and not obj.instance_of?(@cls)
				throw "All objects must be of the same type"
			end

			@cls = obj.class
			obj = { id: obj.id }
		end

		obj
	end

	data = { object: 'list', values: deletes }

	return self._request('Delete', json: data)
end

#filter_by(*args, **data) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/payload/arm/request.rb', line 48

def filter_by(*args, **data)
	args.each do |f|
		@filter_objects << f if f.respond_to?(:attr) && f.respond_to?(:opval)
	end
	if !@cls.nil? && @cls.poly
		data = data.merge(@cls.poly)
	end
	@filters = @filters.merge(data)
	return self
end

#get(id) ⇒ Object 



75
76
77
78
79
80
81
 
# File 'lib/payload/arm/request.rb', line 75

def get(id)
	if id.nil? || id.empty?
		throw 'id cannot be empty'
	end

	return self._request('Get', id: id)
end

#group_by(*args, **data) ⇒ Object 



28
29
30
31
 
# File 'lib/payload/arm/request.rb', line 28

def group_by(*args, **data)
	@group_by.concat(args)
	self
end

#limit(n) ⇒ Object 



38
39
40
41
 
# File 'lib/payload/arm/request.rb', line 38

def limit(n)
	@limit = n
	self
end

#offset(n) ⇒ Object 



43
44
45
46
 
# File 'lib/payload/arm/request.rb', line 43

def offset(n)
	@offset = n
	self
end

#order_by(*args, **data) ⇒ Object 



33
34
35
36
 
# File 'lib/payload/arm/request.rb', line 33

def order_by(*args, **data)
	@order_by.concat(args)
	self
end

#request_params ⇒ Object 



171
172
173
174
175
176
177
178
179
 
# File 'lib/payload/arm/request.rb', line 171

def request_params
	params = @filters.dup
	@filter_objects.each { |f| params[f.attr] = f.opval }
	@group_by.each_with_index { |v, i| params["group_by[#{i}]"] = v.to_s }
	@order_by.each_with_index { |v, i| params["order_by[#{i}]"] = v.to_s }
	params['limit'] = @limit.to_s if @limit
	params['offset'] = @offset.to_s if @offset
	params
end

#select(*args, **data) ⇒ Object 



23
24
25
26
 
# File 'lib/payload/arm/request.rb', line 23

def select(*args, **data)
	@filters['fields'] = args.map { |a| a.strip }.join(',')
	return self
end

#update(**updates) ⇒ Object 



83
84
85
86
 
# File 'lib/payload/arm/request.rb', line 83

def update(**updates)
	return self.filter_by(mode: 'query')
		._request('Put', json: updates)
end

#update_all(updates) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/payload/arm/request.rb', line 88

def update_all(updates)
	updates.map do |obj, update|
		if obj.kind_of?(ARMObject)
			if @cls and not obj.instance_of?(@cls)
				throw "All objects must be of the same type"
			end

			@cls = obj.class
		end
	end

	updates = {
		object: 'list',
		values: updates.map do |obj, update|
			update['id'] = obj.id
			update
		end
	}

	return self._request('Put', json: updates)
end