https://github.com/mscoutermarsh/contestant-poll

Vote tracking API - With simple math authentication
https://github.com/mscoutermarsh/contestant-poll

Last synced: about 1 month ago
JSON representation

Vote tracking API - With simple math authentication

• Host: GitHub
• URL: https://github.com/mscoutermarsh/contestant-poll
• Owner: mscoutermarsh
• Created: 2012-01-14T15:43:17.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2012-02-24T05:13:01.000Z (almost 13 years ago)
• Last Synced: 2024-10-12T19:25:05.630Z (2 months ago)
• Language: Ruby
• Homepage:
• Size: 266 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
Contestant Poll API

===========================

An API for tracking votes. To limit cheating, instead of using a captcha, use simple math!  

  

### **See it running on Heroku:** [HTML/JavaScript Implementation](http://voteAPI.heroku.com/vote.html "voteAPI")    

1. Vote is created

2. API asks a simple math question (What's 2+2?)

3. If user answers correctly. Vote is counted in poll.

**Setup:** Before running you must setup a couple environment variables:

1. Define ENV variable `VOTECONN`. This is the connection string to your database.

2. *Optional:* Define ENV variable `ALLOW_REF` with the domain you want to limit requests from.

 + **Example:** `ALLOWED_REF=voteAPI.heroku.com` will only allow record votes if the referer is from the specified domain. This will stop someone from hitting the API from another domain.

API Documentation

============================

POST

----

### Create a new Vote

`Post: http://localhost:4567/vote/:contestant`

Creates a new vote. Returns json containing the ID and the simple math problem.

Response:  

`{"question":"What is 4+3?","id":"96"}`

After recieving this response, you must confirm the vote by answering the question (What is 4+3?).

### Confirm Vote

`Post: http://localhost:4567/confirm/:id/:answer`

**Post:** ID and answer to question.

If correct: the vote will be valid and counted.  

`{"message":"Thanks for voting!"}`

If incorrect: error message will be returned.  

`{"message":"Oops, wrong answer."}`

GET

----

### Get count of votes

`Get: http://localhost:4567/votes/:contestant`

Returns number of validated votes for a contestant.

Response:  

`{"votes":"21"}`

Things to do

============================

+ Clean up JavaScript for example implementation.

+ Record header information for the user. This could be used to filter out cheating beyond just IP.