shotgrid_api_ruby 0.1.3.1 → 0.2.0.4

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.
Files changed (159) hide show
  1. checksums.yaml +4 -4
  2. data/.github/ISSUE_TEMPLATE/bug_report.md +38 -0
  3. data/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
  4. data/.github/workflows/test_and_publish.yml +4 -1
  5. data/.github/workflows/test_only.yml +5 -1
  6. data/.gitignore +3 -2
  7. data/.overcommit.yml +9 -0
  8. data/.rubocop.yml +2 -0
  9. data/.ruby-version +1 -1
  10. data/CHANGELOG.md +31 -3
  11. data/CODE_OF_CONDUCT.md +128 -0
  12. data/Gemfile +18 -0
  13. data/Gemfile.lock +264 -0
  14. data/Guardfile +2 -2
  15. data/bin/generate_and_add_documentation +1 -0
  16. data/bin/generate_sorbet_coverage +3 -0
  17. data/bin/prettirun +1 -1
  18. data/bin/sorbet_check +1 -0
  19. data/bin/tapioca +29 -0
  20. data/docs/ShotgridApiRuby/Auth/Validator.html +319 -0
  21. data/docs/ShotgridApiRuby/Auth.html +1079 -0
  22. data/docs/ShotgridApiRuby/Client.html +933 -0
  23. data/docs/ShotgridApiRuby/Entities/Params/TooComplexFiltersError.html +124 -0
  24. data/docs/ShotgridApiRuby/Entities/Params.html +1377 -0
  25. data/docs/ShotgridApiRuby/Entities/Schema.html +646 -0
  26. data/docs/ShotgridApiRuby/Entities/Summarize/Summary.html +401 -0
  27. data/docs/ShotgridApiRuby/Entities/Summarize.html +775 -0
  28. data/docs/ShotgridApiRuby/Entities.html +2461 -0
  29. data/docs/ShotgridApiRuby/Entity.html +935 -0
  30. data/docs/ShotgridApiRuby/Preferences.html +417 -0
  31. data/docs/ShotgridApiRuby/ServerInfo.html +415 -0
  32. data/docs/ShotgridApiRuby/ShotgridCallError.html +328 -0
  33. data/docs/ShotgridApiRuby/Types.html +136 -0
  34. data/docs/ShotgridApiRuby.html +307 -0
  35. data/docs/_index.html +253 -0
  36. data/docs/class_list.html +51 -0
  37. data/docs/css/common.css +1 -0
  38. data/docs/css/full_list.css +58 -0
  39. data/docs/css/style.css +497 -0
  40. data/docs/file.README.html +578 -0
  41. data/docs/file_list.html +56 -0
  42. data/docs/frames.html +17 -0
  43. data/docs/index.html +578 -0
  44. data/docs/js/app.js +314 -0
  45. data/docs/js/full_list.js +216 -0
  46. data/docs/js/jquery.js +4 -0
  47. data/docs/method_list.html +643 -0
  48. data/docs/top-level-namespace.html +110 -0
  49. data/lib/shotgrid_api_ruby/auth.rb +89 -33
  50. data/lib/shotgrid_api_ruby/client.rb +50 -7
  51. data/lib/shotgrid_api_ruby/entities/params.rb +304 -65
  52. data/lib/shotgrid_api_ruby/entities/schema.rb +18 -3
  53. data/lib/shotgrid_api_ruby/entities/summarize.rb +39 -7
  54. data/lib/shotgrid_api_ruby/entities.rb +118 -29
  55. data/lib/shotgrid_api_ruby/entity.rb +29 -12
  56. data/lib/shotgrid_api_ruby/preferences.rb +7 -1
  57. data/lib/shotgrid_api_ruby/server_info.rb +7 -1
  58. data/lib/shotgrid_api_ruby/shotgrid_call_error.rb +5 -1
  59. data/lib/shotgrid_api_ruby/types/auth_type.rb +23 -0
  60. data/lib/shotgrid_api_ruby/version.rb +2 -1
  61. data/lib/shotgrid_api_ruby.rb +20 -2
  62. data/shotgrid_api_ruby.gemspec +4 -11
  63. data/sorbet/config +6 -0
  64. data/sorbet/rbi/faraday.rbi +20 -0
  65. data/sorbet/rbi/gems/activesupport@6.1.4.1.rbi +3770 -0
  66. data/sorbet/rbi/gems/ast@2.4.2.rbi +54 -0
  67. data/sorbet/rbi/gems/backport@1.2.0.rbi +8 -0
  68. data/sorbet/rbi/gems/benchmark@0.1.1.rbi +65 -0
  69. data/sorbet/rbi/gems/bundler-audit@0.8.0.rbi +8 -0
  70. data/sorbet/rbi/gems/byebug@11.1.3.rbi +1569 -0
  71. data/sorbet/rbi/gems/childprocess@4.1.0.rbi +8 -0
  72. data/sorbet/rbi/gems/coderay@1.1.3.rbi +1005 -0
  73. data/sorbet/rbi/gems/colorize@0.8.1.rbi +39 -0
  74. data/sorbet/rbi/gems/commander@4.6.0.rbi +8 -0
  75. data/sorbet/rbi/gems/concurrent-ruby@1.1.9.rbi +2403 -0
  76. data/sorbet/rbi/gems/diff-lcs@1.4.4.rbi +8 -0
  77. data/sorbet/rbi/gems/docile@1.4.0.rbi +54 -0
  78. data/sorbet/rbi/gems/dotenv@2.7.6.rbi +88 -0
  79. data/sorbet/rbi/gems/e2mmap@0.1.0.rbi +8 -0
  80. data/sorbet/rbi/gems/faker@2.19.0.rbi +2513 -0
  81. data/sorbet/rbi/gems/faraday-em_http@1.0.0.rbi +101 -0
  82. data/sorbet/rbi/gems/faraday-em_synchrony@1.0.0.rbi +78 -0
  83. data/sorbet/rbi/gems/faraday-excon@1.1.0.rbi +77 -0
  84. data/sorbet/rbi/gems/faraday-httpclient@1.0.1.rbi +73 -0
  85. data/sorbet/rbi/gems/faraday-net_http@1.0.1.rbi +82 -0
  86. data/sorbet/rbi/gems/faraday-net_http_persistent@1.2.0.rbi +72 -0
  87. data/sorbet/rbi/gems/faraday-patron@1.0.0.rbi +74 -0
  88. data/sorbet/rbi/gems/faraday-rack@1.0.0.rbi +73 -0
  89. data/sorbet/rbi/gems/faraday@1.7.0.rbi +783 -0
  90. data/sorbet/rbi/gems/ffi@1.15.3.rbi +8 -0
  91. data/sorbet/rbi/gems/formatador@0.3.0.rbi +8 -0
  92. data/sorbet/rbi/gems/guard-compat@1.2.1.rbi +8 -0
  93. data/sorbet/rbi/gems/guard-rspec@4.7.3.rbi +8 -0
  94. data/sorbet/rbi/gems/guard@2.18.0.rbi +8 -0
  95. data/sorbet/rbi/gems/haml@5.2.2.rbi +8 -0
  96. data/sorbet/rbi/gems/highline@2.0.3.rbi +8 -0
  97. data/sorbet/rbi/gems/i18n@1.8.10.rbi +584 -0
  98. data/sorbet/rbi/gems/iniparse@1.5.0.rbi +8 -0
  99. data/sorbet/rbi/gems/jaro_winkler@1.5.4.rbi +8 -0
  100. data/sorbet/rbi/gems/kramdown-parser-gfm@1.1.0.rbi +8 -0
  101. data/sorbet/rbi/gems/kramdown@2.3.1.rbi +8 -0
  102. data/sorbet/rbi/gems/listen@3.7.0.rbi +476 -0
  103. data/sorbet/rbi/gems/lumberjack@1.2.8.rbi +8 -0
  104. data/sorbet/rbi/gems/method_source@1.0.0.rbi +72 -0
  105. data/sorbet/rbi/gems/minitest@5.14.4.rbi +344 -0
  106. data/sorbet/rbi/gems/multipart-post@2.1.1.rbi +69 -0
  107. data/sorbet/rbi/gems/nenv@0.3.0.rbi +8 -0
  108. data/sorbet/rbi/gems/nokogiri@1.12.3.rbi +8 -0
  109. data/sorbet/rbi/gems/notiffany@0.1.3.rbi +8 -0
  110. data/sorbet/rbi/gems/overcommit@0.58.0.rbi +8 -0
  111. data/sorbet/rbi/gems/parallel@1.20.1.rbi +8 -0
  112. data/sorbet/rbi/gems/parlour@6.0.1.rbi +1610 -0
  113. data/sorbet/rbi/gems/parser@3.0.2.0.rbi +1731 -0
  114. data/sorbet/rbi/gems/prettier@1.6.1.rbi +8 -0
  115. data/sorbet/rbi/gems/pry-byebug@3.9.0.rbi +461 -0
  116. data/sorbet/rbi/gems/pry@0.13.1.rbi +2553 -0
  117. data/sorbet/rbi/gems/racc@1.5.2.rbi +47 -0
  118. data/sorbet/rbi/gems/rainbow@3.0.0.rbi +153 -0
  119. data/sorbet/rbi/gems/rake@13.0.6.rbi +807 -0
  120. data/sorbet/rbi/gems/rb-fsevent@0.11.0.rbi +8 -0
  121. data/sorbet/rbi/gems/rb-inotify@0.10.1.rbi +8 -0
  122. data/sorbet/rbi/gems/regexp_parser@2.1.1.rbi +8 -0
  123. data/sorbet/rbi/gems/reverse_markdown@2.0.0.rbi +8 -0
  124. data/sorbet/rbi/gems/rexml@3.2.5.rbi +672 -0
  125. data/sorbet/rbi/gems/rspec-core@3.10.1.rbi +2500 -0
  126. data/sorbet/rbi/gems/rspec-expectations@3.10.1.rbi +1574 -0
  127. data/sorbet/rbi/gems/rspec-mocks@3.10.2.rbi +1462 -0
  128. data/sorbet/rbi/gems/rspec-support@3.10.2.rbi +510 -0
  129. data/sorbet/rbi/gems/rspec@3.10.0.rbi +39 -0
  130. data/sorbet/rbi/gems/rspec_in_context@1.1.0.3.rbi +196 -0
  131. data/sorbet/rbi/gems/rubocop-ast@1.11.0.rbi +8 -0
  132. data/sorbet/rbi/gems/rubocop-faker@1.1.0.rbi +8 -0
  133. data/sorbet/rbi/gems/rubocop-performance@1.11.5.rbi +8 -0
  134. data/sorbet/rbi/gems/rubocop-sorbet@0.6.2.rbi +8 -0
  135. data/sorbet/rbi/gems/rubocop@1.20.0.rbi +8 -0
  136. data/sorbet/rbi/gems/ruby-progressbar@1.11.0.rbi +8 -0
  137. data/sorbet/rbi/gems/ruby2_keywords@0.0.5.rbi +8 -0
  138. data/sorbet/rbi/gems/shellany@0.0.1.rbi +8 -0
  139. data/sorbet/rbi/gems/simplecov-html@0.12.3.rbi +89 -0
  140. data/sorbet/rbi/gems/simplecov@0.21.2.rbi +577 -0
  141. data/sorbet/rbi/gems/simplecov_json_formatter@0.1.3.rbi +8 -0
  142. data/sorbet/rbi/gems/solargraph@0.43.0.rbi +8 -0
  143. data/sorbet/rbi/gems/spoom@1.1.2.rbi +1204 -0
  144. data/sorbet/rbi/gems/tapioca@0.4.25.rbi +1239 -0
  145. data/sorbet/rbi/gems/temple@0.8.2.rbi +8 -0
  146. data/sorbet/rbi/gems/thor@1.1.0.rbi +838 -0
  147. data/sorbet/rbi/gems/tilt@2.0.10.rbi +8 -0
  148. data/sorbet/rbi/gems/timecop@0.9.4.rbi +82 -0
  149. data/sorbet/rbi/gems/tzinfo@2.0.4.rbi +857 -0
  150. data/sorbet/rbi/gems/unicode-display_width@2.0.0.rbi +8 -0
  151. data/sorbet/rbi/gems/unparser@0.6.0.rbi +8 -0
  152. data/sorbet/rbi/gems/vcr@6.0.0.rbi +782 -0
  153. data/sorbet/rbi/gems/yard-sorbet@0.5.3.rbi +8 -0
  154. data/sorbet/rbi/gems/yard@0.9.26.rbi +8 -0
  155. data/sorbet/rbi/gems/zeitwerk@2.4.2.rbi +173 -0
  156. data/sorbet/tapioca/config +0 -0
  157. data/sorbet/tapioca/require.rb +5 -0
  158. data/yarn.lock +3 -3
  159. metadata +157 -138
data/docs/ShotgridApiRuby/Auth/Validator.html ADDED
@@ -0,0 +1,319 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Module: ShotgridApiRuby::Auth::Validator
8
+
9
+ &mdash; Documentation by YARD 0.9.26
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "ShotgridApiRuby::Auth::Validator";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (V)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../ShotgridApiRuby.html" title="ShotgridApiRuby (module)">ShotgridApiRuby</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Auth.html" title="ShotgridApiRuby::Auth (class)">Auth</a></span></span>
41
+ &raquo;
42
+ <span class="title">Validator</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Module: ShotgridApiRuby::Auth::Validator
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+ <dl>
73
+ <dt>Extended by:</dt>
74
+ <dd>T::Sig</dd>
75
+ </dl>
76
+
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+ <dl>
85
+ <dt>Defined in:</dt>
86
+ <dd>lib/shotgrid_api_ruby/auth.rb</dd>
87
+ </dl>
88
+
89
+ </div>
90
+
91
+ <h2>Overview</h2><div class="docstring">
92
+ <div class="discussion">
93
+
94
+ <p>Validate auth parameters format</p>
95
+
96
+
97
+ </div>
98
+ </div>
99
+ <div class="tags">
100
+
101
+
102
+ </div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ <h2>
111
+ Class Method Summary
112
+ <small><a href="#" class="summary_toggle">collapse</a></small>
113
+ </h2>
114
+
115
+ <ul class="summary">
116
+
117
+ <li class="public ">
118
+ <span class="summary_signature">
119
+
120
+ <a href="#valid%3F-class_method" title="valid? (class method)">.<strong>valid?</strong>(client_id: nil, client_secret: nil, username: nil, password: nil, session_token: nil, refresh_token: nil) &#x21d2; Boolean </a>
121
+
122
+
123
+
124
+ </span>
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+ <span class="summary_desc"><div class='inline'>
135
+ <p>Validate auth parameters format.</p>
136
+ </div></span>
137
+
138
+ </li>
139
+
140
+
141
+ </ul>
142
+
143
+
144
+
145
+
146
+
147
+ <div id="class_method_details" class="method_details_list">
148
+ <h2>Class Method Details</h2>
149
+
150
+
151
+ <div class="method_details first">
152
+ <h3 class="signature first" id="valid?-class_method">
153
+
154
+ .<strong>valid?</strong>(client_id: nil, client_secret: nil, username: nil, password: nil, session_token: nil, refresh_token: nil) &#x21d2; <tt>Boolean</tt>
155
+
156
+
157
+
158
+
159
+
160
+ </h3><div class="docstring">
161
+ <div class="discussion">
162
+
163
+ <p>Validate auth parameters format</p>
164
+
165
+
166
+ </div>
167
+ </div>
168
+ <div class="tags">
169
+ <p class="tag_title">Parameters:</p>
170
+ <ul class="param">
171
+
172
+ <li>
173
+
174
+ <span class='name'>client_id</span>
175
+
176
+
177
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
178
+
179
+
180
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
181
+
182
+
183
+ </li>
184
+
185
+ <li>
186
+
187
+ <span class='name'>client_secret</span>
188
+
189
+
190
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
191
+
192
+
193
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
194
+
195
+
196
+ </li>
197
+
198
+ <li>
199
+
200
+ <span class='name'>username</span>
201
+
202
+
203
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
204
+
205
+
206
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
207
+
208
+
209
+ </li>
210
+
211
+ <li>
212
+
213
+ <span class='name'>password</span>
214
+
215
+
216
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
217
+
218
+
219
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
220
+
221
+
222
+ </li>
223
+
224
+ <li>
225
+
226
+ <span class='name'>session_token</span>
227
+
228
+
229
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
230
+
231
+
232
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
233
+
234
+
235
+ </li>
236
+
237
+ <li>
238
+
239
+ <span class='name'>refresh_token</span>
240
+
241
+
242
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
243
+
244
+
245
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
246
+
247
+
248
+ </li>
249
+
250
+ </ul>
251
+
252
+ <p class="tag_title">Returns:</p>
253
+ <ul class="return">
254
+
255
+ <li>
256
+
257
+
258
+ <span class='type'>(<tt>Boolean</tt>)</span>
259
+
260
+
261
+
262
+ </li>
263
+
264
+ </ul>
265
+
266
+ </div><table class="source_code">
267
+ <tr>
268
+ <td>
269
+ <pre class="lines">
270
+
271
+
272
+ 26
273
+ 27
274
+ 28
275
+ 29
276
+ 30
277
+ 31
278
+ 32
279
+ 33
280
+ 34
281
+ 35
282
+ 36
283
+ 37
284
+ 38</pre>
285
+ </td>
286
+ <td>
287
+ <pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/auth.rb', line 26</span>
288
+
289
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_valid?'>valid?</span><span class='lparen'>(</span>
290
+ <span class='label'>client_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
291
+ <span class='label'>client_secret:</span> <span class='kw'>nil</span><span class='comma'>,</span>
292
+ <span class='label'>username:</span> <span class='kw'>nil</span><span class='comma'>,</span>
293
+ <span class='label'>password:</span> <span class='kw'>nil</span><span class='comma'>,</span>
294
+ <span class='label'>session_token:</span> <span class='kw'>nil</span><span class='comma'>,</span>
295
+ <span class='label'>refresh_token:</span> <span class='kw'>nil</span>
296
+ <span class='rparen'>)</span>
297
+ <span class='op'>!</span><span class='op'>!</span><span class='lparen'>(</span>
298
+ <span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_id</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_client_secret'>client_secret</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='id identifier rubyid_password'>password</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_username'>username</span><span class='rparen'>)</span> <span class='op'>||</span>
299
+ <span class='id identifier rubyid_session_token'>session_token</span> <span class='op'>||</span> <span class='id identifier rubyid_refresh_token'>refresh_token</span>
300
+ <span class='rparen'>)</span>
301
+ <span class='kw'>end</span></pre>
302
+ </td>
303
+ </tr>
304
+ </table>
305
+ </div>
306
+
307
+ </div>
308
+
309
+ </div>
310
+
311
+ <div id="footer">
312
+ Generated on Tue Oct 12 21:57:54 2021 by
313
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
314
+ 0.9.26 (ruby-3.0.2).
315
+ </div>
316
+
317
+ </div>
318
+ </body>
319
+ </html>