smtp_mock 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6fcd84a6232032428e31f2d0627b9c72a98a74a257dcb7638fb8b0bb11dbba5
-  data.tar.gz: 1b06de5c2a1009eb9dddc7f3b1aa2a15573f6f2ff2fadd2a4d81fb50c8c7d91f
+  metadata.gz: 6e7b1afecc17c4c1905acc7008dece2c87908a622adf0d3e7fa4093b3385584d
+  data.tar.gz: a8e006258b42098c2b35cbadd10b7004b7099942d18cdd6baec533fc7abc62c7
 SHA512:
-  metadata.gz: bd6df23a441cebf9a7d597d770f16af4548880da884082c32e91f507399a76e953a274ee6985f963143cd5fac98560cd5d9563896c3f8019a26ee266f4c29d3a
-  data.tar.gz: aa7c24286f3e74b059b48f3d59f67e5dd4548feabcdc3cd85ae6381d8950c64ec5042ca84baa6d06e1a55155668f2f296c7e6fd95bf1bcdb6614e81024ea282c
+  metadata.gz: 9713d4cd810845321ce7b7bce79717382da3652b3475836342e5a68433d7ee92246ff456285cc905d862030801a7c545b89780100bd5e867ab433f6bf82ae29a
+  data.tar.gz: cd51a1f5a1bd7f70b9babe5b4cf2cbfd8ab17333bd1b739a941f598960b1b6e1de8baddceda89aad0e0276ddf64a1ba17074fed4989a2d09e62b0aa0638ccb0f

data/.circleci/config.yml

@@ -6,7 +6,7 @@ defaults: &defaults
     - image: cimg/ruby:<< parameters.ruby-version >>
 
 orbs:
-  ruby: circleci/ruby@1.2.0
+  ruby: circleci/ruby@1.4.0
 
 references:
   restore_bundle_cache: &restore_bundle_cache
@@ -40,6 +40,12 @@ references:
             curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
             chmod +x ./cc-test-reporter
 
+  use_compatible_gemspec: &use_compatible_gemspec
+    run:
+      name: Use compatible gemspec
+      command: |
+            cp .circleci/gemspec_compatible smtp_mock.gemspec
+
 jobs:
   linters-ruby:
     parameters:
@@ -106,6 +112,7 @@ jobs:
       - image: cimg/ruby:<< parameters.ruby-version >>
     steps:
       - checkout
+      - <<: *use_compatible_gemspec
       - ruby/install-deps:
           bundler-version: "2.3.5"
           with-cache: false
@@ -121,12 +128,12 @@ workflows:
       - linters-ruby:
           matrix:
             parameters:
-              ruby-version: ["2.5"]
+              ruby-version: ["3.1"]
       - tests-ruby:
           matrix:
             parameters:
-              ruby-version: ["2.5"]
+              ruby-version: ["3.1"]
       - compatibility-ruby:
           matrix:
             parameters:
-              ruby-version: ["2.6", "2.7", "3.0", "3.1"]
+              ruby-version: ["2.5", "2.6", "2.7", "3.0"]

data/.circleci/gemspec_compatible

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = ::File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smtp_mock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'smtp_mock'
+  spec.version       = SmtpMock::VERSION
+  spec.authors       = ['Vladislav Trotsenko']
+  spec.email         = ['admin@bestweb.com.ua']
+
+  spec.summary       = %(smtp_mock)
+  spec.description   = %(💎 Ruby SMTP mock. Mimic any SMTP server behaviour for your test environment.)
+
+  spec.homepage      = 'https://github.com/mocktools/ruby-smtp-mock'
+  spec.license       = 'MIT'
+
+  spec.metadata = {
+    'homepage_uri' => 'https://github.com/mocktools/ruby-smtp-mock',
+    'changelog_uri' => 'https://github.com/mocktools/ruby-smtp-mock/blob/master/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/mocktools/ruby-smtp-mock',
+    'documentation_uri' => 'https://github.com/mocktools/ruby-smtp-mock/blob/master/README.md',
+    'bug_tracker_uri' => 'https://github.com/mocktools/ruby-smtp-mock/issues'
+  }
+
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = %w[smtp_mock]
+  spec.require_paths = %w[lib]
+
+  spec.add_runtime_dependency 'dry-struct', '~> 1.4'
+
+  spec.add_development_dependency 'ffaker', '~> 2.20'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+end

data/.codeclimate.yml

@@ -7,7 +7,7 @@ checks:
 plugins:
   rubocop:
     enabled: true
-    channel: rubocop-1-24
+    channel: rubocop-1-25
 
   reek:
     enabled: true

data/.reek.yml

@@ -9,6 +9,7 @@ detectors:
       - SmtpMock::ServerHelper
       - SmtpMock::TestFramework::RSpec::Helper#smtp_mock_server
       - SmtpMock::ContextGeneratorHelper#random_message
+      - SmtpMock::Cli::Resolver#install_to
 
   NestedIterators:
     exclude:

data/.rubocop.yml

@@ -290,9 +290,6 @@ Gemspec/DateAssignment:
 Gemspec/RequireMFA:
   Enabled: false
 
-Gemspec/RubyVersionGlobalsUsage:
-  Enabled: false
-
 Security/IoMethods:
   Enabled: true
 

data/.ruby-version

@@ -1 +1 @@
-ruby-2.5.0
+ruby-3.1.0

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0] - 2022-01-31
+
+### Added
+
+- Added `smtpmock` version checker
+- Added command for upgrade `smtpmock` to latest version
+- Added `SmtpMock::Error::Dependency::SMTPMOCK_MIN_VERSION`
+- Added `SmtpMock::Server#version`, tests
+
+### Updated
+
+- Updated `SmtpMock::Dependency.verify_dependencies`, tests
+- Updated `SmtpMock::Cli::Command`, tests
+- Updated gem version, documentation
+
 ## [0.1.2] - 2022-01-24
 
 ### Updated

data/README.md

@@ -77,8 +77,9 @@ This gem includes easy system dependency manager. Run `bundle exec smtp_mock` wi
 | Flag | Description | Example of usage |
 | --- | --- | --- |
 | `-s`, `--sudo` | Run command as sudo | `bundle exec smtp_mock -s -i ~` |
-| `-i`, `--install=PATH` | Install smtpmock to the existing path | `bundle exec smtp_mock -i ~/existent_dir` |
-| `-u`, `--uninstall` | Uninstall smtpmock | `bundle exec smtp_mock -u` |
+| `-i`, `--install=PATH` | Install `smtpmock` to the existing path | `bundle exec smtp_mock -i ~/existent_dir` |
+| `-u`, `--uninstall` | Uninstall `smtpmock` | `bundle exec smtp_mock -u` |
+| `-g`, `--upgrade` | Upgrade to latest version of `smtpmock` | `bundle exec smtp_mock -g` |
 | `-h`, `--help` | Prints help | `bundle exec smtp_mock -h` |
 
 ### DSL
@@ -134,6 +135,9 @@ smtp_mock_server.port # => 55640
 # returns current smtp mock server port
 smtp_mock_server.pid # => 38195
 
+# returns current smtp mock server version
+smtp_mock_server.version # => '1.5.2'
+
 # interface for graceful shutdown current smtp mock server
 smtp_mock_server.stop # => true
 

data/lib/smtp_mock/cli/resolver.rb

@@ -12,34 +12,34 @@ module SmtpMock
         opt_parser = ::OptionParser.new do |parser|
           parser.banner = SmtpMock::Cli::Resolver::USE_CASE
 
-          parser.on('-s', '--sudo', 'Run command as sudo') do
-            self.sudo = true
-          end
+          parser.on('-s', '--sudo', 'Run command as sudo') { self.sudo = true }
 
           parser.on('-iPATH', '--install=PATH', 'Install smtpmock to the existing path') do |argument|
             self.install_path = argument
             return self.message = 'smtpmock is already installed' if ::File.exist?(binary_path)
 
-            ::Kernel.system("cd #{install_path} && curl -sL #{SmtpMock::Cli::Resolver::DOWNLOAD_SCRIPT} | bash")
+            install_to(install_path)
             ::Kernel.system("#{as_sudo}ln -s #{binary_path} #{SmtpMock::Dependency::SYMLINK}")
-
             self.message = 'smtpmock was installed successfully'
           end
 
           parser.on('-u', '--uninstall', 'Uninstall smtpmock') do
-            current_smtpmock_path = SmtpMock::Dependency.smtpmock_path_by_symlink
-            return self.message = 'smtpmock not installed yet' if current_smtpmock_path.empty?
+            return if not_installed? # rubocop:disable Lint/NonLocalExitFromIterator
 
             ::Kernel.system("#{as_sudo}unlink #{SmtpMock::Dependency::SYMLINK}")
             ::Kernel.system("rm #{current_smtpmock_path}")
-
             self.message = 'smtpmock was uninstalled successfully'
           end
 
-          parser.on('-h', '--help', 'Prints help') do
-            self.message = parser.to_s
+          parser.on('-g', '--upgrade', 'Upgrade to latest version of smtpmock') do
+            return if not_installed? # rubocop:disable Lint/NonLocalExitFromIterator
+
+            install_to(current_smtpmock_path[%r{(.+)/.+}, 1])
+            self.message = 'smtpmock was upgraded successfully'
           end
 
+          parser.on('-h', '--help', 'Prints help') { self.message = parser.to_s }
+
           self.success = true
         end
 
@@ -52,9 +52,23 @@ module SmtpMock
         "#{install_path}/smtpmock"
       end
 
+      def install_to(install_path)
+        ::Kernel.system("cd #{install_path} && curl -sL #{SmtpMock::Cli::Resolver::DOWNLOAD_SCRIPT} | bash")
+      end
+
       def as_sudo
         return 'sudo ' if sudo
       end
+
+      def current_smtpmock_path
+        @current_smtpmock_path ||= SmtpMock::Dependency.smtpmock_path_by_symlink
+      end
+
+      def not_installed?
+        return false unless current_smtpmock_path.empty?
+        self.message = 'smtpmock not installed yet'
+        true
+      end
     end
   end
 end

data/lib/smtp_mock/core.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module SmtpMock
+  SMTPMOCK_MIN_VERSION = '1.5.0'
+
   module Error
     require_relative '../smtp_mock/error/argument'
     require_relative '../smtp_mock/error/dependency'

data/lib/smtp_mock/dependency.rb

@@ -4,6 +4,7 @@ module SmtpMock
   module Dependency
     BINARY_SHORTCUT = 'smtpmock'
     SYMLINK = "/usr/local/bin/#{BINARY_SHORTCUT}"
+    VERSION_REGEX_PATTERN = /#{BINARY_SHORTCUT}: (.+)/.freeze
 
     class << self
       def smtpmock_path_by_symlink
@@ -16,11 +17,27 @@ module SmtpMock
 
       def verify_dependencies
         raise SmtpMock::Error::Dependency, SmtpMock::Error::Dependency::SMTPMOCK_NOT_INSTALLED unless smtpmock?
+        current_version = version
+        raise SmtpMock::Error::Dependency, SmtpMock::Error::Dependency::SMTPMOCK_MIN_VERSION unless minimal_version?(current_version)
+        current_version
       end
 
       def compose_command(command_line_args)
         "#{SmtpMock::Dependency::BINARY_SHORTCUT} #{command_line_args}".strip
       end
+
+      private
+
+      def version
+        ::Kernel.public_send(
+          :`,
+          "#{SmtpMock::Dependency::BINARY_SHORTCUT} -v"
+        )[SmtpMock::Dependency::VERSION_REGEX_PATTERN, 1]
+      end
+
+      def minimal_version?(current_version)
+        !!current_version && current_version >= SmtpMock::SMTPMOCK_MIN_VERSION
+      end
     end
   end
 end

data/lib/smtp_mock/error/dependency.rb

@@ -4,6 +4,7 @@ module SmtpMock
   module Error
     class Dependency < ::RuntimeError
       SMTPMOCK_NOT_INSTALLED = 'smtpmock is required system dependency. Run `bundle exec smtp_mock -h` for details'
+      SMTPMOCK_MIN_VERSION = "smtpmock #{SmtpMock::SMTPMOCK_MIN_VERSION} or higher is required. Run `bundle exec smtp_mock -g` for version upgrade"
     end
   end
 end

data/lib/smtp_mock/server.rb

@@ -2,7 +2,7 @@
 
 module SmtpMock
   class Server
-    attr_reader :pid, :port
+    attr_reader :pid, :port, :version
 
     def initialize( # rubocop:disable Metrics/ParameterLists
       deps_handler = SmtpMock::Dependency,
@@ -11,7 +11,7 @@ module SmtpMock
       process = SmtpMock::Server::Process,
       **args
     )
-      deps_handler.verify_dependencies
+      @version = deps_handler.verify_dependencies
       args[:port] = port_checker.random_free_port unless args.include?(:port)
       @command_line_args, @port = args_builder.call(**args), args[:port]
       @deps_handler, @port_checker, @process = deps_handler, port_checker, process

data/lib/smtp_mock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SmtpMock
-  VERSION = '0.1.2'
+  VERSION = '1.0.0'
 end

data/smtp_mock.gemspec

@@ -36,14 +36,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler-audit', '~> 0.9.0.1'
   spec.add_development_dependency 'fasterer', '~> 0.9.0'
   spec.add_development_dependency 'ffaker', '~> 2.20'
-  spec.add_development_dependency 'net-smtp', '~> 0.3' if ::RUBY_VERSION >= '3.1.0'
+  spec.add_development_dependency 'net-smtp', '~> 0.3.1'
   spec.add_development_dependency 'overcommit', '~> 0.58.0'
   spec.add_development_dependency 'pry-byebug', '~> 3.9'
   spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
-  spec.add_development_dependency 'reek', '~> 6.0', '>= 6.0.6'
+  spec.add_development_dependency 'reek', '~> 6.1'
   spec.add_development_dependency 'rspec', '~> 3.10'
-  spec.add_development_dependency 'rubocop', '~> 1.24'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.13'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.7'
-  spec.add_development_dependency 'simplecov', '~> 0.17.1'
+  spec.add_development_dependency 'rubocop', '~> 1.25'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.13', '>= 1.13.2'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.8'
+  spec.add_development_dependency 'simplecov', '~> 0.21.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smtp_mock
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Vladislav Trotsenko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-24 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.20'
+- !ruby/object:Gem::Dependency
+  name: net-smtp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: overcommit
   requirement: !ruby/object:Gem::Requirement
@@ -120,20 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.0.6
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.0.6
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -154,14 +162,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '1.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '1.25'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -169,6 +177,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -176,34 +187,37 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.21.2
 description: "\U0001F48E Ruby SMTP mock. Mimic any SMTP server behaviour for your
   test environment."
 email:
@@ -214,6 +228,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".circleci/gemspec_compatible"
 - ".codeclimate.yml"
 - ".github/BRANCH_NAMING_CONVENTION.md"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
@@ -281,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: smtp_mock