introspective_grape 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83d87bcd4a1b094140084f652e87311d763b4259
-  data.tar.gz: ad9cc7c59b4675a4b105e656c3bc82e7a6db2b45
+  metadata.gz: f52e3f6200f277c190a76450e09f65c582a9e56d
+  data.tar.gz: f2779c6afdfa697bc4d051d3ab461d9afcb91e6f
 SHA512:
-  metadata.gz: d1e241e2e6b14512efe1b3da193f3a382def1c7a953dc9790d4b6680f68b1168b2397d45be5a09e2641eb7b5e5a392f31e42a37148aec9e394e40a176c25b8cf
-  data.tar.gz: aa769217ebffabc67b73732108c7e56c77482e6bd48a6ff8b929f35bfd3491f99ea3881b08f2c02e8534957add7941687a47b7bf81db5b5a4963df7e86d588da
+  metadata.gz: fc38af247ee9f040212122583701537567fc3a6551339c35034f88a0edef5acea6ed79b020fb7d5f3d16dddcc299bd12b882870d1a90826220bf00b6d8bfbb51
+  data.tar.gz: 08b47cd609c1501a9eeeb4293d5dc3dee9a97028c814aef22a9930f543ba529439358258f2b75a0f7af0d00597d5b73fb6d58ed57738683b6f7c397f384296e9

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 
+0.2.5 10/28/2016
+==============
+
+### Bug Fix
+
+Include the nested model IDs in the swagger doc.
+
 0.2.4 10/26/2016
 ==============
 

data/lib/introspective_grape/api.rb

@@ -204,7 +204,7 @@ module IntrospectiveGrape
           detail klass.create_documentation || "creates a new #{name} record"
         end
         dsl.params do
-          klass.generate_params(self, klass, :create, model, api_params)
+          klass.generate_params(self, :create, model, api_params, true)
         end
         dsl.post do
           if @model
@@ -225,7 +225,7 @@ module IntrospectiveGrape
           detail klass.update_documentation || "updates the details of a #{name}"
         end
         dsl.params do
-          klass.generate_params(self, klass, :update, model, api_params)
+          klass.generate_params(self, :update, model, api_params, true)
         end
         dsl.put ":#{routes.last.swaggerKey}" do
           authorize @model, :update?
@@ -316,35 +316,36 @@ module IntrospectiveGrape
 
 
 
-      def generate_params(dsl, klass, action, model, fields)
+      def generate_params(dsl, action, model, fields, is_root_endpoint=false)
         # We'll be doing a recursive walk (to handle nested attributes) down the
         # whitelisted params, generating the Grape param definitions by introspecting
         # on the model and its associations.
         raise "Invalid action: #{action}" unless [:update, :create].include?(action)
         # dsl   : The Grape::Validations::ParamsScope object
-        # klass : A reference back to the original descendant of IntrospectiveGrape::API.
-        #         You have to pass this around to remember who you were before the DSL
-        #         scope hijacked your identity.
         # action: create or update
         # model : The ActiveRecord model class
         # fields: The whitelisted data structure for Rails' strong params, from which we
         #         infer Grape's parameters
+        
+        # skip the ID param at the root level endpoint, so we don't duplicate the URL parameter (api/v#/model/modelId)
+        fields -= [:id] if is_root_endpoint
 
-        (fields-[:id]).each do |field|
+        fields.each do |field|
           if field.kind_of?(Hash)
-            generate_nested_params(dsl,klass,action,model,field)
-          elsif (action==:create && klass.param_required?(model,field) )
+            generate_nested_params(dsl,action,model,field)
+          elsif (action==:create && param_required?(model,field) )
             # All params are optional on an update, only require them during creation.
             # Updating a record with new child models will have to rely on ActiveRecord
             # validations:
-            dsl.requires field, type: klass.param_type(model,field)
+            dsl.requires field, type: param_type(model,field)
           else
-            dsl.optional field, type: klass.param_type(model,field)
+            dsl.optional field, type: param_type(model,field)
           end
         end
       end
 
-      def generate_nested_params(dsl,klass,action,model,fields)
+      def generate_nested_params(dsl,action,model,fields)
+        klass = self
         fields.each do |r,v|
           # Look at model.reflections to find the association's class name:
           reflection = r.to_s.sub(/_attributes$/,'') # the reflection name
@@ -360,7 +361,7 @@ module IntrospectiveGrape
             # In case you need a refresher on how these work:
             # http://api.rubyonrails.org/classes/ActiveRecord/NestedAttributes/ClassMethods.html
             dsl.optional r, type: Array do |dl|
-              klass.generate_params(dl,klass,action,relation,v)
+              klass.generate_params(dl,action,relation,v)
               klass.add_destroy_param(dl,model,reflection) unless action==:create
             end
           else
@@ -369,7 +370,7 @@ module IntrospectiveGrape
             # ThroughReflection, HasOneReflection,
             # HasAndBelongsToManyReflection, BelongsToReflection
             dsl.optional r, type: Hash do |dl|
-              klass.generate_params(dl,klass,action,relation,v)
+              klass.generate_params(dl,action,relation,v)
               klass.add_destroy_param(dl,model,reflection) unless action==:create
             end
           end

data/lib/introspective_grape/version.rb

@@ -1,3 +1,3 @@
 module IntrospectiveGrape
-  VERSION = "0.2.4".freeze
+  VERSION = "0.2.5".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: introspective_grape
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Josh Buermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-27 00:00:00.000000000 Z
+date: 2016-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails