Merge pull request #19 from Exelord/feature-query-params

Custom Query Params

Author: Exelord

README.md

@@ -41,7 +41,7 @@ let user = this.get('currentUser');
 let postToPublish = this.get('store').findRecord('post', 1);
 let payload = { publisher: user };
 
-postToPublish.publish(payload).then((status) => {
+postToPublish.publish(payload, /*{ custom options }*/).then((status) => {
   alert(`Post has been: ${status}`)
 }).catch((error) => {
   console.log('Here are you serialized model errors', error.serializedErrors);
@@ -70,7 +70,7 @@ let user = this.get('currentUser');
 let emptyPost = this.get('store').createRecord('post');
 let payload = { user };
 
-emptyPost.favorites(payload).then((favoritesPosts) => {
+emptyPost.favorites(payload, /*{ custom options }*/).then((favoritesPosts) => {
   console.log(favoritesPosts);
 }).finally(()=>{
   emptyPost.deleteRecord();
@@ -175,6 +175,10 @@ model.customAction({}, { promiseType: null }) // returns Promise
 ```
 `null` is useful if you don't care about the response or just want to use `then` on the promise without using `binding` or display it in the template.
 
+#### `params`
+You can pass a query params for a request by passing an `{}` with properties, eg: `{ include: 'owner' }`
+** Remember: Query params are not normalized! You have to pass it in the correct format. **
+
 # Development
 
 ## Installation

addon/actions/action.js

@@ -7,7 +7,7 @@ const {
   assign,
   getOwner,
   computed,
-  Object: emberObject,
+  Object: EmberObject,
   ObjectProxy,
   ArrayProxy,
   PromiseProxyMixin,
@@ -21,14 +21,19 @@ const promiseTypes = {
   object: ObjectProxy.extend(PromiseProxyMixin)
 };
 
-export default emberObject.extend({
+export default EmberObject.extend({
   model: null,
   options: {},
   payload: {},
   instance: false,
 
   store: computed.reads('model.store'),
 
+  params: computed('config.params', 'adapter', function() {
+    let params = emberTypeOf(this.get('config.params')) === 'object' ? this.get('config.params') : {};
+    return this.get('adapter').sortQueryParams(params);
+  }),
+
   modelName: computed('model', function() {
     let { constructor } = this.get('model');
     return constructor.modelName || constructor.typeKey;
@@ -44,15 +49,15 @@ export default emberObject.extend({
 
   appConfig: computed('model', function() {
     let config = getOwner(this.get('model')).resolveRegistration('config:environment').emberCustomActions || {};
-    return emberObject.create(config);
+    return EmberObject.create(config);
   }),
 
   defaultConfig: computed(function() {
-    return emberObject.create(defaultConfig);
+    return EmberObject.create(defaultConfig);
   }),
 
   config: computed('defaultConfig', 'options', 'appConfig', function() {
-    return emberObject.create(assign(this.get('defaultConfig'), this.get('appConfig'), this.get('options')));
+    return EmberObject.create(assign({}, this.get('defaultConfig'), this.get('appConfig'), this.get('options')));
   }),
 
   requestType: computed('config.type', function() {
@@ -67,14 +72,16 @@ export default emberObject.extend({
       adapter: this.get('adapter'),
       urlType: this.get('urlType'),
       instance: this.get('instance'),
-      model: this.get('model')
+      model: this.get('model'),
+      params: this.get('params')
     }).build();
   }),
 
   data: computed('config.{normalizeOperation,ajaxOptions}', 'payload', function() {
     let payload = emberTypeOf(this.get('payload')) === 'object' ? this.get('payload') : {};
     let data = normalizePayload(payload, this.get('config.normalizeOperation'));
-    return assign(this.get('config.ajaxOptions'), { data });
+
+    return assign({}, this.get('config.ajaxOptions'), { data });
   }),
 
   promiseType: computed('config.promiseType', function() {

addon/actions/model.js

@@ -8,7 +8,7 @@ export default function(path, options = {}) {
     return Action.create({
       model: this,
       instance: true,
-      options: assign(options, customOptions),
+      options: assign({}, options, customOptions),
       payload,
       path
     }).callAction();

addon/actions/resource.js

@@ -7,7 +7,7 @@ export default function(path, options = {}) {
   return function(payload = {}, customOptions = {}) {
     return Action.create({
       model: this,
-      options: assign(options, customOptions),
+      options: assign({}, options, customOptions),
       path,
       payload
     }).callAction();

addon/utils/url-builder.js

@@ -1,8 +1,10 @@
 import Ember from 'ember';
 
-const { assert, computed, Object } = Ember;
+const { assert, computed, Object: EmberObject, $ } = Ember;
+
+export default EmberObject.extend({
+  params: {},
 
-export default Object.extend({
   modelName: computed('model', function() {
     let { constructor } = this.get('model');
     return constructor.modelName || constructor.typeKey;
@@ -21,14 +23,28 @@ export default Object.extend({
   },
 
   _buildUrl(id) {
-    return this.get('adapter').buildURL(this.get('modelName'), id, this.get('snapshot'), this.get('urlType'));
+    let query = this.get('params');
+    let snapshot = this.get('snapshot');
+    let modelName = this.get('modelName');
+    let requestType = this.get('urlType');
+
+    return this.get('adapter').buildURL(modelName, id, snapshot, requestType, query);
   },
 
   _makeUrl(url) {
+    let pathUrl = '';
+    let query = $.param(this.get('params'));
+
     if (url.charAt(url.length - 1) === '/') {
-      return `${url}${this.get('path')}`;
+      pathUrl = `${url}${this.get('path')}`;
+    } else {
+      pathUrl = `${url}/${this.get('path')}`;
+    }
+
+    if (query) {
+      return `${pathUrl}?${query}`;
     } else {
-      return `${url}/${this.get('path')}`;
+      return pathUrl;
     }
   }
 });

tests/dummy/app/models/post.js

@@ -8,5 +8,9 @@ export default Model.extend({
 
   publish: modelAction('publish', { promiseType: 'object' }),
   list: resourceAction('list'),
-  search: resourceAction('search', { type: 'GET', normalizeOperation: 'dasherize' })
+  search: resourceAction('search', {
+    type: 'GET',
+    normalizeOperation: 'dasherize',
+    params: { showAll: true }
+  })
 });

tests/unit/models/bike-test.js

@@ -14,12 +14,14 @@ moduleForModel('bike', 'Unit | Model | bike', {
 });
 
 test('model action', function(assert) {
-  assert.expect(3);
+  assert.expect(4);
 
   this.server.put('/bikes/:id/ride', (request) => {
     let data = JSON.parse(request.requestBody);
+
     assert.deepEqual(data, { myParam: 'My first param' });
-    assert.equal(request.url, '/bikes/1/ride');
+    assert.deepEqual(request.queryParams, { enduro: 'true', include: 'owner' });
+    assert.equal(request.url, '/bikes/1/ride?enduro=true&include=owner');
 
     return [200, { }, 'true'];
   });
@@ -30,7 +32,7 @@ test('model action', function(assert) {
   let model = this.subject();
   model.set('id', 1);
 
-  model.ride(payload).then((response) => {
+  model.ride(payload, { params: { enduro: true, include: 'owner' } }).then((response) => {
     assert.ok(response, true);
     done();
   });

tests/unit/models/post-test.js

@@ -89,11 +89,16 @@ test('resource action', function(assert) {
 });
 
 test('resource action with params in GET', function(assert) {
-  assert.expect(3);
+  assert.expect(4);
 
   this.server.get('/posts/search', (request) => {
-    assert.equal(request.url, '/posts/search?my-param=My%20first%20param');
+    assert.equal(request.url, '/posts/search?showAll=true&my-param=My%20first%20param');
     assert.equal(request.requestHeaders.test, 'Custom header');
+    assert.deepEqual(request.queryParams, {
+      'my-param': 'My first param',
+      'showAll': 'true'
+    });
+
     return [200, { }, 'true'];
   });