Merge pull request #28 from imsweb/new-naaccr-endpoints

Added support for new NAACCR endpoints.

Author: ctmay4

build.gradle

@@ -6,8 +6,8 @@ plugins {
     id 'signing'
     id "io.codearte.nexus-staging" version "0.22.0"
     id 'com.adarshr.test-logger' version '2.1.1'
-    id "com.github.ben-manes.versions" version "0.34.0"
-    id "org.owasp.dependencycheck" version "6.0.3"
+    id "com.github.ben-manes.versions" version "0.36.0"
+    id 'org.sonatype.gradle.plugins.scan' version '2.0.3'
 }
 
 group = 'com.imsweb'
@@ -32,13 +32,16 @@ repositories {
 }
 
 dependencies {
-    spotbugs 'com.github.spotbugs:spotbugs:4.1.4'
+    spotbugs 'com.github.spotbugs:spotbugs:4.2.1'
 
     api 'com.squareup.retrofit2:retrofit:2.9.0'
     api 'com.squareup.retrofit2:converter-jackson:2.9.0'
 
-    testImplementation 'junit:junit:4.13.1'
-    testImplementation 'org.assertj:assertj-core:3.18.0'
+    // newer version of dependency to fix vulnerability until converter-jackson is updated
+    api 'com.fasterxml.jackson.core:jackson-databind:2.10.5.1'
+
+    testImplementation 'junit:junit:4.13.2'
+    testImplementation 'org.assertj:assertj-core:3.19.0'
 }
 
 jar {
@@ -67,14 +70,24 @@ spotbugs {
     excludeFilter = file('config/spotbugs/spotbugs-exclude.xml')
 }
 
-// OWASP check (https://jeremylong.github.io/DependencyCheck/index.html)
-dependencyCheck {
-    failOnError = true
-    format = 'ALL'
+// Nexus vulnerability scan (see https://github.com/sonatype-nexus-community/scan-gradle-plugin)
+ossIndexAudit {
+    dependencyGraph = true
+    printBanner = false
+
+    // only set proxy if running outside of Github Actions
+    if (!System.getenv().GITHUB_ACTIONS) {
+        proxyConfiguration {
+            protocol = 'http'
+            host = 'webproxy-btp.imsweb.com'
+            port = 8080
+        }
+    }
 }
+check.dependsOn 'ossIndexAudit'
 
 wrapper {
-    gradleVersion = '6.7'
+    gradleVersion = '6.8.2'
     distributionType = Wrapper.DistributionType.ALL
 }
 

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.2-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

src/main/java/com/imsweb/seerapi/client/naaccr/NaaccrFieldName.java

@@ -7,24 +7,22 @@
 
 public class NaaccrFieldName {
 
+    @JsonProperty("id")
+    protected String _id;
     @JsonProperty("item")
     protected Integer _item;
     @JsonProperty("name")
     protected String _name;
 
-    public Integer getItem() {
-        return _item;
+    public String getNaaccrId() {
+        return _id;
     }
 
-    public void setItem(Integer item) {
-        _item = item;
+    public Integer getItemNum() {
+        return _item;
     }
 
     public String getName() {
         return _name;
     }
-
-    public void setName(String name) {
-        _name = name;
-    }
 }

…b/seerapi/client/naaccr/NaaccrField.java …erapi/client/naaccr/NaaccrFlatField.javasrc/main/java/com/imsweb/seerapi/client/naaccr/NaaccrField.java renamed to src/main/java/com/imsweb/seerapi/client/naaccr/NaaccrFlatField.java src/main/java/com/imsweb/seerapi/client/naaccr/NaaccrField.java renamed to src/main/java/com/imsweb/seerapi/client/naaccr/NaaccrFlatField.java

@@ -9,8 +9,10 @@
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 
 @JsonPropertyOrder({"item", "name", "section", "start_col", "end_col", "alignment", "padding_char", "default_value", "documentation", "subfield"})
-public class NaaccrField {
+public class NaaccrFlatField {
 
+    @JsonProperty("id")
+    protected String _id;
     @JsonProperty("item")
     protected Integer _item;
     @JsonProperty("name")
@@ -32,83 +34,47 @@ public class NaaccrField {
     @JsonProperty("subfield")
     protected List<NaaccrSubField> _subFields;
 
-    public Integer getItem() {
-        return _item;
+    public String getNaaccrId() {
+        return _id;
     }
 
-    public void setItem(Integer item) {
-        _item = item;
+    public Integer getItemNum() {
+        return _item;
     }
 
     public String getName() {
         return _name;
     }
 
-    public void setName(String name) {
-        _name = name;
-    }
-
     public String getSection() {
         return _section;
     }
 
-    public void setSection(String section) {
-        _section = section;
-    }
-
     public Integer getStart() {
         return _start;
     }
 
-    public void setStart(Integer start) {
-        _start = start;
-    }
-
     public Integer getEnd() {
         return _end;
     }
 
-    public void setEnd(Integer end) {
-        _end = end;
-    }
-
     public String getAlign() {
         return _align;
     }
 
-    public void setAlign(String align) {
-        _align = align;
-    }
-
     public String getPadChar() {
         return _padChar;
     }
 
-    public void setPadChar(String padChar) {
-        _padChar = padChar;
-    }
-
     public String getDefaultValue() {
         return _defaultValue;
     }
 
-    public void setDefaultValue(String defaultValue) {
-        _defaultValue = defaultValue;
-    }
-
     public String getDocumentation() {
         return _documentation;
     }
 
-    public void setDocumentation(String documentation) {
-        _documentation = documentation;
-    }
-
     public List<NaaccrSubField> getSubFields() {
         return _subFields;
     }
-
-    public void setSubFields(List<NaaccrSubField> subFields) {
-        _subFields = subFields;
-    }
 }

src/main/java/com/imsweb/seerapi/client/naaccr/NaaccrService.java

@@ -12,27 +12,60 @@
 public interface NaaccrService {
 
     /**
-     * Return a collection of NaaccrVersion objects which descibe the available versions
+     * Return a collection of NaaccrVersion objects which descibe the available flat file versions
      * @return a list of the available NAACCR versions and information about each of them
      */
-    @GET("naaccr/versions")
-    Call<List<NaaccrVersion>> versions();
+    @GET("naaccr/flat/versions")
+    Call<List<NaaccrVersion>> flatVersions();
 
     /**
-     * Return a list of all the field identifiers and names from a specified NAACCR version
+     * Return a collection of NaaccrVersion objects which descibe the available XML versions
+     * @return a list of the available NAACCR versions and information about each of them
+     */
+    @GET("naaccr/xml/versions")
+    Call<List<NaaccrVersion>> xmlVersions();
+
+    /**
+     * Return a list of all the field identifiers and names from a specified NAACCR flat file version
+     * @param version NAACCR version
+     * @return a list of NaaccrFieldName objects
+     */
+    @GET("naaccr/flat/{version}")
+    Call<List<NaaccrFieldName>> flatFieldNames(@Path("version") String version);
+
+    /**
+     * Return a list of all the field identifiers and names from a specified NAACCR XML version
+     * @param version NAACCR version
+     * @return a list of NaaccrFieldName objects
+     */
+    @GET("naaccr/xml/{version}")
+    Call<List<NaaccrFieldName>> xmlFieldNames(@Path("version") String version);
+
+    /**
+     * Return a list of all the field identifiers and names from a specified NAACCR flat file version
+     * @param version NAACCR version
+     * @param item NAACCR item number
+     * @return a list of NaaccrFieldName objects
+     */
+    @GET("naaccr/flat/{version}/item/{item}")
+    Call<NaaccrFlatField> flatField(@Path("version") String version, @Path("item") Integer item);
+
+    /**
+     * Return a list of all the field identifiers and names from a specified NAACCR XML version
      * @param version NAACCR version
+     * @param id NAACCR XML id
      * @return a list of NaaccrFieldName objects
      */
-    @GET("naaccr/{version}")
-    Call<List<NaaccrFieldName>> fieldNames(@Path("version") String version);
+    @GET("naaccr/xml/{version}/id/{id}")
+    Call<NaaccrXmlField> xmlField(@Path("version") String version, @Path("id") String id);
 
     /**
-     * Return a list of all the field identifiers and names from a specified NAACCR version
+     * Return a list of all the field identifiers and names from a specified NAACCR XML version
      * @param version NAACCR version
      * @param item NAACCR item number
      * @return a list of NaaccrFieldName objects
      */
-    @GET("naaccr/{version}/item/{item}")
-    Call<NaaccrField> field(@Path("version") String version, @Path("item") Integer item);
+    @GET("naaccr/xml/{version}/item/{item}")
+    Call<NaaccrXmlField> xmlField(@Path("version") String version, @Path("item") Integer item);
 
 }

src/main/java/com/imsweb/seerapi/client/naaccr/NaaccrSubField.java

@@ -24,47 +24,23 @@ public Integer getItem() {
         return _item;
     }
 
-    public void setItem(Integer item) {
-        _item = item;
-    }
-
     public String getName() {
         return _name;
     }
 
-    public void setName(String name) {
-        _name = name;
-    }
-
     public Integer getStart() {
         return _start;
     }
 
-    public void setStart(Integer start) {
-        _start = start;
-    }
-
     public Integer getEnd() {
         return _end;
     }
 
-    public void setEnd(Integer end) {
-        _end = end;
-    }
-
     public String getAlign() {
         return _align;
     }
 
-    public void setAlign(String align) {
-        _align = align;
-    }
-
     public String getPadChar() {
         return _padChar;
     }
-
-    public void setPadChar(String padChar) {
-        _padChar = padChar;
-    }
 }

src/main/java/com/imsweb/seerapi/client/naaccr/NaaccrVersion.java

@@ -14,44 +14,41 @@ public class NaaccrVersion {
     protected String _description;
     @JsonProperty("style")
     protected String _style;
+    @JsonProperty("dictionary_uri")
+    protected String dictionaryUri;
+    @JsonProperty("dictionary_description")
+    protected String dictionaryDescription;
+    @JsonProperty("specification_version")
+    protected String specificationVersion;
 
     public String getVersion() {
         return _version;
     }
 
-    public void setVersion(String version) {
-        _version = version;
-    }
-
     public String getName() {
         return _name;
     }
 
-    public void setName(String name) {
-        _name = name;
-    }
-
     public Integer getLength() {
         return _length;
     }
 
-    public void setLength(Integer length) {
-        _length = length;
-    }
-
     public String getDescription() {
         return _description;
     }
 
-    public void setDescription(String description) {
-        _description = description;
-    }
-
     public String getStyle() {
         return _style;
     }
 
-    public void setStyle(String style) {
-        _style = style;
+    public String getDictionaryUri() {
+        return dictionaryUri;
+    }
+
+    public String getDictionaryDescription() {
+        return dictionaryDescription;
+    }
+    public String getSpecificationVersion() {
+        return specificationVersion;
     }
 }