Technical/Update gem dependencies (#23)

* Updated gem development dependencies
* Updated simplecov/CircleCi config
* Fixed syntax compatibility with Ruby 3.x
* Updated gem version, changelog, documentation

Author: bestwebua

.circleci/config.yml

@@ -1,11 +1,21 @@
+version: 2.1
+
 defaults: &defaults
   working_directory: ~/truemail-ruby-client
   docker:
-    - image: circleci/ruby:2.5.0-node
+    - image: cimg/ruby:<< parameters.ruby-version >>
   environment:
     CC_TEST_REPORTER_ID: 183d1173cc05e4e5dbd07ddb60a04b9c4115ed11a4bacda0e1834572eb168c51
 
+orbs:
+  ruby: circleci/ruby@1.1.3
+
 references:
+  install_bundler: &install_bundler
+    run:
+      name: Installing Bundler
+      command: gem i bundler -v $(tail -1 Gemfile.lock | tr -d ' ')
+
   restore_bundle_cache: &restore_bundle_cache
     restore_cache:
       keys:
@@ -24,66 +34,97 @@ references:
 
   install_codeclimate_reporter: &install_codeclimate_reporter
     run:
-      name: Install Code Climate Test Reporter
+      name: Installing CodeClimate test reporter
       command: |
             curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
             chmod +x ./cc-test-reporter
 
-version: 2
 jobs:
-  linters:
+  linters-ruby:
+    parameters:
+      ruby-version:
+        type: string
+
     <<: *defaults
 
     steps:
       - checkout
 
+      - <<: *install_bundler
       - <<: *restore_bundle_cache
       - <<: *bundle_install
       - <<: *save_bundle_cache
 
       - run:
-          name: Running overcommit
+          name: Running Overcommit
           command: |
             bundle exec overcommit -s
             SKIP=AuthorEmail,AuthorName bundle exec overcommit -r
 
-  tests:
+  tests-ruby:
+    parameters:
+      ruby-version:
+        type: string
+
     <<: *defaults
 
     steps:
       - checkout
 
+      - <<: *install_bundler
       - <<: *restore_bundle_cache
       - <<: *bundle_install
       - <<: *save_bundle_cache
       - <<: *install_codeclimate_reporter
 
       - run:
-          name: Running tests
+          name: Running RSpec
           command: |
-            mkdir /tmp/test-results
             ./cc-test-reporter before-build
             bundle exec rspec
 
       - run:
-          name: Code Climate Test Coverage
+          name: Creating CodeClimate test coverage report
           command: |
             ./cc-test-reporter format-coverage -t simplecov -o "coverage/codeclimate.$CIRCLE_NODE_INDEX.json"
 
-      - store_test_results:
-          path: /tmp/test-results
-
       - store_artifacts:
-          path: /tmp/test-results
-          destination: test-results
+          name: Saving Simplecov coverage artifacts
+          path: ~/truemail-ruby-client/coverage
+          destination: coverage
 
       - deploy:
+          name: Uploading CodeClimate test coverage report
           command: |
             ./cc-test-reporter sum-coverage --output - --parts $CIRCLE_NODE_TOTAL coverage/codeclimate.*.json | ./cc-test-reporter upload-coverage --debug --input -
 
+  compatibility-ruby:
+    parameters:
+      ruby-version:
+        type: string
+    docker:
+      - image: cimg/ruby:<< parameters.ruby-version >>
+    steps:
+      - checkout
+      - ruby/install-deps:
+          with-cache: false
+          path: './vendor/custom_bundle'
+      - run:
+          name: Running compatibility tests
+          command: bundle exec rspec
+
 workflows:
-  version: 2
-  build:
+  build_and_test:
     jobs:
-      - linters
-      - tests
+      - linters-ruby:
+          matrix:
+            parameters:
+              ruby-version: ["2.5"]
+      - tests-ruby:
+          matrix:
+            parameters:
+              ruby-version: ["2.5"]
+      - compatibility-ruby:
+          matrix:
+            parameters:
+              ruby-version: ["2.6", "2.7", "3.0"]

CHANGELOG.md

@@ -2,6 +2,18 @@
 
 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).
 
+## [0.3.2] - 2021-05-19
+
+### Fixed
+
+- Gem syntax compatibility with Ruby 3.x
+
+### Changed
+
+- Updated gem dependencies
+- Updated rubocop/codeclimate config
+- Updated gem version
+
 ## [0.3.1] - 2021-05-08
 
 ### Changed

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    truemail-client (0.3.1)
+    truemail-client (0.3.2)
 
 GEM
   remote: https://rubygems.org/
@@ -20,8 +20,8 @@ GEM
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
-    docile (1.3.5)
-    faker (2.17.0)
+    docile (1.4.0)
+    faker (2.18.0)
       i18n (>= 1.6, < 2)
     fasterer (0.9.0)
       colorize (~> 0.7)
@@ -48,7 +48,7 @@ GEM
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    psych (3.3.1)
+    psych (3.3.2)
     public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.3)
@@ -72,7 +72,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.14.0)
+    rubocop (1.15.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -90,26 +90,26 @@ GEM
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
-    ruby_parser (3.15.1)
-      sexp_processor (~> 4.9)
-    sexp_processor (4.15.2)
+    ruby_parser (3.16.0)
+      sexp_processor (~> 4.15, >= 4.15.1)
+    sexp_processor (4.15.3)
     simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     thor (1.1.0)
     unicode-display_width (2.0.0)
-    webmock (3.12.2)
+    webmock (3.13.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.2, >= 2.2.17)
   bundler-audit (~> 0.8.0)
   faker (~> 2.17)
   fasterer (~> 0.9.0)
@@ -127,4 +127,4 @@ DEPENDENCIES
   webmock (~> 3.12, >= 3.12.2)
 
 BUNDLED WITH
-   1.16.6
+   2.2.17

README.md

@@ -59,17 +59,17 @@ To have an access for `Truemail::Client` you must configure it first as in the e
 require 'truemail/client'
 
 Truemail::Client.configure do |config|
-  # Optional parameter (Boolean). By default it is equal false
-  config.secure_connection = true
-
   # Required parameter (String). It should be a hostname or an ip address where Truemail server runs
   config.host = 'example.com'
 
-  # Optional parameter (Integer). By default it is equal 9292
-  config.port = 80
-
   # Required parameter (String). It should be valid Truemail server access token
   config.token = 'token'
+
+  # Optional parameter (Boolean). By default it is equal false
+  config.secure_connection = true
+
+  # Optional parameter (Integer). By default it is equal 9292
+  config.port = 80
 end
 ```
 
@@ -94,6 +94,8 @@ Truemail::Client.validate('admin@bestweb.com.ua')
     "whitelist_validation": false,
     "whitelisted_domains": null,
     "blacklisted_domains": null,
+    "blacklisted_mx_ip_addresses": null,
+    "dns": null,
     "smtp_safe_check": false,
     "email_pattern": "default gem value",
     "smtp_error_body_pattern": "default gem value",

lib/truemail/client/configuration.rb

@@ -5,8 +5,8 @@ module Client
     class Configuration
       DEFAULT_PORT = 9292
 
-      Error = Class.new(StandardError)
-      ArgumentError = Class.new(StandardError) do
+      Error = ::Class.new(::StandardError)
+      ArgumentError = ::Class.new(::StandardError) do
         def initialize(arg_value, arg_name)
           super("#{arg_value} is not a valid #{arg_name[0..-2]}")
         end
@@ -26,7 +26,7 @@ def initialize(&block)
           raise_unless(
             argument,
             __method__,
-            method.eql?(:port) ? argument.is_a?(Integer) && argument.positive? : argument.is_a?(String)
+            method.eql?(:port) ? argument.is_a?(::Integer) && argument.positive? : argument.is_a?(::String)
           )
           instance_variable_set(:"@#{method}", argument)
         end

lib/truemail/client/http.rb

@@ -22,8 +22,8 @@ def initialize(endpoint = Truemail::Client::Http::VALIDATION_ENDPOINT, **uri_par
       end
 
       def run
-        Net::HTTP.start(uri.host, uri.port, use_ssl: secure_connection) do |http|
-          request = Net::HTTP::Get.new(uri)
+        ::Net::HTTP.start(uri.host, uri.port, use_ssl: secure_connection) do |http|
+          request = ::Net::HTTP::Get.new(uri)
           request['User-Agent'] = Truemail::Client::Http::USER_AGENT
           request['Accept'] = Truemail::Client::Http::MIME_TYPE
           request['Content-Type'] = Truemail::Client::Http::MIME_TYPE
@@ -41,9 +41,9 @@ def run
       attr_reader(*Truemail::Client::Http::URI_ATTRS)
 
       def request_uri
-        URI::HTTP.build(
+        ::URI::HTTP.build(
           path: endpoint,
-          query: uri_params.empty? ? nil : URI.encode_www_form(uri_params)
+          query: uri_params.empty? ? nil : ::URI.encode_www_form(uri_params)
         ).request_uri
       end
 

lib/truemail/client/version.rb

@@ -2,6 +2,6 @@
 
 module Truemail
   module Client
-    VERSION = '0.3.1'
+    VERSION = '0.3.2'
   end
 end

spec/spec_helper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-rspec_custom = File.join(File.dirname(__FILE__), 'support/**/*.rb')
-Dir[File.expand_path(rspec_custom)].sort.each { |file| require file unless file[/\A.+_spec\.rb\z/] }
+rspec_custom = ::File.join(File.dirname(__FILE__), 'support/**/*.rb')
+::Dir[::File.expand_path(rspec_custom)].sort.each { |file| require file unless file[/\A.+_spec\.rb\z/] }
 
 require 'truemail/client'
 
@@ -22,5 +22,5 @@
   config.order = :random
   config.before { Truemail::Client.reset_configuration! }
 
-  Kernel.srand(config.seed)
+  ::Kernel.srand(config.seed)
 end

spec/support/config/simplecov.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-require 'simplecov'
+if ::RUBY_VERSION[/\A2\.5.+\z/]
+  require 'simplecov'
 
-SimpleCov.minimum_coverage(100)
-SimpleCov.start
+  SimpleCov.minimum_coverage(100)
+  SimpleCov.start { add_filter(%r{\A/spec/}) }
+end

spec/support/helpers/configuration_helper.rb

@@ -19,7 +19,7 @@ def configure_client(**configuration_settings)
     Truemail::Client.reset_configuration!
     configuration_settings[:host] = Faker::Internet.domain_name unless configuration_settings[:host]
     configuration_settings[:token] = create_token unless configuration_settings[:token]
-    Truemail::Client.configure(&configuration_block(configuration_settings))
+    Truemail::Client.configure(&configuration_block(**configuration_settings))
   end
 
   def client_configuration

spec/support/helpers/configuration_helper_spec.rb

@@ -3,11 +3,11 @@
 RSpec.describe ConfigurationHelper, type: :helper do
   describe '#configuration_block' do
     let(:configuration_params) { { param_1: 1, param_2: 2 } }
-    let(:configuration_instance) { Struct.new(*configuration_params.keys).new }
+    let(:configuration_instance) { ::Struct.new(*configuration_params.keys).new }
 
-    before { configuration_block(configuration_params).call(configuration_instance) }
+    before { configuration_block(**configuration_params).call(configuration_instance) }
 
-    specify { expect(configuration_block).to be_an_instance_of(Proc) }
+    specify { expect(configuration_block).to be_an_instance_of(::Proc) }
 
     it 'sets configuration instance attributes' do
       configuration_params.each do |attribute, value|
@@ -19,12 +19,12 @@
   describe '#create_token' do
     it 'returns secure token' do
       expect(SecureRandom).to receive(:uuid).and_call_original
-      expect(create_token).to be_an_instance_of(String)
+      expect(create_token).to be_an_instance_of(::String)
     end
   end
 
   describe '#configure_client' do
-    subject(:configuration_builder) { configure_client(params) }
+    subject(:configuration_builder) { configure_client(**params) }
 
     let(:params) { {} }