API v3.10 specification updates (#46)

.env-example

@@ -1,9 +1,9 @@
-export EMASSER_API_KEY_API_KEY=<API key>
-export EMASSER_API_KEY_USER_UID=<unique identifier of the eMASS user EMASSER_API_KEY_API_KEY belongs to>
-export EMASSER_HOST=<FQDN of the eMASS server>
+export EMASSER_API_KEY=<API key>
+export EMASSER_USER_UID=<unique identifier of the eMASS user EMASSER_API_KEY belongs to>
+export EMASSER_HOST_URL=<FQDN of the eMASS server>
 export EMASSER_KEY_FILE_PATH=<path to your emass key in PEM format>
 export EMASSER_CERT_FILE_PATH=<path to your emass certificate in PEM format>
-export EMASSER_KEY_PASSWORD=<password for the key given in EMASSER_KEY_FILE_PATH>
+export EMASSER_KEY_FILE_PASSWORD=<password for the key given in EMASSER_KEY_FILE_PATH>
 export EMASSER_CLIENT_SIDE_VALIDATION=<client side validation - true or false>
 export EMASSER_VERIFY_SSL=<verify SSL - true or false>
 export EMASSER_VERIFY_SSL_HOST=<verify host SSL - true or false>

.github/workflows/codeql-analysis.yml

@@ -38,7 +38,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/push-to-docker-mail.yml

@@ -17,7 +17,7 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
       - name: Checkout the emasser Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Build and push
         id: docker_build
         uses: docker/build-push-action@v2

.github/workflows/push-to-docker.yml

@@ -24,7 +24,7 @@ jobs:
           replace-with: ''
           flags: 'g'
       - name: Checkout the emasser Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Build and push
         id: docker_build
         uses: docker/build-push-action@v2

.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
     steps:
       - name: Setup ruby
         uses: actions/setup-ruby@v1
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - run: git fetch origin +refs/tags/*:refs/tags/*

.github/workflows/rubocop.yml

@@ -9,7 +9,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - run: git fetch origin +refs/tags/*:refs/tags/*

.github/workflows/test-cli.yml

@@ -1,36 +1,3 @@
-# name: Test emasser CLI
-
-# on:
-#   push:
-#     branches: [ main ]
-#   pull_request:
-#     branches: [ main ]
-
-# jobs:
-#   test:
-#     strategy:
-#       fail-fast: false
-#       matrix:
-#        platform: [ ubuntu-latest, macos-latest, windows-latest ]
-#        ruby-version: ['2.6', '2.7']
-#     runs-on: ${{ matrix.platform }}
-#     steps:
-#       - name: Setup Ruby ${{matrix.ruby}}
-#         uses: ruby/setup-ruby@v1
-#         with:
-#           ruby-version: ${{ matrix.ruby-version }}
-#       - uses: actions/checkout@v2
-#       - name: Testing on ${{ matrix.platform }} for Ruby ${{ matrix.ruby }}
-#         if: matrix.platform == 'windows-latest'
-#         run: |
-#           echo "need to install libcurl.dll"
-#       - name: Testing on ${{ matrix.platform }} for Ruby ${{ matrix.ruby }}
-#         if: matrix.platform == 'ubuntu-latest' || matrix.platform == 'macos-latest'
-#         run: |
-#           bundle install
-#           bundle info swagger_client
-#           rspec spec --format documentation
-
 name: Test emasser CLI
 
 on:
@@ -52,7 +19,7 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: crazy-max/ghaction-chocolatey@v1
         with:
           args: install curl -y

.rubocop.yml

@@ -15,6 +15,7 @@ AllCops:
     - Rakefile
     - 'test/**/*'
     - '*.gemspec'
+    - '.env'
 
 #Cops in Metrics might need to be adjusted to past their defaults depending on how restrictive the requirements feel
 Style/Documentation:
@@ -78,3 +79,5 @@ Style/FrozenStringLiteralComment:
   Enabled: false
 Style/SignalException:
   Enabled: false
+Layout/EndOfLine:
+  EnforcedStyle: lf

Gemfile.lock

@@ -1,23 +1,22 @@
 PATH
   remote: .
   specs:
-    emasser (3.4.0)
+    emasser (3.4.1)
       activesupport (>= 6.1.4, < 7.1.0)
       colorize (~> 0.8.1)
       dotenv (~> 2.7.6)
-      emass_client (~> 3.0)
+      emass_client (~> 3.10)
       rubyzip (~> 2.3.2)
       thor (~> 1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.7.3)
+    activesupport (7.0.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
     bundler-audit (0.9.1)
       bundler (>= 1.2.0, < 3)
@@ -27,21 +26,24 @@ GEM
     concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
     dotenv (2.7.6)
-    emass_client (3.4.1)
+    emass_client (3.10.1)
       typhoeus (~> 1.0, >= 1.0.1)
     ethon (0.16.0)
       ffi (>= 1.15.0)
     ffi (1.15.5)
     ffi (1.15.5-x64-mingw32)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    minitest (5.15.0)
-    parallel (1.22.1)
-    parser (3.2.1.1)
+    json (2.6.3)
+    minitest (5.18.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.5.0)
+    regexp_parser (2.8.1)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -56,34 +58,34 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
-    rubocop (1.28.2)
+    rubocop (1.52.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
-      parser (>= 3.1.1.0)
-    rubocop-minitest (0.19.1)
-      rubocop (>= 0.90, < 2.0)
-    rubocop-performance (1.13.3)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-minitest (0.31.0)
+      rubocop (>= 1.39, < 2.0)
+    rubocop-performance (1.18.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    ruby-progressbar (1.11.0)
+    ruby-progressbar (1.13.0)
     rubyzip (2.3.2)
     thor (1.1.0)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
-    yaml (0.2.0)
-    zeitwerk (2.6.7)
+    yaml (0.2.1)
 
 PLATFORMS
   x64-mingw32
@@ -103,4 +105,4 @@ DEPENDENCIES
   yaml (~> 0.2.0)
 
 BUNDLED WITH
-   2.3.5
+   2.3.22