rsteamshot 0.1.2 → 0.1.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (64) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/README.md +35 -10
  4. data/lib/rsteamshot.rb +14 -0
  5. data/lib/rsteamshot/app.rb +126 -40
  6. data/lib/rsteamshot/configuration.rb +7 -0
  7. data/lib/rsteamshot/screenshot.rb +51 -0
  8. data/lib/rsteamshot/user.rb +23 -6
  9. data/lib/rsteamshot/version.rb +1 -1
  10. data/rsteamshot.gemspec +5 -0
  11. metadata +7 -56
  12. data/docs/README_md.html +0 -233
  13. data/docs/Rsteamshot.html +0 -147
  14. data/docs/Rsteamshot/App.html +0 -466
  15. data/docs/Rsteamshot/App/BadAppsFile.html +0 -106
  16. data/docs/Rsteamshot/Screenshot.html +0 -562
  17. data/docs/Rsteamshot/ScreenshotPage.html +0 -347
  18. data/docs/Rsteamshot/ScreenshotPaginator.html +0 -307
  19. data/docs/Rsteamshot/User.html +0 -309
  20. data/docs/created.rid +0 -9
  21. data/docs/css/fonts.css +0 -167
  22. data/docs/css/rdoc.css +0 -590
  23. data/docs/fonts/Lato-Light.ttf +0 -0
  24. data/docs/fonts/Lato-LightItalic.ttf +0 -0
  25. data/docs/fonts/Lato-Regular.ttf +0 -0
  26. data/docs/fonts/Lato-RegularItalic.ttf +0 -0
  27. data/docs/fonts/SourceCodePro-Bold.ttf +0 -0
  28. data/docs/fonts/SourceCodePro-Regular.ttf +0 -0
  29. data/docs/images/add.png +0 -0
  30. data/docs/images/arrow_up.png +0 -0
  31. data/docs/images/brick.png +0 -0
  32. data/docs/images/brick_link.png +0 -0
  33. data/docs/images/bug.png +0 -0
  34. data/docs/images/bullet_black.png +0 -0
  35. data/docs/images/bullet_toggle_minus.png +0 -0
  36. data/docs/images/bullet_toggle_plus.png +0 -0
  37. data/docs/images/date.png +0 -0
  38. data/docs/images/delete.png +0 -0
  39. data/docs/images/find.png +0 -0
  40. data/docs/images/loadingAnimation.gif +0 -0
  41. data/docs/images/macFFBgHack.png +0 -0
  42. data/docs/images/package.png +0 -0
  43. data/docs/images/page_green.png +0 -0
  44. data/docs/images/page_white_text.png +0 -0
  45. data/docs/images/page_white_width.png +0 -0
  46. data/docs/images/plugin.png +0 -0
  47. data/docs/images/ruby.png +0 -0
  48. data/docs/images/tag_blue.png +0 -0
  49. data/docs/images/tag_green.png +0 -0
  50. data/docs/images/transparent.png +0 -0
  51. data/docs/images/wrench.png +0 -0
  52. data/docs/images/wrench_orange.png +0 -0
  53. data/docs/images/zoom.png +0 -0
  54. data/docs/index.html +0 -242
  55. data/docs/js/darkfish.js +0 -161
  56. data/docs/js/jquery.js +0 -4
  57. data/docs/js/navigation.js +0 -142
  58. data/docs/js/navigation.js.gz +0 -0
  59. data/docs/js/search.js +0 -109
  60. data/docs/js/search_index.js +0 -1
  61. data/docs/js/search_index.js.gz +0 -0
  62. data/docs/js/searcher.js +0 -229
  63. data/docs/js/searcher.js.gz +0 -0
  64. data/docs/table_of_contents.html +0 -179
@@ -1,309 +0,0 @@
1
- <!DOCTYPE html>
2
-
3
- <html>
4
- <head>
5
- <meta charset="UTF-8">
6
-
7
- <title>class Rsteamshot::User - 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/jquery.js"></script>
15
- <script src="../js/darkfish.js"></script>
16
-
17
- <link href="../css/fonts.css" rel="stylesheet">
18
- <link href="../css/rdoc.css" rel="stylesheet">
19
-
20
-
21
-
22
- <body id="top" role="document" class="class">
23
- <nav role="navigation">
24
- <div id="project-navigation">
25
- <div id="home-section" role="region" title="Quick navigation" class="nav-section">
26
- <h2>
27
- <a href="../index.html" rel="home">Home</a>
28
- </h2>
29
-
30
- <div id="table-of-contents-navigation">
31
- <a href="../table_of_contents.html#pages">Pages</a>
32
- <a href="../table_of_contents.html#classes">Classes</a>
33
- <a href="../table_of_contents.html#methods">Methods</a>
34
- </div>
35
- </div>
36
-
37
- <div id="search-section" role="search" class="project-section initially-hidden">
38
- <form action="#" method="get" accept-charset="utf-8">
39
- <div id="search-field-wrapper">
40
- <input id="search-field" role="combobox" aria-label="Search"
41
- aria-autocomplete="list" aria-controls="search-results"
42
- type="text" name="search" placeholder="Search" spellcheck="false"
43
- title="Type to search, Up and Down to navigate, Enter to load">
44
- </div>
45
-
46
- <ul id="search-results" aria-label="Search Results"
47
- aria-busy="false" aria-expanded="false"
48
- aria-atomic="false" class="initially-hidden"></ul>
49
- </form>
50
- </div>
51
-
52
- </div>
53
-
54
-
55
-
56
- <div id="class-metadata">
57
- <div id="sections-section" class="nav-section">
58
- <h3>Sections</h3>
59
-
60
- <ul class="link-list" role="directory">
61
-
62
- <li><a href="#5Buntitled-5D"></a></li>
63
-
64
- <li><a href="#Public">Public</a></li>
65
-
66
- </ul>
67
- </div>
68
-
69
- <div id="parent-class-section" class="nav-section">
70
- <h3>Parent</h3>
71
-
72
-
73
- <p class="link">Object
74
-
75
- </div>
76
-
77
-
78
-
79
- <!-- Method Quickref -->
80
- <div id="method-list-section" class="nav-section">
81
- <h3>Methods</h3>
82
-
83
- <ul class="link-list" role="directory">
84
-
85
- <li ><a href="#method-c-new">::new</a>
86
-
87
- <li ><a href="#method-i-screenshots">#screenshots</a>
88
-
89
- </ul>
90
- </div>
91
-
92
- </div>
93
- </nav>
94
-
95
- <main role="main" aria-labelledby="class-Rsteamshot::User">
96
- <h1 id="class-Rsteamshot::User" class="class">
97
- class Rsteamshot::User
98
- </h1>
99
-
100
- <section class="description">
101
-
102
- <p>Represents a Steam user. Used to fetch the user&#39;s screenshots they have
103
- uploaded to Steam.</p>
104
-
105
- </section>
106
-
107
-
108
-
109
-
110
- <section id="5Buntitled-5D" class="documentation-section">
111
-
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
- </section>
121
-
122
-
123
-
124
- <section id="Public" class="documentation-section">
125
-
126
- <header class="documentation-section-title">
127
- <h2>
128
- Public
129
- </h2>
130
- <span class="section-click-top">
131
- <a href="#top">&uarr; top</a>
132
- </span>
133
- </header>
134
-
135
-
136
-
137
-
138
-
139
- <section class="constants-list">
140
- <header>
141
- <h3>Constants</h3>
142
- </header>
143
- <dl>
144
-
145
- <dt id="STEAM_PER_PAGE">STEAM_PER_PAGE
146
-
147
- <dd><p>How many screenshots are shown on a user&#39;s profile per page.</p>
148
-
149
-
150
- <dt id="VALID_ORDERS">VALID_ORDERS
151
-
152
- <dd><p>How to sort screenshots when they are being retrieved.</p>
153
-
154
-
155
- </dl>
156
- </section>
157
-
158
-
159
-
160
- <section class="attribute-method-details" class="method-section">
161
- <header>
162
- <h3>Attributes</h3>
163
- </header>
164
-
165
-
166
- <div id="attribute-i-user_name" class="method-detail">
167
- <div class="method-heading attribute-method-heading">
168
- <span class="method-name">user_name</span><span
169
- class="attribute-access-type">[R]</span>
170
- </div>
171
-
172
- <div class="method-description">
173
-
174
- <h3 id="attribute-i-user_name-label-Returns">Returns<span><a href="#attribute-i-user_name-label-Returns">&para;</a> <a href="#top">&uarr;</a></span></h3>
175
-
176
- <p>Returns a String user name from a Steam user&#39;s public profile.</p>
177
-
178
- </div>
179
- </div>
180
-
181
- </section>
182
-
183
-
184
-
185
- <section id="public-class-Public-method-details" class="method-section">
186
- <header>
187
- <h3>Public Class Methods</h3>
188
- </header>
189
-
190
-
191
- <div id="method-c-new" class="method-detail ">
192
-
193
- <div class="method-heading">
194
- <span class="method-name">new</span><span
195
- class="method-args">(user_name, per_page: 10)</span>
196
-
197
- <span class="method-click-advice">click to toggle source</span>
198
-
199
- </div>
200
-
201
-
202
- <div class="method-description">
203
-
204
- <p>Initialize a Steam user with the given user name.</p>
205
- <dl class="rdoc-list note-list"><dt><a href="User.html#attribute-i-user_name">#user_name</a>
206
- <dd>
207
- <p>a String</p>
208
- </dd><dt>per_page
209
- <dd>
210
- <p>how many screenshots to get in each page; defaults to 10; valid range:
211
- 1-50; Integer</p>
212
- </dd></dl>
213
-
214
-
215
-
216
-
217
- <div class="method-source-code" id="new-source">
218
- <pre><span class="ruby-comment"># File lib/rsteamshot/user.rb, line 19</span>
219
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">user_name</span>, <span class="ruby-identifier">per_page</span><span class="ruby-operator">:</span> <span class="ruby-value">10</span>)
220
- <span class="ruby-ivar">@user_name</span> = <span class="ruby-identifier">user_name</span>
221
-
222
- <span class="ruby-identifier">process_html</span> = <span class="ruby-operator">-</span><span class="ruby-operator">&gt;</span>(<span class="ruby-identifier">html</span>) <span class="ruby-keyword">do</span>
223
- <span class="ruby-identifier">links_from</span>(<span class="ruby-identifier">html</span>).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">link</span><span class="ruby-operator">|</span> <span class="ruby-identifier">screenshot_from</span>(<span class="ruby-identifier">link</span>) }
224
- <span class="ruby-keyword">end</span>
225
- <span class="ruby-ivar">@paginator</span> = <span class="ruby-constant">ScreenshotPaginator</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">process_html</span>, <span class="ruby-identifier">max_per_page</span><span class="ruby-operator">:</span> <span class="ruby-constant">STEAM_PER_PAGE</span>,
226
- <span class="ruby-identifier">per_page</span><span class="ruby-operator">:</span> <span class="ruby-identifier">per_page</span>, <span class="ruby-identifier">steam_per_page</span><span class="ruby-operator">:</span> <span class="ruby-constant">STEAM_PER_PAGE</span>)
227
- <span class="ruby-keyword">end</span></pre>
228
- </div>
229
-
230
- </div>
231
-
232
-
233
-
234
-
235
- </div>
236
-
237
-
238
- </section>
239
-
240
- <section id="public-instance-Public-method-details" class="method-section">
241
- <header>
242
- <h3>Public Instance Methods</h3>
243
- </header>
244
-
245
-
246
- <div id="method-i-screenshots" class="method-detail ">
247
-
248
- <div class="method-heading">
249
- <span class="method-name">screenshots</span><span
250
- class="method-args">(order: nil, page: 1, app_id: 0)</span>
251
-
252
- <span class="method-click-advice">click to toggle source</span>
253
-
254
- </div>
255
-
256
-
257
- <div class="method-description">
258
-
259
- <p>Fetch a list of the user&#39;s newest uploaded screenshots.</p>
260
- <dl class="rdoc-list note-list"><dt>order
261
- <dd>
262
- <p>String specifying which screenshots should be retrieved; choose from
263
- newestfirst, score, and oldestfirst; defaults to newestfirst</p>
264
- </dd><dt>page
265
- <dd>
266
- <p>which page of results to fetch; defaults to 1; Integer</p>
267
- </dd><dt>app_id
268
- <dd>
269
- <p>optional Steam app ID as an Integer or String, to get screenshots from this
270
- user for the specified app; defaults to including all apps</p>
271
- </dd></dl>
272
-
273
- <h3 id="method-i-screenshots-label-Returns">Returns<span><a href="#method-i-screenshots-label-Returns">&para;</a> <a href="#top">&uarr;</a></span></h3>
274
-
275
- <p>Returns an Array of Rsteamshot::Screenshots.</p>
276
-
277
-
278
-
279
-
280
- <div class="method-source-code" id="screenshots-source">
281
- <pre><span class="ruby-comment"># File lib/rsteamshot/user.rb, line 38</span>
282
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">screenshots</span>(<span class="ruby-identifier">order</span><span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">page</span><span class="ruby-operator">:</span> <span class="ruby-value">1</span>, <span class="ruby-identifier">app_id</span><span class="ruby-operator">:</span> <span class="ruby-value">0</span>)
283
- <span class="ruby-keyword">return</span> [] <span class="ruby-keyword">unless</span> <span class="ruby-identifier">user_name</span>
284
-
285
- <span class="ruby-identifier">url</span> = <span class="ruby-identifier">steam_url</span>(<span class="ruby-identifier">order</span>, <span class="ruby-identifier">app_id</span>)
286
- <span class="ruby-ivar">@paginator</span>.<span class="ruby-identifier">screenshots</span>(<span class="ruby-identifier">page</span><span class="ruby-operator">:</span> <span class="ruby-identifier">page</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">url</span>)
287
- <span class="ruby-keyword">end</span></pre>
288
- </div>
289
-
290
- </div>
291
-
292
-
293
-
294
-
295
- </div>
296
-
297
-
298
- </section>
299
-
300
- </section>
301
- </main>
302
-
303
-
304
- <footer id="validator-badges" role="contentinfo">
305
- <p><a href="http://validator.w3.org/check/referer">Validate</a>
306
- <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.1.0.
307
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
308
- </footer>
309
-
@@ -1,9 +0,0 @@
1
- Sun, 29 Oct 2017 18:38:52 -0500
2
- README.md Sun, 29 Oct 2017 18:38:48 -0500
3
- lib/rsteamshot.rb Sun, 29 Oct 2017 14:05:55 -0500
4
- lib/rsteamshot/app.rb Sun, 29 Oct 2017 18:32:47 -0500
5
- lib/rsteamshot/screenshot.rb Sun, 29 Oct 2017 18:35:07 -0500
6
- lib/rsteamshot/screenshot_page.rb Sun, 29 Oct 2017 17:15:34 -0500
7
- lib/rsteamshot/screenshot_paginator.rb Sun, 29 Oct 2017 17:21:55 -0500
8
- lib/rsteamshot/user.rb Sun, 29 Oct 2017 17:35:30 -0500
9
- lib/rsteamshot/version.rb Sat, 28 Oct 2017 16:46:51 -0500
@@ -1,167 +0,0 @@
1
- /*
2
- * Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/),
3
- * with Reserved Font Name "Source". All Rights Reserved. Source is a
4
- * trademark of Adobe Systems Incorporated in the United States and/or other
5
- * countries.
6
- *
7
- * This Font Software is licensed under the SIL Open Font License, Version
8
- * 1.1.
9
- *
10
- * This license is copied below, and is also available with a FAQ at:
11
- * http://scripts.sil.org/OFL
12
- */
13
-
14
- @font-face {
15
- font-family: "Source Code Pro";
16
- font-style: normal;
17
- font-weight: 400;
18
- src: local("Source Code Pro"),
19
- local("SourceCodePro-Regular"),
20
- url("../fonts/SourceCodePro-Regular.ttf") format("truetype");
21
- }
22
-
23
- @font-face {
24
- font-family: "Source Code Pro";
25
- font-style: normal;
26
- font-weight: 700;
27
- src: local("Source Code Pro Bold"),
28
- local("SourceCodePro-Bold"),
29
- url("../fonts/SourceCodePro-Bold.ttf") format("truetype");
30
- }
31
-
32
- /*
33
- * Copyright (c) 2010, Łukasz Dziedzic (dziedzic@typoland.com),
34
- * with Reserved Font Name Lato.
35
- *
36
- * This Font Software is licensed under the SIL Open Font License, Version
37
- * 1.1.
38
- *
39
- * This license is copied below, and is also available with a FAQ at:
40
- * http://scripts.sil.org/OFL
41
- */
42
-
43
- @font-face {
44
- font-family: "Lato";
45
- font-style: normal;
46
- font-weight: 300;
47
- src: local("Lato Light"),
48
- local("Lato-Light"),
49
- url("../fonts/Lato-Light.ttf") format("truetype");
50
- }
51
-
52
- @font-face {
53
- font-family: "Lato";
54
- font-style: italic;
55
- font-weight: 300;
56
- src: local("Lato Light Italic"),
57
- local("Lato-LightItalic"),
58
- url("../fonts/Lato-LightItalic.ttf") format("truetype");
59
- }
60
-
61
- @font-face {
62
- font-family: "Lato";
63
- font-style: normal;
64
- font-weight: 700;
65
- src: local("Lato Regular"),
66
- local("Lato-Regular"),
67
- url("../fonts/Lato-Regular.ttf") format("truetype");
68
- }
69
-
70
- @font-face {
71
- font-family: "Lato";
72
- font-style: italic;
73
- font-weight: 700;
74
- src: local("Lato Italic"),
75
- local("Lato-Italic"),
76
- url("../fonts/Lato-RegularItalic.ttf") format("truetype");
77
- }
78
-
79
- /*
80
- * -----------------------------------------------------------
81
- * SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
82
- * -----------------------------------------------------------
83
- *
84
- * PREAMBLE
85
- * The goals of the Open Font License (OFL) are to stimulate worldwide
86
- * development of collaborative font projects, to support the font creation
87
- * efforts of academic and linguistic communities, and to provide a free and
88
- * open framework in which fonts may be shared and improved in partnership
89
- * with others.
90
- *
91
- * The OFL allows the licensed fonts to be used, studied, modified and
92
- * redistributed freely as long as they are not sold by themselves. The
93
- * fonts, including any derivative works, can be bundled, embedded,
94
- * redistributed and/or sold with any software provided that any reserved
95
- * names are not used by derivative works. The fonts and derivatives,
96
- * however, cannot be released under any other type of license. The
97
- * requirement for fonts to remain under this license does not apply
98
- * to any document created using the fonts or their derivatives.
99
- *
100
- * DEFINITIONS
101
- * "Font Software" refers to the set of files released by the Copyright
102
- * Holder(s) under this license and clearly marked as such. This may
103
- * include source files, build scripts and documentation.
104
- *
105
- * "Reserved Font Name" refers to any names specified as such after the
106
- * copyright statement(s).
107
- *
108
- * "Original Version" refers to the collection of Font Software components as
109
- * distributed by the Copyright Holder(s).
110
- *
111
- * "Modified Version" refers to any derivative made by adding to, deleting,
112
- * or substituting -- in part or in whole -- any of the components of the
113
- * Original Version, by changing formats or by porting the Font Software to a
114
- * new environment.
115
- *
116
- * "Author" refers to any designer, engineer, programmer, technical
117
- * writer or other person who contributed to the Font Software.
118
- *
119
- * PERMISSION & CONDITIONS
120
- * Permission is hereby granted, free of charge, to any person obtaining
121
- * a copy of the Font Software, to use, study, copy, merge, embed, modify,
122
- * redistribute, and sell modified and unmodified copies of the Font
123
- * Software, subject to the following conditions:
124
- *
125
- * 1) Neither the Font Software nor any of its individual components,
126
- * in Original or Modified Versions, may be sold by itself.
127
- *
128
- * 2) Original or Modified Versions of the Font Software may be bundled,
129
- * redistributed and/or sold with any software, provided that each copy
130
- * contains the above copyright notice and this license. These can be
131
- * included either as stand-alone text files, human-readable headers or
132
- * in the appropriate machine-readable metadata fields within text or
133
- * binary files as long as those fields can be easily viewed by the user.
134
- *
135
- * 3) No Modified Version of the Font Software may use the Reserved Font
136
- * Name(s) unless explicit written permission is granted by the corresponding
137
- * Copyright Holder. This restriction only applies to the primary font name as
138
- * presented to the users.
139
- *
140
- * 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
141
- * Software shall not be used to promote, endorse or advertise any
142
- * Modified Version, except to acknowledge the contribution(s) of the
143
- * Copyright Holder(s) and the Author(s) or with their explicit written
144
- * permission.
145
- *
146
- * 5) The Font Software, modified or unmodified, in part or in whole,
147
- * must be distributed entirely under this license, and must not be
148
- * distributed under any other license. The requirement for fonts to
149
- * remain under this license does not apply to any document created
150
- * using the Font Software.
151
- *
152
- * TERMINATION
153
- * This license becomes null and void if any of the above conditions are
154
- * not met.
155
- *
156
- * DISCLAIMER
157
- * THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
158
- * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
159
- * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
160
- * OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
161
- * COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
162
- * INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
163
- * DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
164
- * FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
165
- * OTHER DEALINGS IN THE FONT SOFTWARE.
166
- */
167
-