diffend 0.2.27 → 0.2.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6539b727e33d38eb0b3fb6f38f25c3fd2abda05f337f50af2db1fe135575510
-  data.tar.gz: c6808082290c195a846117fd4c16a4fa4cb20f65cc289cbadbd71532f8ae5713
+  metadata.gz: 8e0efaea5a8bb4c724e24057821578b6c257a5eb313c472ac17dd60747fe10e4
+  data.tar.gz: af3b702fa128eabcc8f6f054895c0e64097f38672b650697e292ab705b749b69
 SHA512:
-  metadata.gz: 9eb4e7749b9a9a0824770921d150e180ed5b40ba19a7f22d1f65154474347110221dc96049c2b4b5d7136c850c5775c07bc4e840b005dda13043742ac74238d2
-  data.tar.gz: 427d6b00c913174e535de300020f8fe715bda9b3f946f1fbe25906dfa734bb4dd3c349735470fbacb9740c287dd5252bcf6b481e40120daba3138afda6f334e9
+  metadata.gz: 00e60e3f610e03cad43a65b11c1b7f17d839d4b43009dde4436b9eebd96b82bdbf0035860eb85fb0e57c7042221403894a1aaf5f89cb606a86dd15e94f65bc58
+  data.tar.gz: f45b310e0e376b50e27b7a1876f3704a3f282dbadac5c868b4548a4a6a2d582632aeb3f204e47fda5545f47807446e648b0bf2fe70b4a0abdefb17ea40cf1ff1

data/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 ## [Unreleased][master]
 
+## [0.2.32] (2020-10-02)
+- fix how we build platform from `Gem::Platform` ([#56](https://github.com/diffend-io/diffend-ruby/pull/56))
+- introduce `Diffend::LatestVersion` ([#57](https://github.com/diffend-io/diffend-ruby/pull/57))
+- refactor `Diffend::Config` ([#58](https://github.com/diffend-io/diffend-ruby/pull/58))
+- set command in `Diffend::Config` ([#59](https://github.com/diffend-io/diffend-ruby/pull/59))
+- introduce `Diffend::Logger` ([#60](https://github.com/diffend-io/diffend-ruby/pull/60))
+- set severity to `FATAL` in `Diffend::Monitor` ([#61](https://github.com/diffend-io/diffend-ruby/pull/61))
+- handle `Bundler::VersionConflict` ([#62](https://github.com/diffend-io/diffend-ruby/pull/62))
+
+## [0.2.31] (2020-09-24)
+- change request timeout to 15 seconds ([#53](https://github.com/diffend-io/diffend-ruby/pull/53))
+- report request issues as warnings ([#54](https://github.com/diffend-io/diffend-ruby/pull/54))
+
+## [0.2.30] (2020-09-21)
+- handle dependencies resolve issues ([#51](https://github.com/diffend-io/diffend-ruby/pull/51))
+- better detection when to start `Diffend::Monitor` ([#50](https://github.com/diffend-io/diffend-ruby/pull/50))
+- cleanup structure ([#47](https://github.com/diffend-io/diffend-ruby/pull/47))
+
+## [0.2.29] (2020-09-21)
+- fix command reporting on jruby ([#48](https://github.com/diffend-io/diffend-ruby/pull/48))
+
+## [0.2.28] (2020-09-19)
+- start `Diffend::Monitor` only if not in development or test ([#44](https://github.com/diffend-io/diffend-ruby/pull/44))
+- better host command expose ([#45](https://github.com/diffend-io/diffend-ruby/pull/45))
+
 ## [0.2.27] (2020-09-16)
 - introduce `Diffend::RequestObject` ([#40](https://github.com/diffend-io/diffend-ruby/pull/40))
 - clean up error codes and introduce `DIFFEND_INGORE_EXCEPTIONS` ([#41](https://github.com/diffend-io/diffend-ruby/pull/41))
@@ -60,7 +85,10 @@
 
 - initial release
 
-[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.27...HEAD
+[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.30...HEAD
+[0.2.30]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.29...v0.2.30
+[0.2.29]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.28...v0.2.29
+[0.2.28]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.27...v0.2.28
 [0.2.27]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.26...v0.2.27
 [0.2.26]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.25...v0.2.26
 [0.2.25]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.24...v0.2.25

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    diffend (0.2.27)
+    diffend (0.2.32)
 
 GEM
   remote: https://rubygems.org/

data/diffend.gemspec

@@ -2,7 +2,7 @@
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'diffend'
+require 'diffend/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'diffend'
@@ -11,8 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['contact@diffend.io']
 
   spec.summary       = 'OSS supply chain security and management platform'
-  spec.summary       = 'OSS supply chain security and management platform.'
-  spec.homepage      = Diffend::HOMEPAGE
+  spec.homepage      = 'https://diffend.io'
   spec.license       = 'Prosperity Public License'
 
   if $PROGRAM_NAME.end_with?('gem')

data/lib/diffend.rb

@@ -1,142 +1,4 @@
 # frozen_string_literal: true
 
-%w[
-  bundler
-].each(&method(:require))
-
-%w[
-  build_bundler_definition
-  errors
-  config/fetcher
-  config/file_finder
-  config/validator
-  commands
-  handle_errors/messages
-  handle_errors/build_exception_payload
-  handle_errors/display_to_stdout
-  handle_errors/report
-  request_object
-  request
-  voting
-  track
-].each { |file| require "diffend/#{file}" }
-
-%w[
-  versions/local
-  versions/remote
-].each { |file| require "diffend/voting/#{file}" }
-
-# Diffend main namespace
 module Diffend
-  # Current plugin version
-  VERSION = '0.2.27'
-  # Diffend homepage
-  HOMEPAGE = 'https://diffend.io'
-
-  class << self
-    # Registers the plugin and add before install all hook
-    def register
-      Bundler::Plugin.add_hook('before-install-all') do |_|
-        execute
-      end
-    end
-
-    # Execute diffend plugin
-    def execute
-      return unless enabled?
-
-      verify_version
-
-      config = fetch_config
-
-      Diffend::Voting.call(
-        command,
-        config,
-        Diffend::BuildBundlerDefinition.call(
-          command,
-          Bundler.default_gemfile,
-          Bundler.default_lockfile
-        )
-      )
-    rescue Diffend::Errors::HandledException
-      return if ENV['DIFFEND_IGNORE_ERRORS'] == 'true'
-
-      exit 255
-    rescue StandardError => e
-      Diffend::HandleErrors::Report.call(
-        exception: e,
-        config: config,
-        message: :unhandled_exception,
-        report: true,
-        raise_exception: false
-      )
-
-      return if ENV['DIFFEND_IGNORE_ERRORS'] == 'true'
-
-      exit 255
-    end
-
-    def verify_version
-      return if ENV['DIFFEND_DEVELOPMENT'] == 'true'
-      return if installed_version == VERSION
-
-      build_outdated_version_message(installed_version)
-        .tap(&Bundler.ui.method(:error))
-
-      exit 2
-    end
-
-    # @return [String] installed plugin version
-    def installed_version
-      Bundler::Plugin
-        .index
-        .plugin_path('diffend')
-        .basename
-        .to_s
-        .split('-')
-        .last
-    end
-
-    # Checks if plugin is enabled
-    #
-    # @return [Boolean] true if enabled, false otherwise
-    def enabled?
-      Bundler
-        .default_gemfile
-        .read
-        .split("\n")
-        .reject(&:empty?)
-        .map(&:strip)
-        .select { |line| line.start_with?('plugin') }
-        .any? { |line| line.include?('diffend') }
-    end
-
-    # @param version [Hash] installed version
-    #
-    # @return [String]
-    def build_outdated_version_message(version)
-      <<~MSG
-        \nYou are running an outdated version (#{version}) of the plugin, which will lead to issues.
-        \nPlease upgrade to the latest one (#{VERSION}) by executing "rm -rf .bundle/plugin".\n
-      MSG
-    end
-
-    # Command that was run with bundle
-    #
-    # @return [String]
-    def command
-      ARGV.first || Bundler.feature_flag.default_cli_command.to_s
-    end
-
-    # Fetch diffend config file
-    #
-    # @return [OpenStruct, nil] configuration object
-    #
-    # @raise [Errors::MissingConfigurationFile] when no config file
-    def fetch_config
-      Config::Fetcher.call(
-        File.expand_path('..', Bundler.bin_path)
-      )
-    end
-  end
 end

data/lib/diffend/build_bundler_definition.rb

@@ -6,7 +6,7 @@ module Diffend
     class << self
       # Build clean instance of bundler definition, as we don't want to pollute the main one
       #
-      # @param command [String] bundler command that we are executing
+      # @param command [String] command executed via bundler
       # @param gemfile [String] path to Gemfile
       # @param lockfile [String] path to Gemfile.lock
       #

data/lib/diffend/config.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Diffend config object
+  class Config
+    attr_reader :project_id, :shareable_id, :shareable_key, :build_path, :env, :command
+
+    # Build diffend config object
+    #
+    # @return [Diffend::Config]
+    #
+    # @raise [Errors::MissingConfigurationFile] when no config file
+    def initialize(command: nil, severity: nil, build_path: nil)
+      @log_level = severity
+      build(command, build_path)
+      validate
+    end
+
+    def logger
+      @logger ||= Diffend::Logger.new(@log_level)
+    end
+
+    def ignore_errors?
+      @ignore_errors
+    end
+
+    def development?
+      @development
+    end
+
+    # Provides diffend commands endpoint url
+    #
+    # @return [String]
+    def commands_url
+      return ENV['DIFFEND_COMMANDS_URL'] if ENV.key?('DIFFEND_COMMANDS_URL')
+
+      "https://my.diffend.io/api/projects/#{project_id}/bundle/#{command}"
+    end
+
+    # Provides diffend errors endpoint url
+    #
+    # @return [String]
+    def errors_url
+      return ENV['DIFFEND_ERRORS_URL'] if ENV.key?('DIFFEND_ERRORS_URL')
+
+      "https://my.diffend.io/api/projects/#{project_id}/errors"
+    end
+
+    # @param request_id [String]
+    #
+    # @return [String]
+    def track_url(request_id)
+      "https://my.diffend.io/api/projects/#{project_id}/bundle/#{request_id}/track"
+    end
+
+    private
+
+    def build(command, build_path)
+      build_path ||= File.expand_path('..', ::Bundler.bin_path)
+      hash = Diffend::Configs::Fetcher.call(logger, build_path)
+      hash['build_path'] = build_path
+      hash['env'] = ENV['DIFFEND_ENV'] || 'development'
+      hash['ignore_errors'] = ENV['DIFFEND_IGNORE_ERRORS'] == 'true'
+      hash['development'] = ENV['DIFFEND_DEVELOPMENT'] == 'true'
+      hash['command'] = command || build_command
+
+      hash.each { |key, value| instance_variable_set(:"@#{key}", value) }
+    end
+
+    def validate
+      Diffend::Configs::Validator.call(self)
+    end
+
+    # Command that was run with bundle
+    #
+    # @return [String]
+    def build_command
+      ARGV.first || ::Bundler.feature_flag.default_cli_command.to_s
+    end
+  end
+end

data/lib/diffend/{config → configs}/fetcher.rb

@@ -4,41 +4,33 @@ require 'yaml'
 
 module Diffend
   # Module for all the components related to setting up the config
-  module Config
+  module Configs
     # Class responsible for fetching the config from .diffend.yml
     module Fetcher
-      # All the errors for missing keys in the configuration file
-      MISSING_KEY_ERRORS = [
-        Errors::ProjectIdMissingInConfigurationFile,
-        Errors::ShareableIdMissingInConfigurationFile,
-        Errors::ShareableKeyMissingInConfigurationFile,
-        Errors::BuildPathMissingInConfigurationFile
-      ].freeze
-
       class << self
+        # @param logger [Diffend::Logger]
         # @param build_path [String] path of the current build
         #
-        # @return [OpenStruct] open struct with config details
+        # @return [Hash] details from configuration file
         #
         # @example
         #   details = Fetcher.new.call('./')
         #   details.build_path #=> './'
-        def call(build_path)
+        def call(logger, build_path)
           build(build_path)
         rescue Errors::MissingConfigurationFile
-          Bundler.ui.error(build_missing_error_message(build_path))
+          build_missing_error_message(build_path)
+            .tap(&logger.method(:fatal))
 
           raise Diffend::Errors::HandledException
         rescue Errors::EmptyConfigurationFile
-          Bundler.ui.error(build_empty_error_message(build_path))
+          build_empty_error_message(build_path)
+            .tap(&logger.method(:fatal))
 
           raise Diffend::Errors::HandledException
         rescue Errors::MalformedConfigurationFile
-          Bundler.ui.error(build_malformed_error_message(build_path))
-
-          raise Diffend::Errors::HandledException
-        rescue *MISSING_KEY_ERRORS => e
-          Bundler.ui.error(build_missing_key_error_message(e))
+          build_malformed_error_message(build_path)
+            .tap(&logger.method(:fatal))
 
           raise Diffend::Errors::HandledException
         end
@@ -57,8 +49,7 @@ module Diffend
 
           raise Errors::EmptyConfigurationFile if content.empty?
 
-          OpenStruct.new(parse_file(content).merge(build_path: build_path))
-            .tap(&Validator.method(:call))
+          parse_file(content)
         end
 
         def parse_file(content)
@@ -92,25 +83,6 @@ module Diffend
             Please re-setup.\n
           MSG
         end
-
-        # @return [String] malformed configuration file message
-        def build_missing_key_error_message(exception)
-          missing_key = missing_key_from_exception(exception)
-
-          <<~MSG
-            \nYour Diffend configuration file is missing #{missing_key} key.\n
-            Please re-setup.\n
-          MSG
-        end
-
-        def missing_key_from_exception(exception)
-          case exception
-          when Errors::ProjectIdMissingInConfigurationFile then 'project_id'
-          when Errors::ShareableIdMissingInConfigurationFile then 'shareable_id'
-          when Errors::ShareableKeyMissingInConfigurationFile then 'shareable_key'
-          when Errors::BuildPathMissingInConfigurationFile then 'build_path'
-          end
-        end
       end
     end
   end

data/lib/diffend/{config → configs}/file_finder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Diffend
-  module Config
+  module Configs
     # Class used to figure out the file from which we should load the settings
     module FileFinder
       # Names of the files or paths where we will look for the settings

data/lib/diffend/configs/validator.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Module for all the components related to setting up the config
+  module Configs
+    # Class responsible for validating the config from .diffend.yml
+    module Validator
+      KNOWN_KEYS = {
+        project_id: [String],
+        shareable_id: [String],
+        shareable_key: [String],
+        build_path: [String],
+        env: [String],
+        command: [String],
+        ignore_errors?: [TrueClass, FalseClass],
+        development?: [TrueClass, FalseClass]
+      }.freeze
+
+      class << self
+        # @param config [Diffend::Config]
+        def call(config)
+          KNOWN_KEYS.each_key do |key|
+            if missing?(config, key)
+              missing_key_message(key)
+                .tap(&config.logger.method(:fatal))
+
+              raise Diffend::Errors::HandledException
+            end
+
+            if invalid?(config, key)
+              invalid_key_message(config, key)
+                .tap(&config.logger.method(:fatal))
+
+              raise Diffend::Errors::HandledException
+            end
+          end
+        end
+
+        private
+
+        # @param config [Diffend::Config]
+        # @param key [String]
+        #
+        # @return [Boolean] true if we are missing a key, false otherwise
+        def missing?(config, key)
+          value = config.public_send(key)
+
+          value.nil? || (value.respond_to?(:empty?) && value.empty?)
+        end
+
+        # @param config [Diffend::Config]
+        # @param key [String]
+        #
+        # @return [Boolean] true if we are missing a key, false otherwise
+        def invalid?(config, key)
+          !KNOWN_KEYS[key].include?(config.public_send(key).class)
+        end
+
+        # Missing key message
+        #
+        # @param key [String] missing key
+        #
+        # @return [String]
+        def missing_key_message(key)
+          <<~MSG
+            \nDiffend configuration is missing #{key} key.\n
+          MSG
+        end
+
+        # Invalid key message
+        #
+        # @param hash [Hash] config hash
+        # @param key [String] invalid key
+        #
+        # @return [String]
+        def invalid_key_message(hash, key)
+          <<~MSG
+            \nDiffend configuration value for #{key} is invalid.\n
+            It should be #{KNOWN_KEYS[key].join(' or ')} but is #{hash.public_send(key).class}.\n
+          MSG
+        end
+      end
+    end
+  end
+end