Merge pull request #5 from equella/issues/1and4

Issues/1 - B2 and WS now builds via Gradle

.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+
+[*.java]
+indent_style = tab
+tab_width = 4

.gitignore

@@ -2,4 +2,12 @@ staging/
 classes/
 gensrc/
 test.classes/
+target/
+.gradle/
+bin/
+build/
+*.licensed
+.settings/
+.project
+.classpath
 

LICENSES.md

@@ -0,0 +1,39 @@
+# Licenses
+
+This matrix lists any dependencies that have weight in determining how to license this repo and resulting binaries.
+
+Dependency | License
+--- | ---
+javax.servlet-api | CDDL GPL 2.0 **(Part of the Java spec, so doesn't create an issue with licensing the repo/binary as Apache 2.0)**
+javax.servlet.jsp:javax.servlet.jsp-api | CDDL GPL 2.0 **(Part of the Java spec, so doesn't create an issue with licensing the repo/binary as Apache 2.0)**
+javax.servlet:jstl:1.2 | CDDL GPL 2.0 **(Part of the Java spec, so doesn't create an issue with licensing the repo/binary as Apache 2.0)**
+commons-httpclient:commons-httpclient:3.1 | Apache 2.0
+commons-beanutils:commons-beanutils*** | Apache 2.0
+commons-codec:commons-codec:1.7*** | Apache 2.0
+commons-discovery:0.5*** | Apache 2.0 
+log4j | Apache 2.0
+org.apache.cxf:cxf-bundle | Apache 2.0 
+com.fasterxml.jackson.core:jackson-databind:2.3.4 | Apache 2.0, LGPL 2.1 (Just Apache 2.0 in later versions) **Plan to upgrade to the later version so it's only Apache 2.0**
+com.fasterxml.jackson.core:jackson-core:2.3.4*** | Apache 2.0, LGPL 2.1 (Just Apache 2.0 in later versions) **Plan to upgrade to the later version so it's only Apache 2.0**
+org.codehaus.woodstox:woodstox-core-asl:4.2.0*** | Apache 2.0
+org.codehaus.woodstox:stax2-api:3.1.3*** |  BSD 2-clause
+stax:stax-api:1.0.1 | Apache 2.0
+org.apache.struts:struts-core:1.3.10 | Apache 2.0
+org.apache.struts:struts-taglib:1.3.10 | Apache 2.0
+org.apache.tomcat.embed:tomcat-embed-core:8.0.42 | Apache 2.0
+org.apache.tomcat.embed:tomcat-embed-logging-juli:8.0.42 | Apache 2.0
+org.apache.tomcat.embed:tomcat-embed-jasper:8.0.42 | Apache 2.0
+com.bmuschko.tomcat:gradle-tomcat-plugin:2.5 | Apache 2.0
+com.google.guava:guava:23.0 | Apache 2.0
+junit:junit:4.12 | EPL 1.0 (EPL 2.0 in later versions)
+org.apache.axis2:axis2:1.6.2*** | Apache 2.0
+org.slf4j:slf4j-api:1.6.1*** | MIT
+org.apache.neethi:neethi (closed-source version unknown) *** | Apache (Apache 2.0 in later versions)
+org.apache.ws.xmlschema:xmlschema-core (closed-source version unknown) *** | Apache 2.0
+Proguard (closed-source version unknown) *** | GPL 2.0  **(Only used during the build phase - not included in the source or binary, so OK for Apache 2.0)**
+xalan:xalan (closed-source version unknown) *** | Apache (Apache 2.0 in later versions)
+bb-taglib | ?
+bb-platform | ?
+bb-cms-admin | ?
+
+Note:  *** means the dependency was in the closed-source version, but hasn't been used in the open-source version yet.

README.md

@@ -1,3 +1,45 @@
 # EQUELLA Blackboard Integration
 
-Information about the Equella open source community and supporting documentation can be found at https://equella.github.io/
+Information about the openEQUELLA community and supporting documentation can be found at https://equella.github.io/
+
+Versions are repo-wide (ie all building blocks / web services will have the same version for a given build).  Versioning will be loosely tied to SemVer.
+
+Version 1.X.Y will support Blackboard v3200 - v3300
+Version 2.W.V will support Blackboard v3400+
+
+## Building the primary building block
+```
+~$ ./gradlew :oeqPrimaryB2:clean
+~$ ./gradlew :oeqPrimaryB2:buildB2
+```
+The war is placed in (cloned repo)/oeqPrimaryB2/build/libs/
+
+## Building the primary web service
+```
+~$ ./gradlew :oeqPrimaryWS:clean
+~$ ./gradlew :oeqPrimaryWS:buildWs
+```
+The jar is placed in (cloned repo)/oeqPrimaryWS/build/libs/
+
+## Building the audit building block
+For now, this is just a skeleton building block for testing.
+
+Eventually it may be a helper building block to audit the Blackboard / openEQUELLA integration.
+
+```
+~$ ./gradlew :oeqAuditB2:clean
+~$ ./gradlew :oeqAuditB2:buildB2
+```
+The war is placed in (cloned repo)/oeqAuditB2/build/libs/
+
+## Building the linkFixer building block
+TODO
+
+## Building the gbFixer building block
+TODO
+
+## Check (and fix) dependency issues
+```
+~$ ./gradlew generateGradleLintReport
+~$ ./gradlew fixGradleLint
+```