reqres_rspec 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fff2afe79f68435c6b2427a0956a13b7fcc745df
-  data.tar.gz: 8e5a3cc6f86c39a9298fd32eb95d3ab3173736db
+  metadata.gz: 6ab09afc849b19636a0c584016db5aa14da06d70
+  data.tar.gz: cf117741746332f50063c8bcd3a8224901e1fc6a
 SHA512:
-  metadata.gz: 2e2d2c9c66a38dc962c9e99e7bcbfda25851ce1de6fc9481289708e14fb11edf5180c49ee1458b8ddd541230fd13d71853ee29ee6b6a8e0acb33eb68b9c1c7f2
-  data.tar.gz: 38831de650a0ace22d13ccbcfa96b19ba9694d1c80f12954c6974be12d6e4dfd224538a042dd52ffd487ce87d227afe51385189c594c2eaa0e3fd7f3d4e36286
+  metadata.gz: a295bee73cb02b837727c841621946984d233c241a2f85a4700d7d6d4772aeb1809d4c84aa58533785df741b49b6272085a36a0c698f70b894800e77fd95ea72
+  data.tar.gz: d35cef61612ac710074bba1700ef3023636225fb9ee0328c2eecb348936f3dce3a342c90cfee668b8ea73364ffcd800a6273e31296c8fa1682f2ff018df14781

data/lib/reqres_rspec/collector.rb

@@ -1,14 +1,198 @@
-require 'reqres_rspec'
-
 module ReqresRspec
-  module Collector
+  class Collector
+    # Contains spec values read from rspec example, request and response
+    attr_accessor :records
+
+    # response headers contain many unnecessary information,
+    # everything from this list will be stripped
+    EXCLUDE_RESPONSE_HEADER_PATTERNS = %w[
+      X-Frame-Options
+      X-XSS-Protection
+      X-Content-Type-Options
+      X-UA-Compatible
+    ]
+
+    # request headers contain many unnecessary information,
+    # everything that match items from this list will be stripped
+    EXCLUDE_REQUEST_HEADER_PATTERNS = %w[
+      rack.
+      action_dispatch
+      REQUEST_METHOD
+      SERVER_NAME
+      SERVER_PORT
+      QUERY_STRING
+      SCRIPT_NAME
+      CONTENT_LENGTH
+      HTTPS
+      HTTP_HOST
+      HTTP_USER_AGENT
+      REMOTE_ADDR
+      PATH_INFO
+    ]
+
+    def initialize
+      self.records = []
+    end
+
     # collects spec data for further processing
-    def Collector.collect(spec, request, response)
-      record = {
-        title: 'title',
+    def collect(spec, request, response)
+      self.records << {
+        title: spec.example.full_description,
+        description: get_action_description(request.env['action_dispatch.request.parameters']['controller'], request.env['action_dispatch.request.parameters']['action']),
+        params: get_action_params(request.env['action_dispatch.request.parameters']['controller'], request.env['action_dispatch.request.parameters']['action']),
+        request_path: get_symbolized_path(request),
+        request: {
+          host: request.host,
+          url: request.url,
+          path: request.path,
+          method: request.request_method,
+          query_parameters: request.env['action_dispatch.request.parameters'].reject { |p| %w[controller action].include? p },
+          backend_parameters: request.env['action_dispatch.request.parameters'].reject { |p| !%w[controller action].include? p },
+          body: request.body.read,
+          content_length: request.content_length,
+          content_type: request.content_type,
+          headers: read_request_headers(request),
+          accept: request.accept,
+        },
+        response: {
+          code: response.status,
+          body: response.body,
+          headers: read_response_headers(response),
+        }
       }
+    end
+
+    private
+
+    # read and cleanup response headers
+    # returns Hash
+    def read_response_headers(response)
+      headers = response.headers
+      EXCLUDE_RESPONSE_HEADER_PATTERNS.each do |pattern|
+        headers = headers.reject { |h| h if h.starts_with? pattern }
+      end
+      headers
+    end
+
+    # read and cleanup request headers
+    # returns Hash
+    def read_request_headers(request)
+      headers = {}
+      request.env.keys.each do |key|
+        headers.merge!(key => request.env[key]) if EXCLUDE_REQUEST_HEADER_PATTERNS.all? { |p| !key.starts_with? p }
+      end
+      headers
+    end
+
+    # replace each first occurrence of param's value in the request path
+    #
+    # example
+    #   request path = /api/users/123
+    #   id = 123
+    #   symbolized path => /api/users/:id
+    #
+    def get_symbolized_path(request)
+      request_path = request.path
+
+      request.env['action_dispatch.request.parameters'].
+        reject { |param| %w[controller action].include? param }.
+        each do |key, value|
+        if value.is_a? String
+          request_path = request_path.sub(value, ":#{key}") if request_path.index(value) >= 0
+        end
+      end
+
+      request_path
+    end
+
+    # returns action comments taken from controller file
+    # example TODO
+    def get_action_comments(controller, action)
+      lines = File.readlines(File.join(Rails.root, 'app', 'controllers', "#{controller}_controller.rb"))
+
+      action_line = nil
+      lines.each_with_index do |line, index|
+        if line.match /\s*def #{action}/ #  def show
+          action_line = index
+          break
+        end
+      end
+
+      if action_line
+        comment_lines = []
+        was_comment = true
+        while action_line > 0 && was_comment
+          action_line -= 1
+
+          if lines[action_line].match /\s*#/
+            comment_lines << lines[action_line].strip
+          else
+            was_comment = false
+          end
+        end
+
+        comment_lines.reverse
+      else
+        'not found'
+      end
+    end
+
+    # returns description action comments
+    # example TODO
+    def get_action_description(controller, action)
+      comment_lines = get_action_comments(controller, action)
+
+      description = []
+      comment_lines.each_with_index do |line, index|
+        if line.match /\s*#\s*@description/ # @description blah blah
+          description << line.gsub(/\A\s*#\s*@description/, '').strip
+          comment_lines[(index + 1)..-1].each do |multiline|
+            if !multiline.match /\s*#\s*@params/
+              description << multiline.gsub(/\A\s*#\s*/, '').strip
+            else
+              break
+            end
+          end
+        end
+      end
+
+      description.join ' '
+    end
+
+    # returns params action comments
+    # example TODO
+    def get_action_params(controller, action)
+      comment_lines = get_action_comments(controller, action)
+
+      text_params = []
+      last_new_param_index = nil
+      comment_lines.each_with_index do |line, index|
+        if line.match /\s*#\s*@params/ # @params id required Integer blah blah
+          last_new_param_index = index
+          text_params << line.gsub(/\A\s*#\s*@params/, '').strip
+        elsif last_new_param_index && last_new_param_index == index - 1
+          text_params.last << " #{line.gsub(/\A\s*#\s*/, '').strip}"
+        end
+      end
+
+      params = []
+
+      text_params.each do |param|
+        match_data = param.match /(?<name>[a-z0-9A-Z_\[\]]+)?\s*(?<required>required)?\s*(?<type>Integer|Boolean|String|Text|Float|Date|DateTime|File)?\s*(?<description>.*)/
+
+        if match_data
+          params << {
+            name: match_data[:name],
+            required: match_data[:required],
+            type: match_data[:type],
+            description: match_data[:description],
+          }
+        else
+          params << { description: param }
+        end
+      end
 
-      ReqresRspec.records << record
+      params
     end
   end
 end

data/lib/reqres_rspec/generators/pdf.rb

@@ -0,0 +1,24 @@
+module ReqresRspec
+  module Generators
+    class Pdf
+      # generates PDF file from existing HTML docs
+      # TODO: more info
+      def generate
+        wkhtmltopdf_path = '/Applications/wkhtmltopdf.app/Contents/MacOS/wkhtmltopdf'
+        html_docs_root = File.join(Rails.root, 'docs')
+        pdf_doc_path = File.join(Rails.root, 'docs', "spec_#{Time.now.strftime("%d-%h-%Y_%H-%M")}.pdf")
+
+        if File.exists?(wkhtmltopdf_path)
+          files = Dir["#{html_docs_root}/rspec_docs_*.html"]
+          files_arg = files.map { |f| f if f =~ /\/rspec_docs_\d+\.html/ }.compact.sort.join(' ')
+
+          `#{wkhtmltopdf_path} #{files_arg} #{pdf_doc_path}`
+
+          puts "saved to #{pdf_doc_path}" if File.exists? pdf_doc_path
+        else
+          puts 'ERROR: wkhtmltopdf app not installed! Please check http://code.google.com/p/wkhtmltopdf/ for more info'
+        end
+      end
+    end
+  end
+end

data/lib/reqres_rspec/version.rb

@@ -1,3 +1,3 @@
 module ReqresRspec
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/lib/reqres_rspec/writers/html.rb

@@ -0,0 +1,55 @@
+module ReqresRspec
+  module Writers
+    class Html
+      def initialize(records)
+        @records = records
+      end
+
+      def write
+        cleanup
+        generate_header
+        generate_specs
+      end
+
+      private
+
+      # deletes previous version of HTML docs
+      # TODO: more info
+      def cleanup
+        FileUtils.rm_rf(Dir.glob("#{Rails.root}/docs/rspec_docs_*.html"), secure: true)
+      end
+
+      # generates contents of HTML docs
+      # TODO: more info
+      def generate_header
+        tpl_path = File.join(File.dirname(__FILE__), 'templates', 'header.erb')
+        rendered_doc = ERB.new(File.open(tpl_path).read).result(binding)
+
+        path = File.join(Rails.root, 'docs', 'rspec_docs_00000.html')
+        file = File.open(path, 'w')
+        file.write(rendered_doc)
+        file.close
+        puts "Reqres::Writers::Html saved doc header to #{path}"
+      end
+
+      # generates each separate spec example doc
+      # TODO: more info
+      def generate_specs
+        tpl_path = File.join(File.dirname(__FILE__), 'templates', 'spec.erb')
+
+        @records.each_with_index do |record, index|
+          @record = record
+          @index = index + 1
+
+          rendered_doc = ERB.new(File.open(tpl_path).read).result(binding)
+
+          path = File.join(Rails.root, 'docs', "rspec_docs_#{('0000' + (@index).to_s)[-5, 5]}.html")
+          file = File.open(path, 'w')
+          file.write(rendered_doc)
+          file.close
+          puts "Reqres::Writers::Html saved doc spec to #{path}"
+        end
+      end
+    end
+  end
+end

data/lib/reqres_rspec/writers/templates/header.erb

@@ -0,0 +1,72 @@
+<html>
+<head>
+  <title><%= Rails.application.class.to_s.sub('::Application', '') %> API Documentation</title>
+  <link href='http://fonts.googleapis.com/css?family=Droid+Sans:400,700' rel='stylesheet' type='text/css'>
+  <link href='http://fonts.googleapis.com/css?family=Droid+Sans+Mono' rel='stylesheet' type='text/css'>
+  <style>
+    body {
+      color: #333333;
+      font-family: 'Verdana', 'Droid Sans', sans-serif;
+      font-size: 14px;
+      padding: 0;
+      margin: 0;
+    }
+    body *{
+      -webkit-box-sizing: border-box;
+      -moz-box-sizing: border-box;
+      box-sizing: border-box;
+    }
+    .container {
+      padding: 40px;
+    }
+    h1, h2, ul {
+      margin: 0 0 10px;
+      padding: 0;
+    }
+    h1 {
+      font-size: 2.286em;
+    }
+    h2 {
+      font-size: 2em;
+    }
+    a {
+      color: #1d96d2;
+      text-decoration: none;
+    }
+    ul {
+      padding-left: 0;
+      list-style: none;
+    }
+    li{
+      margin-bottom: 4px;
+    }
+
+    ol{
+      margin: 0 0 10px 0;
+      padding: 0 10px 0 50px;
+    }
+    ol li{
+      white-space: pre;
+      border-left: 1px solid #ccc;
+      margin: 0;
+      padding: 0 4px;
+    }
+  </style>
+</head>
+<body>
+<div class="container">
+  <h1><%= Rails.application.class.to_s.sub('::Application', '') %> API Documentation</h1>
+  <p>Generated <%= Time.now.strftime('%d %B %Y at %H:%m:%S')%></p>
+  <ul>
+    <% @records.each_with_index do |record, index| %>
+      <li>
+        <%= index+1 %>.
+        <a href="rspec_docs_<%= ('0000' + (index + 1).to_s)[-5, 5] %>.html">
+          <%= record[:title] %>
+        </a>
+      </li>
+    <% end %>
+  </ul>
+</div>
+</body>
+</html>

data/lib/reqres_rspec/writers/templates/spec.erb

@@ -0,0 +1,213 @@
+<html>
+<head>
+  <title><%= Rails.application.class.to_s.sub('::Application', '') %> API Documentation</title>
+  <link href='http://fonts.googleapis.com/css?family=Droid+Sans:400,700' rel='stylesheet' type='text/css'>
+  <link href='http://fonts.googleapis.com/css?family=Droid+Sans+Mono' rel='stylesheet' type='text/css'>
+  <style>
+    body {
+      color: #333333;
+      font-family: 'Verdana', 'Droid Sans', sans-serif;
+      font-size: 14px;
+      padding: 0;
+      margin: 0;
+    }
+    body *{
+      -webkit-box-sizing: border-box;
+      -moz-box-sizing: border-box;
+      box-sizing: border-box;
+    }
+    .container {
+      padding: 40px;
+    }
+    h1, h2, ul {
+      margin: 0 0 10px;
+      padding: 0;
+    }
+    h1 {
+      font-size: 2.286em;
+    }
+    h2 {
+      font-size: 2em;
+    }
+    h3{
+      font-size: 1.57em;
+      margin: 14px 0 0px;
+      padding: 0;
+    }
+    h4{
+      font-size: 1.15em;
+      margin: 14px 0 0 0;
+      padding: 0;
+    }
+    h5{
+      font-size: 1em;
+      margin: 10px 0 0 0;
+      padding: 0;
+    }
+    a {
+      color: #1d96d2;
+      text-decoration: none;
+    }
+    .required {
+      color: #f00;
+    }
+    ul {
+      padding-left: 0;
+      list-style: none;
+    }
+    li{
+      margin-bottom: 4px;
+    }
+    .table{
+      border: 1px solid #cccccc;
+      border-radius: 4px;
+      overflow: hidden;
+    }
+    table{
+      width: 100%;
+      font-size: 1em;
+      padding: 0;
+      margin: 0;
+      border-collapse: collapse;
+      border-spacing: 0px;
+    }
+    tr{
+      border-top: 1px solid #cccccc;
+    }
+    tr:first-child{
+      border-top: 0
+    }
+    th, td{
+      margin: 0;
+      padding: 5px 8px;
+      text-align: left;
+      border-left: 1px solid #cccccc;
+      font-size: 1em;
+    }
+    th:first-child, td:first-child{
+      border-left: 0;
+    }
+    td{
+      background: #f9f9f9;
+    }
+    tr:nth-child(2n+1) td{
+      background: #ffffff;
+    }
+    td i{
+      font-style: normal;
+      font-weight: 300;
+      float: right;
+    }
+
+    code, ol{
+      display: block;
+      border-radius: 6px;
+      border: 1px solid #cccccc;
+      width: 100%;
+      background: #f5f5f5;
+      font-family: 'Courier New','Droid Sans Mono', monospace;
+      font-size: 0.85em;
+      font-weight: 700;
+    }
+    code{
+      white-space: pre-line;
+      padding: 10px;
+      font-size: 0.85em;
+    }
+    code i{
+      font-weight: 400;
+      font-style: normal;
+    }
+    ol{
+      margin: 0 0 10px 0;
+      padding: 0 10px 0 50px;
+    }
+    ol li{
+      white-space: pre;
+      border-left: 1px solid #ccc;
+      margin: 0;
+      padding: 0 4px;
+    }
+  </style>
+</head>
+<body>
+  <div class="container">
+    <h3>
+      <a href="rspec_docs_00000.html">&#9650</a>
+      <a id="<%= @index %>"></a><%= @index %>. <%= @record[:title] %>
+    </h3>
+
+    <p><%= @record[:description] %></p>
+
+    <code><%= @record[:request][:method] %> <%= @record[:request_path] %></code>
+
+    <% if @record[:params].size > 0 %>
+      <h5>Parameters</h5>
+      <div class="table">
+        <table>
+          <tr>
+            <th>Name</th>
+            <th>Type</th>
+            <th>Description</th>
+          </tr>
+          <% @record[:params].each do |param| %>
+            <tr>
+              <td><%= param[:name] %> <i class="required"><%= param[:required] %></i></td>
+              <td><%= param[:type] %></td>
+              <td><%= param[:description] %></td>
+            </tr>
+          <% end %>
+        </table>
+      </div>
+    <% end %>
+
+    <h4>Request</h4>
+
+    <% if @record[:request][:headers].keys.count > 0 %>
+      <h5>Headers</h5>
+      <code><%= @record[:request][:headers].collect { |k, v| "#{k}: <i>#{v}</i>"}.join("\n")%></code>
+    <% end %>
+
+    <h5>Route</h5>
+    <code><%= @record[:request][:method] %> <%= @record[:request][:path] %></code>
+
+    <h5>Query parameters</h5>
+    <code><%= @record[:request][:query_parameters] %></code>
+
+    <h5><a href="http://curl.haxx.se/docs/manpage.html">CURL</a> Example</h5>
+    <code>TODO</code>
+
+    <% if @record[:request][:body].present? %>
+      <h5>Body</h5>
+      <ol>
+        <% @record[:request][:body].split("\n").each do |line| %>
+          <li><%= line %></li>
+        <% end %>
+      </ol>
+    <% end %>
+
+    <h4>Response</h4>
+
+    <% if @record[:response][:headers].count > 0 %>
+      <h5>Headers</h5>
+      <code><%= @record[:response][:headers].collect { |k, v| "#{k}: <i>#{v}</i>"}.join("\n")%></code>
+    <% end %>
+
+    <h5>Status code (<a href="http://en.wikipedia.org/wiki/List_of_HTTP_status_codes">wiki</a>)</h5>
+    <code>HTTP <%= @record[:response][:code] %></code>
+
+    <% if @record[:response][:body].present? %>
+      <h5>Body</h5>
+      <ol>
+        <% JSON.pretty_generate(
+             JSON.parse(
+               @record[:response][:body]
+             )
+           ).split("\n").each do |line| %>
+          <li><%= line %></li>
+        <% end %>
+      </ol>
+    <% end %>
+  </div>
+</body>
+</html>

data/lib/reqres_rspec.rb

@@ -1,41 +1,27 @@
-# to enable mattr_accessor
-require "active_support/core_ext/module/attribute_accessors"
+require 'reqres_rspec/version'
+require 'reqres_rspec/collector'
+require 'reqres_rspec/writers/html'
+require 'reqres_rspec/generators/pdf'
 
-require "reqres_rspec/version"
-require "reqres_rspec/collector"
-
-module ReqresRspec
-  # Contains spec values read from rspec example, request and response
-  mattr_accessor :records
-
-  # define if all doc generation is enabled
-  mattr_accessor :enabled
-end
-
-ReqresRspec.enabled = defined?(RSpec)
-
-if !ReqresRspec.enabled
-  puts "\nWARNING: ReqresRspec is disabled\n"
-end
-
-if ReqresRspec.enabled
-  # initialize
-  ReqresRspec.records = []
+if defined?(RSpec) && ENV['REQRES_RSPEC'] == '1'
+  collector = ReqresRspec::Collector.new
 
   RSpec.configure do |config|
     config.after(:each) do
       if defined?(request) && defined?(response)
         unless self.example.options.has_key?(:rspec_doc) && !self.example.options[:rspec_doc]
-          ReqresRspec::Collector.collect(self, request, response)
+          collector.collect(self, request, response)
         end
       end
     end
 
     config.after(:suite) do
-      if ReqresRspec.records && ReqresRspec.records.size > 0
-        puts 'TODO: save records'
-        puts ReqresRspec.records.inspect
+      if collector.records.size > 0
+        ReqresRspec::Writers::Html.new(collector.records).write
+        ReqresRspec::Generators::Pdf.new.generate
       end
     end
   end
+else
+  puts "\nNOTICE: ReqresRspec is disabled. run RSpec with REQRES_RSPEC=1 environment var\n"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reqres_rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - rilian
@@ -53,7 +53,11 @@ files:
 - Rakefile
 - lib/reqres_rspec.rb
 - lib/reqres_rspec/collector.rb
+- lib/reqres_rspec/generators/pdf.rb
 - lib/reqres_rspec/version.rb
+- lib/reqres_rspec/writers/html.rb
+- lib/reqres_rspec/writers/templates/header.erb
+- lib/reqres_rspec/writers/templates/spec.erb
 - reqres_rspec.gemspec
 homepage: ''
 licenses: