grape-swagger-entity 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41afe8433047f9b998351967b5e2ecf4809413c1f622125c70b860c5bbf11a43
-  data.tar.gz: 60e644e6a03258aa4284c348cd486b49027f21558c52805f49a8b08316d5d6bb
+  metadata.gz: 4c6aad956f868bcf6563b52eaaf6347b821fe06a63153324e299562857418dc3
+  data.tar.gz: 04ffc54b6c66cb328e7687aac44f9140f0891ab74c3fab05463bda4a43f02f41
 SHA512:
-  metadata.gz: b16ce2ac2fe5e37c7d67cb5113a0870bcd43dc7addc92b54d983cd8e7f6bb599ea7ab3b13f251eac92d2039ecc120a641eab6b18a256294550f26812247b3e12
-  data.tar.gz: f28eb0a4058f2e007e72acdc38746fa0c8cd72bd46927a1f9519a351c45c9a81124aede349a2780faed8619a0bc1cb95b9be720a2fe782b571fb827380c473dc
+  metadata.gz: e4e6cd881f3c194a10beb6489b295ecc0d3168479935c4402922d4e4f9358686c3aa2d3df1023e99114710c14efa9685d8f5b1792558538f680721d77d7b8177
+  data.tar.gz: 5090a6ae14257708c383c10b858b6c89ba21e54fd5a873dfe10dcd1873b1aac125b3d4be4ad0c055778461859b91c18c2505607ecbd4552384c1a0f01ce46033

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.ruby-gemset
+.ruby-version

data/.rubocop.yml

@@ -21,5 +21,5 @@ Metrics/MethodLength:
 Naming/FileName:
   Enabled: false
 
-Layout/IndentHash:
+Layout/IndentFirstHashElement:
   EnforcedStyle: consistent

data/.travis.yml

@@ -10,18 +10,19 @@ after_success:
   - bundle exec danger
 
 rvm:
-  - 2.4.2
-  - 2.3.5
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
 
 env:
-  - GRAPE_ENTITY=0.5.2
   - GRAPE_ENTITY=0.6.1
+  - GRAPE_ENTITY=0.7.1
 
 matrix:
   fast_finish: true
 
   include:
-    - rvm: 2.2.8
+    - rvm: 2.3.8
       env:
     - rvm: ruby-head
       env:
@@ -31,7 +32,7 @@ matrix:
       env:
 
   allow_failures:
-    - rvm: 2.2.8
+    - rvm: 2.3.8
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: rbx-2

data/CHANGELOG.md

@@ -8,6 +8,41 @@
 
 * Your contribution here.
 
+### 0.5.0 (June 29, 2020)
+
+#### Features
+
+* [#50](https://github.com/ruby-grape/grape-swagger-entity/pull/50): Features/inheritance and discriminator - [@MaximeRDY](https://github.com/MaximeRDY).
+
+### 0.4.0 (May 30, 2020)
+
+#### Features
+
+* [#49](https://github.com/ruby-grape/grape-swagger-entity/pull/49): Bumped minimal required version of grape-swagger to 1.0.0 - [@Bugagazavr](https://github.com/Bugagazavr).
+* [#48](https://github.com/ruby-grape/grape-swagger-entity/pull/48): Add support for extensions - [@MaximeRDY](https://github.com/MaximeRDY).
+
+#### Fixes
+
+* [#46](https://github.com/ruby-grape/grape-swagger-entity/pull/46): Fixed issue where a boolean example value of false would not display in swagger file - [@drewnichols](https://github.com/drewnichols).
+
+### 0.3.4 (January 9, 2020)
+
+#### Features
+
+* [#40](https://github.com/ruby-grape/grape-swagger-entity/pull/40): Add support for minLength and maxLength - [@fotos](https://github.com/fotos).
+
+### 0.3.3 (Fabruary 22, 2019)
+
+#### Features
+
+* [#39](https://github.com/ruby-grape/grape-swagger-entity/pull/39): Fix to avoid conflict with polymorphic model - [@kinoppyd](https://github.com/kinoppyd).
+
+### 0.3.2 (January 15, 2019)
+
+#### Features
+
+* [#38](https://github.com/ruby-grape/grape-swagger-entity/pull/38): Added support for hidden option for documentation - [@vitoravelino](https://github.com/vitoravelino).
+
 ### 0.3.1 (November 26, 2018)
 
 #### Features

data/Gemfile

@@ -13,10 +13,10 @@ group :development, :test do
   gem 'rake'
   gem 'rdoc'
   gem 'rspec', '~> 3.0'
-  gem 'rubocop', '~> 0.48'
+  gem 'rubocop', '~> 0.68.1'
 end
 
-gem 'grape-swagger', git: 'https://github.com/ruby-grape/grape-swagger.git'
+gem 'grape-swagger', path: '../grape-swagger'
 
 group :test do
   gem 'grape-entity', ENV.fetch('GRAPE_ENTITY', '0.6.1')

data/README.md

@@ -26,7 +26,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grape-swagger-entity.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby-grape/grape-swagger-entity.
 
 ## License
 

data/grape-swagger-entity.gemspec

@@ -19,5 +19,5 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.2.6'
   s.add_runtime_dependency 'grape-entity', '>= 0.5.0'
-  s.add_runtime_dependency 'grape-swagger', '>= 0.31.0'
+  s.add_runtime_dependency 'grape-swagger', '>= 1.4.0'
 end

data/lib/grape-swagger/entity.rb

@@ -2,6 +2,7 @@ require 'grape-swagger'
 require 'grape-entity'
 
 require 'grape-swagger/entity/version'
+require 'grape-swagger/entity/helper'
 require 'grape-swagger/entity/attribute_parser'
 require 'grape-swagger/entity/parser'
 

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

@@ -12,7 +12,7 @@ module GrapeSwagger
         entity_model = model_from(entity_options)
 
         if entity_model
-          name = endpoint.nil? ? entity_model.to_s.demodulize : endpoint.send(:expose_params_from_model, entity_model)
+          name = GrapeSwagger::Entity::Helper.model_name(entity_model, endpoint)
 
           entity_model_type = entity_model_type(name, entity_options)
           return entity_model_type unless documentation
@@ -24,8 +24,8 @@ module GrapeSwagger
           param = data_type_from(entity_options)
           return param unless documentation
 
-          param[:default] = documentation[:default] if documentation[:default]
-          add_attribute_example(param, documentation[:example])
+          add_attribute_sample(param, documentation, :default)
+          add_attribute_sample(param, documentation, :example)
 
           if (values = documentation[:values])
             param[:enum] = values if values.is_a?(Array)
@@ -36,6 +36,10 @@ module GrapeSwagger
             add_array_documentation(param, documentation)
           end
 
+          add_attribute_documentation(param, documentation)
+
+          add_extension_documentation(param, documentation)
+          add_discriminator_extension(param, documentation)
           param
         end
       end
@@ -103,10 +107,16 @@ module GrapeSwagger
         end
       end
 
-      def add_attribute_example(attribute, example)
-        return unless example
+      def add_attribute_sample(attribute, hash, key)
+        value = hash[key]
+        return if value.nil?
+
+        attribute[key] = value.is_a?(Proc) ? value.call : value
+      end
 
-        attribute[:example] = example.is_a?(Proc) ? example.call : example
+      def add_attribute_documentation(param, documentation)
+        param[:minLength] = documentation[:min_length] if documentation.key?(:min_length)
+        param[:maxLength] = documentation[:max_length] if documentation.key?(:max_length)
       end
 
       def add_array_documentation(param, documentation)
@@ -114,6 +124,14 @@ module GrapeSwagger
         param[:maxItems] = documentation[:max_items] if documentation.key?(:max_items)
         param[:uniqueItems] = documentation[:unique_items] if documentation.key?(:unique_items)
       end
+
+      def add_extension_documentation(param, documentation)
+        GrapeSwagger::DocMethods::Extensions.add_extensions_to_root(documentation, param)
+      end
+
+      def add_discriminator_extension(param, documentation)
+        param[:documentation] = { is_discriminator: true } if documentation.key?(:is_discriminator)
+      end
     end
   end
 end

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

@@ -0,0 +1,36 @@
+module GrapeSwagger
+  module Entity
+    # Helper methods for DRY
+    class Helper
+      class << self
+        def model_name(entity_model, endpoint)
+          if endpoint.nil?
+            entity_model.to_s.demodulize
+          else
+            endpoint.send(:expose_params_from_model, entity_model)
+          end
+        end
+
+        def discriminator(entity_model)
+          entity_model.superclass.root_exposures.detect do |value|
+            value.documentation.dig(:is_discriminator)
+          end
+        end
+
+        def root_exposures_without_parent(entity_model)
+          entity_model.root_exposures.select do |value|
+            entity_model.superclass.root_exposures.find_by(value.attribute).nil?
+          end
+        end
+
+        def root_exposure_with_discriminator(entity_model)
+          if discriminator(entity_model)
+            root_exposures_without_parent(entity_model)
+          else
+            entity_model.root_exposures
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,15 +17,24 @@ module GrapeSwagger
 
       private
 
+      class Alias
+        attr_reader :original, :renamed
+        def initialize(original, renamed)
+          @original = original
+          @renamed = renamed
+        end
+      end
+
       def extract_params(exposure)
-        exposure.root_exposures.each_with_object({}) do |value, memo|
+        GrapeSwagger::Entity::Helper.root_exposure_with_discriminator(exposure).each_with_object({}) do |value, memo|
           if value.for_merge && (value.respond_to?(:entity_class) || value.respond_to?(:using_class_name))
             entity_class = value.respond_to?(:entity_class) ? value.entity_class : value.using_class_name
 
             extracted_params = extract_params(entity_class)
             memo.merge!(extracted_params)
           else
-            memo[value.attribute] = value.send(:options)
+            opts = value.send(:options)
+            opts[:as] ? memo[Alias.new(value.attribute, opts[:as])] = opts : memo[value.attribute] = opts
           end
         end
       end
@@ -34,8 +43,12 @@ module GrapeSwagger
         return unless params
 
         parsed = params.each_with_object({}) do |(entity_name, entity_options), memo|
-          next if entity_options.fetch(:documentation, {}).fetch(:in, nil).to_s == 'header'
+          documentation_options = entity_options.fetch(:documentation, {})
+          in_option = documentation_options.fetch(:in, nil).to_s
+          hidden_option = documentation_options.fetch(:hidden, nil)
+          next if in_option == 'header' || hidden_option == true
 
+          entity_name = entity_name.original if entity_name.is_a?(Alias)
           final_entity_name = entity_options.fetch(:as, entity_name)
           documentation = entity_options[:documentation]
 
@@ -51,7 +64,39 @@ module GrapeSwagger
           memo[final_entity_name][:description] = documentation[:desc] if documentation[:desc]
         end
 
-        [parsed, required_params(params)]
+        discriminator = GrapeSwagger::Entity::Helper.discriminator(model)
+        if discriminator
+          respond_with_all_of(parsed, params, discriminator)
+        else
+          [parsed, required_params(params)]
+        end
+      end
+
+      def respond_with_all_of(parsed, params, discriminator)
+        parent_name = GrapeSwagger::Entity::Helper.model_name(model.superclass, endpoint)
+
+        {
+          allOf: [
+            {
+              '$ref' => "#/definitions/#{parent_name}"
+            },
+            [
+              add_discriminator(parsed, discriminator),
+              required_params(params).push(discriminator.attribute)
+            ]
+          ]
+        }
+      end
+
+      def add_discriminator(parsed, discriminator)
+        model_name = GrapeSwagger::Entity::Helper.model_name(model, endpoint)
+
+        parsed.merge(
+          discriminator.attribute => {
+            type: 'string',
+            enum: [model_name]
+          }
+        )
       end
 
       def parse_nested(entity_name, entity_options, parent_model = nil)

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

@@ -1,5 +1,5 @@
 module GrapeSwagger
   module Entity
-    VERSION = '0.3.1'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-entity
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Kirill Zaitsev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-26 00:00:00.000000000 Z
+date: 2020-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape-entity
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.31.0
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.31.0
+        version: 1.4.0
 description: 
 email:
 - kirik910@gmail.com
@@ -62,6 +62,7 @@ files:
 - lib/grape-swagger-entity.rb
 - lib/grape-swagger/entity.rb
 - lib/grape-swagger/entity/attribute_parser.rb
+- lib/grape-swagger/entity/helper.rb
 - lib/grape-swagger/entity/parser.rb
 - lib/grape-swagger/entity/version.rb
 homepage: https://github.com/ruby-grape/grape-swagger-entity
@@ -83,8 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Grape swagger adapter to support grape-entity object parsing