rspec-api-docs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93a03551851fab62786002d514811191321bcab5
+  data.tar.gz: cbde2ff103792b94141f1bb96092485b78882817
+SHA512:
+  metadata.gz: 2789ae22918606ca1d572f8025bd4930540dc097c8a2606c9b28867b12c8d17a2750e77926d381d0e44f5ddef3c7c6d0d652edd076eb4830ecef81b0924f8c0c
+  data.tar.gz: af7acf8f314521c861a9c321be0939a93e6e8eab25e22b61a2a6cc3d4890d4f5f28ed41ac16f642e74b21eb6fd2036c6a6f2b667d116bc8c491fc80e8a74b1c6

data/.gitignore

@@ -0,0 +1 @@
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at odindutton@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Odin Dutton
+
+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,52 @@
+# rspec-api-docs
+
+## 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
+
+For now see the integration specs.
+
+```
+rm -rf spec/integration/output
+rspec spec/integration/rspec_api_docs_spec.rb --format=RspecApiDocs::Formatter
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake` to run the tests.
+
+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].
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/twe4ked/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] code of
+conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License].
+
+[MIT License]: http://opensource.org/licenses/MIT
+[Contributor Covenant]: http://contributor-covenant.org
+[rubygems.org]: https://rubygems.org

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/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/rspec_api_docs.rb

@@ -0,0 +1,22 @@
+require 'rspec_api_docs/version'
+
+module RspecApiDocs
+  METADATA_NAMESPACE = :rspec_api_docs
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Config.new
+    yield configuration
+  end
+
+  class Config
+    attr_accessor :output_dir
+
+    def initialize
+      @output_dir = 'docs'
+    end
+  end
+end

data/lib/rspec_api_docs/after.rb

@@ -0,0 +1,10 @@
+module RspecApiDocs
+  After = -> (example) do
+    metadata = example.metadata[METADATA_NAMESPACE]
+
+    if metadata
+      metadata[:requests] ||= []
+      metadata[:requests] << [last_request, last_response]
+    end
+  end
+end

data/lib/rspec_api_docs/dsl.rb

@@ -0,0 +1,27 @@
+require 'rspec_api_docs'
+require 'rspec_api_docs/dsl/request_store'
+require 'rspec_api_docs/dsl/doc_proxy'
+
+module RspecApiDocs
+  module Dsl
+    def doc(&block)
+      example.metadata[METADATA_NAMESPACE] ||= {}
+
+      if block
+        DocProxy.new(example).instance_eval(&block)
+      end
+
+      RequestStore.new(example)
+    end
+
+    def no_doc
+      example.metadata[METADATA_NAMESPACE] = nil
+    end
+
+    private
+
+    def example
+      RSpec.current_example
+    end
+  end
+end

data/lib/rspec_api_docs/dsl/doc_proxy.rb

@@ -0,0 +1,46 @@
+module RspecApiDocs
+  module Dsl
+    class DocProxy
+      attr_reader :metadata
+
+      def initialize(example)
+        @metadata = example.metadata
+      end
+
+      def name(value)
+        metadata[METADATA_NAMESPACE][:example_name] = value
+      end
+
+      def resource_name(value)
+        metadata[METADATA_NAMESPACE][:resource_name] = value
+      end
+
+      def description(value)
+        metadata[METADATA_NAMESPACE][:description] = value
+      end
+
+      def path(value)
+        metadata[METADATA_NAMESPACE][:path] = value
+      end
+
+      def field(name, description, scope: [], type: nil)
+        metadata[METADATA_NAMESPACE][:fields] ||= {}
+        metadata[METADATA_NAMESPACE][:fields][name] = {
+          description: description,
+          scope: Array(scope),
+          type: type,
+        }
+      end
+
+      def param(name, description, scope: [], type: nil, required: false)
+        metadata[METADATA_NAMESPACE][:parameters] ||= {}
+        metadata[METADATA_NAMESPACE][:parameters][name] = {
+          description: description,
+          scope: Array(scope),
+          type: type,
+          required: required,
+        }
+      end
+    end
+  end
+end

data/lib/rspec_api_docs/dsl/request_store.rb

@@ -0,0 +1,16 @@
+module RspecApiDocs
+  module Dsl
+    class RequestStore
+      attr_reader :metadata
+
+      def initialize(example)
+        @metadata = example.metadata
+      end
+
+      def <<(value)
+        metadata[METADATA_NAMESPACE][:requests] ||= []
+        metadata[METADATA_NAMESPACE][:requests] << value.sort_by { |v| v.class.name }.reverse
+      end
+    end
+  end
+end

data/lib/rspec_api_docs/formatter.rb

@@ -0,0 +1,27 @@
+require 'rspec/core/formatters/base_formatter'
+require 'json'
+
+require 'rspec_api_docs/formatter/resource'
+require 'rspec_api_docs/formatter/renderers/json_renderer'
+
+module RspecApiDocs
+  class Formatter < RSpec::Core::Formatters::BaseFormatter
+    RSpec::Core::Formatters.register self, :example_passed, :close
+
+    attr_reader :resources
+
+    def initialize(*args)
+      @resources = []
+      super args
+    end
+
+    def example_passed(example_notification)
+      return unless example_notification.example.metadata[METADATA_NAMESPACE]
+      resources << Resource.new(example_notification.example)
+    end
+
+    def close(null_notification)
+      JSONRender.new(resources).render
+    end
+  end
+end

data/lib/rspec_api_docs/formatter/index_serializer.rb

@@ -0,0 +1,37 @@
+class IndexSerializer
+  class ResourceSerializer
+    attr_reader :resource
+
+    def initialize(resource)
+      @resource = resource
+    end
+
+    def to_h
+      {
+        description: resource.example_name,
+        link: resource.link,
+        groups: resource.groups,
+        route: resource.path,
+        method: resource.http_method.downcase,
+      }
+    end
+  end
+
+  attr_reader :resources
+
+  def initialize(resources)
+    @resources = resources.group_by(&:name)
+  end
+
+  def to_h
+    {
+      resources: resources.map do |name, examples|
+        {
+          name: name,
+          explanation: nil,
+          examples: examples.map { |resource| ResourceSerializer.new(resource).to_h },
+        }
+      end
+    }
+  end
+end

data/lib/rspec_api_docs/formatter/renderers/json_renderer.rb

@@ -0,0 +1,34 @@
+require 'rspec_api_docs/formatter/index_serializer'
+require 'rspec_api_docs/formatter/resource_serializer'
+
+module RspecApiDocs
+  class JSONRender
+    attr_reader :resources
+
+    def initialize(resources)
+      @resources = resources
+    end
+
+    def render
+      FileUtils.mkdir_p output_dir
+
+      File.open(output_dir + 'index.json', 'w') do |f|
+        f.write JSON.pretty_generate(IndexSerializer.new(resources).to_h) + "\n"
+      end
+
+      resources.each do |resource|
+        FileUtils.mkdir_p output_dir + Pathname.new(resource.link).dirname
+
+        File.open(output_dir + resource.link, 'w') do |f|
+          f.write JSON.pretty_generate(ResourceSerializer.new(resource).to_h) + "\n"
+        end
+      end
+    end
+
+    private
+
+    def output_dir
+      Pathname.new RspecApiDocs.configuration.output_dir
+    end
+  end
+end

data/lib/rspec_api_docs/formatter/resource.rb

@@ -0,0 +1,130 @@
+require 'active_support/inflector'
+
+module RspecApiDocs
+  class Resource
+    attr_reader :example
+
+    def initialize(example)
+      @example = example
+    end
+
+    def name
+      metadata.fetch(:resource_name, example.metadata[:example_group][:description])
+    end
+
+    def example_name
+      metadata.fetch(:example_name, example.description)
+    end
+
+    def description
+      metadata[:description]
+    end
+
+    def parameters
+      metadata.fetch(:parameters, []).map do |name, field|
+        result = {}
+        result[:required] = true if field[:required]
+        result[:scope] = field[:scope].join unless field[:scope].empty?
+        result = result.merge(
+          name: name,
+          description: field[:description],
+        )
+        result
+      end
+    end
+
+    def response_fields
+      metadata.fetch(:fields, []).map do |name, field|
+        {
+          scope: field[:scope].join,
+          Type: field[:type],
+          name: name,
+          description: field[:description],
+        }
+      end
+    end
+
+    def requests
+      reqs = metadata.fetch(:requests, []).reject { |x| x.any?(&:nil?) }
+      reqs.map do |request, response|
+        {
+          request_method: request.request_method,
+          request_path: request_path(request),
+          request_body: request_body(request.body),
+          request_headers: request_headers(request.env),
+          request_query_parameters: request.params,
+          request_content_type: request.content_type,
+          response_status: response.status,
+          response_status_text: response_status_text(response.status),
+          response_body: response_body(response.body),
+          response_headers: response.headers,
+          response_content_type: response.content_type,
+          curl: curl,
+        }
+      end
+    end
+
+    # NOTE: returns the first route requested
+    def path
+      metadata.fetch(:path) do
+        reqs = metadata.fetch(:requests, []).reject { |x| x.any?(&:nil?) }
+        return if reqs.empty?
+        reqs.first.first.path
+      end
+    end
+
+    # NOTE: returns the first HTTP method used
+    def http_method
+      reqs = metadata.fetch(:requests, []).reject { |x| x.any?(&:nil?) }
+      return if reqs.empty?
+      reqs.first.first.request_method
+    end
+
+    def link
+      "#{name.downcase}/#{example_name.parameterize.underscore}.json"
+    end
+
+    def groups
+      'all'
+    end
+
+    private
+
+    # http://stackoverflow.com/a/33235714/826820
+    def request_headers(env)
+      Hash[
+        *env.select { |k,v| k.start_with? 'HTTP_' }
+          .collect { |k,v| [k.sub(/^HTTP_/, ''), v] }
+          .collect { |k,v| [k.split('_').collect(&:capitalize).join('-'), v] }
+          .sort.flatten
+      ]
+    end
+
+    def request_path(request)
+      URI(request.path).tap do |uri|
+        uri.query = request.query_string unless request.query_string.empty?
+      end.to_s
+    end
+
+    def request_body(body)
+      body = body.read
+      body.empty? ? nil : body
+    end
+
+    def response_body(body)
+      body.empty? ? nil : body
+    end
+
+    def response_status_text(status)
+      Rack::Utils::HTTP_STATUS_CODES[status]
+    end
+
+    # TODO
+    def curl
+    end
+
+    def metadata
+      example.metadata[METADATA_NAMESPACE]
+    end
+  end
+end

data/lib/rspec_api_docs/formatter/resource_serializer.rb

@@ -0,0 +1,21 @@
+class ResourceSerializer
+  attr_reader :resource
+
+  def initialize(resource)
+    @resource = resource
+  end
+
+  def to_h
+    {
+      resource: resource.name,
+      resource_explanation: nil,
+      http_method: resource.http_method,
+      route: resource.path,
+      description: resource.example_name,
+      explanation: resource.description,
+      parameters: resource.parameters,
+      response_fields: resource.response_fields,
+      requests: resource.requests,
+    }
+  end
+end

data/lib/rspec_api_docs/version.rb

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

data/rspec-api-docs.gemspec

@@ -0,0 +1,29 @@
+# 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 = ['Odin Dutton']
+  spec.email = ['odindutton@gmail.com']
+
+  spec.summary = 'Generate API documentation using RSpec'
+  spec.homepage = 'https://github.com/twe4ked'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.bindir = 'bin'
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'sinatra', '2.0.0.beta2'
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: rspec-api-docs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Odin Dutton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+description: 
+email:
+- odindutton@gmail.com
+executables:
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- lib/rspec_api_docs.rb
+- lib/rspec_api_docs/after.rb
+- lib/rspec_api_docs/dsl.rb
+- lib/rspec_api_docs/dsl/doc_proxy.rb
+- lib/rspec_api_docs/dsl/request_store.rb
+- lib/rspec_api_docs/formatter.rb
+- lib/rspec_api_docs/formatter/index_serializer.rb
+- lib/rspec_api_docs/formatter/renderers/json_renderer.rb
+- lib/rspec_api_docs/formatter/resource.rb
+- lib/rspec_api_docs/formatter/resource_serializer.rb
+- lib/rspec_api_docs/version.rb
+- rspec-api-docs.gemspec
+homepage: https://github.com/twe4ked
+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 documentation using RSpec
+test_files: []