Compare commits

...

39 Commits

Author SHA1 Message Date
Laszlo Kajan
99861ca588 Patch of _reduceStock() under @sap/cds 4 (#136)
* Bump to cds 4
* Cosmetics in handler code
  * await and cds.run([...]) instead of Promise.all

Co-authored-by: Christian Georgi <christian.georgi@sap.com>
2020-09-18 10:49:46 +02:00
Christian Georgi
b5fc3fe4fa Add app/ dir to also also include annotations 2020-06-03 10:15:10 +02:00
Matthias Bühl
b371e10fdf Update README.md 2020-04-07 11:20:55 +02:00
Christian Georgi
9d31d66c78 Add package-lock.json, fix readme 2020-04-02 16:02:32 +02:00
Matthias Bühl
b34b1b0a17 Merge pull request #41 from SAP-samples/remove-insertonly-annotation
remove @insertonly of Orders in CatalogService
2020-03-25 18:19:52 +01:00
d045778
7d39278e79 remove @insertonly of Orders in CatalogService 2020-03-25 16:06:17 +01:00
Matthias Buehl
8395c3fbfc typo README.md 2020-03-24 16:52:01 +01:00
Matthias Buehl
6e5c23bc22 typo README 2020-03-24 16:49:21 +01:00
Matthias Buehl
57803e8f2b correct README 2020-03-24 16:44:28 +01:00
Matthias Buehl
7bbd4ffdb3 correct package.json 2020-03-24 16:27:29 +01:00
Matthias Buehl
ece7aa99cc delete local package.json 2020-03-24 16:07:17 +01:00
Matthias Buehl
e8156ce08a streamline branches 2020-03-24 15:47:03 +01:00
Matthias Buehl
2bf65fb50f Move to standard README and package-lock file 2020-03-24 11:17:23 +01:00
Christian Georgi
23cc571d8a Update readme 2020-03-23 17:09:18 +01:00
Matthias Buehl
50b1f1bb15 delete unused packages 2020-03-20 12:43:13 +01:00
Dominik Nehse
3b818b18c1 Added info on the usage of Windows Powershell
There is a known encoding issue with Windows Powershell that leads to the xs-security.json to not be accepted when creating the xsuaa service instance.
2020-03-19 16:42:24 +01:00
Matthias Bühl
2d7630449c README 2020-02-12 17:07:09 +01:00
Matthias Bühl
f4f41aca52 Update README 2020-02-11 16:43:20 +01:00
Matthias Bühl
a0d63890ac Reset toplevel Package.json 2020-02-06 14:36:07 +01:00
pianocktail
c2ef8c9a69 Merge branch 'OpenSAP-week3-unit5' of https://github.com/SAP-samples/cloud-cap-samples into OpenSAP-week3-unit5 2020-02-06 09:00:58 +00:00
pianocktail
44cf281360 package.json 2020-02-06 09:00:34 +00:00
pianocktail
cfc1ebc881 package.json 2020-02-06 08:37:21 +00:00
pianocktail
fef327f344 "Enable CF Merge branch 'OpenSAP-week3-unit5' of https://github.com/SAP-samples/cloud-cap-samples into OpenSAP-week3-unit5 2020-02-06 08:33:34 +00:00
pianocktail
9932d02d57 CF enablement 2020-02-06 08:27:57 +00:00
Matthias Bühl
cad3a32c78 Add model": "srv" in package.json 2020-02-03 12:44:13 +01:00
Matthias Bühl
05a5a68463 add HANATRIAL to MTA.YAML 2020-02-03 10:30:28 +01:00
Matthias Bühl
73cf655715 instance based restriction in catalogservice 2020-02-03 09:26:33 +01:00
Matthias Bühl
3c094c201b XSUAA 2020-01-31 15:59:43 +01:00
Matthias Bühl
a458c7bb0d cleanup 2020-01-30 17:48:32 +01:00
Matthias Bühl
e0e330c43a XSUAA Config 1 2020-01-30 17:32:23 +01:00
Lakshmi C Rajeev
6d0194acc0 Merge pull request #12 from LakshmiCR/master
Media-server implementation
2020-01-17 15:02:15 +05:30
Lakshmi C Rajeev
db75a99808 Merge branch 'master' into master 2020-01-17 15:01:59 +05:30
Volker Buzek
a04755efed feat(npm): add .npmrc for @sap-scope
- `npm set @sap...` is unnecessary
- update README.md accordingly
2020-01-14 14:55:36 +01:00
Lakshmi C Rajeev
ba72d7f478 Update package.json 2020-01-03 14:29:53 +05:30
Lakshmi C Rajeev
cd808c76dd Update media-service.js 2020-01-03 14:07:17 +05:30
Lakshmi C Rajeev
630bb2b19c Update package.json 2019-12-19 10:59:57 +05:30
Lakshmi C Rajeev
f9a7aa59de Update media-service.js 2019-12-19 10:43:22 +05:30
Lakshmi C Rajeev
9205e0893a Update media-service.js 2019-12-02 15:27:38 +05:30
Lakshmi C Rajeev
7137bf227e Media-server 2019-11-29 12:30:07 +05:30
76 changed files with 2776 additions and 1592 deletions

1
.npmrc Normal file
View File

@@ -0,0 +1 @@
registry=https://registry.npmjs.org

41
.vscode/launch.json vendored
View File

@@ -5,18 +5,45 @@
"version": "0.2.0",
"configurations": [
{
"name": "bookshop", "request": "launch", "type": "node", "runtimeExecutable": "npx", "runtimeArgs": [ "-n" ],
"args": [ "--", "cds", "run", "--in-memory" ],
"name": "bookshop",
"request": "launch",
"type": "node",
"runtimeExecutable": "npx",
"runtimeArgs": [
"-n"
],
"args": [
"--",
"cds",
"run",
"--in-memory"
],
"cwd": "${workspaceFolder}/packages/bookshop",
"console": "integratedTerminal",
"skipFiles": ["<node_internals>/**"]
"skipFiles": [
"<node_internals>/**"
]
},
{
"name": "cds run ...", "request": "launch", "type": "node", "runtimeExecutable": "npx", "runtimeArgs": [ "-n" ],
"args": [ "--", "cds", "run", "--with-mocks", "--in-memory?" ],
"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",
"skipFiles": ["<node_internals>/**"]
"skipFiles": [
"<node_internals>/**"
]
}
],
"inputs": [
@@ -34,4 +61,4 @@
"default": "bookshop"
}
]
}
}

139
README.md
View File

@@ -1,73 +1,118 @@
# 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
## 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.
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.
## Setup
The samples provided can be run in a local setup on SQLite Database.
In SAP Business Application Studio, open a terminal.
Then clone the repo with this specific branch:
## 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://cap.cloud.sap/docs/get-started/in-vscode#add-cds-editor)
## 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
git clone https://github.com/sap-samples/cloud-cap-samples projects/cloud-cap-samples -b openSAP-week3-unit5
cd projects/cloud-cap-samples
```
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`
In the `cloud-cap-samples` folder run:
```sh
npm install
```
#### Run the samples
## Run
With that you're ready to run the samples, e.g. start the [_bookshop_](./packages/bookshop) sample as follows:
Now you're ready to run the samples, for example:
```sh
cd packages/bookshop
cds deploy
cds watch
```
`npm run bookshop`
After that, watch out for the little popup in the lower right corner of SAP Business Application Studio that asks you to open the application in your browser.
## Test
## Hints
- If your demo user logon window does not show up: clear the browsers login data
- If your port is still in use run in your terminal:
```
> pkill node //kill running node proceses
```
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.
## Deploy to Cloud Foundry
Clean-up the CF space in your trial account if you already used it before. Make sure that there are no services or applications deployed.
Generation of the XSUAA service configuration file xs-security.json:
```sh
cds compile srv/ --to xsuaa > xs-security.json
```
In this unit we use [MTA](https://sap.github.io/cloud-mta-build-tool/) to do the deployment to CF
```sh
npm install -g mbt
```
You can generate the MTA.yaml from CDS and do manual modifications or simply use the already generated and adapted mta.yaml in the branch and directly generate the .mtar file
## Debug
For example, in [VS Code](https://code.visualstudio.com) switch to _Debug_ view and launch one of the prepared _cds run_ launch configurations.
#### BEGIN OPTIONAL PART
If you want to generate the MTA.YAML yourself please do the following:
## Limitations
- Generate the mta.yaml with the HANA dependency
```sh
cds add hana --force
cds add mta
```
None
- Add the path to the generated xs-security.json in the MTA.YAML
```
parameters:
path: ./xs-security.json
service:xsuaa
service-plan: application
....
```
- Add the application block in the MTA.YAML
```
############## APP #########################
- name: capire-bookshop-app
type: nodejs
path: gen/app
parameters:
memory: 256M
build-parameters:
requires:
- name: capire-bookshop-srv
requires:
- name: capire-bookshop-uaa
- name: srv-binding
group: destinations
properties:
forwardAuthToken: true
name: srv-binding
url: ~{srv-url}
```
- Make sure to use service hanatrial instead of hana in the MTA.YAML
```
parameters:
service: hanatrial
```
#### END OPTIONAL PART
## Known Issues
Generate the .mtar file for the deployment and deploy to cloud foundry:
```sh
mbt build -t ./
cf login -a https://api.cf.eu10.hana.ondemand.com
cf deploy sap.capire-bookshop_1.0.0.mtar
```
None
## Get Support
## How to obtain 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).
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.

12
db/package.json Normal file
View File

@@ -0,0 +1,12 @@
{
"name": "deploy",
"dependencies": {
"@sap/hdi-deploy": "^3.8.2"
},
"engines": {
"node": "^8"
},
"scripts": {
"start": "node node_modules/@sap/hdi-deploy/deploy.js"
}
}

2164
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -8,14 +8,11 @@
"lerna": "npx --no-install lerna -v > /dev/null || npm i lerna --no-save",
"install": "(npm -s run lerna) && lerna bootstrap --hoist",
"cleanup": "lerna clean -y && rm -fr node_modules",
"bookshop": "cds watch packages/bookshop",
"bookshop-enhanced": "cds watch packages/bookshop-enhanced",
"reviews-service": "cds watch packages/reviews-service",
"bookstore": "cds watch packages/bookstore"
"bookshop": "cds watch packages/bookshop"
},
"dependencies": {
"@sap/cds": "latest",
"express": "*"
"@sap/cds": "^4",
"express": "^4"
},
"devDependencies": {
"sqlite3": "*"

View File

@@ -1 +0,0 @@
using from '@sap/capire-bookshop/app';

View File

@@ -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;
}

View File

@@ -1,29 +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": {
"reviews-service": "PORT=5005 cds run ../reviews-service --bind --in-memory?",
"start": "cds run --in-memory?",
"watch": "cds watch"
},
"cds": {
"requires": {
"sap.capire.reviews.ReviewsService": {
"kind": "odata",
"model": "@sap/capire-reviews"
},
"messaging": {
"kind": "file-based-messaging"
}
}
}
}

View File

@@ -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;
}

View File

@@ -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})
})
})

View File

@@ -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)
###

View File

@@ -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

View File

@@ -0,0 +1,67 @@
{
"odata": {
"version": "v4"
},
"build": {
"target": "gen",
"tasks": [
{
"src": "db",
"for": "hana",
"options": {
"model": [
"db",
"srv"
]
}
},
{
"src": "srv",
"for": "node-cf",
"options": {
"model": [
"db",
"srv",
"app"
]
}
},
{
"src": "app",
"for": "fiori",
"options": {
"model": [
"app"
]
}
}
]
},
"auth": {
"passport": {
"strategy": "mock",
"users": {
"alice": {
"password": "123",
"ID": "alice",
"roles": [
"admin",
"authenticated-user"
],
"xs.user.attributes": {
"currency": [
"USD"
]
}
},
"bob": {
"password": "123",
"ID": "bob",
"roles": [
"authenticated-user"
]
}
}
}
}
}

29
packages/bookshop/.vscode/launch.json vendored Normal file
View File

@@ -0,0 +1,29 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "Run bookshop",
"request": "launch",
"type": "node",
"cwd": "/home/user/projects/cloud-cap-samples/packages/bookshop",
"runtimeExecutable": "npx",
"runtimeArgs": [
"-n"
],
"args": [
"--",
"cds",
"run",
"--in-memory?"
],
"console": "internalConsole",
"internalConsoleOptions": "openOnSessionStart",
"skipFiles": [
"<node_internals>/**"
],
"env": {
"run.config": "{\"handlerId\":\"cap_run_config_handler_id\",\"runnableId\":\"/home/user/projects/cloud-cap-samples/packages/bookshop\"}"
}
}
]
}

View File

@@ -0,0 +1,11 @@
{
"name": "capire-bookshop-approuter",
"version": "0.0.1",
"description": "",
"dependencies": {
"@sap/approuter": "^8"
},
"scripts": {
"start": "node node_modules/@sap/approuter/approuter.js"
}
}

View File

@@ -0,0 +1,22 @@
{
"welcomeFile": "/fiori.html",
"authenticationMethod": "route",
"routes": [
{
"source": "^/.*(html|js)$",
"localDir": "."
},
{
"source": "^/sapui5/.*",
"localDir": "."
},
{
"source": "^/.*/webapp/.*",
"localDir": "."
},
{
"source": "/",
"destination": "srv-binding"
}
]
}

View File

@@ -0,0 +1,12 @@
{
"name": "deploy",
"dependencies": {
"@sap/hdi-deploy": "^3.8.2"
},
"engines": {
"node": "^12"
},
"scripts": {
"start": "node node_modules/@sap/hdi-deploy/deploy.js"
}
}

View File

@@ -0,0 +1,136 @@
{
"file_suffixes": {
"csv": {
"plugin_name": "com.sap.hana.di.tabledata.source"
},
"hdbafllangprocedure": {
"plugin_name": "com.sap.hana.di.afllangprocedure"
},
"hdbanalyticprivilege": {
"plugin_name": "com.sap.hana.di.analyticprivilege"
},
"hdbcalculationview": {
"plugin_name": "com.sap.hana.di.calculationview"
},
"hdbcollection": {
"plugin_name": "com.sap.hana.di.collection"
},
"hdbconstraint": {
"plugin_name": "com.sap.hana.di.constraint"
},
"hdbdropcreatetable": {
"plugin_name": "com.sap.hana.di.dropcreatetable"
},
"hdbflowgraph": {
"plugin_name": "com.sap.hana.di.flowgraph"
},
"hdbfunction": {
"plugin_name": "com.sap.hana.di.function"
},
"hdbgraphworkspace": {
"plugin_name": "com.sap.hana.di.graphworkspace"
},
"hdbhadoopmrjob": {
"plugin_name": "com.sap.hana.di.virtualfunctionpackage.hadoop"
},
"hdbindex": {
"plugin_name": "com.sap.hana.di.index"
},
"hdblibrary": {
"plugin_name": "com.sap.hana.di.library"
},
"hdbmigrationtable": {
"plugin_name": "com.sap.hana.di.table.migration"
},
"hdbprocedure": {
"plugin_name": "com.sap.hana.di.procedure"
},
"hdbprojectionview": {
"plugin_name": "com.sap.hana.di.projectionview"
},
"hdbprojectionviewconfig": {
"plugin_name": "com.sap.hana.di.projectionview.config"
},
"hdbreptask": {
"plugin_name": "com.sap.hana.di.reptask"
},
"hdbresultcache": {
"plugin_name": "com.sap.hana.di.resultcache"
},
"hdbrole": {
"plugin_name": "com.sap.hana.di.role"
},
"hdbroleconfig": {
"plugin_name": "com.sap.hana.di.role.config"
},
"hdbsearchruleset": {
"plugin_name": "com.sap.hana.di.searchruleset"
},
"hdbsequence": {
"plugin_name": "com.sap.hana.di.sequence"
},
"hdbstatistics": {
"plugin_name": "com.sap.hana.di.statistics"
},
"hdbstructuredprivilege": {
"plugin_name": "com.sap.hana.di.structuredprivilege"
},
"hdbsynonym": {
"plugin_name": "com.sap.hana.di.synonym"
},
"hdbsynonymconfig": {
"plugin_name": "com.sap.hana.di.synonym.config"
},
"hdbsystemversioning": {
"plugin_name": "com.sap.hana.di.systemversioning"
},
"hdbtable": {
"plugin_name": "com.sap.hana.di.table"
},
"hdbtabledata": {
"plugin_name": "com.sap.hana.di.tabledata"
},
"hdbtabletype": {
"plugin_name": "com.sap.hana.di.tabletype"
},
"hdbtrigger": {
"plugin_name": "com.sap.hana.di.trigger"
},
"hdbview": {
"plugin_name": "com.sap.hana.di.view"
},
"hdbvirtualfunction": {
"plugin_name": "com.sap.hana.di.virtualfunction"
},
"hdbvirtualfunctionconfig": {
"plugin_name": "com.sap.hana.di.virtualfunction.config"
},
"hdbvirtualpackagehadoop": {
"plugin_name": "com.sap.hana.di.virtualpackage.hadoop"
},
"hdbvirtualpackagesparksql": {
"plugin_name": "com.sap.hana.di.virtualpackage.sparksql"
},
"hdbvirtualprocedure": {
"plugin_name": "com.sap.hana.di.virtualprocedure"
},
"hdbvirtualprocedureconfig": {
"plugin_name": "com.sap.hana.di.virtualprocedure.config"
},
"hdbvirtualtable": {
"plugin_name": "com.sap.hana.di.virtualtable"
},
"hdbvirtualtableconfig": {
"plugin_name": "com.sap.hana.di.virtualtable.config"
},
"properties": {
"plugin_name": "com.sap.hana.di.tabledata.properties"
},
"tags": {
"plugin_name": "com.sap.hana.di.tabledata.properties"
},
"txt": {
"plugin_name": "com.sap.hana.di.copyonly"
}
}
}

View File

@@ -0,0 +1,94 @@
####### 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
- name: capire-bookshop-uaa
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
- name: capire-bookshop-uaa
############################################################
############## APP #########################
- name: capire-bookshop-app
type: nodejs
path: gen/app
parameters:
memory: 256M
build-parameters:
requires:
- name: capire-bookshop-srv
requires:
- name: capire-bookshop-uaa
- name: srv-binding
group: destinations
properties:
forwardAuthToken: true
name: srv-binding
url: ~{srv-url}
############## 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:
service: hanatrial
properties:
hdi-service-name: ${service-name} # required for Java case
- name: capire-bookshop-uaa
type: org.cloudfoundry.managed-service
parameters:
##### Path to xs-security.json to add roles and scopes ####
path: ./xs-security.json
service: xsuaa
service-plan: application
config:
xsappname: capire-bookshop-${space} # name + space dependency
tenant-mode: dedicated
############################################################

View File

@@ -1,14 +1,29 @@
{
"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": "cds run --in-memory?",
"watch": "cds watch"
}
"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": "^4",
"express": "^4",
"hdb": "^0.18.1",
"passport": "^0.4.1"
},
"scripts": {
"start": "cds run --in-memory?",
"watch": "cds watch"
},
"cds": {
"requires": {
"db": {
"kind": "sql",
"[production]": {
"kind": "hana"
}
},
"uaa": {
"kind": "xsuaa"
}
}
}
}

BIN
packages/bookshop/sqlite.db Normal file

Binary file not shown.

View File

@@ -14,3 +14,7 @@ annotate AdminService.Orders with @odata.draft.enabled;
extend service AdminService with {
entity OrderItems as select from my.OrderItems;
}
// Restrict access to orders to users with role "admin"
annotate AdminService.Orders with @(restrict: [
{ grant: 'READ', to: 'admin' }
]);

View File

@@ -0,0 +1,10 @@
/** Service implementation for AdminService */
module.exports = cds.service.impl(function() {
this.before ('CREATE', 'Orders', _checkOrderCreateAuth)
})
/** Check authorization */
function _checkOrderCreateAuth (req) {
req.user.currency[0] === req.data.currency_code || req.reject(403)
}

View File

@@ -8,6 +8,10 @@ service CatalogService {
} excluding { createdBy, modifiedBy };
@requires_: 'authenticated-user'
@insertonly entity Orders as projection on my.Orders;
entity Orders as projection on my.Orders;
}
// Example for an instance restriction
annotate CatalogService.Orders with @(restrict: [
{ grant: 'READ', where: 'currency_code = $user.currency' }
]);

View File

@@ -14,13 +14,20 @@ function _addDiscount2 (each,discount) {
/** Reduce stock of ordered books if available stock suffices */
async function _reduceStock (req) {
const { Items: OrderItems } = req.data
return cds.transaction(req) .run (()=> OrderItems.map (order =>
UPDATE (Books) .set ('stock -=', order.amount)
.where ('ID =', order.book_ID) .and ('stock >=', order.amount)
)) .then (all => all.forEach ((affectedRows,i) => {
if (affectedRows === 0) req.error (409,
`${OrderItems[i].amount} exceeds stock for book #${OrderItems[i].book_ID}`
)
}))
const { Items: orderItems } = req.data
if (!Array.isArray(orderItems)) return
const all = await cds.transaction(req).run(orderItems.map(item =>
UPDATE(Books)
.set('stock -=', item.amount)
.where('ID =', item.book_ID).and('stock >=', item.amount)
))
all.forEach((affectedRows, i) => {
if (affectedRows === 0) {
req.error(409, `${orderItems[i].amount} exceeds stock for book #${orderItems[i].book_ID}`)
}
})
return all
}

View File

@@ -0,0 +1,37 @@
{
"xsappname": "capire-bookshop",
"tenant-mode": "dedicated",
"scopes": [
{
"name": "$XSAPPNAME.admin",
"description": "admin"
}
],
"attributes": [
{
"name": "currency",
"description": "currency",
"valueType": "s",
"valueRequired": false
}
],
"role-templates": [
{
"name": "admin",
"description": "generated",
"scope-references": [
"$XSAPPNAME.admin"
],
"attribute-references": []
},
{
"name": "userattributes",
"description": "generated",
"default-role-name": "Attributes of a User",
"scope-references": [],
"attribute-references": [
"currency"
]
}
]
}

View File

@@ -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;Kings Lynn, Norfolk;2012-02-26;Hertfordshire, England
1 ID firstname lastname dateOfBirth placeOfBirth dateOfDeath placeOfDeath
2 101 Emily Brontë 1818-07-30 Thornton, Yorkshire 1848-12-19 Haworth, Yorkshire
3 107 Charlotte Brontë 1818-04-21 Thornton, Yorkshire 1855-03-31 Haworth, Yorkshire
4 150 Edgar Allen Poe 1809-01-19 Boston, Massachusetts 1849-10-07 Baltimore, Maryland
5 170 Richard Carpenter 1929-08-14 King’s Lynn, Norfolk 2012-02-26 Hertfordshire, England

View File

@@ -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 ID parent_ID name
2 1 Poetry
3 2 Biography
4 3 Fantasy
5 4 Science Fiction
6 5 Romance
7 6 Mystery
8 7 Thriller
9 8 Dystopia
10 9 Tragedy
11 10 Novel

View File

@@ -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 ID title descr author_ID stock price currency_code category_ID
2 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
3 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
4 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
5 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
6 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

View File

@@ -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ë (18181848). 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 ID locale title descr
2 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.
3 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
4 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.

View File

@@ -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';

View File

@@ -1,48 +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 --in-memory?",
"watch": "cds watch"
},
"cds": {
"requires": {
"db": {
"kind": "sql"
},
"sap.capire.media.MediaServer": {
"kind": "rest"
},
"sap.capire.reviews.ReviewsService": {
"model": "@sap/capire-reviews",
"kind": "odata"
}
}
}
}

View File

@@ -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;

View File

@@ -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';

View File

@@ -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'
}])

View File

@@ -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';

View File

@@ -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)
})
})

View File

@@ -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;
}

View File

@@ -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 code name descr
2 AU Australia Commonwealth of Australia
3 CA Canada Canada
4 CN China People's Republic of China (PRC)
5 FR France French Republic
6 DE Germany Federal Republic of Germany
7 IN India Republic of India
8 IL Israel State of Israel
9 MM Myanmar Republic of the Union of Myanmar
10 GB United Kingdom United Kingdom of Great Britain and Northern Ireland
11 US United States United States of America (USA)
12 EU European Union European Union

View File

@@ -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 code locale name descr
2 AU de Australien Commonwealth Australien
3 CA de Kanada Canada
4 CN de China Volksrepublik China
5 FR de Frankreich Republik Frankreich
6 DE de Deutschland Bundesrepublik Deutschland
7 IN de Indien Republik Indien
8 IL de Israel Staat Israel
9 MM de Myanmar Republik der Union Myanmar
10 GB de Vereinigtes Königreich Vereinigtes Königreich Großbritannien und Nordirland
11 US de Vereinigte Staaten Vereinigte Staaten von Amerika
12 EU de Europäische Union Europäische Union

View File

@@ -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;
}

View File

@@ -1,2 +0,0 @@
using from './db/code-lists';
using from './db/schema';

View File

@@ -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"
}
}

View File

@@ -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`

View File

@@ -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 = {}

View File

@@ -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!
})

View File

@@ -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;
}

View File

@@ -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 code symbol name descr numcode minor exponent
2 EUR Euro European Euro 978 Cent 2
3 USD $ US Dollar United States Dollar 840 Cent 2
4 CAD $ Canadian Dollar Canadian Dollar 124 Cent 2
5 AUD $ Australian Dollar Canadian Dollar 036 Cent 2
6 GBP £ British Pound Great Britain Pound 826 Penny 2
7 ILS Shekel Israeli New Shekel 376 Agorat 2
8 INR Rupee Indian Rupee 356 Paise 2
9 QAR Riyal Katar Riyal 356 Dirham 2
10 SAR Riyal Saudi Riyal 682 Halala 2
11 JPY ¥ Yen Japanese Yen 392 Sen 2
12 CNY ¥ Yuan Chinese Yuan Renminbi 156 Jiao 1

View File

@@ -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 code locale name descr
2 EUR de Euro European Euro
3 USD de US-Dollar United States Dollar
4 CAD de Kanadischer Dollar Kanadischer Dollar
5 AUD de Australischer Dollar Australischer Dollar
6 GBP de Pfund Britische Pfund
7 ILS de Schekel Israelische Schekel
8 EUR fr euro de la Zone euro
9 USD fr dollar dollar des États-Unis
10 CAD fr dollar canadien dollar canadien
11 AUD fr dollar australien dollar australien
12 GBP fr livre sterling pound sterling
13 ILS fr Shekel shekel israelien

View File

@@ -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

View File

@@ -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"
}
}

View File

@@ -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);

View File

@@ -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": "*"
}
}

View File

@@ -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 ID amount parent_ID article
2 58040e66-1dcd-4ffb-ab10-fdce32028b79 1 7e2f2640-6866-4dcf-8f4d-3027aa831cad 201
3 64e718c9-ff99-47f1-8ca3-950c850777d4 1 7e2f2640-6866-4dcf-8f4d-3027aa831cad 271
4 e9641166-e050-4261-bfee-d1e797e6cb7f 2 64e718c9-ff99-47f1-8ca3-950c850777d4 252

View File

@@ -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 ID modifiedAt createdAt createdBy modifiedBy OrderNo currency_code
2 7e2f2640-6866-4dcf-8f4d-3027aa831cad 2019-01-31 john.doe@test.com 1 EUR
3 64e718c9-ff99-47f1-8ca3-950c850777d4 2019-01-30 christian.georgi@sap.com 2 EUR

View File

@@ -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;
}

View File

@@ -1,2 +0,0 @@
namespace sap.capire.orders;
using from './srv/orders-service';

View File

@@ -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": "*"
}
}

View File

@@ -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;
}

View File

@@ -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;
}

View File

@@ -1,2 +0,0 @@
using from './db/schema';
using from './srv/admin-service';

View File

@@ -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"
]
}

View File

@@ -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;
}

View File

@@ -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' } ]},
]}
)
})
})

View File

@@ -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 ID parent_ID name
2 0 Some Sample Categories...
3 1 Cat
4 2 1 Kitty
5 3 2 Kitty Cat
6 4 3 Aristocat
7 5 2 Kitty Bat
8 6 1 Catwoman
9 7 6 Catalina
10 8 Catweazle

View File

@@ -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": []
}
]
}

View File

@@ -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;
}

View File

@@ -1 +0,0 @@
using from './srv/reviews-service';

View File

@@ -1,30 +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": "*"
},
"scripts": {
"start": "cds run --in-memory?",
"watch": "cds watch"
},
"files": [
"db",
"srv",
"index.cds"
],
"cds": {
"requires": {
"db": {
"kind": "sql"
},
"messaging": {
"kind": "file-based-messaging"
}
}
}
}

View File

@@ -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' },
];

View File

@@ -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}))
})
})

View File

@@ -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 },
])
})
})

View File

@@ -1 +0,0 @@
using from './srv/services';

View File

@@ -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": "*"
}
}

View File

@@ -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 ();
}