Changeset 41126

Timestamp:

07/24/2017 08:45:23 PM (7 years ago)

Author:

westonruter

Message:

WP-API JS Client: Interpret Settings resource as a model.

The REST API does not provide a mechanism to distinguish between endpoints representing models and those representing collections, so the Backbone client must make that distinction internally. Previously wp-api.js accounted for /users/me, but not for /settings. This patch updates the logic so that /settings is properly registered as a Backbone model.

When calling wp.api.init, additional endpoints can be specified to be models using the modelEndpoints argument.

Merges [41112] onto 4.8 branch.
Props adamsilverstein, kadamwhite.
Fixes #41056 for 4.8.1.

Location:

branches/4.8

Files:

• . (modified) (1 prop)
• src/wp-includes/js/wp-api.js (modified) (3 diffs)
• tests/qunit/fixtures/wp-api.js (modified) (1 diff)
• tests/qunit/wp-includes/js/wp-api.js (modified) (2 diffs)

branches/4.8/src/wp-includes/js/wp-api.js

@@ -1113 +1113 @@
                     'PostsTags':       'PostTags'
                 }
-            };
+            },
+
+            modelEndpoints = routeModel.get( 'modelEndpoints' ),
+            modelRegex     = new RegExp( '(?:.*[+)]|\/(' + modelEndpoints.join( '|' ) + '))$' );
 
             /**
@@ -1138 +1141 @@
                 ) {
 
-                    // Single items end with a regex (or the special case 'me').
-                    if ( /(?:.*[+)]|\/me)$/.test( index ) ) {
+                    // Single items end with a regex, or a special case word.
+                    if ( modelRegex.test( index ) ) {
                         modelRoutes.push( { index: index, route: route } );
                     } else {
@@ -1361 +1364 @@
         var endpoint, attributes = {}, deferred, promise;
 
-        args                     = args || {};
-        attributes.apiRoot       = args.apiRoot || wpApiSettings.root || '/wp-json';
-        attributes.versionString = args.versionString || wpApiSettings.versionString || 'wp/v2/';
-        attributes.schema        = args.schema || null;
+        args                      = args || {};
+        attributes.apiRoot        = args.apiRoot || wpApiSettings.root || '/wp-json';
+        attributes.versionString  = args.versionString || wpApiSettings.versionString || 'wp/v2/';
+        attributes.schema         = args.schema || null;
+        attributes.modelEndpoints = args.modelEndpoints || [ 'me', 'settings' ];
         if ( ! attributes.schema && attributes.apiRoot === wpApiSettings.root && attributes.versionString === wpApiSettings.versionString ) {
             attributes.schema = wpApiSettings.schema;

branches/4.8/tests/qunit/fixtures/wp-api.js

@@ -25 +25 @@
     'wp-json/wp/v2/status': mockedApiResponse.StatusModel,
     'wp-json/wp/v2/type': mockedApiResponse.TypeModel,
-    'wp-json/js-widgets/v1/': jsWidgetsEndpointSchema
+    'wp-json/js-widgets/v1/': jsWidgetsEndpointSchema,
+    'wp-json/wp/v2/users/me': mockedApiResponse.me,
+    'wp-json/wp/v2/settings': mockedApiResponse.settings
 };
 

branches/4.8/tests/qunit/wp-includes/js/wp-api.js

@@ -116 +116 @@
         'Post',
         'Tag',
-        'User'
+        'User',
+        'UsersMe',
+        'Settings'
     ];
 
@@ -131 +133 @@
                 theModel.fetch().done( function(  ) {
                     var theModel2 = new wp.api.models[ className ]();
-                    theModel2.set( 'id', theModel.attributes[0].id );
+                    theModel2.set( 'id', theModel.attributes.id );
                     theModel2.fetch().done( function() {
 
                         // We were able to retrieve the model.
                         assert.equal(
-                            theModel.attributes[0].id,
+                            theModel.attributes.id,
                             theModel2.get( 'id' ) ,
                             'We should be able to get a ' + className