rspec_api_documentation-open_api 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: fab416f868a74ddb07866e0e7d17913c7c56f4697b1a35bb363f1c591641a42c
4
+ data.tar.gz: 5f0b5cfe8472d44f3e6d300f57f6c47cab1202a52ad9d8911e33ed969652ba04
5
+ SHA512:
6
+ metadata.gz: 44cba9fa46feace13862d58a5ba9062e2cdfae62fdc9012c1cde31eea31b87052b11a3154dea737027f4d8a9b452a88a521d562fd32ec4b5de5582d0b1c7af5f
7
+ data.tar.gz: 2c4c594c94e8e7539d9f8299b8be2bdd53626970607ef049aed6cfb905705714157f1785a747b45e41d81420d8e0f955995e12bb6010285b38099e71dad6c9c9
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+ .rubocop-https*
data/.rubocop.yml ADDED
@@ -0,0 +1,11 @@
1
+ inherit_from:
2
+ - https://raw.githubusercontent.com/cookpad/guides/master/.rubocop.yml
3
+
4
+ AllCops:
5
+ TargetRubyVersion: 2.5
6
+
7
+ Rails/UnknownEnv:
8
+ Environments:
9
+ - production
10
+ - development
11
+ - test
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.5.1
5
+ before_install: gem install bundler -v 1.16.1
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at david.stosik+git-noreply@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in rspec_api_documentation-open_api.gemspec
6
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,59 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ rspec_api_documentation-open_api (0.1.0)
5
+ rspec_api_documentation (~> 5)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ activesupport (5.2.0)
11
+ concurrent-ruby (~> 1.0, >= 1.0.2)
12
+ i18n (>= 0.7, < 2)
13
+ minitest (~> 5.1)
14
+ tzinfo (~> 1.1)
15
+ coderay (1.1.2)
16
+ concurrent-ruby (1.0.5)
17
+ diff-lcs (1.3)
18
+ i18n (1.0.1)
19
+ concurrent-ruby (~> 1.0)
20
+ method_source (0.9.0)
21
+ minitest (5.11.3)
22
+ mustache (1.0.5)
23
+ pry (0.11.3)
24
+ coderay (~> 1.1.0)
25
+ method_source (~> 0.9.0)
26
+ rake (10.5.0)
27
+ rspec (3.7.0)
28
+ rspec-core (~> 3.7.0)
29
+ rspec-expectations (~> 3.7.0)
30
+ rspec-mocks (~> 3.7.0)
31
+ rspec-core (3.7.1)
32
+ rspec-support (~> 3.7.0)
33
+ rspec-expectations (3.7.0)
34
+ diff-lcs (>= 1.2.0, < 2.0)
35
+ rspec-support (~> 3.7.0)
36
+ rspec-mocks (3.7.0)
37
+ diff-lcs (>= 1.2.0, < 2.0)
38
+ rspec-support (~> 3.7.0)
39
+ rspec-support (3.7.1)
40
+ rspec_api_documentation (5.1.0)
41
+ activesupport (>= 3.0.0)
42
+ mustache (~> 1.0, >= 0.99.4)
43
+ rspec (~> 3.0)
44
+ thread_safe (0.3.6)
45
+ tzinfo (1.2.5)
46
+ thread_safe (~> 0.1)
47
+
48
+ PLATFORMS
49
+ ruby
50
+
51
+ DEPENDENCIES
52
+ bundler (~> 1.16)
53
+ minitest (~> 5.0)
54
+ pry (~> 0.11)
55
+ rake (~> 10.0)
56
+ rspec_api_documentation-open_api!
57
+
58
+ BUNDLED WITH
59
+ 1.16.1
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 Aaditya Taparia
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,54 @@
1
+ # RspecApiDocumentation::OpenApi
2
+
3
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rspec_api_documentation/open_api`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'rspec_api_documentation-open_api'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install rspec_api_documentation-open_api
22
+
23
+ ## Usage
24
+
25
+ in *spec/spec_helper.rb* Put
26
+ ```rb
27
+ RspecApiDocumentation.configure do |config|
28
+ config.format = :open_api_json # for json file
29
+ end
30
+ ```
31
+ or
32
+ ```rb
33
+ RspecApiDocumentation.configure do |config|
34
+ config.format = :open_api_yaml # for yaml file
35
+ end
36
+ ```
37
+
38
+ ## Development
39
+
40
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
41
+
42
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
43
+
44
+ ## Contributing
45
+
46
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec_api_documentation-open_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
47
+
48
+ ## License
49
+
50
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
51
+
52
+ ## Code of Conduct
53
+
54
+ Everyone interacting in the RspecApiDocumentation::OpenApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rspec_api_documentation-open_api/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList["test/**/*_test.rb"]
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,11 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "rspec_api_documentation/open_api"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ require "pry"
11
+ Pry.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,11 @@
1
+ require "rspec_api_documentation/open_api/version"
2
+
3
+ module RspecApiDocumentation
4
+ module Writers
5
+ extend ActiveSupport::Autoload
6
+
7
+ autoload :OpenApiWriter
8
+ autoload :OpenApiJsonWriter
9
+ autoload :OpenApiYamlWriter
10
+ end
11
+ end
@@ -0,0 +1,5 @@
1
+ module RspecApiDocumentation
2
+ module OpenApi
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
@@ -0,0 +1,11 @@
1
+ module RspecApiDocumentation
2
+ module Writers
3
+ class OpenApiJsonWriter < OpenApiWriter
4
+ def write
5
+ File.open(configuration.docs_dir.join("open_api.json"), "w") do |f|
6
+ f.write JSON.pretty_generate(get_hash)
7
+ end
8
+ end
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,275 @@
1
+ require "json"
2
+ require "yaml"
3
+ require "cgi"
4
+ require "rspec_api_documentation/writers/json_writer"
5
+
6
+ module RspecApiDocumentation
7
+ module Writers
8
+ class OpenApiWriter < Writer
9
+ attr_writer :types, :swagger
10
+
11
+ def write
12
+ File.open(configuration.docs_dir.join("open_api.json"), "w") do |f|
13
+ f.write JSON.pretty_generate(get_hash)
14
+ end
15
+
16
+ File.open(configuration.docs_dir.join("open_api.yaml"), "w") do |f|
17
+ f.write get_hash.to_yaml
18
+ end
19
+ end
20
+
21
+ def get_hash
22
+ index.examples.each do |rspec_example|
23
+ api = JSONExample.new(rspec_example, configuration).as_json.deep_stringify_keys
24
+ description = api["description"]
25
+ route = api["route"].gsub(%r{\:version\/}, "")
26
+ route = route.gsub(%r{\:([^\/]+)}, '{\1}')
27
+ params = route.scan(%r{\{([^\/]+)\}}).map { |param| { "name" => param[0], "in" => "path", "required" => true, "schema" => { "type" => "string" } } }
28
+ swagger["paths"][route] = swagger["paths"][route] || {}
29
+ responses = {}
30
+ req = api["requests"][0]
31
+ method = req["request_method"].downcase
32
+ result = JSON.parse(req["response_body"]) if req["response_body"]
33
+ properties = {}
34
+ result&.each { |k, v| properties[k] = get_properties(v) }
35
+
36
+ responses[req["response_status"]] = {
37
+ "description" => req["response_status_text"],
38
+ "headers" => req["response_headers"].map { |name, _v| [name, { "schema" => { "type" => "string" } }] }.to_h,
39
+ "content" => {
40
+ "application/json" => {
41
+ "schema" => {
42
+ "type" => "object",
43
+ "properties" => properties
44
+ }
45
+ }
46
+ }
47
+ }
48
+ api["parameters"]&.each do |param|
49
+ params.push("name" => param["name"],
50
+ "in" => "query",
51
+ "schema" => {
52
+ "type" => "string"
53
+ },
54
+ "description" => param["description"],
55
+ "required" => param["required"] || false)
56
+ end
57
+
58
+ req["request_query_parameters"]&.each do |name, value|
59
+ params.push("name" => name,
60
+ "in" => "query",
61
+ "schema" => {
62
+ "type" => "string"
63
+ },
64
+ "example" => value)
65
+ end
66
+ if req["request_content_type"] == "application/x-www-form-urlencoded" && api["requests"][0]["request_body"]
67
+ req["request_body"].scan(/([^\&\=]*)=([^\&]*)/).map do |body|
68
+ params.push("name" => body[0],
69
+ "in" => "query",
70
+ "schema" => {
71
+ "type" => "string"
72
+ },
73
+ "example" => CGI.unescape(body[1]))
74
+ end
75
+ end
76
+ swagger["paths"][route][method] = swagger["paths"][route][method] || {}
77
+ swagger["paths"][route][method]["parameters"] = swagger["paths"][route][method]["parameters"] || []
78
+
79
+ req["request_headers"]&.each do |name, value|
80
+ if name == "Authorization"
81
+ swagger["paths"][route][method]["security"] = if /Bearer (.*)/.match?(value)
82
+ responses["401"] = {
83
+ "description" => "Unauthorized Access",
84
+ "content" => {
85
+ "application/json" => {
86
+ "schema" => {
87
+ "$ref" => "#/components/schemas/unauthorized"
88
+ }
89
+ }
90
+ }
91
+ }
92
+ [{ "bearerAuth" => [] }]
93
+ else
94
+ [{ "basicAuth" => [] }]
95
+ end
96
+ else
97
+ params.unshift("name" => name,
98
+ "in" => "header",
99
+ "schema" => {
100
+ "type" => "string"
101
+ },
102
+ "example" => value,
103
+ "required" => true)
104
+ end
105
+ end
106
+ params.each do |param|
107
+ has = false
108
+ swagger["paths"][route][method]["parameters"].each_with_index do |p, i|
109
+ if p["name"] == param["name"]
110
+ swagger["paths"][route][method]["parameters"][i]["example"] = swagger["paths"][route][method]["parameters"][i]["example"] || param["example"]
111
+ has = true
112
+ end
113
+ end
114
+ swagger["paths"][route][method]["parameters"].push(param) unless has
115
+ end
116
+ desc = swagger["paths"][route][method]["description"] || ""
117
+ swagger["paths"][route][method]["description"] = desc + "- #{description}, <strong>Needed Parameters:</strong>\n - #{ params.map{ |p| p['name'] }.join("\n - ") } \n"
118
+ swagger["paths"][route][method]["responses"] = responses
119
+ end
120
+ swagger["components"]["schemas"] = types
121
+
122
+ swagger
123
+ end
124
+
125
+ def get_properties(v)
126
+ case v.class.name
127
+ when "Hash"
128
+ props = v.map { |key, value| [key, get_properties(value)] }.to_h
129
+ x = {
130
+ "type" => "object",
131
+ "properties" => props
132
+ }
133
+ if v["type"]
134
+ type = v["type"].tr("\/", "_")
135
+ types[type] = x unless types.key?(type)
136
+ if types.key?(type)
137
+ types[type]["properties"] = hash_deep_assign(types[type]["properties"], x["properties"])
138
+ else
139
+ types[type] = x
140
+ end
141
+ return { "$ref" => "#/components/schemas/#{type}" }
142
+ end
143
+ x
144
+ when "Array"
145
+ {
146
+ "type" => "array",
147
+ "items" => get_properties(v[0])
148
+ }
149
+ when "TrueClass", "FalseClass"
150
+ {
151
+ "type" => "boolean",
152
+ "example" => v
153
+ }
154
+ when "NilClass"
155
+ {
156
+ "type" => "integer",
157
+ "nullable" => true
158
+ }
159
+ when "Integer", "Float"
160
+ {
161
+ "type" => "number",
162
+ "example" => v
163
+ }
164
+ else
165
+ {
166
+ "type" => v.class.name.downcase,
167
+ "example" => v
168
+ }
169
+ end
170
+ end
171
+
172
+ def hash_deep_assign(target, other)
173
+ return target unless target && other
174
+ other.each do |key, value|
175
+ target[key] = if target.key?(key) && other[key].is_a?(Hash)
176
+ hash_deep_assign(target[key], other[key])
177
+ elsif target.key?(key) && target[key].is_a?(Array) && other[key].is_a?(Array)
178
+ target[key].push(*other[key]).uniq
179
+ elsif key == "$ref"
180
+ if other["$ref"] && target["$ref"] && target["$ref"] != other["$ref"]
181
+ target = {
182
+ "oneOf" => [
183
+ { "$ref" => target["$ref"] },
184
+ { "$ref" => other["$ref"] }
185
+ ]
186
+ }
187
+ elsif target.key?("oneOf")
188
+ target["oneOf"].push("$ref" => other["$ref"]).uniq
189
+ else
190
+ target["$ref"] || other["$ref"]
191
+ end
192
+ elsif target.key?(key)
193
+ target[key] || other[key]
194
+ else
195
+ value
196
+ end
197
+ end
198
+ target = { "oneOf" => target["oneOf"] } if target.key?("oneOf")
199
+ target = { "$ref" => target["$ref"] } if target.key?("$ref")
200
+ target = get_properties(target["example"]) if target["example"] && target.key?("nullable")
201
+ target
202
+ end
203
+
204
+ def types
205
+ @types ||= {
206
+ "unauthorized" => {
207
+ "properties" => {
208
+ "code" => {
209
+ "type" => "string",
210
+ "example" => "invalid_client_credentials"
211
+ },
212
+ "message" => {
213
+ "type" => "string",
214
+ "example" => "Not found or invalid client credentials"
215
+ }
216
+ }
217
+ }
218
+ }
219
+ end
220
+
221
+ def swagger
222
+ @swagger ||= {
223
+ "openapi" => "3.0.0",
224
+ "info" => {
225
+ "version" => "1.0.0",
226
+ "title" => "Cookpad Global Web API",
227
+ "description" => "Cookpad's global web API",
228
+ "contact" => {
229
+ "name" => "Aaditya Taparia",
230
+ "email" => "aaditya-taparia@gmail.com",
231
+ "url" => "https://github.com/aadityataparia"
232
+ }
233
+ },
234
+ "servers" => [
235
+ {
236
+ "url" => "http://localhost:{port}/{version}",
237
+ "description" => "Development server",
238
+ "variables" => {
239
+ "version" => {
240
+ "default" => "v4"
241
+ },
242
+ "port" => {
243
+ "default" => "3000"
244
+ }
245
+ }
246
+ },
247
+ {
248
+ "url" => "https://global-search-api-staging.ckpd.co/{version}",
249
+ "description" => "Staging server",
250
+ "variables" => {
251
+ "version" => {
252
+ "default" => "v4"
253
+ }
254
+ }
255
+ }
256
+ ],
257
+ "paths" => {},
258
+ "components" => {
259
+ "securitySchemes" => {
260
+ "bearerAuth" => {
261
+ "type" => "http",
262
+ "scheme" => "bearer"
263
+ },
264
+ "basicAuth" => {
265
+ "type" => "http",
266
+ "scheme" => "basic"
267
+ }
268
+ },
269
+ "schemas" => {}
270
+ }
271
+ }
272
+ end
273
+ end
274
+ end
275
+ end
@@ -0,0 +1,11 @@
1
+ module RspecApiDocumentation
2
+ module Writers
3
+ class OpenApiYamlWriter < OpenApiWriter
4
+ def write
5
+ File.open(configuration.docs_dir.join("open_api.yaml"), "w") do |f|
6
+ f.write get_hash.to_yaml
7
+ end
8
+ end
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,39 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "rspec_api_documentation/open_api/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "rspec_api_documentation-open_api"
8
+ spec.version = RspecApiDocumentation::OpenApi::VERSION
9
+ spec.authors = ["Aaditya Taparia"]
10
+ spec.email = ["aadityataparia@gmail.com"]
11
+
12
+ spec.summary = "Adds open_api output format to rspec_api_documentation"
13
+ spec.description = "Adds open_api output format to rspec_api_documentation"
14
+ spec.homepage = "https://github.com/aadityataparia/rspec_api_documentation-open_api"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
18
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
19
+ if spec.respond_to?(:metadata)
20
+ spec.metadata["allowed_push_host"] = "https://rubygems.org"
21
+ else
22
+ raise "RubyGems 2.0 or newer is required to protect against " \
23
+ "public gem pushes."
24
+ end
25
+
26
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
27
+ f.match(%r{^(test|spec|features)/})
28
+ end
29
+ spec.bindir = "exe"
30
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
31
+ spec.require_paths = ["lib"]
32
+
33
+ spec.add_dependency "rspec_api_documentation", "~> 5"
34
+
35
+ spec.add_development_dependency "bundler", "~> 1.16"
36
+ spec.add_development_dependency "minitest", "~> 5.0"
37
+ spec.add_development_dependency "rake", "~> 10.0"
38
+ spec.add_development_dependency "pry", "~> 0.11"
39
+ end
metadata ADDED
@@ -0,0 +1,132 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: rspec_api_documentation-open_api
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Aaditya Taparia
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-05-30 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rspec_api_documentation
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '5'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '5'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.16'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.16'
41
+ - !ruby/object:Gem::Dependency
42
+ name: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '5.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '5.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: pry
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '0.11'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '0.11'
83
+ description: Adds open_api output format to rspec_api_documentation
84
+ email:
85
+ - aadityataparia@gmail.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rubocop.yml"
92
+ - ".travis.yml"
93
+ - CODE_OF_CONDUCT.md
94
+ - Gemfile
95
+ - Gemfile.lock
96
+ - LICENSE.txt
97
+ - README.md
98
+ - Rakefile
99
+ - bin/console
100
+ - bin/setup
101
+ - lib/rspec_api_documentation/open_api.rb
102
+ - lib/rspec_api_documentation/open_api/version.rb
103
+ - lib/rspec_api_documentation/writers/open_api_json_writer.rb
104
+ - lib/rspec_api_documentation/writers/open_api_writer.rb
105
+ - lib/rspec_api_documentation/writers/open_api_yaml_writer.rb
106
+ - rspec_api_documentation-open_api.gemspec
107
+ homepage: https://github.com/aadityataparia/rspec_api_documentation-open_api
108
+ licenses:
109
+ - MIT
110
+ metadata:
111
+ allowed_push_host: https://rubygems.org
112
+ post_install_message:
113
+ rdoc_options: []
114
+ require_paths:
115
+ - lib
116
+ required_ruby_version: !ruby/object:Gem::Requirement
117
+ requirements:
118
+ - - ">="
119
+ - !ruby/object:Gem::Version
120
+ version: '0'
121
+ required_rubygems_version: !ruby/object:Gem::Requirement
122
+ requirements:
123
+ - - ">="
124
+ - !ruby/object:Gem::Version
125
+ version: '0'
126
+ requirements: []
127
+ rubyforge_project:
128
+ rubygems_version: 2.7.4
129
+ signing_key:
130
+ specification_version: 4
131
+ summary: Adds open_api output format to rspec_api_documentation
132
+ test_files: []