Implement basic JSON-API adapter #2904

wecc · 2015-03-19T20:23:17Z

A basic working JSON-API adapter.

bmac · 2015-03-20T17:49:20Z

packages/ember-data/lib/adapters/json-api-adapter.js

+
+  pathForType: function(typeKey) {
+    return Ember.String.dasherize(typeKey);
+  },


chnn · 2015-04-03T18:12:38Z

tests/ember-configuration.js

+      return this._super(attributeType, true) || transforms[attributeType];
+    };
+    DS.JSONSerializer.reopen({ transformFor: transformFor });
+    DS.JSONAPISerializer.reopen({ transformFor: transformFor });


Looks like transformFor is never defined on the serializer and adapter, but the tests pass because of this patching (would not work in an actual app). I think?

bmac · 2015-04-28T18:48:04Z

packages/ember-data/lib/serializers/json-api-serializer.js

+  @namespace DS
+  @extends DS.Serializer
+*/
+export default Serializer.extend({


Should this extend from JSONSerializer so it can inherit the transformFor method?

wwwdata · 2015-06-10T13:38:05Z

hi, this is still in the RC3 format and not the final specification of jsonapi 1.0 right? Are you planning to finish this for 1.0? Can I help out in any way? Please give a small status update, thanks :)

wecc · 2015-06-10T13:42:04Z

@wwwdata I'm hard at work updating this to both 1.0 and the new Serializer API refactor we did recently. I hope I can update this PR later tonight with the new code! Happy to have an extra set of 👀 reviewing it!

wwwdata · 2015-06-10T13:42:52Z

@wecc awesome! I will review it carefully and test it against my backend once you push the new commits

wecc · 2015-06-10T21:10:04Z

@wwwdata ping

igorT · 2015-06-10T22:28:20Z

packages/ember-data/lib/adapters/json-api-adapter.js

+export default RESTAdapter.extend({
+  defaultSerializer: '-json-api',
+
+  concatenatedProperties: ['headers'],


If we are gonna do this, should add it to the rest adapter, but it seems like they can also be a CP as per the comments in the rest adapter, so might not work

igorT · 2015-06-10T22:42:32Z

packages/ember-data/lib/serializers/json-api-serializer.js

+        }
+
+        let data = hasMany.map((item) => {
+          return {


can rewrite without return and {

forEach and data.push()?

needs EnumerableUtils for IE8.

igorT · 2015-06-10T22:42:50Z

👍

utilityboy · 2015-06-10T23:56:41Z

I can't express the amount of awesome there is in the ember community! Thanks for all the amazing work. 👍

wwwdata · 2015-06-11T08:44:00Z

packages/ember-data/tests/integration/adapter/json-api-adapter-test.js

+
+    run(function() {
+      store.find('post').then(function(posts) {
+        equal(passedUrl[0], '/post');


the url should be /posts here. They are always pluralized.

SeyZ · 2015-06-11T09:01:08Z

Awesome work @wecc @wwwdata @igorT ! 🎉

pangratz · 2015-06-11T12:20:24Z

packages/ember-data/tests/integration/adapter/json-api-adapter-test.js

+
+    run(function() {
+      store.find('post', 1).then(function(post) {
+        equal(passedUrl[0], '/post/1');


@wwwdata same here as down below: this should be /posts/1?

Ok, so @wecc it seems that most/all URLs in the tests are singular at the moment ...

This is currently intentional as JSON-API does not state anything about URLs being singular/plural. Right now we only pass through from whatever your model names are. If your model is named Post the URL will be /post/1. If it's named Posts the URL will be /posts/1.

I'm very open to give Ember Data stronger opinions on this. Like plural for URLs and types and dasherized keys in payloads to match the examples from http://jsonapi.org/. There simply needs to be a decision made. I will bring this up at our meeting later today.

You are completely right @wecc. Thanks for the heads up!

hmm, but it is very confusing to name a single model in plural like posts. If we do not want to enforce a pluralized url we need some mechanism to configure the url I guess. On the jsonapi.org website, all the URLs are plural. A lot of backends that generate an API with URLs will generate them in that recommended format, so it should be easy for an ember-data user to use this recommended url scheme.

Totally agree with the confusion. For me:

Url should be plural: /api/posts or /api/posts/5 (REST compliant)

Model should be singular: Post

the type key in a jsonapi payload can be singular or plural (according to the spec). In my opinion, we need an option in the JSONAPIAdapter to specify the singular or plural form.

@pangratz @wwwdata @SeyZ this PR has now been updated to match the format on jsonapi.org as closely as possible.

types are serialized to, and expected to be plural dasherized when received from the server

member names are serialized to, and expected to be dasherized when received from the server

However, the internal JSON-API format for ED has singular dasherized for types and camelized for member names. This should not be an issue as the JSONAPISerializer normalizes the format mentioned above to the internal ED format automatically.

All of these will be easily overridden using hooks (modelNameFromPayloadKey, payloadKeyFromModelName, extractType, keyForAttribute, keyForRelationship...)

URLs are now also built to be plural dasherized by default.

😍 awesome work @wecc!

nonsensery · 2015-06-12T13:33:45Z

packages/ember-data/lib/adapters/json-api-adapter.js

+    let hash = this._super(...arguments);
+
+    if (hash.contentType) {
+      hash.contentType = 'application/vnd.api+json; charset=utf-8';


I don't think parameters, like charset=utf-8, are allowed by the spec right now. See content negotiation. (Same thing on line 33.)

bmac · 2015-06-14T23:55:00Z

packages/ember-data/lib/adapters/json-api-adapter.js

+  },
+
+  /**
+    TODO: Remove this once we have a better way to override HTTP verbs.


Lets move this comment out of the doc block.

fivetanley · 2015-06-15T00:01:06Z

packages/ember-data/lib/serializers/json-api-serializer.js

+  */
+  _normalizeResponse: function(store, primaryModelClass, payload, id, requestType, isSingle) {
+
+    let normalizeResourceHelper = (resourceHash) => {


we should probably move this to the prototype to avoid re-creating a closure every time.

fivetanley · 2015-06-15T00:05:07Z

Overall looks pretty good. You, bmac, and igor did all the hard work which is why this is a relatively small change 💃

igorT · 2015-06-15T19:47:25Z

packages/ember-data/lib/serializers/json-api-serializer.js

+    @param {Object} resourceHash
+    @return {String}
+  */
+  extractType: function(modelClass, resourceHash) {


Implement basic JSON-API adapter

wwwdata · 2015-06-18T09:19:21Z

this is merged now, which is awesome but did anybody actually use this adapter against his backend and can help me? When I want to load entities from my backend, the request is made, I can see that in chrome debug tools but I always have an empty array instead of a list of my question entity.

I am doing

this.store.findAll('question');

in my route

question model

import DS from 'ember-data';

export default DS.Model.extend({
  text: DS.attr('string')
});

the server returns this very minimalistic json

{
    "data": [
        {
            "attributes": {
                "text": "wow?"
            },
            "id": "ddb72a88-3004-4c30-a14c-71f50084233b",
            "type": "questions"
        }
    ]
}

I am using ember-cli and registered the JSONAPIAdapter in my application adapter and the JSONAPISerializer as application serializer.

What could I have possibly done wrong that this does not work?

wecc · 2015-06-18T10:16:50Z

@wwwdata I'm able to replicate that the JSONSerializer doesn't automatically use the new Serializer API when extending. Can you confirm if it works when you change your application serializer to:

export default DS.JSONAPISerializer.extend({
  isNewSerializerAPI: true
});

wwwdata · 2015-06-18T12:18:32Z

aaah, thank you so much, yes that was the problem!

wecc · 2015-06-18T12:41:41Z

@wwwdata thank you for discovering and confirming! This should be fixed with #3375 (as in not needing to provide isNewSerializerAPI: true)

wecc mentioned this pull request Mar 19, 2015

[Meta Issue] JSON-API support #2905

Closed

10 tasks

bmac reviewed Mar 20, 2015
View reviewed changes

packages/ember-data/lib/adapters/json-api-adapter.js

pathForType: function(typeKey) {

return Ember.String.dasherize(typeKey);

},

Copy link

Member

bmac Mar 20, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

twokul mentioned this pull request Mar 24, 2015

Error Handling Refactor #2931

Closed

11 tasks

wecc force-pushed the json-api-adapter branch 2 times, most recently from eb34c6d to 57bc19c Compare March 25, 2015 14:52

chnn reviewed Apr 3, 2015
View reviewed changes

wecc force-pushed the json-api-adapter branch from 57bc19c to da54b6e Compare April 22, 2015 18:31

bmac pushed a commit to endpoints/ember-data-endpoints that referenced this pull request Apr 22, 2015

Add Wecc's JSON API adapter from emberjs/data#2904

717a871

bmac mentioned this pull request Apr 22, 2015

Json api rc3 endpoints/ember-data-endpoints#12

Merged

wecc force-pushed the json-api-adapter branch 2 times, most recently from 610a430 to aa31e23 Compare April 22, 2015 21:16

bmac mentioned this pull request Apr 28, 2015

Bob fixes endpoints/ember-data-endpoints#13

Merged

bmac reviewed Apr 28, 2015
View reviewed changes

barelyknown mentioned this pull request Jun 8, 2015

Support JSON API 1.0. eneuhauser/ember-json-api#14

Merged

ballPointPenguin mentioned this pull request Jun 8, 2015

Support for JSON API 1.0 kurko/ember-json-api#82

Closed

wecc force-pushed the json-api-adapter branch from 0bfde88 to 392958a Compare June 10, 2015 20:49

wecc changed the title ~~[WIP] Implement basic JSON-API adapter~~ Implement basic JSON-API adapter Jun 10, 2015

igorT reviewed Jun 10, 2015
View reviewed changes

wwwdata reviewed Jun 11, 2015
View reviewed changes

pangratz reviewed Jun 11, 2015
View reviewed changes

wecc force-pushed the json-api-adapter branch from 392958a to 5eb9e36 Compare June 12, 2015 07:54

nonsensery reviewed Jun 12, 2015
View reviewed changes

wecc force-pushed the json-api-adapter branch 2 times, most recently from 00f6206 to 5d59b76 Compare June 14, 2015 20:27

bmac reviewed Jun 14, 2015
View reviewed changes

wecc force-pushed the json-api-adapter branch from 5d59b76 to 7b130b6 Compare June 14, 2015 23:56

fivetanley reviewed Jun 15, 2015
View reviewed changes

wecc force-pushed the json-api-adapter branch from 7b130b6 to a75d6fa Compare June 15, 2015 00:17

igorT reviewed Jun 15, 2015
View reviewed changes

wecc force-pushed the json-api-adapter branch from a75d6fa to e8f4c3d Compare June 15, 2015 20:09

Initial JSON-API Adapter/Serializer

76cf421

wecc force-pushed the json-api-adapter branch from e8f4c3d to 76cf421 Compare June 15, 2015 20:16

igorT added a commit that referenced this pull request Jun 15, 2015

Merge pull request #2904 from wecc/json-api-adapter

7b2c70d

Implement basic JSON-API adapter

igorT merged commit 7b2c70d into emberjs:master Jun 15, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement basic JSON-API adapter #2904

Implement basic JSON-API adapter #2904

wecc commented Mar 19, 2015

bmac Mar 20, 2015

chnn Apr 3, 2015

bmac Apr 28, 2015

wwwdata commented Jun 10, 2015

wecc commented Jun 10, 2015

wwwdata commented Jun 10, 2015

wecc commented Jun 10, 2015

igorT Jun 10, 2015

igorT Jun 10, 2015

wecc Jun 12, 2015

fivetanley Jun 15, 2015

igorT commented Jun 10, 2015

utilityboy commented Jun 10, 2015

wwwdata Jun 11, 2015

SeyZ commented Jun 11, 2015

pangratz Jun 11, 2015

wwwdata Jun 11, 2015

pangratz Jun 11, 2015

wecc Jun 12, 2015

pangratz Jun 12, 2015

wwwdata Jun 12, 2015

SeyZ Jun 13, 2015

wecc Jun 14, 2015

pangratz Jun 14, 2015

nonsensery Jun 12, 2015

wecc Jun 14, 2015

bmac Jun 14, 2015

fivetanley Jun 15, 2015

fivetanley commented Jun 15, 2015

igorT Jun 15, 2015

wwwdata commented Jun 18, 2015

wecc commented Jun 18, 2015

wwwdata commented Jun 18, 2015

wecc commented Jun 18, 2015

Implement basic JSON-API adapter #2904

Implement basic JSON-API adapter #2904

Conversation

wecc commented Mar 19, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wwwdata commented Jun 10, 2015

wecc commented Jun 10, 2015

wwwdata commented Jun 10, 2015

wecc commented Jun 10, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

igorT commented Jun 10, 2015

utilityboy commented Jun 10, 2015

Choose a reason for hiding this comment

SeyZ commented Jun 11, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fivetanley commented Jun 15, 2015

Choose a reason for hiding this comment

wwwdata commented Jun 18, 2015

wecc commented Jun 18, 2015

wwwdata commented Jun 18, 2015

wecc commented Jun 18, 2015