diffend 0.2.25 → 0.2.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6f2f5188a60431f6125d9b82e75f6edb661bf9c805ff13f685b962555c2cdb2
-  data.tar.gz: 3b4161909c2c494a37b3e8e3f9839f2fb86dd7c5712ca200cfb40e3c77e6bba6
+  metadata.gz: 52618cdf40375202e18c1cdaa481554084f3b92f337fd61c089e147f0027e982
+  data.tar.gz: 859f390055e3030d3a357b604067e6c05814f653225a802136563be4bc32f9ee
 SHA512:
-  metadata.gz: a305d14cb1c2fe8166de8a830a465ed0647b690aec10ec917cf31348944a6f8f3867b75053f2817ab04153a27bc141064bc2ecc46dc73a77f68850011592c11c
-  data.tar.gz: f279c3f69cfcd07706a4c4652741d7ebc9423d222724d2c0093fa363f3be25970216d5adcaf156825db1edde6a8d6fb3d990f31a8d7480b656ff23e2a23490bc
+  metadata.gz: 9f17436faa3bdabe77c891c930bb9dac01f426ae715d37035d7727112e221526ac003daa44d196dbb056f4c21bca49589a7799e36bef81db6bf8b3c29012adb5
+  data.tar.gz: 232310953c6dc8cd500aac54b0fd8d7f9980457b40032021b46bf7753f62c8a7d6167486c3e15e0d2e940101b47b8b8cdd8af67577eca7ba626b2db9706724c6

data/.github/workflows/ci.yml

@@ -34,6 +34,8 @@ jobs:
         run: |
           gem install bundler --no-document
       - name: Bundle install
+        env:
+          DIFFEND_DEVELOPMENT: true
         run: |
           bundle config path vendor/bundle
           bundle install --jobs 4 --retry 3

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 ## [Unreleased][master]
 
+## [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))
+- introduce `Diffend::Monitor` and `Diffend::Track` ([#15](https://github.com/diffend-io/diffend-ruby/pull/15))
+
+## [0.2.26] (2020-09-10)
+- introduce `DIFFEND_DEVELOPMENT` environment variable ([#36](https://github.com/diffend-io/diffend-ruby/pull/36))
+- adjust message for allow verdict ([#37](https://github.com/diffend-io/diffend-ruby/pull/37))
+- do not run the plugin when it is not enabled ([#38](https://github.com/diffend-io/diffend-ruby/pull/38))
+
 ## [0.2.25] (2020-09-09)
 - add support for a warn verdict ([#34](https://github.com/diffend-io/diffend-ruby/pull/34))
 
@@ -50,7 +72,12 @@
 
 - initial release
 
-[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.25...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
 [0.2.24]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.23...v0.2.24
 [0.2.23]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.22...v0.2.23

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    diffend (0.2.25)
+    diffend (0.2.30)
 
 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,114 +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
-  voting
-].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.25'
-  # 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
-      detect_installed_version
-
-      config = fetch_config
-
-      Diffend::Voting.call(
-        command,
-        config,
-        Diffend::BuildBundlerDefinition.call(
-          command,
-          Bundler.default_gemfile,
-          Bundler.default_lockfile
-        )
-      )
-    rescue StandardError => e
-      Diffend::HandleErrors::Report.call(
-        exception: e,
-        config: config,
-        message: :unhandled_exception,
-        report: true
-      )
-    end
-
-    def detect_installed_version
-      return if installed_version == VERSION
-
-      build_outdated_version_message(installed_version)
-        .tap(&Bundler.ui.method(:error))
-
-      exit 1
-    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
-
-    # @return [String] installed plugin version
-    def installed_version
-      Bundler::Plugin
-        .index
-        .plugin_path('diffend')
-        .basename
-        .to_s
-        .split('-')
-        .last
-    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/commands.rb

@@ -3,9 +3,11 @@
 module Diffend
   # Modules grouping supported bundler commands
   module Commands
-    # Install bundler command
+    # Bundler install command
     INSTALL = 'install'
-    # Update bundler command
+    # Bundler update command
     UPDATE = 'update'
+    # Bundler exec command
+    EXEC = 'exec'
   end
 end

data/lib/diffend/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Diffend config object
+  module Config
+    class << self
+      # Build diffend config object
+      #
+      # @return [OpenStruct, nil]
+      #
+      # @raise [Errors::MissingConfigurationFile] when no config file
+      def call
+        Diffend::Config::Fetcher.call(
+          File.expand_path('..', ::Bundler.bin_path)
+        )
+      end
+    end
+  end
+end

data/lib/diffend/config/fetcher.rb

@@ -27,16 +27,20 @@ module Diffend
           build(build_path)
         rescue Errors::MissingConfigurationFile
           Bundler.ui.error(build_missing_error_message(build_path))
-          exit 1
+
+          raise Diffend::Errors::HandledException
         rescue Errors::EmptyConfigurationFile
           Bundler.ui.error(build_empty_error_message(build_path))
-          exit 1
+
+          raise Diffend::Errors::HandledException
         rescue Errors::MalformedConfigurationFile
           Bundler.ui.error(build_malformed_error_message(build_path))
-          exit 1
+
+          raise Diffend::Errors::HandledException
         rescue *MISSING_KEY_ERRORS => e
           Bundler.ui.error(build_missing_key_error_message(e))
-          exit 1
+
+          raise Diffend::Errors::HandledException
         end
 
         private

data/lib/diffend/errors.rb

@@ -21,5 +21,9 @@ module Diffend
     BuildPathMissingInConfigurationFile = Class.new(BaseError)
     # Raised when server-side error occurs
     RequestServerError = Class.new(BaseError)
+    # Raised when we had an exception that we know how to handle
+    HandledException = Class.new(BaseError)
+    # Raised when we are unable to resolve dependencies
+    DependenciesResolveException = Class.new(BaseError)
   end
 end

data/lib/diffend/{voting.rb → execute.rb}

@@ -1,18 +1,30 @@
 # frozen_string_literal: true
 
 module Diffend
-  # Verifies voting verdicts for gems
-  module Voting
+  # Executes a check for a given command
+  module Execute
     class << self
       # Build verdict
       #
       # @param command [String] either install or update
       # @param config [OpenStruct] diffend config
-      # @param definition [Bundler::Definition] definition for your source
-      def call(command, config, definition)
-        Versions::Remote
-          .call(command, config, definition)
+      def call(command, config)
+        Diffend::RequestVerdict
+          .call(command, config, build_definition(command))
           .tap { |response| build_message(command, config, response) }
+      rescue Diffend::Errors::DependenciesResolveException
+        # We are unable to resolve dependencies, no message will be printed
+      end
+
+      # Build bundler definition
+      #
+      # @return [Bundler::Definition]
+      def build_definition(command)
+        Diffend::BuildBundlerDefinition.call(
+          command,
+          Bundler.default_gemfile,
+          Bundler.default_lockfile
+        )
       end
 
       # @param command [String] either install or update
@@ -38,7 +50,7 @@ module Diffend
         build_error_message(response)
           .tap(&Bundler.ui.method(:error))
 
-        exit 1
+        raise Diffend::Errors::HandledException
       end
 
       # @param command [String] either install or update
@@ -84,7 +96,7 @@ module Diffend
       def build_allow_message(command, response)
         <<~MSG
           #{build_message_header('an allow', command)}
-          #{build_message_info(response)}
+          #{build_message_info(response)}\n
           #{response['review_url']}\n
         MSG
       end
@@ -96,7 +108,7 @@ module Diffend
       def build_warn_message(command, response)
         <<~MSG
           #{build_message_header('a warn', command)}
-          #{build_message_info(response)}
+          #{build_message_info(response)} Please go to the url below and review the issues.\n
           #{response['review_url']}\n
         MSG
       end
@@ -108,7 +120,7 @@ module Diffend
       def build_deny_message(command, response)
         <<~MSG
           #{build_message_header('a deny', command)}
-          #{build_message_info(response)}
+          #{build_message_info(response)} Please go to the url below and review the issues.\n
           #{response['review_url']}\n
         MSG
       end
@@ -125,7 +137,7 @@ module Diffend
       #
       # @return [String]
       def build_message_info(response)
-        "\nQuality score: #{response['quality_score']}, allows: #{response['allows_count']}, warnings: #{response['warns_count']}, denies: #{response['denies_count']}. Please go to the url below and review the issues.\n"
+        "\nQuality score: #{response['quality_score']}, allows: #{response['allows_count']}, warnings: #{response['warns_count']}, denies: #{response['denies_count']}."
       end
     end
   end

data/lib/diffend/handle_errors/report.rb

@@ -12,9 +12,10 @@ module Diffend
         # @param config [OpenStruct] Diffend config
         # @param message [Symbol] message that we want to display
         # @param report [Boolean] if true we will report the issue to diffend
+        # @param raise_exception [Boolean] if true we will raise an exception
         #
         # @return [Net::HTTPResponse] response from Diffend
-        def call(config:, message:, exception: nil, payload: {}, report: false)
+        def call(config:, message:, exception: nil, payload: {}, report: false, raise_exception: true)
           exception_payload = prepare_exception_payload(exception, payload)
 
           Bundler.ui.error(Diffend::HandleErrors::Messages::PAYLOAD_DUMP)
@@ -22,13 +23,24 @@ module Diffend
 
           if report
             Diffend::Request.call(
-              config,
-              errors_url(config.project_id),
-              exception_payload
+              build_request_object(config, exception_payload)
             )
           end
 
-          exit 1
+          raise Diffend::Errors::HandledException if raise_exception
+        end
+
+        # @param config [OpenStruct] diffend config
+        # @param payload [Hash]
+        #
+        # @return [Diffend::RequestObject]
+        def build_request_object(config, payload)
+          Diffend::RequestObject.new(
+            config: config,
+            url: errors_url(config.project_id),
+            payload: payload,
+            request_method: :post
+          )
         end
 
         # Prepare exception payload and display it to stdout

data/lib/diffend/local_context.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Module responsible for building local context
+  module LocalContext
+    class << self
+      # Build diffend, host, packages, and platform specific information
+      #
+      # @param command [String] either install or update
+      # @param project_id [String] diffend project_id
+      # @param definition [Bundler::Definition] definition for your source
+      #
+      # @return [Hash] payload for diffend endpoint
+      def call(command, project_id, definition)
+        {
+          'diffend' => Diffend.call(project_id),
+          'host' => Host.call,
+          'packages' => Packages.call(command, definition),
+          'platform' => Platform.call
+        }.freeze
+      end
+    end
+  end
+end

data/lib/diffend/local_context/diffend.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Module responsible for building local context
+  module LocalContext
+    # Module responsible for building diffend information from local context
+    module Diffend
+      # API version
+      API_VERSION = '0.1'
+      # Platform type ruby
+      PLATFORM_TYPE = 0
+
+      private_constant :API_VERSION, :PLATFORM_TYPE
+
+      class << self
+        # Build diffend information
+        #
+        # @param project_id [String, nil] diffend project_id
+        #
+        # @return [Hash]
+        def call(project_id)
+          {
+            'api_version' => API_VERSION,
+            'environment' => ENV['DIFFEND_ENV'],
+            'project_id' => project_id,
+            'type' => PLATFORM_TYPE,
+            'version' => ::Diffend::VERSION
+          }.freeze
+        end
+      end
+    end
+  end
+end