rasti-web-api_doc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc62167910daa3a5fc15cade8b2d3fd3056ea7c0
+  data.tar.gz: 819145533aa50ee96802f4f0ed97119bf21ed7f7
+SHA512:
+  metadata.gz: 766997829111040e197f0a6265972ff17ad10a994746ff4e2d66aa6d311fa1555c67c4c62ce649c28d161d3908c0f5842ef85512e32b482f71b27ba7c624bbda
+  data.tar.gz: 49922f7ae586de7be2cac0ed1a2fb21fb90f654f625b11b979453f294d951cf591bb09dac396e4a403d6f78f60d866688e33f584cdd2185d6f873dd167309e90

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Gabriel Naiman
+
+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,51 @@
+# Rasti::Web::ApiDoc
+
+Generate documentation of endpoint usage based on tests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rasti-web-api_doc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rasti-web-api_doc
+
+## Usage
+
+Add following task in your Rakefile
+
+```ruby
+require 'rasti/web/api_doc'
+
+Rasti::Web::ApiDoc::Task.new(:doc) do |t|
+  t.env = './environment.rb'
+  t.app = 'MyApp::Web'
+  t.path = 'spec' # Optional
+  t.pattern = 'spec/**/*_spec.rb' # Optional
+  t.output = 'API.md' # Optional
+end
+```
+
+## Development
+
+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.
+
+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/gabynaiman/rasti-web-api_doc.
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rasti/web/api_doc"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rasti/web/api_doc/request.rb

@@ -0,0 +1,51 @@
+module Rasti
+  module Web
+    module ApiDoc
+      class Request
+
+        def initialize(env)
+          @env = env
+        end
+
+        def method
+          env['REQUEST_METHOD']
+        end
+
+        def path_info
+          env['PATH_INFO']
+        end
+
+        def route
+          env['PATH_INFO'].dup.tap do |path_info|
+            route_params.each do |name, value|
+              path_info.sub! value, ":#{name}"
+            end
+          end
+        end
+
+        def route_params
+          env['rack.request.route_params'] || {}
+        end
+
+        def query_params
+          env['rack.request.query_hash'] || {}
+        end
+
+        def form_params
+          env['rack.request.form_hash'] || {}
+        end
+
+        def headers
+          {}.tap do |hash|
+            hash['Content-Type'] = env['CONTENT_TYPE'] if env['CONTENT_TYPE']
+          end
+        end
+
+        private
+
+        attr_reader :env
+
+      end
+    end
+  end
+end

data/lib/rasti/web/api_doc/response.rb

@@ -0,0 +1,21 @@
+module Rasti
+  module Web
+    module ApiDoc
+      class Response
+
+        attr_reader :status, :headers
+
+        def initialize(status, headers, body_proxy)
+          @status = status
+          @headers = headers
+          @body_proxy = body_proxy
+        end
+
+        def body
+          @body_proxy.body
+        end
+
+      end
+    end
+  end
+end

data/lib/rasti/web/api_doc/task.rb

@@ -0,0 +1,113 @@
+module Rasti
+  module Web
+    module ApiDoc
+      class Task < Rake::TaskLib
+
+        attr_reader :name
+        attr_accessor :env, :app, :output, :pattern, :path
+
+        def initialize(name=:doc)
+          @name = name
+          @output = 'API.md'
+          @pattern = 'spec/**/*_spec.rb'
+          @path = 'spec'
+          
+          yield self if block_given?
+
+          build_task
+        end
+
+        private
+
+        def build_task
+          desc 'Build API documentation'
+          task name do
+            ENV['RACK_ENV'] ||= 'test'
+            require env if env
+            application = Object.const_get app
+
+            Rasti::Web::ApiDoc.tracker = Tracker.new application.all_routes
+
+            # Hide test runner output
+            $stdout = StringIO.new
+            $stderr = StringIO.new
+           
+            at_exit do
+              write_file
+              print_summary
+            end
+
+            # Run all tests
+            STDOUT.puts 'Building documentation'
+            $LOAD_PATH.unshift path
+            Dir.glob(File.expand_path(pattern)).each { |f| require f }
+          end
+        end
+
+        def write_file
+          File.open(File.expand_path(output), 'w') do |f|
+            f.puts '# **Endpoints**'
+
+            Rasti::Web::ApiDoc.tracker.tracks.each do |method, routes|
+              f.puts "\n## #{method}"
+              routes.each do |route, info|
+                f.puts "\n### **#{route}**"
+                if info
+                  request, response = info
+                  
+                  f.puts "**REQUEST**"
+                  f.puts "- Path info: #{request.path_info}"
+                  f.puts '- Headers' unless request.headers.empty?
+                  request.headers.each do |name, value|
+                    f.puts "  - #{name}: #{value}"
+                  end
+                  f.puts '- Route params' unless request.route_params.empty?
+                  request.route_params.each do |name, value|
+                    f.puts "  - #{name}: #{value}"
+                  end
+                  f.puts '- Query params' unless request.query_params.empty?
+                  request.query_params.each do |name, value|
+                    f.puts "  - #{name}: #{value}"
+                  end
+                  f.puts '- Form params' unless request.form_params.empty?
+                  request.form_params.each do |name, value|
+                    f.puts "  - #{name}: #{value}"
+                  end
+                  
+                  f.puts "\n**RESPONSE**"
+                  f.puts "- Status: #{response.status}"
+                  f.puts '- Headers' unless response.headers.empty?
+                  response.headers.each do |name, value|
+                    f.puts "  - #{name}: #{value}"
+                  end
+                  f.puts "- Body: #{response.body}"
+                else
+                  f.puts "Pending"
+                end
+              end
+              f.puts "\n---"
+            end
+          end
+        end
+
+        def print_summary
+          summary = Rasti::Web::ApiDoc.tracker.summary
+
+          STDOUT.puts "\nPending endpoints" unless summary[:pending_list].empty?
+          summary[:pending_list].each do |method, routes|
+            routes.each do |route|
+              STDOUT.puts "  #{method} #{route}".red
+            end
+          end
+
+          STDOUT.puts
+          STDOUT.print "#{summary[:endpoints]} endpoints, "
+          STDOUT.print "#{summary[:documented]} documented".colorize(summary[:documented] == 0 ? :white : :green)
+          STDOUT.print ", "
+          STDOUT.puts "#{summary[:pending]} pending".colorize(summary[:pending] == 0 ? :white : :red)
+        end
+
+      end
+    end
+  end
+end

data/lib/rasti/web/api_doc/tracker.rb

@@ -0,0 +1,43 @@
+module Rasti
+  module Web
+    module ApiDoc
+      class Tracker
+
+        attr_reader :tracks        
+
+        def initialize(routes)
+          @tracks = Hash.new { |h,k| h[k] = {} }
+          routes.each do |method, routes| 
+            routes.each do |route| 
+              tracks[method][route] = nil
+            end
+          end
+        end
+
+        def track(env, response)
+          req = Rasti::Web::ApiDoc::Request.new(env)
+          res = Rasti::Web::ApiDoc::Response.new(*response)
+
+          if !tracks[req.method][req.route]
+            STDOUT.puts "  #{req.method} #{req.route}".green
+            tracks[req.method][req.route] = [req, res]
+          end
+        end
+
+        def summary
+          endpoints = tracks.values.flat_map(&:keys).count
+          documented = tracks.values.flat_map(&:values).compact.count
+          pending = Hash[tracks.map { |method, routes| [method, routes.select { |route, info| info.nil? }.keys ] }].select { |method, routes| !routes.empty? }
+
+          {
+            endpoints: endpoints,
+            documented: documented,
+            pending: pending.count,
+            pending_list: pending
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/rasti/web/api_doc/version.rb

@@ -0,0 +1,7 @@
+module Rasti
+  module Web
+    module ApiDoc
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/rasti/web/api_doc.rb

@@ -0,0 +1,41 @@
+require 'colorize'
+require 'stringio'
+require 'rake'
+require 'rack/test'
+require 'rasti/web'
+
+require 'rasti/web/api_doc/request'
+require 'rasti/web/api_doc/response'
+require 'rasti/web/api_doc/task'
+require 'rasti/web/api_doc/tracker'
+require 'rasti/web/api_doc/version'
+
+module Rasti
+  module Web
+    module ApiDoc
+      
+      def self.tracker
+        @tracker
+      end
+
+      def self.tracker=(tracker)
+        @tracker = tracker
+      end
+
+    end
+  end
+end
+
+module Rack
+  class MockSession
+
+    alias_method :__request__, :request
+    
+    def request(uri, env)
+      response = __request__ uri, env
+      Rasti::Web::ApiDoc.tracker.track env, response
+      response
+    end
+
+  end
+end

data/rasti-web-api_doc.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rasti/web/api_doc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rasti-web-api_doc'
+  spec.version       = Rasti::Web::ApiDoc::VERSION
+  spec.authors       = ['Gabriel Naiman']
+  spec.email         = ['gabynaiman@gmail.com']
+
+  spec.homepage      = 'https://github.com/gabynaiman/rasti-web-api_doc'
+  spec.description   = 'Generate documentation of endpoint usage based on tests'
+  spec.summary       = 'Generate documentation of endpoint usage based on tests'
+  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_dependency 'rasti-web', '~> 0.0.6'
+  spec.add_dependency 'colorize', '~> 0.7'
+  spec.add_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'rack-test', '~> 0.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: rasti-web-api_doc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gabriel Naiman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rasti-web
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+description: Generate documentation of endpoint usage based on tests
+email:
+- gabynaiman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rasti/web/api_doc.rb
+- lib/rasti/web/api_doc/request.rb
+- lib/rasti/web/api_doc/response.rb
+- lib/rasti/web/api_doc/task.rb
+- lib/rasti/web/api_doc/tracker.rb
+- lib/rasti/web/api_doc/version.rb
+- rasti-web-api_doc.gemspec
+homepage: https://github.com/gabynaiman/rasti-web-api_doc
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Generate documentation of endpoint usage based on tests
+test_files: []