newman_scenario 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d60c8eac8bd0c964e9e3b8de49d4ef6c1f9d01dd74b8a06b4e09f30b5ab52c25
-  data.tar.gz: 4556d9ae5231ef5ff852f2efebbf3f931115ee0a2624d01733c4b83b494efba5
+  metadata.gz: 559c5e124ccffa5e4f98839bc34a87351203e13f977dbc07820fe7f7cdf9720b
+  data.tar.gz: a0935c087ed1e143699f7932c04965845b90c90cecd66cedfe21a58056e9861f
 SHA512:
-  metadata.gz: 2e8f88228bc646bf1a3f6f0f18aa7834f17a60c7b0fdc2eabc6ad47f1165bc8757bf4b450ef0a2308c913bfe9e7cb4a912115cb1099c8cb64ba0938edd10dbb5
-  data.tar.gz: 61c3fd0c42f480b401e33864fe3ce2edc643657ea323f9c9085e7bc6877dd51dc31f5f43567dbdac76553d1a9e0eef4ebc1406762a9ffff26056e8662c9c5b07
+  metadata.gz: 5da5a15b5291c5a38224b6e352181f876a2451c202af0e396dbb3500884e63e329a4512c9110bf1438e573955356fee7d353a1685f55d8d6cf0e83bd0033ceff
+  data.tar.gz: 849b32f48312ae202757ffb1b17197a9936fd0d4671b5196ad507b0fe8a3e891108f3efe94e872f919cd54c43748985eb23ff036fad2d5ecb70aa3bfb36d179a

data/Gemfile.lock

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

data/README.md

@@ -37,6 +37,15 @@ Or install it yourself as:
 
 ## Configuration
 
+### Using configure`
+
+configure will guide you to set Postman related collection id and environments ids, and
+stores them in `.env`
+
+  $ newman_scenario configure
+
+### Setting `.env` manually
+
 Add this to your `ENV` or `.env`
 
 ```
@@ -53,12 +62,13 @@ NEWMAN_SCENARIO_COLLECTION_ID: 7361507-9627fa69-1fe0-0000-AAAA-XXXXXX
 # config/initializers/newman_scenario.rb
 require 'newman_scenario'
 
-# NewmanScenario configuration
-NewmanScenario::Scenario.default_collection_id = 'ABCDEF-XXXXX-XXXX-0000-AAAA-XXXXXX' # ENV['NEWMAN_SCENARIO_COLLECTION_ID']
-NewmanScenario::Scenario.default_environment_ids = { staging: 'YXZ-XXXXX-XXXX-0000-AAAA-XXXXXX', production: ''ABC-XXXXX-XXXX-0000-AAAA-XXXXXX''} # ENV['NEWMAN_SCENARIO_ENVIRONMENTS'] (json format)
-NewmanScenario::Scenario.default_collection_id = 'PMAK-XXXX-XXXX' # ENV['POSTMAN_API_KEY']
-NewmanScenario::Scenario.default_custom_collection_file_path = 'newman-scenarios.json' # ENV['NEWMAN_SCENARIO_CUSTOM_COLLECTION_FILE_PATH'], default: `newman_scenarios.json`
-NewmanScenario::Scenario.default_last_scenario_file_path = 'newman-scenarios.json' # ENV['NEWMAN_SCENARIO_LAST_SCENARIO_FILE_PATH'], default: `last_newman_scenario.json`
+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_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`
+)
 ```
 
 ## Usage
@@ -98,6 +108,16 @@ NewmanScenario::Scenario.new.run
 NewmanScenario::Scenario.new.run(scenario_name: 'Signup', environment_name: 'staging3', no_prompt: true)
 ```
 
+## Roadmap
+
+- [x] `NewmanScenario::Scenario.run`
+- [ ] Specs :(
+- [x] `newman_scenario` cli
+- [x] Configure using `NewmanScenario::Scenario.configure`
+- [ ] Support for custom scenario variable
+- [ ] Support for local environment (no synchronised with Postman)
+- [ ] Fetch available collections and environments from Postman
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/newman_scenario/cli.rb

@@ -14,5 +14,15 @@ module NewmanScenario
     def run_scenario( environment = nil, scenario = nil )
       Scenario.new.run(scenario_name: scenario, environment_name: environment, bail: options[:bail])
     end
+
+    desc "configure", "configure Postman vs newman_scenario"
+    long_desc <<~EOF
+
+    `newman_scenario` needs some information about Postman environments and collections
+    Configure will prompt you for each and optionally save them to `.env`
+    EOF
+    def configure( )
+      Scenario.configure
+    end
   end
 end

data/lib/newman_scenario/scenario.rb

@@ -5,20 +5,57 @@ require 'dotenv/load'
 
 module NewmanScenario
   class Error < StandardError; end
+  class ConfigurationError < StandardError; end
 
   class Scenario
+    DEFAULT_CUSTOM_SCENARIOS_FILE_PATH = 'newman_scenarios.json'.freeze
+    DEFAULT_LAST_SCENARIO_FILE_PATH = '/tmp/last_newman_scenario.json'.freeze
+
     @default_collection_id = ENV['NEWMAN_SCENARIO_COLLECTION_ID']
     @default_environment_ids = nil
     @default_api_key = ENV['POSTMAN_API_KEY']
-    @default_custom_collection_file_path = ENV['NEWMAN_SCENARIO_CUSTOM_COLLECTION_FILE_PATH'] || 'newman_scenarios.json'.freeze
-    @default_last_scenario_file_path = ENV['NEWMAN_SCENARIO_LAST_SCENARIO_FILE_PATH'] || '/tmp/last_newman_scenario.json'.freeze
+    @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
 
     class << self
+      attr_accessor :default_api_key
       attr_accessor :default_collection_id
       attr_accessor :default_environment_ids
-      attr_accessor :default_api_key
-      attr_accessor :default_custom_collection_file_path
+      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)
+        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_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
+        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|
+            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_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
+        end
+      end
+
+      private
+      
+      def prompt
+        @prompt ||= TTY::Prompt.new
+      end
     end
 
     attr_accessor :collection_id
@@ -29,25 +66,31 @@ module NewmanScenario
 
     def initialize(collection_id: nil, environment_ids: nil, api_key: nil, custom_collection_file_path: nil, last_scenario_file_path: nil)
       self.collection_id ||= self.class.default_collection_id
-      raise Error, 'Missing Collection Id' unless self.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 Error, 'Missing Environment Ids' unless self.environment_ids
+      raise ConfigurationError, 'Missing Environment Ids' unless self.environment_ids
 
       self.api_key ||= self.class.default_api_key
-      raise Error, 'Missing Postman API Key' unless self.api_key
+      raise ConfigurationError, 'Missing Postman API Key' unless self.api_key
 
-      self.custom_collection_file_path ||= self.class.default_custom_collection_file_path
-      raise Error, 'Missing Custom collection file path' unless self.custom_collection_file_path
+      self.custom_collection_file_path ||= self.class.default_custom_scenarios_file_path
+      raise ConfigurationError, 'Missing Custom collection file path' unless self.custom_collection_file_path
 
       self.last_scenario_file_path ||= self.class.default_last_scenario_file_path
-      raise Error, 'Missing Last scenario file path' unless self.last_scenario_file_path
-
+      raise ConfigurationError, 'Missing Last scenario file path' unless self.last_scenario_file_path
+    rescue ConfigurationError => e
+      prompt.warn e
+      if prompt.yes?('Configure?')
+        self.class.configure
+        retry
+      end
     end
 
     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)
@@ -69,6 +112,7 @@ module NewmanScenario
             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)
             break unless scenario_requests.include?('duplicate')
+
           end
           if prompt.yes?('Save this custom scenario?')
             name = prompt.ask('Name?')
@@ -127,6 +171,7 @@ module NewmanScenario
     def prompt_to_install_newman
       prompt.warn 'missing newman command line'
       return false unless prompt.yes?('Install newman?')
+
       prompt.ok 'installing newman: brew install newman'
       cmd('brew install newman')
     end
@@ -160,7 +205,6 @@ module NewmanScenario
     end
 
     def fetch_postman_to_file(url_path, file_path)
-      puts "https://api.getpostman.com/#{url_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
 

data/lib/newman_scenario/version.rb

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

metadata

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