rpdoc 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72d3497d62e6af176d18871c5cc1e375cfe8582fb7f450880b0ef84b90f5d302
+  data.tar.gz: db8a565df0f83ff24dd6d0a2f3f226dac63c17ddd20646f65d5b1dba80341a1a
+SHA512:
+  metadata.gz: 288aae7de390ecf88baa08a546d7c78d03460f2e80470a98bb26e762f6e9e2a0d8165e07f811b340cda006771a54272c78332804292a9c365145b5dad25320fc
+  data.tar.gz: 4589ba86931cbc983b7a3dea03a4d7bf74c5285b940fb7ab249352f59d559a1172f4733b44c5fbfd37c1fcc6aa53f7ca8e4d873bed0bc8a58c9078f1e22c4a95

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-10-30
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rpdoc.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,207 @@
+PATH
+  remote: .
+  specs:
+    rpdoc (0.1.0)
+      json_requester (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activestorage (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    json_requester (1.0.3)
+      faraday (>= 1.0.0)
+    loofah (2.12.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.14.4)
+    multipart-post (2.1.1)
+    nio4r (2.5.8)
+    nokogiri (1.12.5-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.4.1)
+      actioncable (= 6.1.4.1)
+      actionmailbox (= 6.1.4.1)
+      actionmailer (= 6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actiontext (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.22.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  pry
+  rails (>= 5.0)
+  rpdoc!
+  rspec (~> 3.0)
+  rubocop (~> 1.0)
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 yuntai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1 @@
+# Rpdoc

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rpdoc"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/generators/rpdoc/install_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Rpdoc
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+      desc 'Creates an initializer file at config/initializers.'
+
+      def copy_initializer_file
+        copy_file "initializer.rb", "#{Rails.root}/config/initializers/rpdoc.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+Rpdoc.configure do |config|
+
+  # (Optional) You can disable rpdoc generation process manually.
+  # config.rpdoc_enable = true
+
+  # (Optional) Apikey for your Postman account, used if need to push.
+  # config.postman_apikey = 'postman_apikey'
+
+  # (Optional) Workspace that your collection will be push to. Default your account's personal workspace. 
+  # config.collection_workspace = 'collection_workspace'
+  
+  # (Optional) Your existing collection uid. Will update it when using :push_and_update push strategy.
+  # config.collection_uid = 'collection_uid'
+  
+  # (Optional) Collection name.
+  # config.collection_name = 'Rpdoc'
+  
+  # (Optional) Your Rails server API host.
+  # config.rspec_server_host = '{{server_host}}'
+
+  # (Optional) Since Rspec generates many noisy headers, you can filter them.
+  # config.rspec_request_allow_headers = ['User-Agent', 'Content-Type', 'Authorization']
+
+  # (Optional) Folder that Rpdoc use for json data generation and save.
+  # config.rpdoc_root = 'rpdoc'
+
+  # (Optional) Filename to store RSpec request json data.
+  # config.rpdoc_request_filename = 'request.json'
+
+  # (Optional) Filename to store Postman description markdown data.
+  # config.rpdoc_description_filename = 'description.md'
+
+  # (Optional) Filename to store RSpec collection json data.
+  # config.rpdoc_collection_filename = 'collection.json'
+
+  # (Optional) Auto push collection to Postman server or not.
+  # config.rpdoc_auto_push = false
+
+  # (Optional) Auto push strategy, including :push_and_create and :push_and_update
+  # config.rpdoc_auto_push_strategy = :push_and_create
+end

data/lib/rpdoc/configuration.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Rpdoc
+  class Configuration
+    attr_reader \
+      :postman_host,
+      :postman_collection_endpoint,
+      :collection_schema
+
+    attr_accessor \
+      :rpdoc_enable,
+      :postman_apikey,
+      :collection_workspace,
+      :collection_uid,
+      :collection_name,
+      :rspec_server_host,
+      :rspec_request_allow_headers,
+      :rpdoc_root,
+      :rpdoc_request_filename,
+      :rpdoc_description_filename,
+      :rpdoc_collection_filename,
+      :rpdoc_auto_push,
+      :rpdoc_auto_push_strategy
+
+    def initialize
+      @rpdoc_enable = true
+
+      @postman_host = 'https://api.getpostman.com'
+      @postman_collection_endpoint = "#{@postman_host}/collections"
+      @postman_apikey = nil
+
+      @collection_workspace = nil
+      @collection_uid = nil
+      @collection_name = 'Rpdoc'
+      @collection_schema = 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+
+      @rspec_server_host = '{{server_host}}'
+      @rspec_request_allow_headers = ['User-Agent', 'Content-Type', 'Authorization']
+
+      @rpdoc_root = 'rpdoc'
+      @rpdoc_request_filename = 'request.json'
+      @rpdoc_description_filename = 'description.md'
+      @rpdoc_collection_filename = 'collection.json'
+      @rpdoc_auto_push = false
+      @rpdoc_auto_push_strategy = :push_and_create # or :push_and_update
+    end
+  
+    def valid?
+      @rpdoc_enable && @rpdoc_auto_push ? !@postman_apikey.nil? : true
+    end
+  end
+end

data/lib/rpdoc/helper.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    if Rpdoc.configuration.rpdoc_enable
+      raise StandardError.new('Configuration Invalid') unless Rpdoc.configuration.valid?
+      Dir.glob("#{Rpdoc.configuration.rpdoc_root}/**/*.json") do |filename|
+        File.delete(filename)
+      end
+    end
+  end
+
+  config.after(:suite) do
+    if Rpdoc.configuration.rpdoc_enable && Rpdoc.configuration.rpdoc_auto_push
+      postman_collection = Rpdoc::PostmanCollection.new
+      postman_collection.save
+      postman_collection.send(Rpdoc.configuration.rpdoc_auto_push_strategy)
+    end
+  end
+end
+  
+RSpec.shared_context 'rpdoc' do
+  after(:each) do |example|
+    example.metadata[:rpdoc_skip] ||= false
+    if Rpdoc.configuration.rpdoc_enable && example.exception.nil? && example.metadata[:type] == :request && example.metadata[:rpdoc_skip] == false
+      example.metadata[:rpdoc_action_key] ||= controller.action_name
+      example.metadata[:rpdoc_action_name] ||= controller.action_name
+      example.metadata[:rpdoc_example_key] ||= example.metadata[:description].underscore
+      example.metadata[:rpdoc_example_name] ||= example.metadata[:description]
+      example.metadata[:rpdoc_example_folders] ||= controller.controller_path.split('/')
+      
+      postman_response = Rpdoc::PostmanResponse.new(example, request, response)
+      postman_response.save
+    end
+  end
+end

data/lib/rpdoc/postman_collection.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Rpdoc
+  class PostmanCollection
+
+    def initialize
+      @configuration = Rpdoc.configuration
+      @requester = JsonRequester.new(Settings.kdan_service.data_center)
+
+      @data = generated_collection_data
+    end
+
+    def push_and_create
+      path = "#{@configuration.postman_collection_endpoint}?workspace=#{@configuration.collection_workspace}"
+      headers = {
+        'X-Api-Key': @configuration.postman_apikey
+      }
+      @requester.http_send(:post, path, @data, headers)
+    end
+
+    def push_and_update
+      path = "#{@configuration.postman_collection_endpoint}/#{@configuration.collection_uid}"
+      headers = {
+        'X-Api-Key': @configuration.postman_apikey
+      }
+      remote_collection_data = @requester.http_send(:get, path, {}, headers)
+      remote_collection_data = remote_collection_data['status'] == 200 ? remote_collection_data.deep_symbolize_keys.slice(:collection) : nil
+      
+      merged_by(remote_collection_data)
+      @requester.http_send(:put, path, remote_collection_data, headers)
+    end
+
+    def save
+      File.open("#{@configuration.rpdoc_root}/#{@configuration.rpdoc_collection_filename}", 'w+') do |f|
+        f.write(JSON.pretty_generate(@data))
+      end
+    end
+
+    private
+
+    def collection_data
+      @collection_data ||= @original_collection.present? ? @original_collection.deeper_merge(collection_from_rspec, merge_hash_arrays: true) : collection_from_rspec
+    end
+
+    def generated_collection_data
+      {
+        collection: {
+          info: {
+            name: @configuration.collection_name,
+            description: description(@configuration.rpdoc_root),
+            schema: @configuration.collection_schema
+          },
+          item: items(@configuration.rpdoc_root)
+        }
+      }
+    end
+
+    def description(folder)
+      File.read("#{folder}/#{@configuration.rpdoc_description_filename}") rescue ""
+    end
+
+    def items(folder)
+      data = []
+      Dir.glob("#{folder}/*") do |filename|
+        next unless File.directory?(filename)
+        request_file = File.read("#{filename}/#{@configuration.rpdoc_request_filename}") rescue nil
+        request_data = JSON.parse(request_file).deep_symbolize_keys if request_file.present?
+        if request_data.present?
+          Dir.glob("#{filename}/*") do |response_filename|
+            next unless response_filename.match?(/.json$/) && response_filename != "#{filename}/#{@configuration.rpdoc_request_filename}"
+            response_data = JSON.parse(File.read(response_filename)).deep_symbolize_keys
+            request_data[:response] << response_data
+          end
+          request_data[:request][:description] = description(filename)
+          data << request_data
+        else
+          data << {
+            name: filename.split('/').last.camelize,
+            description: description(filename),
+            item: items(filename)
+          }
+        end
+      end
+      data
+    end
+
+    def merged_by(other_collection_data)
+      clean_generated_responses_from(other_collection_data[:collection][:item])
+      insert_generated_responses_into(other_collection_data[:collection][:item])
+    end
+
+    def clean_generated_responses_from(collection_items)
+      collection_items.each do |item|
+        if item.has_key?(:item)
+          clean_generated_responses_from(item[:item])
+        elsif item.has_key?(:response)
+          item[:response] = item[:response].reject do |response|
+            response.dig(:header)&.pluck(:key)&.include?('RSpec-Location')
+          end
+        end
+      end
+    end
+
+    def insert_generated_responses_into(collection_items, from_collection_items: nil)
+      from_collection_items ||= @data[:collection][:item]
+
+      if collection_items.empty?
+        collection_items = from_collection_items.deep_dup
+      else
+        item_hash = {}
+        collection_items.each do |item|
+          item_hash[item[:name]] = item
+        end
+
+        from_collection_items.each do |from_item|
+          from_item_name = from_item[:name]
+          if item_hash.has_key?(from_item_name)
+            if from_item.has_key?(:item) && item_hash[from_item_name].has_key?(:item)
+              insert_generated_responses_into(item_hash[from_item_name][:item], from_collection_items: from_item[:item])
+            elsif from_item.has_key?(:response) && item_hash[from_item_name].has_key?(:response)
+              item_hash[from_item_name][:response] += from_item[:response].deep_dup
+            else
+              collection_items << from_item.deep_dup
+            end
+          else
+            collection_items << from_item.deep_dup
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpdoc/postman_response.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Rpdoc
+  class PostmanResponse
+    attr_reader :data
+
+    def initialize(rspec_example, rspec_request, rspec_response)
+      @rspec_example = rspec_example
+      @rspec_request = rspec_request
+      @rspec_response = rspec_response
+      @configuration = Rpdoc.configuration
+
+      @data = response_data
+    end
+
+    def save
+      root_path ||= @configuration.rpdoc_root
+      folder_path = "#{root_path}/#{@rspec_example.metadata[:rpdoc_example_folders].join('/')}/#{@rspec_example.metadata[:rpdoc_action_key]}"
+      FileUtils.mkdir_p(folder_path) unless File.exists?(folder_path)
+
+      request_file_path = "#{folder_path}/#{@configuration.rpdoc_request_filename}"
+      File.open(request_file_path, 'w+') { |f| f.write(JSON.pretty_generate(request_data)) } unless File.exists?(request_file_path)
+
+      response_file_path = "#{folder_path}/#{@rspec_example.metadata[:rpdoc_example_key]}.json"
+      File.open(response_file_path, 'w+') { |f| f.write(JSON.pretty_generate(response_data)) }
+    end
+
+    private
+
+    def request_data
+      {
+        name: @rspec_example.metadata[:rpdoc_action_name],
+        request: original_request_data,
+        response: []
+      }
+    end
+
+    def response_data
+      headers = @rspec_response.header.map { |key, value| {key: key, value: value} }
+      headers << rspec_location_header
+      {
+        name: @rspec_example.metadata[:rpdoc_example_name],
+        originalRequest: original_request_data,
+        status: @rspec_response.status.to_s,
+        code: @rspec_response.code.to_i,
+        _postman_previewlanguage: "json",
+        header: headers,
+        body: JSON.pretty_generate(JSON.parse(@rspec_response.body))
+      }
+    end
+
+    def rspec_location_header
+      {
+        key: 'RSpec-Location',
+        value: @rspec_example.metadata[:location]
+      }
+    end
+
+    def original_request_data
+      return @original_request_data if @original_request_data.present?
+      filter_headers = @configuration.rspec_request_allow_headers.map do |header|
+        next unless @rspec_request.headers[header].present?
+        {
+          key: header,
+          value: @rspec_request.headers[header]
+        }
+      end.compact
+      @original_request_data = {
+        method: @rspec_request.method,
+        header: filter_headers,
+        url: {
+          raw: "#{@configuration.rspec_server_host}#{@rspec_request.path}",
+          host: [@configuration.rspec_server_host],
+          path: @rspec_request.path.split('/'),
+          variable: [],
+        },
+        body: nil
+      }
+      @original_request_data[:body] = {
+        mode: 'raw',
+        raw: JSON.pretty_generate(JSON.parse(@rspec_request.headers['RAW_POST_DATA'])),
+        options: {
+          raw: {
+            language: "json"
+          }
+        }
+      } if @rspec_request.headers['RAW_POST_DATA'].present?
+      @original_request_data
+    end  
+  end
+end

data/lib/rpdoc/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rpdoc
+  VERSION = "0.1.1"
+end

data/lib/rpdoc.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rpdoc/version'
+require 'rpdoc/configuration'
+require 'rpdoc/postman_response'
+require 'rpdoc/postman_collection'
+require 'rpdoc/helper' if defined?(RSpec)
+
+module Rpdoc
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure(&block)
+    yield(configuration)
+  end
+
+end

data/rpdoc.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/rpdoc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rpdoc"
+  spec.version       = Rpdoc::VERSION
+  spec.authors       = ["yuntai"]
+  spec.email         = ["yuntai.yang@kdanmobile.com"]
+
+  spec.summary       = "A gem to transform RSpec examples to Postman collection"
+  spec.description   = "With RSpec examples, it will generate Postman collection and push to the Postman server."
+  spec.homepage      = "https://www.kdanmobile.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://www.kdanmobile.com"
+  spec.metadata["changelog_uri"] = "https://www.kdanmobile.com"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'json_requester', '~> 1.0'
+
+  spec.add_development_dependency 'rails', '>= 5.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: rpdoc
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- yuntai
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_requester
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: With RSpec examples, it will generate Postman collection and push to
+  the Postman server.
+email:
+- yuntai.yang@kdanmobile.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/rpdoc/install_generator.rb
+- lib/generators/templates/initializer.rb
+- lib/rpdoc.rb
+- lib/rpdoc/configuration.rb
+- lib/rpdoc/helper.rb
+- lib/rpdoc/postman_collection.rb
+- lib/rpdoc/postman_response.rb
+- lib/rpdoc/version.rb
+- rpdoc.gemspec
+homepage: https://www.kdanmobile.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.kdanmobile.com
+  source_code_uri: https://www.kdanmobile.com
+  changelog_uri: https://www.kdanmobile.com
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: A gem to transform RSpec examples to Postman collection
+test_files: []