Compare commits
24 Commits
openSAP-we
...
openSAP-we
| Author | SHA1 | Date | |
|---|---|---|---|
|
7333001683 | ||
|
|
d6e051fcb8 | ||
|
|
059df03cc1 | ||
|
|
669c5249ff | ||
|
|
1a3fb3ffab | ||
|
|
f2c458db7a | ||
|
|
5c7a3e6860 | ||
|
|
ece590be9c | ||
|
|
19ba5c2d9c | ||
|
|
3e6a23e43d | ||
|
|
2857ab7fa0 | ||
|
|
ecd2152be5 | ||
|
|
ce3094a30d | ||
|
|
8f0f032e6c | ||
|
|
7c52a3b4f2 | ||
|
|
6a9a1bc4d6 | ||
|
|
a0847e603f | ||
|
|
b1270bc0eb | ||
|
|
3a77707f49 | ||
|
|
583c97a494 | ||
|
|
eb7431afed | ||
|
|
c0bce5ae5b | ||
|
|
ad05e2b9db | ||
|
|
b7c2eee961 |
@@ -6,7 +6,7 @@
|
||||
"jest": true
|
||||
},
|
||||
"parserOptions": {
|
||||
"ecmaVersion": 2017
|
||||
"ecmaVersion": 2018
|
||||
},
|
||||
"globals": {
|
||||
"SELECT": true,
|
||||
|
||||
27
.vscode/launch.json
vendored
27
.vscode/launch.json
vendored
@@ -5,19 +5,17 @@
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "cds run",
|
||||
"request": "launch",
|
||||
"type": "node",
|
||||
"runtimeExecutable": "npx",
|
||||
"runtimeArgs": ["-n"],
|
||||
"args": ["--", "cds", "run", "--with-mocks", "--in-memory?"], // the leading "--" arg ensures it works with as well as without debugging
|
||||
"name": "bookshop", "request": "launch", "type": "node", "runtimeExecutable": "npx", "runtimeArgs": [ "-n" ],
|
||||
"args": [ "--", "cds", "run", "--in-memory" ],
|
||||
"cwd": "${workspaceFolder}/packages/bookshop",
|
||||
"console": "integratedTerminal",
|
||||
"skipFiles": ["<node_internals>/**"]
|
||||
},
|
||||
{
|
||||
"name": "cds run ...", "request": "launch", "type": "node", "runtimeExecutable": "npx", "runtimeArgs": [ "-n" ],
|
||||
"args": [ "--", "cds", "run", "--with-mocks", "--in-memory?" ],
|
||||
"cwd": "${workspaceFolder}/packages/${input:service}",
|
||||
"console": "integratedTerminal",
|
||||
"serverReadyAction": {
|
||||
"pattern": "server listening on (https?://\\S+|[0-9]+)",
|
||||
"uriFormat": "http://localhost:%s",
|
||||
"action": "openExternally"
|
||||
},
|
||||
"skipFiles": ["<node_internals>/**"]
|
||||
}
|
||||
],
|
||||
@@ -31,12 +29,9 @@
|
||||
"bookstore",
|
||||
"media-server",
|
||||
"office-supplies",
|
||||
"orders-service",
|
||||
"products-service",
|
||||
"reviews-service",
|
||||
"user-service"
|
||||
"reviews-service"
|
||||
],
|
||||
"default": "bookstore"
|
||||
"default": "bookshop"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
5
.vscode/settings.json
vendored
5
.vscode/settings.json
vendored
@@ -1,7 +1,6 @@
|
||||
{
|
||||
"files.exclude": {
|
||||
"**/.gitignore": false,
|
||||
"**/.git": false,
|
||||
"**/.vscode": false
|
||||
"**/.gitignore": true,
|
||||
"**/.vscode": true
|
||||
}
|
||||
}
|
||||
|
||||
21
.vscode/tasks.json
vendored
21
.vscode/tasks.json
vendored
@@ -4,23 +4,14 @@
|
||||
"version": "2.0.0",
|
||||
"tasks": [
|
||||
{
|
||||
"type": "shell", "label": "cds run bookshop",
|
||||
"command": "npx", "args": [ "cds", "watch", "packages/bookshop" ],
|
||||
"presentation": { "group": "A" },
|
||||
"problemMatcher": []
|
||||
"type": "npm", "script": "watch", "path": "packages/bookshop/",
|
||||
"options": { "env": { "PORT": "4004" }},
|
||||
"presentation": { "group": "A" }
|
||||
},
|
||||
{
|
||||
"type": "shell", "label": "cds run bookshop-enhanced",
|
||||
"command": "npx", "args": [ "cds", "watch", "packages/bookshop-enhanced" ],
|
||||
"presentation": { "group": "A" },
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"type": "shell", "label": "cds run reviews-service",
|
||||
"command": "npx", "args": [ "cds", "watch", "packages/reviews-service" ],
|
||||
"options": {"env": { "PORT":"5005" }},
|
||||
"presentation": { "group": "A" },
|
||||
"problemMatcher": []
|
||||
"type": "npm", "script": "watch", "path": "packages/reviews-service/",
|
||||
"options": { "env": { "PORT": "5005" }},
|
||||
"presentation": { "group": "A" }
|
||||
}
|
||||
]
|
||||
}
|
||||
24
Jenkinsfile
vendored
Normal file
24
Jenkinsfile
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
#!/usr/bin/env groovy
|
||||
|
||||
/*
|
||||
* This file bootstraps the codified Continuous Delivery pipeline for extensions of SAP solutions, such as SAP S/4HANA.
|
||||
* The pipeline helps you to deliver software changes quickly and in a reliable manner.
|
||||
* A suitable Jenkins instance is required to run the pipeline.
|
||||
* The Jenkins can easily be bootstraped using the life-cycle script located inside the 'cx-server' directory.
|
||||
*
|
||||
* More information on getting started with Continuous Delivery can be found in the following places:
|
||||
* - GitHub repository: https://github.com/SAP/cloud-s4-sdk-pipeline
|
||||
* - Blog Post: https://blogs.sap.com/2017/09/20/continuous-integration-and-delivery
|
||||
*/
|
||||
|
||||
/*
|
||||
* Set pipelineVersion to a fixed released version (e.g. "v15") when running in a productive environment.
|
||||
* To find out about available versions and release notes, visit: https://github.com/SAP/cloud-s4-sdk-pipeline/releases
|
||||
*/
|
||||
String pipelineVersion = "v28"
|
||||
|
||||
node {
|
||||
deleteDir()
|
||||
sh "git clone --depth 1 https://github.com/SAP/cloud-s4-sdk-pipeline.git -b ${pipelineVersion} pipelines"
|
||||
load './pipelines/s4sdk-pipeline.groovy'
|
||||
}
|
||||
80
README.md
80
README.md
@@ -1,73 +1,45 @@
|
||||
# cloud-cap-samples
|
||||
# Welcome to SAP Cloud Application Programming model samples
|
||||
|
||||
This is a monorepository for sample projects on [SAP Cloud Application Programming Model](https://cap.cloud.sap).
|
||||
Find here the samples for the openSAP course [Building Applications with the SAP Cloud Application Programming Model](https://open.sap.com/courses/cp7).
|
||||
|
||||
## Description
|
||||
## Notes on the Demo in Week 4 Unit 4
|
||||
To add all pipeline specific file to your project, run the following command:
|
||||
|
||||
This repository provides a list of samples and reusable packages created based on SAP Cloud Application Programming Model.
|
||||
The SAP Cloud Application Programming Model enables you to quickly create business applications by allowing you to focus on your domain logic. It offers a consistent end-to-end programming model that includes languages, libraries and APIs tailored for full-stack development on SAP Cloud Platform.
|
||||
|
||||
The samples provided can be run in a local setup on SQLite Database.
|
||||
|
||||
|
||||
## Requirements
|
||||
* [Node.js](https://nodejs.org/en/) v8 or higher
|
||||
* [Git](https://git-scm.com)
|
||||
* [SQLite DB](https://www.sqlite.org/download.html) (Windows only; pre-installed on Mac/Linux)
|
||||
|
||||
#### Optional (if you want to import the code into an editor)
|
||||
* [VS Code](https://code.visualstudio.com)
|
||||
* [Add CDS extension to VS](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/be944d6d51f343f6b3f53c29c44ff00a.html)
|
||||
|
||||
## Download and Installation
|
||||
|
||||
#### Install `cds` development kit
|
||||
```sh
|
||||
# sets the registry for `@sap` packages
|
||||
npm set @sap:registry=https://npm.sap.com
|
||||
|
||||
npm install -g @sap/cds-dk
|
||||
cds #> test-run it
|
||||
cds add pipeline
|
||||
```
|
||||
Got issues? Check out the [documentation](https://cap.cloud.sap/docs/get-started/).
|
||||
|
||||
#### Clone and build the application
|
||||
`git clone https://github.com/SAP-samples/cloud-cap-samples samples && cd samples && npm i`
|
||||
Details on how to start your Jenkins in your own environment can be found in the [Operations Guide](https://github.com/SAP/devops-docker-cx-server/blob/master/docs/operations/cx-server-operations-guide.md).
|
||||
|
||||
#### Run the samples
|
||||
Please note that other than shown in the video Jenkins now is secured by default with an admin user and password.
|
||||
After you have started Jenkins with the command `cx-server start`, you can get the initial password by running `./cx-server initial-credentials`.
|
||||
|
||||
With that you're ready to run the samples, e.g. start the [_bookshop_](./packages/bookshop) sample as follows:
|
||||
The pipeline documentation can be found [here](https://sap.github.io/jenkins-library/pipelines/cloud-sdk/introduction/).
|
||||
|
||||
`npm run bookshop`
|
||||
## Get Access to SAP Business Application Studio
|
||||
The recommended environment for the course is SAP Business Application Studio. Watch [unit 2 of week 1](https://open.sap.com/courses/cp7/items/51pzQUzbXHr2kdbOmVs6jI) for how to get access.
|
||||
|
||||
## Test
|
||||
## Setup
|
||||
|
||||
For example, try these links in your browser:
|
||||
- <http://localhost:4004> to test with generic index page.
|
||||
- <http://localhost:4004/fiori.html> to test with Fiori sandbox.
|
||||
In SAP Business Application Studio, open a terminal.
|
||||
Then clone the repo with this specific branch:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/sap-samples/cloud-cap-samples -b openSAP-week4-unit4
|
||||
cd cloud-cap-samples
|
||||
```
|
||||
|
||||
## Debug
|
||||
In the `cloud-cap-samples` folder run:
|
||||
```sh
|
||||
npm install
|
||||
```
|
||||
|
||||
For example, in [VS Code](https://code.visualstudio.com) switch to _Debug_ view and launch one of the prepared _cds run_ launch configurations.
|
||||
## Get Support
|
||||
|
||||
Check out the cap docs at https://cap.cloud.sap. <br>
|
||||
In case you find a bug or need support, please [open an issue in here](https://github.com/SAP-samples/cloud-cap-samples/issues/new).
|
||||
|
||||
## Limitations
|
||||
|
||||
None
|
||||
|
||||
## Known Issues
|
||||
|
||||
None
|
||||
|
||||
## How to obtain support
|
||||
|
||||
Check out the documentation on https://cap.cloud.sap. In case you find a bug, or you need additional support, please open an issue [here](https://github.com/SAP-samples/cloud-cap-samples/issues/new) in GitHub.
|
||||
|
||||
## To-Do (upcoming changes)
|
||||
|
||||
None
|
||||
|
||||
## License
|
||||
|
||||
Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under SAP Sample Code License Agreement, except as noted otherwise in the [LICENSE](/LICENSE) file.
|
||||
Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under SAP Sample Code License Agreement, except as noted otherwise in the [LICENSE](/LICENSE) file.
|
||||
|
||||
@@ -43,7 +43,7 @@
|
||||
<script src="https://sapui5.hana.ondemand.com/resources/sap-ui-core.js"
|
||||
data-sap-ui-libs="sap.m, sap.ushell, sap.collaboration, sap.ui.layout"
|
||||
data-sap-ui-compatVersion="edge"
|
||||
data-sap-ui-theme="sap_belize"
|
||||
data-sap-ui-theme="sap_fiori_3"
|
||||
data-sap-ui-frameOptions="allow"
|
||||
></script>
|
||||
<script>
|
||||
@@ -1 +0,0 @@
|
||||
{"packages":["packages/*"],"version":"1.0.0"}
|
||||
64
mta.yaml
Normal file
64
mta.yaml
Normal file
@@ -0,0 +1,64 @@
|
||||
####### Generated mta.yaml based on template version 0.2.0
|
||||
####### appName = capire-bookshop
|
||||
####### language=nodejs; multiTenant=
|
||||
####### approuter=
|
||||
|
||||
_schema-version: '3.1'
|
||||
ID: sap.capire-bookshop
|
||||
version: 1.0.0
|
||||
description: "A simple bookshop application, build in a self-contained all-in-one fashion, i.e. w/o reusing other packages."
|
||||
|
||||
build-parameters:
|
||||
before-all:
|
||||
- builder: custom
|
||||
commands:
|
||||
- npm install
|
||||
- cds build/all
|
||||
|
||||
parameters:
|
||||
enable-parallel-deployments: true
|
||||
|
||||
modules:
|
||||
############## SERVER MODULE ##########################
|
||||
- name: capire-bookshop-srv
|
||||
type: nodejs
|
||||
path: gen/srv
|
||||
properties:
|
||||
EXIT: 1 # required by deploy.js task to terminate
|
||||
|
||||
|
||||
requires:
|
||||
#### Resources extracted from CAP configuration ####
|
||||
- name: capire-bookshop-db
|
||||
|
||||
provides:
|
||||
- name: srv-binding # required by consumers of CAP services (e.g. approuter)
|
||||
properties:
|
||||
srv-url: ${default-url}
|
||||
|
||||
############################################################
|
||||
|
||||
############## SIDECAR MODULE #########################
|
||||
- name: db
|
||||
|
||||
type: hdb
|
||||
path: gen/db
|
||||
parameters:
|
||||
app-name: capire-bookshop-db
|
||||
requires:
|
||||
#### Hana and xsuaa resources extracted from CAP configuration ####
|
||||
- name: capire-bookshop-db
|
||||
############################################################
|
||||
|
||||
|
||||
############## RESOURCES ##################################
|
||||
resources:
|
||||
##### Services extracted from CAP configuration ####
|
||||
##### 'service-plan' can be configured via 'cds.requires.<name>.vcap.plan'
|
||||
- name: capire-bookshop-db
|
||||
type: com.sap.xs.hdi-container
|
||||
|
||||
parameters:
|
||||
properties:
|
||||
hdi-service-name: ${service-name} # required for Java case
|
||||
############################################################
|
||||
2088
package-lock.json
generated
Normal file
2088
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
47
package.json
47
package.json
@@ -1,28 +1,29 @@
|
||||
{
|
||||
"name": "@sap/capire-samples",
|
||||
"description": "The umbrella project for all samples to easily setup for local development and tests.",
|
||||
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
|
||||
"author": "daniel.hutzel@sap.com",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"cleanup": "lerna clean -y && rm -fr node_modules",
|
||||
"install": "(npm -s run lerna) && lerna bootstrap --hoist",
|
||||
"lerna": "npx --no-install lerna -v > /dev/null || npm i lerna --no-save",
|
||||
"test": "jest",
|
||||
"bookshop-enhanced": "cds watch packages/bookshop-enhanced",
|
||||
"bookshop": "cds watch packages/bookshop",
|
||||
"bookstore": "cds watch packages/bookstore",
|
||||
"products-service": "cds watch packages/products-service",
|
||||
"reviews-service": "cds watch packages/reviews-service"
|
||||
},
|
||||
"name": "@sap/capire-bookshop",
|
||||
"version": "1.0.0",
|
||||
"description": "A simple bookshop application, build in a self-contained all-in-one fashion, i.e. w/o reusing other packages.",
|
||||
"license": "SAP SAMPLE CODE LICENSE",
|
||||
"dependencies": {
|
||||
"@sap/cds": "latest",
|
||||
"express": "*"
|
||||
"@sap/cds": "^3",
|
||||
"express": "^4",
|
||||
"@sap/hana-client": "^2.4.182"
|
||||
},
|
||||
"--add-these-to-devDependencies-for-tests": {
|
||||
"@types/jest": "*",
|
||||
"sqlite3": "*",
|
||||
"jest": "*"
|
||||
"devDependencies": {
|
||||
"sqlite3": "^4.1.1"
|
||||
},
|
||||
"license": "SAP SAMPLE CODE LICENSE"
|
||||
"scripts": {
|
||||
"start": "cds run",
|
||||
"watch": "cds watch"
|
||||
},
|
||||
"cds": {
|
||||
"requires": {
|
||||
"db": {
|
||||
"kind": "hana",
|
||||
"model": [
|
||||
"db",
|
||||
"srv"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
using from '@sap/capire-bookshop/app';
|
||||
@@ -1,25 +0,0 @@
|
||||
/*
|
||||
In this model we demonstrate how to add Genres to Books in
|
||||
as if it was an external extension. For example we use
|
||||
CDS Aspects' to extend the core domain model's Books entity
|
||||
as well as the AdminService.
|
||||
*/
|
||||
|
||||
namespace sap.capire.bookshop;
|
||||
using { sap.capire.reviews.ReviewsService as external } from '@sap/capire-reviews';
|
||||
using { sap.capire.bookshop.Books } from '@sap/capire-bookshop/db/schema';
|
||||
using { sap.common.CodeList } from '@sap/cds/common';
|
||||
|
||||
// Extending Books by Reviews and Genres
|
||||
extend Books with {
|
||||
reviews : Composition of many external.Reviews on reviews.subject = ID;
|
||||
rating : external.Reviews.rating;
|
||||
genre : Association to Genres;
|
||||
}
|
||||
|
||||
// Hierarchical Code List for Genres
|
||||
entity Genres : CodeList {
|
||||
key ID : Integer;
|
||||
children : Composition of many Genres on children.parent = $self;
|
||||
parent : Association to Genres;
|
||||
}
|
||||
@@ -1,27 +0,0 @@
|
||||
{
|
||||
"name": "@sap/capire-bookshop-enhanced",
|
||||
"version": "1.0.0",
|
||||
"description": "A sample for extending a base application package, in this case bookshop, e.g. in context of verticalization or customization.",
|
||||
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
|
||||
"license": "SAP SAMPLE CODE LICENSE",
|
||||
"dependencies": {
|
||||
"@sap/capire-bookshop": "^1.0.0",
|
||||
"@sap/capire-reviews": "^1.0.0",
|
||||
"@sap/cds": "latest",
|
||||
"express": "*"
|
||||
},
|
||||
"scripts": {
|
||||
"start": "npx cds run"
|
||||
},
|
||||
"cds": {
|
||||
"requires": {
|
||||
"sap.capire.reviews.ReviewsService": {
|
||||
"kind": "odata",
|
||||
"model": "@sap/capire-reviews"
|
||||
},
|
||||
"messaging": {
|
||||
"kind": "file-based-messaging"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,9 +0,0 @@
|
||||
namespace sap.capire.bookshop;
|
||||
|
||||
using { AdminService } from '@sap/capire-bookshop/srv/admin-service';
|
||||
using { sap.capire.bookshop } from '../db/schema';
|
||||
|
||||
@impl:'srv/services'
|
||||
extend service AdminService with {
|
||||
entity Genres as projection on bookshop.Genres;
|
||||
}
|
||||
@@ -1,30 +0,0 @@
|
||||
const cds = require ('@sap/cds')
|
||||
|
||||
module.exports = cds.service.impl (async()=>{
|
||||
|
||||
const ReviewsService = await cds.connect.to ('sap.capire.reviews.ReviewsService')
|
||||
const CatalogService = await cds.connect.to ('CatalogService')
|
||||
const db = await cds.connect.to ('db')
|
||||
// import model definitions from connected services to work with subsequently
|
||||
const { Books } = db.entities
|
||||
const { Reviews } = ReviewsService.entities
|
||||
|
||||
CatalogService.impl (srv => {
|
||||
// delegate requests to read reviews to ReviewsService
|
||||
srv.on ('READ', 'Books/reviews', (req) => {
|
||||
const [ subject ] = req.params
|
||||
const tx = ReviewsService.transaction (req)
|
||||
return tx.run (SELECT.from (Reviews) .where ({subject}))
|
||||
})
|
||||
})
|
||||
|
||||
// react on event messages from reviews service
|
||||
ReviewsService.on ('reviewed', (msg) => {
|
||||
console.debug ('> received:', msg.event, msg.data)
|
||||
const { subject, rating } = msg.data
|
||||
const tx = db // TODO: db.transaction (msg)
|
||||
return tx.run (UPDATE (Books, subject) .with ({rating}))
|
||||
// return tx.update (Books, subject) .with ({rating})
|
||||
})
|
||||
|
||||
})
|
||||
@@ -1,33 +0,0 @@
|
||||
#################################################
|
||||
#
|
||||
# Genres
|
||||
#
|
||||
|
||||
GET http://localhost:4004/admin/Genres?
|
||||
###
|
||||
|
||||
POST http://localhost:4004/admin/Genres?
|
||||
Content-Type: application/json
|
||||
|
||||
{ "ID":100, "name":"Some Sample Genres...", "children":[
|
||||
{ "ID":101, "name":"Cat", "children":[
|
||||
{ "ID":102, "name":"Kitty", "children":[
|
||||
{ "ID":103, "name":"Kitty Cat", "children":[
|
||||
{ "ID":104, "name":"Aristocat" } ]},
|
||||
{ "ID":105, "name":"Kitty Bat" } ]},
|
||||
{ "ID":106, "name":"Catwoman", "children":[
|
||||
{ "ID":107, "name":"Catalina" } ]} ]},
|
||||
{ "ID":108, "name":"Catweazle" }
|
||||
]}
|
||||
###
|
||||
|
||||
GET http://localhost:4004/admin/Genres(100)?
|
||||
# &$expand=children
|
||||
# &$expand=children($expand=children($expand=children($expand=children)))
|
||||
###
|
||||
|
||||
DELETE http://localhost:4004/admin/Genres(103)
|
||||
###
|
||||
|
||||
DELETE http://localhost:4004/admin/Genres(100)
|
||||
###
|
||||
@@ -1,32 +0,0 @@
|
||||
#################################################
|
||||
#
|
||||
# Reviews Service
|
||||
#
|
||||
|
||||
|
||||
### Use this one for ReviewsService running as a separate process
|
||||
# Note: use 5005 instead of 4004 in case of separate service
|
||||
POST http://localhost:5005/reviews/Reviews
|
||||
# POST http://localhost:4004/reviews/Reviews
|
||||
Content-Type: application/json;IEEE754Compatible=true
|
||||
|
||||
{"subject":"201", "rating":"5", "title":"boo"}
|
||||
|
||||
### Direct Request to ReviewsService
|
||||
# Note: use 5005 instead of 4004 in case of separate service
|
||||
GET http://localhost:5005/reviews/Reviews?
|
||||
# GET http://localhost:4004/reviews/Reviews?
|
||||
# &$filter=subject eq '201'
|
||||
|
||||
|
||||
### Request to CatalogService > delegated to ReviewsService
|
||||
GET http://localhost:4004/browse/Books(201)/reviews
|
||||
|
||||
### Alternative OData URL
|
||||
GET http://localhost:4004/browse/Books/201/reviews
|
||||
|
||||
###
|
||||
GET http://localhost:4004/browse/Books(201)?
|
||||
&$select=ID,title,rating
|
||||
# &$expand=reviews
|
||||
# Note: the latter only works in case of ReviewsService in same process
|
||||
@@ -1,13 +0,0 @@
|
||||
{
|
||||
"name": "@sap/capire-bookshop",
|
||||
"version": "1.0.0",
|
||||
"description": "A simple bookshop application, build in a self-contained all-in-one fashion, i.e. w/o reusing other packages.",
|
||||
"license": "SAP SAMPLE CODE LICENSE",
|
||||
"dependencies": {
|
||||
"@sap/cds": "latest",
|
||||
"express": "*"
|
||||
},
|
||||
"scripts": {
|
||||
"start": "npx cds run"
|
||||
}
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
ID;firstname;lastname;dateOfBirth;placeOfBirth;dateOfDeath;placeOfDeath
|
||||
101;Emily;Brontë;1818-07-30;Thornton, Yorkshire;1848-12-19;Haworth, Yorkshire
|
||||
107;Charlotte;Brontë;1818-04-21;Thornton, Yorkshire;1855-03-31;Haworth, Yorkshire
|
||||
150;Edgar Allen;Poe;1809-01-19;Boston, Massachusetts;1849-10-07;Baltimore, Maryland
|
||||
170;Richard;Carpenter;1929-08-14;King’s Lynn, Norfolk;2012-02-26;Hertfordshire, England
|
||||
|
@@ -1,11 +0,0 @@
|
||||
ID;parent_ID;name
|
||||
1;;Poetry
|
||||
2;;Biography
|
||||
3;;Fantasy
|
||||
4;;Science Fiction
|
||||
5;;Romance
|
||||
6;;Mystery
|
||||
7;;Thriller
|
||||
8;;Dystopia
|
||||
9;;Tragedy
|
||||
10;;Novel
|
||||
|
@@ -1,6 +0,0 @@
|
||||
ID;title;descr;author_ID;stock;price;currency_code;category_ID
|
||||
201;Wuthering Heights;"Wuthering Heights, Emily Brontë's only novel, was published in 1847 under the pseudonym ""Ellis Bell"". It was written between October 1845 and June 1846. Wuthering Heights and Anne Brontë's Agnes Grey were accepted by publisher Thomas Newby before the success of their sister Charlotte's novel Jane Eyre. After Emily's death, Charlotte edited the manuscript of Wuthering Heights and arranged for the edited version to be published as a posthumous second edition in 1850.";101;12;11.11;GBP;9
|
||||
207;Jane Eyre;"Jane Eyre /ɛər/ (originally published as Jane Eyre: An Autobiography) is a novel by English writer Charlotte Brontë, published under the pen name ""Currer Bell"", on 16 October 1847, by Smith, Elder & Co. of London. The first American edition was published the following year by Harper & Brothers of New York. Primarily a bildungsroman, Jane Eyre follows the experiences of its eponymous heroine, including her growth to adulthood and her love for Mr. Rochester, the brooding master of Thornfield Hall. The novel revolutionised prose fiction in that the focus on Jane's moral and spiritual development is told through an intimate, first-person narrative, where actions and events are coloured by a psychological intensity. The book contains elements of social criticism, with a strong sense of Christian morality at its core and is considered by many to be ahead of its time because of Jane's individualistic character and how the novel approaches the topics of class, sexuality, religion and feminism.";107;11;12.34;GBP;10
|
||||
251;The Raven;"“The Raven"" is a narrative poem by American writer Edgar Allan Poe. First published in January 1845, the poem is often noted for its musicality, stylized language, and supernatural atmosphere. It tells of a talking raven's mysterious visit to a distraught lover, tracing the man's slow fall into madness. The lover, often identified as being a student, is lamenting the loss of his love, Lenore. Sitting on a bust of Pallas, the raven seems to further distress the protagonist with its constant repetition of the word ""Nevermore"". The poem makes use of folk, mythological, religious, and classical references.";150;333;13.13;USD;1
|
||||
252;Eleonora;"""Eleonora"" is a short story by Edgar Allan Poe, first published in 1842 in Philadelphia in the literary annual The Gift. It is often regarded as somewhat autobiographical and has a relatively ""happy"" ending.";150;555;14;USD;5
|
||||
271;Catweazle;Catweazle is a British fantasy television series, starring Geoffrey Bayldon in the title role, and created by Richard Carpenter for London Weekend Television. The first series, produced and directed by Quentin Lawrence, was screened in the UK on ITV in 1970. The second series, directed by David Reid and David Lane, was shown in 1971. Each series had thirteen episodes, most but not all written by Carpenter, who also published two books based on the scripts.;170;22;15;EUR;3
|
||||
|
@@ -1,4 +0,0 @@
|
||||
ID;locale;title;descr
|
||||
201;de;Sturmhöhe;Sturmhöhe (Originaltitel: Wuthering Heights) ist der einzige Roman der englischen Schriftstellerin Emily Brontë (1818–1848). Der 1847 unter dem Pseudonym Ellis Bell veröffentlichte Roman wurde vom viktorianischen Publikum weitgehend abgelehnt, heute gilt er als ein Klassiker der britischen Romanliteratur des 19. Jahrhunderts.
|
||||
207;de;Jane Eyre;Jane Eyre. Eine Autobiographie (Originaltitel: Jane Eyre. An Autobiography), erstmals erschienen im Jahr 1847 unter dem Pseudonym Currer Bell, ist der erste veröffentlichte Roman der britischen Autorin Charlotte Brontë und ein Klassiker der viktorianischen Romanliteratur des 19. Jahrhunderts. Der Roman erzählt in Form einer Ich-Erzählung die Lebensgeschichte von Jane Eyre (ausgesprochen /ˌdʒeɪn ˈɛə/), die nach einer schweren Kindheit eine Stelle als Gouvernante annimmt und sich in ihren Arbeitgeber verliebt, jedoch immer wieder um ihre Freiheit und Selbstbestimmung kämpfen muss. Als klein, dünn, blass, stets schlicht dunkel gekleidet und mit strengem Mittelscheitel beschrieben, gilt die Heldin des Romans Jane Eyre nicht zuletzt aufgrund der Kino- und Fernsehversionen der melodramatischen Romanvorlage als die bekannteste englische Gouvernante der Literaturgeschichte
|
||||
252;de;Eleonora;“Eleonora” ist eine Erzählung von Edgar Allan Poe. Sie wurde 1841 erstveröffentlicht. In ihr geht es um das Paradox der Treue in der Treulosigkeit.
|
||||
|
@@ -1,18 +0,0 @@
|
||||
namespace sap.capire.bookstore;
|
||||
|
||||
// We reuse Products, which are Books in our domain
|
||||
using { sap.capire.products.Products as Books } from '@sap/capire-products';
|
||||
extend Books with {
|
||||
author : Association to Authors;
|
||||
rating : Decimal(2,1);
|
||||
}
|
||||
|
||||
// We reuse aspect Person to define Authors
|
||||
using { sap.capire.contacts.Person } from '@sap/capire-contacts';
|
||||
entity Authors : Person {
|
||||
key ID : UUID;
|
||||
books : Association to many Books on books.author = $self;
|
||||
}
|
||||
|
||||
// we use enhanced currencies code lists
|
||||
using from '@sap/capire-currencies';
|
||||
@@ -1,47 +0,0 @@
|
||||
{
|
||||
"name": "@sap/capire-bookstore",
|
||||
"version": "1.0.0",
|
||||
"description": "A variant of the bookshop application, built on top of products-service and common reuse packages.",
|
||||
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
|
||||
"license": "SAP SAMPLE CODE LICENSE",
|
||||
"dependencies": {
|
||||
"@sap/capire-products": "^1.0.0",
|
||||
"@sap/capire-reviews": "^1.0.0",
|
||||
"@sap/capire-orders": "^1.0.0",
|
||||
"@sap/capire-media": "^1.0.0",
|
||||
"@sap/capire-users": "^1.0.0",
|
||||
"@sap/capire-contacts": "^1.0.0",
|
||||
"@sap/capire-currencies": "^1.0.0",
|
||||
"@sap/cds": "latest",
|
||||
"express": "*"
|
||||
},
|
||||
"bundledDependencies": [
|
||||
"@sap/capire-products",
|
||||
"@sap/capire-reviews",
|
||||
"@sap/capire-orders",
|
||||
"@sap/capire-media",
|
||||
"@sap/capire-users",
|
||||
"@sap/capire-contacts",
|
||||
"@sap/capire-currencies"
|
||||
],
|
||||
"files": [
|
||||
"app", "srv", "db"
|
||||
],
|
||||
"scripts": {
|
||||
"start": "cds run"
|
||||
},
|
||||
"cds": {
|
||||
"requires": {
|
||||
"db": {
|
||||
"kind": "sql"
|
||||
},
|
||||
"sap.capire.media.MediaServer": {
|
||||
"kind": "rest"
|
||||
},
|
||||
"sap.capire.reviews.ReviewsService": {
|
||||
"model": "@sap/capire-reviews",
|
||||
"kind": "odata"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,12 +0,0 @@
|
||||
//----------------------
|
||||
// workarounds -> should be done by @cds-compiler
|
||||
|
||||
annotate cds.UUID with @odata.Type: 'Edm.String';
|
||||
|
||||
using from '@sap/capire-products';
|
||||
annotate sap.capire.products.Products with { texts @odata.contained }
|
||||
annotate sap.capire.products.Categories with { texts @odata.contained }
|
||||
|
||||
annotate sap.capire.reviews.ReviewsService with @imported;
|
||||
annotate sap.capire.reviews.Reviews with @cds.persistence.skip;
|
||||
annotate sap.capire.reviews.Likes with @cds.persistence.skip;
|
||||
@@ -1,35 +0,0 @@
|
||||
namespace sap.capire.bookstore;
|
||||
|
||||
// Service for all users to browse books
|
||||
using { sap.capire.products } from '../db/schema';
|
||||
|
||||
service CatalogService @(path:'browse'){
|
||||
|
||||
@readonly entity Books as select from products.Products { *,
|
||||
author.firstname ||' '|| author.lastname as author : String,
|
||||
category.name as genre,
|
||||
} excluding { createdBy, modifiedBy };
|
||||
|
||||
@readonly entity Genres as projection on products.Categories;
|
||||
|
||||
}
|
||||
|
||||
// Reuse AdminService from @sap/capire-products...
|
||||
using { sap.capire.products.AdminService } from '@sap/capire-products';
|
||||
using { sap.capire.bookstore as my } from '../db/schema';
|
||||
|
||||
extend service AdminService with @(impl:'srv/services.js') {
|
||||
entity Authors as projection on my.Authors;
|
||||
}
|
||||
|
||||
// Adding reviews via @sap/capire-reviews service
|
||||
using { sap.capire.reviews.ReviewsService as external } from '@sap/capire-reviews';
|
||||
extend service CatalogService with {
|
||||
@readonly entity Reviews as projection on external.Reviews;
|
||||
}
|
||||
|
||||
|
||||
// Adding images via @sap/capire-media service
|
||||
using from '@sap/capire-media';
|
||||
// using from '@sap/capire-orders';
|
||||
// using from '@sap/capire-users';
|
||||
@@ -1,38 +0,0 @@
|
||||
const cds = require('@sap/cds')
|
||||
module.exports['sap.capire.bookstore.CatalogService'] = cds.service.impl (async (srv) => {
|
||||
|
||||
const ReviewsService = await cds.connect.to ('sap.capire.reviews.ReviewsService')
|
||||
const { Reviews } = ReviewsService.entities
|
||||
const { Books } = srv.entities
|
||||
|
||||
// delegate requests to reviews service
|
||||
srv.on('READ', 'Reviews', async (req) => {
|
||||
const { SELECT } = cds.ql(req)
|
||||
const results = await SELECT.from (Reviews)
|
||||
|
||||
// TODO: Should actually be using .where of fluent query API
|
||||
if (req.query.SELECT.where) {
|
||||
return results.filter (row => row.subject === req.query.SELECT.where[2].val)
|
||||
}
|
||||
|
||||
return results
|
||||
})
|
||||
|
||||
// react on event messages from reviews service
|
||||
ReviewsService.on ('reviewed', (msg) => {
|
||||
console.debug ('> received message:', msg.event, msg.data)
|
||||
const {subject,rating} = msg.data
|
||||
const tx = cds // cds.transaction(msg) // TODO: how to add multi-tenancy?
|
||||
return tx.run (UPDATE(Books).set({rating}) .where ({ID:subject})) //.then (console.log)
|
||||
})
|
||||
|
||||
})
|
||||
|
||||
|
||||
// FIXME: pls remove this...
|
||||
process.env.destinations = JSON.stringify([{
|
||||
name: 'reviewsDest',
|
||||
url: 'http://localhost:4005/reviews',
|
||||
username: 'dummy',
|
||||
password: 'dummy'
|
||||
}])
|
||||
@@ -1,7 +0,0 @@
|
||||
using { sap.capire.products as my } from '../db/schema';
|
||||
|
||||
service BooksService {
|
||||
entity Books as SELECT from my.Products;
|
||||
}
|
||||
|
||||
annotate cds.UUID with @odata.Type: 'Edm.String';
|
||||
@@ -1,190 +0,0 @@
|
||||
const cds = require ('@sap/cds')
|
||||
|
||||
describe('Localized data on db level', ()=>{
|
||||
|
||||
let db, Books
|
||||
|
||||
it ('should deploy the db schema to sqlite in-memory', async()=>{
|
||||
db = await cds.deploy (__dirname+'/books') .to ('sqlite::memory:')
|
||||
expect (db.model) .toBeDefined()
|
||||
Books = db.entities('sap.capire.products').Products
|
||||
expect (Books) .toBeDefined()
|
||||
})
|
||||
|
||||
it ('should list all books with default language', async ()=>{
|
||||
const books = await SELECT.from (Books, b=>b.title)
|
||||
expect (books) .toMatchObject([
|
||||
{ title: 'Wuthering Heights' },
|
||||
{ title: 'Jane Eyre' },
|
||||
{ title: 'The Raven' },
|
||||
{ title: 'Eleonora' },
|
||||
{ title: 'Catweazle' }
|
||||
])
|
||||
})
|
||||
|
||||
|
||||
it ('should read translated texts from Books_texts', async ()=>{
|
||||
const texts = await SELECT ('locale','title').from (Books+'_texts')
|
||||
expect (texts) .toMatchObject ([
|
||||
{ locale: 'de', title: 'Sturmhöhe' },
|
||||
{ locale: 'de', title: 'Jane Eyre' },
|
||||
{ locale: 'de', title: 'Eleonora' }
|
||||
])
|
||||
})
|
||||
|
||||
it ('should read translated texts from Books.texts', async ()=>{
|
||||
const book = await SELECT.one.from (Books, b=>{
|
||||
b.ID, b.title, b.texts(t=> {
|
||||
t.locale, t.title
|
||||
})
|
||||
}) .where ({title:'Wuthering Heights'})
|
||||
expect (book) .toMatchObject ({
|
||||
title: 'Wuthering Heights', texts:[
|
||||
{locale:'de',title:'Sturmhöhe'}
|
||||
]
|
||||
})
|
||||
})
|
||||
|
||||
it ('should insert books with translated texts', async ()=>{
|
||||
const n = await INSERT.into (Books) .entries ({ ID:444, title:'A New Book', texts:[
|
||||
{locale:'de', title:'Ein Neues Buch'},
|
||||
{locale:'fr', title:'Un Nouveau Livre'},
|
||||
]})
|
||||
expect(n).toBe(3)
|
||||
})
|
||||
|
||||
it ('should delete books w/ cascaded delete to texts', async()=>{
|
||||
const n = await DELETE.from(Books) .where ({ID:444})
|
||||
expect(n).toBe(3)
|
||||
})
|
||||
|
||||
})
|
||||
|
||||
|
||||
describe('Localized data on service level', ()=>{
|
||||
|
||||
let srv, Books
|
||||
|
||||
it ('should serve BooksService', async()=>{
|
||||
srv = await cds.serve('BooksService').from(__dirname+'/books')
|
||||
expect (srv.model) .toBeDefined()
|
||||
Books = srv.entities.Books
|
||||
expect (Books) .toBeDefined()
|
||||
})
|
||||
|
||||
it ('should list all books with default language', async ()=>{
|
||||
const books = await srv.read (Books, b=>b.title)
|
||||
expect (books) .toMatchObject([
|
||||
{ title: 'Wuthering Heights' },
|
||||
{ title: 'Jane Eyre' },
|
||||
{ title: 'The Raven' },
|
||||
{ title: 'Eleonora' },
|
||||
{ title: 'Catweazle' }
|
||||
])
|
||||
})
|
||||
|
||||
it ('should read Books with translated texts', async ()=>{
|
||||
const book = await srv.run (
|
||||
SELECT.from (Books, b=>{ b.ID, b.title, b.texts(t=> {
|
||||
t.locale, t.title
|
||||
})}) .where ({title:'Wuthering Heights'})
|
||||
)
|
||||
expect (book) .toMatchObject ([{
|
||||
title: 'Wuthering Heights', texts:[
|
||||
{locale:'de',title:'Sturmhöhe'}
|
||||
]
|
||||
}])
|
||||
})
|
||||
|
||||
it ('should do the same with convenient method', async ()=>{
|
||||
const book = await srv.read (Books, b=>{ b.ID, b.title, b.texts(t=> {
|
||||
t.locale, t.title
|
||||
})}) .where ({title:'Wuthering Heights'})
|
||||
expect (book) .toMatchObject ([{
|
||||
title: 'Wuthering Heights', texts:[
|
||||
{locale:'de',title:'Sturmhöhe'}
|
||||
]
|
||||
}])
|
||||
})
|
||||
|
||||
it ('should read single Book with translated texts', async ()=>{
|
||||
const book = await srv.run (
|
||||
SELECT.one.from (Books, b=>{ b.ID, b.title, b.texts(t=> {
|
||||
t.locale, t.title
|
||||
})}) .where ({title:'Wuthering Heights'})
|
||||
)
|
||||
expect (book) .toMatchObject ({
|
||||
title: 'Wuthering Heights', texts:[
|
||||
{locale:'de',title:'Sturmhöhe'}
|
||||
]
|
||||
})
|
||||
})
|
||||
|
||||
it ('should insert books with translated texts', async ()=>{
|
||||
const book = { ID:444, title:'A New Book', texts:[
|
||||
{locale:'de', title:'Ein Neues Buch'},
|
||||
{locale:'fr', title:'Un Nouveau Livre'},
|
||||
]}
|
||||
const response = await srv.create (Books) .entries (book)
|
||||
expect(response).toMatchObject(book)
|
||||
})
|
||||
|
||||
it ('should delete books w/ cascaded delete to texts', async()=>{
|
||||
await srv.delete('Books') .where ({ID:444})
|
||||
})
|
||||
})
|
||||
|
||||
|
||||
describe('Localized data on OData level', () => {
|
||||
|
||||
const app = require('express')()
|
||||
const srv = require('supertest')(app)
|
||||
|
||||
it ('should serve BooksService', async ()=>{
|
||||
await cds.serve('BooksService').from(__dirname+'/books') .in (app)
|
||||
})
|
||||
|
||||
it('should list all books with default language', async () => {
|
||||
const books = await srv.get('/books/Books/201/title')
|
||||
expect(books.body).toMatchObject({'value': 'Wuthering Heights'})
|
||||
})
|
||||
|
||||
it('should read books with translated texts', async () => {
|
||||
const books = await srv.get('/books/Books/201/title'). set('Accept-Language', 'de')
|
||||
expect(books.body).toMatchObject({value: 'Sturmhöhe'})
|
||||
})
|
||||
|
||||
it('should expand translated texts in Book', async () => {
|
||||
const books = await srv. get('/books/Books/201?$select=title&$expand=texts($select=locale,title)')
|
||||
expect(books.body).toMatchObject({
|
||||
title: 'Wuthering Heights',
|
||||
texts: [
|
||||
{ locale: 'de', title: 'Sturmhöhe', },
|
||||
],
|
||||
})
|
||||
})
|
||||
|
||||
const book = {
|
||||
title: 'New Book', descr: 'Lorem Ipsum',
|
||||
texts: [
|
||||
{ locale: 'de', title: 'Neues Buch', descr: 'Dolor sit amet' },
|
||||
{ locale: 'fr', title: 'Nouveau Livre', descr: 'consetetur sadipscing elitr' }
|
||||
],
|
||||
}
|
||||
|
||||
it('should insert books with translated texts', async () => {
|
||||
const {body} = await srv.post('/books/Books').send(book)
|
||||
expect(body).toMatchObject(book)
|
||||
book.ID = body.ID
|
||||
})
|
||||
|
||||
it ('should read the newly created book', async()=>{
|
||||
const {body} = await srv.get('/books/Books/'+book.ID+'?$expand=texts').send(book)
|
||||
expect(body).toMatchObject(book)
|
||||
})
|
||||
|
||||
it ('should delete books w/ cascaded delete to texts', async()=>{
|
||||
await srv.delete('/books/Books/'+book.ID)
|
||||
.expect(204)
|
||||
})
|
||||
})
|
||||
@@ -1,37 +0,0 @@
|
||||
using { sap.capire.contacts.PostalAddress } from './schema';
|
||||
using { sap } from '@sap/cds/common';
|
||||
namespace sap.capire.contacts;
|
||||
|
||||
/**
|
||||
* The Code Lists below are designed as optional extensions to
|
||||
* the base schema. Switch them on by adding an Association to
|
||||
* one of the code list entities in your models or by:
|
||||
* annotate sap.common.Countries with @cds.persistence.skip:false;
|
||||
*/
|
||||
|
||||
entity Countries as select from sap.common.Countries;
|
||||
extend sap.common.Countries {
|
||||
regions : Composition of many Regions on regions._parent = $self.code;
|
||||
}
|
||||
entity Regions : sap.common.CodeList {
|
||||
key code : String(5); // ISO 3166-2 alpha5 codes, e.g. DE-BW
|
||||
children : Composition of many Regions on children._parent = $self.code;
|
||||
cities : Composition of many Cities on cities.region = $self;
|
||||
_parent : String(11);
|
||||
}
|
||||
entity Cities : sap.common.CodeList {
|
||||
key code : String(11);
|
||||
region : Association to Regions;
|
||||
districts : Composition of many Districts on districts.city = $self;
|
||||
}
|
||||
entity Districts : sap.common.CodeList {
|
||||
key code : String(11);
|
||||
city : Association to Cities;
|
||||
}
|
||||
|
||||
annotate PostalAddress with {
|
||||
district @ref: sap.capire.contacts.Districts;
|
||||
city @ref: sap.capire.contacts.Cities;
|
||||
region @ref: sap.capire.contacts.Regions;
|
||||
country @ref: sap.capire.contacts.Countries;
|
||||
}
|
||||
@@ -1,12 +0,0 @@
|
||||
code;name;descr
|
||||
AU;Australia;Commonwealth of Australia
|
||||
CA;Canada;Canada
|
||||
CN;China;People's Republic of China (PRC)
|
||||
FR;France;French Republic
|
||||
DE;Germany;Federal Republic of Germany
|
||||
IN;India;Republic of India
|
||||
IL;Israel;State of Israel
|
||||
MM;Myanmar;Republic of the Union of Myanmar
|
||||
GB;United Kingdom;United Kingdom of Great Britain and Northern Ireland
|
||||
US;United States;United States of America (USA)
|
||||
EU;European Union;European Union
|
||||
|
@@ -1,12 +0,0 @@
|
||||
code;locale;name;descr
|
||||
AU;de;Australien;Commonwealth Australien
|
||||
CA;de;Kanada;Canada
|
||||
CN;de;China;Volksrepublik China
|
||||
FR;de;Frankreich;Republik Frankreich
|
||||
DE;de;Deutschland;Bundesrepublik Deutschland
|
||||
IN;de;Indien;Republik Indien
|
||||
IL;de;Israel;Staat Israel
|
||||
MM;de;Myanmar;Republik der Union Myanmar
|
||||
GB;de;Vereinigtes Königreich;Vereinigtes Königreich Großbritannien und Nordirland
|
||||
US;de;Vereinigte Staaten;Vereinigte Staaten von Amerika
|
||||
EU;de;Europäische Union;Europäische Union
|
||||
|
@@ -1,58 +0,0 @@
|
||||
namespace sap.capire.contacts;
|
||||
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Aspects
|
||||
|
||||
|
||||
aspect Organization {
|
||||
orgname : String(111);
|
||||
}
|
||||
|
||||
aspect Person {
|
||||
firstname : String(111);
|
||||
lastname : String(111);
|
||||
prefix : String(11);
|
||||
suffix : String(11);
|
||||
middle : String(11);
|
||||
dateOfBirth : Date; placeOfBirth : String;
|
||||
dateOfDeath : Date; placeOfDeath : String;
|
||||
}
|
||||
|
||||
aspect PostalAddress {
|
||||
street : String(222) @multiline;
|
||||
postCode : String(11);
|
||||
district : String(111);
|
||||
city : String(111);
|
||||
region : String(111);
|
||||
country : String(111);
|
||||
}
|
||||
|
||||
aspect ContactOptions {
|
||||
email : String @JSON:[{ kind:String, address: EmailAddress }];
|
||||
phone : String @JSON:[{ kind:String, number: PhoneNumber }];
|
||||
// phone : array of { kind:String; number: PhoneNumber };
|
||||
// addresses : Composition of many PostalAddress;
|
||||
}
|
||||
|
||||
type EmailAddress : String;
|
||||
type PhoneNumber : String;
|
||||
|
||||
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Entities
|
||||
|
||||
@cds.persistence.skip:'if-unused'
|
||||
entity Contacts : Person, Organization, ContactOptions {
|
||||
key ID : UUID;
|
||||
isOrg : Boolean;
|
||||
addresses : Composition of many PostalAddresses on addresses.contact = $self;
|
||||
}
|
||||
|
||||
@cds.persistence.skip:'if-unused'
|
||||
entity PostalAddresses : PostalAddress {
|
||||
contact : Association to Contacts;
|
||||
kind : String;
|
||||
key ID : UUID;
|
||||
}
|
||||
@@ -1,2 +0,0 @@
|
||||
using from './db/code-lists';
|
||||
using from './db/schema';
|
||||
@@ -1,10 +0,0 @@
|
||||
{
|
||||
"name": "@sap/capire-contacts",
|
||||
"version": "1.0.0",
|
||||
"description": "A reuse package providing common domain models and services for contacts-related data.",
|
||||
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
|
||||
"license": "SAP SAMPLE CODE LICENSE",
|
||||
"dependencies": {
|
||||
"@sap/cds": "latest"
|
||||
}
|
||||
}
|
||||
@@ -1,67 +0,0 @@
|
||||
# Common Contacts Sample
|
||||
|
||||
This sample provides a reuse package with common domain models and services for contacts-related data.
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
#### Import to your project
|
||||
|
||||
npm install @sap/capire-contacts
|
||||
|
||||
> e.g. see: [bookstore](../bookstore/package.json)
|
||||
|
||||
#### Reusing aspects
|
||||
|
||||
Define own entities derived from the pre-defined aspects as in [_bookstore_](../bookstore/db/schema.cds):
|
||||
|
||||
```swift
|
||||
using { sap.capire.contacts.Person } from '@sap/capire-contacts';
|
||||
entity Authors : contacts.Person { ... }
|
||||
```
|
||||
|
||||
> **Note:** All entities in this package are annotated with _`@cds.persistence.skip`:'if-unused'_, so they will be ignored if not referred to from other entities in your models.
|
||||
|
||||
|
||||
#### Reusing entities
|
||||
|
||||
Reuse the entities as in this example from [_users-service_](../users-service/srv/services.cds):
|
||||
```swift
|
||||
using { sap.capire.contacts.Contacts } from '@sap/capire-contacts';
|
||||
service UsersService @(requires:'authenticated-user') {
|
||||
entity MyProfile as select from Contacts where ID=$user;
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
#### Reusing code lists
|
||||
|
||||
Reuse the code lists as in [_./tests/index.cds_](./tests/index.cds):
|
||||
|
||||
```swift
|
||||
service Sue { ...
|
||||
// expose Countries to activate provided code lists
|
||||
@readonly entity Countries as projection on sap.capire.contacts.Countries;
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Reuse code list service
|
||||
|
||||
```js
|
||||
const { intercept } = require ('@sap/capire-contacts/srv/code-lists')
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Content
|
||||
|
||||
|
||||
|
||||
## Concepts
|
||||
|
||||
* [Reuse of packages](https://cap.cloud.sap/docs/get-started/projects#reuse)
|
||||
* Code Lists, `@sap/cds/common` and `@cds.persistence.skip`: 'if-unused'
|
||||
* Using `aspects` vs `entities`
|
||||
@@ -1,70 +0,0 @@
|
||||
const cds = require ('@sap/cds')
|
||||
const READ='READ', WRITE = ['CREATE','UPDATE']
|
||||
|
||||
const intercept = exports.intercept = cds.service.impl (async (srv) => {
|
||||
|
||||
for (let each in srv.entities) {
|
||||
|
||||
// intercept JSON-encoded elements
|
||||
const jsons = await jsonsIn (srv.entities[each].elements)
|
||||
if (jsons) {
|
||||
srv.before (WRITE, each, ({data:row})=>{
|
||||
for (let e of jsons) if (row[e]) row[e] = JSON.stringify (row[e])
|
||||
})
|
||||
srv.after (READ, each, (row)=>{
|
||||
for (let e of jsons) if (row[e]) row[e] = JSON.parse (row[e])
|
||||
})
|
||||
}
|
||||
|
||||
// intercept references
|
||||
const refs = await refsIn (srv.entities[each].elements, srv.model)
|
||||
if (refs) srv.after (READ, each, (rows, req)=>{
|
||||
for (let row of rows) {
|
||||
for (let {element,codelist} of refs) {
|
||||
const entry = codelist [row[element]]
|
||||
if (entry) {
|
||||
const localized = entry.texts [req.user.locale || intercept.locale]
|
||||
row[element] = localized ? localized.name : entry.name
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
}
|
||||
|
||||
})
|
||||
|
||||
|
||||
function jsonsIn (elements) {
|
||||
const jsons=[]; for (let e in elements) {
|
||||
if (elements[e]['@JSON']) jsons.push(e)
|
||||
}
|
||||
return jsons.length && jsons
|
||||
}
|
||||
|
||||
async function refsIn (elements, model) {
|
||||
const refs=[]; for (let e in elements) {
|
||||
const $ref = elements[e]['@ref']
|
||||
if ($ref) {
|
||||
const d = model.definitions [$ref['=']]
|
||||
refs.push({
|
||||
element:e,
|
||||
codelist: CodeLists[d.name] || (CodeLists[d.name] = await load(d))
|
||||
})
|
||||
}
|
||||
}
|
||||
return refs.length && refs
|
||||
}
|
||||
|
||||
const load = exports.load = async (codelist) => {
|
||||
const all = {}
|
||||
const [entries,texts] = await Promise.all ([
|
||||
SELECT.from (codelist),
|
||||
SELECT.from (codelist.elements.texts.target)
|
||||
])
|
||||
for (let {code,name,descr} of entries) all[code] = {name,descr}
|
||||
for (let {code,locale,name,descr} of texts) (all[code].texts || (all[code].texts={})) [locale] = {name,descr}
|
||||
return all
|
||||
}
|
||||
|
||||
const CodeLists = {}
|
||||
@@ -1,68 +0,0 @@
|
||||
const {load,intercept} = require ('../srv/code-lists')
|
||||
const cds = require ('@sap/cds')
|
||||
|
||||
// patch-enhance cds.ql
|
||||
const select = SELECT.from('.').__proto__.__proto__, query = select.__proto__
|
||||
query.then = function (r,e) { return db.run(this) .then (r,e || ((e)=>{throw e})) }
|
||||
|
||||
let db, Countries, Australia = {
|
||||
name: 'Australia', descr: 'Commonwealth of Australia', texts: {
|
||||
de: { name: 'Australien', descr: 'Commonwealth Australien' }
|
||||
}
|
||||
}
|
||||
|
||||
describe ('code list tests', ()=>{
|
||||
|
||||
it ('should deploy the db schema to sqlite in-memory', async()=>{
|
||||
db = await cds.deploy (__dirname) .to ('sqlite::memory:', {silent:true,primary:true})
|
||||
Countries = db.model.entities ['sap.common.Countries']
|
||||
expect (Countries) .toBeDefined()
|
||||
})
|
||||
|
||||
it ('should read Countries', async()=>{
|
||||
const countries = await SELECT ('code','name') .from (Countries)
|
||||
expect (countries) .toContainEqual ({ code: 'AU', name: 'Australia' })
|
||||
})
|
||||
|
||||
it ('should read Countries_texts', async()=>{
|
||||
const countries = await SELECT ('locale','code','name') .from ('sap.common.Countries_texts')
|
||||
expect (countries) .toContainEqual ({ locale: 'de', code: 'AU', name: 'Australien' })
|
||||
})
|
||||
|
||||
it ('should read code lists with translated texts', async()=>{
|
||||
const {AU} = await load (Countries)
|
||||
expect (AU) .toEqual (Australia)
|
||||
})
|
||||
|
||||
cds.env.singletenant = true
|
||||
|
||||
it ('should serve services with localized data', async()=>{
|
||||
const { Sue:sue } = await cds.serve (__dirname)
|
||||
const { Foos } = sue.entities
|
||||
await sue.create (Foos) .entries ({country:'Avalon'})
|
||||
await sue.create (Foos) .entries ({country:'AU'})
|
||||
expect (await sue.read('Foos')) .toEqual ([ { ID: 1, country: 'Avalon' }, { ID: 2, country: 'AU' } ])
|
||||
})
|
||||
|
||||
it ('should resolve countries', async()=>{
|
||||
const sue = await cds.connect.to ('Sue')
|
||||
await intercept (sue)
|
||||
expect (await sue.read('Foos')) .toEqual ([ { ID: 1, country: 'Avalon' }, { ID: 2, country: 'Australia' } ])
|
||||
intercept.locale = 'de'
|
||||
expect (await sue.read('Foos')) .toEqual ([ { ID: 1, country: 'Avalon' }, { ID: 2, country: 'Australien' } ])
|
||||
console.log (await sue.read('Foos'))
|
||||
})
|
||||
|
||||
it ('should read countries with expand to translated texts', async()=>{
|
||||
const countries = await cds.read (Countries, c=>{
|
||||
c.name, c.texts (t => {
|
||||
t.locale, t.name
|
||||
})
|
||||
})
|
||||
console.log (countries)
|
||||
})
|
||||
|
||||
it ('should disconnect from db', ()=> db.disconnect())
|
||||
//> FIXME: that should not be required!
|
||||
|
||||
})
|
||||
@@ -1,11 +0,0 @@
|
||||
using { sap } from '..';
|
||||
|
||||
entity Foo {
|
||||
key ID : Integer;
|
||||
country : String @ref: sap.capire.contacts.Countries;
|
||||
}
|
||||
service Sue {
|
||||
entity Foos as projection on Foo;
|
||||
// expose Countries to activate provided code lists
|
||||
@readonly entity Countries as projection on sap.capire.contacts.Countries;
|
||||
}
|
||||
@@ -1,12 +0,0 @@
|
||||
code;symbol;name;descr;numcode;minor;exponent
|
||||
EUR;€;Euro;European Euro;978;Cent;2
|
||||
USD;$;US Dollar;United States Dollar;840;Cent;2
|
||||
CAD;$;Canadian Dollar;Canadian Dollar;124;Cent;2
|
||||
AUD;$;Australian Dollar;Canadian Dollar;036;Cent;2
|
||||
GBP;£;British Pound;Great Britain Pound;826;Penny;2
|
||||
ILS;₪;Shekel;Israeli New Shekel;376;Agorat;2
|
||||
INR;₹;Rupee;Indian Rupee;356;Paise;2
|
||||
QAR;﷼;Riyal;Katar Riyal;356;Dirham;2
|
||||
SAR;﷼;Riyal;Saudi Riyal;682;Halala;2
|
||||
JPY;¥;Yen;Japanese Yen;392;Sen;2
|
||||
CNY;¥;Yuan;Chinese Yuan Renminbi;156;Jiao;1
|
||||
|
@@ -1,13 +0,0 @@
|
||||
code;locale;name;descr
|
||||
EUR;de;Euro;European Euro
|
||||
USD;de;US-Dollar;United States Dollar
|
||||
CAD;de;Kanadischer Dollar;Kanadischer Dollar
|
||||
AUD;de;Australischer Dollar;Australischer Dollar
|
||||
GBP;de;Pfund;Britische Pfund
|
||||
ILS;de;Schekel;Israelische Schekel
|
||||
EUR;fr;euro;de la Zone euro
|
||||
USD;fr;dollar;dollar des États-Unis
|
||||
CAD;fr;dollar canadien;dollar canadien
|
||||
AUD;fr;dollar australien;dollar australien
|
||||
GBP;fr;livre sterling;pound sterling
|
||||
ILS;fr;Shekel;shekel israelien
|
||||
|
@@ -1,17 +0,0 @@
|
||||
namespace sap.capire.currencies;
|
||||
using { sap.common.Currencies } from '@sap/cds/common';
|
||||
|
||||
extend Currencies with {
|
||||
// Currencies.code = ISO 4217 alphabetic three-letter code
|
||||
// with the first two letters being equal to ISO 3166 alphabetic country codes
|
||||
numcode : Integer;
|
||||
exponent : Integer; //> e.g. 2 --> 1 Dollar = 10^2 Cent
|
||||
minor : String; //> e.g. 'Cent'
|
||||
// country : String; //> country or region
|
||||
}
|
||||
|
||||
|
||||
// see also
|
||||
// [1] https://www.iso.org/iso-4217-currency-codes.html
|
||||
// [2] https://www.currency-iso.org/en/home/tables/table-a1.html
|
||||
// [3] https://www.ibm.com/support/knowledgecenter/en/SSZLC2_7.0.0/com.ibm.commerce.payments.developer.doc/refs/rpylerl2mst97.htm
|
||||
@@ -1,10 +0,0 @@
|
||||
{
|
||||
"name": "@sap/capire-currencies",
|
||||
"version": "1.0.0",
|
||||
"description": "A reuse package providing common domain models and services for currencies-related data.",
|
||||
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
|
||||
"license": "SAP SAMPLE CODE LICENSE",
|
||||
"dependencies": {
|
||||
"@sap/cds": "latest"
|
||||
}
|
||||
}
|
||||
@@ -1,15 +0,0 @@
|
||||
namespace sap.capire.media;
|
||||
|
||||
service MediaServer {
|
||||
entity Images {
|
||||
key url : URL;
|
||||
type : String enum { jpeg; png; gif; };
|
||||
content : Image;
|
||||
}
|
||||
}
|
||||
|
||||
type ImageURL : URL;
|
||||
// type ImageURL : Association to MediaServer.Images;
|
||||
//> would need Assotiations targeting off service to turn into references w/ foreign keys
|
||||
type Image : LargeBinary @stream;
|
||||
type URL : String(222);
|
||||
@@ -1,11 +0,0 @@
|
||||
{
|
||||
"name": "@sap/capire-media",
|
||||
"version": "1.0.0",
|
||||
"description": "A generic platform service to manage and serve media content on behalf of other services and apps.",
|
||||
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
|
||||
"license": "SAP SAMPLE CODE LICENSE",
|
||||
"dependencies": {
|
||||
"@sap/cds": "latest",
|
||||
"express": "*"
|
||||
}
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
ID;amount;parent_ID;article
|
||||
58040e66-1dcd-4ffb-ab10-fdce32028b79;1;7e2f2640-6866-4dcf-8f4d-3027aa831cad;201
|
||||
64e718c9-ff99-47f1-8ca3-950c850777d4;1;7e2f2640-6866-4dcf-8f4d-3027aa831cad;271
|
||||
e9641166-e050-4261-bfee-d1e797e6cb7f;2;64e718c9-ff99-47f1-8ca3-950c850777d4;252
|
||||
|
@@ -1,3 +0,0 @@
|
||||
ID;modifiedAt;createdAt;createdBy;modifiedBy;OrderNo;currency_code
|
||||
7e2f2640-6866-4dcf-8f4d-3027aa831cad;;2019-01-31;john.doe@test.com;;1;EUR
|
||||
64e718c9-ff99-47f1-8ca3-950c850777d4;;2019-01-30;christian.georgi@sap.com;;2;EUR
|
||||
|
@@ -1,15 +0,0 @@
|
||||
namespace sap.capire.orders;
|
||||
using { Currency, cuid, managed } from '@sap/cds/common';
|
||||
|
||||
|
||||
entity Orders : cuid, managed {
|
||||
OrderNo : String @title:'Order Number'; //> readable key
|
||||
Items : Composition of many OrderItems on Items.parent = $self;
|
||||
currency : Currency;
|
||||
}
|
||||
|
||||
entity OrderItems : cuid {
|
||||
parent : Association to Orders not null;
|
||||
article : String;
|
||||
amount : Integer;
|
||||
}
|
||||
@@ -1,2 +0,0 @@
|
||||
namespace sap.capire.orders;
|
||||
using from './srv/orders-service';
|
||||
@@ -1,11 +0,0 @@
|
||||
{
|
||||
"name": "@sap/capire-orders",
|
||||
"version": "1.0.0",
|
||||
"description": "A reuse package providing domain models and services to submit and manage purchase orders.",
|
||||
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
|
||||
"license": "SAP SAMPLE CODE LICENSE",
|
||||
"dependencies": {
|
||||
"@sap/cds": "latest",
|
||||
"express": "*"
|
||||
}
|
||||
}
|
||||
@@ -1,6 +0,0 @@
|
||||
namespace sap.capire.orders;
|
||||
using { sap.capire.orders as my } from '../db/schema';
|
||||
|
||||
service OrdersService {
|
||||
entity Orders as projection on my.Orders;
|
||||
}
|
||||
@@ -1,18 +0,0 @@
|
||||
namespace sap.capire.products;
|
||||
|
||||
using { Currency, cuid, managed, sap.common.CodeList } from '@sap/cds/common';
|
||||
|
||||
entity Products : cuid, managed {
|
||||
title : localized String(111);
|
||||
descr : localized String(1111);
|
||||
stock : Integer;
|
||||
price : Decimal(9,2);
|
||||
currency : Currency;
|
||||
category : Association to Categories;
|
||||
}
|
||||
|
||||
entity Categories : CodeList {
|
||||
key ID : Integer;
|
||||
parent : Association to Categories;
|
||||
children : Composition of many Categories on children.parent = $self;
|
||||
}
|
||||
@@ -1,2 +0,0 @@
|
||||
using from './db/schema';
|
||||
using from './srv/admin-service';
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"name": "@sap/capire-products",
|
||||
"version": "1.0.0",
|
||||
"description": "A reuse package providing domain models and services to manage product catalogs.",
|
||||
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
|
||||
"license": "SAP SAMPLE CODE LICENSE",
|
||||
"dependencies": {
|
||||
"@sap/cds": "latest",
|
||||
"express": "*"
|
||||
},
|
||||
"files": [
|
||||
"db",
|
||||
"srv",
|
||||
"index.cds"
|
||||
]
|
||||
}
|
||||
@@ -1,7 +0,0 @@
|
||||
using { sap.capire.products as db } from '../db/schema';
|
||||
namespace sap.capire.products;
|
||||
|
||||
service AdminService @(_requires:'admin') {
|
||||
entity Products as projection on db.Products;
|
||||
entity Categories as projection on db.Categories;
|
||||
}
|
||||
@@ -1,68 +0,0 @@
|
||||
const cds = require ('@sap/cds')
|
||||
|
||||
describe('reading/writing hierarchies', ()=>{
|
||||
|
||||
it ('should prepare to sqlite in-memory', async()=>{
|
||||
await cds.deploy (__dirname+'/../db') .to ('sqlite::memory:')
|
||||
expect (cds.model) .toBeDefined()
|
||||
})
|
||||
|
||||
it ('should insert hierarchy of categories', ()=>{
|
||||
const { Categories } = cds.entities
|
||||
return INSERT.into (Categories) .entries (
|
||||
{ ID:100, name:'Some Sample Categories...', children:[
|
||||
{ ID:101, name:'Cat', children:[
|
||||
{ ID:102, name:'Kitty', children:[
|
||||
{ ID:103, name:'Kitty Cat', children:[
|
||||
{ ID:104, name:'Aristocat' } ]},
|
||||
{ ID:105, name:'Kitty Bat' } ]},
|
||||
{ ID:106, name:'Catwoman', children:[
|
||||
{ ID:107, name:'Catalina' } ]} ]},
|
||||
{ ID:108, name:'Catweazle' }
|
||||
]}
|
||||
)
|
||||
})
|
||||
|
||||
it ('should read categories with children', async()=>{
|
||||
const { Categories } = cds.entities
|
||||
expect (await
|
||||
|
||||
SELECT.one.from (Categories, c=>{
|
||||
c.ID, c.name.as('parent'), c.children (c=>{
|
||||
c.name.as('child')
|
||||
})
|
||||
}) .where ({name:'Cat'})
|
||||
|
||||
) .toMatchObject (
|
||||
|
||||
{ ID:101, parent:'Cat', children:[
|
||||
{ child:'Kitty' },
|
||||
{ child:'Catwoman' },
|
||||
]}
|
||||
|
||||
)
|
||||
})
|
||||
|
||||
it ('should read hierarchy of categories', async()=>{
|
||||
const { Categories } = cds.entities
|
||||
expect (await
|
||||
|
||||
SELECT.one.from (Categories, c=>{
|
||||
c.ID, c.name, c.children (c=>{ c.name },{levels:3})
|
||||
}) .where ({name:'Cat'})
|
||||
|
||||
) .toMatchObject (
|
||||
|
||||
{ ID:101, name:'Cat', children:[
|
||||
{ name:'Kitty', children:[
|
||||
{ name:'Kitty Cat', children:[
|
||||
{ name:'Aristocat' }, ]},
|
||||
{ name:'Kitty Bat' }, ]},
|
||||
{ name:'Catwoman', children:[
|
||||
{ name:'Catalina' } ]},
|
||||
]}
|
||||
|
||||
)
|
||||
})
|
||||
|
||||
})
|
||||
@@ -1,10 +0,0 @@
|
||||
ID;parent_ID;name
|
||||
0;;Some Sample Categories...
|
||||
1;;Cat
|
||||
2;1;Kitty
|
||||
3;2;Kitty Cat
|
||||
4;3;Aristocat
|
||||
5;2;Kitty Bat
|
||||
6;1;Catwoman
|
||||
7;6;Catalina
|
||||
8;;Catweazle
|
||||
|
@@ -1,157 +0,0 @@
|
||||
{
|
||||
"info": {
|
||||
"_postman_id": "0f8d4e79-a1c2-47fe-aeab-0319fb4ce180",
|
||||
"name": "@sap/capire-products",
|
||||
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
|
||||
},
|
||||
"item": [
|
||||
{
|
||||
"name": "Categories",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{ \"ID\":0, \"name\":\"Some Sample Categories...\", \"children\":[\n { \"ID\":1, \"name\":\"Cat\", \"children\":[\n { \"ID\":2, \"name\":\"Kitty\", \"children\":[\n { \"ID\":3, \"name\":\"Kitty Cat\", \"children\":[\n { \"ID\":4, \"name\":\"Aristocat\" }\n ]},\n { \"ID\":5, \"name\":\"Kitty Bat\" }\n ]},\n { \"ID\":6, \"name\":\"Catwoman\", \"children\":[\n { \"ID\":7, \"name\":\"Catalina\" }\n ]}\n ] },\n { \"ID\":8, \"name\":\"Catweazle\" }\n]}\n"
|
||||
},
|
||||
"url": {
|
||||
"raw": "http://localhost:4004/admin/Categories",
|
||||
"protocol": "http",
|
||||
"host": [
|
||||
"localhost"
|
||||
],
|
||||
"port": "4004",
|
||||
"path": [
|
||||
"admin",
|
||||
"Categories"
|
||||
]
|
||||
}
|
||||
},
|
||||
"response": []
|
||||
},
|
||||
{
|
||||
"name": "Categories",
|
||||
"request": {
|
||||
"method": "GET",
|
||||
"header": [],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": ""
|
||||
},
|
||||
"url": {
|
||||
"raw": "http://localhost:4004/admin/Categories/0?$expand=children($expand=children($expand=children($expand=children)))",
|
||||
"protocol": "http",
|
||||
"host": [
|
||||
"localhost"
|
||||
],
|
||||
"port": "4004",
|
||||
"path": [
|
||||
"admin",
|
||||
"Categories",
|
||||
"0"
|
||||
],
|
||||
"query": [
|
||||
{
|
||||
"key": "$expand",
|
||||
"value": "children($expand=children($expand=children($expand=children)))"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"response": [
|
||||
{
|
||||
"name": "Categories",
|
||||
"originalRequest": {
|
||||
"method": "GET",
|
||||
"header": [],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": ""
|
||||
},
|
||||
"url": {
|
||||
"raw": "http://localhost:4004/admin/Categories/0?$expand=children($expand=children($expand=children($expand=children)))",
|
||||
"protocol": "http",
|
||||
"host": [
|
||||
"localhost"
|
||||
],
|
||||
"port": "4004",
|
||||
"path": [
|
||||
"admin",
|
||||
"Categories",
|
||||
"0"
|
||||
],
|
||||
"query": [
|
||||
{
|
||||
"key": "$expand",
|
||||
"value": "children($expand=children($expand=children($expand=children)))"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"status": "OK",
|
||||
"code": 200,
|
||||
"_postman_previewlanguage": "json",
|
||||
"header": [
|
||||
{
|
||||
"key": "X-Powered-By",
|
||||
"value": "Express"
|
||||
},
|
||||
{
|
||||
"key": "OData-Version",
|
||||
"value": "4.0"
|
||||
},
|
||||
{
|
||||
"key": "content-type",
|
||||
"value": "application/json;odata.metadata=minimal"
|
||||
},
|
||||
{
|
||||
"key": "Date",
|
||||
"value": "Tue, 21 May 2019 19:20:24 GMT"
|
||||
},
|
||||
{
|
||||
"key": "Connection",
|
||||
"value": "keep-alive"
|
||||
},
|
||||
{
|
||||
"key": "Content-Length",
|
||||
"value": "767"
|
||||
}
|
||||
],
|
||||
"cookie": [],
|
||||
"body": "{\n \"@odata.context\": \"$metadata#cats(children(children(children(children()))))/$entity\",\n \"@odata.metadataEtag\": \"W/\\\"+AAp4JKNOcr+OusjrdQo55RCfM+UHKpTh8EbhsxyPhM=\\\"\",\n \"name\": \"Some Sample Categories...\",\n \"descr\": null,\n \"ID\": 0,\n \"parent_ID\": null,\n \"children\": [\n {\n \"name\": \"Cat\",\n \"descr\": null,\n \"ID\": 1,\n \"parent_ID\": 0,\n \"children\": [\n {\n \"name\": \"Kitty\",\n \"descr\": null,\n \"ID\": 2,\n \"parent_ID\": 1,\n \"children\": [\n {\n \"name\": \"Kitty Cat\",\n \"descr\": null,\n \"ID\": 3,\n \"parent_ID\": 2,\n \"children\": [\n {\n \"name\": \"Aristocat\",\n \"descr\": null,\n \"ID\": 4,\n \"parent_ID\": 3\n }\n ]\n },\n {\n \"name\": \"Kitty Bat\",\n \"descr\": null,\n \"ID\": 5,\n \"parent_ID\": 2,\n \"children\": []\n }\n ]\n },\n {\n \"name\": \"Catwoman\",\n \"descr\": null,\n \"ID\": 6,\n \"parent_ID\": 1,\n \"children\": [\n {\n \"name\": \"Catalina\",\n \"descr\": null,\n \"ID\": 7,\n \"parent_ID\": 6,\n \"children\": []\n }\n ]\n }\n ]\n },\n {\n \"name\": \"Catweazle\",\n \"descr\": null,\n \"ID\": 8,\n \"parent_ID\": 0,\n \"children\": []\n }\n ]\n}"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Categories",
|
||||
"request": {
|
||||
"method": "DELETE",
|
||||
"header": [],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": ""
|
||||
},
|
||||
"url": {
|
||||
"raw": "http://localhost:4004/admin/Categories/0",
|
||||
"protocol": "http",
|
||||
"host": [
|
||||
"localhost"
|
||||
],
|
||||
"port": "4004",
|
||||
"path": [
|
||||
"admin",
|
||||
"Categories",
|
||||
"0"
|
||||
]
|
||||
}
|
||||
},
|
||||
"response": []
|
||||
}
|
||||
]
|
||||
|
||||
}
|
||||
@@ -1,31 +0,0 @@
|
||||
namespace sap.capire.reviews;
|
||||
using { User } from '@sap/cds/common';
|
||||
|
||||
// Reviewed subjects can be any entity that is uniquely identified
|
||||
// by a single key element such as a UUID
|
||||
type ReviewedSubject : String(111);
|
||||
|
||||
entity Reviews {
|
||||
key ID : UUID;
|
||||
subject : ReviewedSubject;
|
||||
reviewer : User;
|
||||
rating : Rating;
|
||||
title : String(111);
|
||||
text : String(1111);
|
||||
date : DateTime;
|
||||
likes : Composition of many Likes on likes.review = $self;
|
||||
liked : Integer default 0; // counter for likes as helpful review (count of all _likes belonging to this review)
|
||||
}
|
||||
|
||||
type Rating : Decimal(3,2) enum {
|
||||
Best = 5;
|
||||
Good = 4;
|
||||
Avg = 3;
|
||||
Poor = 2;
|
||||
Worst = 1;
|
||||
}
|
||||
|
||||
entity Likes {
|
||||
key review : Association to Reviews;
|
||||
key user : User;
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
using from './srv/reviews-service';
|
||||
@@ -1,26 +0,0 @@
|
||||
{
|
||||
"name": "@sap/capire-reviews",
|
||||
"version": "1.0.0",
|
||||
"description": "A reuse service providing generic means to add reviews and ratings to target objects, e.g. products.",
|
||||
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
|
||||
"license": "SAP SAMPLE CODE LICENSE",
|
||||
"dependencies": {
|
||||
"@sap/cds": "latest",
|
||||
"express": "*"
|
||||
},
|
||||
"files": [
|
||||
"db",
|
||||
"srv",
|
||||
"index.cds"
|
||||
],
|
||||
"cds": {
|
||||
"requires": {
|
||||
"db": {
|
||||
"kind": "sql"
|
||||
},
|
||||
"messaging": {
|
||||
"kind": "file-based-messaging"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,41 +0,0 @@
|
||||
using { sap.capire.reviews as my } from '../db/schema';
|
||||
namespace sap.capire.reviews;
|
||||
|
||||
service ReviewsService {
|
||||
// Sync API
|
||||
entity Reviews as projection on my.Reviews excluding { likes }
|
||||
action like (review:Reviews.ID); // TODO: can be a bound action in OData
|
||||
action unlike (review:Reviews.ID); // TODO: can be a bound action in OData
|
||||
|
||||
// Async API
|
||||
event reviewed : { subject: Reviews.subject; rating: Decimal(2,1) };
|
||||
|
||||
// Input validation
|
||||
annotate Reviews with {
|
||||
subject @mandatory;
|
||||
title @mandatory;
|
||||
rating @mandatory @assert.enum;
|
||||
}
|
||||
|
||||
// Auto-fill reviewers and review dates
|
||||
annotate Reviews with {
|
||||
reviewer @cds.on.insert:$user;
|
||||
date @cds.on.insert:$now;
|
||||
date @cds.on.update:$now;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
// Access control restrictions
|
||||
annotate ReviewsService.Reviews with @restrict_:[
|
||||
{ grant:'READ', to:'any' }, // everybody can read reviews
|
||||
{ grant:'CREATE', to:'authenticated-user' }, // users must login to add reviews
|
||||
{ grant:'UPDATE', to:'authenticated-user', where:'reviewer=$user' },
|
||||
{ grant:'DELETE', to:'admin' },
|
||||
];
|
||||
|
||||
annotate ReviewsService with @restrict_:[
|
||||
{ grant:'like', to:'identified-user' },
|
||||
{ grant:'unlike', to:'identified-user', where:'user=$user' },
|
||||
];
|
||||
@@ -1,41 +0,0 @@
|
||||
const cds = require ('@sap/cds')
|
||||
module.exports = cds.service.impl (function(){
|
||||
|
||||
// Get the CSN definition for Reviews from the db schema for sub-sequent queries
|
||||
// ( Note: we explicitly specify the namespace to support embedded reuse )
|
||||
const { Reviews, Likes } = this.entities ('sap.capire.reviews')
|
||||
|
||||
// Emit an event to inform subscribers about new avg ratings for reviewed subjects
|
||||
// ( Note: req.on.succeeded ensures we only do that if there's no error )
|
||||
this.after (['CREATE','UPDATE','DELETE'], 'Reviews', async(_,req) => {
|
||||
const {subject} = req.data
|
||||
const {rating} = await cds.transaction(req) .run (
|
||||
SELECT.one (['round(avg(rating),2) as rating']) .from (Reviews) .where ({subject})
|
||||
)
|
||||
req.on ('succeeded', ()=>{
|
||||
console.log ('< emitting:', 'reviewed', { subject, rating })
|
||||
this.emit ('reviewed', { subject, rating })
|
||||
})
|
||||
})
|
||||
|
||||
// Increment counter for reviews considered helpful
|
||||
this.on ('like', (req) => {
|
||||
if (!req.user) return req.reject(400, 'You must be identified to like a review')
|
||||
const {review} = req.data, {user} = req
|
||||
const tx = cds.transaction(req)
|
||||
return tx.run ([
|
||||
INSERT.into (Likes) .entries ({review_ID: review, user: user.id}),
|
||||
UPDATE (Reviews) .set({liked: {'+=': 1}}) .where({ID:review})
|
||||
]).catch(() => req.reject(400, 'You already liked that review'))
|
||||
})
|
||||
|
||||
// Delete a former like by the same user
|
||||
this.on ('unlike', async (req) => {
|
||||
if (!req.user) return req.reject(400, 'You must be identified to remove a former like of yours')
|
||||
const {review} = req.data, {user} = req
|
||||
const tx = cds.transaction(req)
|
||||
const affectedRows = await tx.run (DELETE.from (Likes) .where ({review_ID: review,user: user.id}))
|
||||
if (affectedRows === 1) return tx.run (UPDATE (Reviews) .set ({liked: {'-=': 1}}) .where ({ID:review}))
|
||||
})
|
||||
|
||||
})
|
||||
@@ -1,69 +0,0 @@
|
||||
const _model = __dirname+'/..'
|
||||
const cds = require ('@sap/cds')
|
||||
|
||||
describe('messaging tests', ()=>{
|
||||
|
||||
it ('should bootstrap sqlite in-memory db', async()=>{
|
||||
const db = await cds.deploy (_model) .to ('sqlite::memory:')
|
||||
expect (db.model) .toBeDefined()
|
||||
})
|
||||
|
||||
let srv
|
||||
it ('should serve reviews services', async()=>{
|
||||
srv = await cds.serve('ReviewsService') .from (_model)
|
||||
expect (srv.name) .toMatch ('ReviewsService')
|
||||
})
|
||||
|
||||
let N=0, received=[], M=0
|
||||
it ('should add messaging event handlers', ()=>{
|
||||
srv.on('reviewed', (msg)=> received.push(msg))
|
||||
})
|
||||
|
||||
it ('should add more messaging event handlers', ()=>{
|
||||
srv.on('reviewed', ()=> ++M)
|
||||
})
|
||||
|
||||
it ('should add review', async ()=>{
|
||||
const review = {
|
||||
ID: 111 + (++N), // FIXME: why does the generic handler not fill this in automatically ?!? --> it does so when the request comes in via Postman / OData
|
||||
subject: "201", title: "Captivating", rating: N
|
||||
}
|
||||
const response = await srv.create ('Reviews') .entries (review)
|
||||
expect (response) .toMatchObject (review)
|
||||
},100)
|
||||
|
||||
it ('should add more reviews', ()=> Promise.all ([
|
||||
// REVISIT: mass operation should trigger one message per entry
|
||||
// srv.create('Reviews').entries(
|
||||
// { ID: 111 + (++N), subject: "201", title: "Captivating", rating: N },
|
||||
// { ID: 111 + (++N), subject: "201", title: "Captivating", rating: N },
|
||||
// { ID: 111 + (++N), subject: "201", title: "Captivating", rating: N },
|
||||
// { ID: 111 + (++N), subject: "201", title: "Captivating", rating: N },
|
||||
// ),
|
||||
srv.create ('Reviews') .entries (
|
||||
{ ID: 111 + (++N), subject: "201", title: "Captivating", rating: N }
|
||||
),
|
||||
srv.create ('Reviews') .entries (
|
||||
{ ID: 111 + (++N), subject: "201", title: "Captivating", rating: N }
|
||||
),
|
||||
srv.create ('Reviews') .entries (
|
||||
{ ID: 111 + (++N), subject: "201", title: "Captivating", rating: N }
|
||||
),
|
||||
srv.create ('Reviews') .entries (
|
||||
{ ID: 111 + (++N), subject: "201", title: "Captivating", rating: N }
|
||||
),
|
||||
]) ,100)
|
||||
|
||||
it ('should have received all messages', async()=> {
|
||||
await new Promise((done)=>setImmediate(done))
|
||||
expect(M).toBe(N)
|
||||
expect(received.length).toBe(N)
|
||||
expect(received.map(m=>m.data)).toEqual([
|
||||
{ subject: '201', rating: 1 },
|
||||
{ subject: '201', rating: 1.5 },
|
||||
{ subject: '201', rating: 2 },
|
||||
{ subject: '201', rating: 2.5 },
|
||||
{ subject: '201', rating: 3 },
|
||||
])
|
||||
})
|
||||
})
|
||||
@@ -1 +0,0 @@
|
||||
using from './srv/services';
|
||||
@@ -1,12 +0,0 @@
|
||||
{
|
||||
"name": "@sap/capire-users",
|
||||
"version": "1.0.0",
|
||||
"description": "A reuse service for users-related functions, like registration, user profile mgmt, etc.",
|
||||
"repository": "https://github.com/SAP-samples/cloud-cap-samples.git",
|
||||
"license": "SAP SAMPLE CODE LICENSE",
|
||||
"dependencies": {
|
||||
"@sap/capire-contacts": "^1.0.0",
|
||||
"@sap/cds": "latest",
|
||||
"express": "*"
|
||||
}
|
||||
}
|
||||
@@ -1,7 +0,0 @@
|
||||
using { sap.capire.contacts.Contacts as RegisteredUsers } from '@sap/capire-contacts';
|
||||
namespace sap.capire.users;
|
||||
|
||||
service UsersService @(requires:'authenticated-user') {
|
||||
entity MyProfile as select from RegisteredUsers;
|
||||
action login ();
|
||||
}
|
||||
47
pipeline_config.yml
Normal file
47
pipeline_config.yml
Normal file
@@ -0,0 +1,47 @@
|
||||
###
|
||||
# This file configures the SAP Cloud SDK Continuous Delivery pipeline of your project.
|
||||
# For a reference of the configuration concept and available options, please have a look into its documentation.
|
||||
#
|
||||
# The documentation for the most recent pipeline version can always be found at:
|
||||
# https://github.com/SAP/cloud-s4-sdk-pipeline/blob/master/configuration.md
|
||||
# If you are using a fixed version of the pipeline, please make sure to view the corresponding version from the tag
|
||||
# list of GitHub (e.g. "v15" when you configured pipelineVersion = "v15" in the Jenkinsfile).
|
||||
#
|
||||
# For general information on how to get started with Continuous Delivery, visit:
|
||||
# https://blogs.sap.com/2017/09/20/continuous-integration-and-delivery
|
||||
#
|
||||
# We aim to keep the pipeline configuration as stable as possible. However, major changes might also imply breaking
|
||||
# changes in the configuration. Before doing an update, please check the the release notes of all intermediate releases
|
||||
# and adapt this file if necessary.
|
||||
#
|
||||
# This is a YAML-file. YAML is a indentation-sensitive file format. Please make sure to properly indent changes to it.
|
||||
###
|
||||
|
||||
|
||||
|
||||
### General project setup
|
||||
general:
|
||||
productiveBranch: 'openSAP-week4-unit4'
|
||||
|
||||
### Step-specific configuration
|
||||
steps:
|
||||
|
||||
|
||||
### Stage-specific configuration
|
||||
stages:
|
||||
|
||||
# integrationTests:
|
||||
# credentials:
|
||||
# - alias: 'mySystemAlias'
|
||||
# credentialId: 'mySystemCredentialsId'
|
||||
|
||||
# s4SdkQualityChecks:
|
||||
# nonErpDestinations:
|
||||
# - 'myCustomDestination'
|
||||
|
||||
# productionDeployment:
|
||||
# cfTargets:
|
||||
# - org: 'myOrg'
|
||||
# space: 'mySpace'
|
||||
# apiEndpoint: 'https://api.cf.eu10.hana.ondemand.com'
|
||||
# credentialsId: 'cf-deploy-sap'
|
||||
Reference in New Issue
Block a user