deep_unrest 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16cfa1baac8c2a73223981948c63a5573202ea22
-  data.tar.gz: 31f808c464f4b7c10470728d8a8f731afb2deca1
+  metadata.gz: f251e8aee5961ebae0a57cedf79dc6ce424dc2d4
+  data.tar.gz: a62e10cd9dfdc0f4e83dc31bef8d4bea68f5b479
 SHA512:
-  metadata.gz: 4592d731550af2ed983b9e520d3794abce76c706b372d95381942325b980a4359495a5b6ce14b281bbd733dbd3513f79f6a9276f1027668ed21377108bd91589
-  data.tar.gz: 420cf01968544730f6f1842986e2c9000dc1204c259d043a11b73e62c31346c81e61ed0b917e84134df94e4caeebd7b8e01a886c4fb5f6afa62eb91b78252175
+  metadata.gz: e009d9471f9661b9c178fe3f0f3fc1cbf936cfeda8c009ce24354e69dc289d56e67886433480dbb7b846a9d7c70b2b7d0f0d38612e4dbf247924e1b8b6272136
+  data.tar.gz: 6e577f6e6c8fb2ab6f5a5cf29d70d3255d52c9ab31644e124525acb8d497fe21212d1b5de918154d31dd7e88631c46463202bdb3c84425747e37a37d08cc0439

data/README.md

@@ -1,15 +1,21 @@
-# Deep UnREST
+<img src="/docs/img/logo.jpg" width="100%">
 
 [![CircleCI](https://circleci.com/gh/graveflex/deep_unrest.svg?style=svg)](https://circleci.com/gh/graveflex/deep_unrest)
 [![Test Coverage](https://codeclimate.com/repos/591cc05fbd15c32ce10014b4/badges/36013471f0d2c4c6f875/coverage.svg)](https://codeclimate.com/repos/591cc05fbd15c32ce10014b4/coverage)
 [![Code Climate](https://codeclimate.com/repos/591cc05fbd15c32ce10014b4/badges/36013471f0d2c4c6f875/gpa.svg)](https://codeclimate.com/repos/591cc05fbd15c32ce10014b4/feed)
 [![Issue Count](https://codeclimate.com/repos/591cc05fbd15c32ce10014b4/badges/36013471f0d2c4c6f875/issue_count.svg)](https://codeclimate.com/repos/591cc05fbd15c32ce10014b4/feed)
 
-<img src="/docs/img/logo.png" width="100%">
+## Goals
 
-Perform updates on deeply nested resources as well as bulk operations.
+* Allow updates and deletions of deeply nested resources
+* Allow bulk updates and deletions
+* Perform authorization on all affected resources
+* Control which params each user is allowed to update for each resource
+* Provide clear errors to the client
 
-## Goals
+## Caveats
+
+* This approach is not RESTful
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -49,12 +55,16 @@ $ bundle
       # config.get_user = proc { current_admin || current_user }
 
       # stategy that will be used to authorize the current user for each resource
-      self.authorization_strategy = DeepUnrest::Authorization::PunditStrategy
+      config.authorization_strategy = DeepUnrest::Authorization::PunditStrategy
     end
     ```
 
 ## Usage
 
+For the following examples, consider this data model:
+
+<img src="/docs/img/example-setup.jpg" width="100%">
+
 ### Example 1 - Simple Update:
 Update attributes on a single `Submission` with id `123`
 
@@ -103,7 +113,7 @@ within their policy scope.
 ```
 
 ##### 405 Response:
-This error will occur when a is allowed to update a resource, but not
+This error will occur when a user is allowed to update a resource, but not
 specified attributes of that resource.
 
 ```javascript
@@ -161,6 +171,7 @@ resource. The temporary ID should be surrounded in brackets (`[]`).
 ```javascript
 // PATCH /deep_unrest/update
 {
+  redirect: '/submissions/[1]',
   data: [
     {
       path: 'submissions[1]',
@@ -172,6 +183,24 @@ resource. The temporary ID should be surrounded in brackets (`[]`).
 }
 ```
 
+##### 200 Response:
+When a temp id (`[id]`) is present in the redirect url, the temp id will be
+replaced with the id given to the new resource. 
+
+Using the example above, assuming that the `Submission` at path
+`submissions[1]` was given the id `123`, the redirect request param of
+`/submissions/[1]` will be replaced with `/submissions/123`.
+
+```javascript
+{
+  id: 123,
+  type: 'submissions',
+  attributes: {
+    name: 'testing'
+  }
+}
+```
+
 ##### Create Errors:
 All errors regarding the new resource will use the temp ID as the path to the error.
 
@@ -192,7 +221,7 @@ example will perform the following operations:
 
 * Change the `name` column of `Submission` with id `123` to `test`
 * Change the `value` column of `Answer` with id `1` to `yes`
-* Create a new `Answer` with a value of `No` using temp ID `[1]`
+* Create a new `Answer` with a value of `no` using temp ID `[1]`
 * Delete the `Answer` with id `2`
 
 These operations will be performed within a single `ActiveRecord` transaction.
@@ -253,7 +282,7 @@ limited to the current user's allowed scope.
 ```
 
 ### Example 6 - Bulk Delete
-The following example will delete every submission.
+The following example will delete every `Submission`.
 
 When using an authorization strategy, the scope of the bulk delete will be
 limited to the current user's allowed scope.

data/app/controllers/deep_unrest/application_controller.rb

@@ -9,10 +9,10 @@ module DeepUnrest
 
     def update
       redirect = allowed_params[:redirect]
-      DeepUnrest.perform_update(allowed_params[:data],
-                                current_user)
+      redirect_replace = DeepUnrest.perform_update(allowed_params[:data],
+                                                   current_user)
       if redirect
-        redirect_to redirect
+        redirect_to redirect_replace.call(redirect)
       else
         render json: {}, status: 200
       end

data/lib/deep_unrest/version.rb

@@ -1,3 +1,3 @@
 module DeepUnrest
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/deep_unrest.rb

@@ -197,18 +197,14 @@ module DeepUnrest
     cursor
   end
 
-  def self.get_mutation_cursor(memo, cursor, addr, type, id, destroy)
+  def self.get_mutation_cursor(memo, cursor, addr, type, id, temp_id, scope_type)
     if memo
       cursor[addr] = [{}]
       next_cursor = cursor[addr][0]
     else
+      method = scope_type == :show ? :update : scope_type
       cursor = {}
       type_sym = type.to_sym
-      if destroy
-        method = id ? :update : :destroy_all
-      else
-        method = id ? :update : :update_all
-      end
       klass = to_class(type)
       body = {}
       body[klass.primary_key.to_sym] = id if id
@@ -221,6 +217,7 @@ module DeepUnrest
         method: method,
         body: body
       }
+      cursor[type_sym][:operations][id][method][:temp_id] = temp_id if temp_id
       memo = cursor
       next_cursor = cursor[type_sym][:operations][id][method][:body]
     end
@@ -238,8 +235,16 @@ module DeepUnrest
     type, id_str = rest.shift
     addr = to_update_body_key(type)
     id = parse_id(id_str)
+    scope_type = get_scope_type(id_str, rest.blank?, op[:destroy])
+    temp_id = scope_type == :create ? id_str : nil
 
-    memo, next_cursor = get_mutation_cursor(memo, cursor, addr, type, id, op[:destroy])
+    memo, next_cursor = get_mutation_cursor(memo,
+                                            cursor,
+                                            addr,
+                                            type,
+                                            id,
+                                            temp_id,
+                                            scope_type)
 
     next_cursor[:id] = id if id
     build_mutation_fragment(op, user, rest, memo, next_cursor, type)
@@ -255,22 +260,28 @@ module DeepUnrest
     mutation.map do |_, item|
       item[:operations].map do |id, ops|
         ops.map do |_, action|
-          case action[:method]
-          when :update_all
-            DeepUnrest.authorization_strategy
-                      .get_authorized_scope(user, item[:klass])
-                      .update(action[:body])
-            nil
-          when :destroy_all
-            DeepUnrest.authorization_strategy
-                      .get_authorized_scope(user, item[:klass])
-                      .destroy_all
-            nil
-          when :update
-            item[:klass].update(id, action[:body])
-          when :create
-            item[:klass].create(action[:body])
+          record = case action[:method]
+                   when :update_all
+                     DeepUnrest.authorization_strategy
+                               .get_authorized_scope(user, item[:klass])
+                               .update(action[:body])
+                     nil
+                   when :destroy_all
+                     DeepUnrest.authorization_strategy
+                               .get_authorized_scope(user, item[:klass])
+                               .destroy_all
+                     nil
+                   when :update
+                     item[:klass].update(id, action[:body])
+                   when :create
+                     item[:klass].create(action[:body])
+                   end
+          result = { record: record }
+          if action[:temp_id]
+            result[:temp_ids] = {}
+            result[:temp_ids][action[:temp_id]] = record.id
           end
+          result
         end
       end
     end
@@ -307,6 +318,19 @@ module DeepUnrest
     end.flatten
   end
 
+  def self.build_redirect_regex(replacements)
+    replacements ||= []
+
+    replace_ops = replacements.map do |k, v|
+      proc { |str| str.sub(k.to_s, v.to_s) }
+    end
+
+    proc do |str|
+      replace_ops.each { |op| str = op.call(str) }
+      str
+    end
+  end
+
   def self.perform_update(params, user)
     # identify requested scope(s)
     scopes = collect_all_scopes(params)
@@ -321,13 +345,18 @@ module DeepUnrest
     results = mutate(mutations, user).flatten
 
     # check results for errors
-    errors = results.compact
+    errors = results.map { |res| res[:record] }
+                    .compact
                     .map(&:errors)
                     .map(&:messages)
                     .reject(&:empty?)
                     .compact
-
-    return if errors.empty?
+    if errors.empty?
+      temp_ids = results.map { |res| res[:temp_ids] }
+                        .compact
+                        .each_with_object({}) { |item, mem| mem.merge!(item) }
+      return build_redirect_regex(temp_ids)
+    end
 
     # map errors to their sources
     formatted_errors = { errors: map_errors_to_param_keys(scopes, errors) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deep_unrest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Lynn Hurley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-17 00:00:00.000000000 Z
+date: 2017-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails