swagger_docs_generator 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4865b66e1c00a693efc1317fc20c5316ae0c79b1
-  data.tar.gz: 2879ea237543e72400290c110ebd170f3b2de996
+  metadata.gz: b1acc55b2ce3bf7a00dd5181f202f40639ee86ae
+  data.tar.gz: baba1e428c1cf9df4195ff207cda25e94eab922a
 SHA512:
-  metadata.gz: 43259622754f69a0e47dc738e36eaa74073f168144fc88370c0aca8bfb6d5865f2f143b3082ba53d624903981948526f87a0a0a8b7a8645edd50ef2bef954b05
-  data.tar.gz: 69dc7294338367895d79f11c6909db5f8735b4ce631787e11ceec29643782c60d6f8dc5a7d8b44a05f48bce0db05af09e02eba6cae5c4dcfbbd5fe272fa93ca6
+  metadata.gz: 93ea4e3b522dcf2d842f20a9a7f90ba809566abe4f1b63d7e93d3942310c2c6b95446402b71957a1c845f3f53ad121aa94e9e4358c945f8bb62d24424ee2eee1
+  data.tar.gz: ae86e26cf7d4a46915ca71d290c6b929f92bef02da20252bfc9d1cc17ef3fbcd431ac97b43b2cd72ced90eb8fabf84c866c8337395a627577be87b66b051cbc2

data/README.md

@@ -52,6 +52,104 @@ Execute rake task for generated `swagger.json` :
 rake swagger:docs
 ```
 
+
+## Examples
+
+```ruby
+# frozen_string_literal: true
+
+module V1
+  # Documentation API for AddressesController
+  class AddressesDoc < BaseDoc
+    CONTROLLER = V1::Geos::AddressesController
+
+    # Describe object Addresses
+    # ###
+    scontroller 'User Addresses management'
+
+    # Describe all actions
+    # ###
+    sdoc :show do
+      summary 'Show address'
+      responses do
+        status 200
+        schema { definition 'address' }
+      end
+      responses { status 404 }
+      responses { status 422 }
+      description <<EOS
+  # Show address to user
+
+  Show complete address to user.
+EOS
+    end
+
+    sdoc :create do
+      summary 'Create address'
+      responses { status 201 }
+      responses { status 422 }
+      parameters do
+        body do
+          name 'address'
+          schema 'address create'
+        end
+      end
+      description <<EOS
+  # Add address
+
+  Save an address to user.
+EOS
+    end
+
+    sdoc :update do
+      summary 'Update address'
+      responses do
+        status 200
+        schema { definition 'address' }
+      end
+      responses { status 404 }
+      responses { status 422 }
+    end
+
+    sdoc :destroy do
+      summary 'Destroy address'
+      responses do
+        status 200
+        schema { definition 'address' }
+      end
+      responses { status 404 }
+      responses { status 422 }
+    end
+
+    # Add definition more model
+    # ###
+    sdefinition 'address create' do
+      required %w[address]
+      properties do
+        required %w{country city zip_code street}
+        properties country: { type: :string },
+                   city: { type: :string },
+                   zip_code: { type: :string },
+                   street: { type: :string },
+                   complements: { type: :string }
+      end
+    end
+
+    sdefinition 'address' do
+      required %w[address]
+      properties do
+        properties country: { type: :string },
+                   city: { type: :string },
+                   zip_code: { type: :string },
+                   street: { type: :string },
+                   complements: { type: :string },
+                   coordinates: { type: :string }
+      end
+    end
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then,

data/lib/swagger_docs_generator/info.rb

@@ -5,7 +5,7 @@ module SwaggerDocsGenerator
   # Name to gem
   GEM =           'swagger_docs_generator'
   # Version to gem
-  VERSION =       '0.3.6'
+  VERSION =       '0.4.0'
   # Authors contributed to gem
   AUTHORS =       ['VAILLANT Jeremy'].freeze
   # Email to ahuthors

data/lib/swagger_docs_generator/parser/definition.rb

@@ -27,8 +27,12 @@ module SwaggerDocsGenerator
       @type = text
     end
 
-    def properties(text)
-      @properties = text
+    def properties(text = nil, &block)
+      @properties = if block_given?
+                      { @required.first => SubProperties.new(&block).construct }
+                    else
+                      text
+                    end
     end
 
     def required(text)
@@ -52,3 +56,5 @@ module SwaggerDocsGenerator
     end
   end
 end
+
+require 'swagger_docs_generator/parser/sub_definition'

data/lib/swagger_docs_generator/parser/sub_definition.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# :reek:InstanceVariableAssumption
+module SwaggerDocsGenerator
+  # # Parse Controller classes
+  #
+  # Parse controller classes in Rails application. It's create temporary file
+  # and adding automaticaly tags element.
+  class SubProperties < ParserDefinition
+    def initialize(&block)
+      instance_eval(&block)
+    end
+
+    def construct
+      {
+        type: @type || 'object',
+        required: @required || [],
+        properties: @properties
+      }
+    end
+
+    private
+
+    def properties(text)
+      @properties = text
+    end
+
+    def type
+      'object'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger_docs_generator
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - VAILLANT Jeremy
@@ -272,6 +272,7 @@ files:
 - lib/swagger_docs_generator/parser/definition.rb
 - lib/swagger_docs_generator/parser/model.rb
 - lib/swagger_docs_generator/parser/parser.rb
+- lib/swagger_docs_generator/parser/sub_definition.rb
 - lib/swagger_docs_generator/railtie.rb
 - lib/tasks/swagger.rake
 - spec/spec_helper.rb