Merge pull request #27 from brianjmiller/master

Rewrite of LRS interface and RemoteLRS

Author: bscSCORM

.travis.yml

@@ -0,0 +1,3 @@
+language: java
+jdk: openjdk7
+before_script: cp src/test/resources/travis-ci.properties src/test/resources/lrs.properties

README.md

@@ -1,5 +1,7 @@
 A Java library for implementing with the Tin Can API.
 
+[![Build Status](https://travis-ci.org/RusticiSoftware/TinCanJava.png)](https://travis-ci.org/RusticiSoftware/TinCanJava)
+
 For hosted API documentation, basic usage instructions, supported version listing, etc. visit the main project website at:
 
 http://rusticisoftware.github.io/TinCanJava/

pom.xml

@@ -51,7 +51,7 @@
                 </configuration>
                 <version>3.0</version>
             </plugin>
-            <plugin>
+            <!--<plugin>
                 <groupId>org.projectlombok</groupId>
                 <artifactId>lombok-maven-plugin</artifactId>
                 <version>0.11.6.0</version>
@@ -67,7 +67,7 @@
                     <addOutputDirectory>false</addOutputDirectory>
                     <sourceDirectory>src/main/java</sourceDirectory>
                 </configuration>
-            </plugin>
+            </plugin>-->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>

src/main/java/com/rusticisoftware/tincan/About.java

@@ -0,0 +1,87 @@
+/*
+    Copyright 2014 Rustici Software
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+*/
+package com.rusticisoftware.tincan;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.rusticisoftware.tincan.json.JSONBase;
+import com.rusticisoftware.tincan.json.Mapper;
+import com.rusticisoftware.tincan.json.StringOfJSON;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+
+@Data
+@EqualsAndHashCode(callSuper = false)
+public class About extends JSONBase{
+    private List<TCAPIVersion> version;
+    private Extensions extensions;
+
+    public About(String str) throws IOException, URISyntaxException {
+        StringOfJSON jsonStr = new StringOfJSON(str);
+        init(jsonStr.toJSONNode());
+    }
+
+    public About(StringOfJSON jsonStr) throws IOException, URISyntaxException{
+        init(jsonStr.toJSONNode());
+    }
+
+    public About(JsonNode jsonNode) throws URISyntaxException{
+        init(jsonNode);
+    }
+
+    private void init(JsonNode jsonNode) throws URISyntaxException{
+
+        if(jsonNode.hasNonNull("version")) {
+
+            Iterator it = jsonNode.get("version").elements();
+
+            while(it.hasNext()){
+                if(version == null) { version = new ArrayList<TCAPIVersion>(); }
+                version.add(TCAPIVersion.fromString(((JsonNode)it.next()).textValue()));
+            }
+        }
+
+        if(jsonNode.hasNonNull("extensions")) {
+            extensions = new Extensions(jsonNode.get("extensions"));
+        }
+    }
+
+    @Override
+    public ObjectNode toJSONNode(TCAPIVersion v) {
+        ObjectNode result = new ObjectNode(Mapper.getInstance().getNodeFactory());
+        if(!version.isEmpty()){
+            ArrayNode versions = Mapper.getInstance().createArrayNode();
+            for(TCAPIVersion tcapiVersion: this.getVersion()){
+                versions.add(tcapiVersion.toString());
+            }
+            result.put("version", versions);
+        }
+
+        if(extensions != null){
+            result.put("extensions", extensions.toJSONNode());
+        }
+
+        return result;
+    }
+
+}

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

@@ -160,7 +160,7 @@ public ObjectNode toJSONNode(TCAPIVersion version) {
             }
         }
         if (this.category != null && this.category.size() > 0) {
-            if (version.ordinal() >= TCAPIVersion.V100.ordinal()) {
+            if (version.ordinal() <= TCAPIVersion.V100.ordinal()) {
                 ArrayNode category = mapper.createArrayNode();
                 node.put("category", category);
 

src/main/java/com/rusticisoftware/tincan/LRS.java

@@ -15,20 +15,38 @@
 */
 package com.rusticisoftware.tincan;
 
+import com.rusticisoftware.tincan.documents.*;
+import com.rusticisoftware.tincan.lrsresponses.*;
+
 import java.util.List;
 import java.util.UUID;
 
 /**
  * Define the interface that must be satisfied to talk to an LRS
  */
 public interface LRS {
-    Statement retrieveStatement(String id) throws Exception;
-    Statement retrieveVoidedStatement(String id) throws Exception;
-    StatementsResult queryStatements(StatementsQueryInterface query) throws Exception;
-    StatementsResult moreStatements(String moreURL) throws Exception;
-    UUID saveStatement(Statement statement) throws Exception;
-    List<String> saveStatements(List<Statement> statements) throws Exception;
-
-    State retrieveState(String id, String activityId, Agent agent, UUID registration) throws Exception;
-    void saveState(State state, String activityId, Agent agent, UUID registration) throws Exception;
-}
+    AboutLRSResponse about() throws Exception;
+
+    StatementLRSResponse saveStatement(Statement statement) throws Exception;
+    StatementsResultLRSResponse saveStatements(List<Statement> statements) throws Exception;
+    StatementLRSResponse retrieveStatement(String id) throws Exception;
+    StatementLRSResponse retrieveVoidedStatement(String id) throws Exception;
+    StatementsResultLRSResponse queryStatements(StatementsQueryInterface query) throws Exception;
+    StatementsResultLRSResponse moreStatements(String moreURL) throws Exception;
+
+    ProfileKeysLRSResponse retrieveStateIds(Activity activity, Agent agent, UUID registration) throws Exception;
+    StateLRSResponse retrieveState(String id, Activity activity, Agent agent, UUID registration) throws Exception;
+    LRSResponse saveState(StateDocument state) throws Exception;
+    LRSResponse deleteState(StateDocument state) throws Exception;
+    LRSResponse clearState(Activity activity, Agent agent, UUID registration) throws Exception;
+
+    ProfileKeysLRSResponse retrieveActivityProfileIds(Activity activity) throws Exception;
+    ActivityProfileLRSResponse retrieveActivityProfile(String id, Activity activity) throws Exception;
+    LRSResponse saveActivityProfile(ActivityProfileDocument profile) throws Exception;
+    LRSResponse deleteActivityProfile(ActivityProfileDocument profile) throws Exception;
+
+    ProfileKeysLRSResponse retrieveAgentProfileIds(Agent agent) throws Exception;
+    AgentProfileLRSResponse retrieveAgentProfile(String id, Agent agent) throws Exception;
+    LRSResponse saveAgentProfile(AgentProfileDocument profile) throws Exception;
+    LRSResponse deleteAgentProfile(AgentProfileDocument profile) throws Exception;
+}