angularjs-rails-resource 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e03c98a5ea5807396c9246d9a2183c8861fbf6ec
-  data.tar.gz: 06ddc4ec3b0d2c5549783a738f35f7b28fa583ac
+  metadata.gz: 4bfbacbc10e68b92315a301e1419852f77b4c028
+  data.tar.gz: 73c370919edead2bd08430a3551513196595389d
 SHA512:
-  metadata.gz: 047426f09ba305b7d347623406e95d1c04b94726b8e3d3bd26fbc8b92bdb3c69a4d5a08821d1bc98625fd4630bd13c4fc5cbf8148d7e3f3a3ca4bb93e0adf44c
-  data.tar.gz: 386dfb97cb7fec33ae06a5b91f9bb0925750090f748005e55a1d6e8af1ff0f8cdf690487d873234670106182f232b5d7e9fccb94e92f214217b52cfa45d190ea
+  metadata.gz: 11b7134336f0441bdd6ee5cec43b5d683f82d1d1e965d55f50a174c69eca431ee7b927dc903bb43f57f1038fcd5fd75a54734ffb46cfa53c7a62bc27f8b30bc7
+  data.tar.gz: 805dbd40dcc11ce20b3773c04fb974a5b2b2ae2c5f6a0e452a455c1c222da60f32ff3b8378413d5f12fe4dcaf530bb030beae592741e3889dce3a556b86b53f3

data/.gitignore

@@ -19,4 +19,5 @@ test_out
 atlassian-ide-plugin.xml
 node_modules
 build/
+.idea/
 

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+<a name="1.1.0"></a>
+# 1.1.0
+## Bug Fixes
+
+## Features
+- Added <code>idAttribute</code> configuration option to allow customizing the unique id field on resources. - #114 (@inlineblock)
+- Added <code>get</code> instance method to refresh resources from the server. - #115 (@wwilkins)
+ 
 <a name="1.0.1"></a>
 # 1.0.1
 ## Bug Fixes

data/README.md

@@ -197,6 +197,7 @@ defined on the resource can be called multiple times to adjust properties as nee
  * **name** - This is the name used for root wrapping when dealing with singular instances.
  * **pluralName** *(optional)* - If specified this name will be used for unwrapping array results.  If not specified then the serializer's [pluralize](#serializers) method is used to calculate
         the plural name from the singular name.
+ * **idAttribute** *(optional)* - (Default: 'id') Configures what field on the record represents the unique identifier.
  * **httpConfig** *(optional)* - By default we will add the following headers to ensure that the request is processed as JSON by Rails. You can specify additional http config options or override any of the defaults by setting this property.  See the [AngularJS $http API](http://docs.angularjs.org/api/ng.$http) for more information.
      * **headers**
          * **Accept** - application/json
@@ -352,6 +353,9 @@ All of the instance methods will update the instance in-place on response and wi
 * $url(path) - Returns this Resource instance's URL with the optional path appended if provided.
     * **path** {string} (optional) - A path to append to the resource's URL.
 
+* get() - Refreshes the instance from the server.
+    * **returns** {promise} - A promise that will be resolved with the instance itself
+
 * create() - Submits the resource instance to the resource's base URL (e.g. /books) using a POST
     * **returns** {promise} - A promise that will be resolved with the instance itself
 

data/bower.json

@@ -1,6 +1,6 @@
 {
   "name": "angularjs-rails-resource",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "main": "angularjs-rails-resource.js",
   "description": "A resource factory inspired by $resource from AngularJS",
   "repository": {

data/lib/angularjs-rails-resource/version.rb

@@ -1,7 +1,7 @@
 module Angularjs
   module Rails
     module Resource
-      VERSION = '1.0.2'
+      VERSION = '1.1.1'
     end
   end
 end

data/package.json

@@ -1,7 +1,7 @@
 {
   "name": "angularjs-rails-resource",
   "description" : "A resource factory inspired by $resource from AngularJS",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "main" : "dist/angularjs-rails-resource.min.js",
   "homepage" : "https://github.com/FineLinePrototyping/angularjs-rails-resource.git",
   "author" : "",

data/test/unit/angularjs/rails/resourceSpec.js

@@ -359,6 +359,30 @@ describe('railsResourceFactory', function () {
             expect(result).toEqualData({id: 123, abc: 'xyz', xyz: 'abc', extra: 'test'});
         });
 
+        it('should be able to get an existing resource to retrieve server-side updates', function () {
+            var promise, result;
+
+            $httpBackend.expectGET('/test/123').respond(200, {test: {id: 123, abc: 'xyz', xyz: 'abcd'}});
+
+            expect(promise = Test.get(123)).toBeDefined();
+
+            promise.then(function (response) {
+              result = response;
+            });
+
+            $httpBackend.flush();
+
+            expect(result).toBeInstanceOf(Test);
+            expect(result).toEqualData({id: 123, abc: 'xyz', xyz: 'abcd'});
+
+            var updatedData = {test: {id: 123, abc: 'zed', xyz: 'wcw', extra: 'test'}};
+            $httpBackend.expectGET('/test/123').respond(200, updatedData);
+
+           result.get();
+           $httpBackend.flush();
+           expect(result).toEqualData(updatedData.test);
+        });
+
         it('update should handle 204 response', function () {
             var promise, result;
 

data/test/unit/angularjs/rails/utils/urlBuilderSpec.js

@@ -4,25 +4,47 @@ describe("railsUrlBuilder", function () {
     beforeEach(module('rails'));
 
     it('should return custom function', inject(function (railsUrlBuilder) {
-        expect(railsUrlBuilder(function () { return 'test' })()).toEqualData('test')
+        expect(railsUrlBuilder({
+          url: function () { return 'test' }
+        })()).toEqualData('test')
     }));
 
     it('should return base url when no context object', inject(function (railsUrlBuilder) {
-        expect(railsUrlBuilder('/books')()).toEqualData('/books');
+        expect(railsUrlBuilder({
+          url: '/books'
+        })()).toEqualData('/books');
     }));
 
     it('should append id', inject(function (railsUrlBuilder) {
-        expect(railsUrlBuilder('/books')({id: 1})).toEqualData('/books/1');
+        expect(railsUrlBuilder({
+          url: '/books',
+          idAttribute: 'id'
+        })({id: 1})).toEqualData('/books/1');
     }));
 
     it('should use author id for book list', inject(function (railsUrlBuilder) {
-        expect(railsUrlBuilder('/authors/{{authorId}}/books/{{id}}')({authorId: 1})).toEqualData('/authors/1/books');
+        expect(railsUrlBuilder({
+          url: '/authors/{{authorId}}/books/{{id}}',
+          idAttribute: 'id'
+        })({authorId: 1})).toEqualData('/authors/1/books');
     }));
 
     it('should use author id and book id', inject(function (railsUrlBuilder) {
-        expect(railsUrlBuilder('/authors/{{authorId}}/books/{{id}}')({authorId: 1, id: 2})).toEqualData('/authors/1/books/2');
+        expect(railsUrlBuilder({
+          url: '/authors/{{authorId}}/books/{{id}}',
+          idAttribute: 'id'
+        })({authorId: 1, id: 2})).toEqualData('/authors/1/books/2');
     }));
 
+    describe('custom idAttribute', function () {
+      it('should use different id attribute', inject(function (railsUrlBuilder) {
+        expect(railsUrlBuilder({
+          url: '/books',
+          idAttribute: 'other_id'
+        })({id: 1, other_id: 30})).toEqualData('/books/30');
+      }));
+    });
+
     describe('custom interpolation symbols', function() {
         beforeEach(module(function($interpolateProvider) {
               $interpolateProvider.startSymbol('--');
@@ -30,11 +52,17 @@ describe("railsUrlBuilder", function () {
         }));
 
         it('should append id', inject(function (railsUrlBuilder) {
-            expect(railsUrlBuilder('/books')({id: 1})).toEqualData('/books/1');
+            expect(railsUrlBuilder({
+              url: '/books',
+              idAttribute: 'id'
+            })({id: 1})).toEqualData('/books/1');
         }));
 
         it('should use author id and book id', inject(function (railsUrlBuilder) {
-            expect(railsUrlBuilder('/authors/--authorId--/books/--id--')({authorId: 1, id: 2})).toEqualData('/authors/1/books/2');
+            expect(railsUrlBuilder({
+              url: '/authors/--authorId--/books/--id--',
+              idAttribute: 'id'
+            })({authorId: 1, id: 2})).toEqualData('/authors/1/books/2');
         }));
     });
 });

data/vendor/assets/javascripts/angularjs/rails/resource/resource.js

@@ -209,6 +209,7 @@
                     }
 
                     this.config = {};
+                    this.config.idAttribute = cfg.idAttribute || 'id';
                     this.config.url = cfg.url;
                     this.config.rootWrapping = booleanParam(cfg.rootWrapping, defaultOptions.rootWrapping); // using undefined check because config.rootWrapping || true would be true when config.rootWrapping === false
                     this.config.httpConfig = cfg.httpConfig || defaultOptions.httpConfig;
@@ -232,7 +233,7 @@
                         this.config.pluralName = this.config.serializer.underscore(cfg.pluralName || this.config.serializer.pluralize(this.config.name));
                     }
 
-                    this.config.urlBuilder = railsUrlBuilder(this.config.url);
+                    this.config.urlBuilder = railsUrlBuilder(this.config);
                     this.config.resourceConstructor = this;
 
                     this.extend.apply(this, loadExtensions((cfg.extensions || []).concat(defaultOptions.extensions)));
@@ -732,9 +733,14 @@
                     return this['$' + this.constructor.config.updateMethod](this.$url(), this);
                 };
 
+                RailsResource.prototype.get = function () {
+                    return this.constructor.$http(angular.extend({method: 'GET', url: this.$url()}, this.constructor.getHttpConfig()), this);
+                };
+
                 RailsResource.prototype.isNew = function () {
-                    return angular.isUndefined(this.id) ||
-                        this.id === null;
+                    var idAttribute = this.constructor.config.idAttribute;
+                    return angular.isUndefined(this[idAttribute]) ||
+                        this[idAttribute] === null;
                 };
 
                 RailsResource.prototype.save = function () {

data/vendor/assets/javascripts/angularjs/rails/resource/utils/url_builder.js

@@ -30,15 +30,17 @@
  */
 (function (undefined) {
     angular.module('rails').factory('railsUrlBuilder', ['$interpolate', function($interpolate) {
-        return function (url) {
-            var expression;
+        return function (config) {
+            var url = config.url,
+              idAttribute = config.idAttribute,
+              expression;
 
             if (angular.isFunction(url) || angular.isUndefined(url)) {
                 return url;
             }
 
             if (url.indexOf($interpolate.startSymbol()) === -1) {
-                url = url + '/' + $interpolate.startSymbol() + 'id' + $interpolate.endSymbol();
+                url = url + '/' + $interpolate.startSymbol() + idAttribute + $interpolate.endSymbol();
             }
 
             expression = $interpolate(url);
@@ -54,4 +56,4 @@
             };
         };
     }]);
-}());
+}());

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: angularjs-rails-resource
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.1
 platform: ruby
 authors:
 - Tommy Odom
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-01 00:00:00.000000000 Z
+date: 2014-04-12 00:00:00.000000000 Z
 dependencies: []
 description: A small AngularJS add-on for integrating with Rails via JSON more easily.
 email:
@@ -19,8 +19,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - CHANGELOG.md
 - EXAMPLES.md
 - Gemfile
@@ -71,17 +71,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: AngularJS add-on resource add-on for integrating with Rails