Optimizing an API for Ember Data (Boston)

I updated my talk from EmberCamp for a Boston Ember meetup. The slides include some updated code examples and fresh content.

Transcript

1. Optimizing An API For Ember Data Dan Gebhardt Updated for BOSTON Ember.js
2. Dan Gebhardt @dgeb
3. Convention Configuration
4. “Trivial choices are the enemy” - Yehuda Katz
5. Ruby on Rails ActiveModel::Serializers Ember.js Ember Data
7. “What” not “how” DRY Customizable ActiveModel::Serializers
8. Ember Data In memory store Canonical records Multi-layered architecture Flexible and customizable
9. Ember Data
10. Ember Data Serializer Adapter Store
11. JSON underscore_naming include root element id: 1, fk_id: 1, fk_ids: [1] conventions for including related data AM::S Conventions
12. DS.RESTAdapter Conventions JSON underscore_naming include root element id: 1, fk_id: 1, fk_ids: [1] conventions for including related data
13. DS.RESTAdapter Conventions JSON underscore_naming include root element id: 1, fk_id: 1, fk_ids: [1] conventions for including related data IDENTICAL TO ActiveModel::Serializers
14. class ApplicationSerializer < ActiveModel::Serializer # sideload related data by default embed :ids, include: true end AM::S Configuration
15. Ember Data Configuration App.Adapter = DS.RESTAdapter.extend(); App.Store = DS.Store.extend({ revision: 12, adapter: 'App.Adapter' });
16. Relationships source: twitamore.com
17. One-to-Many Relationships App.Post = DS.Model.extend({ title: DS.attr('string'), comments: DS.hasMany('App.Comment') }); App.Comment = DS.Model.extend({ body: DS.attr('string'), post: DS.belongsTo('App.Post') });
18. class PostSerializer < ApplicationSerializer attributes :title has_many :comments end class CommentSerializer < ApplicationSerializer attributes :body belongs_to :post end One-to-Many Relationships
19. { post: { id: 1, title: 'Ember is Omakase', comment_ids: [4, 5, 6] }, comments: [ {id: 4, post_id: 1, body: 'delicious!'}, {id: 5, post_id: 1, body: 'yuno turbolinks?'}, {id: 6, post_id: 1, body: 'is that a tentacle?'} ] } JSON One-to-Many Relationships
20. One-to-One Relationships App.User = DS.Model.extend({ name: DS.attr('string'), rights: DS.belongsTo('App.Rights') }); App.Rights = DS.Model.extend({ admin: DS.attr('boolean'), user: DS.belongsTo('App.User') });
21. class UserSerializer < ApplicationSerializer attributes :id, :name has_one :rights end class RightsSerializer < ApplicationSerializer attributes :id, :admin belongs_to :user end One-to-One Relationships
22. { user: { id: 1, name: '', rights_id: 2 }, rights: [{ id: 2, admin: true, user_id: 1 }] } JSON One-to-One Relationships
23. One-to-None Relationships App.User = DS.Model.extend({ name: DS.attr('string'), rights: DS.belongsTo('App.Rights') }); App.Rights = DS.Model.extend({ admin: DS.attr('boolean') });
24. class UserSerializer < ApplicationSerializer attributes :id, :name has_one :rights end class RightsSerializer < ApplicationSerializer attributes :id, :admin end One-to-None Relationships
25. { user: { id: 1, name: '', rights_id: 2 }, rights: [{ id: 2, admin: true }] } JSON One-to-None Relationships
26. Many-to-Many Relationships App.Post = DS.Model.extend({ title: DS.attr('string'), body: DS.attr('string'), tags: DS.hasMany('App.Tag') }); App.Tag = DS.Model.extend({ name: DS.attr('string'), posts: DS.hasMany('App.Post') });
27. class PostSerializer < ApplicationSerializer attributes :id, :title, :body has_many :tags end class TagSerializer < ApplicationSerializer attributes :id, :name has_many :posts end Many-to-Many Relationships
28. { posts: [ {id: 1, title: 'Hello world', tag_ids: [11, 12]}, {id: 2, title: 'Goodbye', tag_ids: [11, 13]} ], tags: [ {id: 11, name: 'announcements', post_ids: [1,2]}, {id: 12, name: 'happy', post_ids: [1]}, {id: 13, name: 'sad', post_ids: [2]} ] } JSON Many-to-Many Relationships
29. Many-to-None Relationships App.Post = DS.Model.extend({ title: DS.attr('string'), body: DS.attr('string'), tags: DS.hasMany('App.Tag') }); App.Tag = DS.Model.extend({ name: DS.attr('string') });
30. class PostSerializer < ApplicationSerializer attributes :id, :title, :body has_many :tags end class TagSerializer < ApplicationSerializer attributes :id, :name end Many-to-None Relationships
31. { posts: [ {id: 1, title: 'Hello world', tag_ids: [11, 12]}, {id: 2, title: 'Goodbye', tag_ids: [11, 13]} ], tags: [ {id: 11, name: 'announcements'}, {id: 12, name: 'happy'}, {id: 13, name: 'sad'} ] } JSON Many-to-None Relationships
32. Embedded Relationships Creative Commons licensed by: Subhash Chandra
33. { post: { id: 1, title: 'Ember is Omakase', comments: [ {id: 4, body: 'delicious!'}, {id: 5, body: 'yuno turbolinks?'}, {id: 6, body: 'is that a tentacle?'} ] } } JSON Serialized Embedded Data
34. class PostSerializer < ApplicationSerializer attributes :title has_many :comments, embed: :objects end class CommentSerializer < ApplicationSerializer attributes :body belongs_to :post end Embedded Data Serializers
35. Embedded Read-only Data App.Post = DS.Model.extend({ title: DS.attr('string'), comments: DS.hasMany('App.Comment') }); App.Comment = DS.Model.extend({ body: DS.attr('string') }); App.Adapter.map('App.Post', { comments: {embedded: 'load'} });
36. Embedded Writeable Data App.Post = DS.Model.extend({ title: DS.attr('string'), comments: DS.hasMany('App.Comment') }); App.Comment = DS.Model.extend({ body: DS.attr('string') }); App.Adapter.map('App.Post', { comments: {embedded: 'always'} });
37. Customizations
38. { hobbit: {id: 1, name: 'Bilbo'} } { hobbitses: [ {id: 1, name: 'Bilbo'} {id: 2, name: 'Frodo'} {id: 3, name: 'Samwise'} ] } JSON Custom Pluralization
39. Custom Pluralization App.Adapter.configure('plurals', { hobbit: 'hobbitses' });
40. { post: { id: 1, titleOfPost: 'Ember is Omakase' } } JSON Custom Keys
41. Custom Keys App.Adapter.map('App.Post', { title: {key: 'titleOfPost'} });
42. { post: { id: 1, title: 'Ember is Omakase', comment_ids: [4, 5, 6] }, post_comments: [ {id: 4, post_id: 1, body: 'delicious!'}, {id: 5, post_id: 1, body: 'yuno turbolinks?'}, {id: 6, post_id: 1, body: 'is that a tentacle?'} ] } JSON Custom Sideloading
43. Custom Sideloading App.Adapter.configure('App.Comment', { sideloadAs: 'post_comments' });
44. Custom Transforms App.Adapter.registerTransform('excitableString', { serialize: function(value) { return value + '!'; }, deserialize: function(value) { return value.substring(0, value.length - 1); } }); App.Greeting = DS.Model.extend({ message: DS.attr('excitableString') });
45. Custom URLs App.Adapter.reopen({namespace: 'ember'}); person = store.find(Person, 1); // => /ember/people/1 App.Adapter.reopen({url: 'http://api.ember.dev'}); person = store.find(Person, 1); // => http://api.ember.dev/people/1
46. Bulk Commits App.Adapter.reopen({bulkCommit: true}); store.createRecord(App.Person, {name: 'tomdale'}); store.createRecord(App.Person, {name: 'wycats'}); store.commit(); // POST to /people // {people: [{name: 'tomdale'}, {name: 'wycats'}]}
47. Edge of Convention Pagination Authentication Sparse fieldsets Custom includes Polymorphism Creative Commons licensed by: _chrisUK
48. Resources http://emberjs.com/guides/models/ https://github.com/rails-api/active_model_serializers https://github.com/dgeb/ember_data_example Questions? http://stackoverflow.com/questions/tagged/ember-data @dgeb