Merge branch 'release-2.0'

Author: starlightknight

.gitlab-ci.yml

@@ -15,19 +15,19 @@ cache:
      - .gradle/wrapper
      - .gradle/caches
 
-job_build_develop:
+job_build:
   stage: build
   script:
-    - ./gradlew clean build
-  only:
-    - develop
+    - ./gradlew clean build shadowJar
+  except:
+    - maseter
   tags:
     - docker
 
 job_build_master:
   stage: build
   script:
-    - ./gradlew clean build -Prelease=true
+    - ./gradlew clean build shadowJar -Prelease=true
   only:
     - master
   tags:
@@ -36,12 +36,22 @@ job_build_master:
 job_analyze_develop:
   stage: analyze
   script:
-    - ./gradlew jacocoTestReport sonarqube
+    - ./gradlew jacocoTestReport sonarqube -Dsonar.issuesReport.console.enable=true -Dsonar.gitlab.commit_sha=$CI_BUILD_REF -Dsonar.gitlab.ref=$CI_BUILD_REF_NAME
   only:
     - develop
   tags:
     - docker
 
+job_analyze_pull:
+  stage: analyze
+  script:
+    - ./gradlew jacocoTestReport sonarqube -Dsonar.analysis.mode=preview -Dsonar.issuesReport.console.enable=true -Dsonar.gitlab.commit_sha=$CI_BUILD_REF -Dsonar.gitlab.ref=$CI_BUILD_REF_NAME
+  except:
+    - develop
+    - master
+  tags:
+    - docker
+
 job_publish_develop:
   stage: publish
   only:
@@ -50,6 +60,7 @@ job_publish_develop:
     - ./gradlew publish
   artifacts:
     paths:
+    - swagger-confluence-cli/build/libs/*.jar
     - swagger-confluence-core/build/libs/*.jar
     - swagger-confluence-gradle-plugin/build/libs/*.jar
   tags:
@@ -63,6 +74,7 @@ job_publish_master:
     - ./gradlew publish -Prelease=true
   artifacts:
     paths:
+    - swagger-confluence-cli/build/libs/*.jar
     - swagger-confluence-core/build/libs/*.jar
     - swagger-confluence-gradle-plugin/build/libs/*.jar
   tags:

README.md

@@ -16,21 +16,40 @@ This project uses the following flow to publish to Confluence:
 
 Your Swagger Schema -> Swagger2Markup -> AsciiDoctorJ -> XHTML -> Confluence REST API
 
+
+
 This project requires the use of Java 7 or later.
 
-## Documentation & Usage
+## Components
+
+The project is current broken into three components
+
+- **swagger-confluence-core:** a core shared library to handle converting and publishing the swagger schema to confluence. This shared library should be reusable by other projects
+- **swagger-confluence-gradle-plugin:** a gradle plugin to provide seamless conversion and publishing
+- **swagger-confluence-cli:** a command line executor for publishing to swagger docs to confluence
+
+## Documentation & Usage Guide
 
 You can view the documentation and usage guide [here](https://cloud.slkdev.net/swagger-confluence)
 
+## Live Demo
+
+You can view a live demo of Swagger Confluence [here on my Confluence Server](https://cloud.slkdev.net/confluence/display/DEMO/Swagger+Confluence+Demos)
+
 ## Contributing
 
 ### Community contributions
 
+Pull requests are welcome. The primary source repository for this project is hosted on my [GitLab CE Instance](https://cloud.slkdev.net/gitlab/starlightknight/swagger-confluence).
 
-Pull requests are welcome. Please submit via my [GitLab Instance](https://cloud.slkdev.net/gitlab/starlightknight/swagger-confluence)
 
+It is preferred that if you wish to contribute, you submit there as this is where I have CI, SonarQube, etc set up. GitLab CE officially provides OmniAuth integration to make this easy, or you can of course sign up manually as well.
 
 
+GitLab CE is open source software. If you are unfamiliar with it, you can read more about it [here](https://about.gitlab.com/) on their official web site.
+
+
+If you are not comfortable with this, you may submit via the GitHub mirror, and I will merge it back manually.
 
 ### Questions, Bugs, or Enhacement Requests
 
@@ -48,6 +67,10 @@ If you would like an enhancement to be made to the Swagger Confluence, pull requ
 
 
 
+## Static Code Analysis + Coverage
+
+See [SonarQube](https://cloud.slkdev.net/sonar/overview?id=30) for this project
+
 ## Special Thanks
 
 
@@ -66,11 +89,9 @@ conjunction with the above projects and their respective gradle plugins before s
 * [asciidoctor-confluence](https://github.com/gscheibel/asciidoctor-confluence)
 * [asciidoc2confluence](https://github.com/rdmueller/asciidoc2confluence)
 
-The XHTML->Confluence REST API portion of this library was inspired by the
+The XHTML->Confluence REST API portion of this library was originally inspired by the
 asciidoc2confluence groovy script
 
-
-
 ## License
 
 Copyright 2016 Aaron Knight

build.gradle

@@ -1,3 +1,34 @@
+buildscript {
+    repositories {
+        mavenLocal()
+        maven {
+            url "https://plugins.gradle.org/m2/"
+        }
+        jcenter()
+        mavenCentral()
+    }
+    dependencies {
+        classpath "org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:1.2"
+    }
+}
+
+tasks.withType(JavaExec) {
+    systemProperties System.properties
+}
+
+apply plugin: 'org.sonarqube'
+
+sonarqube {
+    properties {
+        property "sonar.host.url", "$System.env.SONAR_URL"
+        property "sonar.login", "$System.env.SONAR_USER"
+        property "sonar.password", "$System.env.SONAR_PASS"
+        property "sonar.sourceEncoding", "UTF-8"
+        property "sonar.java.source", "1.7"
+        property "sonar.java.target", "1.7"
+    }
+}
+
 allprojects {
     apply plugin: 'idea'
     apply plugin: 'eclipse'
@@ -6,7 +37,7 @@ allprojects {
 subprojects {
     group 'net.slkdev.swagger.confluence'
 
-    version '1.0'
+    version '2.0'
 
     if (project.hasProperty("release")) {
         version += '-RELEASE'

gradle.properties

@@ -1,5 +1,7 @@
 ASCIIDOCTORJ_VERSION=1.5.4
+COMMONS_CLI=1.3.1
 JSONPATH_VERSION=2.2.0
+JSOUP_VERSION=1.8.3
 JUNIT_VERSION=4.12
 LOG4J2_VERSION=2.5
 MOCKITO_VERSION=1.10.19

settings.gradle

@@ -1,3 +1,3 @@
 rootProject.name = 'swagger-confluence'
-include 'swagger-confluence-core', 'swagger-confluence-gradle-plugin'
+include 'swagger-confluence-core', 'swagger-confluence-gradle-plugin', 'swagger-confluence-cli'
 

swagger-confluence-cli/build.gradle

@@ -0,0 +1,76 @@
+buildscript {
+    repositories {
+        mavenLocal()
+        maven {
+            url "https://plugins.gradle.org/m2/"
+        }
+        jcenter()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.github.jengelman.gradle.plugins:shadow:1.2.3'
+        classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.6'
+    }
+}
+
+apply plugin: 'java'
+apply plugin: 'com.github.johnrengelman.shadow'
+apply plugin: 'com.jfrog.bintray'
+
+defaultTasks 'shadowJar'
+
+jar {
+    manifest {
+        attributes 'Main-Class': 'net.slkdev.swagger.confluence.cli.SwaggerConfluence'
+    }
+}
+
+shadowJar {
+    baseName = 'swagger-confluence-cli-all'
+    classifier = ''
+    mergeServiceFiles()
+    append('NOTICE')
+}
+
+bintray {
+    user = "$System.env.BINTRAY_USER"
+    key = "$System.env.BINTRAY_PASS"
+    publications = ['myPublication']
+    pkg {
+        version {
+            name = project.version
+        }
+        repo = "$System.env.BINTRAY_REPO"
+        name = 'swagger-confluence-cli'
+        userOrg = "$System.env.BINTRAY_USER"
+        licenses = ['Apache-2.0']
+        vcsUrl = 'https://cloud.slkdev.net/gitlab/starlightknight/swagger-confluence'
+        websiteUrl = 'https://cloud.slkdev.net/swagger-confluence'
+        issueTrackerUrl = 'https://cloud.slkdev.net/gitlab/starlightknight/swagger-confluence/issues'
+        labels = ['swagger','confluence']
+    }
+}
+
+evaluationDependsOn(':swagger-confluence-core')
+
+dependencies {
+    compile (project(':swagger-confluence-core'))
+    compile "commons-cli:commons-cli:$COMMONS_CLI"
+
+    testCompile "junit:junit:$JUNIT_VERSION"
+    testCompile "org.mockito:mockito-core:$MOCKITO_VERSION"
+}
+
+publishing {
+	publications {
+        myPublication(MavenPublication) {
+            from components.java
+            artifactId = 'swagger-confluence-cli'
+        }
+		myShadowPublication(MavenPublication) {
+			from components.shadow
+            artifactId = 'swagger-confluence-cli-all'
+		}
+	}
+}
+

swagger-confluence-cli/src/main/java/net/slkdev/swagger/confluence/cli/SwaggerConfluence.java

@@ -0,0 +1,130 @@
+/*
+ * Copyright 2016 Aaron Knight
+ *
+ * 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 net.slkdev.swagger.confluence.cli;
+
+import net.slkdev.swagger.confluence.config.SwaggerConfluenceConfig;
+import net.slkdev.swagger.confluence.context.SwaggerConfluenceContextConfig;
+import net.slkdev.swagger.confluence.exception.SwaggerConfluenceConfigurationException;
+import net.slkdev.swagger.confluence.service.SwaggerToConfluenceService;
+import org.apache.commons.cli.*;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+
+import static org.apache.commons.lang3.Validate.notNull;
+
+public class SwaggerConfluence {
+
+    private SwaggerToConfluenceService swaggerToConfluenceService;
+
+    public SwaggerConfluence(final SwaggerToConfluenceService swaggerToConfluenceService){
+        notNull(swaggerToConfluenceService, "SwaggerToConfluenceService Cannot Be Null!");
+        this.swaggerToConfluenceService = swaggerToConfluenceService;
+    }
+
+    public static void main(final String[] args){
+        final SwaggerToConfluenceService swaggerToConfluenceService = bootSwaggerConfluence();
+        final SwaggerConfluence swaggerConfluence = new SwaggerConfluence(swaggerToConfluenceService);
+        swaggerConfluence.runCLI(args);
+    }
+
+    private static SwaggerToConfluenceService bootSwaggerConfluence(){
+        final AnnotationConfigApplicationContext annotationConfigApplicationContext =
+                new AnnotationConfigApplicationContext(SwaggerConfluenceContextConfig.class);
+        return annotationConfigApplicationContext.getBean(SwaggerToConfluenceService.class);
+    }
+
+    public void runCLI(final String args[]){
+        final Options options = buildOptions();
+        final CommandLine commandLine = parseCommandLineOptions(options, args);
+
+        if(commandLine.hasOption("h") || args.length == 0){
+            final HelpFormatter formatter = new HelpFormatter();
+            formatter.printHelp("swagger-confluence-cli", options);
+        }
+        else {
+            final SwaggerConfluenceConfig swaggerConfluenceConfig =
+                    buildSwaggerConfluenceConfig(commandLine);
+            swaggerToConfluenceService.convertSwaggerToConfluence(swaggerConfluenceConfig);
+        }
+    }
+
+    private static Options buildOptions(){
+        final Options options = new Options();
+
+        options.addOption("a", "ancestor-id", true, "ancestor id to use for the published api doc");
+        options.addOption("b", "authentication", true, "base64 encoded user:pass pair for authentication");
+        options.addOption("g", "generate-numeric-prefixes", true, "boolean flag to indicate whether to " +
+                "generate numeric prefixes for titles");
+        options.addOption("h", "help", false, "Print help message with usage information");
+        options.addOption("i", "include-toc-on-single", true, "Include table of contents on single page mode");
+        options.addOption("k", "space-key", true, "Space Key to publish api doc to");
+        options.addOption("m", "pagination-mode", true, "Pagination mode to use: [single, category, individual]");
+        options.addOption("s", "swagger-schema", true, "Swagger Schema name. Absolute, relative, or classpath location");
+        options.addOption("p", "prefix", true, "Prefix to use for article titles to ensure uniqueness");
+        options.addOption("t", "title", true, "Base title to use for the root article of the API doc");
+        options.addOption("u", "confluence-rest-api-url", true, "URL to the confluence REST API");
+
+        return options;
+    }
+
+    private static CommandLine parseCommandLineOptions(final Options options, final String[] args){
+        final CommandLineParser commandLineParser = new DefaultParser();
+
+        try {
+            return commandLineParser.parse(options, args);
+
+        } catch (ParseException e) {
+            throw new SwaggerConfluenceConfigurationException(
+                    "Error Parsing Command Line Arguments!", e);
+        }
+    }
+
+    private static SwaggerConfluenceConfig buildSwaggerConfluenceConfig(final CommandLine commandLine){
+        final SwaggerConfluenceConfig swaggerConfluenceConfig = new SwaggerConfluenceConfig();
+        final String ancestorIdString = commandLine.getOptionValue("a");
+        final Integer ancestorId;
+
+        if(ancestorIdString == null){
+            ancestorId = null;
+        }
+        else {
+            ancestorId = Integer.valueOf(ancestorIdString);
+        }
+
+        swaggerConfluenceConfig.setAncestorId(ancestorId);
+        swaggerConfluenceConfig.setAuthentication(commandLine.getOptionValue("b"));
+        swaggerConfluenceConfig.setConfluenceRestApiUrl(commandLine.getOptionValue("u"));
+        swaggerConfluenceConfig.setGenerateNumericPrefixes(
+                Boolean.valueOf(commandLine.getOptionValue("g", "true"))
+        );
+        swaggerConfluenceConfig.setIncludeTableOfContentsOnSinglePage(
+                Boolean.valueOf(commandLine.getOptionValue("i", "true"))
+        );
+        swaggerConfluenceConfig.setPaginationMode(commandLine.getOptionValue("m","single"));
+
+        final String prefix = commandLine.getOptionValue("p");
+
+        if(prefix != null){
+            swaggerConfluenceConfig.setPrefix(prefix);
+        }
+
+        swaggerConfluenceConfig.setSpaceKey(commandLine.getOptionValue("k"));
+        swaggerConfluenceConfig.setSwaggerSchema(commandLine.getOptionValue("s"));
+        swaggerConfluenceConfig.setTitle(commandLine.getOptionValue("t"));
+
+        return swaggerConfluenceConfig;
+    }
+
+}