obarc 0.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.codeclimate.yml +19 -0
- data/.gitignore +5 -0
- data/.rubocop.yml +1156 -0
- data/.travis.yml +12 -0
- data/Gemfile +3 -0
- data/Gemfile.lock +78 -0
- data/README.md +133 -0
- data/Rakefile +39 -0
- data/doc/OBarc.html +210 -0
- data/doc/OBarc/Api.html +883 -0
- data/doc/OBarc/Session.html +5399 -0
- data/doc/OBarc/Utils.html +117 -0
- data/doc/OBarc/Utils/Exceptions.html +115 -0
- data/doc/OBarc/Utils/Exceptions/InvalidArgumentError.html +230 -0
- data/doc/OBarc/Utils/Exceptions/InvalidElementError.html +218 -0
- data/doc/OBarc/Utils/Exceptions/InvalidWordError.html +218 -0
- data/doc/OBarc/Utils/Exceptions/MissingArgumentError.html +230 -0
- data/doc/OBarc/Utils/Exceptions/OBarcArgumentError.html +151 -0
- data/doc/OBarc/Utils/Exceptions/OBarcError.html +291 -0
- data/doc/OBarc/Utils/Exceptions/OBarcResponseError.html +520 -0
- data/doc/OBarc/Utils/Exceptions/OverLimitError.html +218 -0
- data/doc/OBarc/Utils/Exceptions/TimeOutError.html +218 -0
- data/doc/OBarc/Utils/Helper.html +115 -0
- data/doc/OBarc/Utils/Helper/ObjectExtensions.html +105 -0
- data/doc/_index.html +239 -0
- data/doc/class_list.html +58 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +339 -0
- data/doc/file.README.html +229 -0
- data/doc/file_list.html +60 -0
- data/doc/frames.html +26 -0
- data/doc/index.html +229 -0
- data/doc/js/app.js +219 -0
- data/doc/js/full_list.js +181 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +465 -0
- data/doc/top-level-namespace.html +112 -0
- data/graphics/obarc-logo.png +0 -0
- data/graphics/obarc-logo.xcf +0 -0
- data/lib/obarc.rb +14 -0
- data/lib/obarc/api.rb +220 -0
- data/lib/obarc/session.rb +514 -0
- data/lib/obarc/utils/exceptions.rb +35 -0
- data/lib/obarc/utils/helper.rb +18 -0
- data/lib/obarc/version.rb +3 -0
- data/obarc.gemspec +32 -0
- metadata +276 -0
data/doc/OBarc/Api.html
ADDED
@@ -0,0 +1,883 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
+
<title>
|
7
|
+
Module: OBarc::Api
|
8
|
+
|
9
|
+
— Documentation by YARD 0.8.7.6
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
19
|
+
relpath = '../';
|
20
|
+
framesUrl = "../frames.html#!OBarc/Api.html";
|
21
|
+
</script>
|
22
|
+
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
25
|
+
|
26
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
27
|
+
|
28
|
+
|
29
|
+
</head>
|
30
|
+
<body>
|
31
|
+
<div id="header">
|
32
|
+
<div id="menu">
|
33
|
+
|
34
|
+
<a href="../_index.html">Index (A)</a> »
|
35
|
+
<span class='title'><span class='object_link'><a href="../OBarc.html" title="OBarc (module)">OBarc</a></span></span>
|
36
|
+
»
|
37
|
+
<span class="title">Api</span>
|
38
|
+
|
39
|
+
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
41
|
+
</div>
|
42
|
+
|
43
|
+
<div id="search">
|
44
|
+
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
46
|
+
href="../class_list.html">
|
47
|
+
Class List
|
48
|
+
</a>
|
49
|
+
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
51
|
+
href="../method_list.html">
|
52
|
+
Method List
|
53
|
+
</a>
|
54
|
+
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
56
|
+
href="../file_list.html">
|
57
|
+
File List
|
58
|
+
</a>
|
59
|
+
|
60
|
+
</div>
|
61
|
+
<div class="clear"></div>
|
62
|
+
</div>
|
63
|
+
|
64
|
+
<iframe id="search_frame"></iframe>
|
65
|
+
|
66
|
+
<div id="content"><h1>Module: OBarc::Api
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
</h1>
|
71
|
+
|
72
|
+
<dl class="box">
|
73
|
+
|
74
|
+
|
75
|
+
|
76
|
+
<dt class="r1">Extended by:</dt>
|
77
|
+
<dd class="r1"><span class='object_link'><a href="" title="OBarc::Api (module)">Api</a></span></dd>
|
78
|
+
|
79
|
+
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
|
84
|
+
<dt class="r2">Included in:</dt>
|
85
|
+
<dd class="r2"><span class='object_link'><a href="" title="OBarc::Api (module)">Api</a></span></dd>
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
<dt class="r1 last">Defined in:</dt>
|
90
|
+
<dd class="r1 last">lib/obarc/api.rb</dd>
|
91
|
+
|
92
|
+
</dl>
|
93
|
+
<div class="clear"></div>
|
94
|
+
|
95
|
+
|
96
|
+
<h2>Constant Summary</h2>
|
97
|
+
|
98
|
+
<dl class="constants">
|
99
|
+
|
100
|
+
<dt id="DEFAULT_TIMEOUT-constant" class="">DEFAULT_TIMEOUT =
|
101
|
+
|
102
|
+
</dt>
|
103
|
+
<dd><pre class="code"><span class='int'>60</span> <span class='op'>*</span> <span class='int'>60</span> <span class='op'>*</span> <span class='int'>1</span></pre></dd>
|
104
|
+
|
105
|
+
<dt id="VALID_ACTIONS-constant" class="">VALID_ACTIONS =
|
106
|
+
|
107
|
+
</dt>
|
108
|
+
<dd><pre class="code"><span class='lbrace'>{</span>
|
109
|
+
<span class='label'>get:</span> <span class='qsymbols_beg'>%i(</span><span class='tstring_content'>image</span><span class='words_sep'> </span><span class='tstring_content'>profile</span><span class='words_sep'> </span><span class='tstring_content'>listings</span><span class='words_sep'> </span><span class='tstring_content'>followers</span><span class='words_sep'> </span><span class='tstring_content'>following</span><span class='words_sep'> </span><span class='tstring_content'>contracts</span><span class='words_sep'> </span><span class='tstring_content'>shutdown</span><span class='words_sep'>
|
110
|
+
</span><span class='tstring_content'> settings</span><span class='words_sep'> </span><span class='tstring_content'>connected_peers</span><span class='words_sep'> </span><span class='tstring_content'>routing_table</span><span class='words_sep'> </span><span class='tstring_content'>notifications</span><span class='words_sep'> </span><span class='tstring_content'>chat_messages</span><span class='words_sep'>
|
111
|
+
</span><span class='tstring_content'> chat_conversations</span><span class='words_sep'> </span><span class='tstring_content'>sales</span><span class='words_sep'> </span><span class='tstring_content'>purchases</span><span class='words_sep'> </span><span class='tstring_content'>order</span><span class='words_sep'> </span><span class='tstring_content'>cases</span><span class='words_sep'> </span><span class='tstring_content'>order_messages</span><span class='words_sep'> </span><span class='tstring_content'>ratings</span><span class='words_sep'>
|
112
|
+
</span><span class='tstring_content'> btc_price</span><span class='words_sep'>)</span><span class='comma'>,</span>
|
113
|
+
<span class='label'>post:</span> <span class='qsymbols_beg'>%i(</span><span class='tstring_content'>login</span><span class='words_sep'> </span><span class='tstring_content'>follow</span><span class='words_sep'> </span><span class='tstring_content'>unfollow</span><span class='words_sep'> </span><span class='tstring_content'>profile</span><span class='words_sep'> </span><span class='tstring_content'>social_accounts</span><span class='words_sep'>
|
114
|
+
</span><span class='tstring_content'> contract</span><span class='words_sep'> </span><span class='tstring_content'>make_moderator</span><span class='words_sep'> </span><span class='tstring_content'>unmake_moderator</span><span class='words_sep'> </span><span class='tstring_content'>purchase_contract</span><span class='words_sep'>
|
115
|
+
</span><span class='tstring_content'> confirm_order</span><span class='words_sep'> </span><span class='tstring_content'>upload_image</span><span class='words_sep'> </span><span class='tstring_content'>complete_order</span><span class='words_sep'> </span><span class='tstring_content'>settings</span><span class='words_sep'>
|
116
|
+
</span><span class='tstring_content'> mark_notification_as_read</span><span class='words_sep'> </span><span class='tstring_content'>broadcast</span><span class='words_sep'> </span><span class='tstring_content'>mark_chat_message_as_read</span><span class='words_sep'>
|
117
|
+
</span><span class='tstring_content'> check_for_payment</span><span class='words_sep'> </span><span class='tstring_content'>dispute_contract</span><span class='words_sep'> </span><span class='tstring_content'>close_dispute</span><span class='words_sep'> </span><span class='tstring_content'>release_funds</span><span class='words_sep'> </span><span class='tstring_content'>refund</span><span class='words_sep'>
|
118
|
+
</span><span class='tstring_content'> mark_discussion_as_read</span><span class='words_sep'>)</span><span class='comma'>,</span>
|
119
|
+
<span class='label'>delete:</span> <span class='qsymbols_beg'>%i(</span><span class='tstring_content'>social_accounts</span><span class='words_sep'> </span><span class='tstring_content'>contract</span><span class='words_sep'> </span><span class='tstring_content'>chat_conversation</span><span class='words_sep'>)</span>
|
120
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
121
|
+
|
122
|
+
</dl>
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
<h2>
|
133
|
+
Instance Method Summary
|
134
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
135
|
+
</h2>
|
136
|
+
|
137
|
+
<ul class="summary">
|
138
|
+
|
139
|
+
<li class="public ">
|
140
|
+
<span class="summary_signature">
|
141
|
+
|
142
|
+
<a href="#get_chat_messages-instance_method" title="#get_chat_messages (instance method)">- (Object) <strong>get_chat_messages</strong>(chat_messages, options = {}) </a>
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
</span>
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
<span class="summary_desc"><div class='inline'>
|
157
|
+
<p>GET api/v1/get_chat_messages.</p>
|
158
|
+
</div></span>
|
159
|
+
|
160
|
+
</li>
|
161
|
+
|
162
|
+
|
163
|
+
<li class="public ">
|
164
|
+
<span class="summary_signature">
|
165
|
+
|
166
|
+
<a href="#get_contracts-instance_method" title="#get_contracts (instance method)">- (Object) <strong>get_contracts</strong>(contracts, options = {}) </a>
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
</span>
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
<span class="summary_desc"><div class='inline'>
|
181
|
+
<p>GET api/v1/contracts.</p>
|
182
|
+
</div></span>
|
183
|
+
|
184
|
+
</li>
|
185
|
+
|
186
|
+
|
187
|
+
<li class="public ">
|
188
|
+
<span class="summary_signature">
|
189
|
+
|
190
|
+
<a href="#get_order-instance_method" title="#get_order (instance method)">- (Object) <strong>get_order</strong>(order, options = {}) </a>
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
</span>
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
<span class="summary_desc"><div class='inline'>
|
205
|
+
<p>GET api/v1/get_order.</p>
|
206
|
+
</div></span>
|
207
|
+
|
208
|
+
</li>
|
209
|
+
|
210
|
+
|
211
|
+
<li class="public ">
|
212
|
+
<span class="summary_signature">
|
213
|
+
|
214
|
+
<a href="#method_missing-instance_method" title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(m, *args, &block) </a>
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
</span>
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
229
|
+
|
230
|
+
</li>
|
231
|
+
|
232
|
+
|
233
|
+
<li class="public ">
|
234
|
+
<span class="summary_signature">
|
235
|
+
|
236
|
+
<a href="#ping-instance_method" title="#ping (instance method)">- (Object) <strong>ping</strong>(options = {}) </a>
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
</span>
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
251
|
+
|
252
|
+
</li>
|
253
|
+
|
254
|
+
|
255
|
+
<li class="public ">
|
256
|
+
<span class="summary_signature">
|
257
|
+
|
258
|
+
<a href="#post_login-instance_method" title="#post_login (instance method)">- (Object) <strong>post_login</strong>(options = {}) </a>
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
</span>
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
<span class="summary_desc"><div class='inline'>
|
273
|
+
<p>POST api/v1/login.</p>
|
274
|
+
</div></span>
|
275
|
+
|
276
|
+
</li>
|
277
|
+
|
278
|
+
|
279
|
+
<li class="public ">
|
280
|
+
<span class="summary_signature">
|
281
|
+
|
282
|
+
<a href="#post_upload_image-instance_method" title="#post_upload_image (instance method)">- (Object) <strong>post_upload_image</strong>(options = {}) </a>
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
</span>
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
<span class="summary_desc"><div class='inline'>
|
297
|
+
<p>POST api/v1/upload_image.</p>
|
298
|
+
</div></span>
|
299
|
+
|
300
|
+
</li>
|
301
|
+
|
302
|
+
|
303
|
+
<li class="public ">
|
304
|
+
<span class="summary_signature">
|
305
|
+
|
306
|
+
<a href="#respond_to_missing%3F-instance_method" title="#respond_to_missing? (instance method)">- (Boolean) <strong>respond_to_missing?</strong>(m, include_private = false) </a>
|
307
|
+
|
308
|
+
|
309
|
+
|
310
|
+
</span>
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
321
|
+
|
322
|
+
</li>
|
323
|
+
|
324
|
+
|
325
|
+
</ul>
|
326
|
+
|
327
|
+
|
328
|
+
<div id="method_missing_details" class="method_details_list">
|
329
|
+
<h2>Dynamic Method Handling</h2>
|
330
|
+
<p class="notice this">
|
331
|
+
This class handles dynamic methods through the <tt>method_missing</tt> method
|
332
|
+
|
333
|
+
</p>
|
334
|
+
|
335
|
+
<div class="method_details first">
|
336
|
+
<h3 class="signature first" id="method_missing-instance_method">
|
337
|
+
|
338
|
+
- (<tt>Object</tt>) <strong>method_missing</strong>(m, *args, &block)
|
339
|
+
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
</h3><div class="docstring">
|
345
|
+
<div class="discussion">
|
346
|
+
|
347
|
+
|
348
|
+
</div>
|
349
|
+
</div>
|
350
|
+
<div class="tags">
|
351
|
+
|
352
|
+
<p class="tag_title">Raises:</p>
|
353
|
+
<ul class="raise">
|
354
|
+
|
355
|
+
<li>
|
356
|
+
|
357
|
+
|
358
|
+
<span class='type'>(<tt><span class='object_link'><a href="Utils/Exceptions/OBarcError.html" title="OBarc::Utils::Exceptions::OBarcError (class)">Utils::Exceptions::OBarcError</a></span></tt>)</span>
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
</li>
|
363
|
+
|
364
|
+
</ul>
|
365
|
+
|
366
|
+
</div><table class="source_code">
|
367
|
+
<tr>
|
368
|
+
<td>
|
369
|
+
<pre class="lines">
|
370
|
+
|
371
|
+
|
372
|
+
55
|
373
|
+
56
|
374
|
+
57
|
375
|
+
58
|
376
|
+
59
|
377
|
+
60
|
378
|
+
61
|
379
|
+
62
|
380
|
+
63
|
381
|
+
64
|
382
|
+
65
|
383
|
+
66
|
384
|
+
67
|
385
|
+
68
|
386
|
+
69
|
387
|
+
70
|
388
|
+
71
|
389
|
+
72
|
390
|
+
73
|
391
|
+
74
|
392
|
+
75
|
393
|
+
76
|
394
|
+
77
|
395
|
+
78
|
396
|
+
79
|
397
|
+
80
|
398
|
+
81
|
399
|
+
82
|
400
|
+
83
|
401
|
+
84
|
402
|
+
85
|
403
|
+
86
|
404
|
+
87
|
405
|
+
88
|
406
|
+
89
|
407
|
+
90
|
408
|
+
91
|
409
|
+
92
|
410
|
+
93
|
411
|
+
94</pre>
|
412
|
+
</td>
|
413
|
+
<td>
|
414
|
+
<pre class="code"><span class="info file"># File 'lib/obarc/api.rb', line 55</span>
|
415
|
+
|
416
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
417
|
+
<span class='kw'>super</span> <span class='kw'>unless</span> <span class='id identifier rubyid_respond_to_missing?'>respond_to_missing?</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='rparen'>)</span>
|
418
|
+
|
419
|
+
<span class='comment'># Many of the calls to restapi.py are uniform enough for DRY code, but the
|
420
|
+
</span> <span class='comment'># ones that aren't are mapped here.
|
421
|
+
</span>
|
422
|
+
<span class='id identifier rubyid_rest_method'>rest_method</span><span class='comma'>,</span> <span class='id identifier rubyid_endpoint'>endpoint</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='kw'>case</span> <span class='id identifier rubyid_m'>m</span>
|
423
|
+
<span class='kw'>when</span> <span class='symbol'>:get_image</span> <span class='kw'>then</span> <span class='lbracket'>[</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>get_image</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
|
424
|
+
<span class='kw'>when</span> <span class='symbol'>:get_listings</span> <span class='kw'>then</span> <span class='lbracket'>[</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>get_listings</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
|
425
|
+
<span class='kw'>when</span> <span class='symbol'>:get_followers</span> <span class='kw'>then</span> <span class='lbracket'>[</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>get_followers</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
|
426
|
+
<span class='kw'>when</span> <span class='symbol'>:get_following</span> <span class='kw'>then</span> <span class='lbracket'>[</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>get_following</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
|
427
|
+
<span class='kw'>when</span> <span class='symbol'>:post_contract</span> <span class='kw'>then</span> <span class='lbracket'>[</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>contracts</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
|
428
|
+
<span class='kw'>when</span> <span class='symbol'>:delete_contract</span> <span class='kw'>then</span> <span class='lbracket'>[</span><span class='symbol'>:delete</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>contracts</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
|
429
|
+
<span class='kw'>when</span> <span class='symbol'>:get_notifications</span> <span class='kw'>then</span> <span class='lbracket'>[</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>get_notifications</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
|
430
|
+
<span class='kw'>when</span> <span class='symbol'>:get_chat_conversations</span> <span class='kw'>then</span> <span class='lbracket'>[</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>get_chat_conversations</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
|
431
|
+
<span class='kw'>when</span> <span class='symbol'>:get_sales</span> <span class='kw'>then</span> <span class='lbracket'>[</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>get_sales</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
|
432
|
+
<span class='kw'>when</span> <span class='symbol'>:get_purchases</span> <span class='kw'>then</span> <span class='lbracket'>[</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>get_purchases</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
|
433
|
+
<span class='kw'>when</span> <span class='symbol'>:get_cases</span> <span class='kw'>then</span> <span class='lbracket'>[</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>get_cases</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
|
434
|
+
<span class='kw'>when</span> <span class='symbol'>:get_ratings</span> <span class='kw'>then</span> <span class='lbracket'>[</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>get_ratings</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
|
435
|
+
<span class='kw'>else</span>
|
436
|
+
<span class='id identifier rubyid_verb'>verb</span> <span class='op'>=</span> <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>_</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
437
|
+
<span class='id identifier rubyid_a'>a</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_verb'>verb</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='comma'>,</span> <span class='id identifier rubyid_verb'>verb</span><span class='lbracket'>[</span><span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>_</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rbracket'>]</span>
|
438
|
+
<span class='id identifier rubyid_a'>a</span> <span class='op'><<</span> <span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>==</span> <span class='int'>1</span>
|
439
|
+
<span class='kw'>nil</span>
|
440
|
+
<span class='kw'>else</span>
|
441
|
+
<span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
|
442
|
+
<span class='kw'>end</span>
|
443
|
+
<span class='id identifier rubyid_a'>a</span> <span class='op'><<</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>-</span> <span class='int'>1</span><span class='rbracket'>]</span>
|
444
|
+
<span class='kw'>end</span>
|
445
|
+
|
446
|
+
<span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_build_base_url'>build_base_url</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_endpoint'>endpoint</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>&&</span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_options'>options</span>
|
447
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_rest_method'>rest_method</span> <span class='op'>&&</span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_url'>url</span> <span class='op'>&&</span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_options'>options</span>
|
448
|
+
<span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='id identifier rubyid_build_headers'>build_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
449
|
+
<span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='id identifier rubyid_headers'>headers</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_params'>params</span>
|
450
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_execute'>execute</span> <span class='label'>method:</span> <span class='id identifier rubyid_rest_method'>rest_method</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span>
|
451
|
+
<span class='label'>verify_ssl:</span> <span class='id identifier rubyid_build_verify_ssl'>build_verify_ssl</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
452
|
+
<span class='kw'>end</span>
|
453
|
+
|
454
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>Utils</span><span class='op'>::</span><span class='const'>Exceptions</span><span class='op'>::</span><span class='const'>OBarcError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Did not handle </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_m'>m</span><span class='embexpr_end'>}</span><span class='tstring_content'> as expected, arguments: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_args'>args</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
455
|
+
<span class='kw'>end</span></pre>
|
456
|
+
</td>
|
457
|
+
</tr>
|
458
|
+
</table>
|
459
|
+
</div>
|
460
|
+
|
461
|
+
</div>
|
462
|
+
|
463
|
+
|
464
|
+
<div id="instance_method_details" class="method_details_list">
|
465
|
+
<h2>Instance Method Details</h2>
|
466
|
+
|
467
|
+
|
468
|
+
<div class="method_details first">
|
469
|
+
<h3 class="signature first" id="get_chat_messages-instance_method">
|
470
|
+
|
471
|
+
- (<tt>Object</tt>) <strong>get_chat_messages</strong>(chat_messages, options = {})
|
472
|
+
|
473
|
+
|
474
|
+
|
475
|
+
|
476
|
+
|
477
|
+
</h3><div class="docstring">
|
478
|
+
<div class="discussion">
|
479
|
+
|
480
|
+
<p>GET api/v1/get_chat_messages</p>
|
481
|
+
|
482
|
+
|
483
|
+
</div>
|
484
|
+
</div>
|
485
|
+
<div class="tags">
|
486
|
+
|
487
|
+
|
488
|
+
</div><table class="source_code">
|
489
|
+
<tr>
|
490
|
+
<td>
|
491
|
+
<pre class="lines">
|
492
|
+
|
493
|
+
|
494
|
+
126
|
495
|
+
127
|
496
|
+
128
|
497
|
+
129
|
498
|
+
130
|
499
|
+
131
|
500
|
+
132
|
501
|
+
133
|
502
|
+
134
|
503
|
+
135
|
504
|
+
136
|
505
|
+
137</pre>
|
506
|
+
</td>
|
507
|
+
<td>
|
508
|
+
<pre class="code"><span class="info file"># File 'lib/obarc/api.rb', line 126</span>
|
509
|
+
|
510
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_chat_messages'>get_chat_messages</span><span class='lparen'>(</span><span class='id identifier rubyid_chat_messages'>chat_messages</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
511
|
+
<span class='id identifier rubyid_guid'>guid</span> <span class='op'>=</span> <span class='id identifier rubyid_chat_messages'>chat_messages</span><span class='lbracket'>[</span><span class='symbol'>:guid</span><span class='rbracket'>]</span>
|
512
|
+
|
513
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_guid'>guid</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_guid'>guid</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>!=</span> <span class='int'>40</span>
|
514
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>Utils</span><span class='op'>::</span><span class='const'>Exceptions</span><span class='op'>::</span><span class='const'>InvalidArgumentError</span><span class='comma'>,</span> <span class='label'>guid:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>must be present, 40 characters (was: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_guid'>guid</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>"</span></span>
|
515
|
+
<span class='kw'>end</span>
|
516
|
+
|
517
|
+
<span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_build_base_url'>build_base_url</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>/get_chat_messages</span><span class='tstring_end'>"</span></span>
|
518
|
+
<span class='id identifier rubyid_execute'>execute</span> <span class='label'>method:</span> <span class='symbol'>:get</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
519
|
+
<span class='label'>headers:</span> <span class='id identifier rubyid_build_headers'>build_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>params:</span> <span class='id identifier rubyid_chat_messages'>chat_messages</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span><span class='rparen'>)</span><span class='comma'>,</span>
|
520
|
+
<span class='label'>verify_ssl:</span> <span class='id identifier rubyid_build_verify_ssl'>build_verify_ssl</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
521
|
+
<span class='kw'>end</span></pre>
|
522
|
+
</td>
|
523
|
+
</tr>
|
524
|
+
</table>
|
525
|
+
</div>
|
526
|
+
|
527
|
+
<div class="method_details ">
|
528
|
+
<h3 class="signature " id="get_contracts-instance_method">
|
529
|
+
|
530
|
+
- (<tt>Object</tt>) <strong>get_contracts</strong>(contracts, options = {})
|
531
|
+
|
532
|
+
|
533
|
+
|
534
|
+
|
535
|
+
|
536
|
+
</h3><div class="docstring">
|
537
|
+
<div class="discussion">
|
538
|
+
|
539
|
+
<p>GET api/v1/contracts</p>
|
540
|
+
|
541
|
+
|
542
|
+
</div>
|
543
|
+
</div>
|
544
|
+
<div class="tags">
|
545
|
+
|
546
|
+
|
547
|
+
</div><table class="source_code">
|
548
|
+
<tr>
|
549
|
+
<td>
|
550
|
+
<pre class="lines">
|
551
|
+
|
552
|
+
|
553
|
+
109
|
554
|
+
110
|
555
|
+
111
|
556
|
+
112
|
557
|
+
113
|
558
|
+
114
|
559
|
+
115
|
560
|
+
116
|
561
|
+
117
|
562
|
+
118
|
563
|
+
119
|
564
|
+
120
|
565
|
+
121
|
566
|
+
122
|
567
|
+
123</pre>
|
568
|
+
</td>
|
569
|
+
<td>
|
570
|
+
<pre class="code"><span class="info file"># File 'lib/obarc/api.rb', line 109</span>
|
571
|
+
|
572
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_contracts'>get_contracts</span><span class='lparen'>(</span><span class='id identifier rubyid_contracts'>contracts</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
573
|
+
<span class='id identifier rubyid_id'>id</span> <span class='op'>=</span> <span class='id identifier rubyid_contracts'>contracts</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span>
|
574
|
+
<span class='id identifier rubyid_guid'>guid</span> <span class='op'>=</span> <span class='id identifier rubyid_contracts'>contracts</span><span class='lbracket'>[</span><span class='symbol'>:guid</span><span class='rbracket'>]</span>
|
575
|
+
|
576
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_id'>id</span> <span class='op'>&&</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>!=</span> <span class='int'>40</span>
|
577
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>Utils</span><span class='op'>::</span><span class='const'>Exceptions</span><span class='op'>::</span><span class='const'>InvalidArgumentError</span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>must be 40 characters, if present (was: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>"</span></span>
|
578
|
+
<span class='kw'>elsif</span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_guid'>guid</span> <span class='op'>&&</span> <span class='id identifier rubyid_guid'>guid</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>!=</span> <span class='int'>40</span>
|
579
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>Utils</span><span class='op'>::</span><span class='const'>Exceptions</span><span class='op'>::</span><span class='const'>InvalidArgumentError</span><span class='comma'>,</span> <span class='label'>guid:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>must be 40 characters, if present (was: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_guid'>guid</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>"</span></span>
|
580
|
+
<span class='kw'>end</span>
|
581
|
+
|
582
|
+
<span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_build_base_url'>build_base_url</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>/contracts</span><span class='tstring_end'>"</span></span>
|
583
|
+
<span class='id identifier rubyid_execute'>execute</span> <span class='label'>method:</span> <span class='symbol'>:get</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
584
|
+
<span class='label'>headers:</span> <span class='id identifier rubyid_build_headers'>build_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>params:</span> <span class='id identifier rubyid_contracts'>contracts</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span><span class='rparen'>)</span><span class='comma'>,</span>
|
585
|
+
<span class='label'>verify_ssl:</span> <span class='id identifier rubyid_build_verify_ssl'>build_verify_ssl</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
586
|
+
<span class='kw'>end</span></pre>
|
587
|
+
</td>
|
588
|
+
</tr>
|
589
|
+
</table>
|
590
|
+
</div>
|
591
|
+
|
592
|
+
<div class="method_details ">
|
593
|
+
<h3 class="signature " id="get_order-instance_method">
|
594
|
+
|
595
|
+
- (<tt>Object</tt>) <strong>get_order</strong>(order, options = {})
|
596
|
+
|
597
|
+
|
598
|
+
|
599
|
+
|
600
|
+
|
601
|
+
</h3><div class="docstring">
|
602
|
+
<div class="discussion">
|
603
|
+
|
604
|
+
<p>GET api/v1/get_order</p>
|
605
|
+
|
606
|
+
|
607
|
+
</div>
|
608
|
+
</div>
|
609
|
+
<div class="tags">
|
610
|
+
|
611
|
+
|
612
|
+
</div><table class="source_code">
|
613
|
+
<tr>
|
614
|
+
<td>
|
615
|
+
<pre class="lines">
|
616
|
+
|
617
|
+
|
618
|
+
140
|
619
|
+
141
|
620
|
+
142
|
621
|
+
143
|
622
|
+
144
|
623
|
+
145
|
624
|
+
146
|
625
|
+
147
|
626
|
+
148
|
627
|
+
149
|
628
|
+
150
|
629
|
+
151</pre>
|
630
|
+
</td>
|
631
|
+
<td>
|
632
|
+
<pre class="code"><span class="info file"># File 'lib/obarc/api.rb', line 140</span>
|
633
|
+
|
634
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_order'>get_order</span><span class='lparen'>(</span><span class='id identifier rubyid_order'>order</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
635
|
+
<span class='id identifier rubyid_order_id'>order_id</span> <span class='op'>=</span> <span class='id identifier rubyid_order'>order</span><span class='lbracket'>[</span><span class='symbol'>:order_id</span><span class='rbracket'>]</span>
|
636
|
+
|
637
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_order_id'>order_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
638
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>Utils</span><span class='op'>::</span><span class='const'>Exceptions</span><span class='op'>::</span><span class='const'>InvalidArgumentError</span><span class='comma'>,</span> <span class='label'>order_id:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>must be present</span><span class='tstring_end'>'</span></span>
|
639
|
+
<span class='kw'>end</span>
|
640
|
+
|
641
|
+
<span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_build_base_url'>build_base_url</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>/get_order</span><span class='tstring_end'>"</span></span>
|
642
|
+
<span class='id identifier rubyid_execute'>execute</span> <span class='label'>method:</span> <span class='symbol'>:get</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
643
|
+
<span class='label'>headers:</span> <span class='id identifier rubyid_build_headers'>build_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>params:</span> <span class='id identifier rubyid_order'>order</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span><span class='rparen'>)</span><span class='comma'>,</span>
|
644
|
+
<span class='label'>verify_ssl:</span> <span class='id identifier rubyid_build_verify_ssl'>build_verify_ssl</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
645
|
+
<span class='kw'>end</span></pre>
|
646
|
+
</td>
|
647
|
+
</tr>
|
648
|
+
</table>
|
649
|
+
</div>
|
650
|
+
|
651
|
+
<div class="method_details ">
|
652
|
+
<h3 class="signature " id="ping-instance_method">
|
653
|
+
|
654
|
+
- (<tt>Object</tt>) <strong>ping</strong>(options = {})
|
655
|
+
|
656
|
+
|
657
|
+
|
658
|
+
|
659
|
+
|
660
|
+
</h3><table class="source_code">
|
661
|
+
<tr>
|
662
|
+
<td>
|
663
|
+
<pre class="lines">
|
664
|
+
|
665
|
+
|
666
|
+
38
|
667
|
+
39
|
668
|
+
40
|
669
|
+
41
|
670
|
+
42</pre>
|
671
|
+
</td>
|
672
|
+
<td>
|
673
|
+
<pre class="code"><span class="info file"># File 'lib/obarc/api.rb', line 38</span>
|
674
|
+
|
675
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_ping'>ping</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
676
|
+
<span class='id identifier rubyid_execute'>execute</span><span class='lparen'>(</span><span class='label'>method:</span> <span class='symbol'>:get</span><span class='comma'>,</span>
|
677
|
+
<span class='label'>url:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_build_base_url'>build_base_url</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>/connected_peers?_=</span><span class='embexpr_beg'>#{</span><span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
678
|
+
<span class='label'>headers:</span> <span class='id identifier rubyid_build_headers'>build_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>verify_ssl:</span> <span class='id identifier rubyid_build_verify_ssl'>build_verify_ssl</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
679
|
+
<span class='kw'>end</span></pre>
|
680
|
+
</td>
|
681
|
+
</tr>
|
682
|
+
</table>
|
683
|
+
</div>
|
684
|
+
|
685
|
+
<div class="method_details ">
|
686
|
+
<h3 class="signature " id="post_login-instance_method">
|
687
|
+
|
688
|
+
- (<tt>Object</tt>) <strong>post_login</strong>(options = {})
|
689
|
+
|
690
|
+
|
691
|
+
|
692
|
+
|
693
|
+
|
694
|
+
</h3><div class="docstring">
|
695
|
+
<div class="discussion">
|
696
|
+
|
697
|
+
<p>POST api/v1/login</p>
|
698
|
+
|
699
|
+
|
700
|
+
</div>
|
701
|
+
</div>
|
702
|
+
<div class="tags">
|
703
|
+
|
704
|
+
<p class="tag_title">Raises:</p>
|
705
|
+
<ul class="raise">
|
706
|
+
|
707
|
+
<li>
|
708
|
+
|
709
|
+
|
710
|
+
<span class='type'>(<tt><span class='object_link'><a href="Utils/Exceptions/MissingArgumentError.html" title="OBarc::Utils::Exceptions::MissingArgumentError (class)">Utils::Exceptions::MissingArgumentError</a></span></tt>)</span>
|
711
|
+
|
712
|
+
|
713
|
+
|
714
|
+
</li>
|
715
|
+
|
716
|
+
</ul>
|
717
|
+
|
718
|
+
</div><table class="source_code">
|
719
|
+
<tr>
|
720
|
+
<td>
|
721
|
+
<pre class="lines">
|
722
|
+
|
723
|
+
|
724
|
+
28
|
725
|
+
29
|
726
|
+
30
|
727
|
+
31
|
728
|
+
32
|
729
|
+
33
|
730
|
+
34
|
731
|
+
35
|
732
|
+
36</pre>
|
733
|
+
</td>
|
734
|
+
<td>
|
735
|
+
<pre class="code"><span class="info file"># File 'lib/obarc/api.rb', line 28</span>
|
736
|
+
|
737
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_post_login'>post_login</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
738
|
+
<span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_build_base_url'>build_base_url</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>/login</span><span class='tstring_end'>"</span></span>
|
739
|
+
<span class='id identifier rubyid_auth'>auth</span> <span class='op'>=</span> <span class='id identifier rubyid_build_authentication'>build_authentication</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
740
|
+
|
741
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>Utils</span><span class='op'>::</span><span class='const'>Exceptions</span><span class='op'>::</span><span class='const'>MissingArgumentError</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:username</span><span class='comma'>,</span> <span class='symbol'>:password</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_auth'>auth</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
742
|
+
|
743
|
+
<span class='id identifier rubyid_execute'>execute</span> <span class='label'>method:</span> <span class='symbol'>:post</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='label'>params:</span> <span class='id identifier rubyid_auth'>auth</span><span class='rbrace'>}</span><span class='comma'>,</span>
|
744
|
+
<span class='label'>verify_ssl:</span> <span class='id identifier rubyid_build_verify_ssl'>build_verify_ssl</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
745
|
+
<span class='kw'>end</span></pre>
|
746
|
+
</td>
|
747
|
+
</tr>
|
748
|
+
</table>
|
749
|
+
</div>
|
750
|
+
|
751
|
+
<div class="method_details ">
|
752
|
+
<h3 class="signature " id="post_upload_image-instance_method">
|
753
|
+
|
754
|
+
- (<tt>Object</tt>) <strong>post_upload_image</strong>(options = {})
|
755
|
+
|
756
|
+
|
757
|
+
|
758
|
+
|
759
|
+
|
760
|
+
</h3><div class="docstring">
|
761
|
+
<div class="discussion">
|
762
|
+
|
763
|
+
<p>POST api/v1/upload_image</p>
|
764
|
+
|
765
|
+
|
766
|
+
</div>
|
767
|
+
</div>
|
768
|
+
<div class="tags">
|
769
|
+
|
770
|
+
|
771
|
+
</div><table class="source_code">
|
772
|
+
<tr>
|
773
|
+
<td>
|
774
|
+
<pre class="lines">
|
775
|
+
|
776
|
+
|
777
|
+
97
|
778
|
+
98
|
779
|
+
99
|
780
|
+
100
|
781
|
+
101
|
782
|
+
102
|
783
|
+
103
|
784
|
+
104
|
785
|
+
105
|
786
|
+
106</pre>
|
787
|
+
</td>
|
788
|
+
<td>
|
789
|
+
<pre class="code"><span class="info file"># File 'lib/obarc/api.rb', line 97</span>
|
790
|
+
|
791
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_post_upload_image'>post_upload_image</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
792
|
+
<span class='id identifier rubyid_elements'>elements</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:image</span><span class='comma'>,</span> <span class='symbol'>:avatar</span><span class='comma'>,</span> <span class='symbol'>:header</span><span class='rbracket'>]</span>
|
793
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_slice'>slice</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_elements'>elements</span><span class='rparen'>)</span>
|
794
|
+
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete_if'>delete_if</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='id identifier rubyid_elements'>elements</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_k'>k</span> <span class='rbrace'>}</span>
|
795
|
+
|
796
|
+
<span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_build_base_url'>build_base_url</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>/upload_images</span><span class='tstring_end'>"</span></span>
|
797
|
+
<span class='id identifier rubyid_execute'>execute</span> <span class='label'>method:</span> <span class='symbol'>:post</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
798
|
+
<span class='label'>headers:</span> <span class='id identifier rubyid_build_headers'>build_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span><span class='rparen'>)</span><span class='comma'>,</span>
|
799
|
+
<span class='label'>verify_ssl:</span> <span class='id identifier rubyid_build_verify_ssl'>build_verify_ssl</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
800
|
+
<span class='kw'>end</span></pre>
|
801
|
+
</td>
|
802
|
+
</tr>
|
803
|
+
</table>
|
804
|
+
</div>
|
805
|
+
|
806
|
+
<div class="method_details ">
|
807
|
+
<h3 class="signature " id="respond_to_missing?-instance_method">
|
808
|
+
|
809
|
+
- (<tt>Boolean</tt>) <strong>respond_to_missing?</strong>(m, include_private = false)
|
810
|
+
|
811
|
+
|
812
|
+
|
813
|
+
|
814
|
+
|
815
|
+
</h3><div class="docstring">
|
816
|
+
<div class="discussion">
|
817
|
+
|
818
|
+
|
819
|
+
</div>
|
820
|
+
</div>
|
821
|
+
<div class="tags">
|
822
|
+
|
823
|
+
<p class="tag_title">Returns:</p>
|
824
|
+
<ul class="return">
|
825
|
+
|
826
|
+
<li>
|
827
|
+
|
828
|
+
|
829
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
830
|
+
|
831
|
+
|
832
|
+
|
833
|
+
</li>
|
834
|
+
|
835
|
+
</ul>
|
836
|
+
|
837
|
+
</div><table class="source_code">
|
838
|
+
<tr>
|
839
|
+
<td>
|
840
|
+
<pre class="lines">
|
841
|
+
|
842
|
+
|
843
|
+
44
|
844
|
+
45
|
845
|
+
46
|
846
|
+
47
|
847
|
+
48
|
848
|
+
49
|
849
|
+
50
|
850
|
+
51
|
851
|
+
52
|
852
|
+
53</pre>
|
853
|
+
</td>
|
854
|
+
<td>
|
855
|
+
<pre class="code"><span class="info file"># File 'lib/obarc/api.rb', line 44</span>
|
856
|
+
|
857
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_respond_to_missing?'>respond_to_missing?</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='comma'>,</span> <span class='id identifier rubyid_include_private'>include_private</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
858
|
+
<span class='id identifier rubyid_verb'>verb</span> <span class='op'>=</span> <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>_</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
859
|
+
<span class='id identifier rubyid_rest_method'>rest_method</span> <span class='op'>=</span> <span class='id identifier rubyid_verb'>verb</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
|
860
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='const'>VALID_ACTIONS</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_rest_method'>rest_method</span><span class='rparen'>)</span>
|
861
|
+
|
862
|
+
<span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>=</span> <span class='id identifier rubyid_verb'>verb</span><span class='lbracket'>[</span><span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>_</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
863
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_endpoint'>endpoint</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
864
|
+
|
865
|
+
<span class='const'>VALID_ACTIONS</span><span class='lbracket'>[</span><span class='id identifier rubyid_rest_method'>rest_method</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint'>endpoint</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span>
|
866
|
+
<span class='kw'>end</span></pre>
|
867
|
+
</td>
|
868
|
+
</tr>
|
869
|
+
</table>
|
870
|
+
</div>
|
871
|
+
|
872
|
+
</div>
|
873
|
+
|
874
|
+
</div>
|
875
|
+
|
876
|
+
<div id="footer">
|
877
|
+
Generated on Tue Apr 4 17:29:29 2017 by
|
878
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
879
|
+
0.8.7.6 (ruby-2.2.5).
|
880
|
+
</div>
|
881
|
+
|
882
|
+
</body>
|
883
|
+
</html>
|