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

@@ -1,242 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta charset="UTF-8">
-<title>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="file">
-<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="project-metadata">
-    <div id="fileindex-section" class="nav-section">
-  <h3>Pages</h3>
-  <ul class="link-list">
-    <li><a href="./README_md.html">README</a>
-  </ul>
-</div>
-    <div id="classindex-section" class="nav-section">
-  <h3>Class and Module Index</h3>
-  <ul class="link-list">
-    <li><a href="./Rsteamshot.html">Rsteamshot</a>
-    <li><a href="./Rsteamshot/App.html">Rsteamshot::App</a>
-    <li><a href="./Rsteamshot/App/BadAppsFile.html">Rsteamshot::App::BadAppsFile</a>
-    <li><a href="./Rsteamshot/Screenshot.html">Rsteamshot::Screenshot</a>
-    <li><a href="./Rsteamshot/ScreenshotPage.html">Rsteamshot::ScreenshotPage</a>
-    <li><a href="./Rsteamshot/ScreenshotPaginator.html">Rsteamshot::ScreenshotPaginator</a>
-    <li><a href="./Rsteamshot/User.html">Rsteamshot::User</a>
-  </ul>
-</div>
-  </div>
-</nav>
-<main role="main">
-<h1 id="label-Rsteamshot"><a href="Rsteamshot.html">Rsteamshot</a><span><a href="#label-Rsteamshot">&para;</a> <a href="#top">&uarr;</a></span></h1>
-<p><a href="https://travis-ci.org/cheshire137/rsteamshot"><img
-src="https://travis-ci.org/cheshire137/rsteamshot.svg?branch=master"></a></p>
-<p><a href="Rsteamshot.html">Rsteamshot</a> is a Ruby gem for getting
-screenshots a user has uploaded to their Steam profile, as well as
-screenshots uploaded for a particular game. You can find the newest
-screenshots as well as the most popular screenshots. Screenshots can be
-paginated.</p>
-<p>There&#39;s no Steam API that I know of that provides this screenshot data,
-so this gem works by using <a
-href="https://github.com/sparklemotion/mechanize">Mechanize</a> to do web
-scraping on <a href="http://steamcommunity.com/">steamcommunity.com</a>.</p>
-<p><a href="https://github.com/cheshire137/rsteamshot">View source on
-GitHub</a></p>
-<h2 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<p>Add this line to your application&#39;s Gemfile:</p>
-<pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-string">&#39;rsteamshot&#39;</span>
-</pre>
-<p>And then execute:</p>
-<pre>$ bundle</pre>
-<p>Or install it yourself as:</p>
-<pre>$ gem install rsteamshot</pre>
-<h2 id="label-Usage">Usage<span><a href="#label-Usage">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<pre class="ruby"><span class="ruby-comment"># Get screenshots uploaded by a Steam user:</span>
-<span class="ruby-identifier">steam_user_name</span> = <span class="ruby-string">&#39;cheshire137&#39;</span>
-<span class="ruby-identifier">user</span> = <span class="ruby-constant">Rsteamshot</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">steam_user_name</span>, <span class="ruby-identifier">per_page</span><span class="ruby-operator">:</span> <span class="ruby-value">10</span>)
-<span class="ruby-identifier">order</span> = <span class="ruby-string">&#39;newestfirst&#39;</span> <span class="ruby-comment"># also: score, oldestfirst</span>
-<span class="ruby-identifier">screenshots</span> = <span class="ruby-identifier">user</span>.<span class="ruby-identifier">screenshots</span>(<span class="ruby-identifier">order</span><span class="ruby-operator">:</span> <span class="ruby-identifier">order</span>)
-<span class="ruby-identifier">screenshots</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">user</span>.<span class="ruby-identifier">screenshots</span>(<span class="ruby-identifier">order</span><span class="ruby-operator">:</span> <span class="ruby-identifier">order</span>, <span class="ruby-identifier">page</span><span class="ruby-operator">:</span> <span class="ruby-value">2</span>)
-<span class="ruby-comment"># Find a Steam app by name:</span>
-<span class="ruby-identifier">apps_path</span> = <span class="ruby-string">&#39;apps-list.json&#39;</span>
-<span class="ruby-constant">Rsteamshot</span><span class="ruby-operator">::</span><span class="ruby-constant">App</span>.<span class="ruby-identifier">download_apps_list</span>(<span class="ruby-identifier">apps_path</span>)
-<span class="ruby-identifier">apps</span> = <span class="ruby-constant">Rsteamshot</span><span class="ruby-operator">::</span><span class="ruby-constant">App</span>.<span class="ruby-identifier">search</span>(<span class="ruby-string">&#39;witcher 3&#39;</span>, <span class="ruby-identifier">apps_path</span>)
-<span class="ruby-identifier">app</span> = <span class="ruby-identifier">apps</span>.<span class="ruby-identifier">first</span>
-<span class="ruby-comment"># Filter a user&#39;s screenshots to those for a particular app:</span>
-<span class="ruby-identifier">alice_screenshots</span> = <span class="ruby-identifier">user</span>.<span class="ruby-identifier">screenshots</span>(<span class="ruby-identifier">app_id</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;19680&#39;</span>)
-<span class="ruby-comment"># Initialize an app directly if you know its ID:</span>
-<span class="ruby-identifier">app_id</span> = <span class="ruby-string">&#39;377160&#39;</span>
-<span class="ruby-identifier">app</span> = <span class="ruby-constant">Rsteamshot</span><span class="ruby-operator">::</span><span class="ruby-constant">App</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">app_id</span>, <span class="ruby-identifier">per_page</span><span class="ruby-operator">:</span> <span class="ruby-value">10</span>)
-<span class="ruby-comment"># Get screenshots uploaded for a Steam game:</span>
-<span class="ruby-identifier">order</span> = <span class="ruby-string">&#39;mostrecent&#39;</span> <span class="ruby-comment"># also: toprated, trendday, trendweek, trendthreemonths, trendsixmonths,</span>
-                     <span class="ruby-comment"># trendyear</span>
-<span class="ruby-identifier">screenshots</span> = <span class="ruby-identifier">app</span>.<span class="ruby-identifier">screenshots</span>(<span class="ruby-identifier">order</span><span class="ruby-operator">:</span> <span class="ruby-identifier">order</span>)
-<span class="ruby-identifier">screenshots</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">app</span>.<span class="ruby-identifier">screenshots</span>(<span class="ruby-identifier">order</span><span class="ruby-operator">:</span> <span class="ruby-identifier">order</span>, <span class="ruby-identifier">page</span><span class="ruby-operator">:</span> <span class="ruby-value">2</span>)
-<span class="ruby-comment"># Search an app&#39;s screenshots:</span>
-<span class="ruby-identifier">dog_screenshots</span> = <span class="ruby-identifier">app</span>.<span class="ruby-identifier">screenshots</span>(<span class="ruby-identifier">query</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;dog&#39;</span>, <span class="ruby-identifier">order</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;trendweek&#39;</span>)
-<span class="ruby-comment"># Data available for each screenshot:</span>
-<span class="ruby-identifier">screenshots</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">screenshot</span><span class="ruby-operator">|</span>
-  <span class="ruby-identifier">screenshot</span>.<span class="ruby-identifier">title</span>
-  <span class="ruby-comment"># =&gt; &quot;Lovely sunset in Toussaint&quot;</span>
-  <span class="ruby-identifier">screenshot</span>.<span class="ruby-identifier">details_url</span>
-  <span class="ruby-comment"># =&gt; &quot;http://steamcommunity.com/sharedfiles/filedetails/?id=737284878&quot;</span>
-  <span class="ruby-identifier">screenshot</span>.<span class="ruby-identifier">full_size_url</span>
-  <span class="ruby-comment"># =&gt; &quot;https://steamuserimages-a.akamaihd.net/ugc/1621679306978373648/FACBF0285AFB413467E0E76371E8796D8E8C263D/&quot;</span>
-  <span class="ruby-identifier">screenshot</span>.<span class="ruby-identifier">medium_url</span>
-  <span class="ruby-comment"># =&gt; &quot;https://steamuserimages-a.akamaihd.net/ugc/1621679306978373648/FACBF0285AFB413467E0E76371E8796D8E8C263D/?interpolation=lanczos-none&amp;output-format=jpeg&amp;output-quality=95&amp;fit=inside|1024:576&amp;composite-to%3D%2A%2C%2A%7C1024%3A576&amp;background-color=black&quot;</span>
-  <span class="ruby-identifier">screenshot</span>.<span class="ruby-identifier">user_name</span>
-  <span class="ruby-comment"># =&gt; &quot;cheshire137&quot;</span>
-  <span class="ruby-identifier">screenshot</span>.<span class="ruby-identifier">user_url</span>
-  <span class="ruby-comment"># =&gt; &quot;http://steamcommunity.com/id/cheshire137&quot;</span>
-  <span class="ruby-identifier">screenshot</span>.<span class="ruby-identifier">date</span>
-  <span class="ruby-comment"># =&gt; #&lt;DateTime: 2016-08-03T20:54:00+00:00 ((2457604j,75240s,0n),+0s,2299161j)&gt;</span>
-  <span class="ruby-identifier">screenshot</span>.<span class="ruby-identifier">file_size</span>
-  <span class="ruby-comment"># =&gt; &quot;0.367 MB&quot;</span>
-  <span class="ruby-identifier">screenshot</span>.<span class="ruby-identifier">width</span>
-  <span class="ruby-comment"># =&gt; 1920</span>
-  <span class="ruby-identifier">screenshot</span>.<span class="ruby-identifier">height</span>
-  <span class="ruby-comment"># =&gt; 1080</span>
-  <span class="ruby-identifier">screenshot</span>.<span class="ruby-identifier">like_count</span>
-  <span class="ruby-comment"># =&gt; 0</span>
-  <span class="ruby-identifier">screenshot</span>.<span class="ruby-identifier">comment_count</span>
-  <span class="ruby-comment"># =&gt; 0</span>
-  <span class="ruby-comment"># Utility methods:</span>
-  <span class="ruby-identifier">screenshot</span>.<span class="ruby-identifier">to_h</span>
-  <span class="ruby-comment"># =&gt; {:details_url=&gt;&quot;http://steamcommunity.com/sharedfiles/filedetails/?id=737284878&quot;, :title=&gt;...</span>
-  <span class="ruby-identifier">screenshot</span>.<span class="ruby-identifier">to_json</span>
-  <span class="ruby-comment"># =&gt; &quot;{\n  \&quot;details_url\&quot;: \&quot;http://steamcommunity.com/sharedfiles/filedetails/?id=737284878\&quot;,</span>
-<span class="ruby-keyword">end</span>
-</pre>
-<h2 id="label-Development">Development<span><a href="#label-Development">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<p>After checking out <a href="https://github.com/cheshire137/rsteamshot">the
-repo</a>, run <code>bin/setup</code> to install dependencies. Then, run
-<code>rake spec</code> to run the tests. You can also run
-<code>bin/console</code> for an interactive prompt that will allow you to
-experiment.</p>
-<p>To install this gem onto your local machine, run <code>bundle exec rake
-install</code>. To release a new version, update the version number in
-<code>version.rb</code>, and then run <code>bundle exec rake
-release</code>, which will create a git tag for the version, push git
-commits and tags, and push the <code>.gem</code> file to <a
-href="https://rubygems.org">rubygems.org</a>.</p>
-<h2 id="label-Contributing">Contributing<span><a href="#label-Contributing">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<p><a href="https://github.com/cheshire137/rsteamshot/issues">Bug reports</a>
-and pull requests are welcome. This project is intended to be a safe,
-welcoming space for collaboration, and contributors are expected to adhere
-to the <a href="http://contributor-covenant.org">Contributor Covenant</a>
-code of conduct.</p>
-<h2 id="label-License">License<span><a href="#label-License">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<p>The gem is available as open source under the terms of the <a
-href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
-</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/js/darkfish.js DELETED

@@ -1,161 +0,0 @@
-/**
- *
- * Darkfish Page Functions
- * $Id: darkfish.js 53 2009-01-07 02:52:03Z deveiant $
- *
- * Author: Michael Granger <mgranger@laika.com>
- *
- */
-/* Provide console simulation for firebug-less environments */
-if (!("console" in window) || !("firebug" in console)) {
-  var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
-    "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
-  window.console = {};
-  for (var i = 0; i < names.length; ++i)
-    window.console[names[i]] = function() {};
-};
-/**
- * Unwrap the first element that matches the given @expr@ from the targets and return them.
- */
-$.fn.unwrap = function( expr ) {
-  return this.each( function() {
-    $(this).parents( expr ).eq( 0 ).after( this ).remove();
-  });
-};
-function showSource( e ) {
-  var target = e.target;
-  var codeSections = $(target).
-    parents('.method-detail').
-    find('.method-source-code');
-  $(target).
-    parents('.method-detail').
-    find('.method-source-code').
-    slideToggle();
-};
-function hookSourceViews() {
-  $('.method-heading').click( showSource );
-};
-function hookSearch() {
-  var input  = $('#search-field').eq(0);
-  var result = $('#search-results').eq(0);
-  $(result).show();
-  var search_section = $('#search-section').get(0);
-  $(search_section).show();
-  var search = new Search(search_data, input, result);
-  search.renderItem = function(result) {
-    var li = document.createElement('li');
-    var html = '';
-    // TODO add relative path to <script> per-page
-    html += '<p class="search-match"><a href="' + index_rel_prefix + result.path + '">' + this.hlt(result.title);
-    if (result.params)
-      html += '<span class="params">' + result.params + '</span>';
-    html += '</a>';
-    if (result.namespace)
-      html += '<p class="search-namespace">' + this.hlt(result.namespace);
-    if (result.snippet)
-      html += '<div class="search-snippet">' + result.snippet + '</div>';
-    li.innerHTML = html;
-    return li;
-  }
-  search.select = function(result) {
-    var result_element = result.get(0);
-    window.location.href = result_element.firstChild.firstChild.href;
-  }
-  search.scrollIntoView = search.scrollInWindow;
-};
-function highlightTarget( anchor ) {
-  console.debug( "Highlighting target '%s'.", anchor );
-  $("a[name]").each( function() {
-    if ( $(this).attr("name") == anchor ) {
-      if ( !$(this).parent().parent().hasClass('target-section') ) {
-        console.debug( "Wrapping the target-section" );
-        $('div.method-detail').unwrap( 'div.target-section' );
-        $(this).parent().wrap( '<div class="target-section"></div>' );
-      } else {
-        console.debug( "Already wrapped." );
-      }
-    }
-  });
-};
-function highlightLocationTarget() {
-  console.debug( "Location hash: %s", window.location.hash );
-  if ( ! window.location.hash || window.location.hash.length == 0 ) return;
-  var anchor = window.location.hash.substring(1);
-  console.debug( "Found anchor: %s; matching %s", anchor, "a[name=" + anchor + "]" );
-  highlightTarget( anchor );
-};
-function highlightClickTarget( event ) {
-  console.debug( "Highlighting click target for event %o", event.target );
-  try {
-    var anchor = $(event.target).attr( 'href' ).substring(1);
-    console.debug( "Found target anchor: %s", anchor );
-    highlightTarget( anchor );
-  } catch ( err ) {
-    console.error( "Exception while highlighting: %o", err );
-  };
-};
-function loadAsync(path, success, prefix) {
-  $.ajax({
-    url: prefix + path,
-    dataType: 'script',
-    success: success,
-    cache: true
-  });
-};
-$(document).ready( function() {
-  hookSourceViews();
-  highlightLocationTarget();
-  $('ul.link-list a').bind( "click", highlightClickTarget );
-  var search_scripts_loaded = {
-    navigation_loaded:   false,
-    search_loaded:       false,
-    search_index_loaded: false,
-    searcher_loaded:     false,
-  }
-  var search_success_function = function(variable) {
-    return (function (data, status, xhr) {
-      search_scripts_loaded[variable] = true;
-      if (search_scripts_loaded['navigation_loaded']   == true &&
-          search_scripts_loaded['search_loaded']       == true &&
-          search_scripts_loaded['search_index_loaded'] == true &&
-          search_scripts_loaded['searcher_loaded']     == true)
-        hookSearch();
-    });
-  }
-  loadAsync('js/navigation.js',   search_success_function('navigation_loaded'), rdoc_rel_prefix);
-  loadAsync('js/search.js',       search_success_function('search_loaded'), rdoc_rel_prefix);
-  loadAsync('js/search_index.js', search_success_function('search_index_loaded'), index_rel_prefix);
-  loadAsync('js/searcher.js',     search_success_function('searcher_loaded'), rdoc_rel_prefix);
-});