angular.js/test/ResourceSpec.js

'use strict';

describe("resource", function() {
  var xhr, resource, CreditCard, callback;

  beforeEach(function(){
    var browser = new MockBrowser();
    xhr = browser.xhr;
    resource = new ResourceFactory(xhr);
    CreditCard = resource.route('/CreditCard/:id:verb', {id:'@id.key'}, {
      charge:{
        method:'POST',
        params:{verb:'!charge'}
      }
    });
    callback = jasmine.createSpy();
  });

  it("should build resource", function(){
    expect(typeof CreditCard).toBe($function);
    expect(typeof CreditCard.get).toBe($function);
    expect(typeof CreditCard.save).toBe($function);
    expect(typeof CreditCard.remove).toBe($function);
    expect(typeof CreditCard['delete']).toBe($function);
    expect(typeof CreditCard.query).toBe($function);
  });

  it('should default to empty parameters', function(){
    xhr.expectGET('URL').respond({});
    resource.route('URL').query();
  });

  it('should ignore slashes of undefinend parameters', function(){
    var R = resource.route('/Path/:a/:b/:c');
    xhr.expectGET('/Path').respond({});
    xhr.expectGET('/Path/1').respond({});
    xhr.expectGET('/Path/2/3').respond({});
    xhr.expectGET('/Path/4/5/6').respond({});
    R.get({});
    R.get({a:1});
    R.get({a:2, b:3});
    R.get({a:4, b:5, c:6});
  });

  it('should correctly encode url params', function(){
    var R = resource.route('/Path/:a');
    xhr.expectGET('/Path/foo%231').respond({});
    xhr.expectGET('/Path/doh!@foo?bar=baz%231').respond({});
    R.get({a: 'foo#1'});
    R.get({a: 'doh!@foo', bar: 'baz#1'});
  });

  it('should not encode @ in url params', function() {
    //encodeURIComponent is too agressive and doesn't follow http://www.ietf.org/rfc/rfc3986.txt
    //with regards to the character set (pchar) allowed in path segments
    //so we need this test to make sure that we don't over-encode the params and break stuff like
    //buzz api which uses @self

    var R = resource.route('/Path/:a');
    xhr.expectGET('/Path/doh@fo%20o?!do%26h=g%3Da+h&:bar=$baz@1').respond({});
    R.get({a: 'doh@fo o', ':bar': '$baz@1', '!do&h': 'g=a h'});
  });

  it('should encode & in url params', function() {
    var R = resource.route('/Path/:a');
    xhr.expectGET('/Path/doh&foo?bar=baz%261').respond({});
    R.get({a: 'doh&foo', bar: 'baz&1'});
  });

  it("should build resource with default param", function(){
    xhr.expectGET('/Order/123/Line/456.visa?minimum=0.05').respond({id:'abc'});
    var LineItem = resource.route('/Order/:orderId/Line/:id:verb', {orderId: '123', id: '@id.key', verb:'.visa', minimum:0.05});
    var item = LineItem.get({id:456});
    xhr.flush();
    nakedExpect(item).toEqual({id:'abc'});
  });

  it("should create resource", function(){
    xhr.expectPOST('/CreditCard', {name:'misko'}).respond({id:123, name:'misko'});

    var cc = CreditCard.save({name:'misko'}, callback);
    nakedExpect(cc).toEqual({name:'misko'});
    expect(callback).not.toHaveBeenCalled();
    xhr.flush();
    nakedExpect(cc).toEqual({id:123, name:'misko'});
    expect(callback).toHaveBeenCalledWith(cc);
  });

  it("should read resource", function(){
    xhr.expectGET("/CreditCard/123").respond({id:123, number:'9876'});
    var cc = CreditCard.get({id:123}, callback);
    expect(cc instanceof CreditCard).toBeTruthy();
    nakedExpect(cc).toEqual({});
    expect(callback).not.toHaveBeenCalled();
    xhr.flush();
    nakedExpect(cc).toEqual({id:123, number:'9876'});
    expect(callback).toHaveBeenCalledWith(cc);
  });

  it("should read partial resource", function(){
    xhr.expectGET("/CreditCard").respond([{id:{key:123}}]);
    xhr.expectGET("/CreditCard/123").respond({id:{key:123}, number:'9876'});
    var ccs = CreditCard.query();
    xhr.flush();
    expect(ccs.length).toEqual(1);
    var cc = ccs[0];
    expect(cc instanceof CreditCard).toBeTruthy();
    expect(cc.number).not.toBeDefined();
    cc.$get(callback);
    xhr.flush();
    expect(callback).toHaveBeenCalledWith(cc);
    expect(cc.number).toEqual('9876');
  });

  it("should update resource", function(){
    xhr.expectPOST('/CreditCard/123', {id:{key:123}, name:'misko'}).respond({id:{key:123}, name:'rama'});

    var cc = CreditCard.save({id:{key:123}, name:'misko'}, callback);
    nakedExpect(cc).toEqual({id:{key:123}, name:'misko'});
    expect(callback).not.toHaveBeenCalled();
    xhr.flush();
  });

  it("should query resource", function(){
    xhr.expectGET("/CreditCard?key=value").respond([{id:1}, {id:2}]);

    var ccs = CreditCard.query({key:'value'}, callback);
    expect(ccs).toEqual([]);
    expect(callback).not.toHaveBeenCalled();
    xhr.flush();
    nakedExpect(ccs).toEqual([{id:1}, {id:2}]);
    expect(callback).toHaveBeenCalledWith(ccs);
  });

  it("should have all arguments optional", function(){
    xhr.expectGET('/CreditCard').respond([{id:1}]);
    var log = '';
    var ccs = CreditCard.query(function(){ log += 'cb;'; });
    xhr.flush();
    nakedExpect(ccs).toEqual([{id:1}]);
    expect(log).toEqual('cb;');
  });

  it('should delete resource and call callback', function(){
    xhr.expectDELETE("/CreditCard/123").respond(200, {});

    CreditCard.remove({id:123}, callback);
    expect(callback).not.toHaveBeenCalled();
    xhr.flush();
    nakedExpect(callback.mostRecentCall.args).toEqual([{}]);

    callback.reset();
    xhr.expectDELETE("/CreditCard/333").respond(204, null);
    CreditCard.remove({id:333}, callback);
    expect(callback).not.toHaveBeenCalled();
    xhr.flush();
    nakedExpect(callback.mostRecentCall.args).toEqual([{}]);
  });

  it('should post charge verb', function(){
    xhr.expectPOST('/CreditCard/123!charge?amount=10', {auth:'abc'}).respond({success:'ok'});

    CreditCard.charge({id:123, amount:10},{auth:'abc'}, callback);
  });

  it('should post charge verb on instance', function(){
    xhr.expectPOST('/CreditCard/123!charge?amount=10', {id:{key:123}, name:'misko'}).respond({success:'ok'});

    var card = new CreditCard({id:{key:123}, name:'misko'});
    card.$charge({amount:10}, callback);
  });

  it('should create on save', function(){
    xhr.expectPOST('/CreditCard', {name:'misko'}).respond({id:123});
    var cc = new CreditCard();
    expect(cc.$get).toBeDefined();
    expect(cc.$query).toBeDefined();
    expect(cc.$remove).toBeDefined();
    expect(cc.$save).toBeDefined();

    cc.name = 'misko';
    cc.$save(callback);
    nakedExpect(cc).toEqual({name:'misko'});
    xhr.flush();
    nakedExpect(cc).toEqual({id:123});
    expect(callback).toHaveBeenCalledWith(cc);
  });

  it('should not mutate the resource object if response contains no body', function(){
    var data = {id:{key:123}, number:'9876'};
    xhr.expectGET("/CreditCard/123").respond(data);
    var cc = CreditCard.get({id:123});
    xhr.flush();
    expect(cc instanceof CreditCard).toBeTruthy();
    var idBefore = cc.id;

    xhr.expectPOST("/CreditCard/123", data).respond('');
    cc.$save();
    xhr.flush();
    expect(idBefore).toEqual(cc.id);
  });

  it('should bind default parameters', function(){
    xhr.expectGET('/CreditCard/123.visa?minimum=0.05').respond({id:123});
    var Visa = CreditCard.bind({verb:'.visa', minimum:0.05});
    var visa = Visa.get({id:123});
    xhr.flush();
    nakedExpect(visa).toEqual({id:123});
  });

  it('should excersize full stack', function(){
    var scope = angular.compile('<div></div>')();
    var $browser = scope.$service('$browser');
    var $resource = scope.$service('$resource');
    var Person = $resource('/Person/:id');
    $browser.xhr.expectGET('/Person/123').respond('\n{\n"name":\n"misko"\n}\n');
    var person = Person.get({id:123});
    $browser.xhr.flush();
    expect(person.name).toEqual('misko');
    dealoc(scope);
  });

  it('should return the same object when verifying the cache', function(){
    var scope = angular.compile('<div></div>')();
    var $browser = scope.$service('$browser');
    var $resource = scope.$service('$resource');
    var Person = $resource('/Person/:id', null, {query: {method:'GET', isArray: true, verifyCache: true}});
    $browser.xhr.expectGET('/Person/123').respond('[\n{\n"name":\n"misko"\n}\n]');
    var person = Person.query({id:123});
    $browser.xhr.flush();
    expect(person[0].name).toEqual('misko');

    $browser.xhr.expectGET('/Person/123').respond('[\n{\n"name":\n"rob"\n}\n]');
    var person2 = Person.query({id:123});
    $browser.defer.flush();

    expect(person2[0].name).toEqual('misko');
    var person2Cache = person2;
    $browser.xhr.flush();
    expect(person2Cache).toEqual(person2);
    expect(person2[0].name).toEqual('rob');
    dealoc(scope);
  });

  describe('failure mode', function(){
    it('should report error when non 200', function(){
      xhr.expectGET('/CreditCard/123').respond(500, "Server Error");
      var cc = CreditCard.get({id:123});
      try {
        xhr.flush();
        fail('expected exception, non thrown');
      } catch (e) {
        expect(e.status).toEqual(500);
        expect(e.response).toEqual('Server Error');
        expect(e.message).toEqual('500: Server Error');
      }
    });
  });

});