Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willin/wrescuetime
一个10行代码的 Rescuetime Open API SDK
https://github.com/willin/wrescuetime
api diy efficiency nodejs rescuetime sdk
Last synced: about 4 hours ago
JSON representation
一个10行代码的 Rescuetime Open API SDK
- Host: GitHub
- URL: https://github.com/willin/wrescuetime
- Owner: willin
- License: apache-2.0
- Created: 2017-02-17T01:33:25.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-12T00:02:45.000Z (about 1 year ago)
- Last Synced: 2024-04-14T04:55:54.442Z (5 months ago)
- Topics: api, diy, efficiency, nodejs, rescuetime, sdk
- Language: JavaScript
- Homepage:
- Size: 322 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WRescuetime
[](https://github.com/willin) [](https://npmjs.org/package/wrescuetime) [](https://npmjs.org/package/wrescuetime) [](https://npmjs.org/package/wrescuetime) [](https://codebeat.co/projects/github-com-willin-wrescuetime-master)
## 介绍
[RescueTime](https://www.rescuetime.com/ref/1496575) 是一个效率分析的软件，它可以全天候记录你的在线操作，并进行效率分析。
配合`Gyroscope`（iOS APP）、`IFTTT`等使用有奇效。并且可以自行 DIY新的玩法。
## 安装和使用
国际惯例：
```bash
yarn add wrescuetime
# 或
npm install wrescuetime --save
```
使用示例：
```js
const Wr = require('wrescuetime');
const wr = WR('full_key');
// Analytic Data
wr.analyticData({
rs: 'minute',
pv: 'interval',
rk: 'efficiency'
}).then((d) => {
console.log(d);
});
```
支持方法：
- analyticData
- dailySummaryFeed
- alertsFeed
- highlightsFeed
- highlightsPost
API 文档参考： https://www.rescuetime.com/anapi/setup/documentation
### 分步教程
#### 1.注册安装 RescueTime
注册链接： [https://www.rescuetime.com/](https://www.rescuetime.com/ref/1496575)
下载并安装客户端，支持的环境有：
* Mac OS X: 10.6以上
* Windows: XP/Vista/7/8/10
* Linux: Ubuntu/Fedora
* Android: 2.1以上（需要 Google Play）
* Chrome 插件
* Firefox 插件
安装完成后，通过 [API & Integrations](https://www.rescuetime.com/anapi/setup/overview) 链接新建 API Key。
#### 2. 搭建测试环境
服务器代码(使用`koa@next`、`koa-route@next`和`moment`实现)：
```js
const Wr = require('wrescuetime');
const moment = require('moment');
const Koa = require('koa');
const route = require('koa-route');
const redisClient = require('wulian-redis');
const wr = Wr('输入你的 Key');
moment.locale('zh-CN');
const redis = redisClient();
const app = new Koa();
// 核心代码
// JSON 格式输出
app.use(route.get('/', async (ctx) => {
let data = await redis.get('rescuetime');
if (data === null) {
data = await wr.analyticData({
rs: 'minute',
pv: 'interval',
rk: 'efficiency'
});
await redis.setex('rescuetime', 60, JSON.stringify(data));
} else {
data = JSON.parse(data);
}
const row = data.rows[data.rows.length - 1];
const time = Math.abs(moment(row[0]).diff()) / 60000;
const efficiency = parseFloat(row[4]);
ctx.body = {
status: 1,
time,
efficiency,
date: row[0]
};
}));
// 图片链接跳转
app.use(route.get('/icon', async (ctx) => {
let data = await redis.get('rescuetime');
if (data === null) {
data = await wr.analyticData({
rs: 'minute',
pv: 'interval',
rk: 'efficiency'
});
await redis.setex('rescuetime', 60, JSON.stringify(data));
} else {
data = JSON.parse(data);
}
const row = data.rows[data.rows.length - 1];
const time = Math.abs(moment(row[0]).diff()) / 60000;
const efficiency = parseFloat(row[4]);
if (time > 60) {
ctx.redirect('http://example.com/offline.png');
} else {
if (efficiency > 90) {
ctx.redirect('http://example.com/busy.png');
}
else {
ctx.redirect('http://example.com/online.png');
}
}
}));
app.listen(3000);
```
说明：
* 时间差（分钟）大于60判断为离线
* 效率大于90%判断为忙碌，请勿打扰
* 其他在线状况则显示默认在线
## 相关项目推荐
- 该SDK实际项目示例： https://github.com/willin/up.js.cool
- 微信小程序SDK： https://github.com/willin/mp-sdk
- 阿里云SDK： https://github.com/willin/waliyun
- 腾讯云SDK： https://github.com/willin/wqcloud
- 网易云音乐SDK： https://github.com/willin/wnm
## License
Apache 2.0
