class SelectricityService < ActionWebService::Base
web_service_api SelectricityAPI
+
+ ## Casts a quickvote.
+ ## Expects a quickvote name, a voter ID, and a list of candidate ID's respectively.
+ ## Returns a string containing any potential errors that occurred in the process.
def cast_quickvote(election_name, voter_id, vote_list)
election = QuickVote.ident_to_quickvote election_name
if election
raise ArgumentError.new("Cannot find election #{election_name}")
end
end
+
+ ## Converts QuickVote candidate ID's to names
+ ## Takes in a QuickVote name and a list of candidate ID's, and returns the names of
+ ## each candidate. Useful for doing just a few lookups; it's more efficient to use
+ ## get_quickvote_candidate_map for presenting info about an entire election.
def quickvote_candidate_ids_to_names(shortname, id_list)
qv=QuickVote.ident_to_quickvote(shortname)
candidates={}
}
results
end
+
+ ## Return the results of a QuickVote.
+ ## Takes in the name of a quickvote, and returns a structure as described by
+ ## QuickVoteResultStruct
def get_quickvote_results(shortname)
#TODO: Validate shortname
qv=QuickVote.ident_to_quickvote(shortname)
result.borda_winners=qv.borda_result.winners
result
end
+
+ ## Returns information regarding all the candidates in a QuickVote
+ ## Takes in a QuickVote name, and returns the list of names and ID's of candidates
+ ## This can be useful for presenting the user with a list of readable names, while
+ ## the software sends results to us in the numeric ID's we require. The two lists are in
+ ## respective order.
def get_quickvote_candidate_map(shortname)
qv=QuickVote.ident_to_quickvote(shortname)
result=QuickVoteCandidateMap.new
result
end
+ ## Get information on all the votes cast in a QuickVote
+ ## Takes in the name of a QuickVote, returns an array of QuickVoterInfo structures.
def get_quickvote_votes(shortname)
qv = QuickVote.ident_to_quickvote(shortname)
end
end
+ ## Gets a list of all QuickVotes in the system.
def list_quickvotes()
QuickVote.find(:all).collect do |election|
get_quickvote(election.name)
end
end
+ ## Gets information on a particular QuickVote
+ ## Takes in a QuickVote name
def get_quickvote(shortname)
unless election = QuickVote.ident_to_quickvote(shortname)
raise ArgumentError.new("Cannot find QuickVote named #{shortname}")
:candidate_names => election.candidates.collect {|c| c.name } )
end
+ ## Create a QuickVote
+ ## Pass in a QuickVoteStruct populated with all the fields but the candidate ID's
+ ## Any candidate ID's you fill in will be ignored anyway.
def create_quickvote(election)
qv = QuickVote.new(:name => election.name,
:description => election.description)
--- /dev/null
+<html>
+ <link rel="stylesheet" type="text/css" href="stylesheets/main.css" />
+ <div id="top">
+ <h3>Selectricity XML-RPC<br />
+ <font size="-1">Voting Machinery <em>By the Machinery, for the Machinery</em></font></h3>
+</div>
+
+
+<p>Selectricity has a fully functional XML-RPC interface so that you can
+interface your own application with Selectricity. This API is documented in
+the doc/ subdirectry, under the class <b>SelectricityService</b>. </p>
+
+<h2>Usage</h2>
+
+<p>The XML-RPC service runs at <em>/selectricity_service/vote</em> of the server.
+All of the available methods are documented both below and in the RubyDoc
+generated documentation. <br> </p>
+
+<div class="warning">
+<h4>Important Note</h4> <p>Please note that the Rails framework automatically
+changes the case of a method name by capitalizing words separated by an
+underscore. For example, if you see <em>this_method_name</em>, the actual method
+name you need to call is actually <em>ThisMethodName</em>. </p>
+</div>
+
+<div class="example">
+<h4>Example PHP Script</h4>
+<p>Here is a short PHP script that calls the Selectricity Service to output all
+active QuickVotes to a table. It assumes that you have the samples/utils folder
+from <a href=http://xmlrpc-epi.sourceforge.net/main.php?t=php_about>The PHP
+ XML-RPC Library</a> installed to utils/ in the include path.
+
+</p>
+<blockquote>
+<pre>
+<?
+include("utils/utils.php");
+
+$host="192.168.195.1";
+$uri="/selectricity_service/vote";
+$result = xu_rpc_http_concise(
+ array(
+ 'method' => "ListQuickvotes",
+ 'host' => $host,
+ 'uri' => $uri,
+ 'port' => 3000
+ )
+);
+echo "<table border=1>\n";echo "<tr><th>Name</th>
+<th>Description</th><th>ID</th>
+<th>Candidates</th></tr>\n";
+foreach($result as $i)
+{
+
+ echo "<tr><td>";
+ echo $i['name'];
+ echo "</td><td>";
+ echo $i['description'];
+ echo "</td><td>";
+ echo $i['id'];
+ echo "</td><td>";
+ foreach($i['candidate_names'] as $cand)
+ {
+ echo $cand . ", ";
+ }
+ echo "</td></tr>";
+}
+echo "</table>"
+
+
+?>
+</pre>
+</blockquote>
+</div>
+
+<hr />
+<p><font size="-1">Copyleft 2006 ::
+<a href="http://www.media.mit.edu">MIT Media Lab</a> and
+<a href="http://mako.cc">Benjamin Mako Hill</a></font></p>
+</html>
projects / selectricity / commitdiff