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

Benjamin Mako Hill || Want to submit a patch?