rspec_api_docs 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 3307d9a8dec9bbf62b57f816c027680e758970e8
4
+ data.tar.gz: 6eaddd4848a28727d6c657d1b2e3f6dec0aef0c4
5
+ SHA512:
6
+ metadata.gz: 3b844cc304af39e66a3ac7b25a6d8b44b43f1df0d1adaabcf4ba6fe4c95740cf2e37286ed3e4a96cdee4d4392d0856dda2d1144da20bde252edeee9b8af299e7
7
+ data.tar.gz: 4a6692e901e27bb292c21a5b4989e66b6b449c11fb26595d7450d83248ad9010a12af47c2f9c10e1d90a93118a9bc0c76600ece40e73afff5add33f8a12726a5
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.3
4
+ before_install: gem install bundler -v 1.10.6
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+ We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6
+
7
+ Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8
+
9
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in rspec_api_docs.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Tom Kadwill
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,41 @@
1
+ # RspecApiDocs
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_docs`. 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_docs'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install rspec_api_docs
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
+
31
+ 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).
32
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec_api_docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
36
+
37
+
38
+ ## License
39
+
40
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
41
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "rspec_api_docs"
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
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,3 @@
1
+ module RspecApiDocs
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,102 @@
1
+ require "rspec_api_docs/version"
2
+
3
+ RSpec.configure do |config|
4
+ config.before(:suite) do
5
+ if defined? Rails
6
+ api_docs_folder_path = File.join(Rails.root, '/api_docs/')
7
+ else
8
+ api_docs_folder_path = File.join(File.expand_path('.'), '/api_docs/')
9
+ end
10
+
11
+ Dir.mkdir(api_docs_folder_path) unless Dir.exists?(api_docs_folder_path)
12
+
13
+ files_to_remove = config.files_to_run == [] ? Dir.glob(File.join(api_docs_folder_path, '*')) : config.files_to_run
14
+
15
+ files_to_remove.each do |f|
16
+ next unless f.match(/api\/v*.\/.*/)
17
+
18
+ file = f.match(/api\/v*.\/.*/)[0].gsub('/', '_').gsub('api_', '').gsub('_controller_test.rb', '.txt')
19
+ file = "api_docs/#{file}"
20
+ File.delete(file) if File.exists?(file)
21
+ end
22
+ end
23
+
24
+ config.after(:each) do |example|
25
+ # exit unless this is under api/v*
26
+ next unless example.metadata[:file_path].match(/api\/v\d*/)
27
+ begin
28
+ next unless request && request.try(:symbolized_path_parameters)
29
+ rescue => e
30
+ # Continue anyway
31
+ next
32
+ end
33
+
34
+ if response
35
+ example_group = example.metadata[:example_group]
36
+ example_groups = []
37
+
38
+ while example_group
39
+ example_groups << example_group
40
+ example_group = example_group[:example_group]
41
+ end
42
+
43
+ file_name = request.symbolized_path_parameters[:controller].gsub(/\//, '_').gsub('api_', '')
44
+
45
+ id_symbol = request.symbolized_path_parameters.keys.find{|k| k.match /id/}
46
+ optional_param = request.symbolized_path_parameters[id_symbol] ? "/{:#{id_symbol}}" : ""
47
+ action = "#{request.request_method} #{request.symbolized_path_parameters[:controller]}#{optional_param}"
48
+
49
+ if defined? Rails
50
+ file = File.join(Rails.root, "/api_docs/#{file_name}.txt")
51
+ else
52
+ file = File.join(File.expand_path('.'), "/api_docs/#{file_name}.txt")
53
+ end
54
+
55
+ collection = action.match(/(POST|GET|PATCH|DELETE) (portal\/api|api)\/v\d*\/(.*)/)[3]
56
+ File.open(file, 'a') do |f|
57
+ if File.zero?(File.join(Rails.root, "/api_docs/#{file_name}.txt"))
58
+ f.write "FORMAT: 1A\n"
59
+ f.write "HOST: https://qa1.google.co.uk/api\n\n"
60
+
61
+ f.write "# #{collection.capitalize}\n\n"
62
+
63
+ f.write "description blah blah blah\n\n"
64
+ end
65
+
66
+ # skip if the action is already defined
67
+ next if File.read(File.join(Rails.root, "/api_docs/#{file_name}.txt")).include?(action)
68
+
69
+ f.write "## #{collection.capitalize} collection [/#{collection}]\n\n"
70
+
71
+ f.write "### #{collection.capitalize} #{request.symbolized_path_parameters[:action].capitalize} [#{request.method}]\n\n"
72
+
73
+ # Request
74
+ request_body = request.env["action_dispatch.request.request_parameters"]
75
+ authorization_header = request.env ? request.env['Authorization'] : request.headers['Authorization']
76
+
77
+ if request_body.present? || authorization_header.present?
78
+ f.write "+ Request #{request.content_type}\n\n"
79
+
80
+ # Request Headers
81
+ # if authorization_header.present?
82
+ # f.write "+ Headers\n\n".indent(4)
83
+ # f.write "Authorization: #{authorization_header}\n\n".indent(12)
84
+ # end
85
+
86
+ # Request Body
87
+ if request_body.present?# && request.content_type == 'application/json'
88
+ f.write "+ Body\n\n".indent(4)# if authorization_header
89
+ f.write "#{JSON.pretty_generate(JSON.parse(JSON.pretty_generate(request_body)))}\n\n".indent(authorization_header ? 12 : 8)
90
+ end
91
+ end
92
+
93
+ # Response
94
+ f.write "+ Response #{response.status} #{response.content_type}\n\n"
95
+
96
+ if response.body.present? && response.content_type =~ /application\/json/
97
+ f.write "#{JSON.pretty_generate(JSON.parse(response.body))}\n\n".indent(8)
98
+ end
99
+ end unless response.status.to_s =~ /4\d\d/ || response.status.to_s =~ /3\d\d/
100
+ end
101
+ end
102
+ end
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'rspec_api_docs/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "rspec_api_docs"
8
+ spec.version = RspecApiDocs::VERSION
9
+ spec.authors = ["Tom Kadwill"]
10
+ spec.email = ["tomkadwill@gmail.com"]
11
+
12
+ spec.summary = %q{Generate API blueprint docs when running Rspec}
13
+ spec.description = %q{Generate API blueprint docs when running Rspec}
14
+ spec.homepage = "https://github.com/tomkadwill/rspec_api_docs"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_development_dependency "bundler", "~> 1.10"
23
+ spec.add_development_dependency "rake", "~> 10.0"
24
+ spec.add_development_dependency "rspec"
25
+ end
metadata ADDED
@@ -0,0 +1,99 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: rspec_api_docs
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Tom Kadwill
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-06-15 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.10'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.10'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ description: Generate API blueprint docs when running Rspec
56
+ email:
57
+ - tomkadwill@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rspec"
64
+ - ".travis.yml"
65
+ - CODE_OF_CONDUCT.md
66
+ - Gemfile
67
+ - LICENSE.txt
68
+ - README.md
69
+ - Rakefile
70
+ - bin/console
71
+ - bin/setup
72
+ - lib/rspec_api_docs.rb
73
+ - lib/rspec_api_docs/version.rb
74
+ - rspec_api_docs.gemspec
75
+ homepage: https://github.com/tomkadwill/rspec_api_docs
76
+ licenses:
77
+ - MIT
78
+ metadata: {}
79
+ post_install_message:
80
+ rdoc_options: []
81
+ require_paths:
82
+ - lib
83
+ required_ruby_version: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - ">="
86
+ - !ruby/object:Gem::Version
87
+ version: '0'
88
+ required_rubygems_version: !ruby/object:Gem::Requirement
89
+ requirements:
90
+ - - ">="
91
+ - !ruby/object:Gem::Version
92
+ version: '0'
93
+ requirements: []
94
+ rubyforge_project:
95
+ rubygems_version: 2.5.1
96
+ signing_key:
97
+ specification_version: 4
98
+ summary: Generate API blueprint docs when running Rspec
99
+ test_files: []