diffend-monitor 0.2.30 → 0.2.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b768ab8543226a138c1094b0f49dc5f9d72814b747433d63b32d6edaa0c91fcc
-  data.tar.gz: '085ce87e9324f4c86f7b300dc18ac8b72d2cea5ecbfad8c97c56a5bf91291389'
+  metadata.gz: 4752936e9019b4f29efaaff31b9dac04a941c485c8f1edda527fe8c307e7253a
+  data.tar.gz: 656f56cf62c0684ad19df36a143bd680f0e745b64444048176e5d9ed81c36ddb
 SHA512:
-  metadata.gz: 71a8aa1b53a0d9784c8a85e81f24322418751b8548dfef0dc07fcc2dd175e93944aad8ef381a9e743e992df58b95431e67fb4f11ac8fd1d82dddac18e32abe0b
-  data.tar.gz: aef5a2f90120b7d5d809c2b4afb60192c7b8157626eebc00fb1163a23ec883ce9f66cdd16c86f21c5c532f4f5229785dcd86fe4a82e064bc179dd7e4fbea0366
+  metadata.gz: 5287a81123ca427438e9271fd7bcb87e1eb5cdf3e32376908f35c7cd89cd0f6f3c72b5f464368c7aeea0e60e3a10a8ca433b12c509e05fbd4bced75df0cf69f5
+  data.tar.gz: 67cece4be9ee2ce57b471bb99289eceafe6abf785afb419c5c609a929f4afcf3f946f4c38f25d3c0b08588eba758531b0d8c01cc6f9db8846ec92a5bda68e9a9

data/.ruby-version

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

data/CHANGELOG.md

@@ -2,6 +2,32 @@
 
 ## [Unreleased][master]
 
+## [0.2.35] (2020-11-04)
+- clean command name and title of a process ([#76](https://github.com/diffend-io/diffend-ruby/pull/76))
+- handle `uninitialized constant #<Class:Diffend::Configs::Fetcher>::ERB` ([#75](https://github.com/diffend-io/diffend-ruby/pull/75))
+
+## [0.2.34] (2020-10-25)
+- handle `Bundler::GitError` ([#72](https://github.com/diffend-io/diffend-ruby/pull/72))
+
+## [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))
@@ -72,7 +98,12 @@
 
 - initial release
 
-[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.30...HEAD
+[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.35...HEAD
+[0.2.35]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.34...v0.2.35
+[0.2.34]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.33...v0.2.34
+[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

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,36 +1,26 @@
 PATH
   remote: .
   specs:
-    diffend (0.2.30)
+    diffend (0.2.35)
 
 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-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    spoon (0.0.6)
-      ffi
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
 
 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/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

@@ -2,18 +2,79 @@
 
 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
+  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,67 @@
+# frozen_string_literal: true
+
+%w[
+  erb
+  yaml
+].each(&method(:require))
+
+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

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

data/lib/diffend/errors.rb

@@ -5,10 +5,6 @@ module Diffend
   module Errors
     # Base error class from which all the errors should inherit
     BaseError = Class.new(StandardError)
-    # Raised when we couldn't find a valid configuration file
-    MissingConfigurationFile = Class.new(BaseError)
-    # Raised when configuration file is empty
-    EmptyConfigurationFile = Class.new(BaseError)
     # Raised when configuration file is malformed
     MalformedConfigurationFile = Class.new(BaseError)
     # Raised when project_id is missing in configuration file

data/lib/diffend/execute.rb

@@ -6,12 +6,11 @@ module Diffend
     class << self
       # Build verdict
       #
-      # @param command [String] either install or update
-      # @param config [OpenStruct] diffend config
-      def call(command, config)
+      # @param config [Diffend::Config]
+      def call(config)
         Diffend::RequestVerdict
-          .call(command, config, build_definition(command))
-          .tap { |response| build_message(command, config, response) }
+          .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
@@ -27,14 +26,13 @@ module Diffend
         )
       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_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,
@@ -48,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
@@ -89,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]
@@ -101,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]
@@ -113,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]
@@ -126,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)