魔豆路由器应用商店

Design Guideline

Follow Guidelines extracted from Heroku Platform API

APIs

For latest API definitions, please refer to app_store_server.rb

list all apps

GET /apps

$ http get appstore.ly.md/apps/all?track=stable

Output:

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Connection: keep-alive
Content-Length: 4137
Content-Type: application/json
Date: Tue, 19 Aug 2014 08:50:28 GMT
Server: Cowboy
Status: 200 OK
Via: 1.1 vegur
X-Content-Type-Options: nosniff

[
    {
        "author": "魔豆开发团队-junjian",
        "available": true,
        "description": "简单完成新老路由器的交接工作",
        "display_name": "PPPoE账号迁移助手",
        "email": "[email protected]",
        "homepage": "www.modouwifi.com",
        "icon": "./res/icon.png",
        "icon_url": "http://appstore.ly.md/apps/icons?appname=pppoe-migration-assistant",
        "install_location": "internal",
        "instructions": "1.xxxx; 2.xxxxx",
        "md5_sum": "fbc54da61c5d59f589b8179bc90cf194",
        "name": "pppoe-migration-assistant",
        "package_id": "com.modouwifi.pppoecatch",
        "release_date": "2014.08.11",
        "require_os_version": "0.6.12",
        "size": 52330,
        "updated_at": "2014-09-01T03:23:37Z",
        "url": "http://appstore.ly.md/apps/download?appname=pppoe-migration-assistant",
        "version": "0.2.1"
    },
    {
        "author": "魔豆开发团队",
        "available": true,
        "description": "使用此应用可以开启或关闭魔豆屏幕的背光自动熄灭功能",
        "display_name": "背光控制",
        "email": "[email protected]",
        "homepage": "www.modouwifi.com",
        "icon": "./appicon_backlight_normal.png",
        "icon_url": "http://appstore.ly.md/apps/icons?appname=backlight-control",
        "install_location": "internal",
        "instructions": "开启应用后就两个按钮，简单明了",
        "md5_sum": "31330db8ad82d974cec2278d34ccd9a6",
        "name": "backlight-control",
        "package_id": "com.modouwifi.backlight-control",
        "release_date": "2014.08.18",
        "require_os_version": "0.6.17",
        "size": 3657,
        "updated_at": "2014-09-01T03:23:36Z",
        "url": "http://appstore.ly.md/apps/download?appname=backlight-control",
        "version": "0.2"
    },
// more here...
]

list available apps by criteria

GET /apps/all?track=[stable|main]

$ http get 'appstore.ly.md/apps/all?track=stable'

params format

params	format	example
track	[stable] or [main]	stable

All params are optional

get info of a certain app

GET /apps/single?appname=APPNAME

$ http get appstore.ly.md/apps/single?appname=app-ss-vpn

Output:

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Connection: keep-alive
Content-Length: 508
Content-Type: application/json
Date: Tue, 19 Aug 2014 08:57:38 GMT
Server: Cowboy
Status: 200 OK
Via: 1.1 vegur
X-Content-Type-Options: nosniff

{
    "author": "魔豆路由器",
    "available": true,
    "description": "科学上网",
    "display_name": "科学上网",
    "email": "[email protected]",
    "homepage": "www.modouwifi.com",
    "icon": "./res/icon_111X111.png",
    "icon_url": "http://appstore.ly.md/apps/icons?appname=hdns",
    "install_location": "internal",
    "instructions": null,
    "md5_sum": "8f06cbeca5ed5b6225e95dbc760851f0",
    "name": "hdns",
    "package_id": "com.modouwifi.hdns",
    "release_date": "2014.08.18",
    "require_os_version": null,
    "size": 13259,
    "updated_at": "2014-09-01T03:23:36Z",
    "url": "http://appstore.ly.md/apps/download?appname=hdns",
    "version": "0.4.4"
}

download a certain app

GET /apps/download?appname=APPNAME

$ http get appstore.ly.md/apps/download?appname=app-ss-vpn

Output:

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Connection: keep-alive
Content-Disposition: attachment; filename="hdns-0.4.4.mpk"
Content-Length: 13259
Content-Type: application/octet-stream
Date: Tue, 19 Aug 2014 08:58:01 GMT
Last-Modified: Tue, 19 Aug 2014 08:43:15 GMT
Server: Cowboy
Status: 200 OK
Via: 1.1 vegur
X-Content-Type-Options: nosniff



+-----------------------------------------+
| NOTE: binary data not shown in terminal |
+-----------------------------------------+

get icon of a certain app

GET /apps/icon?appname=APPNAME

$ http get appstore.ly.md/apps/icon?appname=APPNAME

Output:

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Connection: keep-alive
Content-Disposition: inline; filename="wps-0.4.png"
Content-Length: 1672
Content-Type: image/png
Date: Tue, 19 Aug 2014 08:58:47 GMT
Last-Modified: Tue, 19 Aug 2014 08:43:15 GMT
Server: Cowboy
Status: 200 OK
Via: 1.1 vegur
X-Content-Type-Options: nosniff



+-----------------------------------------+
| NOTE: binary data not shown in terminal |
+-----------------------------------------+

Service Benchmark

Throughput 500 requests per second, or 20,000 requests per minute.

benchmark with command

$ ab -n 2000 -c 200 http://appstore.ly.md/apps/all

Output:

Server Software:        Cowboy
Server Hostname:        appstore.ly.md
Server Port:            80

Document Path:          /apps
Document Length:        4137 bytes

Concurrency Level:      200
Time taken for tests:   3.733 seconds
Complete requests:      2000
Failed requests:        0
Write errors:           0
Total transferred:      8722000 bytes
HTML transferred:       8274000 bytes
Requests per second:    535.82 [#/sec] (mean)
Time per request:       373.263 [ms] (mean)
Time per request:       1.866 [ms] (mean, across all concurrent requests)
Transfer rate:          2281.92 [Kbytes/sec] received

Connection Times (ms)
              min  mean[+/-sd] median   max
Connect:       72   74   1.4     74      80
Processing:   114  265  77.3    250     824
Waiting:      114  262  71.7    249     757
Total:        187  339  77.5    325     897

Percentage of the requests served within a certain time (ms)
  50%    325
  66%    346
  75%    363
  80%    377
  90%    423
  95%    478
  98%    571
  99%    647
 100%    897 (longest request)

Start up development server on Mac OS X

$ brew install rbenv ruby-build
$ gem install -g
$ rspec
$ foreman start

# Maybe you need to mkdir some dirs
$ mkdir -p data/apps
$ mkdir -p tmp/cache/apps