rpdoc 0.1.16 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3332b67613587936b3b88b4f35fb1e78621faf65623f35e46b45e73c5b8bb221
-  data.tar.gz: 7d1b22cf5313d4ad91f2e470e67c157b61f4e1f00f1bfb9b912c1f357fcf6023
+  metadata.gz: 614c1855e12f3279570419fc23b7ce0af9849a4f2a8cf9a333b8f53013927cde
+  data.tar.gz: f0b61a84a3e26b447227368ccd2fae5e4723f4d15c2b75b42df569b005fd057b
 SHA512:
-  metadata.gz: 3067394739da8951ec0bbab2028c5b765dce497dd34feeca00ea3325d01e6717e3f418a4957936ac81843ffb6212172d2e6a4a85e1a351f62384cba0723251b6
-  data.tar.gz: 9b21d3ba8cb79e13f1f5dfef58a155cde0edb1e8f861402f516f68b16dfe7def15e8f59b4b4c89e85e733150b378547b8479cee73ce5ea3795c3231d7c51055c
+  metadata.gz: 8dd60eaf51e2c3a466782a13c028a0a1f4ff99540b73c435ae7b9e4b4c22893bfdb7a405906639995d017d21a3906fae066d5e536ccc3cc91820921603806be6
+  data.tar.gz: c6e1c5cb2c221f484905182f112151621d73c2226b9383d26d60f63df8287a807e6ef49a50e53fa3897de79af3f1d9fc39bf47532481800e47b392435318f46d

data/.gitlab-ci.yml

@@ -5,6 +5,8 @@ stages:
 rspec:
   stage: rspec
   image: ruby:3.2.1
+  tags:
+    - arm64
   script:
     - bundle install
     - RPDOC_ENABLE=false rspec spec -fd
@@ -14,6 +16,8 @@ rspec:
 to_gem:
   stage: publish
   image: ruby:3.2.1
+  tags:
+    - arm64
   script:
     - mkdir -p ~/.gem
     - touch ~/.gem/credentials

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [0.2.1] - 2024-04-11
+- Fix `rspec_response_identifier` option bug.
+- Fix path bug for redirected requests and `push_and_update` strategy.
+
+## [0.2.0] - 2024-04-02
+- Add `rspec_root`, `rspec_response_allow_headers`, and `rspec_response_identifier` options to configuration.
+- Add public method `merge!` for PostmanCollection.
+- Fix rake usage.
+- Refactor.
+
 ## [0.1.16] - 2023-06-01
 - Fix default rpdoc_example_folders bug.
 

data/Gemfile.lock

@@ -1,116 +1,145 @@
 PATH
   remote: .
   specs:
-    rpdoc (0.1.14)
+    rpdoc (0.2.0)
+      activesupport (~> 6.1)
       json_requester (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.7)
-      actionview (= 6.1.7)
-      activesupport (= 6.1.7)
+    actionpack (6.1.7.6)
+      actionview (= 6.1.7.6)
+      activesupport (= 6.1.7.6)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.7)
-      activesupport (= 6.1.7)
+    actionview (6.1.7.6)
+      activesupport (= 6.1.7.6)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.1.7)
+    activesupport (6.1.7.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
+    base64 (0.1.1)
     builder (3.2.4)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     crass (1.0.6)
     diff-lcs (1.5.0)
-    erubi (1.11.0)
-    faraday (2.5.2)
-      faraday-net_http (>= 2.0, < 3.1)
+    erubi (1.12.0)
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.0)
-    i18n (1.12.0)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    json (2.6.2)
-    json_requester (1.0.8)
-      faraday (>= 1.0.0)
-    loofah (2.19.0)
+    json (2.6.3)
+    json_requester (1.1.0)
+      faraday (~> 1.0, >= 1.0.0)
+    language_server-protocol (3.17.0.3)
+    loofah (2.21.3)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
+      nokogiri (>= 1.12.0)
     method_source (1.0.0)
-    minitest (5.16.3)
-    nokogiri (1.13.8-arm64-darwin)
+    minitest (5.19.0)
+    multipart-post (2.4.0)
+    nokogiri (1.15.4-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.8-x86_64-darwin)
+    nokogiri (1.15.4-x86_64-darwin)
       racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.1.2.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    pry (0.14.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.6.0)
-    rack (2.2.4)
-    rack-test (2.0.2)
+    racc (1.7.1)
+    rack (2.2.8)
+    rack-test (2.1.0)
       rack (>= 1.3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.3)
-      loofah (~> 2.3)
-    railties (6.1.7)
-      actionpack (= 6.1.7)
-      activesupport (= 6.1.7)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (6.1.7.6)
+      actionpack (= 6.1.7.6)
+      activesupport (= 6.1.7.6)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.1)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.1)
-    rubocop (1.36.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.2)
+      base64 (~> 0.1.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    thor (1.2.1)
-    tzinfo (2.0.5)
+    thor (1.2.2)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
-    zeitwerk (2.6.1)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.11)
 
 PLATFORMS
   arm64-darwin-20
+  arm64-darwin-22
   x86_64-darwin-19
 
 DEPENDENCIES

data/README.md

@@ -50,14 +50,23 @@ Rpdoc.configure do |config|
   
   # (Optional) Collection name.
   config.collection_name = 'Rpdoc'
+
+  # (Optional) Specs in folder are used for json data generation.
+  config.rspec_root = 'rspec'
   
   # (Optional) Your Rails server API host.
   config.rspec_server_host = '{{server_host}}'
 
-  # (Optional) Since Rspec generates many noisy headers, you can filter them.
+  # (Optional) Since Rspec generates many noisy request 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.
+  # (Optional) Since Rspec generates many noisy response headers, you can filter them.
+  config.rspec_response_allow_headers = ['Content-Type', 'Content-Length', 'Location']
+
+  # (Optional) Rspec response identifier, including :rspec_location and nil.
+  config.rspec_response_identifier = :rspec_location
+
+  # (Optional) Root folder where Rpdoc saves generated json data.
   config.rpdoc_root = 'rpdoc'
 
   # (Optional) Filename to store RSpec request json data.
@@ -76,6 +85,9 @@ Rpdoc.configure do |config|
   config.rpdoc_clean_empty_folders = true
   config.rpdoc_clean_empty_folders_except = []
 
+  # (Optional) Folder ordering, including :asc, :desc, and custom array.
+  config.rpdoc_folder_ordering = :asc
+
   # (Optional) Auto push strategy, including :push_and_create and :push_and_update
   config.rpdoc_auto_push_strategy = :push_and_create
 end
@@ -83,16 +95,16 @@ end
 
 ## Usage
 
-`Rpdoc` only supports RSpec examples with [request](https://relishapp.com/rspec/rspec-rails/docs/request-specs/request-spec) type.
+`Rpdoc` only supports RSpec examples with [request](https://rspec.info/features/6-1/rspec-rails/request-specs/request-spec/) type.
 
-1. Include [shared_context](https://relishapp.com/rspec/rspec-core/docs/example-groups/shared-context) in your spec to make `Rpdoc` identify which examples to transform.
+1. Include [shared_context](https://rspec.info/features/3-13/rspec-core/example-groups/shared-context/) in your spec to make `Rpdoc` identify which examples to transform.
     ```ruby
     RSpec.describe 'POST /api/v1/books', type: :request do
       include_context 'rpdoc'
       ...
     end
    ```
-2. Customiz your example [metdata](https://relishapp.com/rspec/rspec-core/docs/metadata/user-defined-metadata) to generate collection data in your preferenced format.
+2. Customize your example [metdata](https://rspec.info/features/3-13/rspec-core/metadata/user-defined/) to generate collection data in your preferenced format.
     ```ruby
     it 'should return 200' do |example|
         # Request identifier.
@@ -132,9 +144,11 @@ end
 
 4. You can write description for your Postman collection by creating markdown files (named `description.md`) and putting each of them in corresponding location under `rpdoc` folder.
 
+5. You can manually push your collection to the Postman server through `rake rpdoc:push`.
+
 ## Notice
 
-If you try to mock the `File.open` method, generating collection data will fail because creating `request.json` use the `File.open` method.
+If you try to mock the `File.open` method, generating collection data will fail because creating `request.json` uses the `File.open` method.
 
 Solution:
 

data/Rakefile

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
+require "bundler/setup"
 require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
 task default: :rubocop
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/lib/rpdoc/**/*.rake").each { |f| import f }

data/VERSION.md

@@ -1 +1 @@
-0.1.16
+0.2.1

data/lib/generators/templates/initializer.rb

@@ -16,14 +16,23 @@ Rpdoc.configure do |config|
   
   # (Optional) Collection name.
   # config.collection_name = 'Rpdoc'
+
+  # (Optional) Specs in folder are used for json data generation.
+  # config.rspec_root = 'spec'
   
   # (Optional) Your Rails server API host.
   # config.rspec_server_host = '{{server_host}}'
 
-  # (Optional) Since Rspec generates many noisy headers, you can filter them.
+  # (Optional) Since Rspec generates many noisy request 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.
+  # (Optional) Since Rspec generates many noisy response headers, you can filter them.
+  # config.rspec_response_allow_headers = ['Content-Type', 'Content-Length', 'Location']
+
+  # (Optional) Rspec response identifier, including :rspec_location and nil.
+  # config.rspec_response_identifier = :rspec_location
+
+  # (Optional) Root folder where Rpdoc saves generated json data.
   # config.rpdoc_root = 'rpdoc'
 
   # (Optional) Filename to store RSpec request json data.
@@ -39,6 +48,9 @@ Rpdoc.configure do |config|
   # config.rpdoc_clean_empty_folders = true
   # config.rpdoc_clean_empty_folders_except = []
 
+  # (Optional) Folder ordering, including :asc, :desc, and custom array.
+  # config.rpdoc_folder_ordering = :asc
+
   # (Optional) Auto push collection to Postman server or not.
   # config.rpdoc_auto_push = false
 

data/lib/rpdoc/configuration.rb

@@ -13,17 +13,25 @@ module Rpdoc
       :collection_workspace,
       :collection_uid,
       :collection_name,
+      :rspec_root,
       :rspec_server_host,
       :rspec_request_allow_headers,
+      :rspec_response_allow_headers,
+      :rspec_response_identifier,
       :rpdoc_root,
       :rpdoc_request_filename,
       :rpdoc_description_filename,
       :rpdoc_collection_filename,
       :rpdoc_clean_empty_folders,
       :rpdoc_clean_empty_folders_except,
+      :rpdoc_folder_ordering,
       :rpdoc_auto_push,
       :rpdoc_auto_push_strategy
 
+    RSPEC_RESPONSE_IDENTIFIERS = [:rspec_location, nil].freeze
+    RPDOC_FOLDER_ORDERING = [:asc, :desc].freeze
+    RPDOC_AUTO_PUSH_STRATEGIES = [:push_and_create, :push_and_update].freeze
+
     def initialize
       @rpdoc_enable = ENV['RPDOC_ENABLE'] != 'false'
 
@@ -36,8 +44,11 @@ module Rpdoc
       @collection_name = 'Rpdoc'
       @collection_schema = 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
 
+      @rspec_root = 'spec'
       @rspec_server_host = '{{server_host}}'
       @rspec_request_allow_headers = ['User-Agent', 'Content-Type', 'Authorization']
+      @rspec_response_allow_headers = ['Content-Type', 'Content-Length', 'Location']
+      @rspec_response_identifier = :rspec_location
 
       @rpdoc_root = 'rpdoc'
       @rpdoc_request_filename = 'request.json'
@@ -46,15 +57,19 @@ module Rpdoc
 
       @rpdoc_clean_empty_folders = true
       @rpdoc_clean_empty_folders_except = []
+      @rpdoc_folder_ordering = []
 
       @rpdoc_auto_push = false
-      @rpdoc_auto_push_strategy = :push_and_create # or :push_and_update
+      @rpdoc_auto_push_strategy = :push_and_create
     end
   
     def valid?
       return true unless @rpdoc_enable && @rpdoc_auto_push
       return false if @postman_apikey.nil?
+      return false unless RSPEC_RESPONSE_IDENTIFIERS.include?(@rspec_response_identifier&.to_sym)
+      return false unless RPDOC_AUTO_PUSH_STRATEGIES.include?(@rpdoc_auto_push_strategy.to_sym)
       return false if @rpdoc_auto_push_strategy == :push_and_update && @collection_uid.nil?
+      return false if @rpdoc_folder_ordering.present? && (RPDOC_FOLDER_ORDERING.exclude?(@rpdoc_folder_ordering) || !@rpdoc_folder_ordering.is_a?(Array))
       true
     end
   end

data/lib/rpdoc/helper.rb

@@ -25,7 +25,13 @@ 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_usable = true
+    example_usable &&= example.metadata[:rpdoc_skip] == false
+    example_usable &&= File.expand_path(example.metadata[:file_path]).start_with?(File.expand_path(Rpdoc.configuration.rspec_root))
+    example_usable &&= example.exception.nil? && example.metadata[:type] == :request
+
+    if Rpdoc.configuration.rpdoc_enable && example_usable
       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

data/lib/rpdoc/postman_collection.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 
 require 'json_requester'
+require 'active_support'
+require 'active_support/core_ext'
 
 module Rpdoc
   class PostmanCollection
+    attr_reader :data
 
-    def initialize
-      @configuration = Rpdoc.configuration
+    def initialize(configuration: nil, data: nil)
+      @configuration = configuration || Rpdoc.configuration
       @requester = JsonRequester.new(@configuration.postman_host)
+      @data = data&.deep_symbolize_keys || generated_collection_data
 
-      @data = generated_collection_data
-      clean_empty_folders_from(@data[:collection][:item])
+      self.clean_empty_folders!
+      self.reordering!
+    end
+
+    def push
+      send(@configuration.rpdoc_auto_push_strategy)
     end
 
     def push_and_create
@@ -28,18 +36,38 @@ module Rpdoc
       }
       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)
-      clean_empty_folders_from(remote_collection_data[:collection][:item])
-      @requester.http_send(:put, path, remote_collection_data, headers)
+      remote_collection = PostmanCollection.new(data: remote_collection_data)
+      remote_collection.clean_generated_responses!
+      remote_collection.merge!(self)
+      @requester.http_send(:put, path, remote_collection.data, headers)
     end
 
-    def save
-      File.open("#{@configuration.rpdoc_root}/#{@configuration.rpdoc_collection_filename}", 'w+') do |f|
+    def save(path: nil)
+      path ||= "#{@configuration.rpdoc_root}/#{@configuration.rpdoc_collection_filename}"
+      File.open(path, 'w+') do |f|
         f.write(JSON.pretty_generate(@data))
       end
     end
 
+    def merge!(other_collection)
+      @data[:collection][:info][:name] = other_collection.data[:collection][:info][:name]
+      @data[:collection][:info][:description] = other_collection.data[:collection][:info][:description]
+      insert_generated_responses_into(@data[:collection][:item], from_collection_items: other_collection.data[:collection][:item].to_a)
+      sort_folders_from(@data[:collection][:item])
+    end
+
+    def clean_empty_folders!
+      clean_empty_folders_from(@data[:collection][:item])
+    end
+
+    def clean_generated_responses!
+      clean_generated_responses_from(@data[:collection][:item])
+    end
+
+    def reordering!
+      sort_folders_from(@data[:collection][:item])
+    end
+
     private
 
     def generated_collection_data
@@ -84,20 +112,13 @@ module Rpdoc
       data
     end
 
-    def merged_by(other_collection_data)
-      clean_generated_responses_from(other_collection_data[:collection][:item])
-
-      other_collection_data[:collection][:info][:description] = @data[:collection][:info][:description]
-      insert_generated_responses_into(other_collection_data[:collection][:item], from_collection_items: @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].reject! do |response|
-            response.dig(:header)&.pluck(:key)&.include?('RSpec-Location')
+            @configuration.rspec_response_identifier.present? ? response.dig(:header)&.pluck(:key)&.include?('RSpec-Location') : true
           end
         end
       end
@@ -105,7 +126,9 @@ module Rpdoc
 
     def insert_generated_responses_into(collection_items, from_collection_items: [])
       if collection_items.empty?
-        collection_items = from_collection_items.deep_dup
+        from_collection_items.each do |item|
+          collection_items << item.deep_dup
+        end
       else
         # transform collection_items into hash, using item[:name] as key
         item_hash = {}
@@ -119,9 +142,9 @@ module Rpdoc
           if item_hash.has_key?(from_item_name)
             if from_item.has_key?(:item) && item_hash[from_item_name].has_key?(:item)
               item_hash[from_item_name][:description] = from_item[:description]
-              insert_generated_responses_into(item_hash[from_item_name][:item], from_collection_items: from_item[:item])
+              insert_generated_responses_into(item_hash[from_item_name][:item], from_collection_items: from_item[:item].to_a)
             elsif from_item.has_key?(:response) && item_hash[from_item_name].has_key?(:response)
-              item_hash[from_item_name][:request][:description] = from_item[:request][:description]
+              item_hash[from_item_name][:request] = from_item[:request].deep_dup
               item_hash[from_item_name][:response] += from_item[:response].deep_dup
             else
               collection_items << from_item.deep_dup
@@ -135,12 +158,24 @@ module Rpdoc
 
     def clean_empty_folders_from(collection_items)
       return unless @configuration.rpdoc_clean_empty_folders
-      collection_items.reject! do |item|
+      collection_items&.reject! do |item|
         next false if item.has_key?(:request)
         next false if @configuration.rpdoc_clean_empty_folders_except.include?(item[:name])
         clean_empty_folders_from(item[:item]) if item[:item].present?
         item[:item].nil? || item[:item].empty?
       end
     end
+
+    def sort_folders_from(collection_items)
+      return unless @configuration.rpdoc_folder_ordering.present?
+      if @configuration.rpdoc_folder_ordering == :asc
+        collection_items&.sort_by! { |item| item[:name] }
+      elsif @configuration.rpdoc_folder_ordering == :desc
+        collection_items&.sort_by! { |item| item[:name] }.reverse!
+      elsif @configuration.rpdoc_folder_ordering.is_a?(Array)
+        # sort by array and then sort by asc
+        collection_items&.sort_by! { |item| [@configuration.rpdoc_folder_ordering.index(item[:name]) || Float::INFINITY, item[:name]] }
+      end
+    end
   end
 end

data/lib/rpdoc/postman_response.rb

@@ -38,26 +38,28 @@ module Rpdoc
     end
 
     def response_data
-      headers = @rspec_response.header.map { |key, value| {key: key, value: value} }
-      headers << rspec_location_header
+      header = @rspec_response.header.slice(*@configuration.rspec_response_allow_headers) if @configuration.rspec_response_allow_headers.present?
+      headers = header.map { |key, value| { key: key, value: value } }
+      headers << rspec_response_identifier_header if @configuration.rspec_response_identifier.present?
       data = {
         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,
       }
       if @rspec_response.headers['Content-Type'].include?('application/json')
+        data[:_postman_previewlanguage] = 'json'
         data[:body] = JSON.pretty_generate(JSON.parse(@rspec_response.body)) rescue nil
       else
         body = @rspec_response.body
+        data[:_postman_previewlanguage] = 'text'
         data[:body] = body.encoding == Encoding::BINARY ? (body.force_encoding(Encoding::ISO_8859_1).encode(Encoding::UTF_8) rescue body) : body
       end
       data
     end
 
-    def rspec_location_header
+    def rspec_response_identifier_header
       {
         key: 'RSpec-Location',
         value: @rspec_example.metadata[:location]
@@ -82,13 +84,15 @@ module Rpdoc
           text: 'text'
         }
       end.compact
+
+      original_path = @rspec_request.original_fullpath.split('?').first # use original_fullpath instead of path to avoid request being redirected
       {
         method: @rspec_request.method,
         header: filter_headers,
         url: {
-          raw: "#{@configuration.rspec_server_host}#{@rspec_request.path}",
+          raw: "#{@configuration.rspec_server_host}#{original_path}",
           host: [@configuration.rspec_server_host],
-          path: @rspec_request.path.split('/'),
+          path: original_path.split('/'),
           query: query_string
         },
         body: original_request_data_body

data/lib/rpdoc/railtie.rb

@@ -0,0 +1,14 @@
+# lib/railtie.rb
+require 'rpdoc'
+require 'rails'
+
+module Rpdoc
+  class Railtie < Rails::Railtie
+    railtie_name :rpdoc
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      load "#{path}/rpdoc.rake"
+    end
+  end
+end

data/lib/rpdoc/rpdoc.rake

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
+require 'rpdoc'
+
 namespace :rpdoc do
   desc 'push collection to the Postman server'
-  task :push => :environment do
+  task :push do
     postman_collection = Rpdoc::PostmanCollection.new
     postman_collection.save
     postman_collection.send(Rpdoc.configuration.rpdoc_auto_push_strategy) if Rpdoc.configuration.rpdoc_auto_push

data/lib/rpdoc/version.rb

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

data/lib/rpdoc.rb

@@ -5,6 +5,8 @@ require 'rpdoc/configuration'
 require 'rpdoc/postman_response'
 require 'rpdoc/postman_collection'
 require 'rpdoc/helper' if defined?(RSpec)
+require 'rpdoc/railtie' if defined?(Rails)
+
 
 module Rpdoc
 

data/rpdoc.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'json_requester', '~> 1.0'
+  spec.add_dependency 'activesupport', '~> 6.1'
 
   spec.add_development_dependency 'railties', '~> 6.1.4'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.2.1
 platform: ruby
 authors:
 - yuntai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2024-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_requester
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -112,6 +126,7 @@ files:
 - lib/rpdoc/helper.rb
 - lib/rpdoc/postman_collection.rb
 - lib/rpdoc/postman_response.rb
+- lib/rpdoc/railtie.rb
 - lib/rpdoc/rpdoc.rake
 - lib/rpdoc/version.rb
 - rpdoc.gemspec