com.sonalake.swaggerlog.nexus.Scanner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swagger-changelog-gradle-plugin Show documentation
Build an asciidoc swagger changelog from a nexus history
There is a newer version: 1.0.3
Show newest version
package com.sonalake.swaggerlog.nexus;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;
import com.mashape.unirest.http.exceptions.UnirestException;
import com.sonalake.swaggerlog.config.Config;
import lombok.Builder;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;

import java.io.IOException;
import java.util.List;

import static java.util.Optional.ofNullable;

/**
 * Queries nexus for the swagger docs for a given artifact, sorts them, and then
 * gets an ordered history for processing.
 */
@Builder
@RequiredArgsConstructor
@Slf4j
public class Scanner {
  private final Config config;

  /**
   * Given the config, get the ordered history of diffable swaggers.
   *
   * @return the list of versions
   */
  public List getHistory() {
    HttpResponse search = queryForSwaggerDocs();
    SearchResults versions = parseSearchResults(search);
    appendSnapshotToHistory(versions);
    return versions.buildHistory();
  }

  /**
   * Find all the swagger docs.
   *
   * @return the raw json result for the query
   */
  private HttpResponse queryForSwaggerDocs() {
    try {
      return Unirest.get(config.getNexusSearchPath())
        .header("accept", "application/json")
        .queryString("g", config.getArtifact().getGroupId())
        .queryString("a", config.getArtifact().getArtifactId())
        .queryString("p", "json")
        .queryString("repositoryId", config.getRepositoryId())
        .asString();
    } catch (UnirestException e) {
      throw new IllegalArgumentException("Failed to query for docs at: " + config, e);
    }
  }

  /**
   * If there is a snapshot, then add it to the search results
   *
   * @param versions the discovered versions
   */
  private void appendSnapshotToHistory(SearchResults versions) {
    ofNullable(config.getSnapshotVersionFile()).ifPresent(path -> {
      VersionedArtifact version = VersionedArtifact.builder()
        .group(config.getArtifact().getGroupId())
        .artifact(config.getArtifact().getArtifactId())
        .path(path)
        .build();
      log.debug("Adding local snapshot file to version history");
      versions.addSnapshot(version);
    });
  }

  /**
   * Parse the search restuls, and translate them into the SearchResults type
   *
   * @param search
   * @return
   */
  private SearchResults parseSearchResults(HttpResponse search) {
    log.debug(search.getBody());

    ObjectMapper mapper = new ObjectMapper();
    final SearchResults versions;
    try {
      versions = mapper.readValue(search.getBody(), SearchResults.class);
    } catch (IOException e) {
      throw new IllegalArgumentException("Failed to parse results from nexus: " + config, e);
    }
    return versions;
  }

  /**
   * Build the version UTI for downloading the swagger, for the given version
   *
   * @param version The versioned artifact model
   * @return the URL to download this artifact
   */
  public String getVersionUri(VersionedArtifact version) {
    if (version.isSnapshot()) {
      return version.getPath();
    }
    return String.format("%s/%s/%s/%s/%s-%s.json",
      config.getNexusDownloadPath("releases"),
      version.getGroup().replace('.', '/'),
      version.getArtifact(),
      version.getVersion(),
      version.getArtifact(),
      version.getVersion()
    );
  }
}