rasti-web-api_doc 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 18e4f3e36ab7fafa94ed98bc51f2ecd2bd42ac62
-  data.tar.gz: 22ff7c3a9a03b00a92ad655e1cd8c646d521af85
+SHA256:
+  metadata.gz: f2918bc3d975edbbf5fc8ed202d501748a944426ea11a30ae013ef6a9a2d961d
+  data.tar.gz: 989e07a070c1140e02356fc9f124e24ee4346d379b23a53482b4368242696963
 SHA512:
-  metadata.gz: 93d9e7b53dadbca34abc5ed5723e78adf2bac5694998eb14717d990b78dd7fa16a230200f7bb5e78544b8160a0586513c4c8ff05a17a5c54f09304191804f514
-  data.tar.gz: a7252d3080118aed1904edf2002a2e3ed2f4526af05887f97c943885a01e6614fd98798c5f96933bd3476c501a452777214f9eace5ff726dfd08becfc6b67584
+  metadata.gz: c05140e0b79fd99903b5f130c2d40dce228ee3dc03d5c04bbb65125ab33ef886e7f9283c7a87d78d3bfbc25881f5ebb1f790151d069469d18ca50fff676f5089
+  data.tar.gz: 70c5dc918ad9af7f6e9b671472e3a6215dcdae74ea66de6c3a52563dafe79cd8932d54327e865d1f967d72bc1914896940b2e2ac1adf6b82222c1744593aaf93

data/.ruby-version

@@ -1 +1 @@
-ruby 2.0
+ruby-2.5.0

data/lib/rasti/web/api_doc.rb

@@ -1,4 +1,4 @@
-require 'colorize'
+require 'colorin'
 require 'stringio'
 require 'rake'
 require 'rake/tasklib'

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

@@ -36,9 +36,10 @@ module Rasti
         end
 
         def headers
-          {}.tap do |hash|
-            hash['Content-Type'] = env['CONTENT_TYPE'] if env['CONTENT_TYPE']
-          end
+          headers = env.select { |k,v| k.start_with?('HTTP_') || k == 'CONTENT_TYPE' }
+                       .map { |k,v| [k.sub(/^HTTP_/, '').split('_').map(&:capitalize).join('-'), v] }
+                       .sort
+          Hash[headers]
         end
 
         private

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

@@ -28,22 +28,28 @@ module Rasti
 
             Rasti::Web::ApiDoc.tracker = Tracker.new application.all_routes
 
-            # Hide test runner output
-            $stdout = StringIO.new
-            $stderr = StringIO.new
+            disable_test_runner_output
            
             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 }
+            run_all_tests
           end
         end
 
+        def disable_test_runner_output
+          $stdout = StringIO.new
+          $stderr = StringIO.new
+        end
+
+        def run_all_tests
+          STDOUT.puts 'Building documentation'
+          $LOAD_PATH.unshift path
+          Dir.glob(File.expand_path(pattern)).each { |f| require f }
+        end
+
         def write_file
           File.open(File.expand_path(output), 'w') do |f|
             f.puts '# **Endpoints**'
@@ -96,15 +102,16 @@ module Rasti
           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
+              STDOUT.puts "  #{Colorin.amber_300(method.ljust(6, ' ')).bold} #{route}"
             end
           end
 
           STDOUT.puts
-          STDOUT.print "#{summary[:endpoints]} endpoints, "
-          STDOUT.print "#{summary[:documented]} documented".colorize(summary[:documented] == 0 ? :white : :green)
+          STDOUT.print Colorin.blue_a700("#{summary[:endpoints]} endpoints")
+          STDOUT.print ", "
+          STDOUT.print Colorin.green_500("#{summary[:documented]} documented")
           STDOUT.print ", "
-          STDOUT.puts "#{summary[:pending]} pending".colorize(summary[:pending] == 0 ? :white : :red)
+          STDOUT.puts Colorin.amber_300("#{summary[:pending]} pending")
         end
 
       end

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

@@ -5,9 +5,9 @@ module Rasti
 
         attr_reader :tracks        
 
-        def initialize(routes)
+        def initialize(routes_by_method)
           @tracks = Hash.new { |h,k| h[k] = {} }
-          routes.each do |method, routes| 
+          routes_by_method.each do |method, routes| 
             routes.each do |route| 
               tracks[method][route] = nil
             end
@@ -19,7 +19,7 @@ module Rasti
           res = Rasti::Web::ApiDoc::Response.new(*response)
 
           if !tracks[req.method][req.route]
-            STDOUT.puts "  #{req.method} #{req.route}".green
+            STDOUT.puts "  #{Colorin.green_500(req.method.ljust(6, ' ')).bold} #{req.route}"
             tracks[req.method][req.route] = [req, res]
           end
         end
@@ -32,7 +32,7 @@ module Rasti
           {
             endpoints: endpoints,
             documented: documented,
-            pending: pending.count,
+            pending: pending.values.map(&:count).sum,
             pending_list: pending
           }
         end

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

@@ -1,7 +1,7 @@
 module Rasti
   module Web
     module ApiDoc
-      VERSION = '1.0.1'
+      VERSION = '1.1.0'
     end
   end
 end

data/rasti-web-api_doc.gemspec

@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'colorin', '~> 2.0'
   spec.add_dependency 'rasti-web'
-  spec.add_dependency 'colorize', '~> 0.7'
-  spec.add_dependency 'rake', '~> 10.0'
-  spec.add_dependency 'rack-test', '~> 0.6'
+  spec.add_dependency 'rake'
+  spec.add_dependency 'rack-test'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: rasti-web-api_doc
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Gabriel Naiman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-19 00:00:00.000000000 Z
+date: 2018-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rasti-web
+  name: colorin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: rasti-web
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
 - !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
@@ -87,15 +87,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-gemset
-- .ruby-version
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - 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
@@ -113,17 +111,17 @@ 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
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Generate documentation of endpoint usage based on tests

data/bin/console

@@ -1,14 +0,0 @@
-#!/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

@@ -1,8 +0,0 @@
-#!/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