swagger_codegen_rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eee36b636a3453a8c2afb020421db4f9f0fc4488
-  data.tar.gz: 7fe0a82fef3a63aa4b66ac4238429d814bc2a6b3
+SHA256:
+  metadata.gz: c23da6493e46a0fe783c81597ad8e0bffa605f7e5f133b6a701458730be9e4eb
+  data.tar.gz: f6da5bc77b6132383338a571f7720b82d74fd0f3f0e2b0c181978e295afa0bb2
 SHA512:
-  metadata.gz: 662d20770af70fb724ffe04d002dd99c359381043e7e35810faed1a6eded03d977fa92e06d98b898e32270b96a460b121fbba7241acaadf9654ca33454b94da6
-  data.tar.gz: b07e408eeab460b42ef667e9575f64c1cc6a01e2c45c9b32942422ceec5b22d045ff025977bd3351283df51d3af721b7ca87da28a357c05c127a292a51a4729b
+  metadata.gz: 8b7aaab84299f12322d83dd0a2a0290d7e4b8341539e823b435f10b2ea8f8b4ccc91120b37081166431fedcfcfb7b205e8087e8072deb4a98054d03b575453db
+  data.tar.gz: 7670e9e0bf2b886a3c0ac19c66bdf182921a7b4ab04470c42f82798110370f679b3d3d922a85bb27259c6f3607fea2127c1f9f79f62fb606ff42d7710aa28aef

data/README.md

@@ -29,7 +29,7 @@ $ gem install swagger_codegen_rails
 ```bash
 $ rails g swagger:install
 $ rails g swagger:init /api/v1
-$ rails g swagger:add /api/v1 /api/v1/user/:id id:path:integer:true
+$ rails g swagger:add /api/v1 get /api/v1/user/:id id:path:integer:true
 ```
 
 ### Create intializer file
@@ -42,8 +42,6 @@ $ rails g swagger:install
 # config/initializers/swagger_codegen_rails.rb
 
 SwaggerCodegenRails.configure do |config|
-  config.versioned = false # boolean
-
   config.versions_url = {
     v1: 'api/v1',
     v2: 'api/v2'
@@ -61,7 +59,6 @@ Options:
 
 |configurations|type|default|description|
 |:------|:----|:-|:-------------------------|
-|config.versioned|boolean|false|set path of versioned API documentations|
 config.versions_url|hash|EMPTY|define versioned path|
 |config.concern_dir|string|/app/controllers/concern|set root path of endpoint documentations|
 |config.schema_dir|string|/app/models/concern|set root path of response schema documentations|
@@ -76,9 +73,8 @@ $ rails g swagger:init NAMESPACE
 ```bash
 $ rails g swagger:add NAMESPACE HTTP_METHOD URI [PARAMETERS; name:in:type:required]
 $ # If you do NOT want namespace, example below
-$ rails g swagger:add . GET /users id:path:integer:true
+$ rails g swagger:add . get /users id:path:integer:true
 ```
-
 Parameters:
 
 ||description|
@@ -89,6 +85,21 @@ Parameters:
 |required|required|
 
 
+### To show SwaggerUI
+Add these lines in your config/application.rb (If you won't create versioned API, it is no needed.)
+```Ruby
+# config/application.rb
+config.paths.add "#{config.root}/app/controllers/**/*", glob: "**/*", eager_load: true
+```
+
+Then start your server with rails command
+```bash
+$ rails s
+```
+And access ``http://localhost:3000/swagger`` in browser.
+
+
+
 ## Contributing
 1. Fork it ( https://github.com/technobrain/swagger_codegen_rails )
 2. Create your feature branch (git checkout -b my-new-feature)

data/lib/generators/swagger/add/add_generator.rb

@@ -21,10 +21,19 @@ module Swagger
     end
 
     private
+
     def module_name
       swagger_file_name.camelize
     end
 
+    def full_uri
+      if uri.sub(/\A\//, "").start_with?(namespace)
+        '/' + uri.sub(/\A\//, "")
+      else
+        '/' + namespace + '/' + uri.sub(/\A\//, "")
+      end
+    end
+
     def namespace
       config = SwaggerCodegenRails.configuration.versions_url
       config ? (config[name.to_sym] || name) : name

data/lib/generators/swagger/add/templates/_swagger.rb.tt

@@ -6,12 +6,12 @@ module <%= module_name %>
   include_swagger '<%= swagger_schema_dir -%>', type: :model
 
   included do
-    swagger_path '<%= uri -%>' do
+    swagger_path '<%= full_uri -%>' do
       operation :<%= http_method.downcase -%> do
         key :description, "TODO: describe endpoint here"
         key :operationId, "TODO: "
         key :produces, [
-          'application/join',
+          'application/json',
         ]
         key :tags, [
           # A list of tags used by the specification with additional metadata.
@@ -33,14 +33,14 @@ module <%= module_name %>
             # key :'$ref', TODO:
           end
         end
-  
+
         response 404 do
           key :description, "TODO: "
           schema do
             # key :'$ref', TODO:
           end
         end
-  
+
         response 501 do
           key :description, "TODO: "
           schema do

data/lib/generators/swagger/install/install_generator.rb

@@ -19,11 +19,5 @@ module Swagger
       gem 'swagger_ui_engine'
       gem 'swagger-blocks'
     end
-
-    private
-    def initializer_exist?
-      initializer_path = "config/initializers/swagger_ui_engine.rb"
-      File.exist?(initializer_path)
-    end
   end
 end

data/lib/swagger_codegen_rails/base.rb

@@ -1,19 +1,11 @@
 module SwaggerCodegenRails
   module Base
     def concern_dir
-      concerns.call
-    end
-
-    def concerns
-      Proc.new { SwaggerCodegenRails.configuration.concern_dir }
+      SwaggerCodegenRails.configuration.concern_dir
     end
 
     def schema_dir
-      schemas.call
-    end
-
-    def schemas
-      Proc.new { SwaggerCodegenRails.configuration.schema_dir }
+      SwaggerCodegenRails.configuration.schema_dir
     end
   end
 end

data/lib/swagger_codegen_rails/defaults.rb

@@ -2,6 +2,5 @@ module SwaggerCodegenRails
   DEFAULTS = {
     concern_dir:  "app/controllers/concerns",
     schema_dir:   "app/models/concerns",
-    versioned:    false
   }
 end

data/lib/swagger_codegen_rails/konstants.rb

@@ -45,8 +45,9 @@ module SwaggerCodegenRails
       # => hoge/foo/bar
       # ------------
       def reduct(source, reduction)
-        File.join(File.dirname(source.sub(reduction, '')), File.basename(source, File.extname(source))).sub(/\A\//,'')
-  
+        File.join(File.dirname(source.sub(reduction, '')),
+                  File.basename(source, 
+                                File.extname(source))).sub(/\A\//,'')
       end
 
       # ------------
@@ -56,7 +57,6 @@ module SwaggerCodegenRails
       def constant(str)
         str.split("/").map(&:camelize).join("::").constantize
       end
-  
     end
   end
 end

data/lib/swagger_codegen_rails/parameter.rb

@@ -10,8 +10,8 @@ module SwaggerCodegenRails
         self[i] = params[i].blank? ? "TODO" : params[i]
       end
     rescue IndexError => e
-      logger.error e
-      logger.error e.backtrace.join("\n")
+      Rails.logger.error e
+      Rails.logger.error e.backtrace.join("\n")
       return nil
     end
 

data/lib/swagger_codegen_rails/version.rb

@@ -2,5 +2,6 @@ module SwaggerCodegenRails
   #VERSION = '0.0.1' 2018/02/26
   #VERSION = '0.0.12' #2018/02/27
   #VERSION = '0.1.01' #2018/02/28
-  VERSION = '0.1.1' #2018/03/01
+  #VERSION = '0.1.1' #2018/03/01
+  VERSION = '0.1.2' #2018/04/23
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger_codegen_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Akifumi Tomiyama
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2018-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -158,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Generator for swagger-blocks and swagger_ui_engine