Merge branch 'release-1.2.0' into master

Author: thc202

CHANGES.md

@@ -0,0 +1,44 @@
+# Change Log
+
+Summary of the changes done in each version.
+
+## 1.2.0 (2017-03-29)
+
+### Updated APIs
+
+ - Core APIs updated for ZAP version 2.6.0.
+ - AJAX Spider API
+   - Allows to obtain the full results of a scan, messages in/out of scope and message with I/O errors.
+
+## 1.1.1 (2017-03-09)
+
+### Bug Fixes
+ - Fixed a bug that prevented the new API methods (that don't require the API key) from being used with ZAP versions <= 2.5.0.
+
+## 1.1.0 (2017-03-09)
+
+### Enhancements
+ - The `ClientApi` now allows to set the API key through the constructor, which ensures that the API key is sent whenever required. The API methods that allowed to pass the API key were deprecated in favour of using the new constructor.
+ - It's now possible to specify the API key in all Ant tasks.
+ - It's now possible to obtain the keys of the values of an `ApiResponseSet` (also, deprecated unused/unnecessary constructor and method).
+ - The `Alert` now exposes the alert ID, message ID and scanner ID.
+ - Added confidence "False Positive" (enum `Alert.Confidence`).
+ - `Alert` and `AlertTask` now use `name` instead of `alert` for the name of the alert (zaproxy/zaproxy#1341), older methods were deprecated.
+
+### Bug Fixes
+ - `ApiResponseSet` now has as values `ApiResponse` (zaproxy/zaproxy#3228).
+
+### New APIs
+
+ - Context Alert Filters API, for more information refer to the help page: https://github.com/zaproxy/zap-extensions/wiki/HelpAddonsAlertFiltersAlertFilter
+
+### Updated APIs
+
+ - AJAX Spider API
+   - Allows to scan a context, as a user and just a subtree.
+ - Selenium API
+   - Allows to choose which Firefox binary is used and set the path to geckodriver.
+
+## 1.0.0 (2016-06-03)
+
+First version as "stand alone library", it was migrated from the [zaproxy repository](https://github.com/zaproxy/zaproxy) and released to Maven Central.

README.md

@@ -17,7 +17,7 @@ can be obtained from [Maven Central](http://search.maven.org/) with following co
 
  * GroupId: `org.zaproxy`
  * ArtifactId: `zap-clientapi`
- * Version: `1.0.0`
+ * Version: `1.2.0`
 
 Previous releases are also available, more details can be found in [Maven Central](http://search.maven.org/#search|ga|1|org.zaproxy).
 
@@ -31,3 +31,104 @@ For help using OWASP ZAP API refer to:
 ## Issues
 
 To report issues related to OWASP ZAP API, bugs and enhancements requests, use the [issue tracker of the main OWASP ZAP project](https://github.com/zaproxy/zaproxy/issues).
+
+## Building
+
+This project uses Gradle to build its libraries, for example, running:
+
+    ./gradlew build
+
+in the main directory of the project will build all the libraries. The libraries will be located in the `build/libs` directory
+of each subproject.
+
+### Installing
+
+To install the artifacts to the local Maven repository you can run the following:
+
+    ./gradlew install
+
+The installed artifacts (`zap-clientapi`) are then available for other (local) projects to use.
+
+## Releasing
+
+In the following sections it will be explained the steps necessary to release a new version of the libraries. In all steps the
+version to be released is referred to as `<version-to-release>`, which should be replaced with appropriate version number
+(e.g. 2.1.0).
+
+### Release Branching
+
+The project follows the [git-flow branching model](http://nvie.com/posts/a-successful-git-branching-model/). To release a new version it needs to be created a new release branch, update the version, and tag:
+  1. Create a release branch:
+     `git checkout -b release-<version-to-release> develop`;
+  2. Update version in:
+     1. `build.gradle` file (e.g. remove `-SNAPSHOT`);
+     2. source code (e.g. `@since` and `@deprecated` JavaDoc tags);
+     3. `README.md` file (in `How to Obtain` section);
+  3. Review that everything is correct and commit the changes:
+     `git commit -S -m "Bump version number to <version-to-release>"`
+  4. Checkout `master` and merge the release branch:
+     1. `git checkout master`
+     2. `git merge -S --no-ff release-<version-to-release> -m "Merge branch 'release-<version-to-release>' into master"`
+  5. Tag the new version:
+     `git tag -s v<version-to-release> -m "Version <version-to-release>"`
+
+Reintegrate the changes into `develop` branch:
+  1. Checkout develop branch:
+     `git checkout develop`
+  2. Merge the `release-<version-to-release>` branch:
+     `git merge -S --no-ff release-<version-to-release> -m "Merge branch 'release-<version-to-release>' into develop"`
+     1. Resolve possible conflicts;
+         1. The version can be bumped to the next developing version (e.g. increase the minor version and add `-SNAPSHOT`);
+         2. Continue with the merge (if the version was bumped mention it in the commit message);
+  3. Bump to the next developing version now (e.g. increase the minor version and add `-SNAPSHOT`), if not done during the merge:
+     `git commit -S -m "Bump version number to <developing-version>-SNAPSHOT"`
+
+Delete the release branch:
+
+    git branch -d release-<version-to-release>
+
+Push the branches (`develop` and `master`) and tag:
+
+    git push upstream develop master v<version-to-release>
+
+(Assuming `upstream` is the zaproxy repo.)
+
+### Build for Release
+
+Checkout the tagged version:
+
+    git checkout v<version-to-release>
+
+Create the the artifacts/libraries necessary for the release:
+
+    ./gradlew clean build uberJar
+
+### Release to Maven Central
+
+To upload the built artifacts to OSSRH you can run the following:
+
+    ./gradlew uploadArchives
+
+Once uploaded continue with the release process in OSSRH:
+http://central.sonatype.org/pages/releasing-the-deployment.html
+
+NOTE: The following properties must be defined (e.g. in file `GRADLE_HOME/gradle.properties` ) to successfully sign and
+upload the artifacts:
+ - `signing.keyId` - the ID of the GPG key, used to sign the artifacts;
+ - `ossrhUsername` - the OSSRH username;
+ - `ossrhPassword` - the OSSRH password for above username.
+
+Also, the user must have permissions to upload to GroupId `org.zaproxy`.
+
+### GitHub Release
+
+Release in GitHub:
+ 1. Draft a [new release](https://github.com/zaproxy/zap-api-java/releases/new):
+    - Tag: `v<version-to-release>`
+    - Title: `Version <version-to-release>`
+    - Description: (Add a summary of the changes done in the new version and mention the artifacts/libraries available.)
+ 2. Upload the libraries:
+     - `zap-api-<version-to-release>.jar`
+     - `zap-clientapi-<version-to-release>.jar`
+     - `zap-clientapi-ant-<version-to-release>.jar`
+ 3. Publish release.

build.gradle

@@ -10,7 +10,7 @@ allprojects {
     apply plugin: 'java'
     group = 'org.zaproxy'
 
-    version '1.1.1'
+    version '1.2.0'
     ext.versionBC = '1.0.0'
 
     repositories {

subprojects/zap-clientapi/src/main/java/org/zaproxy/clientapi/gen/Acsrf.java

@@ -41,14 +41,14 @@ public Acsrf(ClientApi api) {
 	}
 
 	/**
-	 * Lists the names of all anti CSRF tokens
+	 * Lists the names of all anti-CSRF tokens
 	 */
 	public ApiResponse optionTokensNames() throws ClientApiException {
 		return api.callApi("acsrf", "view", "optionTokensNames", null);
 	}
 
 	/**
-	 * Adds an anti CSRF token with the given name, enabled by default
+	 * Adds an anti-CSRF token with the given name, enabled by default
 	 */
 	public ApiResponse addOptionToken(String string) throws ClientApiException {
 		Map<String, String> map = new HashMap<>();
@@ -57,7 +57,7 @@ public ApiResponse addOptionToken(String string) throws ClientApiException {
 	}
 
 	/**
-	 * Removes the anti CSRF token with the given name
+	 * Removes the anti-CSRF token with the given name
 	 */
 	public ApiResponse removeOptionToken(String string) throws ClientApiException {
 		Map<String, String> map = new HashMap<>();
@@ -66,7 +66,7 @@ public ApiResponse removeOptionToken(String string) throws ClientApiException {
 	}
 
 	/**
-	 * Generate a form for testing lack of anti CSRF tokens - typically invoked via ZAP
+	 * Generate a form for testing lack of anti-CSRF tokens - typically invoked via ZAP
 	 */
 	public byte[] genForm(String hrefid) throws ClientApiException {
 		Map<String, String> map = new HashMap<>();

subprojects/zap-clientapi/src/main/java/org/zaproxy/clientapi/gen/AjaxSpider.java

@@ -68,6 +68,13 @@ public ApiResponse numberOfResults() throws ClientApiException {
 		return api.callApi("ajaxSpider", "view", "numberOfResults", null);
 	}
 
+	/**
+	 * This component is optional and therefore the API will only work if it is installed
+	 */
+	public ApiResponse fullResults() throws ClientApiException {
+		return api.callApi("ajaxSpider", "view", "fullResults", null);
+	}
+
 	/**
 	 * This component is optional and therefore the API will only work if it is installed
 	 */