gems-validator 0.3.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 963c07b560c167148a1ea40005134e2299031b7f867fa82314b5e7b731d4784d
-  data.tar.gz: d75025329ec6d7a266605846c9c5e5eb12c9cbeedb760e281659e2e1d417bcfb
+  metadata.gz: a76e6d3822ec786140734de928eaab7dca72945489b882590efcffc81047c4cd
+  data.tar.gz: 210e2e460dcd583a7cae39bf8ce83d9a5589ee1919351838c451ac32bb01df52
 SHA512:
-  metadata.gz: 5f5a925721158a2e18a9eaf52146a0f45f6642033f7ae527b0b574835b05e5bef29abbd7a717a0f9550d2bcf6e7b4a2cb064968e59ec9daa94d1ae15aa0133e3
-  data.tar.gz: 68f91481131422d5693913d370916b505ad38f903541e968af1e909a4aa978ab805a29178ccd3ed691ef387b83fc4ac3e88f81520a1cb06e46b4253493d34303
+  metadata.gz: 875c78fe6ea29105c351cd8403fe381dbe01e0b72bf07f53192c93f060e3be94c80702e45bd798fc5ff87881e20d714b9897ed702bceaf256856bcfff2561d04
+  data.tar.gz: 4adcc359c08e4356d94cd1c9051e9fccbd76b5015dd1f24262438fdba829df7caa5e05dcd90685240258b1df52726bca172485903a9b67d6a542c46647ae2f90

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.1)
+
+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 > 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,7 +1,9 @@
+# frozen_string_literal: true
+
 module GemsValidator
   class FormatError < Bundler::InstallError
     def initialize(gem:, message:)
-      super("[Gems Validator] - Não foi possível instalar a gem #{gem}. Motivo: #{message}")
+      super("[GemsValidator::Error] - Não foi possível instalar a gem #{gem}. Motivo: #{message}")
     end
   end
 end

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,8 +8,8 @@ module GemsValidator
         begin
           is_blocked?
           is_pending?
-          is_available?
-          Bundler.ui.confirm "[Gems Validator] - A gem #{@gem.name} foi instalada com sucesso!"
+          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)
         end
@@ -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.1"
+  VERSION = "0.4.2"
 end

data/lib/gems-validator.rb

@@ -15,8 +15,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.1
+  version: 0.4.2
 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
@@ -47,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: gems-validator