Module: PowerApi::GeneratorHelper::SwaggerHelper

Extended by:
ActiveSupport::Concern
Included in:
PowerApi::GeneratorHelpers
Defined in:
lib/power_api/generator_helper/swagger_helper.rb

Overview

rubocop:disable Metrics/ModuleLength rubocop:disable Metrics/MethodLength rubocop:disable Layout/AlignArguments

Instance Method Summary collapse

Instance Method Details

#rswag_ui_configure_line ⇒ Object 



46
47
48
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 46

def rswag_ui_configure_line
  "Rswag::Ui.configure do |c|\n"
end

#rswag_ui_initializer_path ⇒ Object 



26
27
28
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 26

def rswag_ui_initializer_path
  "config/initializers/rswag-ui.rb"
end

#rswag_ui_initializer_tpl ⇒ Object 



58
59
60
61
62
63
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 58

def rswag_ui_initializer_tpl
  <<~INITIALIZER
    Rswag::Ui.configure do |c|
    end
  INITIALIZER
end

#rswag_ui_swagger_endpoint ⇒ Object 



90
91
92
93
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 90

def rswag_ui_swagger_endpoint
  "  c.swagger_endpoint '/api-docs/v#{version_number}/swagger.json', \
'API V#{version_number} Docs'\n"
end

#spec_integration_path ⇒ Object 



22
23
24
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 22

def spec_integration_path
  "spec/integration/.gitkeep"
end

#spec_swagger_path ⇒ Object 



18
19
20
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 18

def spec_swagger_path
  "spec/swagger/.gitkeep"
end

#swagger_definition_entry ⇒ Object 



163
164
165
166
167
168
169
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 163

def swagger_definition_entry
  [
    "\n    #{resource.snake_case}: #{swagger_model_definition_const},",
    "\n    #{resource.plural}_collection: #{swagger_collection_definition_const},",
    "\n    #{resource.snake_case}_resource: #{swagger_resource_definition_const},"
  ].join
end

#swagger_definition_line_to_inject_schema ⇒ Object 



54
55
56
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 54

def swagger_definition_line_to_inject_schema
  /definitions: {/
end

#swagger_definition_tpl ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 101

def swagger_definition_tpl
  <<~DEFINITION
    API_V#{version_number} = {
      swagger: '2.0',
      info: {
        title: 'API V#{version_number}',
        version: 'v#{version_number}'
      },
      basePath: '/api/v#{version_number}',
      definitions: {
      }
    }
  DEFINITION
end

#swagger_helper_api_definition ⇒ Object 



95
96
97
98
99
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 95

def swagger_helper_api_definition
  content = "    'v#{version_number}/swagger.json' => API_V#{version_number}"
  content = "#{content}," unless first_version?
  "#{content}\n"
end

#swagger_helper_api_definition_line ⇒ Object 



50
51
52
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 50

def swagger_helper_api_definition_line
  "config.swagger_docs = {\n"
end

#swagger_helper_path ⇒ Object 



14
15
16
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 14

def swagger_helper_path
  "spec/swagger_helper.rb"
end

#swagger_helper_tpl ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 65

def swagger_helper_tpl
  <<~SWAGGER
    require 'rails_helper'

    Dir[::Rails.root.join("spec/swagger/**/schemas/*.rb")].each { |f| require f }
    Dir[::Rails.root.join("spec/swagger/**/definition.rb")].each { |f| require f }

    RSpec.configure do |config|
      # Specify a root folder where Swagger JSON files are generated
      # NOTE: If you're using the rswag-api to serve API descriptions, you'll need
      # to ensure that it's confiugred to serve Swagger from the same folder
      config.swagger_root = Rails.root.to_s + '/swagger'

      # Define one or more Swagger documents and provide global metadata for each one
      # When you run the 'rswag:specs:to_swagger' rake task, the complete Swagger will
      # be generated at the provided relative path under swagger_root
      # By default, the operations defined in spec files are added to the first
      # document below. You can override this behavior by adding a swagger_doc tag to the
      # the root example_group in your specs, e.g. describe '...', swagger_doc: 'v2/swagger.json'
      config.swagger_docs = {
      }
    end
  SWAGGER
end

#swagger_resource_schema_path ⇒ Object 



42
43
44
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 42

def swagger_resource_schema_path
  "spec/swagger/v#{version_number}/schemas/#{resource.snake_case}_schema.rb"
end

#swagger_resource_spec_path ⇒ Object 



34
35
36
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 34

def swagger_resource_spec_path
  "spec/integration/api/v#{version_number}/#{resource.plural}_spec.rb"
end

#swagger_resource_spec_tpl ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 171

def swagger_resource_spec_tpl
  concat_tpl_statements(
    "require 'swagger_helper'\n",
    concat_tpl_statements(
      spec_tpl_initial_describe_line,
      spec_tpl_authenticated_resource,
      spec_tpl_let_parent_resource,
      spec_tpl_collection_path_statements,
      spec_tpl_resource_path_statements,
      "end\n"
    )
  )
end

#swagger_schema_tpl ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 116

def swagger_schema_tpl
  <<~SCHEMA
    #{swagger_model_definition_const} = {
      type: :object,
      properties: {
        id: { type: :string, example: '1' },
        type: { type: :string, example: '#{resource.snake_case}' },
        attributes: {
          type: :object,
          properties: {#{get_swagger_schema_attributes_definitions}
          },
          required: [#{get_swagger_schema_attributes_names}
          ]
        }
      },
      required: [
        :id,
        :type,
        :attributes
      ]
    }

    #{swagger_collection_definition_const} = {
      type: "object",
      properties: {
        data: {
          type: "array",
          items: { "$ref" => "#/definitions/#{resource.snake_case}" }
        }
      },
      required: [
        :data
      ]
    }

    #{swagger_resource_definition_const} = {
      type: "object",
      properties: {
        data: { "$ref" => "#/definitions/#{resource.snake_case}" }
      },
      required: [
        :data
      ]
    }
  SCHEMA
end

#swagger_schemas_path ⇒ Object 



30
31
32
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 30

def swagger_schemas_path
  "spec/swagger/v#{version_number}/schemas/.gitkeep"
end

#swagger_version_definition_path ⇒ Object 



38
39
40
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 38

def swagger_version_definition_path
  "spec/swagger/v#{version_number}/definition.rb"
end