truemail 1.6.1 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31b9d354c841d370094f66ba22e481aded3501b0b17206b61eeb1c768d756ea1
-  data.tar.gz: dbe57fe9cdc4763b4fc60c75aaf313aa1dd4ddff2cb5f60c1af9b3a6caddb659
+  metadata.gz: 4132e99e612c8a1f9309dd9b81ef2ce5c234296209d631411687a4622c8581d2
+  data.tar.gz: 360800f323194eaefa48592f4781ce232d9e205785b6eaea15fc22b8b6d28d24
 SHA512:
-  metadata.gz: 3e319f8eeaadba558bc79173fb5765c615c0b67112d49b45eeaee07b3c3f496019eb89ebb95f736c0413eb08d0e7b1b1b6579389bd02e13c33464eefef8aaa82
-  data.tar.gz: 4093fc875a8363d7fe7211c0d1e698ac081c80ff63e8a01e3fc7bef913a65b71743afbc47f0de7eaa4d203f32e3560b40336b5d311b48449dde6542c9c8e9164
+  metadata.gz: 2786a16f5e4418cf704c1cc3eba5b4879072ed17e4a6a36180cb5994a8a824e7e492de4ec211c729783653e783538435f7b799b7f17d847d957511ba6a091687
+  data.tar.gz: 4ecc2dcfd6377826852e64f59471aa2c70fe84be8739d1b20e73350beffc9b4e932b4fac62c48869850d8a28157aeb7756238964d3126e62026ff7f79a999edb

data/.codeclimate.yml

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

data/.reek.yml

@@ -26,6 +26,7 @@ detectors:
   Attribute:
     exclude:
       - Truemail::Configuration#whitelist_validation
+      - Truemail::Configuration#not_rfc_mx_lookup_flow
       - Truemail::Configuration#smtp_safe_check
       - Truemail::Wrapper#attempts
 
@@ -38,6 +39,8 @@ 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:
     exclude:
@@ -54,6 +57,8 @@ detectors:
       - Truemail::ConfigurationHelper#create_configuration
       - Truemail::Log::Serializer::Base#smtp_debug
       - Truemail::Log::Serializer::Text#data_composer
+      - Truemail::Log::Serializer::ValidatorBase#smtp_debug
+      - Truemail::Log::Serializer::ValidatorText#data_composer
 
   NilCheck:
     exclude:

data/.rubocop.yml

@@ -40,6 +40,81 @@ Style/EmptyCaseCondition:
 Style/RescueStandardError:
   Enabled: false
 
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/ExplicitBlockArgument:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/GlobalStdStream:
+  Enabled: true
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/OptionalBooleanParameter:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SingleArgumentDig:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/StringConcatenation:
+  Enabled: true
+
+Style/CombinableLoops:
+  Enabled: true
+
+Style/KeywordParametersOrder:
+  Enabled: true
+
+Style/RedundantSelfAssignment:
+  Enabled: true
+
+Style/SoleNestedConditional:
+  Enabled: true
+
 Layout/LineLength:
   Max: 140
 
@@ -50,15 +125,9 @@ Layout/ClassStructure:
       - include
       - prepend
       - extend
-    associations:
-      - has_one
-      - has_many
-      - belongs_to
-      - has_and_belongs_to_many
   ExpectedOrder:
       - module_inclusion
       - constants
-      - associations
       - public_class_methods
       - initializer
       - public_methods
@@ -68,9 +137,108 @@ Layout/ClassStructure:
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/BeginEndAlignment:
+  Enabled: true
+
 Lint/NonDeterministicRequireOrder:
   Enabled: false
 
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/DuplicateRescueException:
+  Enabled: true
+
+Lint/EmptyConditionalBody:
+  Enabled: true
+
+Lint/FloatComparison:
+  Enabled: true
+
+Lint/MissingSuper:
+  Enabled: false
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/SelfAssignment:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+
+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
+
+Performance/AncestorsInclude:
+  Enabled: true
+
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+
+Performance/RedundantSortBlock:
+  Enabled: true
+
+Performance/RedundantStringChars:
+  Enabled: true
+
+Performance/ReverseFirst:
+  Enabled: true
+
+Performance/SortReverse:
+  Enabled: true
+
+Performance/Squeeze:
+  Enabled: true
+
+Performance/StringInclude:
+  Enabled: true
+
+Performance/Sum:
+  Enabled: true
+
 RSpec/ExampleLength:
   Enabled: false
 
@@ -94,3 +262,6 @@ RSpec/MessageSpies:
 
 RSpec/MultipleDescribes:
   Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false

data/CHANGELOG.md

@@ -1,8 +1,175 @@
 # Changelog
+
 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.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
+
+- Ability to use `Truemail::Auditor` instance represented as json directly
+- `Truemail::Log::Serializer::AuditorJson`
+
+### Changed
+
+- `Truemail::Auditor`, `Truemail::Validator`
+- serializers namespaces
+- gem development dependencies
+- gem documentation
+
+```ruby
+Truemail.host_audit.as_json
+
+=>
+# Serialized Truemail::Auditor instance
+{
+  "date": "2020-08-31 22:33:43 +0300",
+  "current_host_ip": "127.0.0.1",
+  "warnings": {
+    "dns": "A-record of verifier domain not refers to current host ip address", "ptr": "PTR-record does not reference to current verifier domain"
+  },
+ "configuration": {
+    "validation_type_by_domain": null,
+    "whitelist_validation": false,
+    "whitelisted_domains": null,
+    "blacklisted_domains": null,
+    "not_rfc_mx_lookup_flow": false,
+    "smtp_safe_check": false,
+    "email_pattern": "default gem value",
+    "smtp_error_body_pattern": "default gem value"
+  }
+}
+```
+
+## [1.8.0] - 2020.06.21
+
+### Added
+
+Separated audit features for verifier host.
+
+- `Truemail::Audit::Ip`
+- `Truemail::Audit::Dns`
+
+```ruby
+Truemail.host_audit
+
+=> #<Truemail::Auditor:0x00005580df358828
+@result=
+  #<struct Truemail::Auditor::Result
+    current_host_ip="127.0.0.1",
+    warnings={
+      :dns=>"a record of verifier domain not refers to current host ip address",
+      :ptr=>"ptr record does not reference to current verifier domain"
+    },
+    configuration=
+    #<Truemail::Configuration:0x00005615e86327a8
+      @blacklisted_domains=[],
+      @connection_attempts=2,
+      @connection_timeout=2,
+      @default_validation_type=:smtp,
+      @email_pattern=/(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@((?i-mx:[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}))\z)/,
+      @response_timeout=2,
+      @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i,
+      @not_rfc_mx_lookup_flow=false,
+      @smtp_safe_check=false,
+      @validation_type_by_domain={},
+      @verifier_domain="example.com",
+      @verifier_email="verifier@example.com",
+      @whitelist_validation=false,
+      @whitelisted_domains=[]>
+```
+
+### Changed
+
+- `Truemail::Auditor`
+- `Truemail::Auditor::Result`
+- `Truemail::Audit::Base`
+- `Truemail::Audit::Ptr`
+- `Truemail::VERSION`
+- gem documentation
+
+## [1.7.1] - 2020.05.10
+
+### Added
+
+- Ability to show `not_rfc_mx_lookup_flow` attribute in serialized validation result
+
+```ruby
+Truemail.validate('nonexistent_email@bestweb.com.ua').as_json
+
+=>
+# Serialized Truemail::Validator instance
+{
+  "date": "2020-05-10 10:00:00 +0200",
+  "email": "nonexistent_email@bestweb.com.ua",
+  "validation_type": "smtp",
+  "success": false,
+  "errors": {
+    "smtp": "smtp error"
+  },
+  "smtp_debug": [
+    {
+      "mail_host": "213.180.193.89",
+      "port_opened": true,
+      "connection": true,
+      "errors": {
+        "rcptto": "550 5.7.1 No such user!\n"
+      }
+    }
+  ],
+  "configuration": {
+    "validation_type_by_domain": null,
+    "whitelist_validation": false,
+    "whitelisted_domains": null,
+    "blacklisted_domains": null,
+    "not_rfc_mx_lookup_flow": false,
+    "smtp_safe_check": false,
+    "email_pattern": "default gem value",
+    "smtp_error_body_pattern": "default gem value"
+  }
+}
+```
+
+### Changed
+
+- `Truemail::Log::Serializer::Base`
+- `Truemail::VERSION`
+- gem documentation
+
+## [1.7.0] - 2020.05.09
+
+### Added
+
+- Ability to use not RFC MX lookup flow (MX and Null MX records will be checked on the DNS validation layer only)
+
+```ruby
+Truemail.configure do |config|
+  # Optional parameter. This option will provide to use not RFC MX lookup flow.
+  # It means that MX and Null MX records will be cheked on the DNS validation layer only.
+  # By default this option is disabled.
+  config.not_rfc_mx_lookup_flow = true
+end
+```
+
+### Changed
+
+- `Truemail.configuration`
+- `Truemail::Validate::Mx`
+- `Truemail::VERSION`
+- gem development dependencies
+- gem documentation
+
 ## [1.6.1] - 2020.03.23
+
 ### Changed
+
 - `Truemail.configuration`
 - `Truemail::ArgumentError`
 - `Truemail::Audit::Ptr`
@@ -11,26 +178,35 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - gem documentation
 
 ### Removed
+
 `Truemail::Configuration.retry_count` deprecated, and alias for this method has been removed. Please use `Truemail::Configuration.connection_attempts` instead.
 
 ## [1.6.0] - 2020-02-01
+
 ### Added
-- Possibility to use `Truemail::Validator` instance represented as json directly
+
+- Ability to use `Truemail::Validator` instance represented as json directly
 
 ### Changed
+
 - gem development dependencies
 - gem documentation
 
 ## [1.5.1] - 2020-01-20
+
 ### Changed
+
 - gem development dependencies
 - gem documentation
 
 ## [1.5.0] - 2019-12-29
+
 ### Added
+
 - Supporting of internationalized emails ([EAI](https://en.wikipedia.org/wiki/International_email)). Now you can validate emails, like: `dörte@sörensen.de`, `квіточка@пошта.укр`, `alegría@mañana.es`
 
 ### Changed
+
 - `Truemail::RegexConstant::REGEX_DOMAIN`
 - `Truemail::RegexConstant::REGEX_EMAIL_PATTERN`
 - `Truemail::Validator::Result`
@@ -42,22 +218,29 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - linters configs
 
 ## [1.4.2] - 2019-11-27
+
 ### Changed
+
 - `Truemail::Configuration`
 - gem development dependencies
 - linters configs
 
 ## [1.4.1] - 2019-11-20
+
 ### Changed
+
 - gem development dependencies
 - gem documentation
 - linters configs
 
 ### Removed
+
 - truemail rspec helpers (moved to independent gem [`truemail-rspec`](https://github.com/truemail-rb/truemail-rspec))
 
 ## [1.4.0] - 2019-10-28
+
 ### Added
+
 - Event logger (ability to output validation logs to stdout/file)
 - JSON serializer for validator instance
 - [Changelog](CHANGELOG.md)
@@ -85,6 +268,7 @@ Truemail::Log::Serializer::Json.call(Truemail.validate('nonexistent_email@bestwe
 ```
 
 ### Changed
+
 - `Truemail::Configuration`
 - `Truemail::Validator`
 - `Truemail::Validate::Regex`
@@ -93,11 +277,14 @@ Truemail::Log::Serializer::Json.call(Truemail.validate('nonexistent_email@bestwe
 - gem description
 
 ## [1.3.0] - 2019-09-16
+
 ### Added
+
 - Ability to create new `Truemail::Configuration` instance with block
 - `Truemail::Validate::Smtp::Request::Configuration`
 
 ### Changed
+
 - `Truemail::Wrapper`
 - `Truemail::Validate::Base`
 - `Truemail::Validator`
@@ -115,15 +302,20 @@ Truemail::Log::Serializer::Json.call(Truemail.validate('nonexistent_email@bestwe
 - gem description
 
 ## [1.2.1] - 2019-06-27
+
 ### Fixed
+
 - Removed memoization from ```DomainListMatch#whitelisted_domain?```
 
 ### Changed
+
 - `Truemail::VERSION`
 - gem documentation
 
 ## [1.2.0] - 2019-06-26
+
 ### Added
+
 - Configurable option: validation for whitelisted domains only.
 
 When email domain in whitelist and ```whitelist_validation``` is sets equal to ```true``` validation type will be passed to other validators. Validation of email which not contains whitelisted domain always will return ```false```.
@@ -168,11 +360,14 @@ Truemail.validate('email@domain.com', with: :regex)
 ```
 
 ### Changed
+
 - `Truemail::VERSION`
 - gem documentation
 
 ## [1.1.0] - 2019-06-18
+
 ### Added
+
 - Configurable default validation type, [issue details](https://github.com/rubygarage/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```
@@ -185,11 +380,14 @@ end
 ```
 
 ### Changed
+
 - `Truemail::VERSION`
 - gem documentation
 
 ## [1.0.1] - 2019-06-08
+
 ### Added
+
 - Result validation type marker for domain list match check
 
 ```ruby
@@ -219,11 +417,14 @@ Truemail.validate('email@black-domain.com')
 ```
 
 ### Changed
+
 - `Truemail::VERSION`
 - gem documentation
 
 ## [1.0] - 2019-06-04
+
 ### Added
+
 - Feature domain whitelist blacklist. Other validations will not processed even if it was defined in ```validation_type_for```.
 
 ```ruby
@@ -237,6 +438,7 @@ Truemail.configure do |config|
   config.blacklisted_domains = ['somedomain1.com', 'somedomain2.com']
 end
 ```
+
 and
 
 ```ruby
@@ -245,17 +447,22 @@ Truemail.configuration.blacklisted_domains = ['somedomain1.com', 'somedomain2.co
 ```
 
 ### Removed
+
 - ```:skip``` validation type for ```validation_type_for```
 
 ### Fixed
+
 - error key in `lower_snake_case`
 
 ### Changed
+
 - `Truemail::VERSION`
 - gem documentation
 
 ## [0.2] - 2019-05-23
+
 ### Added
+
 - skip validation by domain for validation_type_for configuration option:
 
 ```ruby
@@ -263,68 +470,93 @@ Truemail.configure do |config|
   config.validation_type_for = { 'somedomain.com' => :skip }
 end
 ```
+
 and
+
 ```ruby
 Truemail.configuration.validation_type_for = { 'somedomain.com' => :skip }
 ```
+
 ### Changed
+
 - `Truemail::VERSION`
 - gem documentation
 
 ## [0.1.10] - 2019-05-10
+
 ### Added
+
 - SMTP error body configurable option, [issue details](https://github.com/rubygarage/truemail/issues/19)
 
 ### Changed
+
 - `Truemail::VERSION`
 - gem documentation
 
 ## [0.1.9] - 2019-04-29
+
 ### Fixed
+
 - Empty ptr constant
 
 ## [0.1.8] - 2019-04-29
+
 ### Added
+
 - Reverse trace, [issue details](https://github.com/rubygarage/truemail/issues/18)
 
 ### Fixed
+
 - Behaviour of current host address resolver, [issue details](https://github.com/rubygarage/truemail/issues/18)
 
 ### Changed
+
 - `Truemail::VERSION`
 - gem documentation
 
 ## [0.1.7] - 2019-04-17
+
 ### Added
+
 - PTR record audit, [issue details](https://github.com/rubygarage/truemail/issues/18)
 
 ### Changed
+
 - `Truemail::VERSION`
 - gem documentation
 
 ## [0.1.6] - 2019-04-08
+
 ### 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)
 - [Contributing guideline](CONTRIBUTING.md)
 
 ### Fixed
+
 - Multihomed MX records supporting, [issue details](https://github.com/rubygarage/truemail/issues/28)
 
 ### Changed
+
 - `Truemail::VERSION`
 - gem documentation
 
 ## [0.1.5] - 2019-04-05
+
 ### Added
+
 - Retries for ```Truemail::Validate::Smtp``` for cases when one mx server
 
 ### Changed
+
 - ```Truemail::Configuration``` class, please use ```.connection_attempts``` instead ```.retry_count```
 - `Truemail::VERSION`
 - gem documentation
 
 ## [0.1.4] - 2019-04-01
+
 ### 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)
@@ -333,14 +565,18 @@ Truemail.configuration.validation_type_for = { 'somedomain.com' => :skip }
 - ```.valid?``` helper
 
 ### Changed
+
 - `Truemail::VERSION`
 - gem documentation
 
 ## [0.1.3] - 2019-03-27
+
 ### Added
+
 - Independent domain name extractor to ```Truemail::Validate::Mx#run```
 
 ### Fixed
+
 - Default ```REGEX_EMAIL_PATTERN```, [issue details](https://github.com/rubygarage/truemail/issues/7)
   * local part of address can't start with a dot or special symbol
   * local part of address can include ```+``` symbol
@@ -349,11 +585,14 @@ Truemail.configuration.validation_type_for = { 'somedomain.com' => :skip }
 - Case sensitive domain names, [issue details](https://github.com/rubygarage/truemail/issues/9)
 
 ### Changed
+
 - `Truemail::VERSION`
 - gem documentation
 
 ## [0.1.0] - 2019-03-26
+
 ### Added
+
 - 'SMTP safe check' option for cases when SMTP server does not return an exact answer that the email does not exist.
 
 ```ruby
@@ -401,5 +640,6 @@ Truemail.validate('email@example.com')
 ```
 
 ### Changed
+
 - `Truemail::VERSION`
 - gem documentation