Skip to content

Commit 716fa92

Browse files
davidellsdavidells
committed
* Introduce version and attachments fields on Statement
* Add Attachment data type * Clean up iteration of ArrayNodes * Add some test code around JSON serialization / deserialization * Fix a few bugs found in testing
1 parent b48307a commit 716fa92

38 files changed

+797
-574
lines changed

‎src/main/java/com/rusticisoftware/tincan/ActivityDefinition.java‎

Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import static com.rusticisoftware.tincan.InteractionType.getByString;
1919

20+
import java.net.URI;
2021
import java.net.URISyntaxException;
2122
import java.util.ArrayList;
2223
import java.util.Iterator;
@@ -41,7 +42,7 @@
4142
public class ActivityDefinition extends JSONBase {
4243
private LanguageMap name;
4344
private LanguageMap description;
44-
private String type;
45+
private URI type;
4546
private Extensions extensions;
4647
private InteractionType interactionType;
4748
private ArrayList<String> correctResponsesPattern;
@@ -51,12 +52,13 @@ public class ActivityDefinition extends JSONBase {
5152
private ArrayList<InteractionComponent> target;
5253
private ArrayList<InteractionComponent> steps;
5354

55+
5456
public ActivityDefinition(JsonNode jsonNode) throws URISyntaxException {
5557
this();
5658

5759
JsonNode typeNode = jsonNode.path("type");
5860
if (! typeNode.isMissingNode()) {
59-
this.setType(typeNode.textValue());
61+
this.setType(new URI(typeNode.textValue()));
6062
}
6163

6264
JsonNode nameNode = jsonNode.path("name");
@@ -84,60 +86,48 @@ public ActivityDefinition(JsonNode jsonNode) throws URISyntaxException {
8486
JsonNode correctResponsesPatternNode = jsonNode.path("correctResponsesPattern");
8587
if (! correctResponsesPatternNode.isMissingNode()) {
8688
this.correctResponsesPattern = new ArrayList<String>();
87-
88-
Iterator it = correctResponsesPatternNode.elements();
89-
while(it.hasNext()) {
90-
this.correctResponsesPattern.add(((JsonNode) it.next()).textValue());
89+
for (JsonNode element : correctResponsesPatternNode) {
90+
this.correctResponsesPattern.add(element.textValue());
9191
}
9292
}
9393

9494
JsonNode choicesNode = jsonNode.path("choices");
9595
if (! choicesNode.isMissingNode()) {
9696
this.choices = new ArrayList<InteractionComponent>();
97-
98-
Iterator it = choicesNode.elements();
99-
while(it.hasNext()) {
100-
this.choices.add(new InteractionComponent((JsonNode) it.next()));
97+
for (JsonNode element : choicesNode) {
98+
this.choices.add(new InteractionComponent(element));
10199
}
102100
}
103101

104102
JsonNode scaleNode = jsonNode.path("scale");
105103
if (! scaleNode.isMissingNode()) {
106104
this.scale = new ArrayList<InteractionComponent>();
107-
108-
Iterator it = scaleNode.elements();
109-
while(it.hasNext()) {
110-
this.scale.add(new InteractionComponent((JsonNode) it.next()));
105+
for (JsonNode element : scaleNode) {
106+
this.scale.add(new InteractionComponent(element));
111107
}
112108
}
113109

114110
JsonNode sourceNode = jsonNode.path("source");
115111
if (! sourceNode.isMissingNode()) {
116112
this.source = new ArrayList<InteractionComponent>();
117-
118-
Iterator it = sourceNode.elements();
119-
while(it.hasNext()) {
120-
this.source.add(new InteractionComponent((JsonNode) it.next()));
113+
for (JsonNode element : sourceNode) {
114+
this.source.add(new InteractionComponent(element));
121115
}
122116
}
123117

124118
JsonNode targetNode = jsonNode.path("target");
125119
if (! targetNode.isMissingNode()) {
126120
this.target = new ArrayList<InteractionComponent>();
127-
128-
Iterator it = targetNode.elements();
129-
while(it.hasNext()) {
130-
this.target.add(new InteractionComponent((JsonNode) it.next()));
121+
for (JsonNode element : targetNode) {
122+
this.target.add(new InteractionComponent(element));
131123
}
132124
}
133125

134126
JsonNode stepsNode = jsonNode.path("steps");
135127
if (! stepsNode.isMissingNode()) {
136128
this.steps = new ArrayList<InteractionComponent>();
137-
138-
Iterator it = stepsNode.elements();
139-
while(it.hasNext()) {
140-
this.steps.add(new InteractionComponent((JsonNode) it.next()));
129+
for (JsonNode element : stepsNode) {
130+
this.steps.add(new InteractionComponent(element));
141131
}
142132
}
143133
}
@@ -165,7 +155,7 @@ public ObjectNode toJSONNode(TCAPIVersion version) {
165155
node.put("description", this.getDescription().toJSONNode(version));
166156
}
167157
if (this.type != null) {
168-
node.put("type", this.getType());
158+
node.put("type", this.getType().toString());
169159
}
170160
if (this.extensions != null) {
171161
node.put("extensions", this.getExtensions().toJSONNode(version));
@@ -244,4 +234,12 @@ public ObjectNode toJSONNode(TCAPIVersion version) {
244234
}
245235
return node;
246236
}
237+
238+
public void setType(URI type) {
239+
this.type = type;
240+
}
241+
242+
public void setType(String type) throws URISyntaxException {
243+
this.setType(new URI(type));
244+
}
247245
}

‎src/main/java/com/rusticisoftware/tincan/Agent.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ protected Agent(JsonNode jsonNode) {
6161
this.setMbox(mboxNode.textValue());
6262
}
6363

64-
JsonNode mboxSHA1SumNode = jsonNode.path("mboxSHA1Sum");
64+
JsonNode mboxSHA1SumNode = jsonNode.path("mbox_sha1sum");
6565
if (! mboxSHA1SumNode.isMissingNode()) {
6666
this.setMboxSHA1Sum(mboxSHA1SumNode.textValue());
6767
}

‎src/main/java/com/rusticisoftware/tincan/Attachment.java‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
/*
2+
Copyright 2013 Rustici Software
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
package com.rusticisoftware.tincan;
17+
18+
import java.net.MalformedURLException;
19+
import java.net.URI;
20+
import java.net.URISyntaxException;
21+
import java.net.URL;
22+
23+
import com.fasterxml.jackson.databind.JsonNode;
24+
import com.fasterxml.jackson.databind.node.ObjectNode;
25+
import com.rusticisoftware.tincan.json.JSONBase;
26+
import com.rusticisoftware.tincan.json.Mapper;
27+
28+
import lombok.Data;
29+
import lombok.EqualsAndHashCode;
30+
import lombok.NoArgsConstructor;
31+
32+
/**
33+
* Attachment Class
34+
*/
35+
@Data
36+
@EqualsAndHashCode(callSuper = false)
37+
@NoArgsConstructor
38+
public class Attachment extends JSONBase {
39+
private URI usageType;
40+
private LanguageMap display;
41+
private LanguageMap description;
42+
private String contentType;
43+
private Integer length;
44+
private String sha2;
45+
private URL fileUrl;
46+
47+
public Attachment(JsonNode jsonNode) throws URISyntaxException, MalformedURLException {
48+
JsonNode usageTypeNode = jsonNode.path("usageType");
49+
if (! usageTypeNode.isMissingNode()) {
50+
this.setUsageType(new URI(usageTypeNode.textValue()));
51+
}
52+
53+
JsonNode displayNode = jsonNode.path("display");
54+
if (! displayNode.isMissingNode()) {
55+
this.setDisplay(new LanguageMap(displayNode));
56+
}
57+
58+
JsonNode descriptionNode = jsonNode.path("description");
59+
if (! descriptionNode.isMissingNode()) {
60+
this.setDescription(new LanguageMap(descriptionNode));
61+
}
62+
63+
JsonNode contentTypeNode = jsonNode.path("contentType");
64+
if (! contentTypeNode.isMissingNode()) {
65+
this.setContentType(contentTypeNode.textValue());
66+
}
67+
68+
JsonNode lengthNode = jsonNode.path("length");
69+
if (! lengthNode.isMissingNode()) {
70+
this.setLength(lengthNode.intValue());
71+
}
72+
73+
JsonNode sha2Node = jsonNode.path("sha2");
74+
if (! sha2Node.isMissingNode()) {
75+
this.setSha2(sha2Node.textValue());
76+
}
77+
78+
JsonNode fileUrlNode = jsonNode.path("fileUrl");
79+
if (! fileUrlNode.isMissingNode()) {
80+
this.setFileUrl(new URL(fileUrlNode.textValue()));
81+
}
82+
}
83+
84+
@Override
85+
public ObjectNode toJSONNode(TCAPIVersion version) {
86+
ObjectNode node = Mapper.getInstance().createObjectNode();
87+
if (this.getUsageType() != null) {
88+
node.put("usageType", this.getUsageType().toString());
89+
}
90+
if (this.getDisplay() != null) {
91+
node.put("display", this.getDisplay().toJSONNode(version));
92+
}
93+
if (this.getDescription() != null) {
94+
node.put("description", this.getDescription().toJSONNode(version));
95+
}
96+
if (this.getContentType() != null) {
97+
node.put("contentType", this.getContentType());
98+
}
99+
if (this.getLength() != null) {
100+
node.put("length", this.getLength());
101+
}
102+
if (this.getSha2() != null) {
103+
node.put("sha2", this.getSha2());
104+
}
105+
if (this.getFileUrl() != null) {
106+
node.put("fileUrl", this.getFileUrl().toString());
107+
}
108+
return node;
109+
}
110+
}

‎src/main/java/com/rusticisoftware/tincan/Context.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package com.rusticisoftware.tincan;
1717

18+
import java.net.MalformedURLException;
1819
import java.net.URISyntaxException;
1920
import java.util.UUID;
2021

@@ -44,7 +45,7 @@ public class Context extends JSONBase {
4445
private SubStatement statement;
4546
private Extensions extensions;
4647

47-
public Context(JsonNode jsonNode) throws URISyntaxException {
48+
public Context(JsonNode jsonNode) throws MalformedURLException, URISyntaxException {
4849
this();
4950

5051
JsonNode registrationNode = jsonNode.path("registration");

‎src/main/java/com/rusticisoftware/tincan/ContextActivities.java‎

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717

1818
import java.net.URISyntaxException;
1919
import java.util.ArrayList;
20-
import java.util.Iterator;
2120
import java.util.List;
2221

2322
import lombok.Data;
@@ -42,6 +41,7 @@ public class ContextActivities extends JSONBase {
4241
private List<Activity> parent;
4342
private List<Activity> grouping;
4443
private List<Activity> other;
44+
private List<Activity> category;
4545

4646
public ContextActivities(JsonNode jsonNode) throws URISyntaxException {
4747
this();
@@ -51,9 +51,8 @@ public ContextActivities(JsonNode jsonNode) throws URISyntaxException {
5151
this.parent = new ArrayList<Activity>();
5252

5353
if (parentNode.isArray()) {
54-
Iterator it = parentNode.elements();
55-
while(it.hasNext()) {
56-
this.parent.add(new Activity((JsonNode) it.next()));
54+
for (JsonNode element : parentNode) {
55+
this.parent.add(new Activity(element));
5756
}
5857
}
5958
else {
@@ -66,9 +65,8 @@ public ContextActivities(JsonNode jsonNode) throws URISyntaxException {
6665
this.grouping = new ArrayList<Activity>();
6766

6867
if (groupingNode.isArray()) {
69-
Iterator it = groupingNode.elements();
70-
while(it.hasNext()) {
71-
this.grouping.add(new Activity((JsonNode) it.next()));
68+
for (JsonNode element : groupingNode) {
69+
this.grouping.add(new Activity(element));
7270
}
7371
}
7472
else {
@@ -80,16 +78,29 @@ public ContextActivities(JsonNode jsonNode) throws URISyntaxException {
8078
if (! otherNode.isMissingNode()) {
8179
this.other = new ArrayList<Activity>();
8280

83-
if (parentNode.isArray()) {
84-
Iterator it = otherNode.elements();
85-
while(it.hasNext()) {
86-
this.other.add(new Activity((JsonNode) it.next()));
81+
if (otherNode.isArray()) {
82+
for (JsonNode element : otherNode) {
83+
this.other.add(new Activity(element));
8784
}
8885
}
8986
else {
9087
this.other.add(new Activity(otherNode));
9188
}
9289
}
90+
91+
JsonNode categoryNode = jsonNode.path("category");
92+
if (! categoryNode.isMissingNode()) {
93+
this.category = new ArrayList<Activity>();
94+
95+
if (categoryNode.isArray()) {
96+
for (JsonNode element : otherNode) {
97+
this.category.add(new Activity(element));
98+
}
99+
}
100+
else {
101+
this.category.add(new Activity(otherNode));
102+
}
103+
}
93104
}
94105

95106
@Override
@@ -148,6 +159,16 @@ public ObjectNode toJSONNode(TCAPIVersion version) {
148159
}
149160
}
150161
}
162+
if (this.category != null && this.category.size() > 0) {
163+
if (version.ordinal() <= TCAPIVersion.V100.ordinal()) {
164+
ArrayNode category = mapper.createArrayNode();
165+
node.put("category", category);
166+
167+
for (Activity element : this.getOther()) {
168+
category.add(element.toJSONNode(version));
169+
}
170+
}
171+
}
151172

152173
return node;
153174
}

‎src/main/java/com/rusticisoftware/tincan/Extensions.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,15 @@
2626

2727
import com.fasterxml.jackson.databind.JsonNode;
2828
import com.fasterxml.jackson.databind.node.ObjectNode;
29+
import com.rusticisoftware.tincan.json.JSONBase;
2930
import com.rusticisoftware.tincan.json.Mapper;
3031
import com.rusticisoftware.tincan.json.StringOfJSON;
3132

3233
/**
3334
* Extensions model class
3435
*/
3536
@NoArgsConstructor
36-
public class Extensions {
37+
public class Extensions extends JSONBase {
3738
private final HashMap<URI,JsonNode> _map = new HashMap<URI,JsonNode>();
3839

3940
public Extensions(JsonNode jsonNode) throws URISyntaxException {

‎src/main/java/com/rusticisoftware/tincan/Group.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public Group(JsonNode jsonNode) {
5656
@Override
5757
public ObjectNode toJSONNode(TCAPIVersion version) {
5858
ObjectNode node = super.toJSONNode(version);
59-
if (this.getMembers() != null) {
59+
if (this.getMembers() != null && this.getMembers().size() > 0) {
6060
ArrayNode memberNode = Mapper.getInstance().createArrayNode();
6161
for (Agent member : this.getMembers()) {
6262
memberNode.add(member.toJSONNode(version));

‎src/main/java/com/rusticisoftware/tincan/LanguageMap.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,15 @@
2121
import java.util.HashMap;
2222
import java.util.Iterator;
2323
import java.util.Map;
24+
25+
import com.rusticisoftware.tincan.json.JSONBase;
2426
import com.rusticisoftware.tincan.json.Mapper;
2527

2628
/**
2729
* Language map
2830
*/
2931
@NoArgsConstructor
30-
public class LanguageMap {
32+
public class LanguageMap extends JSONBase {
3133
private final HashMap<String,String> _map = new HashMap<String, String>();
3234

3335
public LanguageMap(JsonNode jsonNode) {

0 commit comments

Comments
 (0)