RubyGems - newman_scenario - Versions diffs - 0.1.2 → 0.1.3 - Mend

newman_scenario 0.1.2 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

checksums.yaml +4 -4
data/Gemfile.lock +3 -3
data/README.md +28 -28
data/lib/newman_scenario/scenario.rb +32 -20
data/lib/newman_scenario/version.rb +1 -1
data/newman_scenario.gemspec +16 -16
metadata +3 -3

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 974c64e5aba070897acfef6b3156b1e72373760c2daabeee9abc5972c30f60d6
-  data.tar.gz: 5b4c7294a9dd87669272f4c4632e4c165872d7840b5b50ec9ca59437a0db13cd
+  metadata.gz: a249bfa843b4d5696be896e2ac9066cd3891da46cbcc0348ca29b587b6f742ad
+  data.tar.gz: 6c4f66cb953c7ffdf5dacb496889123425ecf4143eefaa83aaf438d42d4bdbcf
 SHA512:
-  metadata.gz: 607faa6bb4ab1a8cc839028146f0c61b80463433c89a9b4ec83931d2eca5693ec1e2f6d00437a1145c774f39c8fc6c90ffe270cf95416c56929f1021681b3875
-  data.tar.gz: 453b185f054f60e2c6a3fb429a2627ffd8294098d33b6dd417030710dcfae0d08905dbe26264eedab66c9e1548a6dfadb2d84e5d82013e420c089cc43b97ea07
+  metadata.gz: 4dec924de1eea41bce0cc3ca79605521cc33235c254469819126104bf93bbf48ae12b75434e23d35071131f3cf72048b12670b68e1dea9aa57b4a51cd1750623
+  data.tar.gz: 1e925af5a9c6865e52d4bf8d06f39a88f48448244ffb2613595882325850c86816888d469c7baf6ff0439f59b15f4e578f8e1d7ba5d2eaa773e934cbd6bec688

data/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    newman_scenario (0.1.2)
+    newman_scenario (0.1.3)
       dotenv (= 2.7.5)
       httparty (= 0.16.2)
       thor (= 1.0.1)
@@ -20,7 +20,7 @@ GEM
     pastel (0.7.3)
       equatable (~> 0.6)
       tty-color (~> 0.5)
-    rake (10.5.0)
+    rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -54,7 +54,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   newman_scenario!
-  rake (~> 10.0)
+  rake (~> 12.3)
   rspec (~> 3.0)
 BUNDLED WITH

data/README.md CHANGED Viewed

@@ -5,15 +5,18 @@ It supports:
 - loading a Postman environment file against the requests.
 - running a "folder" of requests
-This is great, but if you want to perform the same request in multiple "folder", you
+It's awesome, but if you want to perform the same request in multiple "folder", you
 will end up duplicating this requests, which make it hard to maintain.
-Also, it can be clumbersome to add new "scenario" ("folder") from Postman.
+Also, it can be clumbersome to add new "scenario" ("folder") from [Postman](https://www.postman.com).
+At @babylist, we (I?) use it to feed some pre-built scenario ("create a user", "sign-in", "add a product to the cart", "checkout").
+Even if using [Postman](https://www.postman.com) , you can group your requests in a folder ("checkout flow") and run `newman --folder "checkout flow"`, it can be tricky to maintain, if you're re-using "create a user" in different scenarios.
 Here comes `NewmanScenario`.
-It basically allow you to cherry pick some requests to be chained, saved them, and run
-the newly created "scenario".
+It basically allow you to cherry pick some requests to be chained, saved them (locally), and run
+the newly created (locally) "scenario".
 The newly builded scenarios are just a list of requests, store in a json format file.
 The file is store in the current working directory under `newman_scenarios.json`
@@ -39,21 +42,22 @@ Or install it yourself as:
 ### Using configure`
-configure will guide you to set Postman related collection id and environments ids, and
+configure will guide you to set Postman related collection and environments (fetch from [Postman](https://www.postman.com) ), and
 stores them in `.env`
-  $ newman_scenario configure
+    $ newman_scenario configure
 ### Setting `.env` manually
 Add this to your `ENV` or `.env`
 ```
-POSTMAN_API_KEY: POSTMAN_API_KEY (https://YOURPOSTMAN.postman.co/settings/me/api-keys)
-# postman environments ids (extract from) in json format
-NEWMAN_SCENARIO_ENVIRONMENTS: {"staging1": "7361507-b4fcda81-db77-0000-AAAA-XXXXXX","staging3": "7361507-5f29f2c7-efff-0000-AAAA-XXXXX","staging5": "7361507-f360c483-6277-0000-AAAA-XXXXX","local": "2d98e3c9-27dc-0000-AAAA-XXXXX"}
-# postman collection id (extract from)
-NEWMAN_SCENARIO_COLLECTION_ID: 7361507-9627fa69-1fe0-0000-AAAA-XXXXXX
+# from https://YOURPOSTMAN.postman.co/settings/me/api-keys
+POSTMAN_API_KEY: POSTMAN_API_KEY ()
+# postman environments id/name in json format
+NEWMAN_SCENARIO_ENVIRONMENTS: {"staging1": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","staging3": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","staging5": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","local": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}
+# postman collection id
+NEWMAN_SCENARIO_COLLECTION_ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
 ```
 ### Rails App
@@ -63,9 +67,9 @@ NEWMAN_SCENARIO_COLLECTION_ID: 7361507-9627fa69-1fe0-0000-AAAA-XXXXXX
 require 'newman_scenario'
 NewmanScenario::Scenario.configure(
-  default_api_key: 'PMAK-XXXX-XXXX', # ENV['POSTMAN_API_KEY'], no default value
-  default_collection_id: 'ABCDEF-XXXXX-XXXX-0000-AAAA-XXXXXX', # ENV['NEWMAN_SCENARIO_COLLECTION_ID'], no default value
-  default_environment_ids: { staging: 'YXZ-XXXXX-XXXX-0000-AAAA-XXXXXX', production: 'ABC-XXXXX-XXXX-0000-AAAA-XXXXXX'},  # ENV['NEWMAN_SCENARIO_ENVIRONMENTS'] (json format), no default value
+  default_api_key: 'PMAK-xxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', # ENV['POSTMAN_API_KEY'], no default value
+  default_collection_id: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', # ENV['NEWMAN_SCENARIO_COLLECTION_ID'], no default value
+  default_environment_ids: { staging: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', production: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'},  # ENV['NEWMAN_SCENARIO_ENVIRONMENTS'] (json format), no default value
   default_custom_scenarios_file_path: 'newman-scenarios.json', # ENV['NEWMAN_SCENARIO_CUSTOM_COLLECTION_FILE_PATH'], default: `newman_scenarios.json`
   default_last_scenario_file_path: '/tmp/last_newman_scenario.json' # ENV['NEWMAN_SCENARIO_LAST_SCENARIO_FILE_PATH'], default: `last_newman_scenario.json`
 )
@@ -77,24 +81,16 @@ NewmanScenario::Scenario.configure(
 ### Stand alone
-```
-# will prompt you to select a environment (by it's name, see configuration)
-# and create or re-use a `NewmanScenario`
-# newly created scenario can be saved
-newman_scenario
+> running the gem itself will prompt you to select a environment (by it's name, see configuration)
+and create or re-use a `NewmanScenario` newly created scenario which can be saved.
-# will run the previous created scenario 'Signup' against staging3 environment (with no extra prompt)
-newman_scenario staging3 Signup
-```
+    $ newman_scenario
-### Within App
+> run with a environment name and/or a scenario name will run the previous created scenario 'Signup' against staging3 environment (with no extra prompt)
-```ruby
-require 'newman_scenario'
+    $ newman_scenario staging3 Signup
-# will run the previous created scenario 'Signup' against staging3 environment (with no extra prompt)
-NewmanScenario::Scenario.new.run(scenario_name: 'Signup', environment_name: 'staging3', no_prompt: true)
-```
+### Within App
 ```ruby
 require 'newman_scenario'
@@ -108,6 +104,10 @@ NewmanScenario::Scenario.new.run
 NewmanScenario::Scenario.new.run(scenario_name: 'Signup', environment_name: 'staging3', no_prompt: true)
 ```
+## How it works
+Beside all the "trivial" Postman collection and environments fetching, it basically scan your collection, cherry pick the requests which match request names stored for a "custom" scenario, create a brand new (local) collection which requests and run this new scenario (collection) using `newman`
 ## Roadmap
 - [x] `NewmanScenario::Scenario.run`

data/lib/newman_scenario/scenario.rb CHANGED Viewed

@@ -10,9 +10,10 @@ module NewmanScenario
   class Scenario
     DEFAULT_CUSTOM_SCENARIOS_FILE_PATH = 'newman_scenarios.json'.freeze
     DEFAULT_LAST_SCENARIO_FILE_PATH = '/tmp/last_newman_scenario.json'.freeze
+    DEBUG = false
     @default_collection_id = ENV['NEWMAN_SCENARIO_COLLECTION_ID']
-    @default_environment_ids = nil
+    @default_environments = nil
     @default_api_key = ENV['POSTMAN_API_KEY']
     @default_custom_scenarios_file_path = ENV['NEWMAN_SCENARIO_CUSTOM_COLLECTION_FILE_PATH'] || DEFAULT_CUSTOM_SCENARIOS_FILE_PATH
     @default_last_scenario_file_path = ENV['NEWMAN_SCENARIO_LAST_SCENARIO_FILE_PATH'] || DEFAULT_LAST_SCENARIO_FILE_PATH
@@ -20,21 +21,31 @@ module NewmanScenario
     class << self
       attr_accessor :default_api_key
       attr_accessor :default_collection_id
-      attr_accessor :default_environment_ids
+      attr_accessor :default_environments
       attr_accessor :default_custom_scenarios_file_path
       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)
+      def configure(default_api_key: nil, default_collection_id: nil, default_environments: 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 (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 = nil
+        environments = nil
+        if prompt.yes?('Using workspace?')
+          workspaces = fetch_postman('/workspaces', api_key: self.default_api_key).parsed_response&.fetch('workspaces', nil) || []
+          workspaces = workspaces.map { |workspace| workspace.slice('name', 'id').values }.to_h
+          workspace = prompt.select('Workspace', workspaces)
+          workspace = fetch_postman("/workspaces/#{workspace}", api_key: self.default_api_key).parsed_response&.fetch('workspace', nil) || {}
+          collections = workspace['collections']
+          environments = workspace['environments']
+        end
+        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
-          environments = fetch_postman('/environments', api_key: self.default_api_key).parsed_response&.fetch('environments', nil) || []
+        self.default_environments = default_environments
+        unless self.default_environments
+          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) }
+          self.default_environments = 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)
@@ -42,7 +53,7 @@ module NewmanScenario
           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_ENVIRONMENTS: self.default_environments.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,
           }
@@ -51,7 +62,7 @@ module NewmanScenario
             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}"
+            file.puts "NEWMAN_SCENARIO_ENVIRONMENTS: #{self.default_environments.to_json}"
             file.puts "NEWMAN_SCENARIO_CUSTOM_COLLECTION_FILE_PATH: #{self.default_custom_scenarios_file_path}"
             file.puts "NEWMAN_SCENARIO_LAST_SCENARIO_FILE_PATH: #{self.default_last_scenario_file_path}"
           end
@@ -59,6 +70,7 @@ module NewmanScenario
       end
       def fetch_postman(url_path, expected_response_codes: [200], api_key: nil)
+        puts "fetching #{url_path}" if DEBUG
         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)
@@ -73,18 +85,18 @@ module NewmanScenario
     end
     attr_accessor :collection_id
-    attr_accessor :environment_ids
+    attr_accessor :environments
     attr_accessor :api_key
     attr_accessor :custom_collection_file_path
     attr_accessor :last_scenario_file_path
-    def initialize(collection_id: nil, environment_ids: nil, api_key: nil, custom_collection_file_path: nil, last_scenario_file_path: nil)
+    def initialize(collection_id: nil, environments: nil, api_key: nil, custom_collection_file_path: nil, last_scenario_file_path: nil)
       self.collection_id ||= self.class.default_collection_id
       raise ConfigurationError, 'Missing Collection Id' unless self.collection_id
-      self.environment_ids ||= self.class.default_environment_ids
-      self.environment_ids ||= JSON.parse(ENV['NEWMAN_SCENARIO_ENVIRONMENTS'], symbolize_names: true) if ENV['NEWMAN_SCENARIO_ENVIRONMENTS']
-      raise ConfigurationError, 'Missing Environment Ids' unless self.environment_ids
+      self.environments ||= self.class.default_environments
+      self.environments ||= JSON.parse(ENV['NEWMAN_SCENARIO_ENVIRONMENTS'], symbolize_names: true) if ENV['NEWMAN_SCENARIO_ENVIRONMENTS']
+      raise ConfigurationError, 'Missing Environment Ids' unless self.environments
       self.api_key ||= self.class.default_api_key
       raise ConfigurationError, 'Missing Postman API Key' unless self.api_key
@@ -105,8 +117,8 @@ module NewmanScenario
     def run(environment_name: nil, scenario_name: nil, bail: true, no_prompt: false)
       return if `which newman`.empty? && !prompt_to_install_newman
-      environment = environment_ids[environment_name.to_sym] if environment_name
-      environment ||= prompt.select("Environment", environment_ids, default: 1)
+      environment = environments[environment_name.to_sym] if environment_name
+      environment ||= prompt.select('Environment', environments, default: 1)
       load_postman_environment(environment, no_prompt: no_prompt)
       collection = JSON.parse(File.read("/tmp/postman-collection-#{collection_id}.json"), symbolize_names: true)[:collection]
       unless File.exist?(last_scenario_file_path) && (!scenario_name && prompt.yes?('Replay last scenario?'))
@@ -123,7 +135,7 @@ module NewmanScenario
           all_request_names = extract_all_requests.call(collection, '')
           loop do
             scenario_requests.delete('duplicate')
-            scenario_requests += prompt.multi_select("Requests (type to filter prefix, choose duplicate to perform action multiple times)", ['duplicate'] + all_request_names, cycle: true, filter: true)
+            scenario_requests += prompt.multi_select('Requests (type to filter prefix, choose duplicate to perform action multiple times)', ['duplicate'] + all_request_names, cycle: true, filter: true)
             break unless scenario_requests.include?('duplicate')
           end
@@ -194,7 +206,7 @@ module NewmanScenario
         if no_prompt
           false
         else
-          !prompt.no?("Refetch postman config?")
+          !prompt.no?('Refetch postman config?')
         end
       if File.file?("/tmp/postman-environment-#{environment}.json") && !reload
         prompt.ok "reusing env /tmp/postman-environment-#{environment}.json"
@@ -203,7 +215,7 @@ module NewmanScenario
         fetch_postman_to_file("/environments/#{environment}", "/tmp/postman-environment-#{environment}.json")
       end
       if File.file?('/tmp/postman-collection.json') && !reload
-        prompt.ok "reusing collection /tmp/postman-collection.json"
+        prompt.ok 'reusing collection /tmp/postman-collection.json'
       else
         prompt.ok "fetching collection #{collection_id}"
         fetch_postman_to_file("/collections/#{collection_id}", "/tmp/postman-collection-#{collection_id}.json")

data/lib/newman_scenario/version.rb CHANGED Viewed

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

data/newman_scenario.gemspec CHANGED Viewed

@@ -1,14 +1,14 @@
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "newman_scenario/version"
+require 'newman_scenario/version'
 Gem::Specification.new do |spec|
-  spec.name          = "newman_scenario"
+  spec.name          = 'newman_scenario'
   spec.version       = NewmanScenario::VERSION
-  spec.authors       = ["Hugues Bernet-Rollande"]
-  spec.email         = ["hugues@xdev.fr"]
+  spec.authors       = ['Hugues Bernet-Rollande']
+  spec.email         = ['hugues@xdev.fr']
-  spec.summary       = "Allow to run re-usable collection of requests using newman"
+  spec.summary       = 'Allow to run re-usable collection of requests using newman'
   spec.description   = <<~EOF
     Postman doesn't support re-using the same requests in multiple scenario.
     Duplicating request will make it hard to maintain them.
@@ -18,29 +18,29 @@ Gem::Specification.new do |spec|
     NewmanScenario try to fill this gap.
   EOF
-  spec.homepage      = "https://github.com/huguesbr/newman_scenario"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/huguesbr/newman_scenario'
+  spec.license       = 'MIT'
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/huguesbr/newman_scenario"
-  spec.metadata["changelog_uri"] = "https://github.com/huguesbr/newman_scenario/README.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/huguesbr/newman_scenario'
+  spec.metadata['changelog_uri'] = 'https://github.com/huguesbr/newman_scenario/README.md'
   # 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('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "bin"
+  spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-  spec.executables = ["newman_scenario"]
+  spec.require_paths = ['lib']
+  spec.executables = ['newman_scenario']
   spec.add_dependency 'tty-prompt', '0.19.0'
   spec.add_dependency 'httparty', '0.16.2'
   spec.add_dependency 'thor', '1.0.1'
   spec.add_dependency 'dotenv', '2.7.5'
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newman_scenario
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Hugues Bernet-Rollande
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement