paraxial 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3849213ba15a24d63699e026fbf59c0c3633d66c2f9c3a20a787ecbb43d6a727
-  data.tar.gz: ea7d9cf3fcd4909b51c98c0922b83e834c7d04a5df204cfc64e44b2701e0eb09
+  metadata.gz: 8fc606825a60ae6e756bf7fda0fb6d3434e88075e8afe0ba1be0ab64c62304af
+  data.tar.gz: 5e4daf86eb7f58a60abe6e3f3497381c9e4e4c70a289a230ec25a72a1427e7ad
 SHA512:
-  metadata.gz: 860660578753aa78749fbadedcf1fc5789bc41ad1d89d1afbf17b60c10dfc6ddc8f6900a082d99b4e915db65e3e99c9c36ee490c05e49853dd681071865546a7
-  data.tar.gz: fb5bfb5f315482914d0fad182489180558be34975f8e1224ce07f906b29ca59c7642d153505b0ec6cb5903e8c7b24e492ca301e91a2015c64b0379ae93d01e8d
+  metadata.gz: a8e809b4362e4182f23c1a997fb20dd3c05ec6dea16ae6e41d6f6b276a82334543abb223f5634bb5560dcc725059d7306f50a153ea373368f8be9cdab18eb521
+  data.tar.gz: 1228d5f5ada089b496fe408fb6f4725733966adeb700948947195942ef7a13da8adda0c39e32575ac1d08632f594d72ac6fe374f6d88cca7a3cfd8d6338cb6d1

data/lib/paraxial/cli.rb

@@ -20,13 +20,23 @@ module Paraxial
 
     def scan
       puts "[Paraxial] v#{Paraxial::VERSION} Scan starting..."
-      if check_rubocop_configuration
-        puts '[Paraxial] .rubocop.yml is valid.'
-      else
-        puts '[Paraxial] .rubocop.yml is missing rubocop-erb. To scan embedded Ruby files for security problems, add:'
-        puts '.rubocop.yml'
+
+      case check_rubocop_configuration
+      when :does_not_exist
+        puts '[Paraxial] .paraxial-rubocop.yml does not exist. This file is required for the scan to run, add:'
+        puts '.paraxial-rubocop.yml'
         puts 'require:'
         puts '- rubocop-erb'
+        puts ''
+        exit(1)
+      when :found_no_erb
+        puts '[Paraxial] .paraxial-rubocop.yml is missing rubocop-erb. To scan embedded Ruby files for security problems, add:'
+        puts '.paraxial-rubocop.yml'
+        puts 'require:'
+        puts '- rubocop-erb'
+        puts ''
+      when :found_with_erb
+        puts '[Paraxial] .paraxial-rubocop.yml is valid, .erb files will be scanned.'
       end
 
       if Paraxial::Helpers.get_api_key.nil?
@@ -40,13 +50,14 @@ module Paraxial
         exit_code = options[:exit_code]
 
         cops = 'Paraxial,Security/Eval,Security/IoMethods,Security/JSONLoad,Security/MarshalLoad,Security/Open,Security/YAMLLoad'
+        rubo_config = '--config .paraxial-rubocop.yml'
         if options[:debug_rubocop]
           puts '[Paraxial] rubocop debug enabled'
-          rubocop = `rubocop --require paraxial --only #{cops} --disable-pending-cops --format json 2>/dev/null`
-          debug_rubocop = `rubocop -d --require paraxial --only #{cops} --disable-pending-cops 2>&1`
+          rubocop = `rubocop --require paraxial --only #{cops} --disable-pending-cops --format json #{rubo_config} 2>/dev/null`
+          debug_rubocop = `rubocop --debug --require paraxial --only #{cops} --disable-pending-cops #{rubo_config} 2>&1`
           puts debug_rubocop
         else
-          rubocop = `rubocop --require paraxial --only #{cops} --disable-pending-cops --format json`
+          rubocop = `rubocop --require paraxial --only #{cops} --disable-pending-cops --format json #{rubo_config}`
         end
         lockfile = File.read('./Gemfile.lock')
         api_key = ENV['PARAXIAL_API_KEY']
@@ -56,6 +67,12 @@ module Paraxial
         body = { rubocop: rubocop, lockfile: lockfile, api_key: api_key, timestamp: Paraxial.get_timestamp }
         response = Net::HTTP.post(uri, body.to_json, headers)
         m = JSON.parse(response.body)
+
+        if m['ok'].nil?
+          puts "[Paraxial] Upload failed, check if PARAXIAL_API_KEY is valid"
+          exit(1)
+        end
+
         findings = m['ok']['findings']
         puts
         puts "[Paraxial] Scan count: #{findings.length}"
@@ -114,17 +131,20 @@ module Paraxial
     private
 
     def check_rubocop_configuration
-      rubocop_file = File.join(Dir.pwd, '.rubocop.yml')
+      # return values:
+      # :does_not_exist, :found_no_erb, :found_with_erb
+
+      rubocop_file = File.join(Dir.pwd, '.paraxial-rubocop.yml')
 
-      return false unless File.exist?(rubocop_file)
+      return :does_not_exist unless File.exist?(rubocop_file)
 
       config = YAML.load_file(rubocop_file)
       required_key = 'require'
 
-      if config.is_a?(Hash) && config[required_key].is_a?(Array)
-        config[required_key].include?('rubocop-erb')
+      if config.is_a?(Hash) && config[required_key].is_a?(Array) && config[required_key].include?('rubocop-erb')
+        :found_with_erb
       else
-        false
+        :found_no_erb
       end
     end
   end

data/lib/paraxial/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paraxial
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paraxial
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Michael Lubas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-16 00:00:00.000000000 Z
+date: 2024-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Paraxial.io Ruby Agent