rpdoc 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72d3497d62e6af176d18871c5cc1e375cfe8582fb7f450880b0ef84b90f5d302
-  data.tar.gz: db8a565df0f83ff24dd6d0a2f3f226dac63c17ddd20646f65d5b1dba80341a1a
+  metadata.gz: 92d9f7ee29c14d29e2ff89e295a3366c04cd36d1446cb03d6e5c42ec3a5847de
+  data.tar.gz: 5fa8e4abf8883bfa3889cdebf52c9095879d4334b83135ab635c4e23a8297c87
 SHA512:
-  metadata.gz: 288aae7de390ecf88baa08a546d7c78d03460f2e80470a98bb26e762f6e9e2a0d8165e07f811b340cda006771a54272c78332804292a9c365145b5dad25320fc
-  data.tar.gz: 4589ba86931cbc983b7a3dea03a4d7bf74c5285b940fb7ab249352f59d559a1172f4733b44c5fbfd37c1fcc6aa53f7ca8e4d873bed0bc8a58c9078f1e22c4a95
+  metadata.gz: f171a6883f585f0576c9a8522fdc392e2a17f859b7d43b62e473f4c09196c86291b2dfb80c421ec8635348f26ac649da0abb5d578b5229b8e4fe407d137113ee
+  data.tar.gz: 763c279f4da96585db0960eddc5181a88b14afb3d01867913018e4319c065ac812a7e85b848c186459b68dff4b2f77d230356bf7a03df2eec043b3eeb09425ac

data/.gitlab-ci.yml

@@ -0,0 +1,27 @@
+stages:
+  - rspec
+  - publish
+
+rspec:
+  stage: rspec
+  image: ruby:3.0.2
+  script:
+    - bundle install
+    - RPDOC_ENABLE=false rspec spec -fd
+  only:
+    - master
+
+to_gem:
+  stage: publish
+  image: ruby:3.0.2
+  script:
+    - mkdir -p ~/.gem
+    - touch ~/.gem/credentials
+    - chmod 0600 ~/.gem/credentials
+    - 'printf -- "---\n:rubygems_api_key: $GEM_HOST_API_KEY\n" > ~/.gem/credentials'
+    - RELEASE_VERSION=$(cat VERSION.md)
+    - GEM_NAME=rpdoc-$RELEASE_VERSION.gem
+    - gem build rpdoc.gemspec
+    - gem push $GEM_NAME
+  only:
+    - master

data/CHANGELOG.md

@@ -1,5 +1,16 @@
-## [Unreleased]
+## [0.1.4, 0.1.5] - 2021-12-22
+- Fix rspec parsing bugs
 
-## [0.1.0] - 2021-10-30
+## [0.1.3] - 2021-11-09
+- Add require 'rspec/rails' if RSpec::Rails exists
+
+## [0.1.2] - 2021-11-04
+- Add gem description
+- Remove unecessary gem dependency
+- Fix configuration and collection bugs
 
+## [0.1.1] - 2021-11-01
+- Add configuration options
+
+## [0.1.0] - 2021-10-30
 - Initial release

data/Gemfile.lock

@@ -1,31 +1,12 @@
 PATH
   remote: .
   specs:
-    rpdoc (0.1.0)
+    rpdoc (0.1.2)
       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)
@@ -33,33 +14,12 @@ GEM
       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)
@@ -92,8 +52,6 @@ GEM
     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)
@@ -101,14 +59,9 @@ GEM
     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)
@@ -121,21 +74,6 @@ GEM
     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)
@@ -177,28 +115,18 @@ GEM
       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)
+  pry (~> 0.14.1)
+  railties (~> 6.1.4)
   rpdoc!
   rspec (~> 3.0)
   rubocop (~> 1.0)

data/README.md

@@ -1 +1,133 @@
 # Rpdoc
+
+`Rpdoc` is a simple `Postman` API documentation tool, which transforms RSpec examples to Postman collection (with json files in Postman data format stored locally).
+
+### Benefits
+- Save time for generating Postman examples manually.
+- Improve maintainability of your API documentation (easy to create/update and put it into version control with CI/CD).
+
+
+## Installation
+
+Add `rpdoc` to your application's `Gemfile`:
+
+```ruby
+gem 'rpdoc', '~> 0.1.2'
+```
+
+And then install the gem:
+
+```bash
+$ bundle install
+```
+
+## Configuration
+
+`Rpdoc` should be configured manually if you want to automatically push your collection to the Postman server.
+
+You can also run the following command to generate the configuration file for your **Rails** application.
+
+```bash
+$ rails g rpdoc:install
+```
+
+Rpdoc can be configured by the following options.
+
+```ruby
+Rpdoc.configure do |config|
+    
+  # (Optional) You can disable rpdoc generation process manually.
+  config.rpdoc_enable = true
+
+  # (Optional) Apikey for your Postman account, used if want to push collection to the Postman server.
+  config.postman_apikey = 'postman_apikey'
+
+  # (Optional) Workspace that your collection will be pushed 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
+```
+
+## Usage
+
+`Rpdoc` only supports RSpec examples with [request](https://relishapp.com/rspec/rspec-rails/docs/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.
+    ```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.
+    ```ruby
+    it 'should return 200' do |example|
+        # Request identifier.
+        # Default is `controller.action_name` 
+        example.metadata[:rpdoc_action_key] = 'create'
+        
+        # Request name shown in Postman collection.
+        # Default is `controller.action_name` 
+        example.metadata[:rpdoc_action_name] = 'Create a book.'
+        
+        # Example identifier.
+        # Default is `controller.action_name` 
+        example.metadata[:rpdoc_example_key] = "create_200"
+        
+        # Example name shown in Postman colleciotn. 
+        # Default is `example.metadata[:description]`
+        example.metadata[:rpdoc_example_name] = "Create a book success."
+        
+        # Example location shown in Postman collection.
+        # Default is `controller.controller_path.split('/')`
+        example.metadata[:rpdoc_example_folders] = ['v1', 'books']
+        
+        # Skip this example if you have already included shared context in the spec.
+        # Default is `false`.
+        example.metadata[:rpdoc_skip] = false
+    end
+    ```
+3. Run your specs, generate data in Postman format, and push your collection to the Postman server.
+   ```bash
+   $ rspec
+   ```
+
+   If you want to disable `Rpdoc` generation process manually, you can either set `rpdoc_enable = false` in configuration or just pass environment variable to rspec.
+   ```bash
+   $ RPDOC_ENABLE=false rspec
+   ```
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/VERSION.md

@@ -0,0 +1 @@
+0.1.5

data/lib/generators/templates/initializer.rb

@@ -5,10 +5,10 @@ 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.
+  # (Optional) Apikey for your Postman account, used if want to push collection to the Postman server.
   # config.postman_apikey = 'postman_apikey'
 
-  # (Optional) Workspace that your collection will be push to. Default your account's personal workspace. 
+  # (Optional) Workspace that your collection will be pushed 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.

data/lib/rpdoc/configuration.rb

@@ -4,7 +4,7 @@ module Rpdoc
   class Configuration
     attr_reader \
       :postman_host,
-      :postman_collection_endpoint,
+      :postman_collection_path,
       :collection_schema
 
     attr_accessor \
@@ -23,10 +23,10 @@ module Rpdoc
       :rpdoc_auto_push_strategy
 
     def initialize
-      @rpdoc_enable = true
+      @rpdoc_enable = ENV['RPDOC_ENABLE'] != 'false'
 
       @postman_host = 'https://api.getpostman.com'
-      @postman_collection_endpoint = "#{@postman_host}/collections"
+      @postman_collection_path = "/collections"
       @postman_apikey = nil
 
       @collection_workspace = nil
@@ -46,7 +46,10 @@ module Rpdoc
     end
   
     def valid?
-      @rpdoc_enable && @rpdoc_auto_push ? !@postman_apikey.nil? : true
+      return true unless @rpdoc_enable && @rpdoc_auto_push
+      return false if @postman_apikey.nil?
+      return false if @rpdoc_auto_push_strategy == :push_and_update && @collection_uid.nil?
+      true
     end
   end
 end

data/lib/rpdoc/helper.rb

@@ -1,20 +1,23 @@
 # frozen_string_literal: true
+require 'rspec/rails' if defined?(RSpec::Rails)
 
 RSpec.configure do |config|
   config.before(:suite) do
+    root = Rpdoc.configuration.rpdoc_root
     if Rpdoc.configuration.rpdoc_enable
       raise StandardError.new('Configuration Invalid') unless Rpdoc.configuration.valid?
-      Dir.glob("#{Rpdoc.configuration.rpdoc_root}/**/*.json") do |filename|
+      FileUtils.mkdir_p(root) unless File.exists?(root)
+      Dir.glob("#{root}/**/*.json") do |filename|
         File.delete(filename)
       end
     end
   end
 
   config.after(:suite) do
-    if Rpdoc.configuration.rpdoc_enable && Rpdoc.configuration.rpdoc_auto_push
+    if Rpdoc.configuration.rpdoc_enable
       postman_collection = Rpdoc::PostmanCollection.new
       postman_collection.save
-      postman_collection.send(Rpdoc.configuration.rpdoc_auto_push_strategy)
+      postman_collection.send(Rpdoc.configuration.rpdoc_auto_push_strategy) if Rpdoc.configuration.rpdoc_auto_push
     end
   end
 end

data/lib/rpdoc/postman_collection.rb

@@ -1,17 +1,19 @@
 # frozen_string_literal: true
 
+require 'json_requester'
+
 module Rpdoc
   class PostmanCollection
 
     def initialize
       @configuration = Rpdoc.configuration
-      @requester = JsonRequester.new(Settings.kdan_service.data_center)
+      @requester = JsonRequester.new(@configuration.postman_host)
 
       @data = generated_collection_data
     end
 
     def push_and_create
-      path = "#{@configuration.postman_collection_endpoint}?workspace=#{@configuration.collection_workspace}"
+      path = "#{@configuration.postman_collection_path}?workspace=#{@configuration.collection_workspace}"
       headers = {
         'X-Api-Key': @configuration.postman_apikey
       }
@@ -19,7 +21,7 @@ module Rpdoc
     end
 
     def push_and_update
-      path = "#{@configuration.postman_collection_endpoint}/#{@configuration.collection_uid}"
+      path = "#{@configuration.postman_collection_path}/#{@configuration.collection_uid}"
       headers = {
         'X-Api-Key': @configuration.postman_apikey
       }
@@ -38,10 +40,6 @@ module Rpdoc
 
     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: {
@@ -86,7 +84,9 @@ module Rpdoc
 
     def merged_by(other_collection_data)
       clean_generated_responses_from(other_collection_data[:collection][:item])
-      insert_generated_responses_into(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)
@@ -101,23 +101,25 @@ module Rpdoc
       end
     end
 
-    def insert_generated_responses_into(collection_items, from_collection_items: nil)
-      from_collection_items ||= @data[:collection][:item]
-
+    def insert_generated_responses_into(collection_items, from_collection_items: [])
       if collection_items.empty?
         collection_items = from_collection_items.deep_dup
       else
+        # transform collection_items into hash, using item[:name] as key
         item_hash = {}
         collection_items.each do |item|
           item_hash[item[:name]] = item
         end
 
+        # insert generated responses and replace description into corresponding items based on item[:name]
         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)
+              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])
             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][:response] += from_item[:response].deep_dup
             else
               collection_items << from_item.deep_dup

data/lib/rpdoc/postman_response.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'cgi'
+
 module Rpdoc
   class PostmanResponse
     attr_reader :data
@@ -38,15 +40,20 @@ module Rpdoc
     def response_data
       headers = @rspec_response.header.map { |key, value| {key: key, value: value} }
       headers << rspec_location_header
-      {
+      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,
-        body: JSON.pretty_generate(JSON.parse(@rspec_response.body))
       }
+      if @rspec_response.headers['Content-Type'].include?('application/json')
+        data[:body] = JSON.pretty_generate(JSON.parse(@rspec_response.body)) rescue nil
+      else
+        data[:body] = @rspec_response.body
+      end
+      data
     end
 
     def rspec_location_header
@@ -65,6 +72,14 @@ module Rpdoc
           value: @rspec_request.headers[header]
         }
       end.compact
+      query_string = @rspec_request.query_string.split('&').map do |string|
+        key, value = string.split('=')
+        {
+          key: key,
+          value: CGI.unescape(value),
+          text: 'text'
+        }
+      end
       @original_request_data = {
         method: @rspec_request.method,
         header: filter_headers,
@@ -72,7 +87,7 @@ module Rpdoc
           raw: "#{@configuration.rspec_server_host}#{@rspec_request.path}",
           host: [@configuration.rspec_server_host],
           path: @rspec_request.path.split('/'),
-          variable: [],
+          query: query_string
         },
         body: nil
       }

data/lib/rpdoc/rpdoc.rake

@@ -0,0 +1,8 @@
+namespace :rpdoc do
+  desc 'push collection to the Postman server'
+  task :push => :environment do
+    postman_collection = Rpdoc::PostmanCollection.new
+    postman_collection.save
+    postman_collection.send(Rpdoc.configuration.rpdoc_auto_push_strategy) if Rpdoc.configuration.rpdoc_auto_push
+  end
+end

data/lib/rpdoc/version.rb

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

data/rpdoc.gemspec

@@ -8,18 +8,12 @@ Gem::Specification.new do |spec|
   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.summary       = "RSpec to Postman Documentation Tool"
+  spec.description   = "Rpdoc is a simple Postman API documentation tool, which transforms RSpec examples to Postman collection."
+  spec.homepage      = "https://github.com/kdan-mobile-software-ltd/rpdoc"
   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
@@ -29,15 +23,10 @@ Gem::Specification.new do |spec|
   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 'railties', '~> 6.1.4'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry', '~> 0.14.1'
   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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.5
 platform: ruby
 authors:
 - yuntai
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-01 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_requester
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 6.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 6.1.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -80,8 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: With RSpec examples, it will generate Postman collection and push to
-  the Postman server.
+description: Rpdoc is a simple Postman API documentation tool, which transforms RSpec
+  examples to Postman collection.
 email:
 - yuntai.yang@kdanmobile.com
 executables: []
@@ -89,6 +89,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
@@ -96,6 +97,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- VERSION.md
 - bin/console
 - bin/setup
 - lib/generators/rpdoc/install_generator.rb
@@ -105,16 +107,14 @@ files:
 - lib/rpdoc/helper.rb
 - lib/rpdoc/postman_collection.rb
 - lib/rpdoc/postman_response.rb
+- lib/rpdoc/rpdoc.rake
 - lib/rpdoc/version.rb
 - rpdoc.gemspec
-homepage: https://www.kdanmobile.com
+homepage: https://github.com/kdan-mobile-software-ltd/rpdoc
 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:
+metadata: {}
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -129,8 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.2.22
+signing_key: 
 specification_version: 4
-summary: A gem to transform RSpec examples to Postman collection
+summary: RSpec to Postman Documentation Tool
 test_files: []