apipie-postman 0.0.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b51cef8c7fc976fc2ccc65adea1a7a310e78a88f13012da523513e569daa6d0
-  data.tar.gz: 270436badcf392d477d9a1ac1f734a5443a6ef2d6a34b1866fe230c0357c2075
+  metadata.gz: cb15fdaecb71ee97ad64d367620f122fc5ba847e682dfe5692c61b05d2fd8a98
+  data.tar.gz: 104174bf8f7dec3283fa1202e616c5d992d6496b8c6d99e3bb111e0293a0308f
 SHA512:
-  metadata.gz: 7bd3da97802ae8f63790df791660075b51f165f9a941dbf29402a5d6f4dea6d3c89439e5460eb2356635bd1ca42432d378cc712eb22e07f936a48e6d944b566a
-  data.tar.gz: 43627d5c8b2c6cebbe592592e2fc181e2fc8bf57ffdf694af7dcbfe944458521350e9cad7328a37e03a167f88b4a8489e2e118761d9c41df18595db016d04a49
+  metadata.gz: e6c6ddb7271df9f1ff84f4f939cc86c7cd1365fc71b8ec505d183841b2d6ca7be309ebf25e93c26cc4e843b09fb50c0102422459bc41e1869e46e7bc8d7e12d7
+  data.tar.gz: 6e31ad3dd6ccea47efb91c80fb566a84434ea173a06bcc397e3914555b2b4536497274da284924e8598a2b1b7a5c6e5cd49791747ab2b7b91ed50e25faaff925

data/lib/apipie-postman.rb

@@ -3,7 +3,6 @@
 require 'json'
 require 'faraday'
 
-# General module for gem
 module ApipiePostman
   class << self
     attr_accessor :configuration
@@ -30,36 +29,19 @@ module ApipiePostman
   def self.generate_docs
     file = File.read('doc/apipie_examples.json')
     @docs = JSON.parse(file)
-    docs_hashes = []
-    endpoints_hashes = []
+    folder_hashes = []
 
-    @docs.each_key do |key|
-      docs_hashes << @docs[key]
-    end
+    @docs = @docs.each_with_object({}) do |array, result|
+      key = array[0].to_s.split('#')[0]
+      (result[key] ||= []).concat(array[1])
+    end.transform_values(&:flatten)
 
-    docs_hashes.each do |doc_hash|
-      doc_hash.each do |endpoint|
-        req_body = if endpoint['request_data'].nil?
-                     {}
-                   else
-                     endpoint['request_data']
-                   end
-
-        endpoints_hashes << {
-          name: endpoint['title'],
-          request: {
-            url: "#{self.configuration.base_url}#{endpoint['path']}",
-            method: endpoint['verb'],
-            header: [],
-            body: {
-              mode: 'raw',
-              raw: req_body.to_json
-            },
-            description: endpoint['title']
-          },
-          response: []
-        }
+    @docs.each_key do |key|
+      key_endpoint_hashes = []
+      @docs[key].each do |endpoint|
+        key_endpoint_hashes << create_endpoint_hash(endpoint, endpoint['request_data'] || {})
       end
+      folder_hashes << create_folder(key, key_endpoint_hashes)
     end
 
     body = {
@@ -69,25 +51,53 @@ module ApipiePostman
           description: 'Test description',
           schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
         },
-        item: endpoints_hashes
+        item: folder_hashes
       }
     }.to_json
+
     headers = {
       'X-Api-Key': self.configuration.postman_api_key,
       'Content-Type': 'application/json'
     }
 
-    Faraday.public_send(:post, 'https://api.getpostman.com/collections/', body, headers)
+    collection_uid = check_collection_uid_by_name(headers)
+
+    if collection_uid.nil?
+      Faraday.public_send(:post, 'https://api.getpostman.com/collections/', body, headers)
+    else
+      Faraday.public_send(:put, "https://api.getpostman.com/collections/#{collection_uid['uid']}", body, headers)
+    end
+  end
+
+  def self.check_collection_uid_by_name(headers)
+    response = Faraday.public_send(:get, 'https://api.getpostman.com/collections/', {}, headers)
+    JSON.parse(response.body)['collections'].select do |col|
+      col['name'] == self.configuration.postman_collection_name
+    end.last
+  end
 
-    # if Object.const_defined?('POSTMAN_COLLECTION_UID') && Object.const_defined?('POSTMAN_COLLECTION_ID')
-    #   Faraday.public_send(:put, "https://api.getpostman.com/collections/#{Object.const_get('POSTMAN_COLLECTION_UID')}", body, headers)
-    # else
-    #   response = Faraday.public_send(:post, 'https://api.getpostman.com/collections/', body, headers)
+  def self.create_endpoint_hash(endpoint, req_body)
+    {
+      name: endpoint['title'] == 'Default' ? "#{endpoint['verb']} #{endpoint['path']}" : endpoint['title'],
+      request: {
+        url: "#{self.configuration.base_url}#{endpoint['path']}",
+        method: endpoint['verb'],
+        header: [],
+        body: {
+          mode: 'raw',
+          raw: req_body.to_json
+        },
+        description: endpoint['title']
+      },
+      response: []
+    }
+  end
 
-    #   if response.status == 200
-    #     Object.const_set('POSTMAN_COLLECTION_UID', JSON.parse(response.body)['collection']['uid'])
-    #     Object.const_set('POSTMAN_COLLECTION_ID', JSON.parse(response.body)['collection']['id'])
-    #   end
-    # end
+  def self.create_folder(key, item_hashes)
+    {
+      name: key,
+      description: key,
+      item: item_hashes
+    }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipie-postman
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Victor Motogna
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-25 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -58,8 +58,28 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.22.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.22.1
 description: Use 'bundle exec apipie-postman' and 'rake apipie_postman' to generate
-  the docs! More details on https://github.com/VictorMotogna/apipie-postman
+  the docs!
 email: vmotogna@gmail.com
 executables:
 - apipie-postman
@@ -80,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="