rsteamshot 0.1.1

data/docs/js/searcher.js

@@ -0,0 +1,229 @@
+Searcher = function(data) {
+  this.data = data;
+  this.handlers = [];
+}
+
+Searcher.prototype = new function() {
+  // search is performed in chunks of 1000 for non-blocking user input
+  var CHUNK_SIZE = 1000;
+  // do not try to find more than 100 results
+  var MAX_RESULTS = 100;
+  var huid = 1;
+  var suid = 1;
+  var runs = 0;
+
+  this.find = function(query) {
+    var queries = splitQuery(query);
+    var regexps = buildRegexps(queries);
+    var highlighters = buildHilighters(queries);
+    var state = { from: 0, pass: 0, limit: MAX_RESULTS, n: suid++};
+    var _this = this;
+
+    this.currentSuid = state.n;
+
+    if (!query) return;
+
+    var run = function() {
+      // stop current search thread if new search started
+      if (state.n != _this.currentSuid) return;
+
+      var results =
+        performSearch(_this.data, regexps, queries, highlighters, state);
+      var hasMore = (state.limit > 0 && state.pass < 4);
+
+      triggerResults.call(_this, results, !hasMore);
+      if (hasMore) {
+        setTimeout(run, 2);
+      }
+      runs++;
+    };
+    runs = 0;
+
+    // start search thread
+    run();
+  }
+
+  /*  ----- Events ------  */
+  this.ready = function(fn) {
+    fn.huid = huid;
+    this.handlers.push(fn);
+  }
+
+  /*  ----- Utilities ------  */
+  function splitQuery(query) {
+    return jQuery.grep(query.split(/(\s+|::?|\(\)?)/), function(string) {
+      return string.match(/\S/);
+    });
+  }
+
+  function buildRegexps(queries) {
+    return jQuery.map(queries, function(query) {
+      return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i');
+    });
+  }
+
+  function buildHilighters(queries) {
+    return jQuery.map(queries, function(query) {
+      return jQuery.map(query.split(''), function(l, i) {
+        return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2);
+      }).join('');
+    });
+  }
+
+  // function longMatchRegexp(index, longIndex, regexps) {
+  //     for (var i = regexps.length - 1; i >= 0; i--){
+  //         if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) return false;
+  //     };
+  //     return true;
+  // }
+
+
+  /*  ----- Mathchers ------  */
+
+  /*
+   * This record matches if the index starts with queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassBeginning(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the longIndex starts with queries[0] and the
+   * longIndex matches all of the regexps
+   */
+  function matchPassLongIndex(index, longIndex, queries, regexps) {
+    if (longIndex.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the index contains queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassContains(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) == -1) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if regexps[0] matches the index and the record
+   * matches all of the regexps
+   */
+  function matchPassRegexp(index, longIndex, queries, regexps) {
+    if (!index.match(regexps[0])) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+
+  /*  ----- Highlighters ------  */
+  function highlightRegexp(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    for (var i=0, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function hltSubstring(string, pos, length) {
+    return string.substring(0, pos) + '\u0001' + string.substring(pos, pos + length) + '\u0002' + string.substring(pos + length);
+  }
+
+  function highlightQuery(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    var pos = 0;
+    var lcTitle = result.title.toLowerCase();
+
+    pos = lcTitle.indexOf(queries[0]);
+    if (pos != -1) {
+      result.title = hltSubstring(result.title, pos, queries[0].length);
+    }
+
+    result.namespace = result.namespace.replace(regexps[0], highlighters[0]);
+    for (var i=1, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function createResult(info) {
+    var result = {};
+    result.title = info[0];
+    result.namespace = info[1];
+    result.path = info[2];
+    result.params = info[3];
+    result.snippet = info[4];
+    result.badge = info[6];
+    return result;
+  }
+
+  /*  ----- Searching ------  */
+  function performSearch(data, regexps, queries, highlighters, state) {
+    var searchIndex = data.searchIndex;
+    var longSearchIndex = data.longSearchIndex;
+    var info = data.info;
+    var result = [];
+    var i = state.from;
+    var l = searchIndex.length;
+    var togo = CHUNK_SIZE;
+    var matchFunc, hltFunc;
+
+    while (state.pass < 4 && state.limit > 0 && togo > 0) {
+      if (state.pass == 0) {
+        matchFunc = matchPassBeginning;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 1) {
+        matchFunc = matchPassLongIndex;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 2) {
+        matchFunc = matchPassContains;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 3) {
+        matchFunc = matchPassRegexp;
+        hltFunc = highlightRegexp;
+      }
+
+      for (; togo > 0 && i < l && state.limit > 0; i++, togo--) {
+        if (info[i].n == state.n) continue;
+        if (matchFunc(searchIndex[i], longSearchIndex[i], queries, regexps)) {
+          info[i].n = state.n;
+          result.push(hltFunc(info[i], queries, regexps, highlighters));
+          state.limit--;
+        }
+      };
+      if (searchIndex.length <= i) {
+        state.pass++;
+        i = state.from = 0;
+      } else {
+        state.from = i;
+      }
+    }
+    return result;
+  }
+
+  function triggerResults(results, isLast) {
+    jQuery.each(this.handlers, function(i, fn) {
+      fn.call(this, results, isLast)
+    })
+  }
+}
+

data/docs/table_of_contents.html

@@ -0,0 +1,179 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>Table of Contents - 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" class="table-of-contents">
+<main role="main">
+<h1 class="class">Table of Contents - RDoc Documentation</h1>
+
+<h2 id="pages">Pages</h2>
+<ul>
+  <li class="file">
+    <a href="README_md.html">README</a>
+
+    <ul>
+      <li><a href="README_md.html#label-Rsteamshot">Rsteamshot</a>
+      <li><a href="README_md.html#label-Installation">Installation</a>
+      <li><a href="README_md.html#label-Usage">Usage</a>
+      <li><a href="README_md.html#label-Development">Development</a>
+      <li><a href="README_md.html#label-Contributing">Contributing</a>
+      <li><a href="README_md.html#label-License">License</a>
+    </ul>
+  </li>
+  
+</ul>
+
+<h2 id="classes">Classes and Modules</h2>
+<ul>
+  <li class="module">
+    <a href="Rsteamshot.html">Rsteamshot</a>
+  </li>
+  <li class="class">
+    <a href="Rsteamshot/App.html">Rsteamshot::App</a>
+
+    <ul>
+      <li><a href="Rsteamshot/App.html#Public">Public</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Rsteamshot/App/BadAppsFile.html">Rsteamshot::App::BadAppsFile</a>
+  </li>
+  <li class="class">
+    <a href="Rsteamshot/Screenshot.html">Rsteamshot::Screenshot</a>
+
+    <ul>
+      <li><a href="Rsteamshot/Screenshot.html#Public">Public</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Rsteamshot/ScreenshotPage.html">Rsteamshot::ScreenshotPage</a>
+
+    <ul>
+      <li><a href="Rsteamshot/ScreenshotPage.html#Public">Public</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Rsteamshot/ScreenshotPaginator.html">Rsteamshot::ScreenshotPaginator</a>
+
+    <ul>
+      <li><a href="Rsteamshot/ScreenshotPaginator.html#Public">Public</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Rsteamshot/User.html">Rsteamshot::User</a>
+
+    <ul>
+      <li><a href="Rsteamshot/User.html#Public">Public</a>
+    </ul>
+  </li>
+</ul>
+
+<h2 id="methods">Methods</h2>
+<ul>
+
+  <li class="method">
+    <a href="Rsteamshot/App.html#method-c-download_apps_list">::download_apps_list</a>
+    &mdash;
+    <span class="container">Rsteamshot::App</span>
+
+  <li class="method">
+    <a href="Rsteamshot/App.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Rsteamshot::App</span>
+
+  <li class="method">
+    <a href="Rsteamshot/ScreenshotPage.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Rsteamshot::ScreenshotPage</span>
+
+  <li class="method">
+    <a href="Rsteamshot/Screenshot.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Rsteamshot::Screenshot</span>
+
+  <li class="method">
+    <a href="Rsteamshot/ScreenshotPaginator.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Rsteamshot::ScreenshotPaginator</span>
+
+  <li class="method">
+    <a href="Rsteamshot/User.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Rsteamshot::User</span>
+
+  <li class="method">
+    <a href="Rsteamshot/App.html#method-c-search">::search</a>
+    &mdash;
+    <span class="container">Rsteamshot::App</span>
+
+  <li class="method">
+    <a href="Rsteamshot/ScreenshotPage.html#method-i-fetch">#fetch</a>
+    &mdash;
+    <span class="container">Rsteamshot::ScreenshotPage</span>
+
+  <li class="method">
+    <a href="Rsteamshot/ScreenshotPage.html#method-i-includes_screenshot-3F">#includes_screenshot?</a>
+    &mdash;
+    <span class="container">Rsteamshot::ScreenshotPage</span>
+
+  <li class="method">
+    <a href="Rsteamshot/Screenshot.html#method-i-inspect">#inspect</a>
+    &mdash;
+    <span class="container">Rsteamshot::Screenshot</span>
+
+  <li class="method">
+    <a href="Rsteamshot/ScreenshotPaginator.html#method-i-per_page">#per_page</a>
+    &mdash;
+    <span class="container">Rsteamshot::ScreenshotPaginator</span>
+
+  <li class="method">
+    <a href="Rsteamshot/ScreenshotPaginator.html#method-i-screenshots">#screenshots</a>
+    &mdash;
+    <span class="container">Rsteamshot::ScreenshotPaginator</span>
+
+  <li class="method">
+    <a href="Rsteamshot/User.html#method-i-screenshots">#screenshots</a>
+    &mdash;
+    <span class="container">Rsteamshot::User</span>
+
+  <li class="method">
+    <a href="Rsteamshot/App.html#method-i-screenshots">#screenshots</a>
+    &mdash;
+    <span class="container">Rsteamshot::App</span>
+
+  <li class="method">
+    <a href="Rsteamshot/Screenshot.html#method-i-to_h">#to_h</a>
+    &mdash;
+    <span class="container">Rsteamshot::Screenshot</span>
+
+  <li class="method">
+    <a href="Rsteamshot/Screenshot.html#method-i-to_json">#to_json</a>
+    &mdash;
+    <span class="container">Rsteamshot::Screenshot</span>
+</ul>
+</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/lib/rsteamshot/app.rb

@@ -0,0 +1,213 @@
+module Rsteamshot
+  # Public: Represents a Steam app, like a video game. Used to fetch the screenshots
+  # that were taken in that app that Steam users have uploaded.
+  class App
+    # Public: Exception thrown by Rsteamshot::App#search when the given file is not a valid file
+    # containing Steam apps.
+    class BadAppsFile < StandardError; end
+
+    # Public: You can fetch this many screenshots at once.
+    MAX_PER_PAGE = 50
+
+    # Public: The API URL to get a list of apps on Steam.
+    APPS_LIST_URL = 'http://api.steampowered.com/ISteamApps/GetAppList/v2'
+
+    # Public: How to sort screenshots when they are being retrieved.
+    VALID_ORDERS = %w[mostrecent toprated trendday trendweek trendthreemonths
+                      trendsixmonths trendyear].freeze
+
+    # Public: Returns the ID of the Steam app as an Integer or String.
+    attr_reader :id
+
+    # Public: Returns the String name of the Steam app, or nil.
+    attr_reader :name
+
+    # Public: Writes a JSON file at the given location with the latest list of apps on Steam.
+    #
+    # path - a String file path
+    #
+    # Returns nothing.
+    def self.download_apps_list(path)
+      File.open(path, 'w') do |file|
+        IO.copy_stream(open(APPS_LIST_URL), file)
+      end
+    end
+
+    # Public: Find Steam apps by name.
+    #
+    # raw_query - a String search query for an app or game on Steam
+    # apps_list_path - a String file path to the JSON file produced by #download_apps_list
+    #
+    # Returns an Array of Rsteamshot::Apps.
+    def self.search(raw_query, apps_list_path)
+      return [] unless raw_query
+
+      unless apps_list_path
+        raise BadAppsFile, 'no path given to JSON apps list from Steam'
+      end
+
+      unless File.file?(apps_list_path)
+        raise BadAppsFile, "#{apps_list_path} is not a file"
+      end
+
+      json = begin
+        JSON.parse(File.read(apps_list_path))
+      rescue JSON::ParserError
+        raise BadAppsFile, "#{apps_list_path} is not a valid JSON file"
+      end
+
+      applist = json['applist']
+      unless applist
+        raise BadAppsFile, "#{apps_list_path} does not have expected JSON format"
+      end
+
+      apps = applist['apps']
+      unless apps
+        raise BadAppsFile, "#{apps_list_path} does not have expected JSON format"
+      end
+
+      query = raw_query.downcase
+      results = []
+      apps.each do |data|
+        next unless data['name']
+
+        if data['name'].downcase.include?(query)
+          results << new(id: data['appid'], name: data['name'])
+        end
+      end
+
+      results
+    end
+
+    # Public: Initialize a Steam app with the given attributes.
+    #
+    # attrs - the Hash of attributes for this app
+    #         :id - the String or Integer app ID
+    #         :name - the String name of the app
+    #         :per_page - how many results to get in each page; defaults to 10; valid range: 1-50;
+    #                     Integer
+    def initialize(attrs = {})
+      per_page = attrs.delete(:per_page)
+
+      attrs.each { |key, value| instance_variable_set("@#{key}", value) }
+
+      process_html = ->(html) do
+        cards_from(html).map { |card| screenshot_from(card) }
+      end
+      @paginator = ScreenshotPaginator.new(process_html, max_per_page: MAX_PER_PAGE,
+                                           per_page: per_page, steam_per_page: per_page)
+    end
+
+    # Public: Fetch a list of the newest uploaded screenshots for this app on Steam.
+    #
+    # order - String specifying which screenshots should be retrieved; choose from mostrecent,
+    #         toprated, trendday, trendweek, trendthreemonths, trendsixmonths, and trendyear;
+    #         defaults to mostrecent
+    # page - which page of results to fetch; defaults to 1; Integer
+    # query - a String of text for searching screenshots
+    #
+    # Returns an Array of Rsteamshot::Screenshots.
+    def screenshots(order: nil, page: 1, query: nil)
+      return [] unless id
+
+      url = steam_url(order, query, @paginator.per_page)
+      @paginator.screenshots(page: page, url: url)
+    end
+
+    private
+
+    def cards_from(html)
+      html.search('.apphub_Card')
+    end
+
+    def screenshot_from(card)
+      details_url = card['data-modal-content-url']
+      medium_url, full_size_url = urls_from(card)
+      title = title_from(card)
+      user_link = user_link_from(card)
+      user_name = if user_link
+        user_link.text.strip.gsub(/[[:space:]]\z/, '')
+      end
+      user_url = if user_link
+        user_link['href']
+      end
+      like_count = like_count_from(card)
+      comment_count = comment_count_from(card)
+      Screenshot.new(details_url: details_url, title: title, medium_url: medium_url,
+                     full_size_url: full_size_url, user_name: user_name,
+                     user_url: user_url, like_count: like_count, comment_count: comment_count)
+    end
+
+    def urls_from(card)
+      image = card.at('.apphub_CardContentPreviewImage')
+      return unless image
+
+      medium_url = image['src']
+      uri = URI.parse(medium_url)
+      full_size_url = "#{uri.scheme}://#{uri.host}#{uri.path}"
+
+      [medium_url, full_size_url]
+    end
+
+    def like_count_from(card)
+      card_rating = card.at('.apphub_CardRating')
+      return 0 unless card_rating
+
+      text = card_rating.text.strip.gsub(/[[:space:]]\z/, '')
+      if text.length > 0
+        text.to_i
+      else
+        0
+      end
+    end
+
+    def comment_count_from(card)
+      comments_el = card.at('.apphub_CardCommentCount')
+      return 0 unless comments_el
+
+      text = comments_el.text.strip.gsub(/[[:space:]]\z/, '')
+      if text.length > 0
+        text.to_i
+      else
+        0
+      end
+    end
+
+    def full_size_url_from(medium_url)
+      if medium_url =~ /\.resizedimage$/
+        size_part = medium_url.split('/').last # e.g., 640x359.resizedimage
+        medium_url.split(size_part).first
+      end
+    end
+
+    def user_link_from(card)
+      links = card.search('.apphub_CardContentAuthorBlock .apphub_CardContentAuthorName a')
+      links.last
+    end
+
+    def title_from(card)
+      title_el = card.at('.apphub_CardMetaData .apphub_CardContentTitle')
+      return unless title_el
+
+      title = title_el.text.strip.gsub(/[[:space:]]\z/, '')
+      title if title.length > 0
+    end
+
+    def steam_url(order, query, per_page)
+      params = [
+        "browsefilter=#{browsefilter_param(order)}",
+        "numperpage=#{per_page}"
+      ]
+      params << "searchText=#{URI.escape(query)}" if query
+      "http://steamcommunity.com/app/#{id}/screenshots/?" + params.join('&')
+    end
+
+    def browsefilter_param(order)
+      if VALID_ORDERS.include?(order)
+        order
+      else
+        VALID_ORDERS.first
+      end
+    end
+  end
+end