From: John Dong Date: Wed, 29 Aug 2007 17:13:26 +0000 (-0400) Subject: Merge jdong X-Git-Url: https://projects.mako.cc/source/selectricity-live/commitdiff_plain/9347f6bd316ab609f4b780658855e52e7937e5a6?hp=231fff75403a90305cae12be7643cc4c0dbbebbc Merge jdong --- diff --git a/app/models/selectricity_service.rb b/app/models/selectricity_service.rb index a3de89f..f5e7457 100644 --- a/app/models/selectricity_service.rb +++ b/app/models/selectricity_service.rb @@ -2,6 +2,10 @@ require 'action_controller/integration' 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 @@ -25,6 +29,11 @@ class SelectricityService < ActionWebService::Base 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={} @@ -42,6 +51,10 @@ class SelectricityService < ActionWebService::Base } 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) @@ -57,6 +70,12 @@ class SelectricityService < ActionWebService::Base 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 @@ -70,6 +89,8 @@ class SelectricityService < ActionWebService::Base 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) @@ -86,12 +107,15 @@ class SelectricityService < ActionWebService::Base 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}") @@ -105,6 +129,9 @@ class SelectricityService < ActionWebService::Base :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) diff --git a/public/selectricity-xmlrpc.html b/public/selectricity-xmlrpc.html new file mode 100644 index 0000000..857ef91 --- /dev/null +++ b/public/selectricity-xmlrpc.html @@ -0,0 +1,80 @@ + + +
+

Selectricity XML-RPC
+ Voting Machinery By the Machinery, for the Machinery

+
+ + +

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 SelectricityService.

+ +

Usage

+ +

The XML-RPC service runs at /selectricity_service/vote of the server. +All of the available methods are documented both below and in the RubyDoc +generated documentation.

+ +
+

Important Note

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 this_method_name, the actual method +name you need to call is actually ThisMethodName.

+
+ +
+

Example PHP Script

+

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 The PHP + XML-RPC Library installed to utils/ in the include path. + +

+
+
+<?
+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>"
+
+
+?>
+
+
+
+ +
+

Copyleft 2006 :: +MIT Media Lab and +Benjamin Mako Hill

+