strawberry_api 0.5.4 → 0.6.0
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 +4 -4
- data/.rubocop.yml +4022 -4
- data/doc/HTTParty/Response.html +1 -1
- data/doc/StrawberryAPI.html +2 -2
- data/doc/StrawberryAPI/AccessRight.html +1 -1
- data/doc/StrawberryAPI/ApiKey.html +1 -1
- data/doc/StrawberryAPI/ArchiveStrategy.html +1 -1
- data/doc/StrawberryAPI/ArchiveStrategyState.html +1 -1
- data/doc/StrawberryAPI/Asset.html +1 -1
- data/doc/StrawberryAPI/AssetCopyToStrategy.html +1 -1
- data/doc/StrawberryAPI/AssetFeedback.html +1 -1
- data/doc/StrawberryAPI/Client.html +2 -2
- data/doc/StrawberryAPI/Client/ApiKeys.html +1 -1
- data/doc/StrawberryAPI/Client/ArchiveStrategies.html +1 -1
- data/doc/StrawberryAPI/Client/AssetCopyToStrategies.html +1 -1
- data/doc/StrawberryAPI/Client/AssetFeedbacks.html +1 -1
- data/doc/StrawberryAPI/Client/Assets.html +1 -1
- data/doc/StrawberryAPI/Client/Collections.html +1 -1
- data/doc/StrawberryAPI/Client/CopyToFeedbacks.html +1 -1
- data/doc/StrawberryAPI/Client/CustomMetadata.html +1 -1
- data/doc/StrawberryAPI/Client/CustomMetadataFields.html +1 -1
- data/doc/StrawberryAPI/Client/CustomMetadataOptions.html +1 -1
- data/doc/StrawberryAPI/Client/CustomMetadataSets.html +1 -1
- data/doc/StrawberryAPI/Client/Edits.html +1 -1
- data/doc/StrawberryAPI/Client/Features.html +1 -1
- data/doc/StrawberryAPI/Client/Libraries.html +1 -1
- data/doc/StrawberryAPI/Client/Markers.html +1 -1
- data/doc/StrawberryAPI/Client/ProjectCopyToStrategies.html +1 -1
- data/doc/StrawberryAPI/Client/ProjectFeedbacks.html +1 -1
- data/doc/StrawberryAPI/Client/Projects.html +92 -9
- data/doc/StrawberryAPI/Client/Roles.html +1 -1
- data/doc/StrawberryAPI/Client/Schedules.html +1 -1
- data/doc/StrawberryAPI/Client/Searches.html +1 -1
- data/doc/StrawberryAPI/Client/Sessions.html +1 -1
- data/doc/StrawberryAPI/Client/Settings.html +1 -1
- data/doc/StrawberryAPI/Client/StatusFlags.html +1 -1
- data/doc/StrawberryAPI/Client/Teams.html +1 -1
- data/doc/StrawberryAPI/Client/Templates.html +1 -1
- data/doc/StrawberryAPI/Client/Users.html +1 -1
- data/doc/StrawberryAPI/Collection.html +1 -1
- data/doc/StrawberryAPI/Configuration.html +1 -1
- data/doc/StrawberryAPI/CopyToFeedback.html +1 -1
- data/doc/StrawberryAPI/CustomMetadataField.html +1 -1
- data/doc/StrawberryAPI/CustomMetadataOption.html +1 -1
- data/doc/StrawberryAPI/CustomMetadataSet.html +1 -1
- data/doc/StrawberryAPI/CustomMetadatum.html +1 -1
- data/doc/StrawberryAPI/Edit.html +1 -1
- data/doc/StrawberryAPI/Feature.html +1 -1
- data/doc/StrawberryAPI/Feedback.html +1 -1
- data/doc/StrawberryAPI/HttpClient.html +1 -1
- data/doc/StrawberryAPI/Library.html +1 -1
- data/doc/StrawberryAPI/Marker.html +1 -1
- data/doc/StrawberryAPI/Metadatum.html +1 -1
- data/doc/StrawberryAPI/Project.html +1 -1
- data/doc/StrawberryAPI/ProjectCopyToStrategy.html +1 -1
- data/doc/StrawberryAPI/ProjectFeedback.html +1 -1
- data/doc/StrawberryAPI/Proxy.html +1 -1
- data/doc/StrawberryAPI/Role.html +1 -1
- data/doc/StrawberryAPI/Schedule.html +1 -1
- data/doc/StrawberryAPI/Session.html +1 -1
- data/doc/StrawberryAPI/Setting.html +1 -1
- data/doc/StrawberryAPI/StatusFlag.html +1 -1
- data/doc/StrawberryAPI/Strategy.html +1 -1
- data/doc/StrawberryAPI/Team.html +1 -1
- data/doc/StrawberryAPI/Template.html +1 -1
- data/doc/StrawberryAPI/User.html +1 -1
- data/doc/_index.html +1 -1
- data/doc/file.README.html +87 -103
- data/doc/index.html +87 -103
- data/doc/method_list.html +343 -335
- data/doc/top-level-namespace.html +1 -1
- data/lib/strawberry_api.rb +4 -4
- data/lib/strawberry_api/client.rb +61 -61
- data/lib/strawberry_api/client/projects.rb +36 -36
- data/lib/strawberry_api/http_client.rb +11 -11
- data/lib/strawberry_api/version.rb +1 -1
- data/samples/test.rb +1 -1
- data/strawberry_api.gemspec +21 -22
- metadata +3 -3
|
@@ -204,7 +204,7 @@
|
|
|
204
204
|
</div>
|
|
205
205
|
|
|
206
206
|
<div id="footer">
|
|
207
|
-
Generated on
|
|
207
|
+
Generated on Thu Mar 26 12:41:05 2020 by
|
|
208
208
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
209
209
|
0.9.16 (ruby-2.5.0).
|
|
210
210
|
</div>
|
|
@@ -309,7 +309,7 @@
|
|
|
309
309
|
</div>
|
|
310
310
|
|
|
311
311
|
<div id="footer">
|
|
312
|
-
Generated on
|
|
312
|
+
Generated on Wed Mar 13 18:57:19 2019 by
|
|
313
313
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
314
314
|
0.9.16 (ruby-2.5.0).
|
|
315
315
|
</div>
|
|
@@ -283,7 +283,7 @@
|
|
|
283
283
|
</div>
|
|
284
284
|
|
|
285
285
|
<div id="footer">
|
|
286
|
-
Generated on
|
|
286
|
+
Generated on Wed Mar 13 18:57:19 2019 by
|
|
287
287
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
288
288
|
0.9.16 (ruby-2.5.0).
|
|
289
289
|
</div>
|
|
@@ -366,7 +366,7 @@
|
|
|
366
366
|
</div>
|
|
367
367
|
|
|
368
368
|
<div id="footer">
|
|
369
|
-
Generated on
|
|
369
|
+
Generated on Wed Mar 13 18:57:19 2019 by
|
|
370
370
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
371
371
|
0.9.16 (ruby-2.5.0).
|
|
372
372
|
</div>
|
|
@@ -200,7 +200,7 @@
|
|
|
200
200
|
</div>
|
|
201
201
|
|
|
202
202
|
<div id="footer">
|
|
203
|
-
Generated on
|
|
203
|
+
Generated on Wed Mar 13 18:57:19 2019 by
|
|
204
204
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
205
205
|
0.9.16 (ruby-2.5.0).
|
|
206
206
|
</div>
|
|
@@ -305,7 +305,7 @@
|
|
|
305
305
|
</div>
|
|
306
306
|
|
|
307
307
|
<div id="footer">
|
|
308
|
-
Generated on
|
|
308
|
+
Generated on Wed Mar 13 18:57:19 2019 by
|
|
309
309
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
310
310
|
0.9.16 (ruby-2.5.0).
|
|
311
311
|
</div>
|
|
@@ -1057,7 +1057,7 @@
|
|
|
1057
1057
|
</div>
|
|
1058
1058
|
|
|
1059
1059
|
<div id="footer">
|
|
1060
|
-
Generated on
|
|
1060
|
+
Generated on Thu Mar 26 12:41:05 2020 by
|
|
1061
1061
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1062
1062
|
0.9.16 (ruby-2.5.0).
|
|
1063
1063
|
</div>
|
|
@@ -309,7 +309,7 @@
|
|
|
309
309
|
</div>
|
|
310
310
|
|
|
311
311
|
<div id="footer">
|
|
312
|
-
Generated on
|
|
312
|
+
Generated on Wed Mar 13 18:57:19 2019 by
|
|
313
313
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
314
314
|
0.9.16 (ruby-2.5.0).
|
|
315
315
|
</div>
|
|
@@ -1245,7 +1245,7 @@
|
|
|
1245
1245
|
</div>
|
|
1246
1246
|
|
|
1247
1247
|
<div id="footer">
|
|
1248
|
-
Generated on
|
|
1248
|
+
Generated on Thu Mar 26 12:41:05 2020 by
|
|
1249
1249
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1250
1250
|
0.9.16 (ruby-2.5.0).
|
|
1251
1251
|
</div>
|
|
@@ -417,7 +417,7 @@
|
|
|
417
417
|
</div>
|
|
418
418
|
|
|
419
419
|
<div id="footer">
|
|
420
|
-
Generated on
|
|
420
|
+
Generated on Wed Mar 13 18:57:21 2019 by
|
|
421
421
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
422
422
|
0.9.16 (ruby-2.5.0).
|
|
423
423
|
</div>
|
|
@@ -471,7 +471,7 @@
|
|
|
471
471
|
</div>
|
|
472
472
|
|
|
473
473
|
<div id="footer">
|
|
474
|
-
Generated on
|
|
474
|
+
Generated on Wed Mar 13 18:57:21 2019 by
|
|
475
475
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
476
476
|
0.9.16 (ruby-2.5.0).
|
|
477
477
|
</div>
|
|
@@ -210,7 +210,7 @@
|
|
|
210
210
|
</div>
|
|
211
211
|
|
|
212
212
|
<div id="footer">
|
|
213
|
-
Generated on
|
|
213
|
+
Generated on Wed Mar 13 18:57:21 2019 by
|
|
214
214
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
215
215
|
0.9.16 (ruby-2.5.0).
|
|
216
216
|
</div>
|
|
@@ -989,7 +989,7 @@
|
|
|
989
989
|
</div>
|
|
990
990
|
|
|
991
991
|
<div id="footer">
|
|
992
|
-
Generated on
|
|
992
|
+
Generated on Wed Mar 13 18:57:21 2019 by
|
|
993
993
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
994
994
|
0.9.16 (ruby-2.5.0).
|
|
995
995
|
</div>
|
|
@@ -557,7 +557,7 @@
|
|
|
557
557
|
</div>
|
|
558
558
|
|
|
559
559
|
<div id="footer">
|
|
560
|
-
Generated on
|
|
560
|
+
Generated on Wed Mar 13 18:57:21 2019 by
|
|
561
561
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
562
562
|
0.9.16 (ruby-2.5.0).
|
|
563
563
|
</div>
|
|
@@ -639,7 +639,7 @@
|
|
|
639
639
|
</div>
|
|
640
640
|
|
|
641
641
|
<div id="footer">
|
|
642
|
-
Generated on
|
|
642
|
+
Generated on Wed Mar 13 18:57:21 2019 by
|
|
643
643
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
644
644
|
0.9.16 (ruby-2.5.0).
|
|
645
645
|
</div>
|
|
@@ -718,7 +718,7 @@
|
|
|
718
718
|
</div>
|
|
719
719
|
|
|
720
720
|
<div id="footer">
|
|
721
|
-
Generated on
|
|
721
|
+
Generated on Wed Mar 13 18:57:21 2019 by
|
|
722
722
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
723
723
|
0.9.16 (ruby-2.5.0).
|
|
724
724
|
</div>
|
data/doc/StrawberryAPI/Edit.html
CHANGED
|
@@ -627,7 +627,7 @@
|
|
|
627
627
|
</div>
|
|
628
628
|
|
|
629
629
|
<div id="footer">
|
|
630
|
-
Generated on
|
|
630
|
+
Generated on Wed Mar 13 18:57:20 2019 by
|
|
631
631
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
632
632
|
0.9.16 (ruby-2.5.0).
|
|
633
633
|
</div>
|
|
@@ -557,7 +557,7 @@
|
|
|
557
557
|
</div>
|
|
558
558
|
|
|
559
559
|
<div id="footer">
|
|
560
|
-
Generated on
|
|
560
|
+
Generated on Wed Mar 13 18:57:20 2019 by
|
|
561
561
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
562
562
|
0.9.16 (ruby-2.5.0).
|
|
563
563
|
</div>
|
|
@@ -631,7 +631,7 @@
|
|
|
631
631
|
</div>
|
|
632
632
|
|
|
633
633
|
<div id="footer">
|
|
634
|
-
Generated on
|
|
634
|
+
Generated on Wed Mar 13 18:57:20 2019 by
|
|
635
635
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
636
636
|
0.9.16 (ruby-2.5.0).
|
|
637
637
|
</div>
|
|
@@ -961,7 +961,7 @@ shamelessly uses the HTTParty gem for all the dirty job</p>
|
|
|
961
961
|
</div>
|
|
962
962
|
|
|
963
963
|
<div id="footer">
|
|
964
|
-
Generated on
|
|
964
|
+
Generated on Wed Mar 13 18:57:21 2019 by
|
|
965
965
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
966
966
|
0.9.16 (ruby-2.5.0).
|
|
967
967
|
</div>
|
|
@@ -627,7 +627,7 @@
|
|
|
627
627
|
</div>
|
|
628
628
|
|
|
629
629
|
<div id="footer">
|
|
630
|
-
Generated on
|
|
630
|
+
Generated on Wed Mar 13 18:57:20 2019 by
|
|
631
631
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
632
632
|
0.9.16 (ruby-2.5.0).
|
|
633
633
|
</div>
|
|
@@ -837,7 +837,7 @@
|
|
|
837
837
|
</div>
|
|
838
838
|
|
|
839
839
|
<div id="footer">
|
|
840
|
-
Generated on
|
|
840
|
+
Generated on Wed Mar 13 18:57:20 2019 by
|
|
841
841
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
842
842
|
0.9.16 (ruby-2.5.0).
|
|
843
843
|
</div>
|
|
@@ -557,7 +557,7 @@
|
|
|
557
557
|
</div>
|
|
558
558
|
|
|
559
559
|
<div id="footer">
|
|
560
|
-
Generated on
|
|
560
|
+
Generated on Wed Mar 13 18:57:21 2019 by
|
|
561
561
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
562
562
|
0.9.16 (ruby-2.5.0).
|
|
563
563
|
</div>
|
|
@@ -2793,7 +2793,7 @@
|
|
|
2793
2793
|
</div>
|
|
2794
2794
|
|
|
2795
2795
|
<div id="footer">
|
|
2796
|
-
Generated on
|
|
2796
|
+
Generated on Wed Mar 13 18:57:20 2019 by
|
|
2797
2797
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2798
2798
|
0.9.16 (ruby-2.5.0).
|
|
2799
2799
|
</div>
|
|
@@ -355,7 +355,7 @@
|
|
|
355
355
|
</div>
|
|
356
356
|
|
|
357
357
|
<div id="footer">
|
|
358
|
-
Generated on
|
|
358
|
+
Generated on Wed Mar 13 18:57:21 2019 by
|
|
359
359
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
360
360
|
0.9.16 (ruby-2.5.0).
|
|
361
361
|
</div>
|
|
@@ -360,7 +360,7 @@
|
|
|
360
360
|
</div>
|
|
361
361
|
|
|
362
362
|
<div id="footer">
|
|
363
|
-
Generated on
|
|
363
|
+
Generated on Wed Mar 13 18:57:21 2019 by
|
|
364
364
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
365
365
|
0.9.16 (ruby-2.5.0).
|
|
366
366
|
</div>
|
|
@@ -1257,7 +1257,7 @@
|
|
|
1257
1257
|
</div>
|
|
1258
1258
|
|
|
1259
1259
|
<div id="footer">
|
|
1260
|
-
Generated on
|
|
1260
|
+
Generated on Wed Mar 13 18:57:20 2019 by
|
|
1261
1261
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1262
1262
|
0.9.16 (ruby-2.5.0).
|
|
1263
1263
|
</div>
|
data/doc/StrawberryAPI/Role.html
CHANGED
|
@@ -557,7 +557,7 @@
|
|
|
557
557
|
</div>
|
|
558
558
|
|
|
559
559
|
<div id="footer">
|
|
560
|
-
Generated on
|
|
560
|
+
Generated on Wed Mar 13 18:57:20 2019 by
|
|
561
561
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
562
562
|
0.9.16 (ruby-2.5.0).
|
|
563
563
|
</div>
|
|
@@ -2377,7 +2377,7 @@
|
|
|
2377
2377
|
</div>
|
|
2378
2378
|
|
|
2379
2379
|
<div id="footer">
|
|
2380
|
-
Generated on
|
|
2380
|
+
Generated on Wed Mar 13 18:57:21 2019 by
|
|
2381
2381
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2382
2382
|
0.9.16 (ruby-2.5.0).
|
|
2383
2383
|
</div>
|
|
@@ -111,7 +111,7 @@
|
|
|
111
111
|
</div>
|
|
112
112
|
|
|
113
113
|
<div id="footer">
|
|
114
|
-
Generated on
|
|
114
|
+
Generated on Wed Mar 13 18:57:20 2019 by
|
|
115
115
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
116
116
|
0.9.16 (ruby-2.5.0).
|
|
117
117
|
</div>
|
|
@@ -197,7 +197,7 @@
|
|
|
197
197
|
</div>
|
|
198
198
|
|
|
199
199
|
<div id="footer">
|
|
200
|
-
Generated on
|
|
200
|
+
Generated on Wed Mar 13 18:57:20 2019 by
|
|
201
201
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
202
202
|
0.9.16 (ruby-2.5.0).
|
|
203
203
|
</div>
|
|
@@ -197,7 +197,7 @@
|
|
|
197
197
|
</div>
|
|
198
198
|
|
|
199
199
|
<div id="footer">
|
|
200
|
-
Generated on
|
|
200
|
+
Generated on Wed Mar 13 18:57:21 2019 by
|
|
201
201
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
202
202
|
0.9.16 (ruby-2.5.0).
|
|
203
203
|
</div>
|
|
@@ -631,7 +631,7 @@
|
|
|
631
631
|
</div>
|
|
632
632
|
|
|
633
633
|
<div id="footer">
|
|
634
|
-
Generated on
|
|
634
|
+
Generated on Wed Mar 13 18:57:21 2019 by
|
|
635
635
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
636
636
|
0.9.16 (ruby-2.5.0).
|
|
637
637
|
</div>
|
data/doc/StrawberryAPI/Team.html
CHANGED
|
@@ -779,7 +779,7 @@
|
|
|
779
779
|
</div>
|
|
780
780
|
|
|
781
781
|
<div id="footer">
|
|
782
|
-
Generated on
|
|
782
|
+
Generated on Wed Mar 13 18:57:20 2019 by
|
|
783
783
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
784
784
|
0.9.16 (ruby-2.5.0).
|
|
785
785
|
</div>
|
|
@@ -697,7 +697,7 @@
|
|
|
697
697
|
</div>
|
|
698
698
|
|
|
699
699
|
<div id="footer">
|
|
700
|
-
Generated on
|
|
700
|
+
Generated on Wed Mar 13 18:57:21 2019 by
|
|
701
701
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
702
702
|
0.9.16 (ruby-2.5.0).
|
|
703
703
|
</div>
|
data/doc/StrawberryAPI/User.html
CHANGED
|
@@ -989,7 +989,7 @@
|
|
|
989
989
|
</div>
|
|
990
990
|
|
|
991
991
|
<div id="footer">
|
|
992
|
-
Generated on
|
|
992
|
+
Generated on Wed Mar 13 18:57:20 2019 by
|
|
993
993
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
994
994
|
0.9.16 (ruby-2.5.0).
|
|
995
995
|
</div>
|
data/doc/_index.html
CHANGED
|
@@ -629,7 +629,7 @@
|
|
|
629
629
|
</div>
|
|
630
630
|
|
|
631
631
|
<div id="footer">
|
|
632
|
-
Generated on
|
|
632
|
+
Generated on Thu Mar 26 12:41:04 2020 by
|
|
633
633
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
634
634
|
0.9.16 (ruby-2.5.0).
|
|
635
635
|
</div>
|
data/doc/file.README.html
CHANGED
|
@@ -57,21 +57,19 @@
|
|
|
57
57
|
<div class="clear"></div>
|
|
58
58
|
</div>
|
|
59
59
|
|
|
60
|
-
<div id="content"><div id='filecontents'>
|
|
61
|
-
<h1 id="label-Strawberry">Strawberry</h1>
|
|
60
|
+
<div id="content"><div id='filecontents'><h1 id="strawberry">Strawberry</h1>
|
|
62
61
|
|
|
63
|
-
<p>A simple Ruby gem acting as a client for <a
|
|
64
|
-
href="http://www.flavoursys.com">Flavoursys Strawberry</a> REST API.</p>
|
|
62
|
+
<p>A simple Ruby gem acting as a client for <a href="http://www.flavoursys.com">Flavoursys Strawberry</a> REST API.</p>
|
|
65
63
|
|
|
66
|
-
<p>This unofficial implementation covers most of the features offered by
|
|
67
|
-
Strawberry API.</p>
|
|
64
|
+
<p>This unofficial implementation covers most of the features offered by Strawberry API.</p>
|
|
68
65
|
|
|
69
|
-
<h2 id="
|
|
66
|
+
<h2 id="installation">Installation</h2>
|
|
70
67
|
|
|
71
|
-
<p>Add this line to your application
|
|
68
|
+
<p>Add this line to your application’s Gemfile:</p>
|
|
72
69
|
|
|
73
|
-
<
|
|
74
|
-
|
|
70
|
+
<p><code>ruby
|
|
71
|
+
gem 'strawberry_api'
|
|
72
|
+
</code></p>
|
|
75
73
|
|
|
76
74
|
<p>And then execute:</p>
|
|
77
75
|
|
|
@@ -83,136 +81,122 @@ Strawberry API.</p>
|
|
|
83
81
|
<pre class="code ruby"><code class="ruby">$ gem install strawberry_api
|
|
84
82
|
</code></pre>
|
|
85
83
|
|
|
86
|
-
<h2 id="
|
|
87
|
-
|
|
88
|
-
<h3 id="label-Authentication">Authentication</h3>
|
|
89
|
-
|
|
90
|
-
<p>Authenticate to the server via regular credentials or by using an API key.
|
|
91
|
-
A standard error will be raised if authentication fails.</p>
|
|
84
|
+
<h2 id="usage">Usage</h2>
|
|
92
85
|
|
|
93
|
-
<
|
|
86
|
+
<h3 id="authentication">Authentication</h3>
|
|
94
87
|
|
|
95
|
-
<
|
|
88
|
+
<p>Authenticate to the server via regular credentials or by using an API key. A standard error will be raised if authentication fails.</p>
|
|
96
89
|
|
|
97
|
-
<
|
|
98
|
-
<span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>server_IP_or_hostname</span><span class='tstring_end'>'</span></span>
|
|
99
|
-
<span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_api_key'>api_key</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>api_key</span><span class='tstring_end'>'</span></span>
|
|
100
|
-
<span class='kw'>end</span>
|
|
90
|
+
<h4 id="api-key-based-authentication">API key based authentication</h4>
|
|
101
91
|
|
|
102
|
-
<
|
|
92
|
+
<p>```ruby
|
|
93
|
+
require ‘strawberry_api’</p>
|
|
103
94
|
|
|
104
|
-
<
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
</
|
|
95
|
+
<p>StrawberryAPI.configure do |c|
|
|
96
|
+
c.host = ‘server_IP_or_hostname’
|
|
97
|
+
c.api_key = ‘api_key’
|
|
98
|
+
end</p>
|
|
108
99
|
|
|
109
|
-
<
|
|
100
|
+
<p>strawberry = StrawberryAPI::Client.new</p>
|
|
110
101
|
|
|
111
|
-
<
|
|
102
|
+
<h1 id="returns-currently-logged-in-user-info">Returns currently logged in user info</h1>
|
|
103
|
+
<p>strawberry.user
|
|
104
|
+
# => “#<Strawberry::API::User: id=2, username=”api”, …
|
|
105
|
+
<code>
|
|
106
|
+
#### User credentials based authentication
|
|
107
|
+
</code>ruby
|
|
108
|
+
require ‘strawberry_api’</p>
|
|
112
109
|
|
|
113
|
-
<
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
110
|
+
<p>StrawberryAPI.configure do |c|
|
|
111
|
+
c.host = ‘server_IP_or_hostname’
|
|
112
|
+
c.username = ‘username’
|
|
113
|
+
c.password = ‘password’
|
|
114
|
+
end</p>
|
|
118
115
|
|
|
119
|
-
<
|
|
116
|
+
<p>strawberry = StrawberryAPI::Client.new</p>
|
|
120
117
|
|
|
121
|
-
<
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
118
|
+
<h1 id="returns-currently-logged-in-user-info-1">Returns currently logged in user info</h1>
|
|
119
|
+
<p>strawberry.user
|
|
120
|
+
# => “#<Strawberry::API::User: id=2, username=”api”, …
|
|
121
|
+
```</p>
|
|
125
122
|
|
|
126
|
-
<h3 id="
|
|
123
|
+
<h3 id="making-requests">Making requests</h3>
|
|
127
124
|
|
|
128
|
-
<h4 id="
|
|
125
|
+
<h4 id="strawberry-api-client">Strawberry API client</h4>
|
|
129
126
|
|
|
130
|
-
<p><a href="doc/Strawberry/Client.html">API methods</a> are available as
|
|
131
|
-
client instance methods.</p>
|
|
127
|
+
<p><a href="doc/Strawberry/Client.html">API methods</a> are available as client instance methods.</p>
|
|
132
128
|
|
|
133
|
-
<
|
|
129
|
+
<p>```ruby
|
|
130
|
+
strawberry = Strawberry::Client.new</p>
|
|
134
131
|
|
|
135
|
-
<
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
132
|
+
<h1 id="returns-all-strawberry-projects">Returns all Strawberry projects</h1>
|
|
133
|
+
<p>strawberry.projects
|
|
134
|
+
# => [#<Strawberry::API::Project: id=6, name=”test_project”, …
|
|
135
|
+
```</p>
|
|
139
136
|
|
|
140
|
-
<h3 id="
|
|
137
|
+
<h3 id="samples">Samples</h3>
|
|
141
138
|
|
|
142
|
-
<p>Most API methods return an object which provide dot notation access for
|
|
143
|
-
fields returned in the API response.</p>
|
|
139
|
+
<p>Most API methods return an object which provide dot notation access for fields returned in the API response.</p>
|
|
144
140
|
|
|
145
141
|
<p>See the <a href="samples">samples</a> directory for more examples.</p>
|
|
146
142
|
|
|
147
|
-
<h4 id="
|
|
143
|
+
<h4 id="methods-returning-an-object">Methods returning an object</h4>
|
|
148
144
|
|
|
149
|
-
<
|
|
150
|
-
|
|
151
|
-
|
|
145
|
+
<p><code>ruby
|
|
146
|
+
strawberry.project(id: 6)
|
|
147
|
+
# => #<Strawberry::API::Project: id=6, name="test_project", ...
|
|
148
|
+
</code></p>
|
|
152
149
|
|
|
153
|
-
<h4 id="
|
|
150
|
+
<h4 id="methods-returning-an-array-of-project-objects">Methods returning an array of project objects</h4>
|
|
154
151
|
|
|
155
152
|
<p>Some methods return an array of objects .</p>
|
|
156
153
|
|
|
157
|
-
<
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
<
|
|
162
|
-
|
|
163
|
-
<
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
<
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
154
|
+
<p>```ruby
|
|
155
|
+
strawberry.projects
|
|
156
|
+
# => [#<Strawberry::API::Project: id=6, name=”test_project”, …</p>
|
|
157
|
+
|
|
158
|
+
<p>```</p>
|
|
159
|
+
|
|
160
|
+
<h4 id="methods-returning-a-boolean">Methods returning a Boolean</h4>
|
|
161
|
+
|
|
162
|
+
<p>A few other methods return a Boolean.
|
|
163
|
+
The following example uses the <code>video?</code> method which indicates whether the asset is a video or not.</p>
|
|
164
|
+
|
|
165
|
+
<p>```ruby
|
|
166
|
+
assets = strawberry.assets
|
|
167
|
+
# => [#<Strawberry::API::Asset: id=6, name=”test_asset”, …</p>
|
|
168
|
+
|
|
169
|
+
<p>assets.each do |asset|
|
|
170
|
+
# Returns true of false
|
|
171
|
+
if asset.video?
|
|
172
|
+
puts “Asset #assetasset.name is a video”
|
|
173
|
+
else
|
|
174
|
+
puts “Asset #assetasset.name is not a video”
|
|
175
|
+
end
|
|
176
|
+
end
|
|
177
|
+
```</p>
|
|
179
178
|
|
|
180
|
-
<h2 id="
|
|
179
|
+
<h2 id="development">Development</h2>
|
|
181
180
|
|
|
182
|
-
<p>After checking out the repo, run <code>bin/setup</code> to install
|
|
183
|
-
dependencies. You can also run <code>bin/console</code> for an interactive
|
|
184
|
-
prompt that will allow you to experiment.</p>
|
|
181
|
+
<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. You can also run <code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
|
|
185
182
|
|
|
186
|
-
<p>To install this gem onto your local machine, run <code>bundle exec rake
|
|
187
|
-
install</code>. To release a new version, update the version number in
|
|
188
|
-
<code>version.rb</code>, and then run <code>bundle exec rake
|
|
189
|
-
release</code>, which will create a git tag for the version, push git
|
|
190
|
-
commits and tags, and push the <code>.gem</code> file to <a
|
|
191
|
-
href="https://rubygems.org">rubygems.org</a>.</p>
|
|
183
|
+
<p>To install this gem onto your local machine, run <code>bundle exec rake install</code>. To release a new version, update the version number in <code>version.rb</code>, and then run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and tags, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</p>
|
|
192
184
|
|
|
193
|
-
<h2 id="
|
|
185
|
+
<h2 id="contributing">Contributing</h2>
|
|
194
186
|
|
|
195
|
-
<p>Bug reports and pull requests are welcome on GitHub at <a
|
|
196
|
-
href="https://github.com/[USERNAME]/strawberry">github.com/[USERNAME]/strawberry</a>.
|
|
197
|
-
This project is intended to be a safe, welcoming space for collaboration,
|
|
198
|
-
and contributors are expected to adhere to the <a
|
|
199
|
-
href="http://contributor-covenant.org">Contributor Covenant</a> code of
|
|
200
|
-
conduct.</p>
|
|
187
|
+
<p>Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/strawberry. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the <a href="http://contributor-covenant.org">Contributor Covenant</a> code of conduct.</p>
|
|
201
188
|
|
|
202
|
-
<h2 id="
|
|
189
|
+
<h2 id="license">License</h2>
|
|
203
190
|
|
|
204
|
-
<p>The gem is available as open source under the terms of the <a
|
|
205
|
-
href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
|
|
191
|
+
<p>The gem is available as open source under the terms of the <a href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
|
|
206
192
|
|
|
207
|
-
<h2 id="
|
|
193
|
+
<h2 id="code-of-conduct">Code of Conduct</h2>
|
|
208
194
|
|
|
209
|
-
<p>Everyone interacting in the Strawberry project’s codebases, issue trackers,
|
|
210
|
-
chat rooms and mailing lists is expected to follow the of
|
|
211
|
-
conduct[https://github.com/[USERNAME]/strawberry/blob/master/CODE_OF_CONDUCT.md].</p>
|
|
195
|
+
<p>Everyone interacting in the Strawberry project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the <a href="https://github.com/[USERNAME]/strawberry/blob/master/CODE_OF_CONDUCT.md">code of conduct</a>.</p>
|
|
212
196
|
</div></div>
|
|
213
197
|
|
|
214
198
|
<div id="footer">
|
|
215
|
-
Generated on
|
|
199
|
+
Generated on Thu Mar 26 12:41:04 2020 by
|
|
216
200
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
217
201
|
0.9.16 (ruby-2.5.0).
|
|
218
202
|
</div>
|