generated from senecajs/seneca-tangocard-provider
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit df31ce6
Showing
17 changed files
with
866 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node | ||
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions | ||
|
||
name: build | ||
|
||
on: | ||
push: | ||
branches: [ main ] | ||
pull_request: | ||
branches: [ main ] | ||
|
||
jobs: | ||
build: | ||
environment: test | ||
env: | ||
TRELLO_APIKEY: ${{secrets.TRELLO_APIKEY}} | ||
TRELLO_USERTOKEN: ${{secrets.TRELLO_USERTOKEN}} | ||
|
||
timeout-minutes: 6 | ||
|
||
strategy: | ||
fail-fast: false | ||
matrix: | ||
os: [ubuntu-latest, windows-latest, macos-latest] | ||
node-version: [lts/*, 17.x, 16.x] | ||
|
||
runs-on: ${{ matrix.os }} | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Use Node.js ${{ matrix.node-version }} | ||
uses: actions/setup-node@v2 | ||
with: | ||
node-version: ${{ matrix.node-version }} | ||
- run: npm install | ||
# manually install peerdeps for node 12,14 | ||
- run: npm i seneca seneca-entity seneca-promisify @seneca/provider @seneca/env | ||
- run: npm run build --if-present | ||
- run: npm test | ||
|
||
- name: Coveralls | ||
uses: coverallsapp/github-action@master | ||
with: | ||
github-token: ${{ secrets.GITHUB_TOKEN }} | ||
path-to-lcov: ./coverage/lcov.info |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
name: "TODO" | ||
on: ["push"] | ||
jobs: | ||
build: | ||
runs-on: "ubuntu-latest" | ||
steps: | ||
- uses: "actions/checkout@master" | ||
- name: "todo-to-issue" | ||
uses: "senecajs/todo-to-issue-action@master" | ||
with: | ||
REPO: ${{ github.repository }} | ||
BEFORE: ${{ github.event.before }} | ||
SHA: ${{ github.sha }} | ||
TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
LABEL: "TODO:" | ||
COMMENT_MARKER: "//" | ||
INCLUDE_EXT: ".js,.md,.ts" | ||
id: "todo" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
lerna-debug.log* | ||
|
||
# Diagnostic reports (https://nodejs.org/api/report.html) | ||
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json | ||
|
||
# Runtime data | ||
pids | ||
*.pid | ||
*.seed | ||
*.pid.lock | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
lib-cov | ||
|
||
# Coverage directory used by tools like istanbul | ||
coverage | ||
*.lcov | ||
|
||
# nyc test coverage | ||
.nyc_output | ||
|
||
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) | ||
.grunt | ||
|
||
# Bower dependency directory (https://bower.io/) | ||
bower_components | ||
|
||
# node-waf configuration | ||
.lock-wscript | ||
|
||
# Compiled binary addons (https://nodejs.org/api/addons.html) | ||
build/Release | ||
|
||
# Dependency directories | ||
node_modules/ | ||
jspm_packages/ | ||
|
||
# TypeScript v1 declaration files | ||
typings/ | ||
|
||
# TypeScript cache | ||
*.tsbuildinfo | ||
|
||
# Optional npm cache directory | ||
.npm | ||
|
||
# Optional eslint cache | ||
.eslintcache | ||
|
||
# Microbundle cache | ||
.rpt2_cache/ | ||
.rts2_cache_cjs/ | ||
.rts2_cache_es/ | ||
.rts2_cache_umd/ | ||
|
||
# Optional REPL history | ||
.node_repl_history | ||
|
||
# Output of 'npm pack' | ||
*.tgz | ||
|
||
# Yarn Integrity file | ||
.yarn-integrity | ||
|
||
# dotenv environment variables file | ||
.env | ||
.env.test | ||
|
||
# parcel-bundler cache (https://parceljs.org/) | ||
.cache | ||
|
||
# Next.js build output | ||
.next | ||
|
||
# Nuxt.js build / generate output | ||
.nuxt | ||
|
||
# Gatsby files | ||
.cache/ | ||
# Comment in the public line in if your project uses Gatsby and *not* Next.js | ||
# https://nextjs.org/blog/next-9-1#public-directory-support | ||
# public | ||
|
||
# vuepress build output | ||
.vuepress/dist | ||
|
||
# Serverless directories | ||
.serverless/ | ||
|
||
# FuseBox cache | ||
.fusebox/ | ||
|
||
# DynamoDB Local files | ||
.dynamodb/ | ||
|
||
# TernJS port file | ||
.tern-port | ||
|
||
*~ | ||
|
||
package-lock.json | ||
yarn.lock | ||
|
||
test/local-config.js | ||
test/local-env.js | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2021 Seneca Microservices Framework | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,140 @@ | ||
![Seneca Tangocard-Provider](http://senecajs.org/files/assets/seneca-logo.png) | ||
|
||
> _Seneca Tangocard-Provider_ is a plugin for [Seneca](http://senecajs.org) | ||
|
||
Provides access to the Tangocard API using the Seneca *provider* | ||
convention. Tangocard API entities are represented as Seneca entities so | ||
that they can be accessed using the Seneca entity API and messages. | ||
|
||
See [seneca-entity](senecajs/seneca-entity) and the [Seneca Data | ||
Entities | ||
Tutorial](https://senecajs.org/docs/tutorials/understanding-data-entities.html) for more details on the Seneca entity API. | ||
|
||
NOTE: underlying third party SDK needs to be replaced as out of date and has a security issue. | ||
|
||
[![npm version](https://img.shields.io/npm/v/@seneca/tangocard-provider.svg)](https://npmjs.com/package/@seneca/tangocard-provider) | ||
[![build](https://github.com/senecajs/seneca-tangocard-provider/actions/workflows/build.yml/badge.svg)](https://github.com/senecajs/seneca-tangocard-provider/actions/workflows/build.yml) | ||
[![Coverage Status](https://coveralls.io/repos/github/senecajs/seneca-tangocard-provider/badge.svg?branch=main)](https://coveralls.io/github/senecajs/seneca-tangocard-provider?branch=main) | ||
[![Known Vulnerabilities](https://snyk.io/test/github/senecajs/seneca-tangocard-provider/badge.svg)](https://snyk.io/test/github/senecajs/seneca-tangocard-provider) | ||
[![DeepScan grade](https://deepscan.io/api/teams/5016/projects/19462/branches/505954/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=5016&pid=19462&bid=505954) | ||
[![Maintainability](https://api.codeclimate.com/v1/badges/f76e83896b731bb5d609/maintainability)](https://codeclimate.com/github/senecajs/seneca-tangocard-provider/maintainability) | ||
|
||
|
||
| ![Voxgig](https://www.voxgig.com/res/img/vgt01r.png) | This open source module is sponsored and supported by [Voxgig](https://www.voxgig.com). | | ||
|---|---| | ||
|
||
|
||
## Quick Example | ||
|
||
|
||
```js | ||
|
||
// Setup - get the key value (<SECRET>) separately from a vault or | ||
// environment variable. | ||
Seneca() | ||
// Get API keys using the seneca-env plugin | ||
.use('env', { | ||
var: { | ||
$TANGOCARD_APIKEY: String, | ||
$TANGOCARD_USERTOKEN: String, | ||
} | ||
}) | ||
.use('provider', { | ||
provider: { | ||
tangocard: { | ||
keys: { | ||
apikey: { value: '$TANGOCARD_APIKEY' }, | ||
usertoken: { value: '$TANGOCARD_USERTOKEN' }, | ||
} | ||
} | ||
} | ||
}) | ||
.use('tangocard-provider') | ||
|
||
let board = await seneca.entity('provider/tangocard/board') | ||
.load$('<tangocard-board-id>') | ||
|
||
Console.log('BOARD', board) | ||
|
||
board.desc = 'New description' | ||
board = await board.save$() | ||
|
||
Console.log('UPDATED BOARD', board) | ||
|
||
``` | ||
|
||
## Install | ||
|
||
```sh | ||
$ npm install @seneca/tangocard-provider @seneca/env | ||
``` | ||
|
||
|
||
|
||
<!--START:options--> | ||
|
||
|
||
## Options | ||
|
||
* `debug` : boolean <i><small>false</small></i> | ||
|
||
|
||
Set plugin options when loading with: | ||
```js | ||
|
||
|
||
seneca.use('TangocardProvider', { name: value, ... }) | ||
|
||
|
||
``` | ||
|
||
|
||
<small>Note: <code>foo.bar</code> in the list above means | ||
<code>{ foo: { bar: ... } }</code></small> | ||
|
||
|
||
|
||
<!--END:options--> | ||
|
||
<!--START:action-list--> | ||
|
||
|
||
## Action Patterns | ||
|
||
* [role:entity,base:tangocard,cmd:load,name:repo,zone:provider](#-roleentitybasetangocardcmdloadnamerepozoneprovider-) | ||
* [role:entity,base:tangocard,cmd:save,name:repo,zone:provider](#-roleentitybasetangocardcmdsavenamerepozoneprovider-) | ||
* [sys:provider,get:info,provider:tangocard](#-sysprovidergetinfoprovidertangocard-) | ||
|
||
|
||
<!--END:action-list--> | ||
|
||
<!--START:action-desc--> | ||
|
||
|
||
## Action Descriptions | ||
|
||
### « `role:entity,base:tangocard,cmd:load,name:repo,zone:provider` » | ||
|
||
Load Tangocard repository data into an entity. | ||
|
||
|
||
|
||
---------- | ||
### « `role:entity,base:tangocard,cmd:save,name:repo,zone:provider` » | ||
|
||
Update Tangocard repository data from an entity. | ||
|
||
|
||
|
||
---------- | ||
### « `sys:provider,get:info,provider:tangocard` » | ||
|
||
Get information about the provider. | ||
|
||
|
||
|
||
---------- | ||
|
||
|
||
<!--END:action-desc--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
module.exports = { | ||
transform: { | ||
"^.+\\.tsx?$": "es-jest" | ||
}, | ||
testEnvironment: 'node', | ||
testMatch: ['**/test/**/*.test.ts'], | ||
watchPathIgnorePatterns: ['dist\\/'], | ||
collectCoverageFrom: ['src/**/*.ts'], | ||
coverageProvider: 'v8', | ||
} |
Oops, something went wrong.