summaryrefslogtreecommitdiff
path: root/lib/sampling
diff options
context:
space:
mode:
Diffstat (limited to 'lib/sampling')
-rw-r--r--lib/sampling/README.md50
-rw-r--r--lib/sampling/double_blind.rb.bak35
-rw-r--r--lib/sampling/manual.html.erb31
-rw-r--r--lib/sampling/manual.rb62
-rw-r--r--lib/sampling/peer_review.html.erb28
-rw-r--r--lib/sampling/peer_review.rb91
-rw-r--r--lib/sampling/riot_api.rb207
7 files changed, 504 insertions, 0 deletions
diff --git a/lib/sampling/README.md b/lib/sampling/README.md
new file mode 100644
index 0000000..e4b3fbf
--- /dev/null
+++ b/lib/sampling/README.md
@@ -0,0 +1,50 @@
+Sampling interface
+==================
+
+Files in this directory should be _classes_ implementing the following
+interface:
+
+ - `self.works_with?(Game) => Boolean`
+
+ Returns whether or not this sampling method works with the
+ specified game.
+
+ - `self.can_get?(String setting_name) => Fixnum`
+
+ Returns whether or not this sampling method can get a specifed
+ statistic; 0 means 'false', positive integers mean 'true', where
+ higher numbers are higher priority.
+
+ - `self.uses_remote?() => Boolean`
+
+ Return whether or not this sampling method requires remote IDs for
+ users.
+
+ - `self.set_remote_name(User, Game, String)`
+
+ Set the remote ID for a user for the specified game. It is safe to
+ assume that this sampling method `works_with?` that game.
+
+ - `self.get_remote_name(Object)`
+
+ When given an object from `RemoteUsername#value`, give back a
+ human-readable/editable name to display
+
+----
+
+ - `initialize(Match)`
+
+ Construct new Sampling object for the specified match.
+
+ - `start()`
+
+ Begin fetching the statistics.
+
+ - `render_user_interaction(User) => String`
+
+ Returns HTML to render on a page.
+
+ - `handle_user_interaction(User, Hash params)`
+
+ Handles params from the form generated by
+ `#user_interaction_render`.
diff --git a/lib/sampling/double_blind.rb.bak b/lib/sampling/double_blind.rb.bak
new file mode 100644
index 0000000..6a30d57
--- /dev/null
+++ b/lib/sampling/double_blind.rb.bak
@@ -0,0 +1,35 @@
+module Sampling
+ module DoubleBlind
+ def self.works_with?(game)
+ return true
+ end
+
+ def can_get?(setting_name)
+ return 1
+ end
+
+ def self.uses_remote?
+ return false
+ end
+
+ def self.set_remote_name(user, game, value)
+ raise "This sampling method doesn't use remote usernames."
+ end
+
+ def self.get_remote_name(value)
+ raise "This sampling method doesn't use remote usernames."
+ end
+
+ def self.sampling_start(match, statistics)
+ # TODO
+ end
+
+ def self.render_user_interaction(match, user)
+ # TODO
+ end
+
+ def self.handle_user_interaction(match, user, sampling_params)
+ # TODO
+ end
+ end
+end
diff --git a/lib/sampling/manual.html.erb b/lib/sampling/manual.html.erb
new file mode 100644
index 0000000..2bbd6da
--- /dev/null
+++ b/lib/sampling/manual.html.erb
@@ -0,0 +1,31 @@
+<% if @tournament.hosts.include? @current_user %>
+ <fieldset><legend>Winner</legend>
+ <ul>
+ <% @match.teams.each do |team| %>
+ <li><label>
+ <input type="radio" name="manual[winner]" value="<%= team.id %>">
+ Team <%= team.id %>
+ </label></li>
+ <% end %>
+ </ul>
+ </fieldset>
+ <% @match.teams.each do |team| %>
+ <fieldset><legend>Statistics for Team <%= team.id %></legend>
+ <% team.users.each do |user| %>
+ <fieldset><legend><%= user.name %></legend>
+ <% @stats.reject{|s|s=="win"}.each do |stat| %>
+ <p>
+ <label>
+ <%= stat.titleize %>
+ <input type="numeric" name="manual[statistics][<%= user.id %>][<%= stat %>]">
+ </label>
+ </p>
+ <% end %>
+ </fieldset>
+ <% end %>
+ </fieldset>
+ <% end %>
+ <input type="submit", value="Finish match" >
+<% else %>
+ <p>The match is running; the host has yet to post the scores of the match.</p>
+<% end %>
diff --git a/lib/sampling/manual.rb b/lib/sampling/manual.rb
new file mode 100644
index 0000000..853516c
--- /dev/null
+++ b/lib/sampling/manual.rb
@@ -0,0 +1,62 @@
+module Sampling
+ class Manual
+ def self.works_with?(game)
+ return true
+ end
+
+ def self.can_get?(setting_name)
+ return 1
+ end
+
+ def self.uses_remote?
+ return false
+ end
+
+ def self.set_remote_name(user, game, value)
+ raise "This sampling method doesn't use remote usernames."
+ end
+
+ def self.get_remote_name(value)
+ raise "This sampling method doesn't use remote usernames."
+ end
+
+ ####
+
+ def initialize(match)
+ @match = match
+ end
+
+ def start
+ # do nothing
+ end
+
+ def render_user_interaction(user)
+ @tournament = @match.tournament_stage.tournament
+ @current_user = user
+ @stats = @match.stats_from(self.class)
+
+ require 'erb'
+ erb_filename = File.join(__FILE__.sub(/\.rb$/, '.html.erb'))
+ erb = ERB.new(File.read(erb_filename))
+ erb.filename = erb_filename
+ return erb.result(binding).html_safe
+ end
+
+ def handle_user_interaction(user, params)
+ # => Save sampling_params as statistics
+ if (@match.tournament_stage.tournament.hosts.include? user)
+ manual_params = params.require(:manual)
+ winner = Team.find(manual_params[:winner])
+ @match.users.each do |user|
+ Statistic.create(match: @match, user: user,
+ name: "win", value: winner.users.include?(user))
+ @match.stats_from(self.class).reject{|s|s=="win"}.each do |stat|
+ Statistic.create(match: @match, user: user,
+ name: stat, value: manual_params[:statistics][user.id][stat].to_i)
+ end # stats
+ end # users
+ end # permission
+ end # def
+
+ end
+end
diff --git a/lib/sampling/peer_review.html.erb b/lib/sampling/peer_review.html.erb
new file mode 100644
index 0000000..a0b9c4d
--- /dev/null
+++ b/lib/sampling/peer_review.html.erb
@@ -0,0 +1,28 @@
+<% if @feedbacks_missing.include? @user %>
+ <script type="text/javascript">
+ function score_peers() {
+ var list = $('ol#peer_review_boxes');
+ for(var i=0, var len=list.length; i < len; i++) {
+ if ( i == len-1) {
+ comma = "";
+ }
+ $('peer_review').value += $('ol#peer_review_boxes:eq(' + i + ')').text() + comma;
+ }
+ }
+ </script>
+ <input type="hidden" id="peer_review" name="peer_review" value="" />
+ <ol id="peer_review_boxes" class="sortable">
+ <% @team.users.reject{|u|u==@user}.each do |user| %><li>
+ <%= user.user_name %>
+ <br>
+ <%# TODO: display more statistics %>
+ </li><% end %>
+ </ol>
+ <input type="submit" value="Submit peer evaluation", onsubmit="score_peers()") >
+<% else %>
+ <p>Still waiting for peer feedback from the following users:
+ <ul><% @feedbacks_missing.each do |user| %>
+ <li><%= link_to user %></li>
+ <% end %></ul>
+ </p>
+<% end %>
diff --git a/lib/sampling/peer_review.rb b/lib/sampling/peer_review.rb
new file mode 100644
index 0000000..7faa241
--- /dev/null
+++ b/lib/sampling/peer_review.rb
@@ -0,0 +1,91 @@
+module Sampling
+ class PeerReview
+ def self.works_with?(game)
+ return true
+ end
+
+ def self.can_get?(setting_name)
+ return setting_name.start_with?("review_from_") ? 2 : 0
+ end
+
+ def self.uses_remote?
+ return false
+ end
+
+ def self.set_remote_name(user, game, value)
+ raise "This sampling method doesn't use remote usernames."
+ end
+
+ def self.get_remote_name(value)
+ raise "This sampling method doesn't use remote usernames."
+ end
+
+ ####
+
+ def initialize(match)
+ @match = match
+ end
+
+ def start
+ # do nothing
+ end
+
+ def render_user_interaction(user)
+ @user = user
+ @team = get_team(match)
+ @reviews_missing = get_reviews_missing(match)
+
+ require 'erb'
+ erb_filename = File.join(__FILE__.sub(/\.rb$/, '.html.erb'))
+ erb = ERB.new(File.read(erb_filename))
+ erb.filename = erb_filename
+ return erb.result(binding).html_safe
+ end
+
+ def handle_user_interaction(reviewing_user, params)
+ i = 0
+ params[:peer_review].to_s.split(',').each do |user_name|
+ reviewed_user = User.find_by_user_name(user_name)
+ reviewed_user.statistics.create(match: @match, name: "review_from_#{reviewing_user.user_name}", value: i)
+ i += 1
+ end
+ end
+
+ private
+
+ def self.get_users(match)
+ users = []
+ match.teams.each{|t| users.concat(t.users)}
+ return users
+ end
+
+ def self.get_team(match)
+ match.teams.find{|t|t.users.include?(@user)}
+ end
+
+ def self.get_reviews(match)
+ ret = {}
+ match.statistiscs.where("'name' LIKE 'review_from_%'").each do |statistic|
+ ret[statistic.user] ||= {}
+ ret[statistic.user][User.find_by_user_name(statistic.name.sub(/^review_from_/,''))] = statistic.value
+ end
+ return ret
+ end
+
+ def self.get_reviews_missing(match)
+ require 'set'
+ ret = Set.new
+
+ review = get_reviews(match)
+ users = get_users(match)
+
+ review.each do |review|
+ (users - review.keys).each do |user|
+ ret.add(user)
+ end
+ end
+
+ return ret
+ end
+ end
+end
diff --git a/lib/sampling/riot_api.rb b/lib/sampling/riot_api.rb
new file mode 100644
index 0000000..4e72f91
--- /dev/null
+++ b/lib/sampling/riot_api.rb
@@ -0,0 +1,207 @@
+module Sampling
+ class RiotApi
+ protected
+ def self.api_name
+ "prod.api.pvp.net/api/lol"
+ end
+
+ protected
+ def self.api_key
+ ENV["RIOT_API_KEY"]
+ end
+
+ protected
+ def self.region
+ ENV["RIOT_API_REGION"]
+ end
+
+ protected
+ def self.url(request, args={})
+ "https://prod.api.pvp.net/api/lol/#{region}/#{request % args.merge(args){|k,v|url_escape(v)}}?api_key=#{api_key}"
+ end
+
+ protected
+ def self.url_escape(string)
+ URI::escape(string.to_s, /[^a-zA-Z0-9._~!$&'()*+,;=:@-]/)
+ end
+
+ protected
+ def self.standardize(summoner_name)
+ summoner_name.to_s.downcase.gsub(' ', '')
+ end
+
+ protected
+ def self.stats_available
+ ["win", "numDeaths", "turretsKilled", "championsKilled", "minionsKilled", "assists"]
+ end
+
+ protected
+ class Job < ThrottledApiRequest
+ def initialize(request, args={})
+ @url = Sampling::RiotApi::url(request, args)
+ limits = [
+ {:unit_time => 10.seconds, :requests_per => 10},
+ {:unit_time => 10.minutes, :requests_per => 500},
+ ]
+ super(RiotApi::api_name, limits)
+ end
+
+ def perform
+ response = open(@url)
+ status = response.status
+ data = JSON::restore(response.read)
+
+ # Error codes that RIOT uses:
+ # "400"=>"Bad request"
+ # "401"=>"Unauthorized"
+ # "429"=>"Rate limit exceeded"
+ # "500"=>"Internal server error"
+ # "503"=>"Service unavailable"
+ # "404"=>"Not found"
+ # Should probably handle these better
+ if status[0] != "200"
+ raise "GET #{@url} => #{status.join(" ")}"
+ end
+ return self.handle(data)
+ end
+
+ def handle(data)
+ return true
+ end
+ end
+
+ ########################################################################
+
+ ##
+ # Return whether or not this sampling method works with the specified game.
+ # Spoiler: It only works with League of Legends (or subclasses of it).
+ public
+ def self.works_with?(game)
+ if api_key.nil? or region.nil?
+ return false
+ end
+ if game.name == "League of Legends"
+ return true
+ end
+ unless game.parent.nil?
+ return works_with?(game.parent)
+ end
+ end
+
+ ##
+ # Return whether or not the API can get a given statistic for
+ # a given user.
+ public
+ def self.can_get?(stat)
+ if stats_available.include?(stat)
+ return 2
+ else
+ return 0
+ end
+ end
+
+ ##
+ # This sampling method uses remote IDs
+ public
+ def self.uses_remote?
+ return true
+ end
+
+ ##
+ # When given a summoner name for a user, figure out the summoner ID.
+ public
+ def self.set_remote_name(user, game, summoner_name)
+ Delayed::Job.enqueue(UsernameJob.new(user, game, summoner_name), :queue => RiotApi::api_name)
+ end
+ protected
+ class UsernameJob < Job
+ def initialize(user, game, summoner_name)
+ @user_id = user.id
+ @game_id = game.id
+ # Escape any funny stuff
+ summoner_names = [summoner_name].map{|name|Sampling::RiotApi::standardize(name.gsub(',',''))}
+ # Generate the request
+ super("v1.3/summoner/by-name/%{summonerNames}", { :summonerNames => summoner_names.join(",") })
+ end
+ def handle(data)
+ user = User.find(@user_id)
+ game = Game.find(@game_id)
+
+ standardized_summoner_name = data.keys.first
+ remote_data = {
+ :id => data[standardized_summoner_name]["id"],
+ :name => data[standardized_summoner_name]["name"],
+ }
+
+ user.set_remote_username(game, remote_data)
+ end
+ end
+
+ ##
+ # When given data from RemoteUsername#value, give back a readable name to display.
+ # Here, this is the summoner name.
+ public
+ def self.get_remote_name(data)
+ data["name"]
+ end
+
+ ####
+
+ public
+ def initialize(match)
+ @match = match
+ end
+
+ ##
+ # Fetch all the statistics for a match.
+ public
+ def start
+ @match.teams.each do |team|
+ team.users.each do |user|
+ #For demo purposes, we are hard coding in a league of legends game id.
+ Delayed::Job.enqueue(FetchStatisticsJob.new(user, @match, @match.stats_from(self.class), 10546), :queue => RiotApi::api_name)
+ end
+ end
+ end
+ protected
+ class FetchStatisticsJob < Job
+ def initialize(user, match, stats, last_game_id)
+ @user_id = user.id
+ @match_id = match.id
+ @stats = stats
+ @last_game_id = last_game_id
+
+ # Get the summoner id
+ summoner = user.get_remote_username(match.tournament_stage.tournament.game)
+ # Generate the request
+ super("v1.3/game/by-summoner/%{summonerId}/recent", { :summonerId => summoner["id"] })
+ end
+ def handle(data)
+ user = User.find(@user_id)
+ match = Match.find(@match_id)
+ if @last_game_id.nil?
+ Delayed::Job.enqueue(FetchStatisticsJob.new(user, match, data["games"][0]["gameId"]), :queue => RiotApi::api_name)
+ else
+ if @last_game_id == data["games"][0]["gameId"]
+ sleep(4.minutes)
+ Delayed::Job.enqueue(FetchStatisticsJob.new(user, match, @last_game_id), :queue => RiotApi::api_name)
+ else
+ @stats.each do |stat|
+ Statistic.create(user: user, match: match, name: stat, value: data["games"][0]["stats"][stat])
+ end
+ end
+ end
+ end
+ end
+
+ public
+ def render_user_interaction(user)
+ return ""
+ end
+
+ public
+ def handle_user_interaction(user)
+ # do nothing
+ end
+ end
+end
generated by cgit v1.1-4-g5e80 at 2024-06-01 20:19:44 +0000