strawberry_api 0.1.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.
Files changed (157) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +9 -0
  3. data/.rubocop.yml +4 -0
  4. data/CODE_OF_CONDUCT.md +74 -0
  5. data/Gemfile +3 -0
  6. data/LICENSE.txt +21 -0
  7. data/README.md +135 -0
  8. data/Rakefile +2 -0
  9. data/bin/console +14 -0
  10. data/bin/setup +8 -0
  11. data/doc/HTTParty/Response.html +148 -0
  12. data/doc/StrawberryAPI/AccessRight.html +431 -0
  13. data/doc/StrawberryAPI/ApiKey.html +637 -0
  14. data/doc/StrawberryAPI/ArchiveStrategy.html +365 -0
  15. data/doc/StrawberryAPI/ArchiveStrategyState.html +1057 -0
  16. data/doc/StrawberryAPI/Asset.html +1791 -0
  17. data/doc/StrawberryAPI/AssetCopyToStrategy.html +145 -0
  18. data/doc/StrawberryAPI/AssetFeedback.html +370 -0
  19. data/doc/StrawberryAPI/Client/ApiKeys.html +904 -0
  20. data/doc/StrawberryAPI/Client/ArchiveStrategies.html +784 -0
  21. data/doc/StrawberryAPI/Client/AssetCopyToStrategies.html +805 -0
  22. data/doc/StrawberryAPI/Client/AssetFeedbacks.html +232 -0
  23. data/doc/StrawberryAPI/Client/Assets.html +888 -0
  24. data/doc/StrawberryAPI/Client/Collections.html +319 -0
  25. data/doc/StrawberryAPI/Client/CopyToFeedbacks.html +232 -0
  26. data/doc/StrawberryAPI/Client/CustomMetadata.html +210 -0
  27. data/doc/StrawberryAPI/Client/CustomMetadataFields.html +214 -0
  28. data/doc/StrawberryAPI/Client/CustomMetadataOptions.html +214 -0
  29. data/doc/StrawberryAPI/Client/CustomMetadataSets.html +214 -0
  30. data/doc/StrawberryAPI/Client/Edits.html +485 -0
  31. data/doc/StrawberryAPI/Client/Features.html +319 -0
  32. data/doc/StrawberryAPI/Client/Libraries.html +321 -0
  33. data/doc/StrawberryAPI/Client/Markers.html +234 -0
  34. data/doc/StrawberryAPI/Client/ProjectCopyToStrategies.html +857 -0
  35. data/doc/StrawberryAPI/Client/ProjectFeedbacks.html +232 -0
  36. data/doc/StrawberryAPI/Client/Projects.html +2764 -0
  37. data/doc/StrawberryAPI/Client/Roles.html +214 -0
  38. data/doc/StrawberryAPI/Client/Schedules.html +319 -0
  39. data/doc/StrawberryAPI/Client/Searches.html +293 -0
  40. data/doc/StrawberryAPI/Client/Sessions.html +376 -0
  41. data/doc/StrawberryAPI/Client/Settings.html +210 -0
  42. data/doc/StrawberryAPI/Client/StatusFlags.html +315 -0
  43. data/doc/StrawberryAPI/Client/Teams.html +1067 -0
  44. data/doc/StrawberryAPI/Client/Templates.html +319 -0
  45. data/doc/StrawberryAPI/Client/Users.html +1255 -0
  46. data/doc/StrawberryAPI/Client.html +487 -0
  47. data/doc/StrawberryAPI/Collection.html +427 -0
  48. data/doc/StrawberryAPI/Configuration.html +481 -0
  49. data/doc/StrawberryAPI/CopyToFeedback.html +220 -0
  50. data/doc/StrawberryAPI/CustomMetadataField.html +999 -0
  51. data/doc/StrawberryAPI/CustomMetadataOption.html +567 -0
  52. data/doc/StrawberryAPI/CustomMetadataSet.html +649 -0
  53. data/doc/StrawberryAPI/CustomMetadatum.html +718 -0
  54. data/doc/StrawberryAPI/Edit.html +637 -0
  55. data/doc/StrawberryAPI/Feature.html +567 -0
  56. data/doc/StrawberryAPI/Feedback.html +641 -0
  57. data/doc/StrawberryAPI/HttpClient.html +971 -0
  58. data/doc/StrawberryAPI/Library.html +637 -0
  59. data/doc/StrawberryAPI/Marker.html +847 -0
  60. data/doc/StrawberryAPI/Project.html +2395 -0
  61. data/doc/StrawberryAPI/ProjectCopyToStrategy.html +365 -0
  62. data/doc/StrawberryAPI/ProjectFeedback.html +370 -0
  63. data/doc/StrawberryAPI/Proxy.html +1267 -0
  64. data/doc/StrawberryAPI/Role.html +567 -0
  65. data/doc/StrawberryAPI/Schedule.html +2387 -0
  66. data/doc/StrawberryAPI/Session.html +121 -0
  67. data/doc/StrawberryAPI/Setting.html +207 -0
  68. data/doc/StrawberryAPI/StatusFlag.html +207 -0
  69. data/doc/StrawberryAPI/Strategy.html +641 -0
  70. data/doc/StrawberryAPI/Team.html +789 -0
  71. data/doc/StrawberryAPI/Template.html +707 -0
  72. data/doc/StrawberryAPI/User.html +999 -0
  73. data/doc/StrawberryAPI.html +483 -0
  74. data/doc/_index.html +632 -0
  75. data/doc/class_list.html +51 -0
  76. data/doc/css/common.css +1 -0
  77. data/doc/css/full_list.css +58 -0
  78. data/doc/css/style.css +496 -0
  79. data/doc/file.README.html +222 -0
  80. data/doc/file_list.html +56 -0
  81. data/doc/frames.html +17 -0
  82. data/doc/index.html +222 -0
  83. data/doc/js/app.js +292 -0
  84. data/doc/js/full_list.js +216 -0
  85. data/doc/js/jquery.js +4 -0
  86. data/doc/method_list.html +3059 -0
  87. data/doc/top-level-namespace.html +110 -0
  88. data/lib/strawberry_api/access_right.rb +18 -0
  89. data/lib/strawberry_api/api_key.rb +19 -0
  90. data/lib/strawberry_api/asset.rb +51 -0
  91. data/lib/strawberry_api/client/api_keys.rb +49 -0
  92. data/lib/strawberry_api/client/archive_strategies.rb +87 -0
  93. data/lib/strawberry_api/client/asset_copy_to_strategies.rb +83 -0
  94. data/lib/strawberry_api/client/asset_feedbacks.rb +18 -0
  95. data/lib/strawberry_api/client/assets.rb +92 -0
  96. data/lib/strawberry_api/client/collections.rb +29 -0
  97. data/lib/strawberry_api/client/copy_to_feedbacks.rb +18 -0
  98. data/lib/strawberry_api/client/custom_metadata.rb +16 -0
  99. data/lib/strawberry_api/client/custom_metadata_fields.rb +18 -0
  100. data/lib/strawberry_api/client/custom_metadata_options.rb +18 -0
  101. data/lib/strawberry_api/client/custom_metadata_sets.rb +18 -0
  102. data/lib/strawberry_api/client/edits.rb +47 -0
  103. data/lib/strawberry_api/client/features.rb +29 -0
  104. data/lib/strawberry_api/client/libraries.rb +30 -0
  105. data/lib/strawberry_api/client/markers.rb +19 -0
  106. data/lib/strawberry_api/client/project_copy_to_strategies.rb +88 -0
  107. data/lib/strawberry_api/client/project_feedbacks.rb +18 -0
  108. data/lib/strawberry_api/client/projects.rb +305 -0
  109. data/lib/strawberry_api/client/roles.rb +18 -0
  110. data/lib/strawberry_api/client/schedules.rb +29 -0
  111. data/lib/strawberry_api/client/searches.rb +25 -0
  112. data/lib/strawberry_api/client/sessions.rb +33 -0
  113. data/lib/strawberry_api/client/settings.rb +16 -0
  114. data/lib/strawberry_api/client/status_flags.rb +27 -0
  115. data/lib/strawberry_api/client/teams.rb +107 -0
  116. data/lib/strawberry_api/client/templates.rb +29 -0
  117. data/lib/strawberry_api/client/users.rb +125 -0
  118. data/lib/strawberry_api/client.rb +95 -0
  119. data/lib/strawberry_api/collection.rb +16 -0
  120. data/lib/strawberry_api/configuration.rb +19 -0
  121. data/lib/strawberry_api/custom_metadata/custom_metadata_field.rb +30 -0
  122. data/lib/strawberry_api/custom_metadata/custom_metadata_option.rb +18 -0
  123. data/lib/strawberry_api/custom_metadata/custom_metadata_set.rb +25 -0
  124. data/lib/strawberry_api/custom_metadatum.rb +30 -0
  125. data/lib/strawberry_api/edit.rb +19 -0
  126. data/lib/strawberry_api/feature.rb +18 -0
  127. data/lib/strawberry_api/feedback/asset_feedback.rb +15 -0
  128. data/lib/strawberry_api/feedback/copy_to_feedback.rb +12 -0
  129. data/lib/strawberry_api/feedback/project_feedback.rb +15 -0
  130. data/lib/strawberry_api/feedback.rb +19 -0
  131. data/lib/strawberry_api/http_client.rb +135 -0
  132. data/lib/strawberry_api/library.rb +19 -0
  133. data/lib/strawberry_api/marker.rb +22 -0
  134. data/lib/strawberry_api/project.rb +48 -0
  135. data/lib/strawberry_api/proxy.rb +28 -0
  136. data/lib/strawberry_api/role.rb +18 -0
  137. data/lib/strawberry_api/schedule.rb +44 -0
  138. data/lib/strawberry_api/session.rb +7 -0
  139. data/lib/strawberry_api/setting.rb +12 -0
  140. data/lib/strawberry_api/status_flag.rb +12 -0
  141. data/lib/strawberry_api/strategy/archive_strategy.rb +10 -0
  142. data/lib/strawberry_api/strategy/archive_strategy_state.rb +25 -0
  143. data/lib/strawberry_api/strategy/asset_copy_to_strategy.rb +6 -0
  144. data/lib/strawberry_api/strategy/project_copy_to_strategy.rb +9 -0
  145. data/lib/strawberry_api/strategy.rb +19 -0
  146. data/lib/strawberry_api/team.rb +27 -0
  147. data/lib/strawberry_api/template.rb +20 -0
  148. data/lib/strawberry_api/user.rb +30 -0
  149. data/lib/strawberry_api/version.rb +3 -0
  150. data/lib/strawberry_api.rb +36 -0
  151. data/samples/README.md +14 -0
  152. data/samples/list_assets_links.rb +15 -0
  153. data/samples/list_projects.rb +14 -0
  154. data/samples/login.rb +18 -0
  155. data/samples/test.rb +12 -0
  156. data/strawberry_api.gemspec +40 -0
  157. metadata +242 -0
data/doc/StrawberryAPI.html ADDED
@@ -0,0 +1,483 @@
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: StrawberryAPI
8
+
9
+ &mdash; Documentation by YARD 0.9.16
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
+ pathId = "StrawberryAPI";
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 (S)</a> &raquo;
40
+
41
+
42
+ <span class="title">StrawberryAPI</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: StrawberryAPI
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+ <dl>
80
+ <dt>Defined in:</dt>
81
+ <dd>lib/strawberry_api.rb<span class="defines">,<br />
82
+ lib/strawberry_api/edit.rb,<br /> lib/strawberry_api/role.rb,<br /> lib/strawberry_api/team.rb,<br /> lib/strawberry_api/user.rb,<br /> lib/strawberry_api/asset.rb,<br /> lib/strawberry_api/proxy.rb,<br /> lib/strawberry_api/client.rb,<br /> lib/strawberry_api/marker.rb,<br /> lib/strawberry_api/api_key.rb,<br /> lib/strawberry_api/feature.rb,<br /> lib/strawberry_api/library.rb,<br /> lib/strawberry_api/project.rb,<br /> lib/strawberry_api/session.rb,<br /> lib/strawberry_api/setting.rb,<br /> lib/strawberry_api/version.rb,<br /> lib/strawberry_api/feedback.rb,<br /> lib/strawberry_api/schedule.rb,<br /> lib/strawberry_api/strategy.rb,<br /> lib/strawberry_api/template.rb,<br /> lib/strawberry_api/collection.rb,<br /> lib/strawberry_api/http_client.rb,<br /> lib/strawberry_api/status_flag.rb,<br /> lib/strawberry_api/access_right.rb,<br /> lib/strawberry_api/client/edits.rb,<br /> lib/strawberry_api/client/roles.rb,<br /> lib/strawberry_api/client/teams.rb,<br /> lib/strawberry_api/client/users.rb,<br /> lib/strawberry_api/client/assets.rb,<br /> lib/strawberry_api/configuration.rb,<br /> lib/strawberry_api/client/markers.rb,<br /> lib/strawberry_api/client/api_keys.rb,<br /> lib/strawberry_api/client/features.rb,<br /> lib/strawberry_api/client/projects.rb,<br /> lib/strawberry_api/client/searches.rb,<br /> lib/strawberry_api/client/sessions.rb,<br /> lib/strawberry_api/client/settings.rb,<br /> lib/strawberry_api/client/libraries.rb,<br /> lib/strawberry_api/client/schedules.rb,<br /> lib/strawberry_api/client/templates.rb,<br /> lib/strawberry_api/custom_metadatum.rb,<br /> lib/strawberry_api/client/collections.rb,<br /> lib/strawberry_api/client/status_flags.rb,<br /> lib/strawberry_api/client/asset_feedbacks.rb,<br /> lib/strawberry_api/client/custom_metadata.rb,<br /> lib/strawberry_api/feedback/asset_feedback.rb,<br /> lib/strawberry_api/client/copy_to_feedbacks.rb,<br /> lib/strawberry_api/client/project_feedbacks.rb,<br /> lib/strawberry_api/client/archive_strategies.rb,<br /> lib/strawberry_api/feedback/copy_to_feedback.rb,<br /> lib/strawberry_api/feedback/project_feedback.rb,<br /> lib/strawberry_api/strategy/archive_strategy.rb,<br /> lib/strawberry_api/client/custom_metadata_sets.rb,<br /> lib/strawberry_api/client/custom_metadata_fields.rb,<br /> lib/strawberry_api/client/custom_metadata_options.rb,<br /> lib/strawberry_api/client/asset_copy_to_strategies.rb,<br /> lib/strawberry_api/strategy/archive_strategy_state.rb,<br /> lib/strawberry_api/strategy/asset_copy_to_strategy.rb,<br /> lib/strawberry_api/client/project_copy_to_strategies.rb,<br /> lib/strawberry_api/strategy/project_copy_to_strategy.rb,<br /> lib/strawberry_api/custom_metadata/custom_metadata_set.rb,<br /> lib/strawberry_api/custom_metadata/custom_metadata_field.rb,<br /> lib/strawberry_api/custom_metadata/custom_metadata_option.rb</span>
83
+ </dd>
84
+ </dl>
85
+
86
+ </div>
87
+
88
+ <h2>Overview</h2><div class="docstring">
89
+ <div class="discussion">
90
+
91
+ <p>module StrawberryAPI provides access to Strawberry REST API</p>
92
+
93
+
94
+ </div>
95
+ </div>
96
+ <div class="tags">
97
+
98
+ <p class="tag_title">Author:</p>
99
+ <ul class="author">
100
+
101
+ <li>
102
+
103
+
104
+
105
+
106
+
107
+ <div class='inline'>
108
+ <p>Pierre Lebrun &lt;pierreyves.lebrun@gmail.com&gt;</p>
109
+ </div>
110
+
111
+ </li>
112
+
113
+ </ul>
114
+
115
+ </div><h2>Defined Under Namespace</h2>
116
+ <p class="children">
117
+
118
+
119
+
120
+
121
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="StrawberryAPI/AccessRight.html" title="StrawberryAPI::AccessRight (class)">AccessRight</a></span>, <span class='object_link'><a href="StrawberryAPI/ApiKey.html" title="StrawberryAPI::ApiKey (class)">ApiKey</a></span>, <span class='object_link'><a href="StrawberryAPI/ArchiveStrategy.html" title="StrawberryAPI::ArchiveStrategy (class)">ArchiveStrategy</a></span>, <span class='object_link'><a href="StrawberryAPI/ArchiveStrategyState.html" title="StrawberryAPI::ArchiveStrategyState (class)">ArchiveStrategyState</a></span>, <span class='object_link'><a href="StrawberryAPI/Asset.html" title="StrawberryAPI::Asset (class)">Asset</a></span>, <span class='object_link'><a href="StrawberryAPI/AssetCopyToStrategy.html" title="StrawberryAPI::AssetCopyToStrategy (class)">AssetCopyToStrategy</a></span>, <span class='object_link'><a href="StrawberryAPI/AssetFeedback.html" title="StrawberryAPI::AssetFeedback (class)">AssetFeedback</a></span>, <span class='object_link'><a href="StrawberryAPI/Client.html" title="StrawberryAPI::Client (class)">Client</a></span>, <span class='object_link'><a href="StrawberryAPI/Collection.html" title="StrawberryAPI::Collection (class)">Collection</a></span>, <span class='object_link'><a href="StrawberryAPI/Configuration.html" title="StrawberryAPI::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="StrawberryAPI/CopyToFeedback.html" title="StrawberryAPI::CopyToFeedback (class)">CopyToFeedback</a></span>, <span class='object_link'><a href="StrawberryAPI/CustomMetadataField.html" title="StrawberryAPI::CustomMetadataField (class)">CustomMetadataField</a></span>, <span class='object_link'><a href="StrawberryAPI/CustomMetadataOption.html" title="StrawberryAPI::CustomMetadataOption (class)">CustomMetadataOption</a></span>, <span class='object_link'><a href="StrawberryAPI/CustomMetadataSet.html" title="StrawberryAPI::CustomMetadataSet (class)">CustomMetadataSet</a></span>, <span class='object_link'><a href="StrawberryAPI/CustomMetadatum.html" title="StrawberryAPI::CustomMetadatum (class)">CustomMetadatum</a></span>, <span class='object_link'><a href="StrawberryAPI/Edit.html" title="StrawberryAPI::Edit (class)">Edit</a></span>, <span class='object_link'><a href="StrawberryAPI/Feature.html" title="StrawberryAPI::Feature (class)">Feature</a></span>, <span class='object_link'><a href="StrawberryAPI/Feedback.html" title="StrawberryAPI::Feedback (class)">Feedback</a></span>, <span class='object_link'><a href="StrawberryAPI/HttpClient.html" title="StrawberryAPI::HttpClient (class)">HttpClient</a></span>, <span class='object_link'><a href="StrawberryAPI/Library.html" title="StrawberryAPI::Library (class)">Library</a></span>, <span class='object_link'><a href="StrawberryAPI/Marker.html" title="StrawberryAPI::Marker (class)">Marker</a></span>, <span class='object_link'><a href="StrawberryAPI/Project.html" title="StrawberryAPI::Project (class)">Project</a></span>, <span class='object_link'><a href="StrawberryAPI/ProjectCopyToStrategy.html" title="StrawberryAPI::ProjectCopyToStrategy (class)">ProjectCopyToStrategy</a></span>, <span class='object_link'><a href="StrawberryAPI/ProjectFeedback.html" title="StrawberryAPI::ProjectFeedback (class)">ProjectFeedback</a></span>, <span class='object_link'><a href="StrawberryAPI/Proxy.html" title="StrawberryAPI::Proxy (class)">Proxy</a></span>, <span class='object_link'><a href="StrawberryAPI/Role.html" title="StrawberryAPI::Role (class)">Role</a></span>, <span class='object_link'><a href="StrawberryAPI/Schedule.html" title="StrawberryAPI::Schedule (class)">Schedule</a></span>, <span class='object_link'><a href="StrawberryAPI/Session.html" title="StrawberryAPI::Session (class)">Session</a></span>, <span class='object_link'><a href="StrawberryAPI/Setting.html" title="StrawberryAPI::Setting (class)">Setting</a></span>, <span class='object_link'><a href="StrawberryAPI/StatusFlag.html" title="StrawberryAPI::StatusFlag (class)">StatusFlag</a></span>, <span class='object_link'><a href="StrawberryAPI/Strategy.html" title="StrawberryAPI::Strategy (class)">Strategy</a></span>, <span class='object_link'><a href="StrawberryAPI/Team.html" title="StrawberryAPI::Team (class)">Team</a></span>, <span class='object_link'><a href="StrawberryAPI/Template.html" title="StrawberryAPI::Template (class)">Template</a></span>, <span class='object_link'><a href="StrawberryAPI/User.html" title="StrawberryAPI::User (class)">User</a></span>
122
+
123
+
124
+ </p>
125
+
126
+
127
+ <h2>
128
+ Constant Summary
129
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
130
+ </h2>
131
+
132
+ <dl class="constants">
133
+
134
+ <dt id="VERSION-constant" class="">VERSION =
135
+
136
+ </dt>
137
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
138
+
139
+ </dl>
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+ <h2>
150
+ Class Method Summary
151
+ <small><a href="#" class="summary_toggle">collapse</a></small>
152
+ </h2>
153
+
154
+ <ul class="summary">
155
+
156
+ <li class="public ">
157
+ <span class="summary_signature">
158
+
159
+ <a href="#config-class_method" title="config (class method)">.<strong>config</strong> &#x21d2; StrawberryAPI::Configuration </a>
160
+
161
+
162
+
163
+ </span>
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+ <span class="summary_desc"><div class='inline'>
174
+ <p>Return configuration If it has not been configured yet, initialize
175
+ configuration.</p>
176
+ </div></span>
177
+
178
+ </li>
179
+
180
+
181
+ <li class="public ">
182
+ <span class="summary_signature">
183
+
184
+ <a href="#config=-class_method" title="config= (class method)">.<strong>config=</strong>(config) &#x21d2; StrawberryAPI::Configuration </a>
185
+
186
+
187
+
188
+ </span>
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+ <span class="summary_desc"><div class='inline'>
199
+ <p>Set configuration.</p>
200
+ </div></span>
201
+
202
+ </li>
203
+
204
+
205
+ <li class="public ">
206
+ <span class="summary_signature">
207
+
208
+ <a href="#configure-class_method" title="configure (class method)">.<strong>configure</strong> {|config| ... } &#x21d2; Object </a>
209
+
210
+
211
+
212
+ </span>
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+ <span class="summary_desc"><div class='inline'>
223
+ <p>Configure some settings.</p>
224
+ </div></span>
225
+
226
+ </li>
227
+
228
+
229
+ </ul>
230
+
231
+
232
+
233
+
234
+ <div id="class_method_details" class="method_details_list">
235
+ <h2>Class Method Details</h2>
236
+
237
+
238
+ <div class="method_details first">
239
+ <h3 class="signature first" id="config-class_method">
240
+
241
+ .<strong>config</strong> &#x21d2; <tt><span class='object_link'><a href="StrawberryAPI/Configuration.html" title="StrawberryAPI::Configuration (class)">StrawberryAPI::Configuration</a></span></tt>
242
+
243
+
244
+
245
+
246
+
247
+ </h3><div class="docstring">
248
+ <div class="discussion">
249
+
250
+ <p>Return configuration If it has not been configured yet, initialize
251
+ configuration</p>
252
+
253
+
254
+ </div>
255
+ </div>
256
+ <div class="tags">
257
+
258
+ <p class="tag_title">Returns:</p>
259
+ <ul class="return">
260
+
261
+ <li>
262
+
263
+
264
+ <span class='type'>(<tt><span class='object_link'><a href="StrawberryAPI/Configuration.html" title="StrawberryAPI::Configuration (class)">StrawberryAPI::Configuration</a></span></tt>)</span>
265
+
266
+
267
+
268
+ &mdash;
269
+ <div class='inline'>
270
+ <p>configuration object</p>
271
+ </div>
272
+
273
+ </li>
274
+
275
+ </ul>
276
+
277
+ </div><table class="source_code">
278
+ <tr>
279
+ <td>
280
+ <pre class="lines">
281
+
282
+
283
+ 15
284
+ 16
285
+ 17</pre>
286
+ </td>
287
+ <td>
288
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api.rb', line 15</span>
289
+
290
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span>
291
+ <span class='ivar'>@config</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="" title="StrawberryAPI (module)">StrawberryAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="StrawberryAPI/Configuration.html" title="StrawberryAPI::Configuration (class)">Configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
292
+ <span class='kw'>end</span></pre>
293
+ </td>
294
+ </tr>
295
+ </table>
296
+ </div>
297
+
298
+ <div class="method_details ">
299
+ <h3 class="signature " id="config=-class_method">
300
+
301
+ .<strong>config=</strong>(config) &#x21d2; <tt><span class='object_link'><a href="StrawberryAPI/Configuration.html" title="StrawberryAPI::Configuration (class)">StrawberryAPI::Configuration</a></span></tt>
302
+
303
+
304
+
305
+
306
+
307
+ </h3><div class="docstring">
308
+ <div class="discussion">
309
+
310
+ <p>Set configuration</p>
311
+
312
+
313
+ </div>
314
+ </div>
315
+ <div class="tags">
316
+ <p class="tag_title">Parameters:</p>
317
+ <ul class="param">
318
+
319
+ <li>
320
+
321
+ <span class='name'>config</span>
322
+
323
+
324
+ <span class='type'>(<tt><span class='object_link'><a href="StrawberryAPI/Configuration.html" title="StrawberryAPI::Configuration (class)">StrawberryAPI::Configuration</a></span></tt>)</span>
325
+
326
+
327
+
328
+ &mdash;
329
+ <div class='inline'>
330
+ <p>configuration object</p>
331
+ </div>
332
+
333
+ </li>
334
+
335
+ </ul>
336
+
337
+ <p class="tag_title">Returns:</p>
338
+ <ul class="return">
339
+
340
+ <li>
341
+
342
+
343
+ <span class='type'>(<tt><span class='object_link'><a href="StrawberryAPI/Configuration.html" title="StrawberryAPI::Configuration (class)">StrawberryAPI::Configuration</a></span></tt>)</span>
344
+
345
+
346
+
347
+ &mdash;
348
+ <div class='inline'>
349
+ <p>configuration object</p>
350
+ </div>
351
+
352
+ </li>
353
+
354
+ </ul>
355
+ <p class="tag_title">Raises:</p>
356
+ <ul class="raise">
357
+
358
+ <li>
359
+
360
+
361
+ <span class='type'>(<tt>TypeError</tt>)</span>
362
+
363
+
364
+
365
+ </li>
366
+
367
+ </ul>
368
+
369
+ </div><table class="source_code">
370
+ <tr>
371
+ <td>
372
+ <pre class="lines">
373
+
374
+
375
+ 23
376
+ 24
377
+ 25
378
+ 26</pre>
379
+ </td>
380
+ <td>
381
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api.rb', line 23</span>
382
+
383
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_config='>config=</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
384
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>TypeError</span> <span class='kw'>unless</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="" title="StrawberryAPI (module)">StrawberryAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="StrawberryAPI/Configuration.html" title="StrawberryAPI::Configuration (class)">Configuration</a></span></span><span class='rparen'>)</span>
385
+ <span class='ivar'>@config</span> <span class='op'>=</span> <span class='id identifier rubyid_config'>config</span>
386
+ <span class='kw'>end</span></pre>
387
+ </td>
388
+ </tr>
389
+ </table>
390
+ </div>
391
+
392
+ <div class="method_details ">
393
+ <h3 class="signature " id="configure-class_method">
394
+
395
+ .<strong>configure</strong> {|config| ... } &#x21d2; <tt>Object</tt>
396
+
397
+
398
+
399
+
400
+
401
+ </h3><div class="docstring">
402
+ <div class="discussion">
403
+
404
+ <p>Configure some settings</p>
405
+
406
+
407
+ </div>
408
+ </div>
409
+ <div class="tags">
410
+
411
+ <p class="tag_title">Yields:</p>
412
+ <ul class="yield">
413
+
414
+ <li>
415
+
416
+
417
+ <span class='type'>(<tt><span class='object_link'><a href="#config-class_method" title="StrawberryAPI.config (method)">config</a></span></tt>)</span>
418
+
419
+
420
+
421
+ &mdash;
422
+ <div class='inline'>
423
+ <p>Given configuration object</p>
424
+ </div>
425
+
426
+ </li>
427
+
428
+ </ul>
429
+ <p class="tag_title">Yield Parameters:</p>
430
+ <ul class="yieldparam">
431
+
432
+ <li>
433
+
434
+ <span class='name'>config</span>
435
+
436
+
437
+ <span class='type'>(<tt><span class='object_link'><a href="StrawberryAPI/Configuration.html" title="StrawberryAPI::Configuration (class)">StrawberryAPI::Configuration</a></span></tt>)</span>
438
+
439
+
440
+
441
+ &mdash;
442
+ <div class='inline'>
443
+ <p>configuration object</p>
444
+ </div>
445
+
446
+ </li>
447
+
448
+ </ul>
449
+
450
+ </div><table class="source_code">
451
+ <tr>
452
+ <td>
453
+ <pre class="lines">
454
+
455
+
456
+ 33
457
+ 34
458
+ 35</pre>
459
+ </td>
460
+ <td>
461
+ <pre class="code"><span class="info file"># File 'lib/strawberry_api.rb', line 33</span>
462
+
463
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span>
464
+ <span class='kw'>yield</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
465
+ <span class='kw'>end</span></pre>
466
+ </td>
467
+ </tr>
468
+ </table>
469
+ </div>
470
+
471
+ </div>
472
+
473
+ </div>
474
+
475
+ <div id="footer">
476
+ Generated on Thu Aug 30 12:51:39 2018 by
477
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
478
+ 0.9.16 (ruby-2.5.0).
479
+ </div>
480
+
481
+ </div>
482
+ </body>
483
+ </html>