Gson: support raw string as json response fix jooby-project#1269

jknack · jknack · commit ff3e15f794ab · 2019-01-20T12:42:03.000-03:00
diff --git a/modules/jooby-gson/src/main/java/org/jooby/json/GsonRawRenderer.java b/modules/jooby-gson/src/main/java/org/jooby/json/GsonRawRenderer.java
@@ -0,0 +1,222 @@
+/**
+ *                                  Apache License
+ *                            Version 2.0, January 2004
+ *                         http://www.apache.org/licenses/
+ *
+ *    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+ *
+ *    1. Definitions.
+ *
+ *       "License" shall mean the terms and conditions for use, reproduction,
+ *       and distribution as defined by Sections 1 through 9 of this document.
+ *
+ *       "Licensor" shall mean the copyright owner or entity authorized by
+ *       the copyright owner that is granting the License.
+ *
+ *       "Legal Entity" shall mean the union of the acting entity and all
+ *       other entities that control, are controlled by, or are under common
+ *       control with that entity. For the purposes of this definition,
+ *       "control" means (i) the power, direct or indirect, to cause the
+ *       direction or management of such entity, whether by contract or
+ *       otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ *       outstanding shares, or (iii) beneficial ownership of such entity.
+ *
+ *       "You" (or "Your") shall mean an individual or Legal Entity
+ *       exercising permissions granted by this License.
+ *
+ *       "Source" form shall mean the preferred form for making modifications,
+ *       including but not limited to software source code, documentation
+ *       source, and configuration files.
+ *
+ *       "Object" form shall mean any form resulting from mechanical
+ *       transformation or translation of a Source form, including but
+ *       not limited to compiled object code, generated documentation,
+ *       and conversions to other media types.
+ *
+ *       "Work" shall mean the work of authorship, whether in Source or
+ *       Object form, made available under the License, as indicated by a
+ *       copyright notice that is included in or attached to the work
+ *       (an example is provided in the Appendix below).
+ *
+ *       "Derivative Works" shall mean any work, whether in Source or Object
+ *       form, that is based on (or derived from) the Work and for which the
+ *       editorial revisions, annotations, elaborations, or other modifications
+ *       represent, as a whole, an original work of authorship. For the purposes
+ *       of this License, Derivative Works shall not include works that remain
+ *       separable from, or merely link (or bind by name) to the interfaces of,
+ *       the Work and Derivative Works thereof.
+ *
+ *       "Contribution" shall mean any work of authorship, including
+ *       the original version of the Work and any modifications or additions
+ *       to that Work or Derivative Works thereof, that is intentionally
+ *       submitted to Licensor for inclusion in the Work by the copyright owner
+ *       or by an individual or Legal Entity authorized to submit on behalf of
+ *       the copyright owner. For the purposes of this definition, "submitted"
+ *       means any form of electronic, verbal, or written communication sent
+ *       to the Licensor or its representatives, including but not limited to
+ *       communication on electronic mailing lists, source code control systems,
+ *       and issue tracking systems that are managed by, or on behalf of, the
+ *       Licensor for the purpose of discussing and improving the Work, but
+ *       excluding communication that is conspicuously marked or otherwise
+ *       designated in writing by the copyright owner as "Not a Contribution."
+ *
+ *       "Contributor" shall mean Licensor and any individual or Legal Entity
+ *       on behalf of whom a Contribution has been received by Licensor and
+ *       subsequently incorporated within the Work.
+ *
+ *    2. Grant of Copyright License. Subject to the terms and conditions of
+ *       this License, each Contributor hereby grants to You a perpetual,
+ *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ *       copyright license to reproduce, prepare Derivative Works of,
+ *       publicly display, publicly perform, sublicense, and distribute the
+ *       Work and such Derivative Works in Source or Object form.
+ *
+ *    3. Grant of Patent License. Subject to the terms and conditions of
+ *       this License, each Contributor hereby grants to You a perpetual,
+ *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ *       (except as stated in this section) patent license to make, have made,
+ *       use, offer to sell, sell, import, and otherwise transfer the Work,
+ *       where such license applies only to those patent claims licensable
+ *       by such Contributor that are necessarily infringed by their
+ *       Contribution(s) alone or by combination of their Contribution(s)
+ *       with the Work to which such Contribution(s) was submitted. If You
+ *       institute patent litigation against any entity (including a
+ *       cross-claim or counterclaim in a lawsuit) alleging that the Work
+ *       or a Contribution incorporated within the Work constitutes direct
+ *       or contributory patent infringement, then any patent licenses
+ *       granted to You under this License for that Work shall terminate
+ *       as of the date such litigation is filed.
+ *
+ *    4. Redistribution. You may reproduce and distribute copies of the
+ *       Work or Derivative Works thereof in any medium, with or without
+ *       modifications, and in Source or Object form, provided that You
+ *       meet the following conditions:
+ *
+ *       (a) You must give any other recipients of the Work or
+ *           Derivative Works a copy of this License; and
+ *
+ *       (b) You must cause any modified files to carry prominent notices
+ *           stating that You changed the files; and
+ *
+ *       (c) You must retain, in the Source form of any Derivative Works
+ *           that You distribute, all copyright, patent, trademark, and
+ *           attribution notices from the Source form of the Work,
+ *           excluding those notices that do not pertain to any part of
+ *           the Derivative Works; and
+ *
+ *       (d) If the Work includes a "NOTICE" text file as part of its
+ *           distribution, then any Derivative Works that You distribute must
+ *           include a readable copy of the attribution notices contained
+ *           within such NOTICE file, excluding those notices that do not
+ *           pertain to any part of the Derivative Works, in at least one
+ *           of the following places: within a NOTICE text file distributed
+ *           as part of the Derivative Works; within the Source form or
+ *           documentation, if provided along with the Derivative Works; or,
+ *           within a display generated by the Derivative Works, if and
+ *           wherever such third-party notices normally appear. The contents
+ *           of the NOTICE file are for informational purposes only and
+ *           do not modify the License. You may add Your own attribution
+ *           notices within Derivative Works that You distribute, alongside
+ *           or as an addendum to the NOTICE text from the Work, provided
+ *           that such additional attribution notices cannot be construed
+ *           as modifying the License.
+ *
+ *       You may add Your own copyright statement to Your modifications and
+ *       may provide additional or different license terms and conditions
+ *       for use, reproduction, or distribution of Your modifications, or
+ *       for any such Derivative Works as a whole, provided Your use,
+ *       reproduction, and distribution of the Work otherwise complies with
+ *       the conditions stated in this License.
+ *
+ *    5. Submission of Contributions. Unless You explicitly state otherwise,
+ *       any Contribution intentionally submitted for inclusion in the Work
+ *       by You to the Licensor shall be under the terms and conditions of
+ *       this License, without any additional terms or conditions.
+ *       Notwithstanding the above, nothing herein shall supersede or modify
+ *       the terms of any separate license agreement you may have executed
+ *       with Licensor regarding such Contributions.
+ *
+ *    6. Trademarks. This License does not grant permission to use the trade
+ *       names, trademarks, service marks, or product names of the Licensor,
+ *       except as required for reasonable and customary use in describing the
+ *       origin of the Work and reproducing the content of the NOTICE file.
+ *
+ *    7. Disclaimer of Warranty. Unless required by applicable law or
+ *       agreed to in writing, Licensor provides the Work (and each
+ *       Contributor provides its Contributions) on an "AS IS" BASIS,
+ *       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ *       implied, including, without limitation, any warranties or conditions
+ *       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ *       PARTICULAR PURPOSE. You are solely responsible for determining the
+ *       appropriateness of using or redistributing the Work and assume any
+ *       risks associated with Your exercise of permissions under this License.
+ *
+ *    8. Limitation of Liability. In no event and under no legal theory,
+ *       whether in tort (including negligence), contract, or otherwise,
+ *       unless required by applicable law (such as deliberate and grossly
+ *       negligent acts) or agreed to in writing, shall any Contributor be
+ *       liable to You for damages, including any direct, indirect, special,
+ *       incidental, or consequential damages of any character arising as a
+ *       result of this License or out of the use or inability to use the
+ *       Work (including but not limited to damages for loss of goodwill,
+ *       work stoppage, computer failure or malfunction, or any and all
+ *       other commercial damages or losses), even if such Contributor
+ *       has been advised of the possibility of such damages.
+ *
+ *    9. Accepting Warranty or Additional Liability. While redistributing
+ *       the Work or Derivative Works thereof, You may choose to offer,
+ *       and charge a fee for, acceptance of support, warranty, indemnity,
+ *       or other liability obligations and/or rights consistent with this
+ *       License. However, in accepting such obligations, You may act only
+ *       on Your own behalf and on Your sole responsibility, not on behalf
+ *       of any other Contributor, and only if You agree to indemnify,
+ *       defend, and hold each Contributor harmless for any liability
+ *       incurred by, or claims asserted against, such Contributor by reason
+ *       of your accepting any such warranty or additional liability.
+ *
+ *    END OF TERMS AND CONDITIONS
+ *
+ *    APPENDIX: How to apply the Apache License to your work.
+ *
+ *       To apply the Apache License to your work, attach the following
+ *       boilerplate notice, with the fields enclosed by brackets "{}"
+ *       replaced with your own identifying information. (Don't include
+ *       the brackets!)  The text should be enclosed in the appropriate
+ *       comment syntax for the file format. We also recommend that a
+ *       file or class name and description of purpose be included on the
+ *       same "printed page" as the copyright notice for easier
+ *       identification within third-party archives.
+ *
+ *    Copyright 2014 Edgar Espina
+ *
+ *    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 org.jooby.json;
+
+import com.google.gson.Gson;
+import org.jooby.MediaType;
+
+class GsonRawRenderer extends GsonRenderer {
+
+  public GsonRawRenderer(MediaType type, Gson gson) {
+    super(type, gson);
+  }
+
+  @Override public void render(Object value, Context ctx) throws Exception {
+    if (value instanceof CharSequence) {
+      ctx.type(type).send(value.toString());
+    } else {
+      super.render(value, ctx);
+    }
+  }
+}
diff --git a/modules/jooby-gson/src/main/java/org/jooby/json/GsonRenderer.java b/modules/jooby-gson/src/main/java/org/jooby/json/GsonRenderer.java
@@ -212,7 +212,7 @@
 
 class GsonRenderer implements Renderer {
 
-  private final MediaType type;
+  protected final MediaType type;
 
   private final Gson gson;
 
diff --git a/modules/jooby-gson/src/main/java/org/jooby/json/Gzon.java b/modules/jooby-gson/src/main/java/org/jooby/json/Gzon.java
@@ -278,6 +278,8 @@ public class Gzon implements Jooby.Module {
 
   private BiConsumer<GsonBuilder, Config> configurer;
 
+  private boolean raw;
+
   /**
    * Creates a new {@link Gson}.
    *
@@ -351,8 +353,27 @@ public void configure(final Env env, final Config config, final Binder binder) {
     Multibinder.newSetBinder(binder, Parser.class).addBinding()
         .toInstance(new GsonParser(type, gson));
 
-    Multibinder.newSetBinder(binder, Renderer.class).addBinding()
-        .toInstance(new GsonRenderer(type, gson));
+    GsonRenderer renderer = raw ? new GsonRawRenderer(type, gson) : new GsonRenderer(type, gson);
+
+    Multibinder.newSetBinder(binder, Renderer.class).addBinding().toInstance(renderer);
+  }
+
+  /**
+   * Add support raw string json responses:
+   *
+   * <pre>{@code
+   * {
+   *   get("/raw", () -> {
+   *     return "{\"raw\": \"json\"}";
+   *   });
+   * }
+   * }</pre>
+   *
+   * @return This module.
+   */
+  public Gzon raw() {
+    raw = true;
+    return this;
   }
 
 }
diff --git a/modules/jooby-gson/src/test/java/org/jooby/json/GsonRendererTest.java b/modules/jooby-gson/src/test/java/org/jooby/json/GsonRendererTest.java
@@ -39,6 +39,43 @@ public void render() throws Exception {
         });
   }
 
+  @Test
+  public void rawWithCharSequence() throws Exception {
+    String value = "{\"foo\":\"bar\"}";
+    new MockUnit(Gson.class, Renderer.Context.class)
+        .expect(unit -> {
+          Context ctx = unit.get(Renderer.Context.class);
+          expect(ctx.type(MediaType.json)).andReturn(ctx);
+          ctx.send(value);
+        })
+        .run(unit -> {
+          new GsonRawRenderer(MediaType.json, unit.get(Gson.class))
+              .render(value, unit.get(Renderer.Context.class));
+        }, unit -> {
+        });
+  }
+
+  @Test
+  public void rawWithObject() throws Exception {
+    Object value = new GsonRendererTest();
+    new MockUnit(Gson.class, Renderer.Context.class)
+        .expect(unit -> {
+          Context ctx = unit.get(Renderer.Context.class);
+          expect(ctx.accepts(MediaType.json)).andReturn(true);
+          expect(ctx.type(MediaType.json)).andReturn(ctx);
+          ctx.send("{}");
+        })
+        .expect(unit -> {
+          Gson gson = unit.get(Gson.class);
+          expect(gson.toJson(value)).andReturn("{}");
+        })
+        .run(unit -> {
+          new GsonRawRenderer(MediaType.json, unit.get(Gson.class))
+              .render(value, unit.get(Renderer.Context.class));
+        }, unit -> {
+        });
+  }
+
   @Test
   public void renderSkip() throws Exception {
     Object value = new GsonRendererTest();
diff --git a/modules/jooby-gson/src/test/java/org/jooby/json/GzonTest.java b/modules/jooby-gson/src/test/java/org/jooby/json/GzonTest.java
@@ -70,6 +70,17 @@ public void defaults() throws Exception {
         });
   }
 
+  @Test
+  public void raw() throws Exception {
+    new MockUnit(Env.class, Config.class, Binder.class, Gson.class)
+        .expect(body)
+        .run(unit -> {
+          new Gzon()
+              .raw()
+              .configure(unit.get(Env.class), unit.get(Config.class), unit.get(Binder.class));
+        });
+  }
+
   @SuppressWarnings("unchecked")
   @Test
   public void withCallback() throws Exception {
diff --git a/modules/jooby-jackson/src/main/java/org/jooby/json/JacksonRawRenderer.java b/modules/jooby-jackson/src/main/java/org/jooby/json/JacksonRawRenderer.java
@@ -216,7 +216,7 @@ public JacksonRawRenderer(final ObjectMapper mapper, final MediaType type) {
   @Override
   protected void renderValue(final Object value, final Renderer.Context ctx) throws Exception {
     if (value instanceof CharSequence) {
-      ctx.send(value.toString());
+      ctx.type(type).send(value.toString());
     } else {
       super.renderValue(value, ctx);
     }

Original file line number	Diff line number	Diff line change
`@@ -216,7 +216,7 @@ public JacksonRawRenderer(final ObjectMapper mapper, final MediaType type) {`
`216`	`216`	`@Override`
`217`	`217`	`protected void renderValue(final Object value, final Renderer.Context ctx) throws Exception {`
`218`	`218`	`if (value instanceof CharSequence) {`
`219`		`- ctx.send(value.toString());`
	`219`	`+ ctx.type(type).send(value.toString());`
`220`	`220`	`} else {`
`221`	`221`	`super.renderValue(value, ctx);`
`222`	`222`	`}`