postman_markdoc 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c42037a2ac6222e6234c07e352297e46da29641
+  data.tar.gz: 99d99b89233208bd94044a474789203e3532a127
+SHA512:
+  metadata.gz: 808a8caf23bd5c532e218804e65d6d78c9039469d13fbf24f0d37ab3886233b243c9e94336743f334ac420e8f7185e51ed2446dc078ba41f89f4e92364ba1b52
+  data.tar.gz: eafcfdaabbfbdb9e08dcc70d7154123d4b73395e81d3eaf019f897424d6d275480f40585072f87ce924461b7af8aff5612895af1965d083c5c54b6254e5971d2

data/bin/postman_markdoc

@@ -0,0 +1,13 @@
+#! /usr/bin/env ruby
+
+require 'postman_markdoc'
+stdin = STDIN.tty? ? nil : STDIN.read
+files = ARGV
+if stdin.nil? && files == []
+  puts "USAGE: specify files of collections"
+  puts "postman_markdown collection1.json collection2.json"
+elsif stdin.nil?
+  puts PostmanMarkdoc.files_to_markdown(*files)
+else
+  puts PostmanMarkdoc.raw_json_to_markdown(stdin)
+end

data/lib/postman_markdoc.rb

@@ -0,0 +1,41 @@
+require 'json'
+
+class PostmanMarkdoc
+
+  # accepts filenames as arguments
+  # returns markdown string
+  def self.files_to_markdown(*file_names)
+    raw_json = file_names.map{|f| IO.read(f)}
+    collections = raw_json.map{|json| JSON.parse(json)}
+    self.new(*collections).markdown
+  end
+
+  # accepts raw json collection string as argument
+  # returns markdown string
+  def self.raw_json_to_markdown(raw_json)
+    collection = JSON.parse(raw_json)
+    self.new(collection).markdown
+  end
+
+  attr_reader :collections, :markdown
+
+  # accepts hash representations of postman json collections
+  def initialize(*args)
+    @collections = args
+    generate_markdown
+  end
+
+  def generate_markdown
+    @markdown = ""
+    collections.each do |collection|
+      @markdown << PostmanMarkdoc::MarkdownGenerator.generate(
+                    data: collection
+                   ).content
+    end
+  end
+
+end
+
+require_relative 'postman_markdoc/collection_parser.rb'
+require_relative 'postman_markdoc/markdown_generator.rb'
+require_relative 'postman_markdoc/request_parser.rb'

data/lib/postman_markdoc/collection_parser.rb

@@ -0,0 +1,26 @@
+class PostmanMarkdoc::CollectionParser
+
+  attr_reader :data
+
+  def initialize(data)
+    @data = data
+  end
+
+  def name
+    data['info']['name']
+  end
+
+  def description
+  end
+
+  def requests
+    @requests = item.map{|i| PostmanMarkdoc::RequestParser.new(i)}
+  end
+
+  private
+
+  def item
+    @data['item'] || []
+  end
+
+end

data/lib/postman_markdoc/markdown_generator.rb

@@ -0,0 +1,42 @@
+class PostmanMarkdoc::MarkdownGenerator
+
+  def self.generate(*args)
+    generator = self.new(*args)
+    generator.generate
+    generator
+  end
+
+  attr_reader :data, :content
+
+  def initialize(options = {})
+    @data = options[:data]
+    @content = options[:content] || ""
+  end
+
+  def generate
+    collection = PostmanMarkdoc::CollectionParser.new(data)
+    @content << "## #{collection.name}\n\n"
+    if collection.description != nil
+      @content << "#{collection.description}\n\n"
+    end
+    collection.requests.each do |request|
+      @content << "### #{request.method} #{request.name}\n\n"
+      @content << "```\n#{request.url}\n```\n\n"
+      if request.description. != nil
+        @content << "#{request.description}\n\n"
+      end
+      if request.headers != []
+        @content << "#### Headers\n```\n"
+        request.headers.each do |header|
+          @content << header['key']
+          @content << "\t\t\t\t\t"
+          @content << header['value']
+          @content << "\n"
+        end
+        @content << "```\n"
+      end
+      @content << "#### Body\n```\n#{request.body}\n```\n"
+    end
+  end
+
+end

data/lib/postman_markdoc/request_parser.rb

@@ -0,0 +1,37 @@
+class PostmanMarkdoc::RequestParser
+
+  attr_reader :data
+
+  def initialize(data)
+    @data = data
+  end
+
+  def name
+    data['name']
+  end
+
+  def description
+    request['description']
+  end
+
+  def method
+    request['method']
+  end
+
+  def headers
+    @headers ||= request['header'] || []
+  end
+
+  def body
+    request['body']['raw']
+  end
+
+  def url
+    request['url']['raw']
+  end
+
+  def request
+    data['request']
+  end
+
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: postman_markdoc
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Raman Walwyn-Venugopal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-15 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: ramanvenu94@gmail.com
+executables:
+- postman_markdoc
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/postman_markdoc
+- lib/postman_markdoc.rb
+- lib/postman_markdoc/collection_parser.rb
+- lib/postman_markdoc/markdown_generator.rb
+- lib/postman_markdoc/request_parser.rb
+homepage: https://rubygems.org/gems/postman_markdoc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Convert Postman Collections to Markdown
+test_files: []