rspec_api_docs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3307d9a8dec9bbf62b57f816c027680e758970e8
+  data.tar.gz: 6eaddd4848a28727d6c657d1b2e3f6dec0aef0c4
+SHA512:
+  metadata.gz: 3b844cc304af39e66a3ac7b25a6d8b44b43f1df0d1adaabcf4ba6fe4c95740cf2e37286ed3e4a96cdee4d4392d0856dda2d1144da20bde252edeee9b8af299e7
+  data.tar.gz: 4a6692e901e27bb292c21a5b4989e66b6b449c11fb26595d7450d83248ad9010a12af47c2f9c10e1d90a93118a9bc0c76600ece40e73afff5add33f8a12726a5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+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.
+
+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.
+
+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.
+
+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.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+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

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec_api_docs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tom Kadwill
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# RspecApiDocs
+
+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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec_api_docs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec_api_docs
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec_api_docs"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec_api_docs/version.rb

@@ -0,0 +1,3 @@
+module RspecApiDocs
+  VERSION = "0.1.0"
+end

data/lib/rspec_api_docs.rb

@@ -0,0 +1,102 @@
+require "rspec_api_docs/version"
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    if defined? Rails
+      api_docs_folder_path = File.join(Rails.root, '/api_docs/')
+    else
+      api_docs_folder_path = File.join(File.expand_path('.'), '/api_docs/')
+    end
+
+    Dir.mkdir(api_docs_folder_path) unless Dir.exists?(api_docs_folder_path)
+
+    files_to_remove = config.files_to_run == [] ? Dir.glob(File.join(api_docs_folder_path, '*')) : config.files_to_run
+
+    files_to_remove.each do |f|
+      next unless f.match(/api\/v*.\/.*/)
+
+      file = f.match(/api\/v*.\/.*/)[0].gsub('/', '_').gsub('api_', '').gsub('_controller_test.rb', '.txt')
+      file = "api_docs/#{file}"
+      File.delete(file) if File.exists?(file)
+    end
+  end
+
+  config.after(:each) do |example|
+    # exit unless this is under api/v*
+    next unless example.metadata[:file_path].match(/api\/v\d*/)
+    begin
+      next unless request && request.try(:symbolized_path_parameters)
+    rescue => e
+      # Continue anyway
+      next
+    end
+
+    if response
+      example_group = example.metadata[:example_group]
+      example_groups = []
+
+      while example_group
+        example_groups << example_group
+        example_group = example_group[:example_group]
+      end
+
+      file_name = request.symbolized_path_parameters[:controller].gsub(/\//, '_').gsub('api_', '')
+
+      id_symbol = request.symbolized_path_parameters.keys.find{|k| k.match /id/}
+      optional_param = request.symbolized_path_parameters[id_symbol] ? "/{:#{id_symbol}}" : ""
+      action = "#{request.request_method} #{request.symbolized_path_parameters[:controller]}#{optional_param}"
+
+      if defined? Rails
+        file = File.join(Rails.root, "/api_docs/#{file_name}.txt")
+      else
+        file = File.join(File.expand_path('.'), "/api_docs/#{file_name}.txt")
+      end
+
+      collection = action.match(/(POST|GET|PATCH|DELETE) (portal\/api|api)\/v\d*\/(.*)/)[3]
+      File.open(file, 'a') do |f|
+        if File.zero?(File.join(Rails.root, "/api_docs/#{file_name}.txt"))
+          f.write "FORMAT: 1A\n"
+          f.write "HOST: https://qa1.google.co.uk/api\n\n"
+
+          f.write "# #{collection.capitalize}\n\n"
+
+          f.write "description blah blah blah\n\n"
+        end
+
+        # skip if the action is already defined
+        next if File.read(File.join(Rails.root, "/api_docs/#{file_name}.txt")).include?(action)
+
+        f.write "## #{collection.capitalize} collection [/#{collection}]\n\n"
+
+        f.write "### #{collection.capitalize} #{request.symbolized_path_parameters[:action].capitalize} [#{request.method}]\n\n"
+
+        # Request
+        request_body = request.env["action_dispatch.request.request_parameters"]
+        authorization_header = request.env ? request.env['Authorization'] : request.headers['Authorization']
+
+        if request_body.present? || authorization_header.present?
+          f.write "+ Request #{request.content_type}\n\n"
+
+          # Request Headers
+          # if authorization_header.present?
+          #   f.write "+ Headers\n\n".indent(4)
+          #   f.write "Authorization: #{authorization_header}\n\n".indent(12)
+          # end
+
+          # Request Body
+          if request_body.present?# && request.content_type == 'application/json'
+            f.write "+ Body\n\n".indent(4)# if authorization_header
+            f.write "#{JSON.pretty_generate(JSON.parse(JSON.pretty_generate(request_body)))}\n\n".indent(authorization_header ? 12 : 8)
+          end
+        end
+
+        # Response
+        f.write "+ Response #{response.status} #{response.content_type}\n\n"
+
+        if response.body.present? && response.content_type =~ /application\/json/
+          f.write "#{JSON.pretty_generate(JSON.parse(response.body))}\n\n".indent(8)
+        end
+      end unless response.status.to_s =~ /4\d\d/ || response.status.to_s =~ /3\d\d/
+    end
+  end
+end

data/rspec_api_docs.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec_api_docs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec_api_docs"
+  spec.version       = RspecApiDocs::VERSION
+  spec.authors       = ["Tom Kadwill"]
+  spec.email         = ["tomkadwill@gmail.com"]
+
+  spec.summary       = %q{Generate API blueprint docs when running Rspec}
+  spec.description   = %q{Generate API blueprint docs when running Rspec}
+  spec.homepage      = "https://github.com/tomkadwill/rspec_api_docs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rspec_api_docs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Kadwill
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate API blueprint docs when running Rspec
+email:
+- tomkadwill@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec_api_docs.rb
+- lib/rspec_api_docs/version.rb
+- rspec_api_docs.gemspec
+homepage: https://github.com/tomkadwill/rspec_api_docs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Generate API blueprint docs when running Rspec
+test_files: []