sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

Browse Source 
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.

Props @adamsilverstein.
Fixes #41056.


git-svn-id: https://develop.svn.wordpress.org/trunk@41112 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
K. Adam White 2017-07-20 20:25:28 +00:00
parent c66c90a438
commit 79bbfd19c9
3 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/wp-includes/js/wp-api.js
View File

@ -1112,7 +1112,10 @@
'PostsRevisions': 'PostRevisions', 'PostsRevisions': 'PostRevisions',
'PostsTags': 'PostTags' 'PostsTags': 'PostTags'
} }
}; },
modelEndpoints = routeModel.get( 'modelEndpoints' ),
modelRegex = new RegExp( '(?:.*[+)]|\/(' + modelEndpoints.join( '|' ) + '))$' );
/** /**
* Iterate thru the routes, picking up models and collections to build. Builds two arrays, * Iterate thru the routes, picking up models and collections to build. Builds two arrays,
@ -1137,8 +1140,8 @@
index !== ( '/' + routeModel.get( 'versionString' ).slice( 0, -1 ) ) index !== ( '/' + routeModel.get( 'versionString' ).slice( 0, -1 ) )
) { ) {
// Single items end with a regex (or the special case 'me'). // Single items end with a regex, or a special case word.
if ( /(?:.*[+)]|\/me)$/.test( index ) ) { if ( modelRegex.test( index ) ) {
modelRoutes.push( { index: index, route: route } ); modelRoutes.push( { index: index, route: route } );
} else { } else {
@ -1364,6 +1367,7 @@
attributes.apiRoot = args.apiRoot || wpApiSettings.root || '/wp-json'; attributes.apiRoot = args.apiRoot || wpApiSettings.root || '/wp-json';
attributes.versionString = args.versionString || wpApiSettings.versionString || 'wp/v2/'; attributes.versionString = args.versionString || wpApiSettings.versionString || 'wp/v2/';
attributes.schema = args.schema || null; attributes.schema = args.schema || null;
attributes.modelEndpoints = args.modelEndpoints || [ 'me', 'settings' ];
if ( ! attributes.schema && attributes.apiRoot === wpApiSettings.root && attributes.versionString === wpApiSettings.versionString ) { if ( ! attributes.schema && attributes.apiRoot === wpApiSettings.root && attributes.versionString === wpApiSettings.versionString ) {
attributes.schema = wpApiSettings.schema; attributes.schema = wpApiSettings.schema;
} }

4
tests/qunit/fixtures/wp-api.js
View File

@ -24,7 +24,9 @@ var pathToData = {
'wp-json/wp/v2/taxonomy': mockedApiResponse.TaxonomyModel, 'wp-json/wp/v2/taxonomy': mockedApiResponse.TaxonomyModel,
'wp-json/wp/v2/status': mockedApiResponse.StatusModel, 'wp-json/wp/v2/status': mockedApiResponse.StatusModel,
'wp-json/wp/v2/type': mockedApiResponse.TypeModel, '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
}; };
/** /**

8
tests/qunit/wp-includes/js/wp-api.js
View File

@ -115,7 +115,9 @@
'Page', 'Page',
'Post', 'Post',
'Tag', 'Tag',
'User' 'User',
'UsersMe',
'Settings'
]; ];
_.each( modelsWithIdsClassNames, function( className ) { _.each( modelsWithIdsClassNames, function( className ) {
@ -130,12 +132,12 @@
assert.ok( theModel, 'We can instantiate wp.api.models.' + className ); assert.ok( theModel, 'We can instantiate wp.api.models.' + className );
theModel.fetch().done( function( ) { theModel.fetch().done( function( ) {
var theModel2 = new wp.api.models[ className ](); var theModel2 = new wp.api.models[ className ]();
theModel2.set( 'id', theModel.attributes[0].id ); theModel2.set( 'id', theModel.attributes.id );
theModel2.fetch().done( function() { theModel2.fetch().done( function() {
// We were able to retrieve the model. // We were able to retrieve the model.
assert.equal( assert.equal(
theModel.attributes[0].id, theModel.attributes.id,
theModel2.get( 'id' ) , theModel2.get( 'id' ) ,
'We should be able to get a ' + className 'We should be able to get a ' + className
); );