1073: (#1218)

- Updated default serialization config to include href scalars by default (previously omitted).
- Ensured our referenced Spring version is 4.3.5 since Spring Security and Spring Boot both reference that version.  This was causing runtime conflicts in example applications.

Author: lhazlewood

docs/source/forwarded-request.rst

@@ -164,13 +164,8 @@ properties.  This is the default configuration in effect if you don't specify an
            value:
              strategy: scalars
              fields:
-               href:
-                 enabled: false
                customData:
                  strategy: scalars
-                 fields:
-                   href:
-                     enabled: false
                groups:
                  strategy: defined
                  elements:
@@ -188,23 +183,18 @@ So what does this mean?  You can summarize this in English as the following:
 
    - all of the account's `scalar`_ (i.e. non object/collection) fields to be included, each as a JSON name/value pair.
 
-   - However, I want specific overriding rules for the ``href``, ``customData`` and ``groups`` fields.  For these:
-
-     - don't include the account's ``href`` field.  My origin server(s) behind the gateway probably won't talk
-       directly with Stormpath and won't know what to do with that url, so exclude it
+   - However, I want specific overriding rules for the ``customData`` and ``groups`` fields.  For these:
 
      - ``customData`` isn't a scalar, but I want it included anyway, so I'm going to define conversion rules for it
-       too.  Those are:
+       too.  That is :
 
        - Include any of the customData's scalar properties automatically
 
-       - However, don't include the customData's ``href``, since my origin server(s) won't know what to do with it.
-
      - ``groups`` isn't a scalar (it's a ``GroupsCollection`` object), but I want it included anyway.
 
        - However, in this case I want to include *only* fields that are explicitly *defined* in its ``fields``
          list.  (In this case, even though the strategy is ``defined``, no actual ``fields`` have been specified.
-         This means that *no* fields on the ``GroupsCollection`` object itself, like 'size' and 'limit' will be
+         This means that *no* fields on the ``GroupsCollection`` object itself, like 'href', 'size' and 'limit' will be
          included.  We just want the collection's elements, described next.)
 
        - The collection ``elements`` are enabled so I do want the elements in the collection.
@@ -221,6 +211,7 @@ bytes transmitted over the network, the actual value won't be pretty-printed):
 .. code-block:: json
 
    {
+     "href": "https://api.stormpath.com/v1/accounts/753veZGE2aIy64VnTrF5Ov",
      "username": "tk421",
      "email": "tk421@galacticempire.com",
      "givenName": "TK421",
@@ -233,20 +224,23 @@ bytes transmitted over the network, the actual value won't be pretty-printed):
      "passwordModifiedAt": "2016-12-15T19:58:55.000Z",
      "emailVerificationToken": null,
      "customData": {
+       "href": "https://api.stormpath.com/v1/accounts/753veZGE2aIy64VnTrF5Ov/customData",
        "createdAt": "2016-12-15T19:58:55.272Z",
        "modifiedAt":"2016-12-15T19:59:23.729Z",
        "favoriteColor": "Blaster Black"
      },
      "groups": {
        "items": [
          {
+           "href": "https://api.stormpath.com/v1/groups/4NQzRKj0qDq1wIg9M0jUfa",
            "name": "dsguards",
            "description": "Death Star Guards",
            "status": "ENABLED",
            "createdAt": "2016-12-28T00:34:46.453Z",
            "modifiedAt":"2016-12-28T00:34:46.453Z"
          },
          {
+           "href": "https://api.stormpath.com/v1/groups/9fBEMQtvElx2Zn7a0ku1Dj",
            "name": "troopers",
            "description": "All stormtroopers",
            "status": "ENABLED",
@@ -398,6 +392,23 @@ The ``enabled`` conversion property indicates if the field will be included in t
 the value is ``false``, that field will not be included at all in the output sent to the origin server.  The default
 value is ``true``.
 
+For example, the following config indicates that, although the general strategy is to include the user account's
+scalar fields, the ``href`` field is excluded/omitted from the output JSON entirely:
+
+.. code-block:: yaml
+   :emphasize-lines: 8-9
+
+   stormpath:
+     zuul:
+       account:
+         header:
+           value:
+             strategy: scalars
+             fields:
+               href:
+                 enabled: false
+
+
 .. _object conversion field:
 
 ``field``

examples/zuul-spring-cloud-starter/pom.xml

@@ -34,13 +34,7 @@
     <packaging>jar</packaging>
 
     <properties>
-        <jdk.version>1.7</jdk.version>
-        <jstl.version>1.2</jstl.version>
-        <logback.version>1.1.7</logback.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <servlet.version>3.1.0</servlet.version>
-        <slf4j.version>1.7.21</slf4j.version>
-        <spring.version>4.3.2.RELEASE</spring.version>
     </properties>
 
     <dependencies>

extensions/servlet/src/main/java/com/stormpath/sdk/convert/ResourceConverter.java

@@ -46,9 +46,9 @@ public class ResourceConverter<T> implements Function<T, Object> {
     private static final Logger log = LoggerFactory.getLogger(ResourceConverter.class);
 
     public static final Conversion DEFAULT_CONFIG = Conversions
-        .withField("href", Conversions.disabled())
-        .withField("customData", Conversions.withField("href", Conversions.disabled()))
-        .withField("groups", Conversions.withStrategy(ConversionStrategyName.DEFINED).setElements(Conversions.each(Conversions.withField("href", Conversions.disabled()))));
+        //.withField("href", Conversions.disabled())
+        .withField("customData", Conversions.withStrategy(ConversionStrategyName.SCALARS))
+        .withField("groups", Conversions.withStrategy(ConversionStrategyName.DEFINED).setElements(Conversions.each(new Conversion())));
 
     private Conversion config;
 

extensions/servlet/src/test/groovy/com/stormpath/sdk/convert/ResourceConverterTest.groovy

@@ -616,11 +616,13 @@ class ResourceConverterTest {
 
         def result = fn.apply(account)
 
-        assertEquals result.size(), props.size() - 1 // no href
+        assertEquals result.size(), props.size()
+        assertEquals result.href, 'https://example.io/users/1'
         assertEquals result.username, props.username
         assertEquals result.email, props.email
 
-        assertEquals result.customData.size(), cd.size() - 1 // no href
+        assertEquals result.customData.size(), cd.size()
+        assertEquals result.customData.href, 'https://example.io/users/1/customData'
         assertTrue result.customData.containsKey('createdAt')
         assertTrue result.customData.containsKey('modifiedAt')
 
@@ -629,15 +631,18 @@ class ResourceConverterTest {
         def i = result.groups.items.iterator()
 
         def g = i.next()
-        assertEquals g.size(), 1 //no href by default
+        assertEquals g.size(), 2
+        assertEquals g.href, 'https://example.io/groups/1'
         assertEquals g.name, 'foo'
 
         g = i.next()
-        assertEquals g.size(), 1 //no href by default
+        assertEquals g.size(), 2
+        assertEquals g.href, 'https://example.io/groups/2'
         assertEquals g.name, 'bar'
 
         g = i.next()
-        assertEquals g.size(), 1 //no href by default
+        assertEquals g.size(), 2
+        assertEquals g.href, 'https://example.io/groups/3'
         assertEquals g.name, 'baz'
     }
 

pom.xml

@@ -88,6 +88,7 @@
 
     <properties>
         <jdk.version>1.7</jdk.version>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <slf4j.version>1.7.21</slf4j.version>
         <bouncycastle.version>1.56</bouncycastle.version>
         <hazelcast.version>3.6.4</hazelcast.version>
@@ -100,10 +101,10 @@
         <maven-enforcer-plugin.version>1.4.1</maven-enforcer-plugin.version>
         <snakeyaml.version>1.17</snakeyaml.version>
         <servlet.version>3.1.0</servlet.version>
-        <spring.version>4.3.2.RELEASE</spring.version>
+        <spring.version>4.3.5.RELEASE</spring.version>
         <spring.boot.version>1.4.3.RELEASE</spring.boot.version>
         <spring.cloud.netflix.version>1.1.5.RELEASE</spring.cloud.netflix.version>
-        <spring.security.version>4.2.0.RELEASE</spring.security.version>
+        <spring.security.version>4.2.1.RELEASE</spring.security.version>
         <zuul.version>1.2.2</zuul.version>
 
         <!-- Test Dependencies: Only required for testing when building the SDK.  Not required by SDK users at runtime: -->