[GA v1♭] [NOTES] TODO() by duangsuse

[duangsuse]

TODO

https://github.com/bjzhou/Coolapk-kotlin

• TravisCI integration support
• AppType
• Add getXXXXCount() Interfaces for client update event check
• QCL interpreter (v1.1b)
• Add platform task for GeekApk pictures(copycat 🐱
• GeekApk i18n
• User last-online-at time
• App pinned comment
• Test driven development
• Add GET Views for non-GET APIs (debug view) (v1.1b)
• Add PATCH (Bulk update entity properties) APIs (v1.1b)

TODO later

• Topics like CoolApk(yes, with 'subscribe' feature) (merging extra timeline)
• MessageHeader specification (At mentation user, join topics...)
• Make a built-in GeekWidget plugin replacing coolapk's App discovery
• GeekPush & support user (cross device) push events (server-side interface for cloudInstall)
• Database migrate program
• Support J2EE servlet containers arithetcute (v2)

"NOT" TODO

• App discovery like CoolApk

WHY: GeekApk Users can create apps on their purpose, and GeekApk have a GeekWidget plugin replacing coolapk's App discovery (inline picture in comments)

• favorite comments(o:feeds) (designment reasons)
• (un)recommend(+1) comments (designment reasons)
• Headline like CoolApk (Badges in GeekApk actually the same)
• App QR Code
• Recommended Apps and Albums (AppDeps in GeekApk will "implement" that)
• Avatar/Other Image storage (Use external services like sm.ms instead)
• PM like CoolApk (GeekStream in v2 provides "PM" feature)
• download stat (but, GeekApk Hits is almost the same...)
• rating for apps (star is enough)
• "Feed"s (GeekApk uses MetaApp to combine a "Feed Area" with its users)
• pictures (Already has one)
• App gift codes
• block users on the server side
• App tags (GeekDeps...)

[duangsuse]

[duangsuse]

目前 GeekApk 的控制器路径模板已经在 add-controller-template 分支上开发

填充完所有模板并合并到 master 后，下一个目标 branch 是 add-controller-tests

其时 v1b 的第一个版本所有非控制器的编程需求都没有了（因为之前都写完了，感谢 SpringBoot 使得我不用写那么多难看并且耗时间的 XML 配置文件），接下来就是测试驱动编程 implement-interfaces 喽

Test-driven development 的一个好处就是出来的肯定是能用的成品，因为它通过了验收测试（Acceptance test）

然后就是写前端

[duangsuse]

[DuangSUSE@duangsuse]~/文档/geekapk_spring% node code_writer.js

serverDetail() -> object:detailMap
= /serverDetail

serverVersion() -> plain
= /serverVersion

serverDescription() -> plain
= /serverDescription

serverBoot() -> datetime
= /serverBoot

POST@createUser(username:String) -> object:GeekUser
= /admin/makeUser

PUT@resetSharedHash(uid-path:UserId, shash:String?) -> plain
= /admin/resetMetaHash/{uid}

DELETE@deleteUser(uid-path:UserId) -> object:GeekUser
= /admin/dropUser/{uid}

PUT@flagUser(uid-path:UserId, flag:Int) -> object:GeekUser
= /admin/flagUser/{uid}

POST@createCategory(name:String) -> object:Category
= /admin/makeCategory

PUT@renameCategory(id-path:CategoryId, name:String) -> object:Category
= /admin/nameCategory/{id}

DELETE@deleteCategory(id-path:CategoryId) -> object:Category
= /admin/dropCategory/{id}

DELETE@deleteApp(aid-path:AppId) -> object:App
= /admin/dropApp/{aid}

PUT@transferAppCategory(aid-path:AppId, cid:CategoryId) -> [$aid:number, $old:number, $new:number]
= /admin/moveApp/{aid}

PUT@transferAppOwner(aid-path:AppId, uid:UserId) -> [$aid:number, $old:number, $new:number]
= /admin/transferApp/{aid}

DELETE@deleteAppUpdate(aid-path:AppId, rev-path:Int) -> object:AppUpdate
= /admin/dropAppUpdate/{aid}/{rev}

DELETE@deleteComment(cid-path:CommentId) -> [$cid:number, $deletedSubComments:number]
= /admin/dropComment/{cid}

categoryList() -> array:Category
= category/all

categoryName(id-path:CategoryId) -> plain
= category/{id}

readUser(id-path:UserId) -> object:GeekUser
= user/{id}

updateUser(id-path:UserId, prop:String, value-body:String) -> object:string
= user/{id}

resetHash(id-path:UserId, shash:String, hash:String) -> object:string
= user/{id}/hash

checkHash(id-path:UserId, hash:String) -> object:string
= user/{id}/checkHash

listUser(sort:String?, sliceFrom:UserSize?, sliceTo:UserSize?) -> array:GeekUser
= user/all

listMetaUser(sort:String?, sliceFrom:UserSize?, sliceTo:UserSize?) -> array:GeekUser
= user/allHasMetaApp

searchUser(type:String?, kw-path:String, sort:String?) -> array:GeekUser
= user/search/{kw}

updateOnlineTime(id-path:UserId)
= user/{id}/online

[ { method: 'GET',
name: 'serverDetail',
args: [],
return: { type: 'object', of: 'detailMap' },
url: '/serverDetail' },
{ method: 'GET',
name: 'serverVersion',
args: [],
return: 'plain',
url: '/serverVersion' },
{ method: 'GET',
name: 'serverDescription',
args: [],
return: 'plain',
url: '/serverDescription' },
{ method: 'GET',
name: 'serverBoot',
args: [],
return: 'datetime',
url: '/serverBoot' },
{ method: 'POST',
name: 'createUser',
args: [ [Object] ],
return: { type: 'object', of: 'GeekUser' },
url: '/admin/makeUser' },
{ method: 'PUT',
name: 'resetSharedHash',
args: [ [Object], [Object] ],
return: 'plain',
url: '/admin/resetMetaHash/{uid}' },
{ method: 'DELETE',
name: 'deleteUser',
args: [ [Object] ],
return: { type: 'object', of: 'GeekUser' },
url: '/admin/dropUser/{uid}' },
{ method: 'PUT',
name: 'flagUser',
args: [ [Object], [Object] ],
return: { type: 'object', of: 'GeekUser' },
url: '/admin/flagUser/{uid}' },
{ method: 'POST',
name: 'createCategory',
args: [ [Object] ],
return: { type: 'object', of: 'Category' },
url: '/admin/makeCategory' },
{ method: 'PUT',
name: 'renameCategory',
args: [ [Object], [Object] ],
return: { type: 'object', of: 'Category' },
url: '/admin/nameCategory/{id}' },
{ method: 'DELETE',
name: 'deleteCategory',
args: [ [Object] ],
return: { type: 'object', of: 'Category' },
url: '/admin/dropCategory/{id}' },
{ method: 'DELETE',
name: 'deleteApp',
args: [ [Object] ],
return: { type: 'object', of: 'App' },
url: '/admin/dropApp/{aid}' },
{ method: 'PUT',
name: 'transferAppCategory',
args: [ [Object], [Object] ],
return: [ [Object], [Object], [Object] ],
url: '/admin/moveApp/{aid}' },
{ method: 'PUT',
name: 'transferAppOwner',
args: [ [Object], [Object] ],
return: [ [Object], [Object], [Object] ],
url: '/admin/transferApp/{aid}' },
{ method: 'DELETE',
name: 'deleteAppUpdate',
args: [ [Object], [Object] ],
return: { type: 'object', of: 'AppUpdate' },
url: '/admin/dropAppUpdate/{aid}/{rev}' },
{ method: 'DELETE',
name: 'deleteComment',
args: [ [Object] ],
return: [ [Object], [Object] ],
url: '/admin/dropComment/{cid}' },
{ method: 'GET',
name: 'categoryList',
args: [],
return: { type: 'array', of: 'Category' },
url: 'category/all' },
{ method: 'GET',
name: 'categoryName',
args: [ [Object] ],
return: 'plain',
url: 'category/{id}' },
{ method: 'GET',
name: 'readUser',
args: [ [Object] ],
return: { type: 'object', of: 'GeekUser' },
url: 'user/{id}' },
{ method: 'GET',
name: 'updateUser',
args: [ [Object], [Object], [Object] ],
return: { type: 'object', of: 'string' },
url: 'user/{id}' },
{ method: 'GET',
name: 'resetHash',
args: [ [Object], [Object], [Object] ],
return: { type: 'object', of: 'string' },
url: 'user/{id}/hash' },
{ method: 'GET',
name: 'checkHash',
args: [ [Object], [Object] ],
return: { type: 'object', of: 'string' },
url: 'user/{id}/checkHash' },
{ method: 'GET',
name: 'listUser',
args: [ [Object], [Object], [Object] ],
return: { type: 'array', of: 'GeekUser' },
url: 'user/all' },
{ method: 'GET',
name: 'listMetaUser',
args: [ [Object], [Object], [Object] ],
return: { type: 'array', of: 'GeekUser' },
url: 'user/allHasMetaApp' },
{ method: 'GET',
name: 'searchUser',
args: [ [Object], [Object], [Object] ],
return: { type: 'array', of: 'GeekUser' },
url: 'user/search/{kw}' },
{ method: 'GET',
name: 'updateOnlineTime',
args: [ [Object] ],
return: null,
url: 'user/{id}/online' } ]

GET /serverDetail: serverDetail()
Returning object of detailMap

GET /serverVersion: serverVersion()
Returning plain

GET /serverDescription: serverDescription()
Returning plain

GET /serverBoot: serverBoot()
Returning datetime

POST /admin/makeUser: createUser(username:String!)
Returning object of GeekUser

PUT /admin/resetMetaHash/{uid}: resetSharedHash(uid-path:UserId!,shash:String?)
Returning plain

DELETE /admin/dropUser/{uid}: deleteUser(uid-path:UserId!)
Returning object of GeekUser

PUT /admin/flagUser/{uid}: flagUser(uid-path:UserId!,flag:Int!)
Returning object of GeekUser

POST /admin/makeCategory: createCategory(name:String!)
Returning object of Category

PUT /admin/nameCategory/{id}: renameCategory(id-path:CategoryId!,name:String!)
Returning object of Category

DELETE /admin/dropCategory/{id}: deleteCategory(id-path:CategoryId!)
Returning object of Category

DELETE /admin/dropApp/{aid}: deleteApp(aid-path:AppId!)
Returning object of App

PUT /admin/moveApp/{aid}: transferAppCategory(aid-path:AppId!,cid:CategoryId!)
Returning number:aid,number:old,number:new

PUT /admin/transferApp/{aid}: transferAppOwner(aid-path:AppId!,uid:UserId!)
Returning number:aid,number:old,number:new

DELETE /admin/dropAppUpdate/{aid}/{rev}: deleteAppUpdate(aid-path:AppId!,rev-path:Int!)
Returning object of AppUpdate

DELETE /admin/dropComment/{cid}: deleteComment(cid-path:CommentId!)
Returning number:cid,number:deletedSubComments

GET category/all: categoryList()
Returning array of Category

GET category/{id}: categoryName(id-path:CategoryId!)
Returning plain

GET user/{id}: readUser(id-path:UserId!)
Returning object of GeekUser

GET user/{id}: updateUser(id-path:UserId!,prop:String!,value-body:String!)
Returning object of string

GET user/{id}/hash: resetHash(id-path:UserId!,shash:String!,hash:String!)
Returning object of string

GET user/{id}/checkHash: checkHash(id-path:UserId!,hash:String!)
Returning object of string

GET user/all: listUser(sort:String?,sliceFrom:UserSize?,sliceTo:UserSize?)
Returning array of GeekUser

GET user/allHasMetaApp: listMetaUser(sort:String?,sliceFrom:UserSize?,sliceTo:UserSize?)
Returning array of GeekUser

GET user/search/{kw}: searchUser(type:String?,kw-path:String!,sort:String?)
Returning array of GeekUser

GET user/{id}/online: updateOnlineTime(id-path:UserId!)
Returning noting
[DuangSUSE@duangsuse]~/文档/geekapk_spring%

[duangsuse]

找到了个很有意思的名词：Dao（Data Access Object）
是这样的么？

[duangsuse]

Branch "add-tests" excluded per configuration.

[duangsuse]

贡献者 duangsuse 已经启用很无聊的 Commit GnuPG 签名，除了让 GitHub 开心外没有什么卵用。

[duangsuse]

百 Commit 纪念