lecter 0.1.6 → 0.2.0

data/README.md

@@ -1,71 +1,179 @@
-# Lecter. Online debugger
+<div align="center">
+  <img src="https://github.com/Neodelf/staff/blob/master/lecter_web_with_text.png?raw=true" alt="Lecter Logo" width="866px"/>
 
-There are a lot of people around developing web apps also as new developers on projects. Sometimes they don't know how app works and which exactly processes work.
-That gem will help them to understand which code executes per request.
- 
+  <h1 color="#98793a">Lecter shows an executed code by a URL request. <br/>
+    Debug an unknown code in SECONDS!
+  </h1>
 
-## Installation
+  [![Gem Version][0]][1]
+  [![Ruby Style Guide][15]][16]
+  [![CircleCI][2]][3]
+  [![Test Coverage][12]][13]
+  [![Maintainability][10]][11]
+  [![All Contributors](https://img.shields.io/badge/all_contributors-5-green.svg)](#contributors-)
+</div>
 
-Add this line to your application's Gemfile:
+> Quid pro quo. I tell you things, you tell me things. Not about this case, though. About yourself. <br/>
+> -- Hannibal Lecter / The Silence of the Lambs
 
-```ruby
-group :development do
-  gem 'lecter', git: 'https://github.com/neodelf/lecter'
-end
-```
+----------
 
-And then execute:
+## Table of contents
+* [:rotating_light: Problems](#rotating_light-problems)
+* [:rocket: Solutions](#rocket-solutions)
+* [:bangbang: Requirements](#bangbang-requirements)
+* [:hammer_and_wrench: Installation](#hammer_and_wrench-installation)
+* [:joystick: Usage](#joystick-usage)
+* [:man_technologist: Examples](#man_technologist-examples)
+* [:heart: Sponsors](#card_file_box-license)
+* [:desktop_computer: Contributing & Contributors](#desktop_computer-contributing--contributors)
+* [:card_file_box: License](#card_file_box-license)
 
-    $ bundle
+## :rotating_light: Problems
+1. Developers **don't know** how their app works.
+2. Reading code is a **long** process.
+3. Memorizing many lines of code is **difficult**.
 
-## Usage
+## :rocket: Solutions
+1. The main purpose of this gem is **to help developers understand which code is executed** by a request.<br>
 
+2. Gem's purpose could be compared to visiting a doctor:
+   You give the symptoms of your disease and **receive a diagnosis**.<br>
+   You give the parameters of a request and **receive executable code**.
 
-1. Use multithreading server such like a `puma` with workers more than `1`.
-2. Precompile `lecter.css lecter.js` assets.
-3. Add routes in your `routes.rb`
+3. You don't have to work with debuggers, read and remember many lines of code.<br>
+   Just **give & receive**!
 
-    ```ruby
-    mount Lecter::Engine => '/lecter'
-    ```
-
-4. Go to `/lecter/diagnosis/new` and fill fields:
-
-    `endpoint` - use absolute route like `localhost:3000/blogs`
- 
-    `params` - parameters which will be handled on request
- 
-    `method` - choose one variant
-
-Examples to use
- 1. `POST` method:
- 
-    `endpoint` - `localhost:3000/posts`
-    
-    `params` - `"post"=>{"title"=>"New title", "description"=>"Desciption"}`
-    
-    `method` - `POST`
-
- ![alt text](https://raw.githubusercontent.com/neodelf/staff/master/lecter_post_web.gif)
-
- 2. `GET` method:
- 
-    `endpoint` - `localhost:3000/posts`
+## :bangbang: Requirements
+Please **use a multithreading server** such as a [puma][4] server with more than `1` worker.<br>
+For more information about how to tune a puma server, please visit this [link][5].
 
-    `params` - empty field
+## :hammer_and_wrench: Installation
+Installing is a **very simple** process.
 
-    `method` - `GET`
+1. **Add** the gem to your Gemfile:
 
- ![alt text](https://raw.githubusercontent.com/neodelf/staff/master/lecter_get_web.gif)
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/neodelf/lecter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+    ```ruby
+    group :development do
+      gem 'lecter', github: 'neodelf/lecter'
+    end
+    ```
 
-## License
+2. **Execute** in a terminal in your app's directory:
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+    ```zsh
+    bundle install
+    ```
 
-## Code of Conduct
+3. **Add** routes to your `config/routes.rb`:
+    ```ruby
+    mount Lecter::Engine => '/lecter' if Rails.env.development?
+    ```
 
-Everyone interacting in the Lecter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lecter/blob/master/CODE_OF_CONDUCT.md).
+## :joystick: Usage
+Follow **two** simple steps:
+
+1. **Go** to `/lecter`
+
+2. **Fill in** the form fields with request parameters:
+
+   `HTTP method` - request's method<br>
+   `Endpoint` - use absolute route like `localhost:3000/blogs`<br>
+   `Headers` - request's headers
+   `Body(raw)` - request's parameters
+
+## :man_technologist: Examples
+Here is an example with a **POST** request:
+
+1. **Go** to `localhost:3000/lecter`
+
+2. **Fill** in the form with:
+
+   `HTTP method` - `POST`<br>
+   `Endpoint` - `localhost:3000/posts`<br>
+   `Headers` - `content_type=text/html,accept=*/*`<br>
+   `Body(raw)` - `"post"=>{"title"=>"New title", "description"=>"Desciption"}`
+
+    <img src="https://raw.githubusercontent.com/Neodelf/staff/master/lecter_post_headers.png" alt="lecter example post form" title="Example Lecter POST request form" />
+
+3. **Submit** the form
+4. **Review** the result
+
+    <img src="https://raw.githubusercontent.com/Neodelf/staff/master/lecter-post-result.png" alt="lecter post form result" title="Example Lecter POST request result" />
+
+## :heart: Sponsors
+[<img width="200" src="https://github.com/Neodelf/staff/blob/master/evrone-sponsored-logo.png?raw=true" alt="Evrone Logo"/>][14]
+
+## :desktop_computer: Contributing & Contributors
+1. Bug reports and pull requests **are welcome**.
+2. There are many issues as a proposal to improve this library. If you have any ideas, please **feel free** to write your thoughts in a [new issue][7].
+3. Choose **what you like** to fix or improve on the [issues list][8]. You can ask any questions in the comments.
+4. :bangbang: **Mention of each contributor** will be on the README file.
+
+**Thanks** goes to these wonderful people:
+
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center">
+      <a href="https://github.com/pineapplethief">
+        <img src="https://avatars1.githubusercontent.com/u/4012690?v=4" width="100px;" alt=""/>
+        <br />
+        <sub><b>Aleksey Glukhov</b></sub>
+      </a>
+      <br />
+      <a href="https://github.com/Neodelf/lecter/commits?author=pineapplethief" title="Code">💻</a>
+      <a href="https://github.com/Neodelf/lecter/commits?author=pineapplethief" title="Documentation">📖</a>
+    </td>
+    <td align="center">
+      <a href="https://github.com/atayl16">
+        <img src="https://avatars.githubusercontent.com/u/24377351?v=4" width="100px;" alt=""/>
+        <br />
+        <sub><b>Alisha Taylor</b></sub>
+      </a>
+      <br />
+      <a href="https://github.com/Neodelf/lecter/commits?author=atayl16" title="Documentation">📖</a>
+    </td>
+    <td align="center">
+      <a href="https://github.com/gambala">
+        <img src="https://avatars.githubusercontent.com/u/2563426?v=4" width="100px;" alt=""/>
+        <br />
+        <sub><b>Vitaliy Emeliyantsev</b></sub>
+      </a>
+      <br />
+      <a href="https://github.com/Neodelf/lecter/commits?author=gambala" title="Documentation">📖</a>
+    </td>
+    <td align="center">
+      <a href="https://github.com/oskaror">
+        <img src="https://avatars.githubusercontent.com/u/12644040?v=4" width="100px;" alt=""/>
+        <br />
+        <sub><b>Oskar Janusz</b></sub>
+      </a>
+      <br />
+      <a href="https://github.com/Neodelf/lecter/commits?author=oskaror" title="Code">💻</a>
+    </td>
+  </tr>
+</table>
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+
+## :card_file_box: License
+The gem is available as open source under the terms of the [MIT License][9].
+
+[0]: https://badge.fury.io/rb/lecter.svg
+[1]: https://badge.fury.io/rb/lecter
+[2]: https://circleci.com/gh/Neodelf/lecter.svg?style=shield
+[3]: https://circleci.com/gh/neodelf/lecter
+[4]: https://github.com/puma/puma
+[5]: https://github.com/puma/puma#clustered-mode
+[7]: https://github.com/Neodelf/lecter/issues/new
+[8]: https://github.com/Neodelf/lecter/issues
+[9]: https://opensource.org/licenses/MIT
+[10]: https://api.codeclimate.com/v1/badges/45d57f439d66990490f1/maintainability
+[11]: https://codeclimate.com/github/Neodelf/lecter/maintainability
+[12]: https://api.codeclimate.com/v1/badges/45d57f439d66990490f1/test_coverage
+[13]: https://codeclimate.com/github/Neodelf/lecter/test_coverage
+[14]: https://evrone.com
+[15]: https://img.shields.io/badge/code_style-rubocop-brightgreen.svg
+[16]: https://rubystyle.guide

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/app/controllers/lecter/diagnosis_controller.rb

@@ -1,77 +1,56 @@
-require 'rest-client'
-require 'slim-rails'
+# frozen_string_literal: true
 
 module Lecter
   class DiagnosisController < ActionController::Base
     layout 'lecter'
-    before_action :format_params, only: :create
+    before_action :format_request_data, only: :create
 
-    def new
-    end
+    def new; end
 
     def show
       redirect_to new_diagnosis_path
     end
 
     def create
-      response = RestClient::Request.execute(
-        method: diagnosis_method.downcase.to_sym,
-        url: diagnosis_params[:endpoint],
-        payload: format_params
-      )
-      return render :new unless response
-
-      prepare_data(response.body)
-      render :show
-    rescue URI::InvalidURIError
-      flash[:error] = 'Wrong url'
-      return render :new
-    rescue RestClient::ExceptionWithResponse => e
-      flash[:error] = e.message
-      return render :new
+      requester = Lecter::Requester.new(requester_params)
+      if requester.call
+        @file_listings = HtmlGenerator.new(requester.lines).call
+        render :show
+      else
+        flash[:error] = requester.error_message
+        render :new
+      end
     end
 
     private
 
     def diagnosis_params
-      params.permit(:endpoint, :params, :method)
+      params.permit(:endpoint, :body_raw, :method, :headers)
     end
 
-    def prepare_data(response_body)
-      @lines = []
-      @response_status = response_body[0..2]
-      @items = response_body[3..-1].split(';')
-      @items.each do |item|
-        file = item.split(' ')[0]
-        if @lines.last.is_a?(Hash) && @lines.last.keys.first.to_s == file
-          @lines.last[file] = @lines.last[file] << item.split(' ')[1].to_i
-        else
-          @lines << {"#{file}" => [item.split(' ')[1].to_i]}
-        end
-      end
+    def requester_params
+      {
+        method: diagnosis_params[:method].downcase.to_sym,
+        url: diagnosis_params[:endpoint],
+        payload: formatter_payload.result,
+        headers: formatted_headers.result
+      }
     end
 
-    def format_params
-      @format_params ||= begin
-        json_parse(diagnosis_params[:params]).merge(lecter_analysis_parameter)
-      rescue JSON::ParserError
-        flash[:error] = 'Wrong parameters'
-        return render :new
-      end
-    end
+    def format_request_data
+      formatters = [formatter_payload, formatted_headers]
+      return if formatters.all?(&:call)
 
-    def lecter_analysis_parameter
-      { lecter_analysis: true }
+      flash[:error] = formatters.map(&:error_message).join(', ')
+      render :new
     end
 
-    def json_parse(string)
-      string = '{' + string + '}' unless string.match(/\A{.*}\z/)
-      string.gsub!('=>', ':')&.gsub!(/(“|”)/, '"')
-      JSON.parse(string)
+    def formatter_payload
+      @formatter_payload ||= Lecter::FormatterPayload.new(diagnosis_params[:body_raw])
     end
 
-    def diagnosis_method
-      diagnosis_params[:method].downcase
+    def formatted_headers
+      @formatted_headers ||= Lecter::FormatterHeaders.new(diagnosis_params[:headers])
     end
   end
 end

data/app/views/layouts/lecter.html.erb

@@ -0,0 +1,258 @@
+<html>
+  <head>
+    <title><%= yield(:title) %></title>
+    <%= javascript_include_tag '//code.jquery.com/jquery-1.12.4.js', '//code.jquery.com/ui/1.12.1/jquery-ui.js' %>
+    <%= javascript_include_tag 'https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js' %>
+    <%= stylesheet_link_tag 'https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css' %>
+  </head>
+
+  <style>
+    .hljs {
+        display: block;
+        overflow-x: auto;
+        padding: 0.5em;
+        background: #232323;
+        color: #e6e1dc;
+    }
+
+    .hljs-comment,
+    .hljs-quote {
+        color: #bc9458;
+        font-style: italic;
+    }
+
+    .hljs-keyword,
+    .hljs-selector-tag {
+        color: #c26230;
+    }
+
+    .hljs-string,
+    .hljs-number,
+    .hljs-regexp,
+    .hljs-variable,
+    .hljs-template-variable {
+        color: #a5c261;
+    }
+
+    .hljs-subst {
+        color: #519f50;
+    }
+
+    .hljs-tag,
+    .hljs-name {
+        color: #e8bf6a;
+    }
+
+    .hljs-type {
+        color: #da4939;
+    }
+
+
+    .hljs-symbol,
+    .hljs-bullet,
+    .hljs-built_in,
+    .hljs-builtin-name,
+    .hljs-attr,
+    .hljs-link {
+        color: #6d9cbe;
+    }
+
+    .hljs-params {
+        color: #d0d0ff;
+    }
+
+    .hljs-attribute {
+        color: #cda869;
+    }
+
+    .hljs-meta {
+        color: #9b859d;
+    }
+
+    .hljs-title,
+    .hljs-section {
+        color: #ffc66d;
+    }
+
+    .hljs-addition {
+        background-color: #144212;
+        color: #e6e1dc;
+        display: inline-block;
+        width: 100%;
+    }
+
+    .hljs-deletion {
+        background-color: #600;
+        color: #e6e1dc;
+        display: inline-block;
+        width: 100%;
+    }
+
+    .hljs-selector-class {
+        color: #9b703f;
+    }
+
+    .hljs-selector-id {
+        color: #8b98ab;
+    }
+
+    .hljs-emphasis {
+        font-style: italic;
+    }
+
+    .hljs-strong {
+        font-weight: bold;
+    }
+
+    .hljs-link {
+        text-decoration: underline;
+    }
+
+    /* diagnosis/show.slim */
+
+
+    .down {
+        border-left: 5px solid transparent;
+        border-right: 5px solid transparent;
+        border-top: 5px solid black;
+        margin: 10px 7px 0 5px;
+    }
+
+    .ui-accordion .ui-accordion-header {
+        font-size: 78%;
+    }
+
+    .sidebar {
+        float: left;
+    }
+
+    .sidebar > .sidebar-wrapper {
+        width: 235px;
+        position: fixed;
+        margin: 49px 33px 0 0;
+        overflow-y: scroll;
+        top: 82px;
+        bottom: 40px;
+    }
+
+    .sidebar-wrapper > ul {
+        list-style-type: none;
+        height: calc(100% - 40px);
+    }
+
+    .sidebar-wrapper > ul > li {
+        margin-bottom: 3px;
+    }
+
+    .sidebar-wrapper > ul > li > a {
+        text-decoration: none;
+        color: inherit;
+        display: block;
+        font-size: 13px;
+        text-inline: 1.5;
+    }
+
+    .sidebar-wrapper > ul > li > a:hover {
+        color: #7d7d7d;
+    }
+
+    .right {
+        float: left;
+        padding-left: 10px;
+        width: 70%;
+        margin-left: 295px;
+    }
+
+    .listing {
+        display: none;
+        padding: 1em 2.2em;
+        overflow: auto;
+        border-bottom-right-radius: 4px;
+        border: 0.5px solid;
+        border-top-width: 0;
+        border-bottom-left-radius: 4px;
+        background: #efefef;
+    }
+
+    .filename {
+        cursor: pointer;
+        position: relative;
+        margin: 2px 0 0 0;
+        padding: .5em .5em .5em .7em;
+        border: solid 0.1px;
+        background: #efefef;
+    }
+
+    /* layouts/lecter.slim */
+
+    body {
+        font-family: "Helvetica Neue", "Helvetica", Arial, "Open Sans", sans-serif;
+        font-size: 15px;
+        line-height: 1.6;
+        -webkit-font-smoothing: antialiased;
+    }
+
+    .body-wrapper {
+        overflow: hidden;
+        *zoom: 1;
+        margin-top: 50px;
+        margin-bottom: 50px;
+        display: block;
+        padding: 0 20px;
+    }
+
+    .nav {
+        font-weight: 500;
+        background: #0b4e22;
+        border-bottom: 1px solid #cccccc;
+    }
+
+    .nav-inner {
+        display: block;
+        max-width: 955px;
+        padding: 1px 20px;
+    }
+
+    .nav-inner > ul {
+        list-style-type: none;
+    }
+
+    .nav-inner > ul > li > a {
+        text-decoration: none;
+        font-weight: 600;
+        color: white;
+        letter-spacing: 0.4px;
+    }
+
+    .ul {
+        -webkit-justify-content: space-between;
+        justify-content: space-between;
+        list-style-type: none;
+        margin: 0;
+        padding: 8px 2px 8px;
+        display: -webkit-flex;
+        display: flex;
+    }
+
+    .li {
+        -webkit-flex: 0 1 auto;
+        flex: 0 1 auto;
+        display: list-item;
+        text-align: -webkit-match-parent;
+        list-style-type: none;
+    }
+
+    .nav-inner > li > a {
+        text-decoration: none;
+        font-weight: 400;
+        color: white;
+        letter-spacing: 0.4px;
+    }
+  </style>
+
+  <body>
+    <div class="container">
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/app/views/lecter/diagnosis/new.html.erb

@@ -0,0 +1,61 @@
+<%= content_for :title, t('.title')  %>
+
+<div class="container">
+  <h2><%= t('.title') %></h2>
+
+  <%= form_tag diagnosis_path do %>
+    <% flash.each do |key, value| %>
+      <div class="col-sm-2 col-form-label">
+        <%= value %>
+      </div>
+    <% end %>
+    <div class="row my-3">
+      <%= label_tag t('.method'), nil, class: 'col-sm-2 col-form-label' %>
+      <div class="col-sm">
+        <%= select_tag :method, options_for_select(Lecter::AVAILABLE_METHODS, Lecter::DEFAULT_METHOD) %>
+      </div>
+      <div class="col-sm gray">
+        Choose one
+      </div>
+    </div>
+    <div class="row my-3">
+      <%= label_tag t('.endpoint'), nil, class: 'col-sm-2 col-form-label' %>
+      <div class="col-sm">
+        <%= text_field_tag :endpoint, nil, class: 'form-control', placeholder: 'Endpoint' %>
+      </div>
+      <div class="col-sm gray">
+        localhost:3000/posts
+      </div>
+    </div>
+    <div class="row my-3">
+      <%= label_tag t('.headers'), nil, class: 'col-sm-2 col-form-label' %>
+      <div class="col-sm">
+        <%= text_field_tag :headers, nil, class: 'form-control', placeholder: 'Headers' %>
+      </div>
+      <div class="col-sm gray">
+        content_type=text/html,accept=*/*
+      </div>
+    </div>
+    <div class="row my-3">
+      <%= label_tag t('.body_raw'), nil, class: 'col-sm-2 col-form-label' %>
+      <div class="col-sm">
+        <%= text_area_tag :body_raw, nil, rows: 10, class: 'form-control', placeholder: 'Body(raw)' %>
+      </div>
+      <div class="col-sm gray">
+        "post" => {
+          "title" => "New title",
+          "description" => "Desciption"
+        }
+      </div>
+    </div>
+
+    </p>
+    <%= submit_tag t('.send'), class: 'btn btn-primary' %>
+  <% end %>
+</div>
+
+<style>
+  .gray {
+      color: #727a82
+  }
+</style>