Side by Side Diff: sitescripts/urlfixer/README.md
Issue 8626108:
Added /resetScore, /refreshScore and /showScore features to URL Fixer server-side (Closed)
Patch Set:
Created Oct. 22, 2012, 4:08 p.m.
| Left: | ||
| Right: |
Use n/p to move between diff chunks;
N/P to move between comments.
« no previous file with comments
|
« no previous file
|
sitescripts/urlfixer/template/showScores.html » ('j')
|
no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
| OLD | NEW |
|---|---|
| 1 urlfixer | 1 urlfixer |
| 2 ======== | 2 ======== |
| 3 | 3 |
| 4 Backend for the URL Fixer data collection. It provides the following URLs: | 4 Backend for the URL Fixer data collection. It provides the following URLs: |
| 5 | 5 |
| 6 * */refreshScores* - Calculate scores and update scores in database | |
| 7 * */resetScores* - Reset counts after each month / year | |
| 8 * */showScores* - Show data from URL Fixer extension | |
| 6 * */submitData* - Receive data from URL Fixer extension | 9 * */submitData* - Receive data from URL Fixer extension |
| 7 | 10 |
| 8 Required packages | 11 Required packages |
| 9 ----------------- | 12 ----------------- |
| 10 | 13 |
| 11 * [simplejson](http://pypi.python.org/pypi/simplejson/) | 14 * [simplejson](http://pypi.python.org/pypi/simplejson/) |
| 12 | 15 |
| 13 Database setup | 16 Database setup |
| 14 -------------- | 17 -------------- |
| 15 | 18 |
| 16 Just execute the statements in _schema.sql_. | 19 Just execute the statements in _schema.sql_. |
| 17 | 20 |
| 18 Configuration | 21 Configuration |
| 19 ------------- | 22 ------------- |
| 20 | 23 |
| 21 Add an _urlfixer_ section to _/etc/sitescripts_ or _.sitescripts_ and configure the following keys: | 24 Add an _urlfixer_ section to _/etc/sitescripts_ or _.sitescripts_ and configure the following keys: |
| 22 | 25 |
| 23 * _database_ | 26 * _database_ |
| 24 * _dbuser_ | 27 * _dbuser_ |
| 25 * _dbpassword_ | 28 * _dbpassword_ |
| 29 * _basic\_auth\_realm_ | |
| 30 * _basic\_auth\_username_ | |
| 31 * _basic\_auth\_password_ | |
| 32 * _template_ | |
| 26 | 33 |
| 27 Data transfer format | 34 Data transfer format |
| 28 ---------------------------- | 35 ---------------------------- |
| 29 | 36 |
| 30 A domain transfered to the server can have one of the following types: | 37 A domain transfered to the server can have one of the following types: |
| 31 | 38 |
| 32 * 1: the domain was entered without any further action | 39 * 1: the domain was entered without any further action |
| 33 * 2: the domain was recognized as a typo | 40 * 2: the domain was recognized as a typo |
| 34 * 3: the domain is a correction that the user accepted | 41 * 3: the domain is a correction that the user accepted |
| 35 * 4: the domain is a correction that the user declined | 42 * 4: the domain is a correction that the user declined |
| 36 | 43 |
| 37 The server expects the list to be transfered as a JSON object in no particular o rder. Here is an example: | 44 The server expects the list to be transfered as a JSON object in no particular o rder. Here is an example: |
| 38 | 45 |
| 39 ```js | 46 ```js |
| 40 { | 47 { |
| 41 "urlfixer.org": 1, | 48 "urlfixer.org": 1, |
| 42 "adblockplus,org": 2, | 49 "adblockplus,org": 2, |
| 43 "adblockplus.org": 3, | 50 "adblockplus.org": 3, |
| 44 "goggle.com": 1, | 51 "goggle.com": 1, |
| 45 "google.com": 4 | 52 "google.com": 4 |
| 46 } | 53 } |
| 47 ``` | 54 ``` |
| OLD | NEW |
« no previous file with comments
|
« no previous file
|
sitescripts/urlfixer/template/showScores.html » ('j')
|
no next file with comments »
