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 



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

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

#rswag_ui_initializer_path ⇒ Object 



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

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

#rswag_ui_initializer_tpl ⇒ Object 



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

def rswag_ui_initializer_tpl
  "    Rswag::Ui.configure do |c|\n    end\n  INITIALIZER\nend\n"

#rswag_ui_swagger_endpoint ⇒ Object 



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

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 



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

def spec_integration_path
  "spec/integration/.gitkeep"
end

#spec_swagger_path ⇒ Object 



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

def spec_swagger_path
  "spec/swagger/.gitkeep"
end

#swagger_definition_entry ⇒ Object 



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

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 



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

def swagger_definition_line_to_inject_schema
  /definitions: {/
end

#swagger_definition_tpl ⇒ Object 



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

def swagger_definition_tpl
  "    API_V\#{version_number} = {\n      swagger: '2.0',\n      info: {\n        title: 'API V\#{version_number}',\n        version: 'v\#{version_number}'\n      },\n      basePath: '/api/v\#{version_number}',\n      definitions: {\n      }\n    }\n  DEFINITION\nend\n"

#swagger_helper_api_definition ⇒ Object 



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

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 



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

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

#swagger_helper_path ⇒ Object 



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

def swagger_helper_path
  "spec/swagger_helper.rb"
end

#swagger_helper_tpl ⇒ Object 



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

def swagger_helper_tpl
  "    require 'rails_helper'\n\n    Dir[::Rails.root.join(\"spec/swagger/**/schemas/*.rb\")].each { |f| require f }\n    Dir[::Rails.root.join(\"spec/swagger/**/definition.rb\")].each { |f| require f }\n\n    RSpec.configure do |config|\n      # Specify a root folder where Swagger JSON files are generated\n      # NOTE: If you're using the rswag-api to serve API descriptions, you'll need\n      # to ensure that it's confiugred to serve Swagger from the same folder\n      config.swagger_root = Rails.root.to_s + '/swagger'\n\n      # Define one or more Swagger documents and provide global metadata for each one\n      # When you run the 'rswag:specs:to_swagger' rake task, the complete Swagger will\n      # be generated at the provided relative path under swagger_root\n      # By default, the operations defined in spec files are added to the first\n      # document below. You can override this behavior by adding a swagger_doc tag to the\n      # the root example_group in your specs, e.g. describe '...', swagger_doc: 'v2/swagger.json'\n      config.swagger_docs = {\n      }\n    end\n  SWAGGER\nend\n"

#swagger_resource_schema_path ⇒ Object 



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

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

#swagger_resource_spec_path ⇒ Object 



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

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

#swagger_resource_spec_tpl ⇒ Object 



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

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 



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
162
 
# File 'lib/power_api/generator_helper/swagger_helper.rb', line 117

def swagger_schema_tpl
  "    \#{swagger_model_definition_const} = {\n      type: :object,\n      properties: {\n        id: { type: :string, example: '1' },\n        type: { type: :string, example: '\#{resource.snake_case}' },\n        attributes: {\n          type: :object,\n          properties: {\#{get_swagger_schema_attributes_definitions}\n          },\n          required: [\#{get_swagger_schema_attributes_names}\n          ]\n        }\n      },\n      required: [\n        :id,\n        :type,\n        :attributes\n      ]\n    }\n\n    \#{swagger_collection_definition_const} = {\n      type: \"object\",\n      properties: {\n        data: {\n          type: \"array\",\n          items: { \"$ref\" => \"#/definitions/\#{resource.snake_case}\" }\n        }\n      },\n      required: [\n        :data\n      ]\n    }\n\n    \#{swagger_resource_definition_const} = {\n      type: \"object\",\n      properties: {\n        data: { \"$ref\" => \"#/definitions/\#{resource.snake_case}\" }\n      },\n      required: [\n        :data\n      ]\n    }\n  SCHEMA\nend\n"

#swagger_schemas_path ⇒ Object 



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

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

#swagger_version_definition_path ⇒ Object 



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

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