truemail 1.9.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caf982d3dd889a337ae95ab4d4fa79157964e02d83656016ecead8d0831c4d46
-  data.tar.gz: 9b7ec050811c49072d18f7cd9e36229b982af742f24db3a031d4ab1e2e08f780
+  metadata.gz: ccc592c306e3cb61ae0b64e88204a5d464d614abb842bc6538112a19acca812a
+  data.tar.gz: f61ebb1883ff711a1816c3f6523c1ab2f4ffa11b13782011d4d42f9204a4e298
 SHA512:
-  metadata.gz: d8991eb0d33e2aaff25fdbe9fc95b45e8ee6e0c2661b9c82e622eca182f22570b01f27848b60353bf1ce70419c94cbe23cd51871872e0f92f624676d8a0c317c
-  data.tar.gz: 7b8e1b24a90019bf21cb1534f64962ba8b68fe8fd6734a564d57c69fbf483c8e35a14bfd35317c58023f6f54616cad591439ac6eddef878604522d929dd6e42a
+  metadata.gz: 640d6769aee1f4fde2d525253d3096a99866ecd190ad1e3f5ddb77c4105908f97a7cd3468fb65d97363291ec3931cc4802f25673e696ffee6d028000f8d5edff
+  data.tar.gz: 21e63e9a6b6e17b830569a64ddb563264e8ff1a5a4ab6ac22da21169bd331474ae2e467765a196d36b5bafd5ef40867cf4baf74b3861cab967c24bfd457d4a73

data/.circleci/config.yml

@@ -3,7 +3,7 @@ defaults: &defaults
   docker:
     - image: circleci/ruby:2.5.0-node
   environment:
-    CC_TEST_REPORTER_ID: a98d23d6d916932ae11dbe5df36dee070173cbe376b68758901dcc289e098979
+    CC_TEST_REPORTER_ID: 693272a1328521f6f7c09d7ffd419b21c00410da26e98e94c687fdd38b26e2cb
 
 references:
   restore_bundle_cache: &restore_bundle_cache

data/.codeclimate.yml

@@ -7,7 +7,7 @@ checks:
 plugins:
   rubocop:
     enabled: true
-    channel: rubocop-0-91
+    channel: rubocop-1-3
 
   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 read the [Contribution Guidelines](https://github.com/rubygarage/truemail/blob/master/CONTRIBUTING.md)
+- [ ] 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/rubygarage/truemail/issues)
+- [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail/issues)
+
+<!-- Please use next pattern for your issue report title: [ISSUE] Your issue report title here -->
 
-### Issue Description
+### 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
 
@@ -40,7 +43,7 @@
 - [ ] My code follows the code style of this project
 - [ ] My change requires a change to the documentation
 - [ ] I have updated the documentation accordingly
-- [ ] I have read the [**CONTRIBUTING** document](https://github.com/rubygarage/truemail/blob/master/CONTRIBUTING.md)
+- [ ] I have read the [**CONTRIBUTING** document](https://github.com/truemail-rb/truemail/blob/master/CONTRIBUTING.md)
 - [ ] I have added tests to cover my changes
 - [ ] I have run `bundle exec rspec` from the root directory to see all new and existing tests pass
 - [ ] I have run `rubocop` and `reek` to ensure the code style is valid

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
 

data/.rubocop.yml

@@ -115,6 +115,27 @@ 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
+
 Layout/LineLength:
   Max: 140
 
@@ -212,6 +233,33 @@ 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
+
 Performance/AncestorsInclude:
   Enabled: true
 
@@ -265,3 +313,6 @@ RSpec/MultipleDescribes:
 
 RSpec/MultipleMemoizedHelpers:
   Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,83 @@
 
 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.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`). Thanks to [@nenoganchev](https://github.com/nenoganchev) for report.
+
+### Changed
+
+- Updated `Truemail::Validate::Smtp::Request#run`
+- 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 2.x version.
+
+```ruby
+#<struct Truemail::Validate::Smtp::Response:0x00007fa74704cd10
+  port_opened=true,
+  connection=true,
+  helo=true, # Returns Boolean instead of Net::SMTP::Response instance
+  mailfrom=false,
+  rcptto=nil,
+  errors={:mailfrom=>"server response timeout"}>
+```
+
 ## [1.9.2] - 2020.10.02
 
 ### Added
@@ -355,6 +432,7 @@ Truemail.validate('email@white-domain.com', with: :regex)
     smtp_debug=nil>,
   @validation_type=:regex>
 ```
+
 **Email hasn't whitelisted domain**
 
 ```ruby
@@ -380,9 +458,9 @@ Truemail.validate('email@domain.com', with: :regex)
 
 ### Added
 
-- Configurable default validation type, [issue details](https://github.com/rubygarage/truemail/issues/48)
+- 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|
@@ -437,7 +515,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|
@@ -460,7 +538,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
 
@@ -475,7 +553,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|
@@ -498,7 +576,7 @@ Truemail.configuration.validation_type_for = { 'somedomain.com' => :skip }
 
 ### Added
 
-- SMTP error body configurable option, [issue details](https://github.com/rubygarage/truemail/issues/19)
+- SMTP error body configurable option, [issue details](https://github.com/truemail-rb/truemail/issues/19)
 
 ### Changed
 
@@ -515,11 +593,11 @@ Truemail.configuration.validation_type_for = { 'somedomain.com' => :skip }
 
 ### Added
 
-- Reverse trace, [issue details](https://github.com/rubygarage/truemail/issues/18)
+- Reverse trace, [issue details](https://github.com/truemail-rb/truemail/issues/18)
 
 ### Fixed
 
-- Behaviour of current host address resolver, [issue details](https://github.com/rubygarage/truemail/issues/18)
+- Behaviour of current host address resolver, [issue details](https://github.com/truemail-rb/truemail/issues/18)
 
 ### Changed
 
@@ -530,7 +608,7 @@ Truemail.configuration.validation_type_for = { 'somedomain.com' => :skip }
 
 ### Added
 
-- PTR record audit, [issue details](https://github.com/rubygarage/truemail/issues/18)
+- PTR record audit, [issue details](https://github.com/truemail-rb/truemail/issues/18)
 
 ### Changed
 
@@ -541,12 +619,12 @@ Truemail.configuration.validation_type_for = { 'somedomain.com' => :skip }
 
 ### Added
 
-- MX gem logic with [RFC 7505](https://tools.ietf.org/html/rfc7505), null MX record supporting, [issue details](https://github.com/rubygarage/truemail/issues/27)
+- MX gem logic with [RFC 7505](https://tools.ietf.org/html/rfc7505), null MX record supporting, [issue details](https://github.com/truemail-rb/truemail/issues/27)
 - [Contributing guideline](CONTRIBUTING.md)
 
 ### Fixed
 
-- Multihomed MX records supporting, [issue details](https://github.com/rubygarage/truemail/issues/28)
+- Multihomed MX records supporting, [issue details](https://github.com/truemail-rb/truemail/issues/28)
 
 ### Changed
 
@@ -557,11 +635,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
 
@@ -569,12 +647,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/rubygarage/truemail/issues/10)
-- Handling of ```CNAME``` records, [issue details](https://github.com/rubygarage/truemail/issues/11)
-- Checking A record if ```MX``` and ```CNAME``` records not found, [issue details](https://github.com/rubygarage/truemail/issues/12)
-- Supporting of multihomed MX records, conversion host names to ips, [issue details](https://github.com/rubygarage/truemail/issues/17)
-- Timeout configuration for DNS resolver, [issue details](https://github.com/rubygarage/truemail/issues/13)
-- ```.valid?``` helper
+- 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
 
 ### Changed
 
@@ -585,16 +663,16 @@ 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/rubygarage/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/rubygarage/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/rubygarage/truemail/issues/9)
+- Case sensitive domain names, [issue details](https://github.com/truemail-rb/truemail/issues/9)
 
 ### Changed
 
@@ -641,10 +719,7 @@ Truemail.validate('email@example.com')
                 #<struct Truemail::Validate::Smtp::Response
                   port_opened=true,
                   connection=false,
-                  helo=
-                    #<Net::SMTP::Response:0x0000000002c934c8
-                    @status="250",
-                    @string="250 mx1.example.com\n">,
+                  helo=true,
                   mailfrom=false,
                   rcptto=nil,
                   errors={:mailfrom=>"554 5.7.1 Client host blocked\n", :connection=>"server dropped connection after response"}>>,]>,