diffend 0.2.27 → 0.2.32

data/lib/diffend/errors.rb

@@ -23,5 +23,7 @@ module Diffend
     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,28 +1,38 @@
 # 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)
-          .tap { |response| build_message(command, config, response) }
+      # @param config [Diffend::Config]
+      def call(config)
+        Diffend::RequestVerdict
+          .call(config, build_definition(config.command))
+          .tap { |response| build_message(config, response) }
+      rescue Diffend::Errors::DependenciesResolveException
+        # We are unable to resolve dependencies, no message will be printed
       end
 
-      # @param command [String] either install or update
-      # @param config [OpenStruct] diffend config
+      # Build bundler definition
+      #
+      # @return [Bundler::Definition]
+      def build_definition(command)
+        Diffend::BuildBundlerDefinition.call(
+          command,
+          Bundler.default_gemfile,
+          Bundler.default_lockfile
+        )
+      end
+
+      # @param config [Diffend::Config]
       # @param response [Hash] response from diffend API
-      def build_message(command, config, response)
+      def build_message(config, response)
         if response.key?('error')
-          build_error(response)
+          build_error(config, response)
         elsif response.key?('action')
-          build_verdict(command, config, response)
+          build_verdict(config, response)
         else
           Diffend::HandleErrors::Report.call(
             config: config,
@@ -36,25 +46,24 @@ module Diffend
       # @param response [Hash] response from diffend API
       def build_error(response)
         build_error_message(response)
-          .tap(&Bundler.ui.method(:error))
+          .tap(&config.logger.method(:error))
 
         raise Diffend::Errors::HandledException
       end
 
-      # @param command [String] either install or update
-      # @param config [OpenStruct] diffend config
+      # @param config [Diffend::Config]
       # @param response [Hash] response from diffend API
-      def build_verdict(command, config, response)
+      def build_verdict(config, response)
         case response['action']
         when 'allow'
-          build_allow_message(command, response)
-            .tap(&Bundler.ui.method(:confirm))
+          build_allow_message(config.command, response)
+            .tap(&config.logger.method(:info))
         when 'warn'
-          build_warn_message(command, response)
-            .tap(&Bundler.ui.method(:warn))
+          build_warn_message(config.command, response)
+            .tap(&config.logger.method(:warn))
         when 'deny'
-          build_deny_message(command, response)
-            .tap(&Bundler.ui.method(:error))
+          build_deny_message(config.command, response)
+            .tap(&config.logger.method(:error))
 
           exit 1
         else
@@ -77,7 +86,7 @@ module Diffend
         MSG
       end
 
-      # @param command [String] either install or update
+      # @param command [String] command executed via bundler
       # @param response [Hash] response from diffend API
       #
       # @return [String]
@@ -89,7 +98,7 @@ module Diffend
         MSG
       end
 
-      # @param command [String] either install or update
+      # @param command [String] command executed via bundler
       # @param response [Hash] response from diffend API
       #
       # @return [String]
@@ -101,7 +110,7 @@ module Diffend
         MSG
       end
 
-      # @param command [String] either install or update
+      # @param command [String] command executed via bundler
       # @param response [Hash] response from diffend API
       #
       # @return [String]
@@ -114,7 +123,7 @@ module Diffend
       end
 
       # @param type [String] verdict type
-      # @param command [String] either install or update
+      # @param command [String] command executed via bundler
       #
       # @return [String]
       def build_message_header(type, command)

data/lib/diffend/handle_errors/report.rb

@@ -7,10 +7,10 @@ module Diffend
       class << self
         # Execute request to Diffend
         #
+        # @param config [Diffend::Config]
+        # @param message [Symbol] message that we want to display
         # @param exception [Exception] expection that was raised
         # @param payload [Hash] with versions to check
-        # @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
         #
@@ -18,8 +18,11 @@ module Diffend
         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)
-          Bundler.ui.error(Diffend::HandleErrors::Messages.const_get(message.to_s.upcase))
+          Diffend::HandleErrors::Messages::PAYLOAD_DUMP
+            .tap(&config.logger.method(:error))
+          Diffend::HandleErrors::Messages
+            .const_get(message.to_s.upcase)
+            .tap(&config.logger.method(:error))
 
           if report
             Diffend::Request.call(
@@ -30,14 +33,14 @@ module Diffend
           raise Diffend::Errors::HandledException if raise_exception
         end
 
-        # @param config [OpenStruct] diffend config
+        # @param config [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),
+            url: config.errors_url,
             payload: payload,
             request_method: :post
           )
@@ -54,17 +57,6 @@ module Diffend
             .call(exception, payload)
             .tap(&Diffend::HandleErrors::DisplayToStdout.method(:call))
         end
-
-        # Provides diffend errors endpoint url
-        #
-        # @param project_id [String] diffend project_id
-        #
-        # @return [String] diffend endpoint
-        def errors_url(project_id)
-          return ENV['DIFFEND_ERROR_URL'] if ENV.key?('DIFFEND_ERROR_URL')
-
-          "https://my.diffend.io/api/projects/#{project_id}/errors"
-        end
       end
     end
   end

data/lib/diffend/latest_version.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Verify if we are running latest version of the plugin
+  module LatestVersion
+    class << self
+      # Verify if we are running latest version of the plugin
+      #
+      # @param config [Diffend::Config]
+      def call(config)
+        return if config.development?
+        return if installed_version == Diffend::VERSION
+
+        print_message(config, installed_version)
+
+        exit 2
+      end
+
+      private
+
+      # @return [String] installed plugin version
+      def installed_version
+        ::Bundler::Plugin
+          .index
+          .plugin_path('diffend')
+          .basename
+          .to_s
+          .split('-')
+          .last
+      end
+
+      # @param config [Diffend::Config]
+      # @param version [Hash] installed version
+      def print_message(config, version)
+        build_message(version)
+          .tap(&config.logger.method(:error))
+      end
+
+      # @param version [Hash] installed version
+      #
+      # @return [String]
+      def build_message(version)
+        <<~MSG
+          \nYou are running an outdated version (#{version}) of the plugin, which will lead to issues.
+          \nPlease upgrade to the latest one (#{Diffend::VERSION}) by executing "rm -rf .bundle/plugin".\n
+        MSG
+      end
+    end
+  end
+end

data/lib/diffend/local_context.rb

@@ -0,0 +1,23 @@
+# 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 config [Diffend::Config]
+      # @param definition [Bundler::Definition] definition for your source
+      #
+      # @return [Hash] payload for diffend endpoint
+      def call(config, definition)
+        {
+          'diffend' => Diffend.call(config),
+          'host' => Host.call,
+          'packages' => Packages.call(config.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 config [Diffend::Config]
+        #
+        # @return [Hash]
+        def call(config)
+          {
+            'api_version' => API_VERSION,
+            'environment' => config.env,
+            'project_id' => config.project_id,
+            'type' => PLATFORM_TYPE,
+            'version' => ::Diffend::VERSION
+          }.freeze
+        end
+      end
+    end
+  end
+end

data/lib/diffend/local_context/host.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'etc'
+
+module Diffend
+  # Module responsible for building local context
+  module LocalContext
+    # Module responsible for building host information from local context
+    module Host
+      class << self
+        # Build host information
+        #
+        # @return [Hash]
+        def call
+          uname = Etc.uname
+
+          {
+            'command' => command,
+            'ips' => ips,
+            'name' => uname[:nodename],
+            'system' => {
+              'machine' => uname[:machine],
+              'name' => uname[:sysname],
+              'release' => uname[:release],
+              'version' => uname[:version]
+            },
+            'tags' => tags,
+            'user' => Etc.getpwuid(Process.uid).name,
+            'pid' => Process.pid
+          }.freeze
+        end
+
+        private
+
+        # Build host command information
+        #
+        # @return [Hash]
+        def command
+          if File.exist?($PROGRAM_NAME)
+            if defined?(JRUBY_VERSION)
+              name = $PROGRAM_NAME.split('/').last.strip
+              command = "#{name} #{ARGV.join(' ')}"
+            else
+              array = `ps -p #{Process.pid} -o command=`.strip.split(' ')
+              array.shift if array.first.end_with?('bin/ruby')
+              name = array.shift.split('/').last.strip
+              command = "#{name} #{array.join(' ')}"
+            end
+
+            { 'name' => command, 'title' => '' }
+          else
+            { 'name' => ARGV.join(' '), 'title' => $PROGRAM_NAME }
+          end
+        end
+
+        # Build host ips, except localhost and loopback
+        #
+        # @return [Array<String>]
+        def ips
+          Socket.ip_address_list.map do |ip|
+            next if ip.ipv4_loopback? || ip.ipv6_loopback? || ip.ipv6_linklocal?
+
+            ip.ip_address
+          end.compact
+        end
+
+        # Build host tags
+        #
+        # @return [Array]
+        def tags
+          tags = []
+
+          if ENV.key?('GITHUB_ACTIONS')
+            tags << 'ci'
+            tags << 'ci-github'
+          end
+
+          if ENV.key?('CIRCLECI')
+            tags << 'ci'
+            tags << 'ci-circle'
+          end
+
+          tags
+        end
+      end
+    end
+  end
+end

data/lib/diffend/local_context/packages.rb

@@ -0,0 +1,302 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Module responsible for building local context
+  module LocalContext
+    # Module responsible for building packages information from local context
+    class Packages
+      # Definition of a local path, if it matches it means that we are the source
+      ME_PATH = '.'
+      # Sources that we expect to match ourselves too
+      ME_SOURCES = [
+        Bundler::Source::Gemspec,
+        Bundler::Source::Path
+      ].freeze
+      # List of dependency types
+      DEPENDENCIES_TYPES = {
+        direct: 0,
+        dependency: 1
+      }.freeze
+      # List of sources types
+      SOURCES_TYPES = {
+        valid: 0,
+        multiple_primary: 1
+      }.freeze
+      # List of gem sources types
+      GEM_SOURCES_TYPES = {
+        local: 0,
+        gemfile_source: 1,
+        gemfile_git: 2,
+        gemfile_path: 3
+      }.freeze
+
+      class << self
+        # @param command [String] command executed via bundler
+        # @param definition [Bundler::Definition] definition for your source
+        def call(command, definition)
+          Bundler.ui.silence { definition.resolve_remotely! }
+
+          instance = new(definition)
+
+          case command
+          when Commands::INSTALL, Commands::EXEC then instance.build_install
+          when Commands::UPDATE then instance.build_update
+          else
+            raise ArgumentError, "invalid command: #{command}"
+          end
+        end
+      end
+
+      # @param definition [Bundler::Definition] definition for your source
+      #
+      # @return [Hash] local dependencies
+      def initialize(definition)
+        @definition = definition
+        @direct_dependencies = Hash[definition.dependencies.map { |val| [val.name, val] }]
+        # Support case without Gemfile.lock
+        @locked_specs = @definition.locked_gems ? @definition.locked_gems.specs : []
+      end
+
+      # Build install specification
+      #
+      # @return [Hash]
+      def build_install
+        hash = build_main
+
+        @definition.specs.each do |spec|
+          next if skip?(spec.source)
+
+          locked_spec = @locked_specs.find { |s| s.name == spec.name }
+
+          hash['dependencies'][spec.name] = {
+            'platform' => build_spec_platform(spec, locked_spec),
+            'source' => build_spec_source(spec),
+            'type' => build_dependency_type(spec.name),
+            'versions' => build_versions(spec, locked_spec)
+          }
+        end
+
+        hash
+      end
+
+      # Build update specification
+      #
+      # @return [Hash]
+      def build_update
+        hash = build_main
+
+        @definition.specs.each do |spec|
+          next if skip?(spec.source)
+
+          locked_spec = @locked_specs.find { |s| s.name == spec.name }
+
+          hash['dependencies'][spec.name] = {
+            'platform' => build_spec_platform(spec, locked_spec),
+            'source' => build_spec_source(spec),
+            'type' => build_dependency_type(spec.name),
+            'versions' => build_versions(spec, locked_spec)
+          }
+        end
+
+        hash
+      end
+
+      private
+
+      # Build default specification
+      #
+      # @return [Hash]
+      def build_main
+        {
+          'dependencies' => {},
+          'sources' => build_sources,
+          'plugins' => {},
+          'platforms' => @definition.platforms.map(&:to_s)
+        }
+      end
+
+      # Build gem versions
+      #
+      # @param spec [Bundler::StubSpecification, Bundler::LazySpecification, Gem::Specification]
+      # @param locked_spec [Bundler::LazySpecification, Gem::Specification, NilClass]
+      #
+      # @return [Array<String>]
+      def build_versions(spec, locked_spec = nil)
+        if locked_spec && locked_spec.version.to_s != spec.version.to_s
+          [locked_spec.version.to_s, spec.version.to_s]
+        else
+          [spec.version.to_s]
+        end
+      end
+
+      # @param specs [Array] specs that are direct dependencies
+      # @param name [String] spec name
+      #
+      # @return [Boolean] dependency type
+      def build_dependency_type(name)
+        if @direct_dependencies.key?(name)
+          DEPENDENCIES_TYPES[:direct]
+        else
+          DEPENDENCIES_TYPES[:dependency]
+        end
+      end
+
+      # Build gem platform
+      #
+      # @param spec [Bundler::StubSpecification, Bundler::LazySpecification, Gem::Specification]
+      # @param locked_spec [Bundler::LazySpecification, Gem::Specification, NilClass]
+      #
+      # @return [String]
+      def build_spec_platform(spec, locked_spec)
+        parse_platform(
+          spec.platform || locked_spec&.platform || spec.send(:generic_local_platform)
+        )
+      end
+
+      # Parse gem platform
+      #
+      # @param platform [String, Gem::Platform]
+      #
+      # @return [String]
+      def parse_platform(platform)
+        case platform
+        when String then platform
+        when Gem::Platform then platform.to_s
+        end
+      end
+
+      # Build gem source type
+      #
+      # @param source [Bundler::Source] gem source type
+      #
+      # @return [Integer] internal gem source type
+      def build_spec_gem_source_type(source)
+        case source
+        when Bundler::Source::Metadata
+          GEM_SOURCES_TYPES[:local]
+        when Bundler::Source::Rubygems, Bundler::Source::Rubygems::Remote
+          GEM_SOURCES_TYPES[:gemfile_source]
+        when Bundler::Source::Git
+          GEM_SOURCES_TYPES[:gemfile_git]
+        when Bundler::Source::Path
+          GEM_SOURCES_TYPES[:gemfile_path]
+        else
+          raise ArgumentError, "unknown source #{source.class}"
+        end
+      end
+
+      # Build gem source
+      #
+      # @param spec [Bundler::StubSpecification, Bundler::LazySpecification, Gem::Specification]
+      #
+      # @return [Hash]
+      def build_spec_source(spec)
+        source = source_for_spec(spec)
+
+        {
+          'type' => build_spec_gem_source_type(source),
+          'value' => source_name_from_source(source)
+        }
+      end
+
+      # Figure out source for gem
+      #
+      # @param spec [Bundler::StubSpecification, Bundler::LazySpecification, Gem::Specification]
+      #
+      # @return [Bundler::Source] gem source type
+      def source_for_spec(spec)
+        return spec.remote if spec.remote
+
+        case spec.source
+        when Bundler::Source::Rubygems
+          spec
+            .source
+            .send(:remote_specs)
+            .search(Bundler::Dependency.new(spec.name, spec.version))
+            .last
+            .remote
+        when Bundler::Source::Metadata, Bundler::Source::Git, Bundler::Source::Path
+          spec.source
+        else
+          raise ArgumentError, "unknown source #{spec.source.class}"
+        end
+      end
+
+      # Build gem source name
+      #
+      # @param source [Bundler::Source] gem source type
+      #
+      # @return [String]
+      def source_name_from_source(source)
+        case source
+        when Bundler::Source::Metadata
+          ''
+        when Bundler::Source::Rubygems::Remote
+          source_name(source.anonymized_uri)
+        when Bundler::Source::Git
+          source.instance_variable_get(:@safe_uri)
+        when Bundler::Source::Path
+          source.path
+        else
+          raise ArgumentError, "unknown source #{source.class}"
+        end
+      end
+
+      # @param uri [Bundler::URI]
+      #
+      # @return [String]
+      def source_name(uri)
+        uri.to_s[0...-1]
+      end
+
+      # Build sources used in the Gemfile
+      #
+      # @return [Array<Hash>]
+      def build_sources
+        sources = @definition.send(:sources).rubygems_sources
+        hash = {}
+
+        sources.each do |source|
+          type = build_source_type(source.remotes)
+
+          source.remotes.each do |src|
+            hash[source_name(src)] = type
+          end
+        end
+
+        hash.map { |name, type| { 'name' => name, 'type' => type } }
+      end
+
+      # Build gem source type
+      #
+      # @param remotes [Array<Bundler::URI>]
+      #
+      # @return [Integer] internal source type
+      def build_source_type(remotes)
+        remotes.count > 1 ? SOURCES_TYPES[:multiple_primary] : SOURCES_TYPES[:valid]
+      end
+
+      # Checks if we should skip a source
+      #
+      # @param source [Bundler::Source] gem source type
+      #
+      # @return [Boolean] true if we should skip this source, false otherwise
+      def skip?(source)
+        return true if me?(source)
+
+        false
+      end
+
+      # Checks if it's a self source, this happens for repositories that are a gem
+      #
+      # @param source [Bundler::Source] gem source type
+      #
+      # @return [Boolean] true if it's a self source, false otherwise
+      def me?(source)
+        return false unless ME_SOURCES.include?(source.class)
+
+        source.path.to_s == ME_PATH
+      end
+    end
+  end
+end