sleeper_rb 0.2.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 +7 -0
- data/.gitignore +15 -0
- data/.rspec +3 -0
- data/.rubocop.yml +18 -0
- data/.travis.yml +8 -0
- data/CHANGELOG.md +9 -0
- data/CODE_OF_CONDUCT.md +84 -0
- data/Gemfile +14 -0
- data/Gemfile.lock +91 -0
- data/LICENSE.txt +21 -0
- data/README.md +92 -0
- data/Rakefile +24 -0
- data/bin/console +15 -0
- data/bin/setup +8 -0
- data/docs/SleeperRb/BadRequest.html +106 -0
- data/docs/SleeperRb/Client.html +354 -0
- data/docs/SleeperRb/NotFound.html +106 -0
- data/docs/SleeperRb/RateLimitExceeded.html +106 -0
- data/docs/SleeperRb/Resources/Avatar.html +231 -0
- data/docs/SleeperRb/Resources/Draft/Metadata.html +419 -0
- data/docs/SleeperRb/Resources/Draft/Pick/Metadata.html +346 -0
- data/docs/SleeperRb/Resources/Draft/Pick.html +430 -0
- data/docs/SleeperRb/Resources/Draft/PickArray.html +108 -0
- data/docs/SleeperRb/Resources/Draft/Settings.html +361 -0
- data/docs/SleeperRb/Resources/Draft.html +560 -0
- data/docs/SleeperRb/Resources/DraftArray.html +198 -0
- data/docs/SleeperRb/Resources/League/Matchup.html +349 -0
- data/docs/SleeperRb/Resources/League/MatchupArray.html +108 -0
- data/docs/SleeperRb/Resources/League/Roster/Settings.html +415 -0
- data/docs/SleeperRb/Resources/League/Roster.html +409 -0
- data/docs/SleeperRb/Resources/League/RosterArray.html +108 -0
- data/docs/SleeperRb/Resources/League/ScoringSettings.html +808 -0
- data/docs/SleeperRb/Resources/League/Settings.html +648 -0
- data/docs/SleeperRb/Resources/League/Transaction/Metadata.html +119 -0
- data/docs/SleeperRb/Resources/League/Transaction/Settings.html +140 -0
- data/docs/SleeperRb/Resources/League/Transaction/WaiverBudget.html +292 -0
- data/docs/SleeperRb/Resources/League/Transaction.html +679 -0
- data/docs/SleeperRb/Resources/League/TransactionArray.html +272 -0
- data/docs/SleeperRb/Resources/League.html +688 -0
- data/docs/SleeperRb/Resources/LeagueArray.html +272 -0
- data/docs/SleeperRb/Resources/NflState.html +252 -0
- data/docs/SleeperRb/Resources/Player.html +860 -0
- data/docs/SleeperRb/Resources/PlayerArray.html +108 -0
- data/docs/SleeperRb/Resources/TradedPick.html +345 -0
- data/docs/SleeperRb/Resources/TradedPickArray.html +108 -0
- data/docs/SleeperRb/Resources/User/Metadata.html +140 -0
- data/docs/SleeperRb/Resources/User.html +406 -0
- data/docs/SleeperRb/Resources/UserArray.html +108 -0
- data/docs/SleeperRb/Resources.html +99 -0
- data/docs/SleeperRb/ServerError.html +106 -0
- data/docs/SleeperRb/Utilities/ArrayProxy.html +184 -0
- data/docs/SleeperRb/Utilities/Cache/ClassMethods.html +326 -0
- data/docs/SleeperRb/Utilities/Cache.html +253 -0
- data/docs/SleeperRb/Utilities/Request.html +120 -0
- data/docs/SleeperRb/Utilities/RosterPosition.html +239 -0
- data/docs/SleeperRb/Utilities.html +99 -0
- data/docs/SleeperRb.html +113 -0
- data/docs/created.rid +38 -0
- data/docs/css/fonts.css +167 -0
- data/docs/css/rdoc.css +619 -0
- data/docs/fonts/Lato-Light.ttf +0 -0
- data/docs/fonts/Lato-LightItalic.ttf +0 -0
- data/docs/fonts/Lato-Regular.ttf +0 -0
- data/docs/fonts/Lato-RegularItalic.ttf +0 -0
- data/docs/fonts/SourceCodePro-Bold.ttf +0 -0
- data/docs/fonts/SourceCodePro-Regular.ttf +0 -0
- data/docs/images/add.png +0 -0
- data/docs/images/arrow_up.png +0 -0
- data/docs/images/brick.png +0 -0
- data/docs/images/brick_link.png +0 -0
- data/docs/images/bug.png +0 -0
- data/docs/images/bullet_black.png +0 -0
- data/docs/images/bullet_toggle_minus.png +0 -0
- data/docs/images/bullet_toggle_plus.png +0 -0
- data/docs/images/date.png +0 -0
- data/docs/images/delete.png +0 -0
- data/docs/images/find.png +0 -0
- data/docs/images/loadingAnimation.gif +0 -0
- data/docs/images/macFFBgHack.png +0 -0
- data/docs/images/package.png +0 -0
- data/docs/images/page_green.png +0 -0
- data/docs/images/page_white_text.png +0 -0
- data/docs/images/page_white_width.png +0 -0
- data/docs/images/plugin.png +0 -0
- data/docs/images/ruby.png +0 -0
- data/docs/images/tag_blue.png +0 -0
- data/docs/images/tag_green.png +0 -0
- data/docs/images/transparent.png +0 -0
- data/docs/images/wrench.png +0 -0
- data/docs/images/wrench_orange.png +0 -0
- data/docs/images/zoom.png +0 -0
- data/docs/index.html +171 -0
- data/docs/js/darkfish.js +84 -0
- data/docs/js/navigation.js +105 -0
- data/docs/js/navigation.js.gz +0 -0
- data/docs/js/search.js +110 -0
- data/docs/js/search_index.js +1 -0
- data/docs/js/search_index.js.gz +0 -0
- data/docs/js/searcher.js +229 -0
- data/docs/js/searcher.js.gz +0 -0
- data/docs/table_of_contents.html +770 -0
- data/lib/sleeper_rb/client.rb +80 -0
- data/lib/sleeper_rb/resources/avatar.rb +43 -0
- data/lib/sleeper_rb/resources/draft/metadata.rb +83 -0
- data/lib/sleeper_rb/resources/draft/pick/metadata.rb +64 -0
- data/lib/sleeper_rb/resources/draft/pick.rb +85 -0
- data/lib/sleeper_rb/resources/draft/pick_array.rb +11 -0
- data/lib/sleeper_rb/resources/draft/settings.rb +73 -0
- data/lib/sleeper_rb/resources/draft.rb +129 -0
- data/lib/sleeper_rb/resources/draft_array.rb +25 -0
- data/lib/sleeper_rb/resources/league/matchup.rb +66 -0
- data/lib/sleeper_rb/resources/league/matchup_array.rb +11 -0
- data/lib/sleeper_rb/resources/league/roster/settings.rb +76 -0
- data/lib/sleeper_rb/resources/league/roster.rb +73 -0
- data/lib/sleeper_rb/resources/league/roster_array.rb +11 -0
- data/lib/sleeper_rb/resources/league/scoring_settings.rb +172 -0
- data/lib/sleeper_rb/resources/league/settings.rb +148 -0
- data/lib/sleeper_rb/resources/league/transaction/metadata.rb +22 -0
- data/lib/sleeper_rb/resources/league/transaction/settings.rb +22 -0
- data/lib/sleeper_rb/resources/league/transaction/waiver_budget.rb +52 -0
- data/lib/sleeper_rb/resources/league/transaction.rb +153 -0
- data/lib/sleeper_rb/resources/league/transaction_array.rb +43 -0
- data/lib/sleeper_rb/resources/league.rb +197 -0
- data/lib/sleeper_rb/resources/league_array.rb +41 -0
- data/lib/sleeper_rb/resources/nfl_state.rb +51 -0
- data/lib/sleeper_rb/resources/player.rb +189 -0
- data/lib/sleeper_rb/resources/player_array.rb +16 -0
- data/lib/sleeper_rb/resources/traded_pick.rb +63 -0
- data/lib/sleeper_rb/resources/traded_pick_array.rb +9 -0
- data/lib/sleeper_rb/resources/user/metadata.rb +20 -0
- data/lib/sleeper_rb/resources/user.rb +104 -0
- data/lib/sleeper_rb/resources/user_array.rb +9 -0
- data/lib/sleeper_rb/utilities/array_proxy.rb +47 -0
- data/lib/sleeper_rb/utilities/cache.rb +132 -0
- data/lib/sleeper_rb/utilities/request.rb +42 -0
- data/lib/sleeper_rb/utilities/roster_position.rb +30 -0
- data/lib/sleeper_rb/version.rb +5 -0
- data/lib/sleeper_rb.rb +15 -0
- data/sleeper_rb.gemspec +35 -0
- metadata +185 -0
|
@@ -0,0 +1,688 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class SleeperRb::Resources::League - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../../";
|
|
11
|
+
var index_rel_prefix = "../../";
|
|
12
|
+
</script>
|
|
13
|
+
|
|
14
|
+
<script src="../../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../../js/search.js" defer></script>
|
|
16
|
+
<script src="../../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../../js/darkfish.js" defer></script>
|
|
19
|
+
|
|
20
|
+
<link href="../../css/fonts.css" rel="stylesheet">
|
|
21
|
+
<link href="../../css/rdoc.css" rel="stylesheet">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
<body id="top" role="document" class="class">
|
|
27
|
+
<nav role="navigation">
|
|
28
|
+
<div id="project-navigation">
|
|
29
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
30
|
+
<h2>
|
|
31
|
+
<a href="../../index.html" rel="home">Home</a>
|
|
32
|
+
</h2>
|
|
33
|
+
|
|
34
|
+
<div id="table-of-contents-navigation">
|
|
35
|
+
<a href="../../table_of_contents.html#pages">Pages</a>
|
|
36
|
+
<a href="../../table_of_contents.html#classes">Classes</a>
|
|
37
|
+
<a href="../../table_of_contents.html#methods">Methods</a>
|
|
38
|
+
</div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
42
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
43
|
+
<div id="search-field-wrapper">
|
|
44
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
45
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
46
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
47
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
48
|
+
</div>
|
|
49
|
+
|
|
50
|
+
<ul id="search-results" aria-label="Search Results"
|
|
51
|
+
aria-busy="false" aria-expanded="false"
|
|
52
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
53
|
+
</form>
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
<div id="class-metadata">
|
|
61
|
+
|
|
62
|
+
<div id="parent-class-section" class="nav-section">
|
|
63
|
+
<h3>Parent</h3>
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
<p class="link">Object
|
|
67
|
+
|
|
68
|
+
</div>
|
|
69
|
+
|
|
70
|
+
<div id="includes-section" class="nav-section">
|
|
71
|
+
<h3>Included Modules</h3>
|
|
72
|
+
|
|
73
|
+
<ul class="link-list">
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
<li><a class="include" href="../Utilities/Request.html">SleeperRb::Utilities::Request</a>
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
<li><a class="include" href="../Utilities/Cache.html">SleeperRb::Utilities::Cache</a>
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
</ul>
|
|
84
|
+
</div>
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
<!-- Method Quickref -->
|
|
88
|
+
<div id="method-list-section" class="nav-section">
|
|
89
|
+
<h3>Methods</h3>
|
|
90
|
+
|
|
91
|
+
<ul class="link-list" role="directory">
|
|
92
|
+
|
|
93
|
+
<li class="calls-super" ><a href="#method-c-new">::new</a>
|
|
94
|
+
|
|
95
|
+
<li ><a href="#method-i-avatar">#avatar</a>
|
|
96
|
+
|
|
97
|
+
<li ><a href="#method-i-drafts">#drafts</a>
|
|
98
|
+
|
|
99
|
+
<li ><a href="#method-i-matchups">#matchups</a>
|
|
100
|
+
|
|
101
|
+
<li ><a href="#method-i-roster_positions">#roster_positions</a>
|
|
102
|
+
|
|
103
|
+
<li ><a href="#method-i-rosters">#rosters</a>
|
|
104
|
+
|
|
105
|
+
<li ><a href="#method-i-scoring_settings">#scoring_settings</a>
|
|
106
|
+
|
|
107
|
+
<li ><a href="#method-i-settings">#settings</a>
|
|
108
|
+
|
|
109
|
+
<li ><a href="#method-i-traded_picks">#traded_picks</a>
|
|
110
|
+
|
|
111
|
+
<li ><a href="#method-i-transactions">#transactions</a>
|
|
112
|
+
|
|
113
|
+
<li ><a href="#method-i-users">#users</a>
|
|
114
|
+
|
|
115
|
+
</ul>
|
|
116
|
+
</div>
|
|
117
|
+
|
|
118
|
+
</div>
|
|
119
|
+
</nav>
|
|
120
|
+
|
|
121
|
+
<main role="main" aria-labelledby="class-SleeperRb::Resources::League">
|
|
122
|
+
<h1 id="class-SleeperRb::Resources::League" class="class">
|
|
123
|
+
class SleeperRb::Resources::League
|
|
124
|
+
</h1>
|
|
125
|
+
|
|
126
|
+
<section class="description">
|
|
127
|
+
|
|
128
|
+
<p>This class represents a Fantasy Football <a href="League.html"><code>League</code></a> and is the access point for associated resources. All attributes are lazily loaded and cache their value based on the API response.</p>
|
|
129
|
+
|
|
130
|
+
</section>
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
<section class="attribute-method-details" class="method-section">
|
|
142
|
+
<header>
|
|
143
|
+
<h3>Attributes</h3>
|
|
144
|
+
</header>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<div id="attribute-i-draft_id" class="method-detail">
|
|
148
|
+
<div class="method-heading attribute-method-heading">
|
|
149
|
+
<span class="method-name">draft_id</span><span
|
|
150
|
+
class="attribute-access-type">[R]</span>
|
|
151
|
+
</div>
|
|
152
|
+
|
|
153
|
+
<div class="method-description">
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
</div>
|
|
158
|
+
</div>
|
|
159
|
+
|
|
160
|
+
<div id="attribute-i-league_id" class="method-detail">
|
|
161
|
+
<div class="method-heading attribute-method-heading">
|
|
162
|
+
<span class="method-name">league_id</span><span
|
|
163
|
+
class="attribute-access-type">[R]</span>
|
|
164
|
+
</div>
|
|
165
|
+
|
|
166
|
+
<div class="method-description">
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
</div>
|
|
171
|
+
</div>
|
|
172
|
+
|
|
173
|
+
<div id="attribute-i-name" class="method-detail">
|
|
174
|
+
<div class="method-heading attribute-method-heading">
|
|
175
|
+
<span class="method-name">name</span><span
|
|
176
|
+
class="attribute-access-type">[R]</span>
|
|
177
|
+
</div>
|
|
178
|
+
|
|
179
|
+
<div class="method-description">
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
</div>
|
|
184
|
+
</div>
|
|
185
|
+
|
|
186
|
+
<div id="attribute-i-previous_league_id" class="method-detail">
|
|
187
|
+
<div class="method-heading attribute-method-heading">
|
|
188
|
+
<span class="method-name">previous_league_id</span><span
|
|
189
|
+
class="attribute-access-type">[R]</span>
|
|
190
|
+
</div>
|
|
191
|
+
|
|
192
|
+
<div class="method-description">
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
</div>
|
|
197
|
+
</div>
|
|
198
|
+
|
|
199
|
+
<div id="attribute-i-season" class="method-detail">
|
|
200
|
+
<div class="method-heading attribute-method-heading">
|
|
201
|
+
<span class="method-name">season</span><span
|
|
202
|
+
class="attribute-access-type">[R]</span>
|
|
203
|
+
</div>
|
|
204
|
+
|
|
205
|
+
<div class="method-description">
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
</div>
|
|
210
|
+
</div>
|
|
211
|
+
|
|
212
|
+
<div id="attribute-i-season_type" class="method-detail">
|
|
213
|
+
<div class="method-heading attribute-method-heading">
|
|
214
|
+
<span class="method-name">season_type</span><span
|
|
215
|
+
class="attribute-access-type">[R]</span>
|
|
216
|
+
</div>
|
|
217
|
+
|
|
218
|
+
<div class="method-description">
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
</div>
|
|
223
|
+
</div>
|
|
224
|
+
|
|
225
|
+
<div id="attribute-i-sport" class="method-detail">
|
|
226
|
+
<div class="method-heading attribute-method-heading">
|
|
227
|
+
<span class="method-name">sport</span><span
|
|
228
|
+
class="attribute-access-type">[R]</span>
|
|
229
|
+
</div>
|
|
230
|
+
|
|
231
|
+
<div class="method-description">
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
</div>
|
|
236
|
+
</div>
|
|
237
|
+
|
|
238
|
+
<div id="attribute-i-status" class="method-detail">
|
|
239
|
+
<div class="method-heading attribute-method-heading">
|
|
240
|
+
<span class="method-name">status</span><span
|
|
241
|
+
class="attribute-access-type">[R]</span>
|
|
242
|
+
</div>
|
|
243
|
+
|
|
244
|
+
<div class="method-description">
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
</div>
|
|
249
|
+
</div>
|
|
250
|
+
|
|
251
|
+
<div id="attribute-i-total_rosters" class="method-detail">
|
|
252
|
+
<div class="method-heading attribute-method-heading">
|
|
253
|
+
<span class="method-name">total_rosters</span><span
|
|
254
|
+
class="attribute-access-type">[R]</span>
|
|
255
|
+
</div>
|
|
256
|
+
|
|
257
|
+
<div class="method-description">
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
</div>
|
|
262
|
+
</div>
|
|
263
|
+
|
|
264
|
+
</section>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
269
|
+
<header>
|
|
270
|
+
<h3>Public Class Methods</h3>
|
|
271
|
+
</header>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
<div id="method-c-new" class="method-detail ">
|
|
275
|
+
|
|
276
|
+
<div class="method-heading">
|
|
277
|
+
<span class="method-name">new</span><span
|
|
278
|
+
class="method-args">(opts = {})</span>
|
|
279
|
+
|
|
280
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
281
|
+
|
|
282
|
+
</div>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
<div class="method-description">
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
<div class="method-calls-super">
|
|
291
|
+
Calls superclass method
|
|
292
|
+
<a href="../Utilities/Cache.html#method-c-new"><code>SleeperRb::Utilities::Cache::new</code></a>
|
|
293
|
+
</div>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
<div class="method-source-code" id="new-source">
|
|
298
|
+
<pre><span class="ruby-comment"># File lib/sleeper_rb/resources/league.rb, line 143</span>
|
|
299
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">opts</span> = {})
|
|
300
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:league_id</span>]
|
|
301
|
+
|
|
302
|
+
<span class="ruby-keyword">super</span>
|
|
303
|
+
<span class="ruby-keyword">end</span></pre>
|
|
304
|
+
</div>
|
|
305
|
+
|
|
306
|
+
</div>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
</div>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
</section>
|
|
315
|
+
|
|
316
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
317
|
+
<header>
|
|
318
|
+
<h3>Public Instance Methods</h3>
|
|
319
|
+
</header>
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
<div id="method-i-avatar" class="method-detail ">
|
|
323
|
+
|
|
324
|
+
<div class="method-heading">
|
|
325
|
+
<span class="method-name">avatar</span><span
|
|
326
|
+
class="method-args">()</span>
|
|
327
|
+
|
|
328
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
329
|
+
|
|
330
|
+
</div>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<div class="method-description">
|
|
334
|
+
|
|
335
|
+
<p>Retrieves the <a href="Avatar.html"><code>Avatar</code></a> instance for the league.</p>
|
|
336
|
+
|
|
337
|
+
<p>@return [<a href="Avatar.html"><code>SleeperRb::Resources::Avatar</code></a>]</p>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<div class="method-source-code" id="avatar-source">
|
|
343
|
+
<pre><span class="ruby-comment"># File lib/sleeper_rb/resources/league.rb, line 49</span>
|
|
344
|
+
</pre>
|
|
345
|
+
</div>
|
|
346
|
+
|
|
347
|
+
</div>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
</div>
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
<div id="method-i-drafts" class="method-detail ">
|
|
356
|
+
|
|
357
|
+
<div class="method-heading">
|
|
358
|
+
<span class="method-name">drafts</span><span
|
|
359
|
+
class="method-args">()</span>
|
|
360
|
+
|
|
361
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
362
|
+
|
|
363
|
+
</div>
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
<div class="method-description">
|
|
367
|
+
|
|
368
|
+
<p>Returns all drafts for the league</p>
|
|
369
|
+
|
|
370
|
+
<p>@return [<a href="DraftArray.html"><code>SleeperRb::Resources::DraftArray</code></a>]</p>
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<div class="method-source-code" id="drafts-source">
|
|
376
|
+
<pre><span class="ruby-comment"># File lib/sleeper_rb/resources/league.rb, line 128</span>
|
|
377
|
+
<span class="ruby-identifier">cached_association</span> <span class="ruby-value">:drafts</span> <span class="ruby-keyword">do</span>
|
|
378
|
+
<span class="ruby-identifier">retrieve_drafts!</span>
|
|
379
|
+
<span class="ruby-keyword">end</span></pre>
|
|
380
|
+
</div>
|
|
381
|
+
|
|
382
|
+
</div>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
</div>
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
<div id="method-i-matchups" class="method-detail ">
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
<div class="method-heading">
|
|
394
|
+
<span class="method-callseq">
|
|
395
|
+
matchups(week_number)
|
|
396
|
+
</span>
|
|
397
|
+
|
|
398
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
399
|
+
|
|
400
|
+
</div>
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
<div class="method-description">
|
|
405
|
+
|
|
406
|
+
<p>Returns matchups for the <a href="League.html"><code>League</code></a> for the given week.</p>
|
|
407
|
+
|
|
408
|
+
<p>@return [<a href="League/MatchupArray.html"><code>SleeperRb::Resources::League::MatchupArray</code></a>]</p>
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
<div class="method-source-code" id="matchups-source">
|
|
414
|
+
<pre><span class="ruby-comment"># File lib/sleeper_rb/resources/league.rb, line 110</span>
|
|
415
|
+
<span class="ruby-identifier">cached_association</span> <span class="ruby-value">:matchups</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">week</span><span class="ruby-operator">|</span>
|
|
416
|
+
<span class="ruby-identifier">retrieve_matchups!</span>(<span class="ruby-identifier">week</span>)
|
|
417
|
+
<span class="ruby-keyword">end</span></pre>
|
|
418
|
+
</div>
|
|
419
|
+
|
|
420
|
+
</div>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
</div>
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
<div id="method-i-roster_positions" class="method-detail ">
|
|
429
|
+
|
|
430
|
+
<div class="method-heading">
|
|
431
|
+
<span class="method-name">roster_positions</span><span
|
|
432
|
+
class="method-args">()</span>
|
|
433
|
+
|
|
434
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
435
|
+
|
|
436
|
+
</div>
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
<div class="method-description">
|
|
440
|
+
|
|
441
|
+
<p>Retrieves the available roster positions for the league.</p>
|
|
442
|
+
|
|
443
|
+
<p>@return [Array<<a href="../Utilities/RosterPosition.html"><code>SleeperRb::Utilities::RosterPosition</code></a>>]</p>
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
<div class="method-source-code" id="roster_positions-source">
|
|
449
|
+
<pre><span class="ruby-comment"># File lib/sleeper_rb/resources/league.rb, line 61</span>
|
|
450
|
+
</pre>
|
|
451
|
+
</div>
|
|
452
|
+
|
|
453
|
+
</div>
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
</div>
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
<div id="method-i-rosters" class="method-detail ">
|
|
462
|
+
|
|
463
|
+
<div class="method-heading">
|
|
464
|
+
<span class="method-name">rosters</span><span
|
|
465
|
+
class="method-args">()</span>
|
|
466
|
+
|
|
467
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
468
|
+
|
|
469
|
+
</div>
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
<div class="method-description">
|
|
473
|
+
|
|
474
|
+
<p>Retrieves rosters for the <a href="League.html"><code>League</code></a>.</p>
|
|
475
|
+
|
|
476
|
+
<p>@return [<a href="League/RosterArray.html"><code>SleeperRb::Resources::League::RosterArray</code></a>]</p>
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
<div class="method-source-code" id="rosters-source">
|
|
482
|
+
<pre><span class="ruby-comment"># File lib/sleeper_rb/resources/league.rb, line 90</span>
|
|
483
|
+
<span class="ruby-identifier">cached_association</span> <span class="ruby-value">:rosters</span> <span class="ruby-keyword">do</span>
|
|
484
|
+
<span class="ruby-identifier">retrieve_rosters!</span>
|
|
485
|
+
<span class="ruby-keyword">end</span></pre>
|
|
486
|
+
</div>
|
|
487
|
+
|
|
488
|
+
</div>
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
</div>
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
<div id="method-i-scoring_settings" class="method-detail ">
|
|
497
|
+
|
|
498
|
+
<div class="method-heading">
|
|
499
|
+
<span class="method-name">scoring_settings</span><span
|
|
500
|
+
class="method-args">()</span>
|
|
501
|
+
|
|
502
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
503
|
+
|
|
504
|
+
</div>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
<div class="method-description">
|
|
508
|
+
|
|
509
|
+
<p>Retrieves the scoring settings for the league.</p>
|
|
510
|
+
|
|
511
|
+
<p>@return [<a href="League/ScoringSettings.html"><code>SleeperRb::Resources::League::ScoringSettings</code></a>]</p>
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
<div class="method-source-code" id="scoring_settings-source">
|
|
517
|
+
<pre><span class="ruby-comment"># File lib/sleeper_rb/resources/league.rb, line 55</span>
|
|
518
|
+
</pre>
|
|
519
|
+
</div>
|
|
520
|
+
|
|
521
|
+
</div>
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
</div>
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
<div id="method-i-settings" class="method-detail ">
|
|
530
|
+
|
|
531
|
+
<div class="method-heading">
|
|
532
|
+
<span class="method-name">settings</span><span
|
|
533
|
+
class="method-args">()</span>
|
|
534
|
+
|
|
535
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
536
|
+
|
|
537
|
+
</div>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
<div class="method-description">
|
|
541
|
+
|
|
542
|
+
<p>Returns the non-scoring settings for the league.</p>
|
|
543
|
+
|
|
544
|
+
<p>@return [<a href="League/Settings.html"><code>SleeperRb::Resources::League::Settings</code></a>]</p>
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
<div class="method-source-code" id="settings-source">
|
|
550
|
+
<pre><span class="ruby-comment"># File lib/sleeper_rb/resources/league.rb, line 71</span>
|
|
551
|
+
<span class="ruby-identifier">cached_attr</span> <span class="ruby-value">:total_rosters</span>, <span class="ruby-value">:status</span>, <span class="ruby-value">:sport</span>, <span class="ruby-value">:season_type</span>, <span class="ruby-value">:season</span>, <span class="ruby-value">:previous_league_id</span>, <span class="ruby-value">:name</span>, <span class="ruby-value">:league_id</span>,
|
|
552
|
+
<span class="ruby-value">:draft_id</span>, <span class="ruby-value">avatar:</span> <span class="ruby-operator">-></span>(<span class="ruby-identifier">id</span>) { <span class="ruby-constant">Resources</span><span class="ruby-operator">::</span><span class="ruby-constant">Avatar</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">avatar_id:</span> <span class="ruby-identifier">id</span>) },
|
|
553
|
+
<span class="ruby-value">scoring_settings:</span> <span class="ruby-operator">-></span>(<span class="ruby-identifier">settings</span>) { <span class="ruby-constant">ScoringSettings</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">settings</span>) },
|
|
554
|
+
<span class="ruby-value">roster_positions:</span> <span class="ruby-identifier">lambda</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">array</span><span class="ruby-operator">|</span>
|
|
555
|
+
<span class="ruby-identifier">array</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pos</span><span class="ruby-operator">|</span>
|
|
556
|
+
<span class="ruby-constant">SleeperRb</span><span class="ruby-operator">::</span><span class="ruby-constant">Utilities</span><span class="ruby-operator">::</span><span class="ruby-constant">RosterPosition</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pos</span>)
|
|
557
|
+
<span class="ruby-keyword">end</span></pre>
|
|
558
|
+
</div>
|
|
559
|
+
|
|
560
|
+
</div>
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
</div>
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
<div id="method-i-traded_picks" class="method-detail ">
|
|
569
|
+
|
|
570
|
+
<div class="method-heading">
|
|
571
|
+
<span class="method-name">traded_picks</span><span
|
|
572
|
+
class="method-args">()</span>
|
|
573
|
+
|
|
574
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
575
|
+
|
|
576
|
+
</div>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
<div class="method-description">
|
|
580
|
+
|
|
581
|
+
<p>Returns all traded draft picks for the <a href="League.html"><code>League</code></a>.</p>
|
|
582
|
+
|
|
583
|
+
<p>@return [<a href="TradedPickArray.html"><code>SleeperRb::Resources::TradedPickArray</code></a>]</p>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
<div class="method-source-code" id="traded_picks-source">
|
|
589
|
+
<pre><span class="ruby-comment"># File lib/sleeper_rb/resources/league.rb, line 119</span>
|
|
590
|
+
<span class="ruby-identifier">cached_association</span> <span class="ruby-value">:traded_picks</span> <span class="ruby-keyword">do</span>
|
|
591
|
+
<span class="ruby-identifier">retrieve_traded_picks!</span>
|
|
592
|
+
<span class="ruby-keyword">end</span></pre>
|
|
593
|
+
</div>
|
|
594
|
+
|
|
595
|
+
</div>
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
</div>
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
<div id="method-i-transactions" class="method-detail ">
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
<div class="method-heading">
|
|
607
|
+
<span class="method-callseq">
|
|
608
|
+
transactions(week_number)
|
|
609
|
+
</span>
|
|
610
|
+
|
|
611
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
612
|
+
|
|
613
|
+
</div>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
<div class="method-description">
|
|
618
|
+
|
|
619
|
+
<p>Returns all transactions for the <a href="League.html"><code>League</code></a> for a given week.</p>
|
|
620
|
+
|
|
621
|
+
<p>@return [<a href="League/TransactionArray.html"><code>SleeperRb::Resources::League::TransactionArray</code></a>]</p>
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
<div class="method-source-code" id="transactions-source">
|
|
627
|
+
<pre><span class="ruby-comment"># File lib/sleeper_rb/resources/league.rb, line 139</span>
|
|
628
|
+
<span class="ruby-identifier">cached_association</span> <span class="ruby-value">:transactions</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">week</span><span class="ruby-operator">|</span>
|
|
629
|
+
<span class="ruby-identifier">retrieve_transactions!</span>(<span class="ruby-identifier">week</span>)
|
|
630
|
+
<span class="ruby-keyword">end</span></pre>
|
|
631
|
+
</div>
|
|
632
|
+
|
|
633
|
+
</div>
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
</div>
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
<div id="method-i-users" class="method-detail ">
|
|
642
|
+
|
|
643
|
+
<div class="method-heading">
|
|
644
|
+
<span class="method-name">users</span><span
|
|
645
|
+
class="method-args">()</span>
|
|
646
|
+
|
|
647
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
648
|
+
|
|
649
|
+
</div>
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
<div class="method-description">
|
|
653
|
+
|
|
654
|
+
<p>Retrieves users for the <a href="League.html"><code>League</code></a>.</p>
|
|
655
|
+
|
|
656
|
+
<p>@return [<a href="UserArray.html"><code>SleeperRb::Resources::UserArray</code></a>]</p>
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
<div class="method-source-code" id="users-source">
|
|
662
|
+
<pre><span class="ruby-comment"># File lib/sleeper_rb/resources/league.rb, line 99</span>
|
|
663
|
+
<span class="ruby-identifier">cached_association</span> <span class="ruby-value">:users</span> <span class="ruby-keyword">do</span>
|
|
664
|
+
<span class="ruby-identifier">retrieve_users!</span>
|
|
665
|
+
<span class="ruby-keyword">end</span></pre>
|
|
666
|
+
</div>
|
|
667
|
+
|
|
668
|
+
</div>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
</div>
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
</section>
|
|
677
|
+
|
|
678
|
+
</section>
|
|
679
|
+
|
|
680
|
+
</main>
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
<footer id="validator-badges" role="contentinfo">
|
|
684
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
685
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
|
|
686
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
687
|
+
</footer>
|
|
688
|
+
|