Skip to content

Commit ef9ca73

Browse files
committed
Tweaked docs, bumped version
1 parent 4cc0c9e commit ef9ca73

File tree

23 files changed

+109
-80
lines changed

23 files changed

+109
-80
lines changed

CHANGES.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,4 +134,8 @@
134134
- Fix for #163, Error Reporting Could Be Better with some update
135135
- Fix for #182, Symphony Chat Workflow Annotations Documentation
136136

137-
137+
## Jun 24, 2021
138+
- Fix for #190, Chat Workflow documentation in the wrong place
139+
- Fix for #180, Kore AI Bot Health Unreliable
140+
- Fix for #171, Chat Workflow Delete/Checkbox alignment display
141+
- Fix for #141, Handle Primitives in Chat Workflow

README.md

Lines changed: 56 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,42 @@
44
![License](https://img.shields.io/github/license/finos/symphony-java-toolkit)
55
[![Maven Central](https://img.shields.io/maven-central/v/org.finos.symphony.toolkit/symphony-java-toolkit)](https://search.maven.org/search?q=org.finos.symphony.toolkit)
66

7-
## What This Is
7+
# What This Is
88

99
This project is a set of libraries aimed at facilitating creating Bots and Apps for the [Symphony Chat Platform](https://symphony.com) using Java and [Spring Boot](https://spring.io/projects/spring-boot).
1010

1111
This project contains the following:
1212

13-
- Symphony Java Client Bindings
14-
- Symphony Java Client Identity
15-
- Symphony API Spring-Boot Starter
16-
- Symphony App Spring-Boot Starter
17-
- Symphony JSON Support
18-
- Symphony FIX Support
19-
- A Symphony Maven Build Notifier
20-
- A TeamCity Build Notifier
21-
- Symphony Shared Stream
22-
- Chat Workflow
23-
- KoreAI Connector
24-
- Tutorials for getting started
25-
- Demo bots and apps
13+
- **Libraries**
14+
- Symphony Java Client Bindings
15+
- Symphony Java Client Identity
16+
- Symphony API Spring-Boot Starter
17+
- Symphony App Spring-Boot Starter
18+
- Symphony JSON Support
19+
- Symphony FIX Support
20+
- Symphony Shared Stream
21+
- Chat Workflow
22+
23+
- **Tools**
24+
- A Symphony Maven Build Notifier
25+
- A TeamCity Build Notifier
26+
- KoreAI Bridge Connector
27+
- RSS News bot
28+
- Reminder Bot (tbc)
29+
- Webhook Bot (tbc)
30+
31+
- **Tutorials for getting started**
32+
33+
- **Demo bots and apps**
34+
- Demo Bot
35+
- Demo App
36+
- Claim Bot
37+
- To-Do Bot
2638

2739
Read further to see what each of these includes.
2840

41+
# Libraries
42+
2943
## Overview and Dependencies
3044

3145
Many of the components in this project rely on each other, as demonstrated in this dependency diagram. This also gives and overviw of the purpose of each component.
@@ -91,17 +105,6 @@ Although this is not reliant on Symphony code, it is adjacent tech and so might
91105

92106
- [View the README](libs/quickfix-json/README.md)
93107

94-
## Maven Build Reporter
95-
96-
Provides a maven extension that allows you to report build results into a Symphony chat room.
97-
98-
- [View the README](tools/symphony-maven-build-reporter/README.md)
99-
100-
## TeamCity Build Notifier
101-
102-
Allows you to report your TeamCity builds into Symphony chat rooms, using a bot.
103-
104-
- [View the README](tools/teamcity-symphony-integration/README.md)
105108

106109
## Symphony Shared Stream
107110

@@ -117,21 +120,44 @@ This module provides a one-stop-shop for constructing work-flows in Java. It is
117120
- [View the Tutorial](tutorials/Chat-Workflow.md)
118121
- [Demo To-Do List Bot](demos/todo-bot/README.md)
119122
- [Demo Claim Bot](demos/claim-bot/README.md)
120-
- [RSS News Bot](tools/rss-bot/README.md)
121-
- [Poll Bot](tools/poll-bot/README.md)
123+
124+
# Tools
125+
126+
_All bots are deployed into maven central as executable jars_.
127+
128+
## Maven Build Reporter
129+
130+
Provides a maven extension that allows you to report build results into a Symphony chat room.
131+
132+
- [View the README](tools/symphony-maven-build-reporter/README.md)
122133

134+
## TeamCity Build Notifier
135+
136+
Allows you to report your TeamCity builds into Symphony chat rooms, using a bot.
137+
138+
- [View the README](tools/teamcity-symphony-integration/README.md)
139+
123140
## Kore-AI Bridge
124141

125142
This is a Spring Boot App that acts as a middleman between a Symphony bot and a KoreAI bot, allowing you to expose your KoreAI bot as a bot on Symphony. [Kore.AI](https://kore.ai/) is a low code/no code environment for building chat bots.
126143

127144
- [View the README](tools/koreai/README.md)
128145

129-
## License
146+
## Poll Bot
130147

131-
This project is licensed under the [Apache 2.0 License](LICENSE).
148+
A bot for running polls in a Symphony chat room. Built using chat-workflow.
149+
150+
- [View the README](tools/poll-bot/README.md)
132151

133-
## Running The Demo Bots
152+
## News (RSS) Bot
134153

154+
A bot for feeding news into a Symphony chat room. Built using chat-workflow.
155+
156+
- [View the README](tools/rss-bot/README.md)
157+
158+
# License
159+
160+
This project is licensed under the [Apache 2.0 License](LICENSE).
135161

136162

137163
## Releasing This Project (For Maintainers)

demos/claim-bot/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<parent>
77
<groupId>org.finos.symphony.toolkit</groupId>
88
<artifactId>symphony-java-toolkit</artifactId>
9-
<version>7.20.3-SNAPSHOT</version>
9+
<version>7.20.4-SNAPSHOT</version>
1010
<relativePath>../..</relativePath>
1111
</parent>
1212

@@ -24,7 +24,7 @@
2424
<dependency>
2525
<groupId>org.finos.symphony.toolkit</groupId>
2626
<artifactId>chat-workflow-spring-boot-starter</artifactId>
27-
<version>7.20.3-SNAPSHOT</version>
27+
<version>7.20.4-SNAPSHOT</version>
2828
</dependency>
2929
<dependency>
3030
<groupId>org.apache.commons</groupId>

demos/demo-app/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>org.finos.symphony.toolkit</groupId>
99
<artifactId>symphony-java-toolkit</artifactId>
10-
<version>7.20.3-SNAPSHOT</version>
10+
<version>7.20.4-SNAPSHOT</version>
1111
<relativePath>../..</relativePath>
1212
</parent>
1313

@@ -43,7 +43,7 @@
4343
<groupId>org.finos.symphony.toolkit</groupId>
4444
<artifactId>symphony-app-spring-boot-starter</artifactId>
4545
<scope>compile</scope>
46-
<version>7.20.3-SNAPSHOT</version>
46+
<version>7.20.4-SNAPSHOT</version>
4747
</dependency>
4848

4949
<dependency>

demos/demo-bot/pom.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>org.finos.symphony.toolkit</groupId>
99
<artifactId>symphony-java-toolkit</artifactId>
10-
<version>7.20.3-SNAPSHOT</version>
10+
<version>7.20.4-SNAPSHOT</version>
1111
<relativePath>../..</relativePath>
1212
</parent>
1313

@@ -33,13 +33,13 @@
3333
<dependency>
3434
<groupId>org.finos.symphony.toolkit</groupId>
3535
<artifactId>symphony-api-spring-boot-starter</artifactId>
36-
<version>7.20.3-SNAPSHOT</version>
36+
<version>7.20.4-SNAPSHOT</version>
3737
<scope>compile</scope>
3838
</dependency>
3939
<dependency>
4040
<groupId>org.finos.symphony.toolkit</groupId>
4141
<artifactId>shared-stream-spring-boot-starter</artifactId>
42-
<version>7.20.3-SNAPSHOT</version>
42+
<version>7.20.4-SNAPSHOT</version>
4343
<scope>compile</scope>
4444
</dependency>
4545
<dependency>

demos/todo-bot/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<parent>
77
<groupId>org.finos.symphony.toolkit</groupId>
88
<artifactId>symphony-java-toolkit</artifactId>
9-
<version>7.20.3-SNAPSHOT</version>
9+
<version>7.20.4-SNAPSHOT</version>
1010
<relativePath>../..</relativePath>
1111
</parent>
1212

@@ -24,7 +24,7 @@
2424
<dependency>
2525
<groupId>org.finos.symphony.toolkit</groupId>
2626
<artifactId>chat-workflow-spring-boot-starter</artifactId>
27-
<version>7.20.3-SNAPSHOT</version>
27+
<version>7.20.4-SNAPSHOT</version>
2828
</dependency>
2929
<dependency>
3030
<groupId>org.apache.commons</groupId>

libs/bindings/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<parent>
1111
<groupId>org.finos.symphony.toolkit</groupId>
1212
<artifactId>symphony-java-toolkit</artifactId>
13-
<version>7.20.3-SNAPSHOT</version>
13+
<version>7.20.4-SNAPSHOT</version>
1414
<relativePath>../..</relativePath>
1515
</parent>
1616

@@ -247,7 +247,7 @@
247247
<dependency>
248248
<groupId>org.finos.symphony.toolkit</groupId>
249249
<artifactId>identity</artifactId>
250-
<version>7.20.3-SNAPSHOT</version>
250+
<version>7.20.4-SNAPSHOT</version>
251251
<scope>test</scope>
252252
</dependency>
253253
<!-- excluded by spring bom, but we need it for jersey-apache-connector -->

libs/bindings/src/test/java/com/symphony/api/bindings/TokenIT.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public void checkTokenCreation(TestClientStrategy s) throws Exception {
3131
}
3232

3333
// this will perform a retry, since the original tokens are invalid.
34-
messagesApi.v4StreamSidMessageGet(ROOM, 0l, null, null, 0, 100);
34+
messagesApi.v4StreamSidMessageGet(ROOM, 0l, null, null, 0, 5);
3535

3636
// check that tokens actually did get refreshed
3737
Assertions.assertNotEquals(originalSessionToken, tm.getSessionToken());

libs/chat-workflow-spring-boot-starter/pom.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<parent>
99
<groupId>org.finos.symphony.toolkit</groupId>
1010
<artifactId>symphony-java-toolkit</artifactId>
11-
<version>7.20.3-SNAPSHOT</version>
11+
<version>7.20.4-SNAPSHOT</version>
1212
<relativePath>../..</relativePath>
1313
</parent>
1414

@@ -21,17 +21,17 @@
2121
<dependency>
2222
<groupId>org.finos.symphony.toolkit</groupId>
2323
<artifactId>symphony-api-spring-boot-starter</artifactId>
24-
<version>7.20.3-SNAPSHOT</version>
24+
<version>7.20.4-SNAPSHOT</version>
2525
</dependency>
2626
<dependency>
2727
<groupId>org.finos.symphony.toolkit</groupId>
2828
<artifactId>entity-json</artifactId>
29-
<version>7.20.3-SNAPSHOT</version>
29+
<version>7.20.4-SNAPSHOT</version>
3030
</dependency>
3131
<dependency>
3232
<groupId>org.finos.symphony.toolkit</groupId>
3333
<artifactId>shared-stream-spring-boot-starter</artifactId>
34-
<version>7.20.3-SNAPSHOT</version>
34+
<version>7.20.4-SNAPSHOT</version>
3535
</dependency>
3636
<!-- needed for formatting messageml -->
3737
<dependency>

libs/entity-json/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<parent>
1111
<groupId>org.finos.symphony.toolkit</groupId>
1212
<artifactId>symphony-java-toolkit</artifactId>
13-
<version>7.20.3-SNAPSHOT</version>
13+
<version>7.20.4-SNAPSHOT</version>
1414
<relativePath>../..</relativePath>
1515
</parent>
1616

0 commit comments

Comments
 (0)