angularjs-rails-resource 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dcbb9f729e55fc427ad6eaed8e5356f08315d30
-  data.tar.gz: 19cfc254499c9fe89f5db0bf93576055d2309f89
+  metadata.gz: 3f99d3285acce5e56b23fb1afcb9f9441f2bbc00
+  data.tar.gz: d23f60d6f53df27985752e40129329d9a740d585
 SHA512:
-  metadata.gz: 06c9d9ea3be0fbfea6a3bee07b7a85a08623a3d4d394f0ccee79597d65eb4cd9f0f723d8ac53260e4102767d6597da2d6fcf71a900af256650fe23dc0c7e8ac7
-  data.tar.gz: 008723eb726c8aa86aa84ccc15468ef7a6ee223a05ff16fec7c75dc53bf0dbbbf3900a059d28df60ca2afa7f3fd88f6bf13f365a6f52a79b423d92496e5171df
+  metadata.gz: 79ae6274c9fe790e75ce17fc06b8f9d116dfee01d6a49e253fc685f4aa08736f0c4ace185250a038e5866c8fb02c539924935cb1429fe54e6f75b6a3082396aa
+  data.tar.gz: 9c0721c4f9be00b5cddba762a8869e1c7cfbc0ee7c1cd3c31e121551787529c99e6c9413af94c5c9f85c4337a258acd3e394f8495f7270b3f5afcb2ab94743b6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+<a name="2.1.0"></a>
+# 2.1.0
+## Features
+- Added option for singular resources - #187 (@jnfeinstein)
+- <code>configure</code> now returns the config object. - #176 (@poporul)
+
 <a name="2.0.0"></a>
 # 2.0.0
 ## Breaking Changes

data/README.md

@@ -107,6 +107,9 @@ class Encyclopedia extends Book
   @configure url: '/encyclopedias', name: 'encyclopedia'
 ````
 
+**NOTE:** Always call <code>@configure()</code> in subclasses, even when no configuration is required.
+This is important to prevent overriding the parent's configuration with interceptors, etc (especially when using a module mixin pattern).
+
 ##### JavaScript
 Since the purpose of exposing the RailsResource was to allow for CoffeeScript users to create classes from it the JavaScript way
 is basically just the same as the generated CoffeeScript code.  The <code>RailsResource.extendTo</code> function is a modification
@@ -126,7 +129,7 @@ Resource.configure(config);
 angular.module('book.controllers').controller('BookShelfCtrl', ['$scope', 'Book', function ($scope, Book) {
     $scope.searching = true;
     $scope.books = [];
-    
+
     // Find all books matching the title
     Book.query({ title: title }).then(function (results) {
         $scope.books = results;
@@ -208,6 +211,7 @@ defined on the resource can be called multiple times to adjust properties as nee
  * **updateMethod** *(optional)* - Allows overriding the default HTTP method (PUT) used for update.  Valid values are "post", "put", or "patch".
  * **serializer** *(optional)* - Allows specifying a custom [serializer](#serializers) to configure custom serialization options.
  * **fullResponse** *(optional)* - When set to true promises will return full $http responses instead of just the response data.
+ * **singular** - (Default: false) Treat this as a [singular resource](http://guides.rubyonrails.org/routing.html#singular-resources).
  * **interceptors** *(optional)* - See [Interceptors](#interceptors)
  * **extensions** *(optional)* - See [Extensions](#extensions)
 
@@ -442,7 +446,7 @@ The customizer function passed to the railsSerializer has available to it the fo
 
 * rename (javascriptName, jsonName) - Specifies a custom name mapping for an attribute.  On serializing to JSON the <code>jsonName</code> will be used.  On deserialization, if <code>jsonName</code> is seen then it will be renamed as javascriptName in the resulting resource.  Right now it is still passed to underscore so you could do 'publicationDate' -> 'releaseDate' and it will still underscore as release_date.  However, that may be changed to prevent underscore from breaking some custom name that it doesn't handle properly.
 
-* nestedAttribute (attributeName...) - This is a shortcut for rename that allows you to specify a variable number of attributes that should all be renamed to <code><name>_attributes</code> to work with the Rails nested_attributes feature.  This does not perform any additional logic to accomodate specifying the <code>_destroy</code> property.
+* nestedAttribute (attributeName...) - This is a shortcut for rename that allows you to specify a variable number of attributes that should all be renamed to <code><name>_attributes</code> to work with the Rails nested_attributes feature.  This does not perform any additional logic to accommodate specifying the <code>_destroy</code> property.
 
 * resource (attributeName, resource, serializer) - Specifies an attribute that is a nested resource within the parent object.  Nested resources do not imply nested attributes, if you want both you still have to specify call <code>nestedAttribute</code> as well.  A nested resource serves two purposes.  First, it defines the resource that should be used when constructing resources from the server.  Second, it specifies how the nested object should be serialized.  An optional third parameter <code>serializer</code> is available to override the serialization logic of the resource in case you need to serialize it differently in multiple contexts.
 
@@ -457,7 +461,7 @@ are also defined to expose underscore, camelize, and pluralize.  Those functions
 ## Interceptors
 The entire request / response processing is configured as a [$q promise chain](http://docs.angularjs.org/api/ng.$q).  Interceptors allow inserting additional synchronous or asynchronous processing at various phases in the request / response cycle.  The flexibility of the synchronous or asynchronous promise resolution allows any number of customizations to be built.  For instance, on response you could load additional data before returning that the current response is complete.  Or, you could listen to multiple phases and set a flag that a save operation is in progress in <code>beforeRequest</code> and then in <code>afterResponse</code> and <code>afterResponseError</code> you could clear the flag.
 
-Interceptors are similar in design to the $http interceptors.  You can add interceptors via the <code>RailsResource.addInterceptors</code> method or by explicitly adding them to the <code>interceptors</code> array on the on the resource <code>config</code> object.  When you add the interceptor, you can add it using either the interceptor service factory name or the object reference.  An interceptor should contain a set of keys representing one of the valid phases and the callback function for the phase.
+Interceptors are similar in design to the $http interceptors.  You can add interceptors via the <code>RailsResource.addInterceptor</code> method or by explicitly adding them to the <code>interceptors</code> array on the on the resource <code>config</code> object.  When you add the interceptor, you can add it using either the interceptor service factory name or the object reference.  An interceptor should contain a set of keys representing one of the valid phases and the callback function for the phase.
 
 There are several phases for both request and response to give users and mixins more flexibility for exactly where they want to insert a customization.  Each phase also has a corresponding error phase which is the phase name appended with Error (e.g. beforeResponse and beforeResponseError).  The error phases receive the current rejection value which in most cases would be the error returned from $http.  Since these are $q promises, your interceptor can decide whether or not to propagate the error or recover from it.  If you want to propagate the error, you must return a <code>$q.reject(reason)</code> result.  Otherwise any value you return will be treated as a successful value to use for the rest of the chain.  For instance, in the <code>beforeResponseError</code> phase you could attempt to recover by using an alternate URL for the request data and return the new promise as the result.
 

data/bower.json

@@ -1,6 +1,6 @@
 {
   "name": "angularjs-rails-resource",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "main": "angularjs-rails-resource.js",
   "description": "A resource factory inspired by $resource from AngularJS",
   "repository": {
@@ -8,7 +8,7 @@
     "url": "https://github.com/FineLinePrototyping/dist-angularjs-rails-resource.git"
   },
   "dependencies": {
-    "angular": "*"
+    "angular": "~1.0"
   },
   "ignore": [
     "node_modules",

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

@@ -1,7 +1,7 @@
 module Angularjs
   module Rails
     module Resource
-      VERSION = '2.0.0'
+      VERSION = '2.1.0'
     end
   end
 end

data/package.json

@@ -1,8 +1,8 @@
 {
   "name": "angularjs-rails-resource",
   "description" : "A resource factory inspired by $resource from AngularJS",
-  "version": "2.0.0",
-  "main" : "dist/angularjs-rails-resource.min.js",
+  "version": "2.1.0",
+  "main" : "angularjs-rails-resource.min.js",
   "homepage" : "https://github.com/FineLinePrototyping/angularjs-rails-resource.git",
   "author" : "",
   "repository": {
@@ -13,7 +13,9 @@
     "angular",
     "resources"
   ],
-  "dependencies": {},
+  "dependencies": {
+    "angular": "~1.0"
+  },
   "devDependencies": {
     "grunt": "~0.4.1",
     "grunt-contrib-jshint": "~0.6.0",

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

@@ -534,6 +534,11 @@ describe('railsResourceFactory', function () {
             expect(new Test({id: 1}).isNew()).toBeFalsy();
         });
 
+        it('configure should return config object', function() {
+          var Resource = factory();
+          expect(Resource.configure(config)).toBeInstanceOf(Object);
+        });
+
         describe('overridden idAttribute', function () {
             beforeEach(inject(function (_$httpBackend_, _$rootScope_, railsResourceFactory) {
                 Test = railsResourceFactory({url: '/test', name: 'test', idAttribute: 'xyz'});

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

@@ -22,6 +22,13 @@ describe("railsUrlBuilder", function () {
         })({id: 1})).toEqualData('/books/1');
     }));
 
+    it('should not append id when singular', inject(function (railsUrlBuilder) {
+        expect(railsUrlBuilder({
+          url: '/book',
+          singular: true
+        })()).toEqualData('/book');
+    }));
+
     it('should use author id for book list', inject(function (railsUrlBuilder) {
         expect(railsUrlBuilder({
           url: '/authors/{{authorId}}/books/{{id}}',

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

@@ -26,6 +26,7 @@
             defaultParams: undefined,
             underscoreParams: true,
             fullResponse: false,
+            singular: false,
             extensions: []
         };
 
@@ -243,6 +244,8 @@
                             mixin.configure(this.config, cfg);
                         }
                     }, this);
+
+                    return this.config;
                 };
 
                 /**

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

@@ -39,7 +39,7 @@
                 return url;
             }
 
-            if (url.indexOf($interpolate.startSymbol()) === -1) {
+            if (!config.singular && url.indexOf($interpolate.startSymbol()) === -1) {
                 url = url + '/' + $interpolate.startSymbol() + idAttribute + $interpolate.endSymbol();
             }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: angularjs-rails-resource
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Tommy Odom
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2016-03-20 00:00:00.000000000 Z
 dependencies: []
 description: A small AngularJS add-on for integrating with Rails via JSON more easily.
 email:
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: AngularJS add-on resource add-on for integrating with Rails