truemail 2.0.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51df5b3fdb1b14899fba11d4d5cfc28f52396b85e03a653439c1f3b5616c6804
-  data.tar.gz: 927ec7dfd5f30a6b9339a587bac21db11c127b9a97074942d4a9d7c363d7ea87
+  metadata.gz: '098a5137b9a780eef6d123e9393ccb00814808645e99d53408b9a80c32cf1a7b'
+  data.tar.gz: f64e10f884aea786c61006d9be9238b7e1073612c64b12e4b177b18e637da97c
 SHA512:
-  metadata.gz: 45d7f94b891fc7d70f488147761ff1de9389435abfda562306c75a401c2a0576cad744d1d607777c826c74a4d1b0575a13ef38745d8737f10a426d8ff80c2d50
-  data.tar.gz: 21ba52447572ae156611681cd5a14e279e834030e0aa9e8c143f06dda68069eb1016cbed78ad912ba773dc643d89b58bc4645b052ffb655534e31055ee911b2f
+  metadata.gz: 822485cd53478f2e38279de6c02f8ec2cc77762fad336c9c0278e415be852037c2bea2966409247893b271b0c61a5bc0769c659d1beaeef4a085ae57dce57a61
+  data.tar.gz: e176b835d2a11452f5d2d8ab952fbda08adef54078907c02d3bd3d534adab816a29adbc279202c74bf963c678d926141c89771a72207a2933c78214e2fea7119

data/.codeclimate.yml

@@ -7,7 +7,7 @@ checks:
 plugins:
   rubocop:
     enabled: true
-    channel: rubocop-0-91
+    channel: rubocop-1-5
 
   reek:
     enabled: true

data/.github/BRANCH_NAMING_CONVENTION.md

@@ -0,0 +1,36 @@
+# Branch naming convention
+
+## Branch naming
+
+> Please note for new pull requests create new branches from current `develop` branch only.
+
+Branch name should include type of your contribution and context. Please follow next pattern for naming your branches:
+
+```bash
+feature/add-some-feature
+technical/some-technical-improvements
+bugfix/fix-some-bug-name
+```
+
+## Before PR actions
+
+### Squash commits
+
+Please squash all branch commits into the one before openning your PR from your fork. It's simple to do with the git:
+
+```bash
+git rebase -i [hash your first commit of your branch]~1
+git rebase -i 6467fe36232401fa740af067cfd8ac9ec932fed2~1 # example
+```
+
+### Add commit description
+
+Please complete your commit description folowing next pattern:
+
+```
+Technical/Add info files # should be the same name as your branch name
+
+* Added license, changelog, contributing, code of conduct docs
+* Added GitHub templates
+* Updated project license link
+```

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] Your bug report title here"
+labels: bug
+assignees: bestwebua
+
+---
+
+<!-- Thanks for helping to make Truemail better! Before submit your bug, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
+
+### New bug checklist
+
+- [ ] I have updated `truemail` to the latest version
+- [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail/blob/master/CONTRIBUTING.md)
+- [ ] I have read the [documentation](https://truemail-rb.org/truemail-gem)
+- [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail/issues)
+
+<!-- Please use next pattern for your bug report title: [BUG] Your bug report title here -->
+
+### Bug description
+<!-- Please include what's happening, expected behavior, and any relevant code samples -->
+
+##### Complete output when running truemail, including the stack trace and command used
+
+<details>
+  <pre>[INSERT OUTPUT HERE]</pre>
+</details>

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: Suggest an idea for Truemail
+title: "[FEATURE] Your feature request title here"
+labels: enhancement
+assignees: bestwebua
+
+---
+
+<!-- Thanks for helping to make Truemail better! Before submit your new feature request, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
+
+### New feature request checklist
+
+- [ ] I have updated `truemail` to the latest version
+- [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail/blob/master/CONTRIBUTING.md)
+- [ ] I have read the [documentation](https://truemail-rb.org/truemail-gem)
+- [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail/issues)
+
+<!-- Please use next pattern for your feature request title: [FEATURE] Your feature request title here -->
+
+### Feature description
+
+<!-- Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+Describe the solution you'd like. A clear and concise description of what you want to happen.
+
+Describe alternatives you've considered. A clear and concise description of any alternative solutions or features you've considered. -->

data/.github/{ISSUE_TEMPLATE.md → ISSUE_TEMPLATE/issue_report.md}

@@ -1,13 +1,24 @@
+---
+name: Issue report
+about: Create a report to help us improve
+title: "[ISSUE] Your issue report title here"
+labels: ''
+assignees: bestwebua
+
+---
+
 <!-- Thanks for helping to make Truemail better! Before submit your issue, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
 
-### New Issue Checklist
+### New issue checklist
 
-- [ ] I have updated truemail to the latest version
+- [ ] I have updated `truemail` to the latest version
 - [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail/blob/master/CONTRIBUTING.md)
 - [ ] I have read the [documentation](https://truemail-rb.org/truemail-gem)
 - [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail/issues)
 
-### Issue Description
+<!-- Please use next pattern for your issue report title: [ISSUE] Your issue report title here -->
+
+### Issue description
 <!-- Please include what's happening, expected behavior, and any relevant code samples -->
 
 ##### Complete output when running truemail, including the stack trace and command used

data/.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,22 @@
+---
+name: Question
+about: Ask your question to Truemail team
+title: "[QUESTION] Your question title here"
+labels: question
+assignees: bestwebua
+
+---
+
+<!-- Thanks for helping to make Truemail better! Before submit your question, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
+
+### New question checklist
+
+- [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail/blob/master/CONTRIBUTING.md)
+- [ ] I have read the [documentation](https://truemail-rb.org/truemail-gem)
+- [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail/issues)
+
+<!-- Please use next pattern for your question title: [QUESTION] Your question title here -->
+
+### Question
+
+<!-- Your question context here -->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,9 @@
 # PR Details
 
 <!-- Provide a general summary of your changes in the Title above -->
+<!-- PR name should the same name as your branch name, example: -->
+<!-- Branch name is: feature/add-some-feature -->
+<!-- PR name should be: Feature/Add some feature -->
 
 ## Description
 

data/.reek.yml

@@ -27,6 +27,7 @@ detectors:
     exclude:
       - Truemail::Configuration#whitelist_validation
       - Truemail::Configuration#not_rfc_mx_lookup_flow
+      - Truemail::Configuration#smtp_fail_fast
       - Truemail::Configuration#smtp_safe_check
       - Truemail::Wrapper#attempts
 
@@ -41,6 +42,7 @@ detectors:
       - Truemail::Configuration#domain_matcher
       - Truemail::Configuration#logger_options
       - Truemail::Log::Serializer::Base#errors
+      - Truemail::Log::Serializer::ValidatorBase#replace_invalid_chars
 
   ControlParameter:
     exclude:

data/.rubocop.yml

@@ -115,6 +115,30 @@ Style/RedundantSelfAssignment:
 Style/SoleNestedConditional:
   Enabled: true
 
+Style/ClassEqualityComparison:
+  Enabled: true
+
+Style/ArgumentsForwarding:
+  Enabled: true
+
+Style/CollectionCompact:
+  Enabled: true
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+
+Style/NegatedIfElseCondition:
+  Enabled: true
+
+Style/NilLambda:
+  Enabled: true
+
+Style/SwapValues:
+  Enabled: true
+
+Style/RedundantArgument:
+  Enabled: true
+
 Layout/LineLength:
   Max: 140
 
@@ -212,6 +236,36 @@ Lint/UselessMethodDefinition:
 Lint/UselessTimes:
   Enabled: true
 
+Lint/HashCompareByIdentity:
+  Enabled: true
+
+Lint/RedundantSafeNavigation:
+  Enabled: true
+
+Lint/DuplicateBranch:
+  Enabled: true
+
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+
+Lint/EmptyBlock:
+  Enabled: true
+
+Lint/EmptyClass:
+  Enabled: true
+
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: false
+
+Lint/ToEnumArguments:
+  Enabled: true
+
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+
+Lint/UnexpectedBlockArity:
+  Enabled: true
+
 Performance/AncestorsInclude:
   Enabled: true
 
@@ -239,6 +293,18 @@ Performance/StringInclude:
 Performance/Sum:
   Enabled: true
 
+Performance/BlockGivenWithExplicitBlock:
+  Enabled: true
+
+Performance/CollectionLiteralInLoop:
+  Enabled: true
+
+Performance/ConstantRegexp:
+  Enabled: true
+
+Performance/MethodObjectAsBlock:
+  Enabled: true
+
 RSpec/ExampleLength:
   Enabled: false
 
@@ -265,3 +331,6 @@ RSpec/MultipleDescribes:
 
 RSpec/MultipleMemoizedHelpers:
   Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false

data/CHANGELOG.md

@@ -2,11 +2,81 @@
 
 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).
 
+## [2.2.1] - 2020.12.06
+
+### Fixed
+
+- Filter out ASCII-8BIT chars for serialized SMTP response errors. Fixed `Encoding::UndefinedConversionError` in `Truemail::Log::Serializer::ValidatorJson#serialize`. Thanks to [@eni9889](https://github.com/eni9889) for report
+- Added missed `smtp_fail_fast` attribute to serialized validator and auditor results
+
+### Added
+
+- Added `Truemail::Log::Serializer::ValidatorBase#replace_invalid_chars`
+
+### Changed
+
+- Updated `Truemail::Log::Serializer::Base`
+- Updated `Truemail::Log::Serializer::ValidatorBase`
+- Updated gem development dependencies
+
+## [2.2.0] - 2020.12.01
+
+Ability to use fail fast behaviour for SMTP validation layer. When `smtp_fail_fast = true` it means that `truemail` ends smtp validation session after first attempt on the first mx server in any fail cases (network connection/timeout error, smtp validation error). This feature helps to reduce total time of SMTP validation session up to 1 second.
+
+### Added
+
+- Added `Truemail::Configuration#smtp_fail_fast`
+- Added `Truemail::Validate::Smtp#smtp_fail_fast?`
+- Added `Truemail::Validate::Smtp#filtered_mail_servers_by_fail_fast_scenario`
+
+### Changed
+
+- Updated `Truemail::Validate::Smtp#attempts`
+- Updated `Truemail::Validate::Smtp#establish_smtp_connection`
+- Updated gem documentation
+
+It's a configurable and not required option:
+
+```ruby
+Truemail.configure do |config|
+  config.smtp_fail_fast = true # by default it's equal to false
+end
+```
+
+Thanks to [@wikiti](https://github.com/wikiti) for timeout reports.
+
+## [2.1.0] - 2020.11.21
+
+Collecting only unique ip-addresses for target mail servers. This update reduces email validation time for case when remote server have closed connection via avoiding connection attempt to server with the same ip address.
+
+### Changed
+
+- Updated `Truemail::Validate::Mx#fetch_target_hosts`
+
+## [2.0.2] - 2020.11.14
+
+### Fixed
+
+Timeouts time units in `Setting global configuration` of Truemail documentation's section. Thanks to [@wikiti](https://github.com/wikiti) for report.
+
+### Changed
+
+- Refactored `Truemail::RegexConstant::REGEX_EMAIL_PATTERN`
+- Updated gem development dependencies
+- Updated gem documentation
+
+## [2.0.1] - 2020.10.20
+
+### Changed
+
+- Updated gem development dependencies
+- Updated gem documentation
+
 ## [2.0.0] - 2020.10.19
 
 ### Fixed
 
-SMTP connection errors: invalid `HELO` hostname (`localhost`), duplicate `HELO` (`verifier domain`).
+SMTP connection errors: invalid `HELO` hostname (`localhost`), duplicate `HELO` (`verifier domain`). Thanks to [@nenoganchev](https://github.com/nenoganchev) for report.
 
 ### Changed
 
@@ -14,7 +84,7 @@ SMTP connection errors: invalid `HELO` hostname (`localhost`), duplicate `HELO`
 - Updated `Truemail::Validate::Smtp::Request#session_data`
 - Updated `Truemail::Validate::Smtp::Response`
 
-Now `helo` is a `Boolean` instead of `Net::SMTP::Response` instance. It was changed because `helo` is sending during SMTP-session initializing (`Net::SMTP.new.start`), and `helo` is always `true` if session up is okay. Also `hello` response won't logged as error if it happens. Example of `Truemail::Validate::Smtp::Response` instance from 1.9.3 version.
+Now `helo` is a `Boolean` instead of `Net::SMTP::Response` instance. It was changed because `helo` is sending during SMTP-session initializing (`Net::SMTP.new.start`), and `helo` is always `true` if session up is okay. Also `hello` response won't logged as error if it happens. Example of `Truemail::Validate::Smtp::Response` instance from 2.x version.
 
 ```ruby
 #<struct Truemail::Validate::Smtp::Response:0x00007fa74704cd10
@@ -379,6 +449,7 @@ Truemail.validate('email@white-domain.com', with: :regex)
     smtp_debug=nil>,
   @validation_type=:regex>
 ```
+
 **Email hasn't whitelisted domain**
 
 ```ruby
@@ -406,7 +477,7 @@ Truemail.validate('email@domain.com', with: :regex)
 
 - Configurable default validation type, [issue details](https://github.com/truemail-rb/truemail/issues/48)
 
-You can predefine default validation type for ```Truemail.validate('email@email.com')``` call without with-parameter. Available validation types: ```:regex```, ```:mx```, ```:smtp```. By default validation type still remains ```:smtp```
+You can predefine default validation type for `Truemail.validate('email@email.com')` call without with-parameter. Available validation types: `:regex`, `:mx`, `:smtp`. By default validation type still remains `:smtp`
 
 ```ruby
 Truemail.configure do |config|
@@ -461,7 +532,7 @@ Truemail.validate('email@black-domain.com')
 
 ### Added
 
-- Feature domain whitelist blacklist. Other validations will not processed even if it was defined in ```validation_type_for```.
+- Feature domain whitelist blacklist. Other validations will not processed even if it was defined in `validation_type_for`.
 
 ```ruby
 Truemail.configure do |config|
@@ -484,7 +555,7 @@ Truemail.configuration.blacklisted_domains = ['somedomain1.com', 'somedomain2.co
 
 ### Removed
 
-- ```:skip``` validation type for ```validation_type_for```
+- `:skip` validation type for `validation_type_for`
 
 ### Fixed
 
@@ -499,7 +570,7 @@ Truemail.configuration.blacklisted_domains = ['somedomain1.com', 'somedomain2.co
 
 ### Added
 
-- skip validation by domain for validation_type_for configuration option:
+- skip validation by domain for `validation_type_for` configuration option:
 
 ```ruby
 Truemail.configure do |config|
@@ -581,11 +652,11 @@ Truemail.configuration.validation_type_for = { 'somedomain.com' => :skip }
 
 ### Added
 
-- Retries for ```Truemail::Validate::Smtp``` for cases when one mx server
+- Retries for `Truemail::Validate::Smtp` for cases when one mx server
 
 ### Changed
 
-- ```Truemail::Configuration``` class, please use ```.connection_attempts``` instead ```.retry_count```
+- `Truemail::Configuration` class, please use `.connection_attempts` instead `.retry_count`
 - `Truemail::VERSION`
 - gem documentation
 
@@ -593,12 +664,12 @@ Truemail.configuration.validation_type_for = { 'somedomain.com' => :skip }
 
 ### Added
 
-- Checking A record presence if ```MX``` and ```CNAME``` records not exist, [issue details](https://github.com/truemail-rb/truemail/issues/10)
-- Handling of ```CNAME``` records, [issue details](https://github.com/truemail-rb/truemail/issues/11)
-- Checking A record if ```MX``` and ```CNAME``` records not found, [issue details](https://github.com/truemail-rb/truemail/issues/12)
+- Checking A record presence if `MX` and `CNAME` records not exist, [issue details](https://github.com/truemail-rb/truemail/issues/10)
+- Handling of `CNAME` records, [issue details](https://github.com/truemail-rb/truemail/issues/11)
+- Checking A record if `MX` and `CNAME` records not found, [issue details](https://github.com/truemail-rb/truemail/issues/12)
 - Supporting of multihomed MX records, conversion host names to ips, [issue details](https://github.com/truemail-rb/truemail/issues/17)
 - Timeout configuration for DNS resolver, [issue details](https://github.com/truemail-rb/truemail/issues/13)
-- ```.valid?``` helper
+- `.valid?` helper
 
 ### Changed
 
@@ -609,14 +680,14 @@ Truemail.configuration.validation_type_for = { 'somedomain.com' => :skip }
 
 ### Added
 
-- Independent domain name extractor to ```Truemail::Validate::Mx#run```
+- Independent domain name extractor to `Truemail::Validate::Mx#run`
 
 ### Fixed
 
-- Default ```REGEX_EMAIL_PATTERN```, [issue details](https://github.com/truemail-rb/truemail/issues/7)
+- Default `REGEX_EMAIL_PATTERN`, [issue details](https://github.com/truemail-rb/truemail/issues/7)
   * local part of address can't start with a dot or special symbol
   * local part of address can include ```+``` symbol
-- Default ```REGEX_DOMAIN_PATTERN```, [issue details](https://github.com/truemail-rb/truemail/issues/8)
+- Default `REGEX_DOMAIN_PATTERN`, [issue details](https://github.com/truemail-rb/truemail/issues/8)
   * TLD size increased up to 63 characters
 - Case sensitive domain names, [issue details](https://github.com/truemail-rb/truemail/issues/9)