crapidocs 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b995140375b7d77b964c283f94f807214ff86e39
-  data.tar.gz: ff4721f9536bb7060a2b995ce38a408af25faaa3
+  metadata.gz: bd4e5f30914afdc7a2ee4d2faf1d3697de2397ef
+  data.tar.gz: fa43f26801d4135f60e2ebe2fd94f065ab665a80
 SHA512:
-  metadata.gz: 86e217248f99650808772dda6d324313d50f1e03f47919a25480f88c668b5e68b4c6f132354a0c362505bf060522c7608956025e935164900a831116e0ce2f72
-  data.tar.gz: 3835c184c6e0e75dbd35eb828e924b8307d9c04ae60ace13e485aa94c9964d9b067f54eda76a0ee37afca7a15b20d1857e5545a14f128e23de4d10afe52e0864
+  metadata.gz: bc1d214ebecba8346c73917a77d665be77200f8f8b8fdbe94a8a7c226fb33519e93e7d32c9772eaa55dfd189bd983980c12461e8993c0eac7040ea0a5964b1de
+  data.tar.gz: 5beee50d7511be80b705ad0434daeadf376eb30a56f84f727c9b343cf9e318061d5473e4079b042f19daba58d080cff6a903d7d847a5ed384d316c46306f6daa

data/lib/crapidocs/formatter.rb

@@ -0,0 +1,23 @@
+require 'erubis'
+
+module CrapiDocs
+  class Formatter
+    def initialize(session)
+      @session = session
+    end
+
+    def to_md
+      Erubis::Eruby.new(load_template).result(binding)
+    end
+
+    private
+
+    def load_template
+      File.open("#{TEMPLATE_DIR}/layout.md.erb").read
+    end
+
+    def anchor(s)
+      s.gsub(/[^a-zA-Z0-9]/, '')
+    end
+  end
+end

data/lib/crapidocs/session.rb

@@ -0,0 +1,92 @@
+module CrapiDocs
+  class Session
+    def initialize(pattern)
+      @pattern = pattern
+      @actions = {}
+    end
+
+    def track(args, result)
+      uri, env = args
+      status, headers, body = result
+      body = body.respond_to?(:body) ? body.body : ''
+      method = env['REQUEST_METHOD']
+
+      return unless relevant?(uri)
+
+      action = {
+        request: {
+          method: method,
+          body: env['rack.input'].string,
+          headers: env,
+          uri: uri
+        },
+        response: {
+          status: status,
+          headers: headers,
+          body: body
+        }
+      }
+
+      path = cleaned_path(uri)
+      @actions[path] ||= {}
+      @actions[path][method] ||= []
+      @actions[path][method] << action
+    end
+
+    def paths
+      @actions.keys.sort
+    end
+
+    def methods(path)
+      @actions[path].keys.sort
+    end
+
+    def params(path, method)
+      reqs = @actions[path][method].map { |a| a[:request] }
+      params = merge_params(reqs)
+      return nil unless params.keys.any?
+      params
+    end
+
+    def body(path, method)
+      res = @actions[path][method]
+        .map { |a| a[:response] }
+        .find { |r| r[:status] / 100 == 2 }
+      return nil unless res
+      JSON.parse(res[:body])
+    end
+
+    private
+
+    def merge_params(reqs)
+      params = reqs.reduce({}) do |hash, r|
+        ps = if r[:headers]['Content-Type'] =~ /json/
+          JSON.parse(r[:body]) rescue {}
+        else
+          Rack::Utils.parse_nested_query(r[:body])
+        end
+        hash.merge(ps)
+      end
+      params.delete('format')
+      params
+    end
+
+    def cleaned_path(uri)
+      last = nil
+      uri.path.split('/').reject(&:blank?).reduce('') do |cleaned, part|
+        part = ":#{last.singularize}_id" if part =~ /^\d+$/
+        part = ':token' if tokenish?(part)
+        last = part
+        "#{cleaned}/#{part}"
+      end
+    end
+
+    def tokenish?(s)
+      s =~ /\d+/ && s =~ /[a-zA-Z]+/ && s.length >= 10
+    end
+
+    def relevant?(uri)
+      (uri.to_s =~ @pattern).present?
+    end
+  end
+end

data/lib/crapidocs.rb

@@ -16,7 +16,7 @@ module Rack
 end
 
 module CrapiDocs
-  VERSION = [0, 1]
+  VERSION = [0, 1, 1]
   TEMPLATE_DIR = File.expand_path('../..', __FILE__) + '/templates'
 
   class << self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crapidocs
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Mike Holly
@@ -17,6 +17,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/crapidocs.rb
+- lib/crapidocs/formatter.rb
+- lib/crapidocs/session.rb
 homepage: https://rubygems.org/gems/crapidocs
 licenses:
 - MIT