Improve consistency of XMLRPC error reporting. Now, all error conditions will raise...
authorJohn Dong <jdong@mit.edu>
Fri, 17 Aug 2007 23:16:34 +0000 (19:16 -0400)
committerJohn Dong <jdong@mit.edu>
Fri, 17 Aug 2007 23:16:34 +0000 (19:16 -0400)
app/apis/selectricity_api.rb
app/models/selectricity_service.rb

index dfc9946832e7c8b3fbf5c799e9afe1527b88653b..9c95369d9a798917ee68babb9d2f578c0a6b3b04 100644 (file)
@@ -19,12 +19,10 @@ class VoteResultStruct < ActionWebService::Struct
   member :condorcet_winners, [:int]
   member :ssd_winners, [:int]
   member :borda_winners, [:int]
-  member :errors, [:string]
 end
 class CandidateMap < ActionWebService::Struct
   member :candidate_ids, [:int]
   member :candidate_names, [:string]
-  member :errors, [:string]
 end
 class SelectricityAPI < ActionWebService::API::Base
   api_method :cast_quickvote, :expects => [:string, :int, [[:int]]], :returns => [:string]
index add8154ed31df51b025f99d2c33234cd7b7dea80..196161a467ea2bcfb25f5be2f5cb3d22c6123e21 100644 (file)
@@ -28,7 +28,7 @@ class SelectricityService < ActionWebService::Base
   def quickvote_candidate_ids_to_names(shortname, id_list)
     qv=QuickVote.ident_to_quickvote(shortname)
     candidates={}
-    return [] unless qv
+    raise ArgumentError.new("Quickvote by name #{shortname} doesn't exist") unless qv
     qv.results
     qv.candidates.each {|c| candidates[c.id] = c}
     results=[]
@@ -46,10 +46,8 @@ class SelectricityService < ActionWebService::Base
     #TODO: Validate shortname
     qv=QuickVote.ident_to_quickvote(shortname)
     result=VoteResultStruct.new
-    result.errors=[]
     unless qv
-      result.errors << "No quickvote with name #{shortname} found!"
-      return result
+      raise ArgumentError.new("No quickvote with name #{shortname} found!")
     end
     qv.results
     result.plurality_winners=qv.plurality_result.winners
@@ -62,10 +60,8 @@ class SelectricityService < ActionWebService::Base
   def get_quickvote_candidate_map(shortname)
     qv=QuickVote.ident_to_quickvote(shortname)
     result=CandidateMap.new
-    result.errors=[]
     unless qv
-      result.errors << "No quickvote with name #{shortname} found!"
-      return result
+      raise ArgumentError.new("No quickvote with name #{shortname} found!")
     end
     candidates={}
     qv.candidates.each {|c| candidates[c.id] = c.name}
@@ -77,7 +73,7 @@ class SelectricityService < ActionWebService::Base
     qv=QuickVote.ident_to_quickvote(shortname)
     votes=Array.new
     unless qv
-      return result
+      raise ArgumentError.new("Cannot find QuickVote #{shortname}")
     end
     qv.votes.each  do |vote|
       votes << VoteInfo.new(:voter_id => vote.voter.id, :voter_ipaddress => vote.voter.ipaddress, :vote_time => vote.time.to_i, :vote => vote.votes, :voter_session_id => vote.voter.session_id )
@@ -92,7 +88,7 @@ class SelectricityService < ActionWebService::Base
     return all
   end
   def get_quickvote(shortname)
-    return ElectionStruct.new unless election=QuickVote.ident_to_quickvote(shortname)
+    raise ArgumentError.new("Cannot find QuickVote named #{shortname}") unless election=QuickVote.ident_to_quickvote(shortname)
     return ElectionStruct.new(:id => election.id, :name => election.name, :description => election.description, :candidate_ids => election.candidates.collect {|c| c.id }, :candidate_names => election.candidates.collect {|c| c.name } )
   end
   def create_quickvote(election)
@@ -101,7 +97,7 @@ class SelectricityService < ActionWebService::Base
     if qv.save
       return ""
     else
-      return "Saving quickvote FAILED:"+qv.errors.inspect
+      raise ArgumentError.new("Saving quickvote FAILED:"+qv.errors.inspect)
     end
   end
 

Benjamin Mako Hill || Want to submit a patch?