projects.mako.cc - selectricity-live/blob - README

   1 ===============================================
   2 === Depedendencies ============================
   3 ===============================================
   4
   5 To use Selectricity, you'll need to install the following gems in
   6 addition to rails and its dependencies:
   7
   8  * rmagick
   9  * gruff
  10
  11 To use Selectricity in development mode, you'll need to install the
  12 following gems:
  13
  14  * ruby-debug
  15
  16 Also, you will need install the other applications installed first:
  17
  18  * imagemagick (http://www.imagemagick.org/)
  19
  20 On Ubuntu, you can install install the dependencies with:
  21   apt-get install imagemagick libmagick9-dev ruby1.8-dev libwmf-bin
  22
  23
  24 ===============================================
  25 === Contributors to Selectricity Include ======
  26 ===============================================
  27
  28  * Benjamin Mako Hill <mako@atdot.cc>
  29  * John Dong          <jdong@ubuntu.com>
  30  * Justin Sharps      <jlsharps@mit.edu>
  31
  32 ===============================================
  33 === Log =======================================
  34 ===============================================
  35
  36 07/31/07
  37 jlsharps: I've added a user authentication system known as
  38 "acts_as_authenticated" to the code. The plugin is the the vendor/plugins
  39 directory. The two most noticeable changes are the AccountController and a
  40 redone User model. I've left the UserController in place for now, but the
  41 AccountController works in a different manner, so am switching over to that
  42 gradually. I saved the 5 lines or so in the old User model, overwrote
  43 it with the authenticated generator and then recopied the old stuff back in:
  44 has_many :elections and the name() method. The generator also creates its own
  45 migration file, but since we are using a create.sql file I adopted the
  46 migration file into a new users table in the create.sql file. I have yet to
  47 delete the old table because I haven't fully combed through the code yet and
  48 determined how many of the old attributes (such as first_name, last_name) may
  49 need to be retained.
  50 http://technoweenie.stikipad.com/plugins/show/Acts+as+Authenticated is the
  51 best site for documentation regarding acts_as_authenticaed. Also, currently
  52 it only stores the user_id in the session, but i just found a guide to help
  53 me make it store the entire user object, so I'll do that while my battery
  54 charges.
  55
  56 08/03/07
  57 Handy trick: use the command 'gem_server' from a shell to create a server at
  58 http://localhost:8008 that is an easy to navigate locally-hosted website with
  59 all the documentation on local gems you have in a easy to read format.
  60
  61 jlsharps: I added the Gruff plug-in today, which is viewable under the folder
  62 vender/plugins/gruff.  I installed it directly using the Gruff plug-in and
  63 included controller generate utility. The version 0.1.2, which doesn't seem to
  64 be the latest version. I've looked into it and it see and it seems that the
  65 latest version is 0.2.8. However, I wasn't sure how including a gem w/o a plugin
  66 would function in end-game rails so I just what I used for now. If you guys
  67 (mako of john) know how to do it, it'd probably be better to upgrade, but it
  68 didn't seem like the best use of my time right now.  I got the plug-in here:
  69 http://topfunky.net/svn/plugins/gruff. You can get the gruff gem v 0.2.8 by
  70 typing "sudo gem install gruff", I believe it's also hosted on RubyForge.
  71
  72 I created the GraphsController for Gruff methods to use. In Pollarize I put them
  73 in the ApplicationContorller file, so they would be accessible to all. While
  74 that it also an option here, it would also mean there wouldn't be much room for
  75 playing around because everything in the Application file has to be perfect or
  76 it seems to throw Error Code 500 (basically everything breaks). The show()
  77 is a sample sample provided with Gruff.
  78
  79 Documentation is here:http://gruff.rubyforge.org/  Alternately, if you have the
  80 gem installed, you can use the ri command, or the above mentioned gem_server.
  81
  82 If you guys want more helpful stuff here, let me know.
  83
  84 ======================================
  85 === XML-RPC INFO                    ==
  86 ======================================
  87
  88 The XML-RPC API is still under development, but is somewhat functional already:
  89
  90 To instantiate a client in Ruby, try something like:
  91 client=ActionWebService::Client::XmlRpc.new(SelectricityAPI,"http://localhost:3000/selectricity_service/vote")
  92
  93
  94 Getting the results of a quickvote is quite simple:
  95 ?> client.get_quickvote_results("test")
  96 => #<VoteResultStruct:0x336f92c @approval_winners=[1, 2], @borda_winners=[1], @plurality_winners=[1], @ssd_winners=[1], @errors=[], @condorcet_winners=[1]>
  97
  98 Casting a quickvote:
  99 client.cast_quickvote("test",1,[[1,2]])
 100
 101 To figure out what you're voting for:
 102 >> client.get_quickvote_candidate_map("test")=> #<CandidateMap:0x335bbc0 @errors=[], @candidate_names=["test", "test2"], @candidate_ids=[1, 2]>
 103
 104
 105
 106
 107