diffend 0.2.28 → 0.2.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c100adca589f5e4e22488ecc8d12a865b2ec8a5bb6be4bf15f3b4bf5d5ad089
-  data.tar.gz: 8e5820badb850ee24606874e8de80a8e19114a08276f9fca3933a54e4fb825bc
+  metadata.gz: ca45ede600a1ba9ef22e538d14f4de5be8c662e7b3c39211e52327fbf99b6f92
+  data.tar.gz: 5054f7dfa57e79adb3734e30c6cecaa7865fe3b9c0aef345c146cad49019529f
 SHA512:
-  metadata.gz: 70b2798f074676511abc75974db24ee116dcbf9fc87983a4cfc6d9e69246c12b0970c376ced03e08a6fb0a9ba09fa9cd11a3da5d728715c6ec676030bd7ebccd
-  data.tar.gz: fd130a1283b65d6487bab7323eb2a7d7c9d3db6cea7c777e4c7a023f77e9b0d0ee4078cd38c9228fe18b1555ee9e9ec9efd0fa1033a7c8ed5e19859cb8e11970
+  metadata.gz: cede14b22f216cdf7c520d1455676dea8d0a911adf2206d59ba6fc4db8e880b38cd846aeb29cd8e82ec27f13db533442c3853433c7032336879eb7c05d5ddd4c
+  data.tar.gz: 8f6e842c2b9557e76e7cf09e9ed62a8a9f251a7caa21cc2cae5a488aae928ae006df9f081429116d8df8e46acbf5c62e7e9f0097875813bcd0b8b75ef57a3b7b

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+2.7.2

data/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 ## [Unreleased][master]
 
+## [0.2.33] (2020-10-25)
+- fix an exception when configuration file is missing ([#65](https://github.com/diffend-io/diffend-ruby/pull/65))
+- silently exit when configuration file is missing in `Diffend::Monitor` ([#66](https://github.com/diffend-io/diffend-ruby/pull/66))
+- introduce default config ([#67](https://github.com/diffend-io/diffend-ruby/pull/67))
+- handle `SocketError` ([#68](https://github.com/diffend-io/diffend-ruby/pull/68))
+
+## [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))
@@ -64,7 +91,12 @@
 
 - initial release
 
-[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.28...HEAD
+[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.33...HEAD
+[0.2.33]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.32...v0.2.33
+[0.2.32]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.31...v0.2.32
+[0.2.31]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.30...v0.2.31
+[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

data/Gemfile

@@ -7,7 +7,5 @@ plugin 'diffend'
 gemspec
 
 group :development, :test do
-  gem 'byebug', platform: :ruby
-  gem 'pry', platform: :jruby
   gem 'rspec'
 end

data/Gemfile.lock

@@ -1,26 +1,18 @@
 PATH
   remote: .
   specs:
-    diffend (0.2.28)
+    diffend (0.2.33)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    byebug (11.1.3)
-    coderay (1.1.3)
     diff-lcs (1.4.4)
-    ffi (1.13.1-java)
-    method_source (1.0.0)
-    pry (0.13.1-java)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-      spoon (~> 0.0)
     rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
+    rspec-core (3.9.3)
       rspec-support (~> 3.9.3)
     rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -29,8 +21,6 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    spoon (0.0.6)
-      ffi
 
 PLATFORMS
   java
@@ -38,9 +28,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
-  byebug
   diffend!
-  pry
   rake
   rspec
 

data/config/diffend.yml

@@ -0,0 +1,6 @@
+project_id: <%= ENV['DIFFEND_PROJECT_ID'] %>
+shareable_id: <%= ENV['DIFFEND_SHAREABLE_ID'] %>
+shareable_key: <%= ENV['DIFFEND_SHAREABLE_KEY'] %>
+env: <%= ENV['DIFFEND_ENV'] || 'development' %>
+ignore_errors: <%= ENV['DIFFEND_IGNORE_ERRORS'] || 'true' %>
+development: <%= ENV['DIFFEND_DEVELOPMENT'] || 'true' %>

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.28'
-  # 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,80 @@
+# 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]
+    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, plugin_path, build_path)
+      hash['build_path'] = build_path
+      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
+
+    def plugin_path
+      Pathname.new(File.expand_path('../..', __dir__))
+    end
+  end
+end

data/lib/diffend/configs/fetcher.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Diffend
+  # Module for all the components related to setting up the config
+  module Configs
+    # Class responsible for fetching the config from .diffend.yml
+    module Fetcher
+      class << self
+        # @param logger [Diffend::Logger]
+        # @param plugin_path [String] path of the plugin
+        # @param build_path [String] path of the current build
+        #
+        # @return [Hash] details from configuration file
+        #
+        # @example
+        #   details = Fetcher.new.call('./')
+        #   details.build_path #=> './'
+        def call(logger, plugin_path, build_path)
+          build(plugin_path, build_path)
+        rescue Errors::MalformedConfigurationFile
+          build_malformed_error_message(build_path)
+            .tap(&logger.method(:fatal))
+
+          raise Diffend::Errors::HandledException
+        end
+
+        private
+
+        # @param plugin_path [String] path of the plugin
+        # @param build_path [String] path of the current build
+        #
+        # @return [OpenStruct] open struct with config details
+        def build(plugin_path, build_path)
+          default_config = File.join(plugin_path, 'config', 'diffend.yml')
+          project_config = File.join(build_path, '.diffend.yml')
+
+          hash = read_file(default_config)
+
+          if File.exist?(project_config)
+            hash.merge!(read_file(project_config) || {})
+          end
+
+          hash
+        end
+
+        def read_file(path)
+          YAML.safe_load(ERB.new(File.read(path)).result)
+        rescue Psych::SyntaxError
+          raise Errors::MalformedConfigurationFile
+        end
+
+        # @return [String] malformed configuration file message
+        def build_malformed_error_message
+          <<~MSG
+            \nYour Diffend configuration file is malformed.\n
+            Please re-setup.\n
+          MSG
+        end
+      end
+    end
+  end
+end