postman_doc_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f85ff61f6b39a16e78c7c2c4f28339ca31741633
+  data.tar.gz: d348ae263c06c598b32d45d1dfefb4c76bd01310
+SHA512:
+  metadata.gz: '038d203ad6adb813d9860c189f18a42e82a358ac58cb7e0d6f619c38777c600dcb4c69561ec46ee6ba1e1f4c2863d24241bd38fba4e412524467efa821e24b45'
+  data.tar.gz: 355223d845164a9f55aa8dff21b0d6c228ebe0ca350ad778f0217ad83984ee8cdc24bf66da4fba8c46238a985e5e094f3030c04cab548934989af9a26f03932e

data/README.md

@@ -0,0 +1 @@
+Postman::DocMaker.call(request.method_symbol, path, controller, response)

data/lib/postman_doc_generator.rb

@@ -0,0 +1,133 @@
+require 'json'
+require 'fileutils'
+
+class PostmanDocGenerator
+  attr_accessor :result, :error
+
+  def start(http_method, path, controller, response)
+    generator = new(http_method, path, controller, response)
+    generator.call
+  rescue => e
+    generator.error = e
+  ensure
+    generator
+  end
+
+  def initialize(http_method, path, controller, response)
+    @sample_dir = "#{File.expand_path("#{File.dirname(__FILE__)}/..")}/sample"
+    @http_method = http_method.upcase.to_s
+    @path = path
+    @controller = controller
+    @response = response
+    @file_path = file_path
+  end
+
+  def call
+    get_basic_setting
+    setup_basic_info
+    setup_postman_json
+    save_to_file
+  end
+
+  private
+
+  def get_basic_setting
+    env = ENV['RAILS_ENV'] || 'development'
+    string = File.open('config/postman_doc_generator.yml', 'rb') { |f| f.read }
+    fail 'config/postman_doc_generator.yml not existed nor not readable' if string.nil?
+    @config = YAML.load(string)[env]
+    fail 'config/postman_doc_generator.yml incorrect or environment not exist' if @config.nil?
+    result_dir = @config['postman_dir'] || 'result'
+    FileUtils.mkdir_p(result_dir)
+    @file_path = "#{result_dir}/postman.json"
+  end
+
+  def setup_basic_info
+    @params = @controller.params.permit!.to_h.to_json(except: [:format, :controller, :action, :tag, :user_agent])
+    @res_status = @response.status
+    @res_body =  @response.body.present? ? JSON.parse(@response.body) : {}
+    data = File.read(@file_path) if File.exist?(@file_path)
+    @postman_data = data.blank? ? JSON.parse(File.read("#{@sample_dir}/doc.json")) : JSON.parse(data)
+  end
+
+  def setup_postman_json
+    levels = @controller.class.name.split('::')
+    @postman_data['item'] = format_with_levels(levels, @postman_data['item'])
+  end
+
+  def save_to_file
+    File.open(@file_path, 'w+') do |f|
+      f.write(@postman_data.to_json)
+    end
+  end
+
+  def format_with_levels(levels, pm_items)
+    first_level = levels.first
+    return format_namespace_requests(pm_items || []) if first_level.nil?
+    pm_item = pm_items.find do |item|
+      item['name'] == first_level
+    end
+    if pm_item.nil?
+      pm_items << {name: first_level, item: format_with_levels(levels[1..-1], [])}
+    else
+      pm_item['item'] = format_with_levels(levels[1..-1], pm_item['item'])
+    end
+    pm_items
+  end
+
+  def format_namespace_requests(namespace_requests)
+    target_req = namespace_requests.find do |r|
+      req = r['request']
+      req['method'] == @http_method && req['url']['raw'] == "#{@config['project_host']}#{@path}"
+    end
+    request = setup_request(target_req)
+    target_req.present? ? (target_req = request) : namespace_requests << request
+    namespace_requests
+  end
+
+  def setup_request(target_req)
+    if @res_status == 200 || target_req.nil?
+      request = JSON.parse(File.read("#{@sample_dir}/request.json"))
+      request['name'] = "#{@http_method} #{@path}"
+      req = request['request']
+      req['method'] = @http_method
+      req['body']['raw'] = @params.to_json
+      req['url']['raw'] = "#{@config['project_host']}#{@path}"
+      req['url']['host'] = [@config['project_host']]
+      req['url']['path'] = @path.split('/').delete_if(&:blank?)
+    else
+      request = target_req
+    end
+    request['response'] = format_responses_of_request(request, target_req&.dig('response') || [])
+    request
+  end
+
+  def format_responses_of_request(request, responses)
+    target_res = responses.find do |res|
+      next false unless res['code'] == @res_status
+      break true if @res_status == 200
+      body = JSON.parse(res['body'])
+      body['error_code'] == @res_body['error_code']
+    end
+    response = setup_response(request['request'], target_res)
+    target_res.present? ? (target_res = response) : responses << response
+    responses
+  end
+
+  def setup_response(request, target_res)
+    response = JSON.parse(File.read("#{@sample_dir}/response.json"))
+    result = @res_status == 200 ? 'Success' : 'Failed'
+    status_text = Rack::Utils::HTTP_STATUS_CODES[@res_status]
+    error_code = " #{@res_body['error_code']}" unless @res_status == 200
+    response['name'] = "#{@http_method} #{@path} #{result} (#{status_text}#{error_code})"
+    response['originalRequest'] = request.except('description')
+    response['status'] = status_text
+    response['code'] = @res_status
+    response['header'] = @response.header.map do |key, value|
+      {key: key, value: value}
+    end
+    response['body'] = @res_body.to_json
+    response
+  end
+
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: postman_doc_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JiaRou
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A Json API Doc Generator of Postman
+email: laura34963@kdanmobile.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/postman_doc_generator.rb
+homepage: https://github.com/laura34963/postman_doc_generator
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.13
+signing_key:
+specification_version: 4
+summary: Generate Postman Doc Json After Run Rspec
+test_files: []