Split EdgeRcClientCredentialProvider from core

We have been asked by a customer to minimize the dependencies in the
core signing algorithm module. It appears the INI file reader library we
picked pulls in a few things, so we extracting that signer into a
separate artifact.

Author: elreydetodo

README.md

@@ -17,6 +17,7 @@ libraries.
 This project contains a core implementation module and five bindings to specific HTTP client libraries.
 
 * [edgegrid-signer-core](edgegrid-signer-core) is the core signing implementation and base classes used by the individual library implementations.
+* [edgerc-reader](edgerc-reader) is a configuration file reader that supports edgerc files. These files are basically INI files with certain sections and properties.
 * [edgegrid-signer-apache-http-client](edgegrid-signer-apache-http-client) is a binding for [Apache HTTP Client][2].
 * [edgegrid-signer-google-http-client](edgegrid-signer-google-http-client) is a binding for [Google HTTP Client Library for Java][3].
 * [edgegrid-signer-rest-assured](edgegrid-signer-rest-assured) is a binding for [REST-assured][4].

edgegrid-signer-core/README.md

@@ -82,10 +82,4 @@ credential.
 The constructors for all the `AbstractEdgeGridRequestSigner` implementations
 create one of these transparently whenever they are passed a `ClientCredential`.
 
-`EdgeRcClientCredentialProvider` is another implementation of
-`ClientCredentialProvider` that can read from the EdgeRc configuration files
- that are used in various other EdgeGrid signing library implementations. The
-`#pickSectionName()` method can be overridden by the user to select different
-sections from the configuration file based on the current request.
-
 [1]: https://developer.akamai.com/introduction/Client_Auth.html

edgegrid-signer-core/pom.xml

@@ -22,10 +22,6 @@
             <groupId>commons-codec</groupId>
             <artifactId>commons-codec</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.apache.commons</groupId>
-            <artifactId>commons-configuration2</artifactId>
-        </dependency>
         <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-lang3</artifactId>

edgegrid-signer-core/src/main/java/com/akamai/edgegrid/signer/AbstractEdgeGridRequestSigner.java

@@ -75,7 +75,7 @@ public final ClientCredentialProvider getClientCredentialProvider() {
      * replaces {@code request}'s host name with the one specified by the credential.
      *
      * @param request an HTTP request with data used to sign
-     * @param request an HTTP request to update with signature
+     * @param requestToUpdate an HTTP request to update with signature
      * @throws RequestSigningException       if failed to sign a request
      * @throws NoMatchingCredentialException if acquiring a {@link ClientCredential} throws {@code
      *                                       NoMatchingCredentialException} or returns {@code null}

edgegrid-signer-core/src/main/java/com/akamai/edgegrid/signer/ClientCredentialProvider.java

@@ -27,7 +27,7 @@
  * <p>
  * If you are looking for a basic implementation of this interface, see
  * {@link DefaultClientCredentialProvider}. If you would like to read your configuration from an
- * EdgeRc file, see {@link EdgeRcClientCredentialProvider}.
+ * EdgeRc file, see {@code EdgeRcClientCredentialProvider}.
  * </p>
  *
  * @author mmeyer@akamai.com

edgerc-reader/README.md

@@ -0,0 +1,35 @@
+# EdgeGrid Client for Java
+
+Java implementation of Akamai {OPEN} EdgeGrid signing.
+
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.akamai.edgegrid/edgerc-reader/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.akamai.edgegrid/edgerc-reader)
+[![Javadoc](http://www.javadoc.io/badge/com.akamai.edgegrid/edgerc-reader.svg)](http://www.javadoc.io/doc/com.akamai.edgegrid/edgerc-reader)
+
+## Description
+
+This library implements [Akamai {OPEN} EdgeGrid Authentication][1] for Java.
+This particular module is a `ClientCredentialProvider` implementation which is capable of reading
+credentials from an EdgeRC file.
+
+## Overview of EdgeRC Files
+
+The format of an EdgeRC file is simply an INI file where each section corresponds to an OPEN
+credential. Each section MUST have the following properties:
+* access_token
+* client_secret
+* client_token
+* host
+
+In addition to those 4 required properties, an additional property `max-body` may be present. If
+absent, the implied default is 131072. Many users have mysteriously inherited a `max-body` value of
+8192 in their EdgeRC files. That value is very unlikely to be correct. If you encounter signature
+mismatch errors with POST requests, try removing that value from the file before trying anything
+else.
+
+## Using `EdgeRcClientCredentialProvider`
+
+```java
+ClientCredential credential = EdgeRcClientCredentialProvider.fromEdgeRc("~/.edgerc", "good1").getClientCredential("section");
+```
+
+[1]: https://developer.akamai.com/introduction/Client_Auth.html

edgerc-reader/pom.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>edgegrid-signer-parent</artifactId>
+        <groupId>com.akamai.edgegrid</groupId>
+        <version>4.0.0-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+    
+    <artifactId>edgerc-reader</artifactId>
+    <name>EdgeRC ClientCredentialProvider Implementation</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.akamai.edgegrid</groupId>
+            <artifactId>edgegrid-signer-core</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-configuration2</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.hamcrest</groupId>
+            <artifactId>hamcrest-all</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.testng</groupId>
+            <artifactId>testng</artifactId>
+        </dependency>
+    </dependencies>
+
+</project>