Module: StarkCore::Utils::Rest

Defined in:
lib/utils/rest.rb

Class Method Summary collapse

Class Method Details

.delete_id(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, language:, timeout:, id:) ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/utils/rest.rb', line 187

def self.delete_id(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, language:, timeout:, id:)
  json = StarkCore::Utils::Request.fetch(
    host: host,
    sdk_version: sdk_version,
    user: user,
    method: 'DELETE',
    path: "#{StarkCore::Utils::API.endpoint(resource_name)}/#{id}",
    api_version: api_version,
    timeout: timeout
  ).json
  entity = json[StarkCore::Utils::API.last_name(resource_name)]
  return StarkCore::Utils::API.from_api_json(resource_maker, entity)
end

.delete_raw(sdk_version:, host:, api_version:, user:, language:, path:, query:, timeout:, prefix:, raiseException:) ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/utils/rest.rb', line 286

def self.delete_raw(sdk_version:, host:, api_version:, user:, language:, path:, query:, timeout:, prefix:, raiseException:)
  json =  StarkCore::Utils::Request.fetch(
    host: host,
    sdk_version: sdk_version,
    user: user,
    method: 'DELETE',
    path: path,
    query: query,
    api_version: api_version,
    language: language,
    timeout: timeout,
    prefix: prefix,
    raiseException: raiseException
    )
  return json
end

.get_content(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, language:, timeout:, sub_resource_name:, id:, **query) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/utils/rest.rb', line 79

def self.get_content(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, language:, timeout:, sub_resource_name:, id:, **query)
  return StarkCore::Utils::Request.fetch(
    host: host,
    sdk_version: sdk_version,
    user: user,
    method: 'GET',
    path: "#{StarkCore::Utils::API.endpoint(resource_name)}/#{id}/#{StarkCore::Utils::API.endpoint(sub_resource_name)}",
    query: query,
    api_version: api_version,
    language: language,
    timeout: timeout,
  ).content
end

.get_id(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, id:, language:, timeout:, **query) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/utils/rest.rb', line 63

def self.get_id(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, id:, language:, timeout:, **query)
  json = StarkCore::Utils::Request.fetch(
    host: host,
    sdk_version: sdk_version,
    user: user,
    method: 'GET',
    path: "#{StarkCore::Utils::API.endpoint(resource_name)}/#{id}",
    query: query,
    api_version: api_version,
    language: language,
    timeout: timeout,
  ).json
  entity = json[StarkCore::Utils::API.last_name(resource_name)]
  return StarkCore::Utils::API.from_api_json(resource_maker, entity)
end

.get_page(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, language:, timeout:, **query) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/utils/rest.rb', line 9

def self.get_page(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, language:, timeout:, **query)
  json = StarkCore::Utils::Request.fetch(
    host: host,
    sdk_version: sdk_version,
    user: user,
    method: 'GET',
    path: StarkCore::Utils::API.endpoint(resource_name),
    query: query,
    api_version: api_version,
    language: language,
    timeout: timeout,
  ).json
  entities = []
  json[StarkCore::Utils::API.last_name_plural(resource_name)].each do |entity_json|
    entities << StarkCore::Utils::API.from_api_json(resource_maker, entity_json)
  end
  return entities, json['cursor']
end

.get_raw(sdk_version:, host:, api_version:, path:, query:, user:, language:, timeout:, prefix:, raiseException:) ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/utils/rest.rb', line 216

def self.get_raw(sdk_version:, host:, api_version:, path:, query:, user:, language:, timeout:, prefix:, raiseException:)
  json = StarkCore::Utils::Request.fetch(
    host: host,
    sdk_version: sdk_version,
    user: user,
    method: 'GET',
    path: path,
    query: query,
    api_version: api_version,
    timeout: timeout,
    prefix: prefix,
    raiseException: raiseException
  )
  return json
end

.get_stream(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, language:, timeout:, **query) ⇒ Object 



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
 
# File 'lib/utils/rest.rb', line 28

def self.get_stream(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, language:, timeout:, **query)
  limit = query[:limit]
  query[:limit] = limit.nil? ? limit : [limit, 100].min

  Enumerator.new do |enum|
    loop do
      json = StarkCore::Utils::Request.fetch(
        host: host,
        sdk_version: sdk_version,
        user: user,
        method: 'GET',
        path: StarkCore::Utils::API.endpoint(resource_name),
        query: query,
        api_version: api_version,
        language: language,
        timeout: timeout,
      ).json
      entities = json[StarkCore::Utils::API.last_name_plural(resource_name)]

      entities.each do |entity|
        enum << StarkCore::Utils::API.from_api_json(resource_maker, entity)
      end

      unless limit.nil?
        limit -= 100
        query[:limit] = [limit, 100].min
      end

      cursor = json['cursor']
      query['cursor'] = cursor
      break if cursor.nil? || cursor.empty? || (!limit.nil? && limit <= 0)
    end
  end
end

.get_sub_resource(resource_name:, sub_resource_maker:, sub_resource_name:, sdk_version:, host:, api_version:, user:, language:, timeout:, id:, **query) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/utils/rest.rb', line 93

def self.get_sub_resource(resource_name:, sub_resource_maker:, sub_resource_name:, sdk_version:, host:, api_version:, user:, language:, timeout:, id:, **query)
  json = StarkCore::Utils::Request.fetch(
    host: host,
    sdk_version: sdk_version,
    user: user,
    method: 'GET',
    path: "#{StarkCore::Utils::API.endpoint(resource_name)}/#{id}/#{StarkCore::Utils::API.endpoint(sub_resource_name)}",
    query: StarkCore::Utils::API.cast_json_to_api_format(query),
    api_version: api_version,
    timeout: timeout,
  ).json
  entity = json[StarkCore::Utils::API.last_name(sub_resource_name)]
  return StarkCore::Utils::API.from_api_json(sub_resource_maker, entity)
end

.get_sub_resources(resource_name:, sub_resource_maker:, sub_resource_name:, sdk_version:, host:, api_version:, user:, language:, timeout:, id:, **query) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/utils/rest.rb', line 108

def self.get_sub_resources(resource_name:, sub_resource_maker:, sub_resource_name:, sdk_version:, host:, api_version:, user:, language:, timeout:, id:, **query)
  json = StarkCore::Utils::Request.fetch(
    host: host,
    sdk_version: sdk_version,
    user: user,
    method: 'GET',
    path: "#{StarkCore::Utils::API.endpoint(resource_name)}/#{id}/#{StarkCore::Utils::API.endpoint(sub_resource_name)}",
    query: StarkCore::Utils::API.cast_json_to_api_format(query),
    api_version: api_version,
    timeout: timeout,
  ).json
  returned_jsons = json[StarkCore::Utils::API.last_name_plural(sub_resource_name)]
  entities = []
  returned_jsons.each do |returned_json|
    entities << StarkCore::Utils::API.from_api_json(sub_resource_maker, returned_json)
  end
  return entities
end

.patch_id(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, language:, timeout:, id:, **payload) ⇒ Object 



201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/utils/rest.rb', line 201

def self.patch_id(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, language:, timeout:, id:, **payload)
  json = StarkCore::Utils::Request.fetch(
    host: host,
    sdk_version: sdk_version,
    user: user,
    method: 'PATCH',
    path: "#{StarkCore::Utils::API.endpoint(resource_name)}/#{id}",
    payload: StarkCore::Utils::API.cast_json_to_api_format(payload),
    api_version: api_version,
    timeout: timeout
  ).json
  entity = json[StarkCore::Utils::API.last_name(resource_name)]
  return StarkCore::Utils::API.from_api_json(resource_maker, entity)
end

.patch_raw(sdk_version:, host:, api_version:, user:, language:, path:, query:, payload:, timeout:, prefix:, raiseException:) ⇒ Object 



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/utils/rest.rb', line 250

def self.patch_raw(sdk_version:, host:, api_version:, user:, language:, path:, query:, payload:, timeout:, prefix:, raiseException:)
  json =  StarkCore::Utils::Request.fetch(
    host: host,
    sdk_version: sdk_version,
    user: user,
    method: 'PATCH',
    path: path,
    query: query,
    payload: payload,
    api_version: api_version,
    language: language,
    timeout: timeout,
    prefix: prefix,
    raiseException: raiseException
    )
  return json
end

.post(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, language:, timeout:, entities:, **query) ⇒ Object 



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
 
# File 'lib/utils/rest.rb', line 127

def self.post(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, language:, timeout:, entities:, **query)
  
  jsons = []
  entities.each do |entity|
    jsons << StarkCore::Utils::API.api_json(entity)
  end
  payload = { StarkCore::Utils::API.last_name_plural(resource_name) => jsons }

  json = StarkCore::Utils::Request.fetch(
    host: host,
    sdk_version: sdk_version,
    user: user,
    method: 'POST',
    path: StarkCore::Utils::API.endpoint(resource_name),
    query: query,
    payload: payload,
    api_version: api_version,
    timeout: timeout          
  ).json
  returned_jsons = json[StarkCore::Utils::API.last_name_plural(resource_name)]
  entities = []
  returned_jsons.each do |returned_json|
    entities << StarkCore::Utils::API.from_api_json(resource_maker, returned_json)
  end
  return entities
end

.post_raw(sdk_version:, host:, api_version:, user:, language:, path:, query:, payload:, timeout:, prefix:, raiseException:) ⇒ Object 



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/utils/rest.rb', line 232

def self.post_raw(sdk_version:, host:, api_version:, user:, language:, path:, query:, payload:, timeout:, prefix:, raiseException:)
  json =  StarkCore::Utils::Request.fetch(
    host: host,
    sdk_version: sdk_version,
    user: user,
    method: 'POST',
    path: path,
    query: query,
    payload: payload,
    api_version: api_version,
    language: language,
    timeout: timeout,
    prefix: prefix,
    raiseException: raiseException
    )
  return json
end

.post_single(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, language:, timeout:, entity:) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/utils/rest.rb', line 154

def self.post_single(resource_name:, resource_maker:, sdk_version:, host:, api_version:, user:, language:, timeout:, entity:)
  payload = StarkCore::Utils::API.api_json(entity)
  json = StarkCore::Utils::Request.fetch(
    host: host,
    sdk_version: sdk_version,
    user: user,
    method: 'POST',
    path: StarkCore::Utils::API.endpoint(resource_name),
    payload: payload,
    api_version: api_version,
    timeout: timeout
  ).json
  entity_json = json[StarkCore::Utils::API.last_name(resource_name)]
  return StarkCore::Utils::API.from_api_json(resource_maker, entity_json)
end

.post_sub_resource(resource_name:, sub_resource_maker:, sub_resource_name:, sdk_version:, host:, api_version:, user:, language:, timeout:, entity:, id:) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/utils/rest.rb', line 170

def self.post_sub_resource(resource_name:, sub_resource_maker:, sub_resource_name:, sdk_version:, host:, api_version:, user:, language:, timeout:, entity:, id:)
  payload = StarkCore::Utils::API.api_json(entity)
  json = StarkCore::Utils::Request.fetch(
    host: host,
    sdk_version: sdk_version,
    user: user,
    method: 'POST',
    path: "#{StarkCore::Utils::API.endpoint(resource_name)}/#{id}/#{StarkCore::Utils::API.endpoint(sub_resource_name)}",
    payload: payload,
    api_version: api_version,
    timeout: timeout
  ).json
  entity_json = json[StarkCore::Utils::API.last_name(sub_resource_name)]
  return StarkCore::Utils::API.from_api_json(sub_resource_maker, entity_json)
end

.put_raw(sdk_version:, host:, api_version:, user:, language:, path:, query:, payload:, timeout:, prefix:, raiseException:) ⇒ Object 



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/utils/rest.rb', line 268

def self.put_raw(sdk_version:, host:, api_version:, user:, language:, path:, query:, payload:, timeout:, prefix:, raiseException:)
  json =  StarkCore::Utils::Request.fetch(
    host: host,
    sdk_version: sdk_version,
    user: user,
    method: 'PUT',
    path: path,
    query: query,
    payload: payload,
    api_version: api_version,
    language: language,
    timeout: timeout,
    prefix: prefix,
    raiseException: raiseException
    )
  return json
end