RubyGems - rsteamshot - Versions diffs - 0.1.2 → 0.1.3 - Mend

rsteamshot 0.1.2 → 0.1.3

Files changed (64) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +10 -0
data/README.md +35 -10
data/lib/rsteamshot.rb +14 -0
data/lib/rsteamshot/app.rb +126 -40
data/lib/rsteamshot/configuration.rb +7 -0
data/lib/rsteamshot/screenshot.rb +51 -0
data/lib/rsteamshot/user.rb +23 -6
data/lib/rsteamshot/version.rb +1 -1
data/rsteamshot.gemspec +5 -0
metadata +7 -56
data/docs/README_md.html +0 -233
data/docs/Rsteamshot.html +0 -147
data/docs/Rsteamshot/App.html +0 -466
data/docs/Rsteamshot/App/BadAppsFile.html +0 -106
data/docs/Rsteamshot/Screenshot.html +0 -562
data/docs/Rsteamshot/ScreenshotPage.html +0 -347
data/docs/Rsteamshot/ScreenshotPaginator.html +0 -307
data/docs/Rsteamshot/User.html +0 -309
data/docs/created.rid +0 -9
data/docs/css/fonts.css +0 -167
data/docs/css/rdoc.css +0 -590
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 +0 -242
data/docs/js/darkfish.js +0 -161
data/docs/js/jquery.js +0 -4
data/docs/js/navigation.js +0 -142
data/docs/js/navigation.js.gz +0 -0
data/docs/js/search.js +0 -109
data/docs/js/search_index.js +0 -1
data/docs/js/search_index.js.gz +0 -0
data/docs/js/searcher.js +0 -229
data/docs/js/searcher.js.gz +0 -0
data/docs/table_of_contents.html +0 -179

data/docs/Rsteamshot/ScreenshotPage.html DELETED

@@ -1,347 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta charset="UTF-8">
-<title>class Rsteamshot::ScreenshotPage - RDoc Documentation</title>
-<script type="text/javascript">
-  var rdoc_rel_prefix = "../";
-  var index_rel_prefix = "../";
-</script>
-<script src="../js/jquery.js"></script>
-<script src="../js/darkfish.js"></script>
-<link href="../css/fonts.css" rel="stylesheet">
-<link href="../css/rdoc.css" rel="stylesheet">
-<body id="top" role="document" class="class">
-<nav role="navigation">
-  <div id="project-navigation">
-    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
-  <h2>
-    <a href="../index.html" rel="home">Home</a>
-  </h2>
-  <div id="table-of-contents-navigation">
-    <a href="../table_of_contents.html#pages">Pages</a>
-    <a href="../table_of_contents.html#classes">Classes</a>
-    <a href="../table_of_contents.html#methods">Methods</a>
-  </div>
-</div>
-    <div id="search-section" role="search" class="project-section initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <div id="search-field-wrapper">
-      <input id="search-field" role="combobox" aria-label="Search"
-             aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search" spellcheck="false"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </div>
-    <ul id="search-results" aria-label="Search Results"
-        aria-busy="false" aria-expanded="false"
-        aria-atomic="false" class="initially-hidden"></ul>
-  </form>
-</div>
-  </div>
-  <div id="class-metadata">
-    <div id="sections-section" class="nav-section">
-  <h3>Sections</h3>
-  <ul class="link-list" role="directory">
-      <li><a href="#5Buntitled-5D"></a></li>
-      <li><a href="#Public">Public</a></li>
-  </ul>
-</div>
-    <div id="parent-class-section" class="nav-section">
-  <h3>Parent</h3>
-  <p class="link">Object
-</div>
-    <!-- Method Quickref -->
-<div id="method-list-section" class="nav-section">
-  <h3>Methods</h3>
-  <ul class="link-list" role="directory">
-    <li ><a href="#method-c-new">::new</a>
-    <li ><a href="#method-i-fetch">#fetch</a>
-    <li ><a href="#method-i-includes_screenshot-3F">#includes_screenshot?</a>
-  </ul>
-</div>
-  </div>
-</nav>
-<main role="main" aria-labelledby="class-Rsteamshot::ScreenshotPage">
-  <h1 id="class-Rsteamshot::ScreenshotPage" class="class">
-    class Rsteamshot::ScreenshotPage
-  </h1>
-  <section class="description">
-<p>Represents a page of screenshots on Steam.</p>
-  </section>
-  <section id="5Buntitled-5D" class="documentation-section">
-  </section>
-  <section id="Public" class="documentation-section">
-    <header class="documentation-section-title">
-      <h2>
-        Public
-      </h2>
-      <span class="section-click-top">
-        <a href="#top">&uarr; top</a>
-      </span>
-    </header>
-    <section class="attribute-method-details" class="method-section">
-      <header>
-        <h3>Attributes</h3>
-      </header>
-      <div id="attribute-i-number" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">number</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <h3 id="attribute-i-number-label-Returns">Returns<span><a href="#attribute-i-number-label-Returns">&para;</a> <a href="#top">&uarr;</a></span></h3>
-<p>Returns the Integer number of this page.</p>
-        </div>
-      </div>
-      <div id="attribute-i-per_page" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">per_page</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <h3 id="attribute-i-per_page-label-Returns">Returns<span><a href="#attribute-i-per_page-label-Returns">&para;</a> <a href="#top">&uarr;</a></span></h3>
-<p>Returns the Integer count of how many screenshots to fetch per page.</p>
-        </div>
-      </div>
-      <div id="attribute-i-screenshots" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">screenshots</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <h3 id="attribute-i-screenshots-label-Returns">Returns<span><a href="#attribute-i-screenshots-label-Returns">&para;</a> <a href="#top">&uarr;</a></span></h3>
-<p>Returns an Array of the Rsteamshot::Screenshots found on this page.</p>
-        </div>
-      </div>
-    </section>
-     <section id="public-class-Public-method-details" class="method-section">
-       <header>
-         <h3>Public Class Methods</h3>
-       </header>
-      <div id="method-c-new" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">new</span><span
-            class="method-args">(number, per_page)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Construct a new <a href="ScreenshotPage.html">ScreenshotPage</a> with the
-given page number.</p>
-<dl class="rdoc-list note-list"><dt>number
-<dd>
-<p>the page number; Integer</p>
-</dd><dt><a href="ScreenshotPage.html#attribute-i-per_page">#per_page</a>
-<dd>
-<p>how many screenshots are shown on the Steam page</p>
-</dd></dl>
-          <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/rsteamshot/screenshot_page.rb, line 17</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">number</span>, <span class="ruby-identifier">per_page</span>)
-  <span class="ruby-ivar">@number</span> = <span class="ruby-identifier">number</span>
-  <span class="ruby-ivar">@per_page</span> = <span class="ruby-identifier">per_page</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-     <section id="public-instance-Public-method-details" class="method-section">
-       <header>
-         <h3>Public Instance Methods</h3>
-       </header>
-      <div id="method-i-fetch" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">fetch</span><span
-            class="method-args">(base_url) { |html| ... }</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Fetch the contents of this page from Steam.</p>
-<h3 id="method-i-fetch-label-Returns">Returns<span><a href="#method-i-fetch-label-Returns">&para;</a> <a href="#top">&uarr;</a></span></h3>
-<p>Returns a Mechanize::Page.</p>
-          <div class="method-source-code" id="fetch-source">
-            <pre><span class="ruby-comment"># File lib/rsteamshot/screenshot_page.rb, line 34</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">base_url</span>)
-  <span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@screenshots</span> <span class="ruby-comment"># already fetched</span>
-  <span class="ruby-identifier">url</span> = <span class="ruby-identifier">with_steam_page_param</span>(<span class="ruby-identifier">base_url</span>)
-  <span class="ruby-constant">Mechanize</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">url</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">html</span><span class="ruby-operator">|</span>
-    <span class="ruby-ivar">@screenshots</span> = <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">html</span>)
-  <span class="ruby-keyword">end</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-includes_screenshot-3F" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">includes_screenshot?</span><span
-            class="method-args">(screenshot_number)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Check if the nth screenshot would be on this page on Steam.</p>
-<dl class="rdoc-list note-list"><dt>screenshot_number
-<dd>
-<p>the index of the screenshot you want to check</p>
-</dd></dl>
-<h3 id="method-i-includes_screenshot-3F-label-Returns">Returns<span><a href="#method-i-includes_screenshot-3F-label-Returns">&para;</a> <a href="#top">&uarr;</a></span></h3>
-<p>Returns a Boolean.</p>
-          <div class="method-source-code" id="includes_screenshot-3F-source">
-            <pre><span class="ruby-comment"># File lib/rsteamshot/screenshot_page.rb, line 27</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">includes_screenshot?</span>(<span class="ruby-identifier">screenshot_number</span>)
-  <span class="ruby-identifier">range</span>.<span class="ruby-identifier">cover?</span>(<span class="ruby-identifier">screenshot_number</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-  </section>
-</main>
-<footer id="validator-badges" role="contentinfo">
-  <p><a href="http://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.1.0.
-  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
-</footer>

data/docs/Rsteamshot/ScreenshotPaginator.html DELETED

@@ -1,307 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta charset="UTF-8">
-<title>class Rsteamshot::ScreenshotPaginator - RDoc Documentation</title>
-<script type="text/javascript">
-  var rdoc_rel_prefix = "../";
-  var index_rel_prefix = "../";
-</script>
-<script src="../js/jquery.js"></script>
-<script src="../js/darkfish.js"></script>
-<link href="../css/fonts.css" rel="stylesheet">
-<link href="../css/rdoc.css" rel="stylesheet">
-<body id="top" role="document" class="class">
-<nav role="navigation">
-  <div id="project-navigation">
-    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
-  <h2>
-    <a href="../index.html" rel="home">Home</a>
-  </h2>
-  <div id="table-of-contents-navigation">
-    <a href="../table_of_contents.html#pages">Pages</a>
-    <a href="../table_of_contents.html#classes">Classes</a>
-    <a href="../table_of_contents.html#methods">Methods</a>
-  </div>
-</div>
-    <div id="search-section" role="search" class="project-section initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <div id="search-field-wrapper">
-      <input id="search-field" role="combobox" aria-label="Search"
-             aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search" spellcheck="false"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </div>
-    <ul id="search-results" aria-label="Search Results"
-        aria-busy="false" aria-expanded="false"
-        aria-atomic="false" class="initially-hidden"></ul>
-  </form>
-</div>
-  </div>
-  <div id="class-metadata">
-    <div id="sections-section" class="nav-section">
-  <h3>Sections</h3>
-  <ul class="link-list" role="directory">
-      <li><a href="#5Buntitled-5D"></a></li>
-      <li><a href="#Public">Public</a></li>
-  </ul>
-</div>
-    <div id="parent-class-section" class="nav-section">
-  <h3>Parent</h3>
-  <p class="link">Object
-</div>
-    <!-- Method Quickref -->
-<div id="method-list-section" class="nav-section">
-  <h3>Methods</h3>
-  <ul class="link-list" role="directory">
-    <li ><a href="#method-c-new">::new</a>
-    <li ><a href="#method-i-per_page">#per_page</a>
-    <li ><a href="#method-i-screenshots">#screenshots</a>
-  </ul>
-</div>
-  </div>
-</nav>
-<main role="main" aria-labelledby="class-Rsteamshot::ScreenshotPaginator">
-  <h1 id="class-Rsteamshot::ScreenshotPaginator" class="class">
-    class Rsteamshot::ScreenshotPaginator
-  </h1>
-  <section class="description">
-<p>Use to paginate screenshots fetched from Steam in chunks of fewer than 50
-per page.</p>
-  </section>
-  <section id="5Buntitled-5D" class="documentation-section">
-  </section>
-  <section id="Public" class="documentation-section">
-    <header class="documentation-section-title">
-      <h2>
-        Public
-      </h2>
-      <span class="section-click-top">
-        <a href="#top">&uarr; top</a>
-      </span>
-    </header>
-     <section id="public-class-Public-method-details" class="method-section">
-       <header>
-         <h3>Public Class Methods</h3>
-       </header>
-      <div id="method-c-new" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">new</span><span
-            class="method-args">(process_html, max_per_page:, per_page: 10, steam_per_page:)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Construct a new <a href="ScreenshotPaginator.html">ScreenshotPaginator</a>
-that will process a page of HTML using the given lambda.</p>
-<dl class="rdoc-list note-list"><dt>process_html
-<dd>
-<p>a lambda that will take a Mechanize::Page and return a list of <a
-href="Screenshot.html">Rsteamshot::Screenshot</a> instances found in that
-page</p>
-</dd><dt>max_per_page
-<dd>
-<p>the most screenshots that can be returned in a page, based on how many
-screenshots can be shown on the Steam page</p>
-</dd><dt><a href="ScreenshotPaginator.html#method-i-per_page">#per_page</a>
-<dd>
-<p>how many screenshots you want returned; Integer; should be less than or
-equal to max_per_page</p>
-</dd><dt>steam_per_page
-<dd>
-<p>how many screenshots will actually be on the Steam page; Integer; should be
-less than or equal to max_per_page</p>
-</dd></dl>
-          <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/rsteamshot/screenshot_paginator.rb, line 16</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">process_html</span>, <span class="ruby-identifier">max_per_page</span>,, <span class="ruby-identifier">per_page</span><span class="ruby-operator">:</span> <span class="ruby-value">10</span>, <span class="ruby-identifier">steam_per_page</span>))
-  <span class="ruby-ivar">@process_html</span> = <span class="ruby-identifier">process_html</span>
-  <span class="ruby-ivar">@screenshot_pages</span> = []
-  <span class="ruby-ivar">@max_per_page</span> = <span class="ruby-identifier">max_per_page</span>
-  <span class="ruby-ivar">@raw_per_page</span> = <span class="ruby-identifier">per_page</span>
-  <span class="ruby-ivar">@steam_per_page</span> = <span class="ruby-identifier">normalize_per_page</span>(<span class="ruby-identifier">steam_per_page</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-     <section id="public-instance-Public-method-details" class="method-section">
-       <header>
-         <h3>Public Instance Methods</h3>
-       </header>
-      <div id="method-i-per_page" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">per_page</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <h3 id="method-i-per_page-label-Returns">Returns<span><a href="#method-i-per_page-label-Returns">&para;</a> <a href="#top">&uarr;</a></span></h3>
-<p>Returns the Integer count of screenshots per page.</p>
-          <div class="method-source-code" id="per_page-source">
-            <pre><span class="ruby-comment"># File lib/rsteamshot/screenshot_paginator.rb, line 25</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">per_page</span>
-  <span class="ruby-ivar">@per_page</span> = <span class="ruby-identifier">normalize_per_page</span>(<span class="ruby-ivar">@raw_per_page</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-screenshots" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">screenshots</span><span
-            class="method-args">(page: 1, url:)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Get the specified number of screenshots from the given Steam URL.</p>
-<dl class="rdoc-list note-list"><dt>page
-<dd>
-<p>which page of results to fetch; Integer; defaults to 1</p>
-</dd><dt>url
-<dd>
-<p>URL to a Steam page with screenshots, should not include a page parameter;
-String</p>
-</dd></dl>
-<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>
-<p>Returns an Array of Rsteamshot::Screenshots.</p>
-          <div class="method-source-code" id="screenshots-source">
-            <pre><span class="ruby-comment"># File lib/rsteamshot/screenshot_paginator.rb, line 35</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">screenshots</span>(<span class="ruby-identifier">page</span><span class="ruby-operator">:</span> <span class="ruby-value">1</span>, <span class="ruby-identifier">url</span>))
-  <span class="ruby-identifier">offset</span> = <span class="ruby-identifier">get_offset</span>(<span class="ruby-identifier">page</span>)
-  <span class="ruby-identifier">fetch_screenshots</span>(<span class="ruby-identifier">offset</span>, <span class="ruby-identifier">url</span>).<span class="ruby-identifier">drop</span>(<span class="ruby-identifier">offset</span>).<span class="ruby-identifier">take</span>(<span class="ruby-identifier">per_page</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-  </section>
-</main>
-<footer id="validator-badges" role="contentinfo">
-  <p><a href="http://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.1.0.
-  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
-</footer>