15 Commits

Author SHA1 Message Date
7d377e31c2 2.0.11 2018-10-28 23:29:45 +01:00
fcb12d5734 fix(core): update 2018-10-28 23:29:45 +01:00
febf6c1911 2.0.10 2017-09-03 20:09:07 +02:00
457ac52a14 update docs 2017-09-03 20:09:03 +02:00
495a3ffafd 2.0.9 2017-09-03 11:39:40 +02:00
ffd1274f21 add README 2017-09-03 11:39:36 +02:00
8e4ad6159a remove low coverageTreshold 2017-08-29 16:55:41 +02:00
c5a2383fd3 2.0.8 2017-08-29 15:22:20 +02:00
2c25cd0655 update npmextra 2017-08-29 15:22:15 +02:00
370caae226 2.0.7 2017-08-29 15:20:21 +02:00
75c3979120 update ci 2017-08-29 15:20:18 +02:00
b5d792d58c 2.0.6 2017-08-29 15:18:15 +02:00
05b80b618b update to support latest pubapi 2017-08-29 15:18:10 +02:00
511b7ee143 2.0.5 2017-08-25 12:38:53 +02:00
08d37dc037 finetune property naming 2017-08-25 12:38:49 +02:00
14 changed files with 1237 additions and 83 deletions

View File

@ -15,7 +15,9 @@ stages:
testLEGACY:
stage: test
script:
- npmci test legacy
- npmci node install lts
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
@ -24,7 +26,9 @@ testLEGACY:
testLTS:
stage: test
script:
- npmci test lts
- npmci node install lts
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
@ -32,7 +36,9 @@ testLTS:
testSTABLE:
stage: test
script:
- npmci test stable
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
@ -40,7 +46,8 @@ testSTABLE:
release:
stage: release
script:
- npmci publish
- npmci npm prepare
- npmci npm publish
only:
- tags
tags:

View File

@ -22,23 +22,36 @@ Google Analytics everywhere
Use TypeScript for best in class instellisense.
### Why does this package exist?
Tracking users in webapps is common. We use Google Analytics to gain insight in who is using what
and where to spend resources for best efficiency.
Tracking users in webapps is common, often to gain insight in who is using what and where to spend dev resources for best efficiency.
Doing the same stuff in apps can be a bit of a hassle.
Unnecessary dependencies used by many existing analytics tools make the whole app slow
just to gain a little usage info.
Say hello to smartanalytics.
It features a very slim dependency tree using the native node request module to send posts to Google Analytics.
**Say hello to smartanalytics. :)**
It features a very slim dependency tree using the native node request module to send posts to a tracking API of your choice.
### How do I use this package?
```javascript
import {AnalyticsAccount} from 'smartanalytics'
let myAnalyticsAccount = new AnalyticsAccount('My App Name', 'UA-XXXXXX-Y')
myAnalyticsAccount.sendEvent('npmtool', 'install', 'somelabel')
import { Analytics } from 'smartanalytics'
let myAnalytics = new plugins.smartanalytics.Analytics({
apiEndPoint: 'https://somepubapi.endpoint.com',
projectId: 'gitzone',
appName: 'npmts'
})
myAnalytics.recordEvent('someEvent', {
myKey1: 'myValue1',
myKey2: 'myValue2',
myDataKey3: 3
}).catch(err => {
console.log(err)
})
```
For further information read the linked docs at the top of this README.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

View File

@ -4,10 +4,10 @@ export declare class Analytics {
apiEndPoint: string;
secretKey: string;
constructor(optionsArg: {
projectIdArg: string;
appNameArg: string;
apiEndPointArg: string;
secretKeyArg?: string;
projectId: string;
appName: string;
apiEndPoint: string;
secretKey?: string;
});
recordEvent(identifierArg: string, analyticsDataArg: any): Promise<void>;
recordEvent(eventIdArg: string, analyticsDataArg: any): Promise<void>;
}

View File

@ -12,19 +12,19 @@ const plugins = require("./smartanalytics.plugins");
class Analytics {
constructor(optionsArg) {
this.secretKey = '';
this.projectId = optionsArg.projectIdArg;
this.appName = optionsArg.appNameArg;
this.apiEndPoint = optionsArg.apiEndPointArg;
if (optionsArg.secretKeyArg) {
this.secretKey = optionsArg.secretKeyArg;
this.projectId = optionsArg.projectId;
this.appName = optionsArg.appName;
this.apiEndPoint = optionsArg.apiEndPoint;
if (optionsArg.secretKey) {
this.secretKey = optionsArg.secretKey;
}
}
recordEvent(identifierArg, analyticsDataArg) {
recordEvent(eventIdArg, analyticsDataArg) {
return __awaiter(this, void 0, void 0, function* () {
let dataToSend = {
projectId: this.projectId,
appName: this.appName,
identifier: identifierArg,
eventId: eventIdArg,
analyticsData: analyticsDataArg
};
yield plugins.smartrequest.post(this.apiEndPoint, {
@ -40,4 +40,4 @@ class Analytics {
}
}
exports.Analytics = Analytics;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRhbmFseXRpY3MuY2xhc3Nlcy5hbmFseXRpY3MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGFuYWx5dGljcy5jbGFzc2VzLmFuYWx5dGljcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7O0FBQUEsb0RBQW1EO0FBRW5EO0lBS0UsWUFBYSxVQUtaO1FBTkQsY0FBUyxHQUFXLEVBQUUsQ0FBQTtRQU9wQixJQUFJLENBQUMsU0FBUyxHQUFHLFVBQVUsQ0FBQyxZQUFZLENBQUE7UUFDeEMsSUFBSSxDQUFDLE9BQU8sR0FBRyxVQUFVLENBQUMsVUFBVSxDQUFBO1FBQ3BDLElBQUksQ0FBQyxXQUFXLEdBQUcsVUFBVSxDQUFDLGNBQWMsQ0FBQTtRQUM1QyxFQUFFLENBQUMsQ0FBQyxVQUFVLENBQUMsWUFBWSxDQUFDLENBQUMsQ0FBQztZQUM1QixJQUFJLENBQUMsU0FBUyxHQUFHLFVBQVUsQ0FBQyxZQUFZLENBQUE7UUFDMUMsQ0FBQztJQUNILENBQUM7SUFFSyxXQUFXLENBQUUsYUFBcUIsRUFBRSxnQkFBcUI7O1lBQzdELElBQUksVUFBVSxHQUFHO2dCQUNmLFNBQVMsRUFBRSxJQUFJLENBQUMsU0FBUztnQkFDekIsT0FBTyxFQUFFLElBQUksQ0FBQyxPQUFPO2dCQUNyQixVQUFVLEVBQUUsYUFBYTtnQkFDekIsYUFBYSxFQUFFLGdCQUFnQjthQUNoQyxDQUFBO1lBQ0QsTUFBTSxPQUFPLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFO2dCQUNoRCxPQUFPLEVBQUU7b0JBQ1AsY0FBYyxFQUFFLElBQUksQ0FBQyxTQUFTO29CQUM5QixjQUFjLEVBQUUsa0JBQWtCO2lCQUNuQztnQkFDRCxXQUFXLEVBQUUsVUFBVTthQUN4QixDQUFDLENBQUMsS0FBSyxDQUFDLEdBQUc7Z0JBQ1YsT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQTtZQUNsQixDQUFDLENBQUMsQ0FBQTtRQUNKLENBQUM7S0FBQTtDQUNGO0FBcENELDhCQW9DQyJ9
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRhbmFseXRpY3MuY2xhc3Nlcy5hbmFseXRpY3MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGFuYWx5dGljcy5jbGFzc2VzLmFuYWx5dGljcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7O0FBQUEsb0RBQW1EO0FBRW5EO0lBS0UsWUFBYSxVQUtaO1FBTkQsY0FBUyxHQUFXLEVBQUUsQ0FBQTtRQU9wQixJQUFJLENBQUMsU0FBUyxHQUFHLFVBQVUsQ0FBQyxTQUFTLENBQUE7UUFDckMsSUFBSSxDQUFDLE9BQU8sR0FBRyxVQUFVLENBQUMsT0FBTyxDQUFBO1FBQ2pDLElBQUksQ0FBQyxXQUFXLEdBQUcsVUFBVSxDQUFDLFdBQVcsQ0FBQTtRQUN6QyxFQUFFLENBQUMsQ0FBQyxVQUFVLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQztZQUN6QixJQUFJLENBQUMsU0FBUyxHQUFHLFVBQVUsQ0FBQyxTQUFTLENBQUE7UUFDdkMsQ0FBQztJQUNILENBQUM7SUFFSyxXQUFXLENBQUUsVUFBa0IsRUFBRSxnQkFBcUI7O1lBQzFELElBQUksVUFBVSxHQUFHO2dCQUNmLFNBQVMsRUFBRSxJQUFJLENBQUMsU0FBUztnQkFDekIsT0FBTyxFQUFFLElBQUksQ0FBQyxPQUFPO2dCQUNyQixPQUFPLEVBQUUsVUFBVTtnQkFDbkIsYUFBYSxFQUFFLGdCQUFnQjthQUNoQyxDQUFBO1lBQ0QsTUFBTSxPQUFPLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFO2dCQUNoRCxPQUFPLEVBQUU7b0JBQ1AsY0FBYyxFQUFFLElBQUksQ0FBQyxTQUFTO29CQUM5QixjQUFjLEVBQUUsa0JBQWtCO2lCQUNuQztnQkFDRCxXQUFXLEVBQUUsVUFBVTthQUN4QixDQUFDLENBQUMsS0FBSyxDQUFDLEdBQUc7Z0JBQ1YsT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQTtZQUNsQixDQUFDLENBQUMsQ0FBQTtRQUNKLENBQUM7S0FBQTtDQUNGO0FBcENELDhCQW9DQyJ9

59
docs/index.md Normal file
View File

@ -0,0 +1,59 @@
# smartanalytics
Google Analytics everywhere
## Availabililty
[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartanalytics)
[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartanalytics)
[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartanalytics)
[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartanalytics/)
## Status for master
[![build status](https://GitLab.com/pushrocks/smartanalytics/badges/master/build.svg)](https://GitLab.com/pushrocks/smartanalytics/commits/master)
[![coverage report](https://GitLab.com/pushrocks/smartanalytics/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartanalytics/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/smartanalytics.svg)](https://www.npmjs.com/package/smartanalytics)
[![Dependency Status](https://david-dm.org/pushrocks/smartanalytics.svg)](https://david-dm.org/pushrocks/smartanalytics)
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartanalytics/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartanalytics/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/pushrocks/smartanalytics/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartanalytics)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
## Usage
Use TypeScript for best in class instellisense.
### Why does this package exist?
Tracking users in webapps is common, often to gain insight in who is using what and where to spend dev resources for best efficiency.
Doing the same stuff in apps can be a bit of a hassle.
Unnecessary dependencies used by many existing analytics tools make the whole app slow
just to gain a little usage info.
**Say hello to smartanalytics. :)**
It features a very slim dependency tree using the native node request module to send posts to a tracking API of your choice.
### How do I use this package?
```javascript
import { Analytics } from 'smartanalytics'
let myAnalytics = new plugins.smartanalytics.Analytics({
apiEndPoint: 'https://somepubapi.endpoint.com',
projectId: 'gitzone',
appName: 'npmts'
})
myAnalytics.recordEvent('someEvent', {
myKey1: 'myValue1',
myKey2: 'myValue2',
myDataKey3: 3
}).catch(err => {
console.log(err)
})
```
For further information read the linked docs at the top of this README.
> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

19
license Normal file
View File

@ -0,0 +1,19 @@
Copyright (c) 2018 Lossless GmbH (hello@lossless.com)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@ -1,10 +1,8 @@
{
"npmts": {
"coverageTreshold": 40
},
"npmci": {
"globalNpmTools": [
"npmts"
]
"npmGlobalTools": [],
"npmAccessLevel": "public"
}
}

1046
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,20 +1,24 @@
{
"name": "smartanalytics",
"version": "2.0.4",
"name": "@pushrocks/smartanalytics",
"version": "2.0.11",
"description": "Google Analytics everywhere",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"scripts": {
"test": "(npmts)"
"test": "(tstest test/)"
},
"author": "",
"author": "Lossless GmbH",
"license": "MIT",
"dependencies": {
"smartq": "^1.1.1",
"smartrequest": "^1.0.4",
"typings-global": "^1.0.14"
"@pushrocks/smartpromise": "^2.0.5",
"@pushrocks/smartrequest": "^1.1.14"
},
"devDependencies": {
"tapbundle": "^1.1.1"
"@gitzone/tsbuild": "^2.0.22",
"@gitzone/tstest": "^1.0.15",
"@pushrocks/tapbundle": "^3.0.7",
"@types/node": "^10.12.0",
"tslint": "^5.11.0",
"tslint-config-prettier": "^1.15.0"
}
}

View File

@ -1,27 +1,27 @@
import { expect, tap } from 'tapbundle'
import { expect, tap } from '@pushrocks/tapbundle';
import * as smartanalytics from '../ts/index'
import * as smartanalytics from '../ts/index';
let testAnalytics: smartanalytics.Analytics
let testAnalytics: smartanalytics.Analytics;
tap.test('should create a valid AnalyticsAccount', async () => {
testAnalytics = new smartanalytics.Analytics({
projectIdArg: 'sandbox',
appNameArg: 'smartanalytics',
apiEndPointArg: 'https://pubapi-1.lossless.one/analytics'
})
})
projectId: 'sandbox',
appName: 'smartanalytics',
apiEndPoint: 'https://pubapi.lossless.one/analytics'
});
});
tap.test('should send a request to Lossless API endpoint', async () => {
let doit = async () => {
await testAnalytics.recordEvent('sandbox', {
trackingPurpose: 'test'
})
});
await testAnalytics.recordEvent('sandbox', {
someValue: 'someData'
})
}
doit()
})
});
};
doit();
});
tap.start()
tap.start();

View File

@ -1 +1 @@
export { Analytics } from './smartanalytics.classes.analytics'
export { Analytics } from './smartanalytics.classes.analytics';

View File

@ -1,39 +1,41 @@
import * as plugins from './smartanalytics.plugins'
import * as plugins from './smartanalytics.plugins';
export class Analytics {
projectId: string
appName: string
apiEndPoint: string
secretKey: string = ''
public projectId: string;
public appName: string;
public apiEndPoint: string;
public secretKey: string = '';
constructor(optionsArg: {
projectIdArg: string
appNameArg: string
apiEndPointArg: string
secretKeyArg?: string
projectId: string;
appName: string;
apiEndPoint: string;
secretKey?: string;
}) {
this.projectId = optionsArg.projectIdArg
this.appName = optionsArg.appNameArg
this.apiEndPoint = optionsArg.apiEndPointArg
if (optionsArg.secretKeyArg) {
this.secretKey = optionsArg.secretKeyArg
this.projectId = optionsArg.projectId;
this.appName = optionsArg.appName;
this.apiEndPoint = optionsArg.apiEndPoint;
if (optionsArg.secretKey) {
this.secretKey = optionsArg.secretKey;
}
}
async recordEvent (identifierArg: string, analyticsDataArg: any) {
async recordEvent(eventIdArg: string, analyticsDataArg: any) {
let dataToSend = {
projectId: this.projectId,
appName: this.appName,
identifier: identifierArg,
eventId: eventIdArg,
analyticsData: analyticsDataArg
}
await plugins.smartrequest.post(this.apiEndPoint, {
};
await plugins.smartrequest
.postJson(this.apiEndPoint, {
headers: {
'authenticate': this.secretKey,
authenticate: this.secretKey,
'Content-Type': 'application/json'
},
requestBody: dataToSend
}).catch(err => {
console.log(err)
})
.catch(err => {
console.log(err);
});
}
}

View File

@ -1,8 +1,7 @@
import 'typings-global'
import * as smartrequest from 'smartrequest'
import * as smartq from 'smartq'
import * as smartrequest from '@pushrocks/smartrequest';
import * as smartpromise from '@pushrocks/smartpromise';
export {
smartrequest,
smartq
smartpromise
}

View File

@ -1,3 +1,10 @@
{
"extends": "tslint-config-standard"
"extends": ["tslint:latest", "tslint-config-prettier"],
"rules": {
"semicolon": [true, "always"],
"no-console": false,
"ordered-imports": false,
"object-literal-sort-keys": false
},
"defaultSeverity": "warning"
}