emasser 3.4.1 → 3.12.0

data/emasser.gemspec

@@ -1,44 +1,44 @@
-# frozen_string_literal: true
-
-require_relative 'lib/emasser/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'emasser'
-  spec.version = Emasser::VERSION
-  spec.authors = ['Amndeep Singh Mann', 'George Dias', 'Kyle Fagan', 'Robert Clark', 'Aaron Lippold']
-  spec.email = ['saf@groups.mitre.org']
-  spec.licenses = ['Apache-2.0']
-
-  spec.summary = 'Provide an automated capability for invoving eMASS API endpoints'
-  spec.description = 'The emasser can be used as a gem or used from the command line (CL) to access eMASS endpoints via their API.'
-  spec.homepage = 'https://saf.mitre.org'
-  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
-
-  # 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(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(emass_client|test|spec|features)/}) }
-  end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  # References: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry
-  spec.metadata = { "github_repo" => "ssh://github.com/mitre/emasser" }
-
-  spec.add_runtime_dependency 'activesupport', '~> 6.1.4'
-  spec.add_runtime_dependency 'colorize', '~> 0.8.1'
-  spec.add_runtime_dependency 'dotenv', '~> 2.7.6'
-  spec.add_runtime_dependency 'rubyzip', '~> 2.3.2'
-  spec.add_runtime_dependency 'thor', '~> 1.1.0'
-  spec.add_runtime_dependency 'emass_client', '~> 3.0'
-
-  spec.add_development_dependency 'bundler', '~> 2.3'
-  spec.add_development_dependency 'bundler-audit', '~> 0.7'
-  spec.add_development_dependency 'byebug', '~> 11.1.3'
-  spec.add_development_dependency 'rspec', '~> 3.10.0'
-  spec.add_development_dependency 'yaml', '~> 0.2.0'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rubocop', '~> 1.7'
-  spec.add_development_dependency 'rubocop-minitest', '~> 0.10'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.11'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.5'
-end
+# frozen_string_literal: true
+
+require_relative 'lib/emasser/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'emasser'
+  spec.version = Emasser::VERSION
+  spec.authors = ['Amndeep Singh Mann', 'George Dias', 'Kyle Fagan', 'Robert Clark', 'Aaron Lippold']
+  spec.email = ['saf@groups.mitre.org']
+  spec.licenses = ['Apache-2.0']
+
+  spec.summary = 'Provide an automated capability for invoving eMASS API endpoints'
+  spec.description = 'The emasser can be used as a gem or used from the command line (CL) to access eMASS endpoints via their API.'
+  spec.homepage = 'https://saf.mitre.org'
+  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(emass_client|test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  # References: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry
+  spec.metadata = { "github_repo" => "ssh://github.com/mitre/emasser" }
+
+  spec.add_runtime_dependency 'activesupport', '>= 6.1.4', '< 7.1.0'
+  spec.add_runtime_dependency 'colorize', '~> 0.8.1'
+  spec.add_runtime_dependency 'dotenv', '~> 2.7.6'
+  spec.add_runtime_dependency 'rubyzip', '~> 2.3.2'
+  spec.add_runtime_dependency 'thor', '~> 1.1.0'
+  spec.add_runtime_dependency 'emass_client', '~> 3.12'
+
+  spec.add_development_dependency 'bundler', '~> 2.3'
+  spec.add_development_dependency 'bundler-audit', '~> 0.7'
+  spec.add_development_dependency 'byebug', '~> 11.1.3'
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
+  spec.add_development_dependency 'yaml', '~> 0.2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.7'
+  spec.add_development_dependency 'rubocop-minitest', '~> 0.10'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.11'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.5'
+end

data/exe/emasser

@@ -1,5 +1,5 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'dotenv/load'
-require 'emasser'
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'dotenv/load'
+require 'emasser'

data/lib/emasser/cli.rb

@@ -1,37 +1,37 @@
-# frozen_string_literal: true
-
-module Emasser
-  class CLI < Thor
-    package_name 'Emasser'
-
-    if ARGV[0].to_s.include? 'get'
-      require 'emasser/get'
-      register(Emasser::Get, 'get', 'get [RESOURCE]', 'Gets a resource')
-    elsif ARGV[0].to_s.include? 'post'
-      require 'emasser/post'
-      register(Emasser::Post, 'post', 'post [RESOURCE]', 'Posts resources')
-    elsif ARGV[0].to_s.include? 'put'
-      require 'emasser/put'
-      register(Emasser::Put, 'put', 'put [RESOURCE]', 'Puts resources')
-    elsif ARGV[0].to_s.include? 'del'
-      require 'emasser/delete'
-      register(Emasser::Delete, 'delete', 'delete [RESOURCE]', 'Deletes resources')
-    elsif (ARGV[0].to_s.include? '-v') || (ARGV[0].to_s.include? '-V')
-      puts "emasser version: #{Emasser::VERSION}".green
-      exit
-    elsif ARGV[0].to_s.include? 'hello'
-      user_name = ENV.fetch('USERNAME', 'rookie')
-      puts "Hello #{user_name} - enjoy using emasser version #{Emasser::VERSION}!".cyan
-      exit
-    end
-
-    def help
-      puts 'Emasser commands:'.yellow
-      puts '  emasser [get, put, post, delete, -v, or -V]'.yellow
-    end
-
-    def self.exit_on_failure?
-      true
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Emasser
+  class CLI < Thor
+    package_name 'Emasser'
+
+    if ARGV[0].to_s.include? 'get'
+      require 'emasser/get'
+      register(Emasser::Get, 'get', 'get [RESOURCE]', 'Gets a resource')
+    elsif ARGV[0].to_s.include? 'post'
+      require 'emasser/post'
+      register(Emasser::Post, 'post', 'post [RESOURCE]', 'Posts resources')
+    elsif ARGV[0].to_s.include? 'put'
+      require 'emasser/put'
+      register(Emasser::Put, 'put', 'put [RESOURCE]', 'Puts resources')
+    elsif ARGV[0].to_s.include? 'del'
+      require 'emasser/delete'
+      register(Emasser::Delete, 'delete', 'delete [RESOURCE]', 'Deletes resources')
+    elsif (ARGV[0].to_s.include? '-v') || (ARGV[0].to_s.include? '-V')
+      puts "emasser version: #{Emasser::VERSION}".green
+      exit
+    elsif ARGV[0].to_s.include? 'hello'
+      user_name = ENV.fetch('USERNAME', 'rookie')
+      puts "Hello #{user_name} - enjoy using emasser version #{Emasser::VERSION}!".cyan
+      exit
+    end
+
+    def help
+      puts 'Emasser commands:'.yellow
+      puts '  emasser [get, put, post, delete, -v, or -V]'.yellow
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+  end
+end

data/lib/emasser/configuration.rb

@@ -1,49 +1,49 @@
-# frozen_string_literal: true
-
-module Emasser
-  require 'emasser/errors'
-
-  class Configuration
-    # rubocop: disable Style/RaiseArgs
-    def self.raise_unless_present(env)
-      ENV.fetch(env) { raise Emasser::ConfigurationMissingError.new(env) }
-    rescue Emasser::ConfigurationMissingError => e
-      if (ARGV[0].to_s.include? '-v') || (ARGV[0].to_s.include? '-V')
-        puts "emasser version: #{Emasser::VERSION}".green
-      else
-        puts "\n", e.message.red
-        puts 'Create a .env file containing required variables, place it in the root directory where the emasser command is executed'.yellow
-        puts 'Required environment variables are:'.yellow
-        puts '  export EMASSER_API_KEY_API_KEY=<API key>'.green
-        puts '  export EMASSER_API_KEY_USER_UID=<unique identifier of the eMASS user EMASSER_API_KEY_API_KEY belongs to>'.green
-        puts '  export EMASSER_HOST=<FQDN of the eMASS server>'.green
-        puts '  export EMASSER_KEY_FILE_PATH=<path to your emass key in PEM format>'.green
-        puts '  export EMASSER_CERT_FILE_PATH=<path to your emass certficate in PEM format>'.green
-        puts '  export EMASSER_KEY_PASSWORD=<password for the key given in EMASSER_KEY_FILE_PATH>'.green, "\n"
-        puts 'See emasser environment variables requirements in emasser CLI Features for more information (https://mitre.github.io/emasser/docs/features.html).', "\n"
-      end
-      exit
-    end
-    # rubocop: enable Style/RaiseArgs
-
-    # rubocop: disable Style/TernaryParentheses, Style/IfWithBooleanLiteralBranches
-    EmassClient.configure do |config|
-      # Required env variables
-      config.api_key['api-key'] = raise_unless_present('EMASSER_API_KEY_API_KEY')
-      config.api_key['user-uid'] = raise_unless_present('EMASSER_API_KEY_USER_UID')
-      config.scheme = 'https'
-      config.base_path = '/'
-      config.server_index = nil
-      config.host = raise_unless_present('EMASSER_HOST')
-      config.key_file = raise_unless_present('EMASSER_KEY_FILE_PATH')
-      config.cert_file = raise_unless_present('EMASSER_CERT_FILE_PATH')
-      config.key_password = raise_unless_present('EMASSER_KEY_PASSWORD')
-      # Optional env variables
-      config.client_side_validation = (ENV.fetch('EMASSER_CLIENT_SIDE_VALIDATION', 'true').eql? 'true') ? true : false
-      config.verify_ssl = (ENV.fetch('EMASSER_VERIFY_SSL', 'true').eql? 'true') ? true : false
-      config.verify_ssl_host = (ENV.fetch('EMASSER_VERIFY_SSL_HOST', 'true').eql? 'true') ? true : false
-      config.debugging = (ENV.fetch('EMASSER_DEBUGGING', 'false') == 'false') ? false : true
-    end
-    # rubocop: enable Style/TernaryParentheses, Style/IfWithBooleanLiteralBranches
-  end
-end
+# frozen_string_literal: true
+
+module Emasser
+  require 'emasser/errors'
+
+  class Configuration
+    # rubocop: disable Style/RaiseArgs
+    def self.raise_unless_present(env)
+      ENV.fetch(env) { raise Emasser::ConfigurationMissingError.new(env) }
+    rescue Emasser::ConfigurationMissingError => e
+      if (ARGV[0].to_s.include? '-v') || (ARGV[0].to_s.include? '-V')
+        puts "eMASSer version: #{Emasser::VERSION}".green
+      else
+        puts "\n", e.message.red
+        puts 'Create a .env file containing required variables, place it in the root directory where the emasser command is executed'.yellow
+        puts 'Required environment variables are:'.yellow
+        puts '  export EMASSER_API_KEY=<API key>'.green
+        puts '  export EMASSER_USER_UID=<unique identifier of the eMASS user EMASSER_API_KEY belongs to>'.green
+        puts '  export EMASSER_HOST_URL=<FQDN of the eMASS server>'.green
+        puts '  export EMASSER_KEY_FILE_PATH=<path to your eMASS key in PEM format>'.green
+        puts '  export EMASSER_CERT_FILE_PATH=<path to your eMASS certficate in PEM format>'.green
+        puts '  export EMASSER_KEY_FILE_PASSWORD=<password for the key given in EMASSER_KEY_FILE_PATH>'.green, "\n"
+        puts 'See eMASSer environment variables requirements in eMASSer CLI Features for more information (https://mitre.github.io/emasser/docs/features.html).', "\n"
+      end
+      exit
+    end
+    # rubocop: enable Style/RaiseArgs
+
+    # rubocop: disable Style/TernaryParentheses, Style/IfWithBooleanLiteralBranches
+    EmassClient.configure do |config|
+      # Required env variables
+      config.api_key['api-key'] = raise_unless_present('EMASSER_API_KEY')
+      config.api_key['user-uid'] = raise_unless_present('EMASSER_USER_UID')
+      config.scheme = 'https'
+      config.base_path = '/'
+      config.server_index = nil
+      config.host = raise_unless_present('EMASSER_HOST_URL')
+      config.key_file = raise_unless_present('EMASSER_KEY_FILE_PATH')
+      config.cert_file = raise_unless_present('EMASSER_CERT_FILE_PATH')
+      config.key_password = raise_unless_present('EMASSER_KEY_FILE_PASSWORD')
+      # Optional env variables
+      config.client_side_validation = (ENV.fetch('EMASSER_CLIENT_SIDE_VALIDATION', 'true').eql? 'true') ? true : false
+      config.verify_ssl = (ENV.fetch('EMASSER_VERIFY_SSL', 'true').eql? 'true') ? true : false
+      config.verify_ssl_host = (ENV.fetch('EMASSER_VERIFY_SSL_HOST', 'true').eql? 'true') ? true : false
+      config.debugging = (ENV.fetch('EMASSER_DEBUGGING', 'false') == 'false') ? false : true
+    end
+    # rubocop: enable Style/TernaryParentheses, Style/IfWithBooleanLiteralBranches
+  end
+end

data/lib/emasser/constants.rb

@@ -1,26 +1,22 @@
-# frozen_string_literal: true
-
-module Emasser
-  GET_SYSTEM_ID_QUERY_PARAMS = {
-    include_package: false,
-    include_ditpr_metrics: false,
-    include_decommissioned: false,
-    debug_return_type: 'SystemResponse' # This is used by swagger client only to format output
-  }.freeze
-
-  GET_SYSTEM_RETURN_TYPE = {
-    debug_return_type: 'SystemResponse'
-  }.freeze
-
-  GET_ARTIFACTS_RETURN_TYPE = {
-    debug_return_type: 'String'
-  }.freeze
-
-  GET_WORKFLOWINSTANCES_RETURN_TYPE = {
-    debug_return_type: 'Object'
-  }.freeze
-
-  DEL_MILESTONES_RETURN_TYPE = {
-    debug_return_type: 'Object'
-  }.freeze
-end
+# frozen_string_literal: true
+
+module Emasser
+  GET_SYSTEM_ID_QUERY_PARAMS = {
+    include_package: false,
+    include_ditpr_metrics: false,
+    include_decommissioned: false,
+    debug_return_type: 'SystemResponse' # This is used by swagger client only to format output
+  }.freeze
+
+  GET_SYSTEM_RETURN_TYPE = {
+    debug_return_type: 'SystemResponse'
+  }.freeze
+
+  GET_ARTIFACTS_RETURN_TYPE = {
+    debug_return_type: 'String'
+  }.freeze
+
+  GET_WORKFLOWINSTANCES_RETURN_TYPE = {
+    debug_return_type: 'Object'
+  }.freeze
+end