Moved SaxDecoder into feign-sax dependency.

adriancole · adriancole · commit 2597d3baf325 · 2013-09-16T20:13:52.000-07:00
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,9 +1,10 @@
 ### Version 5.0
 * Remove support for Observable methods.
-* SaxDecoder now decodes multiple types.
-* Remove pattern decoders in favor of SaxDecoder.
 * Use single non-generic Decoder/Encoder instead of sets of type-specific Decoders/Encoders.
 * Decoders/Encoders are now more flexible, having access to the Response/RequestTemplate respectively.
+* Moved SaxDecoder into `feign-sax` dependency.
+  * SaxDecoder now decodes multiple types.
+  * Remove pattern decoders in favor of SaxDecoder.
 * Added Feign.Builder to simplify client customizations without using Dagger.
 * Gson type adapters can be registered as Dagger set bindings.
 * `Feign.create(...)` now requires specifying an encoder and decoder.
diff --git a/README.md b/README.md
@@ -78,20 +78,24 @@ For example, the following pattern might decorate each request with the current
 CloudDNS cloudDNS = Feign.builder().target(new CloudIdentityTarget<CloudDNS>(user, apiKey));
 ```
 
-You can find [several examples](https://github.com/Netflix/feign/tree/master/feign-core/src/test/java/feign/examples) in the test tree.  Do take time to look at them, as seeing is believing!
+You can find [several examples](https://github.com/Netflix/feign/tree/master/core/src/test/java/feign/examples) in the test tree.  Do take time to look at them, as seeing is believing!
 
 ### Integrations
 Feign intends to work well within Netflix and other Open Source communities.  Modules are welcome to integrate with your favorite projects!
+
 ### Gson
-[GsonModule](https://github.com/Netflix/feign/tree/master/feign-gson) adds default encoders and decoders so you get get started with a JSON api.
+[GsonModule](https://github.com/Netflix/feign/tree/master/gson) adds default encoders and decoders so you get get started with a JSON api.
 
 Integration requires you pass `new GsonModule()` to `Feign.create()`, or add it to your graph with Dagger:
 ```java
 GitHub github = Feign.create(GitHub.class, "https://api.github.com", new GsonModule());
 ```
 
+### Sax
+[SaxDecoder](https://github.com/Netflix/feign/tree/master/sax) allows you to decode XML in a way that is compatible with normal JVM and also Android environments.
+
 ### JAX-RS
-[JAXRSModule](https://github.com/Netflix/feign/tree/master/feign-jaxrs) overrides annotation processing to instead use standard ones supplied by the JAX-RS specification.  This is currently targeted at the 1.1 spec.
+[JAXRSModule](https://github.com/Netflix/feign/tree/master/jaxrs) overrides annotation processing to instead use standard ones supplied by the JAX-RS specification.  This is currently targeted at the 1.1 spec.
 
 Here's the example above re-written to use JAX-RS:
 ```java
@@ -101,7 +105,7 @@ interface GitHub {
 }
 ```
 ### Ribbon
-[RibbonModule](https://github.com/Netflix/feign/tree/master/feign-ribbon) overrides URL resolution of Feign's client, adding smart routing and resiliency capabilities provided by [Ribbon](https://github.com/Netflix/ribbon).
+[RibbonModule](https://github.com/Netflix/feign/tree/master/ribbon) overrides URL resolution of Feign's client, adding smart routing and resiliency capabilities provided by [Ribbon](https://github.com/Netflix/ribbon).
 
 Integration requires you to pass your ribbon client name as the host part of the url, for example `myAppProd`.
 ```java
diff --git a/build.gradle b/build.gradle
@@ -45,6 +45,20 @@ project(':feign-core') {
     }
 }
 
+project(':feign-sax') {
+    apply plugin: 'java'
+
+    test {
+        useTestNG()
+    }
+
+    dependencies {
+        compile     project(':feign-core')
+        testCompile 'com.google.guava:guava:14.0.1'
+        testCompile 'org.testng:testng:6.8.5'
+    }
+}
+
 project(':feign-gson') {
     apply plugin: 'java'
 
diff --git a/sax/README.md b/sax/README.md
@@ -0,0 +1,24 @@
+Sax Decoder
+===================
+
+This module adds support for decoding xml via SAX.
+
+Add this to your object graph like so:
+
+```java
+IAM iam = Feign.create(IAM.class, "https://iam.amazonaws.com", new DecodeWithSax());
+
+--snip--
+@Module(addsTo = Feign.Defaults.class)
+static class DecodeWithSax {
+  @Provides Decoder saxDecoder(Provider<UserIdHandler> userIdHandler) {
+    return SAXDecoder.builder() //
+        .addContentHandler(userIdHandler) //
+        .build();
+  }
+
+  @Provides Encoder defaultEncoder() {
+    return new Encoder.Default();
+  }
+}
+```
diff --git a/sax/src/main/java/feign/sax/SAXDecoder.java b/sax/src/main/java/feign/sax/SAXDecoder.java
@@ -13,9 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package feign.codec;
+package feign.sax;
 
 import feign.Response;
+import feign.codec.Decoder;
+import feign.codec.DecodeException;
 import org.xml.sax.ContentHandler;
 import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
@@ -90,7 +92,7 @@ private SAXDecoder(Map<Type, Provider<? extends ContentHandlerWithResult<?>>> ha
 
   @Override
   public Object decode(Response response, Type type) throws IOException, DecodeException {
-    if (response.body() == null) {
+    if (void.class.equals(type) || response.body() == null) {
       return null;
     }
     Provider<? extends ContentHandlerWithResult<?>> handlerProvider = handlerProviders.get(type);
diff --git a/sax/src/test/java/feign/sax/SAXDecoderTest.java b/sax/src/test/java/feign/sax/SAXDecoderTest.java
@@ -13,10 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package feign.codec;
+package feign.sax;
 
 import dagger.ObjectGraph;
 import dagger.Provides;
+import feign.codec.Decoder;
+import feign.codec.DecodeException;
 import feign.Response;
 import org.testng.annotations.BeforeClass;
 import org.testng.annotations.Test;
@@ -135,4 +137,14 @@ public void characters(char ch[], int start, int length) {
       currentText.append(ch, start, length);
     }
   }
+
+  @Test public void voidDecodesToNull() throws Exception {
+    Response response = Response.create(200, "OK", Collections.<String, Collection<String>>emptyMap(), statusFailed);
+    assertEquals(decoder.decode(response, void.class), null);
+  }
+
+  @Test public void nullBodyDecodesToNull() throws Exception {
+    Response response = Response.create(204, "OK", Collections.<String, Collection<String>>emptyMap(), null);
+    assertEquals(decoder.decode(response, String.class), null);
+  }
 }
diff --git a/sax/src/test/java/feign/sax/examples/AWSSignatureVersion4.java b/sax/src/test/java/feign/sax/examples/AWSSignatureVersion4.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package feign.examples;
+package feign.sax.examples;
 
 import com.google.common.base.Function;
 import com.google.common.base.Joiner;
diff --git a/sax/src/test/java/feign/sax/examples/IAMExample.java b/sax/src/test/java/feign/sax/examples/IAMExample.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package feign.examples;
+package feign.sax.examples;
 
 import dagger.Module;
 import dagger.Provides;
@@ -23,14 +23,13 @@
 import feign.RequestTemplate;
 import feign.Target;
 import feign.codec.Decoder;
-import feign.codec.SAXDecoder;
+import feign.codec.Encoder;
+import feign.sax.SAXDecoder;
 import org.xml.sax.helpers.DefaultHandler;
 
 import javax.inject.Inject;
 import javax.inject.Provider;
 
-import static dagger.Provides.Type.SET;
-
 public class IAMExample {
 
   interface IAM {
@@ -66,13 +65,17 @@ private IAMTarget(String accessKey, String secretKey) {
     }
   }
 
-  @Module(library = true)
+  @Module(addsTo = Feign.Defaults.class)
   static class DecodeWithSax {
-    @Provides(type = SET) Decoder saxDecoder(Provider<UserIdHandler> userIdHandler) {
+    @Provides Decoder saxDecoder(Provider<UserIdHandler> userIdHandler) {
       return SAXDecoder.builder() //
           .addContentHandler(userIdHandler) //
           .build();
     }
+
+    @Provides Encoder defaultEncoder() {
+      return new Encoder.Default();
+    }
   }
 
   static class UserIdHandler extends DefaultHandler implements
diff --git a/settings.gradle b/settings.gradle
@@ -1,5 +1,5 @@
 rootProject.name='feign'
-include 'core', 'gson', 'jaxrs', 'ribbon', 'example-github', 'example-wikipedia'
+include 'core', 'sax', 'gson', 'jaxrs', 'ribbon', 'example-github', 'example-wikipedia'
 
 rootProject.children.each { childProject ->
     childProject.name = 'feign-' + childProject.name
