grape-swagger-entity 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4765712e8fa51a31cb4cde4e6cb6c67e2863f3cb
-  data.tar.gz: 2012ba6b40ad94a02afc087e8ddcfe9a2fb341f1
+  metadata.gz: dc998b981e77b49cc07ee0c8556ae90cd9039e7f
+  data.tar.gz: b41b339f7804f2b95234a72da9db8d8545a54e78
 SHA512:
-  metadata.gz: bc1f438ae665e682e20603cd9c1693dce8fc41c243b49706aa4939d0c75034f251e6516329a66ac2dbdb09962ab214dc4411ede6e3d72b05b9cc7aec58c92328
-  data.tar.gz: 467778758de82752d19f383bd9be651d06cd6116850ec8d71a21f79e337b822531b49bafbc8d4718940ed3d3b900eaa411cb3c7bb65058c993b65be4c404b3ac
+  metadata.gz: 040cebbf6a2a1a884d2a767655c61c4255d298a5e78212131a8fd70e576f332480cb5e4417660162e8cfabebf63abad6e265f166a330a1b2e7228ce33113abbf
+  data.tar.gz: 304e5f306ab9e0cfd43fb293c0604d88db110790ab6aa262d50ce27dafa9e320695bcb9a55083d5b734578b2f7e9273f28375bd0195ae91ca6bc957fe2764aa8

data/.travis.yml

@@ -1,3 +1,7 @@
+language: ruby
+
+sudo: false
+
 before_install:
   - gem update --system
   - gem install bundler
@@ -6,9 +10,8 @@ after_success:
   - bundle exec danger
 
 rvm:
-  - 2.4.0
-  - 2.3.3
-  - 2.2.6
+  - 2.4.2
+  - 2.3.5
 
 env:
   - GRAPE_ENTITY=0.5.2
@@ -18,6 +21,8 @@ matrix:
   fast_finish: true
 
   include:
+    - rvm: 2.2.8
+      env:
     - rvm: ruby-head
       env:
     - rvm: jruby-head
@@ -26,6 +31,7 @@ matrix:
       env:
 
   allow_failures:
+    - rvm: 2.2.8
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: rbx-2

data/CHANGELOG.md

@@ -8,6 +8,13 @@
 
 * Your contribution here.
 
+### 0.2.3 (November 19, 2017)
+
+#### Fixes
+
+* [#30](https://github.com/ruby-grape/grape-swagger-entity/pull/30): Fix nested exposures with an alias - [@Kukunin](https://github.com/Kukunin).
+* [#31](https://github.com/ruby-grape/grape-swagger-entity/pull/31): Respect `required: true` for nested attributes as well - [@Kukunin](https://github.com/Kukunin).
+
 ### 0.2.2 (November 3, 2017)
 
 #### Features

data/lib/grape-swagger/entity/parser.rb

@@ -27,19 +27,20 @@ module GrapeSwagger
         params.each_with_object({}) do |(entity_name, entity_options), memo|
           next if entity_options.fetch(:documentation, {}).fetch(:in, nil).to_s == 'header'
 
-          entity_name = entity_options[:as] if entity_options[:as]
+          final_entity_name = entity_options.fetch(:as, entity_name)
           documentation = entity_options[:documentation]
 
-          memo[entity_name] = if entity_options[:nesting]
-                                parse_nested(entity_name, entity_options, parent_model)
-                              else
-                                attribute_parser.call(entity_options)
-                              end
+          memo[final_entity_name] = if entity_options[:nesting]
+                                      parse_nested(entity_name, entity_options, parent_model)
+                                    else
+                                      attribute_parser.call(entity_options)
+                                    end
 
-          if documentation
-            memo[entity_name][:read_only] = documentation[:read_only].to_s == 'true' if documentation[:read_only]
-            memo[entity_name][:description] = documentation[:desc] if documentation[:desc]
+          next unless documentation
+          if documentation[:read_only]
+            memo[final_entity_name][:read_only] = documentation[:read_only].to_s == 'true'
           end
+          memo[final_entity_name][:description] = documentation[:desc] if documentation[:desc]
         end
       end
 
@@ -54,6 +55,8 @@ module GrapeSwagger
           memo[value.attribute] = value.send(:options)
         end
 
+        required = required_params(params)
+
         properties = parse_grape_entity_params(params, nested_entity)
         is_a_collection = entity_options[:documentation].is_a?(Hash) &&
                           entity_options[:documentation][:type].to_s.casecmp('array').zero?
@@ -61,20 +64,30 @@ module GrapeSwagger
         if is_a_collection
           {
             type: :array,
-            items: {
+            items: with_required({
               type: :object,
               properties: properties
-            },
-            description: entity_options[:desc] || ''
+            }, required)
           }
         else
-          {
+          with_required({
             type: :object,
-            properties: properties,
-            description: entity_options[:desc] || ''
-          }
+            properties: properties
+          }, required)
         end
       end
+
+      def required_params(params)
+        params.select { |_, options| options.fetch(:documentation, {}).fetch(:required, false) }
+              .map { |(key, options)| [options.fetch(:as, key), options] }
+              .map(&:first)
+      end
+
+      def with_required(hash, required)
+        return hash if required.empty?
+        hash[:required] = required
+        hash
+      end
     end
   end
 end

data/lib/grape-swagger/entity/version.rb

@@ -1,5 +1,5 @@
 module GrapeSwagger
   module Entity
-    VERSION = '0.2.2'.freeze
+    VERSION = '0.2.3'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-entity
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Kirill Zaitsev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-03 00:00:00.000000000 Z
+date: 2017-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape-entity