gems-validator 0.3.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c72c2d22879cd9c8d66a2062c5ca188b1b47c92e7ec75fa8a3cc98c895b4f12
-  data.tar.gz: ac70c06d03af86a323676b31fccac4d2046565209dfb285842299de9a23e96b2
+  metadata.gz: ab34a7d9ea4625c880476c97fd355b40d254f29ed6d9750db1f4564cd1ed8b8b
+  data.tar.gz: 53e50ad4df15efb914a787fb8307810918b112ff96986123c81b00cfbc7ce257
 SHA512:
-  metadata.gz: fbc2ae946a37031e557ac9791b87ae04fc9cec6de319cac856e4fb63da0ab80906f9f31d8c74d21f1c9bd5e708a45b7a8485bef54486d7deab82b817f1cbb61c
-  data.tar.gz: e97823d37609d686b94b37ca9ff8dadad5a59e014ef71d6281052e39df41d271166dd2f7e75fff64724664500e26cf562eb34f51ba5c01069c3f5b308a3a8ca4
+  metadata.gz: d724ced1423b2deb614f000997789efda0a2cfb7167b59e5fa74e0f22afd2826eff62e3822c7eaf61cc4b2e5ea04ffb95fd5e136b56f4b5ebcc97ffb970fc6aa
+  data.tar.gz: f8f354bfd8a7976258b878adec62ef7a4815b1ed50a5a052f52f679aae624cf66db04b89c26d374e4fcc685ccfbcdf76f23cbb96474ab3fe43eb42d5040ab7f2

data/Gemfile

@@ -6,3 +6,4 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
+gem "bundler-audit"

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    gems-validator (0.4.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bundler-audit (0.9.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    rake (13.0.6)
+    thor (1.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler-audit
+  gems-validator!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,25 @@
+# Gems validator
+
+Um plugin Bundle para validar gems homologadas nas aplicações do grupo EUAX.
+
+## 📦 **Instalação**
+
+Execute `bundle plugin install gems-validator` para adicionar o plugin ao seu bundle.
+
+## 🤷‍♂️ **Como funciona?**
+
+Após instalar o plugin ele irá rodar toda vez que `bundle install` for executado. O plugin utiliza da [API de gems homologadas](https://github.com/Artia/euax-gems)
+para validar as gems de um produto, verificando se elas podem ou não serem instaladas. Ao detectar que uma gem não pode ser instalada o processo de instalação
+é interrompido e uma mensagem de erro com o motivo da falha é apresentada no terminal.
+
+## 🤝 **Contribuindo**
+
+Todo tipo de contribuição é muito bem vinda e apreciada!
+
+-   ⭐️ Dê uma estrela ao projeto
+-   🐛 Encontre e reporte issues
+-   📥 Envie PRs e ajude a resolver issues e adição de features
+
+---
+
+Feito com ❤️ por **Henrique Schmeller**.

data/lib/gems-validator/audit-service.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module GemsValidator
+  class AuditService
+    def initialize()
+      system 'bundler-audit check --format json --output bundler-audit.json'
+      @read_file = read_parsed_file
+    end
+
+    def is_a_vulnerable_gem?(gem_name)
+      gem_vulnerabilities = @read_file["results"].select { |item| item["gem"]["name"] == gem_name }
+      generate_messages(gem_vulnerabilities)
+    end
+
+    private
+    def generate_messages(gem_vulnerabilities)
+      if (gem_vulnerabilities.empty?)
+        return Bundler.ui.confirm "[GemsValidator::Success] - A gem não apresenta nenhum vulnerabilidade!"
+      end
+
+      Bundler.ui.warn "[GemsValidator::Error] - A gem #{gem_vulnerabilities[0]["gem"]["name"]} na versao #{gem_vulnerabilities[0]["gem"]["version"]} apresenta #{gem_vulnerabilities.size} vulnerabilidade#{gem_vulnerabilities.size ? "s" : ""}"
+
+      gem_vulnerabilities.map.with_index do |vulnerability, number|
+        Bundler.ui.error "#{number+1} -> #{vulnerability["advisory"]["title"]} \n Nivel: #{vulnerability["advisory"]["criticality"]} \n URL da issue: #{vulnerability["advisory"]["url"]}"
+      end
+    end
+    
+    def read_parsed_file
+      file = File.read('bundler-audit.json')
+      parsed_file = JSON.parse(file)
+    end
+  end
+end

data/lib/gems-validator/format-error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GemsValidator
   class FormatError < Bundler::InstallError
     def initialize(gem:, message:)

data/lib/gems-validator/gems-service.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module GemsValidator
   class GemsService
     def initialize()
-      @access_token = 'eG5hJT9SZUQyYXpyLUBUX2pqJVU0eiRmVjl5RisjdUV0WmY4LTRWanZ2Rz1VVyo3VHlYXndCbms4V3dkLU1MWA=='
+      @access_token = get_token
     end
 
     # Response:
     # { 
-    #   available_gems: {
+    #   allowed_gems: {
     #     [name]: {
     #       approved_at: Date,
     #       version?: String
@@ -18,25 +20,35 @@ module GemsValidator
     #       version?: String
     #     }
     #   },
-    #   gems_pending_approval: {
+    #   pending_gems: {
     #     [name]: {
     #       requested_at: Date
     #     }
     #   }
     # }
     def get_gems()
-      response = request
-      JSON.parse(response.body)["data"]
+      JSON.parse(gems_formatted_request.body)["data"]
     end
 
     private
-    def request
+    def get_token
+      uri = URI('http://ec2-54-173-249-114.compute-1.amazonaws.com:3333/sessions/token')
+      request = Net::HTTP::Post.new(uri)
+      request.body = { username: 'developers', password: 'devs@euax' }.to_json
+      request['Content-Type'] = 'application/json'
+
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        response = http.request request
+        response.header['access_token']
+      end
+    end
+
+    def gems_formatted_request
       uri = URI('http://ec2-54-173-249-114.compute-1.amazonaws.com:3333/gems/formatted')
-      # Net::HTTP.get_response(uri, { "Authorization" => "Bearer #{@access_token}" })
       Net::HTTP.start(uri.host, uri.port) do |http|
         request = Net::HTTP::Get.new uri
-        request["Authorization"] = "Bearer #{@access_token}"
-        response = http.request request
+        request["Authorization"] = @access_token
+        http.request request
       end
     end
   end

data/lib/gems-validator/validate.rb

@@ -8,7 +8,7 @@ module GemsValidator
         begin
           is_blocked?
           is_pending?
-          is_available?
+          is_allowed?
           Bundler.ui.confirm "[GemsValidator::Success] - A gem #{@gem.name} está homologada e pode ser instalada!"
         rescue => error
           raise GemsValidator::FormatError.new(gem: @gem.name, message: error.to_s)
@@ -38,23 +38,31 @@ module GemsValidator
         end
       end
 
-      def is_available?
-        if gems_from_service["available_gems"].keys.include?(@gem.name)
-          is_version_available?
+      def is_allowed?
+        if gems_from_service["allowed_gems"].keys.include?(@gem.name)
+          is_version_allowed?
+          is_deprecated?
         else
           raise "Essa gem não foi homologada."
         end
       end
 
-      def is_version_available?
-        if gems_from_service["available_gems"][@gem.name]["version"]
-          required_version = gems_from_service["available_gems"][@gem.name]["version"]
+      def is_version_allowed?
+        if gems_from_service["allowed_gems"][@gem.name]["version"]
+          required_version = gems_from_service["allowed_gems"][@gem.name]["version"]
           if @gem.version.to_s != required_version
             raise "Essa gem só pode ser instalada na versão #{@gem.version.to_s}."
           end
         end
       end
 
+      def is_deprecated?
+        if gems_from_service["allowed_gems"][@gem.name]["deprecated"]
+          message = gems_from_service["allowed_gems"][@gem.name]["deprecated_message"]
+          Bundler.ui.warn "[GemsValidator::Warn] - A gem #{@gem.name} está depreciada. Motivo: #{message}"
+        end
+      end
+
       def gems_service
         @gems_service ||= GemsValidator::GemsService.new()
       end

data/lib/gems-validator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GemsValidator
-  VERSION = "0.3.2"
+  VERSION = "0.4.3"
 end

data/lib/gems-validator.rb

@@ -4,10 +4,11 @@ require 'net/http'
 require 'uri'
 require 'json'
 
-require_relative "gems-validator/version"
-require_relative "gems-validator/validate"
+require_relative "gems-validator/audit-service"
 require_relative "gems-validator/format-error"
 require_relative "gems-validator/gems-service"
+require_relative "gems-validator/validate"
+require_relative "gems-validator/version"
 
 module GemsValidator
   class << self
@@ -15,8 +16,11 @@ module GemsValidator
       return if defined?(@registered) && @registered
       @registered = true
 
-      Bundler::Plugin.add_hook('before-install') do |dependencie|
-        GemsValidator::Validate.exec(dependencie)
+      GemsValidator::AuditService.new
+
+      Bundler::Plugin.add_hook('before-install') do |gem|
+        GemsValidator::Validate.exec(gem)
+        GemsValidator::AuditService.is_a_vulnerable_gem(gem.name)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gems-validator
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.3
 platform: ruby
 authors:
 - henriquesml
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-16 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies: []
 description: gems-validator
 email:
@@ -20,10 +20,13 @@ files:
 - ".rspec"
 - Dockerfile
 - Gemfile
+- Gemfile.lock
 - Makefile
+- README.md
 - Rakefile
 - docker-compose.yml
 - lib/gems-validator.rb
+- lib/gems-validator/audit-service.rb
 - lib/gems-validator/format-error.rb
 - lib/gems-validator/gems-service.rb
 - lib/gems-validator/validate.rb