newman_scenario 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 559c5e124ccffa5e4f98839bc34a87351203e13f977dbc07820fe7f7cdf9720b
-  data.tar.gz: a0935c087ed1e143699f7932c04965845b90c90cecd66cedfe21a58056e9861f
+  metadata.gz: 974c64e5aba070897acfef6b3156b1e72373760c2daabeee9abc5972c30f60d6
+  data.tar.gz: 5b4c7294a9dd87669272f4c4632e4c165872d7840b5b50ec9ca59437a0db13cd
 SHA512:
-  metadata.gz: 5da5a15b5291c5a38224b6e352181f876a2451c202af0e396dbb3500884e63e329a4512c9110bf1438e573955356fee7d353a1685f55d8d6cf0e83bd0033ceff
-  data.tar.gz: 849b32f48312ae202757ffb1b17197a9936fd0d4671b5196ad507b0fe8a3e891108f3efe94e872f919cd54c43748985eb23ff036fad2d5ecb70aa3bfb36d179a
+  metadata.gz: 607faa6bb4ab1a8cc839028146f0c61b80463433c89a9b4ec83931d2eca5693ec1e2f6d00437a1145c774f39c8fc6c90ffe270cf95416c56929f1021681b3875
+  data.tar.gz: 453b185f054f60e2c6a3fb429a2627ffd8294098d33b6dd417030710dcfae0d08905dbe26264eedab66c9e1548a6dfadb2d84e5d82013e420c089cc43b97ea07

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    newman_scenario (0.1.1)
+    newman_scenario (0.1.2)
       dotenv (= 2.7.5)
       httparty (= 0.16.2)
       thor (= 1.0.1)

data/README.md

@@ -113,10 +113,10 @@ NewmanScenario::Scenario.new.run(scenario_name: 'Signup', environment_name: 'sta
 - [x] `NewmanScenario::Scenario.run`
 - [ ] Specs :(
 - [x] `newman_scenario` cli
-- [x] Configure using `NewmanScenario::Scenario.configure`
+- [x] Configure using `NewmanScenario::Scenario.configure` or `newman_scenario configure`
+- [x] Fetch available collections and environments from Postman
 - [ ] Support for custom scenario variable
 - [ ] Support for local environment (no synchronised with Postman)
-- [ ] Fetch available collections and environments from Postman
 
 ## Development
 

data/lib/newman_scenario/cli.rb

@@ -2,6 +2,8 @@ require 'thor'
 
 module NewmanScenario
   class CLI < Thor
+    default_task :run_scenario
+
     desc "run_scenario environment scenario", "Run scenario using environment"
     long_desc <<~EOF
 

data/lib/newman_scenario/scenario.rb

@@ -25,23 +25,30 @@ module NewmanScenario
       attr_accessor :default_last_scenario_file_path
 
       def configure(default_api_key: nil, default_collection_id: nil, default_environment_ids: nil, default_custom_scenarios_file_path: nil, default_last_scenario_file_path: nil)
-        self.default_api_key = default_api_key || prompt.ask('Postman API Key:')
-        self.default_collection_id = default_collection_id || prompt.ask('Postman Collection Id:')
+        self.default_api_key = default_api_key || prompt.ask('Postman API Key (https://YOURPOSTMAN.postman.co/settings/me/api-keys):', value: ENV['POSTMAN_API_KEY'].to_s)
+        collections = fetch_postman('/collections', api_key: self.default_api_key).parsed_response&.fetch('collections', nil) || []
+        collections = collections.map { |collection| collection.slice('name', 'id').values }.to_h
+        self.default_collection_id = default_collection_id || prompt.select('Postman Collection', collections, default: 1)
         self.default_environment_ids = default_environment_ids
         unless self.default_environment_ids
-          self.default_environment_ids = {}
-          loop do
-            break unless prompt.yes?('Add environment?')
-
-            name = prompt.ask('Environment Name:')
-            id = prompt.ask('Environment Id:')
-            self.default_environment_ids[name] = id
-          end
+          environments = fetch_postman('/environments', api_key: self.default_api_key).parsed_response&.fetch('environments', nil) || []
+          environments = environments.map { |environment| environment.slice('name', 'id').values }.to_h
+          environment_ids = prompt.multi_select('Postman Collection', environments)
+          self.default_environment_ids = environments.select { |_, id| environment_ids.include?(id) }
         end
         self.default_custom_scenarios_file_path = default_custom_scenarios_file_path || prompt.ask('Custom scenarios file path:', value: DEFAULT_CUSTOM_SCENARIOS_FILE_PATH)
         self.default_last_scenario_file_path = default_last_scenario_file_path || prompt.ask('Last scenario file path:', value: DEFAULT_LAST_SCENARIO_FILE_PATH)
         if (env_path = prompt.ask('Save to: [enter to not save]', value: '.env'))
-          File.open(env_path, 'a') do |file|
+          envs = {
+            POSTMAN_API_KEY: self.default_api_key,
+            NEWMAN_SCENARIO_COLLECTION_ID: self.default_collection_id,
+            NEWMAN_SCENARIO_ENVIRONMENTS: self.default_environment_ids.to_json,
+            NEWMAN_SCENARIO_CUSTOM_COLLECTION_FILE_PATH: self.default_custom_scenarios_file_path,
+            NEWMAN_SCENARIO_LAST_SCENARIO_FILE_PATH: self.default_last_scenario_file_path,
+          }
+          existing_lines = File.readlines(env_path).reject { |line| envs.keys.include?(line.split(':').first.to_sym) }
+          File.open(env_path, 'w+') do |file|
+            existing_lines.each { |line| file.puts line }
             file.puts "POSTMAN_API_KEY: #{self.default_api_key}"
             file.puts "NEWMAN_SCENARIO_COLLECTION_ID: #{self.default_collection_id}"
             file.puts "NEWMAN_SCENARIO_ENVIRONMENTS: #{self.default_environment_ids.to_json}"
@@ -51,8 +58,15 @@ module NewmanScenario
         end
       end
 
+      def fetch_postman(url_path, expected_response_codes: [200], api_key: nil)
+        response = HTTParty.get("https://api.getpostman.com#{url_path}", headers: { 'X-Api-Key' => api_key})
+        raise Error, "Invalid response code: #{response.code}" unless expected_response_codes.include?(response.code)
+
+        response
+      end
+
       private
-      
+
       def prompt
         @prompt ||= TTY::Prompt.new
       end
@@ -91,7 +105,6 @@ module NewmanScenario
     def run(environment_name: nil, scenario_name: nil, bail: true, no_prompt: false)
       return if `which newman`.empty? && !prompt_to_install_newman
 
-      prompt_to_set_api_key unless api_key
       environment = environment_ids[environment_name.to_sym] if environment_name
       environment ||= prompt.select("Environment", environment_ids, default: 1)
       load_postman_environment(environment, no_prompt: no_prompt)
@@ -176,13 +189,6 @@ module NewmanScenario
       cmd('brew install newman')
     end
 
-    def prompt_to_set_api_key
-      prompt.warn 'Missing Postman API Key'
-      prompt.warn 'Get one from: https://YOURPOSTMAN.postman.co/settings/me/api-keys'
-      self.api_key = prompt.ask('Postman API Key')
-      cmd("echo \"POSTMAN_API_KEY: #{self.api_key}\" >> .env")
-    end
-
     def load_postman_environment(environment, no_prompt: false)
       reload =
         if no_prompt
@@ -204,10 +210,8 @@ module NewmanScenario
       end
     end
 
-    def fetch_postman_to_file(url_path, file_path)
-      response = HTTParty.get("https://api.getpostman.com/#{url_path}", headers: { 'X-Api-Key' => api_key})
-      raise Error, "Invalid response code: #{response.code}" unless response.code == 200
-
+    def fetch_postman_to_file(url_path, file_path, expected_response_codes: [200])
+      response = self.class.fetch_postman(url_path, expected_response_codes: expected_response_codes, api_key: api_key)
       File.open(file_path, 'w+') do |file|
         file.puts response.body
       end

data/lib/newman_scenario/version.rb

@@ -1,3 +1,3 @@
 module NewmanScenario
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newman_scenario
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Hugues Bernet-Rollande