train-pwsh 0.1.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c0b97bc0ab701a473da4c28af195434cfc6fc374103614bb00ea02766c7d28f
-  data.tar.gz: 86f25bad8916379f13ae5769dc0a0ee89d30b1798c679496903a3b8a874f015f
+  metadata.gz: da66dd3bfae044e714689303864eed1b206c158282c49b0023a2847edcc9466d
+  data.tar.gz: de4f87e4206d4d54bd1fd0ca908ffb5bdaed81573c92046d71d9c64ea832b85e
 SHA512:
-  metadata.gz: 1da78073262a500f458e9208d39850a778aa2b1993f8db53e2e8286bdb5850834e249124cee78b98a4be09b47cca338ad645f3b46fea2b45f8794b95e87672f1
-  data.tar.gz: e16e5aebad94903f7d7c7663eb5f41d9939029149f875fd1aa8af1fc1e2936cdd762440c47a8fe0632e362c2e69cf86f0f5f5e267d0504a2aa79ab336c12cfd0
+  metadata.gz: 6c78670c60457b39db97f0f83011c353841be259b8c2b0fdc1ab4967f878ab2aecfb5ba4707f101e180615fde9407bebfa137cdecd46be4523d72e64b135890f
+  data.tar.gz: d9cb83c1ef7f82c51d3f26b583b2496e8f57c9ede8c28006efedd4848cfc3a491a9868c5044c2ca1b652034ac4fe618ec14f3c887d73258bd8b4f56215a49faf

data/LICENSE.md

@@ -1,4 +1,4 @@
-Licensed under the apache-2.0 license, except as noted below.  
+Licensed under the Apache-2.0 license, except as noted below.  
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 

data/README.md

@@ -12,6 +12,31 @@ A train-pwsh connection has eight fields that are needed for authentication, whi
 
 These fields need to be defined in the config file stored at this directory: `~/.inspec/config.json`. Particularly, under the `credentials` key of the json file, create a `pwsh` key with the value being another dictionary. This dictionary should have a key named `pwsh-options` with the value being another dictionary. This dictionary should contain the names of the eight fields above as well as their values. Please refer to this [link](https://origin.inspec.io/docs/reference/config/) for more detailed instructions.
 
+As mentioned in the link above documentation, to run train-pwsh, a `config.json` file is needed at the following directory: `~/.inspec/config.json`. An example json file is shown below; the values will need to be populated with your actual data. 
+
+```json
+{
+    "version": "1.1",
+    "cli_options": {
+        "color": "true"
+    },
+    "credentials": {
+        "pwsh": {
+            "pwsh-options": {
+                "client_id": "INSERT CLIENT ID",
+                "tenant_id": "INSERT TENANT ID",
+                "client_secret": "INSERT CLIENT SECRET",
+                "certificate_path": "INSERT CERTIFICATE PATH",
+                "certificate_password": "INSERT CERTIFICATE PASSWORD",
+                "organization": "INSERT ORGANIZATION",
+                "sharepoint_admin_url": "INSERT SHAREPOINT ADMIN URL",
+                "pwsh_path": "INSERT POWERSHELL PATH"
+            }
+        }
+    }
+}
+```
+
 On top of this, environment variables may need to be defined for some of these eight fields if they are to be used elsewhere in the profile as inputs. The README for the profile will specify which ones need to be stored as environment variables. 
 
 To set an environment variable on Mac, go to the `zschrc` file located at `~/.zschrc` and enter in the following syntax: `export VARIABLE_NAME='insert_value'`

data/Rakefile

@@ -1,4 +1,13 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require 'github_changelog_generator/task'
+
 task default: %i[]
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = 'skandwal'
+  config.project = 'train-pwsh'
+  config.since_tag = '1.0.7'
+  config.future_release = '2.0.0'
+end

data/lib/train-pwsh/version.rb

@@ -2,6 +2,6 @@
 
 module Train
   module Pwsh
-    VERSION = "0.1.6"
+    VERSION = "1.0.7"
   end
 end

data/train-pwsh.gemspec

@@ -8,17 +8,15 @@ Gem::Specification.new do |spec|
   spec.authors = ["Sujay Kandwal"]
   spec.email = ["skandwal@mitre.org"]
   spec.files = Dir['lib/**/*.rb'] + Dir['bin/*']+ ["README.md", "LICENSE.md", "NOTICE.md", "CHANGELOG.md", "CODE_OF_CONDUCT.md"]
-  spec.summary = "Enabling continuous Powershell connection over Inspec"
-  #spec.description = "TODO: Write a longer description or delete this line."
-  #spec.homepage = "TODO: Put your gem's website or public repo URL here."
-  spec.license = "MIT"
+  spec.summary = "Enabling continuous Powershell connection over Inspec."
+  spec.description = "Enabling continuous Powershell connection over Inspec."
+  spec.homepage = "https://rubygems.org/gems/train-pwsh"
+  spec.license = "Apache-2.0"
   spec.required_ruby_version = ">= 2.6.0"
 
-  #spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  #spec.metadata["homepage_uri"] = spec.homepage
-  #spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/mitre/train-pwsh/"
+  spec.metadata["changelog_uri"] = spec.metadata['source_code_uri'] + "blob/main/CHANGELOG.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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-pwsh
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Sujay Kandwal
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-03 00:00:00.000000000 Z
+date: 2025-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: train
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: Enabling continuous Powershell connection over Inspec.
 email:
 - skandwal@mitre.org
 executables: []
@@ -59,10 +59,13 @@ files:
 - lib/train-pwsh/version.rb
 - sig/train/pwsh.rbs
 - train-pwsh.gemspec
-homepage:
+homepage: https://rubygems.org/gems/train-pwsh
 licenses:
-- MIT
-metadata: {}
+- Apache-2.0
+metadata:
+  homepage_uri: https://rubygems.org/gems/train-pwsh
+  source_code_uri: https://github.com/mitre/train-pwsh/
+  changelog_uri: https://github.com/mitre/train-pwsh/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -81,5 +84,5 @@ requirements: []
 rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
-summary: Enabling continuous Powershell connection over Inspec
+summary: Enabling continuous Powershell connection over Inspec.
 test_files: []