truemail 1.9.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17a5737519f8156df119dc22788dc19ec53ada84a936806bf55997264450c033
-  data.tar.gz: cf291777e0a45707d9e7e6fb3f27e511600817470262f49a046c5c0af4c7ec36
+  metadata.gz: 6345fef51d5f38efde3065b8edb6d777f7c0cf9aec7a44b073da86bce5943c6a
+  data.tar.gz: 6e55b56b4cb92143059ccd3263739e724ea29f118943546d6464af248951d0c6
 SHA512:
-  metadata.gz: 7e9cf660b90669fc65eb5482d571278627602c89e62818b01947f79a7376b4de41fa78bf46aa0b72a0b1194d1d19a4fb34f647d241f295b08e9a36603c18cb0e
-  data.tar.gz: 66986df4338a41c7e5145cca47c3765983fcb04c50e76940ca5dcaec43cb70e6fec5889d8e2d680ac3a8236086d0b2d46d26e498030e8d17a115327ac1fae596
+  metadata.gz: 451d5ee34a5eb52e5451017210bf6c4c5fe213f44cf7bc8b66221ab31fa202c682ecad99f810c571f430f4da0fa0c981958db694e929407ad268201bb60c0652
+  data.tar.gz: 4210cf723bd90843ccf7d806b07563b4eff7bece40d361e35897316bb5c779eedd8a82e60d46948a0f419ea9ee5ed2bfc80fc67a4384dcc47de85d25326609ac

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-89
+    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,26 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: [BUG]
+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)
+
+### 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,25 @@
+---
+name: Feature request
+about: Suggest an idea for Truemail
+title: [FEATURE]
+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)
+
+### 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,22 @@
+---
+name: Issue report
+about: Create a report to help us improve
+title: [ISSUE]
+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 read the [documentation](https://github.com/rubygarage/truemail/blob/master/README.md)
-- [ ] I have searched for [existing GitHub issues](https://github.com/rubygarage/truemail/issues)
+- [ ] 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
+### 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,20 @@
+---
+name: Question
+about: Ask your question to Truemail team
+title: [QUESTION]
+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)
+
+### 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

@@ -39,6 +39,7 @@ detectors:
       - Truemail::Validate::Mx#a_record
       - Truemail::Audit::Base#verifier_domain
       - Truemail::Configuration#domain_matcher
+      - Truemail::Configuration#logger_options
       - Truemail::Log::Serializer::Base#errors
 
   ControlParameter:

data/.rubocop.yml

@@ -103,6 +103,39 @@ Style/SlicingWithRange:
 Style/StringConcatenation:
   Enabled: true
 
+Style/CombinableLoops:
+  Enabled: true
+
+Style/KeywordParametersOrder:
+  Enabled: true
+
+Style/RedundantSelfAssignment:
+  Enabled: true
+
+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
 
@@ -131,6 +164,9 @@ Layout/SpaceAroundMethodCallOperator:
 Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
 
+Layout/BeginEndAlignment:
+  Enabled: true
+
 Lint/NonDeterministicRequireOrder:
   Enabled: false
 
@@ -176,6 +212,54 @@ Lint/TopLevelReturnWithArgument:
 Lint/UnreachableLoop:
   Enabled: true
 
+Lint/ConstantDefinitionInBlock:
+  Enabled: true
+
+Lint/DuplicateRequire:
+  Enabled: true
+
+Lint/EmptyFile:
+  Enabled: true
+
+Lint/IdentityComparison:
+  Enabled: true
+
+Lint/TrailingCommaInAttributeDeclaration:
+  Enabled: true
+
+Lint/UselessMethodDefinition:
+  Enabled: true
+
+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
 
@@ -200,6 +284,9 @@ Performance/Squeeze:
 Performance/StringInclude:
   Enabled: true
 
+Performance/Sum:
+  Enabled: true
+
 RSpec/ExampleLength:
   Enabled: false
 
@@ -226,3 +313,6 @@ RSpec/MultipleDescribes:
 
 RSpec/MultipleMemoizedHelpers:
   Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false

data/CHANGELOG.md

@@ -2,9 +2,72 @@
 
 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.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
+
+- `Truemail::TypeError`
+- error handling for invalid types as input email
+
+### Changed
+
+- Updated `Truemail.validate`
+- Updated `Truemail.valid?`
+
+## [1.9.1] - 2020.09.21
+
+### Changed
+
+Migrated to updated Ruby 2.7.x syntax.
+
+- Updated `Truemail::Configuration#logger=`
+
 ## [1.9.0] - 2020.09.01
 
-## Added
+### Added
 
 - Ability to use `Truemail::Auditor` instance represented as json directly
 - `Truemail::Log::Serializer::AuditorJson`
@@ -42,7 +105,7 @@ Truemail.host_audit.as_json
 
 ## [1.8.0] - 2020.06.21
 
-## Added
+### Added
 
 Separated audit features for verifier host.
 
@@ -89,7 +152,7 @@ Truemail.host_audit
 
 ## [1.7.1] - 2020.05.10
 
-## Added
+### Added
 
 - Ability to show `not_rfc_mx_lookup_flow` attribute in serialized validation result
 
@@ -137,7 +200,7 @@ Truemail.validate('nonexistent_email@bestweb.com.ua').as_json
 
 ## [1.7.0] - 2020.05.09
 
-## Added
+### Added
 
 - Ability to use not RFC MX lookup flow (MX and Null MX records will be checked on the DNS validation layer only)
 
@@ -335,6 +398,7 @@ Truemail.validate('email@white-domain.com', with: :regex)
     smtp_debug=nil>,
   @validation_type=:regex>
 ```
+
 **Email hasn't whitelisted domain**
 
 ```ruby
@@ -360,9 +424,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|
@@ -417,7 +481,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|
@@ -440,7 +504,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
 
@@ -455,7 +519,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|
@@ -478,7 +542,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
 
@@ -495,11 +559,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
 
@@ -510,7 +574,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
 
@@ -521,12 +585,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
 
@@ -537,11 +601,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
 
@@ -549,12 +613,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
 
@@ -565,16 +629,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
 
@@ -621,10 +685,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"}>>,]>,