zero-rails_openapi 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b90e9497b858c621362ea5413020a64bdbd59de
-  data.tar.gz: '067410229fdc842e1d2f65e3cf4fbb9482535044'
+  metadata.gz: 5c0a2065e4a332132fafda9c0b20dc1f10a87ba0
+  data.tar.gz: 8e232f1841f6489ec5fba6e9c3aaf56e0314e416
 SHA512:
-  metadata.gz: eefc1f9b19e39b1a7aee1f9817c9860da02b77f4feb94a22a72fa8dd11739e9e9b1cda3d23404bfeaefbeba9fd3a9cd2c06898f92a31f14c60eae3c1788b5b61
-  data.tar.gz: 1d5bf3b31a7e8ed246e50ecd63f869c0913185a0eb31c95490d32163f48ff5c0eba8e744ce4ec234ad72ff8821e3f246b515d0cec473cb3d4269eaf9c8bf11f5
+  metadata.gz: 24baf84b60c4e2b4a846d5284b34fef596444d1ee90f35fa537d2de87af6b7e35999b44e780db9fbd1a8450675bfe558d9b2d77a51774f120d8133d2fef08f8a
+  data.tar.gz: c238aa68acdc0be8a9d7c3482828ab7feedc69088161622bace745b801111bc28184a9a0612ccb774b5c6accf630e3258c86c88cf160a0e2ee9534544ddc2655

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zero-rails_openapi (1.1.0)
+    zero-rails_openapi (1.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -14,16 +14,16 @@ but I dont have enough time now = ▽ =
 
 ## Table of Contents
 
-- [About OAS](https://github.com/zhandao/zero-rails_openapi#about-oas) (OpenAPI Specification)
-- [Installation](https://github.com/zhandao/zero-rails_openapi#installation)
-- [Configure](https://github.com/zhandao/zero-rails_openapi#configure)
-- [Usage](https://github.com/zhandao/zero-rails_openapi#usage)
-  - [DSL for documenting your controller](https://github.com/zhandao/zero-rails_openapi#dsl-for-documenting-your-controller)
-  - [Generate JSON Documentation File](https://github.com/zhandao/zero-rails_openapi#generate-json-documentation-file)
-  - [Use Swagger UI(very beautiful web page) to show your Documentation](https://github.com/zhandao/zero-rails_openapi#use-swagger-uivery-beautiful-web-page-to-show-your-documentation)
+- [About OAS](#about-oas) (OpenAPI Specification)
+- [Installation](#installation)
+- [Configure](#configure)
+- [Usage](#usage)
+  - [DSL for documenting your controller](#dsl-for-documenting-your-controller)
+  - [Generate JSON Documentation File](#generate-json-documentation-file)
+  - [Use Swagger UI(very beautiful web page) to show your Documentation](#use-swagger-uivery-beautiful-web-page-to-show-your-documentation)
   - [Tricks](#tricks)
-    - [Write the DSL Somewhere Else]
-- [Troubleshooting](https://github.com/zhandao/zero-rails_openapi#troubleshooting)
+    - [Write the DSL Somewhere Else](#write-the-dsl-somewhere-else)
+- [Troubleshooting](#troubleshooting)
 
 ## About OAS
 
@@ -161,9 +161,9 @@ end
   ctrl_path 'api/v1/examples'
   ```
   This option allows you to set the Tag* (which is a node of [OpenApi Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#openapi-object)).  
-  [Here's a trick](): Using `ctrl_path`, you can write the DSL somewhere else 
+  [Here's a trick](#write-the-dsl-somewhere-else-recommend): Using `ctrl_path`, you can write the DSL somewhere else 
   to simplify the current controller.  
-  \* Take the tag from `path.split('/').last`
+  \* take the tag from `path.split('/').last`
 
 - `apis_set` [Optional]
 
@@ -395,7 +395,7 @@ In order to use it, you may have to enable CORS, [see](https://github.com/swagge
 
 ### Tricks
 
-#### Write the DSL Somewhere Else (Recommend)
+#### Write the DSL Somewhere Else
 
 Does your documentation take too mant lines?  
 Do you want to separate documentation from business controller to simplify both?  

data/documentation/examples/open_api.rb

@@ -48,18 +48,20 @@ OpenApi.configure do |c|
           # https://swagger.io/docs/specification/api-host-and-base-path/
           #   The servers section specifies the API server and base URL.
           #   You can define one or several servers, such as production and sandbox.
-          servers: [{
-                        # [REQUIRED] A URL to the target host.
-                        # This URL supports Server Variables and MAY be relative,
-                        #   to indicate that the host location is relative to the location where
-                        #   the OpenAPI document is being served.
-                        url: 'http://localhost:2333',
-                        # An optional string describing the host designated by the URL.
-                        description: 'Optional server description, e.g. Main (production) server'
-                    },{
-                        url: 'http://localhost:3332',
-                        description: 'Optional server description, e.g. Internal staging server for testing'
-                    }],
+          servers: [
+              {
+                  # [REQUIRED] A URL to the target host.
+                  # This URL supports Server Variables and MAY be relative,
+                  #   to indicate that the host location is relative to the location where
+                  #   the OpenAPI document is being served.
+                  url: 'http://localhost:2333',
+                  # An optional string describing the host designated by the URL.
+                  description: 'Optional server description, e.g. Main (production) server'
+              },{
+                  url: 'http://localhost:3332',
+                  description: 'Optional server description, e.g. Internal staging server for testing'
+              }
+          ],
 
           # Authentication
           #   The securitySchemes and security keywords are used to describe the authentication methods used in your API.

data/lib/oas_objs/param_obj.rb

@@ -19,7 +19,7 @@ module OpenApi
 
       def process
         assign(_desc).to_processed 'description'
-        processed.tap { |it| it[:schema] = schema.process_for name }
+        processed.tap { |it| it[:schema] = schema.process_for self[:name] }
       end
 
 
@@ -36,27 +36,6 @@ module OpenApi
           self[key]
         end
       end
-
-
-      # Interfaces for directly taking the info what you focus on,
-      #   The next step you may want to verify the parameters based on these infos.
-      #   The implementation of the parameters validator, see:
-      #     TODO
-      alias_method :range, :_range
-      alias_method :length, :_length
-      { # INTERFACE_MAPPING
-          name:     %i[name          ],
-          required: %i[required      ],
-          in:       %i[in            ],
-          enum:     %i[schema enum   ],
-          pattern:  %i[schema pattern],
-          regexp:   %i[schema pattern],
-          type:     %i[schema type   ],
-          is:       %i[schema format ],
-      }.each do |method, path|
-        define_method method do path.inject(processed, &:[]) end # Get value from hash by key path
-      end
-      alias_method :required?, :required
     end
   end
 end

data/lib/oas_objs/schema_obj.rb

@@ -141,12 +141,11 @@ module OpenApi
         _default: %i[default  dft     default_value   ],
       }.each do |key, aliases|
         define_method key do
-          self[key].tap do |it|
-            aliases.each do |alias_name|
-              break if it == false
-              it ||= self[alias_name]
-            end if it.nil?
-          end
+          aliases.each do |alias_name|
+            break if self[key] == false
+            self[key] ||= self[alias_name]
+          end if self[key].nil?
+          self[key]
         end
         define_method "#{key}=" do |value| self[key] = value end
       end

data/lib/open_api/generator.rb

@@ -45,6 +45,7 @@ module OpenApi
         docs.each do |api_name, doc|
           File.open("#{output_path}/#{api_name}.json", 'w') { |file| file.write JSON.pretty_generate doc }
         end
+        # pp $open_apis
       end
     end
 

data/lib/open_api/version.rb

@@ -1,3 +1,3 @@
 module OpenApi
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zero-rails_openapi
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2017-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler