postman_doc_generator 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6231e054ea9fe8243c70c13f9232a8aac62e2d092821f823ec2ee2e411b431d6
-  data.tar.gz: 6234e86033a5b4c167be3a361e15fa8d00e6e78f830220e0a4a2ff07994e3faa
+  metadata.gz: 07c7b3dbedfed56bd2f1fab1f31ac1a50d55519d480331f10eaaee6ec94bf513
+  data.tar.gz: 0d0cc052afbe3c4e1bfb651ed7c58e80630cb53bbec7df2e614fc96794099ce6
 SHA512:
-  metadata.gz: bf7d387d45406f7bdbb806822234d57f71f92e4f28acff56b4a0353615530c8f80cdefea15db32c61a171cd5f59bbde0debfd959615ef9cc093c4477e7029fd7
-  data.tar.gz: add1316aab6d8d9bf845972846d2f46b67b4eb3f9fcc0276f45f2048a5b4acbd423ead9e8e775012d45996a8dc4cdf971c4943378833efb01a8c4c13b18263d6
+  metadata.gz: 40650c1683be126d8b214483ca9be120a1b1d009284ab0a4ca90d658a5771b6ac2a0ac7a892422c87f3f742e8bc5b2d64d804470e288eee735bc459bff6e6e10
+  data.tar.gz: '029f5e5cef8559630112cb0186faa24f669932140e308b3ffa75d097bc062c057380eb77a2fcd458467cb6463966445ddae86bb5daf7b5fa4dfc4163ea8eeb8c'

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/config/postman_doc_generator.yml

@@ -0,0 +1,14 @@
+development: &development
+  postman_dir: tmp/postman
+  postman_id: defalt_postman_id
+  project_name: Default Project
+  project_host: "{{default_host}}"
+  server_host: "preparing: https://preparing4.kdanmobile.com:3012\n* production: https://store-center.kdanmobile.com (working)"
+  api_doc_name: api_doc
+  api_doc_link: api_doc_link
+
+test:
+  <<: *development
+
+production:
+  <<: *development

data/lib/postman_doc_generator.rb

@@ -4,13 +4,15 @@ 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
+  class << self
+    def start(http_method, path, controller, response)
+      generator = new(http_method, path, controller, response)
+      generator.call
+    rescue => e
+      generator.error = e
+    ensure
+      generator
+    end
   end
 
   def initialize(http_method, path, controller, response)
@@ -19,7 +21,6 @@ class PostmanDocGenerator
     @path = path
     @controller = controller
     @response = response
-    @file_path = file_path
   end
 
   def call
@@ -47,7 +48,7 @@ class PostmanDocGenerator
     @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") % @config) : JSON.parse(data)
+    @postman_data = data.blank? ? JSON.parse(File.read("#{@sample_dir}/doc.json") % @config.transform_keys(&:to_sym)) : JSON.parse(data)
   end
 
   def setup_postman_json

data/postman_doc_generator.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name        = 'postman_doc_generator'
+  s.version     = '0.1.6'
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = 'Generate Postman Doc Json After Run Rspec'
+  s.description = 'A Json API Doc Generator of Postman'
+  s.authors     = ['JiaRou']
+  s.email       = 'laura34963@kdanmobile.com'
+  s.homepage    = 'https://github.com/laura34963/postman_doc_generator'
+  s.license     = 'MIT'
+
+  s.files            = `git ls-files`.split("\n")
+  s.extra_rdoc_files = [ 'README.md' ]
+  s.rdoc_options     = ['--charset=UTF-8']
+
+  s.required_ruby_version = '>= 2.6.1'
+  s.add_development_dependency 'rspec', ['~> 3.0']
+end

data/sample/doc.json

@@ -0,0 +1,9 @@
+{
+  "info": {
+    "_postman_id": "%{postman_id}",
+    "name": "%{project_name}",
+    "description": "%{project_name}\n\n# Enviorments\n\n* %{server_host}\n\n\n### API Document\n[%{api_doc_name}](%{api_doc_link})",
+    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+  },
+  "item": []
+}

data/sample/request.json

@@ -0,0 +1,25 @@
+{
+  "name": "",
+  "request": {
+    "method": "",
+    "header": [],
+    "body": {
+      "mode": "raw",
+      "raw": "",
+      "options": {
+        "raw": {
+          "language": "json"
+        }
+      }
+    },
+    "url": {
+      "raw": "",
+      "host": [
+        ""
+      ],
+      "path": []
+    },
+    "description": ""
+  },
+  "response": []
+}

data/sample/response.json

@@ -0,0 +1,29 @@
+{
+  "name": "",
+  "originalRequest": {
+    "method": "",
+    "header": [],
+    "body": {
+      "mode": "raw",
+      "raw": "",
+      "options": {
+        "raw": {
+          "language": "json"
+        }
+      }
+    },
+    "url": {
+      "raw": "",
+      "host": [
+        ""
+      ],
+      "path": []
+    }
+  },
+  "status": "",
+  "code": 200,
+  "_postman_previewlanguage": "json",
+  "header": [],
+  "cookie": [],
+  "body": ""
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postman_doc_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - JiaRou
@@ -31,8 +31,14 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".gitignore"
 - README.md
+- config/postman_doc_generator.yml
 - lib/postman_doc_generator.rb
+- postman_doc_generator.gemspec
+- sample/doc.json
+- sample/request.json
+- sample/response.json
 homepage: https://github.com/laura34963/postman_doc_generator
 licenses:
 - MIT
@@ -53,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Generate Postman Doc Json After Run Rspec