diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..c46f92e --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,17 @@ + + +### New Issue Checklist + +- [ ] I have updated truemail to the latest version +- [ ] I have read the [Contribution Guidelines](CONTRIBUTING.md) +- [ ] I have read the [documentation](README.md) +- [ ] I have searched for [existing GitHub issues](https://github.com/rubygarage/truemail/issues) + +### Issue Description + + +##### Complete output when running truemail, including the stack trace and command used + +
+ 
[INSERT OUTPUT HERE]
+
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..a0413b7 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,46 @@ +# PR Details + + + +## Description + + + +## Related Issue + + + + + + +## Motivation and Context + + + +## How Has This Been Tested + + + + + +## Types of changes + + + +- [ ] Docs change / refactoring / dependency upgrade +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist + + + + +- [ ] 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](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 diff --git a/.reek.yml b/.reek.yml index d69aa73..7b9083b 100644 --- a/.reek.yml +++ b/.reek.yml @@ -27,7 +27,7 @@ detectors: exclude: - Truemail::Validate::Smtp::Request#compose_from - Truemail::Validator#select_validation_type - - Truemail::Validate::Mx#mx_records + - Truemail::Validate::Mx#null_mx? ControlParameter: exclude: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a3b4fd7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,43 @@ +# Contributing to Truemail + +Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved. + +Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features. + +## Using the issue tracker + +The issue tracker is the preferred channel for [bug reports](#bugs), [features requests](#features) and [submitting pull requests](#pull-requests). + + +## Bug/issue reports + +A bug is a _demonstrable problem_ that is caused by the code in the repository. +Good bug reports are extremely helpful - thank you! + +Guidelines for bug reports: + +1. **Use the GitHub issue search** — check if the issue has already been reported. +2. **Check if the issue has been fixed** — try to reproduce it using the latest `master` or development branch in the repository. + +A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What would you expect to be the outcome? All these details will help people to fix any potential bugs. + + +## Feature requests + +Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to *you* to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible. + + +## Pull requests + +Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits. + +**Please ask first** before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project. + +Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage). Not all features proposed will be added but we are open to having a conversation about a feature you are championing. + +Guidelines for pull requests: + +1. Fork the repo. +2. Run the tests. This is to make sure your starting point works. Tests can be run via ```rspec``` +3. Create a new branch and make your changes. This includes tests for features! +4. Push to your fork and submit a pull request. diff --git a/Gemfile.lock b/Gemfile.lock index f0f2eb2..4d77e6e 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - truemail (0.1.5) + truemail (0.1.6) GEM remote: https://rubygems.org/ diff --git a/README.md b/README.md index 26b5d77..019a97e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Truemail -[![Maintainability](https://api.codeclimate.com/v1/badges/657aa241399927dcd2e2/maintainability)](https://codeclimate.com/github/rubygarage/truemail/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/657aa241399927dcd2e2/test_coverage)](https://codeclimate.com/github/rubygarage/truemail/test_coverage) [![Gem Version](https://badge.fury.io/rb/truemail.svg)](https://badge.fury.io/rb/truemail) [![CircleCI](https://circleci.com/gh/rubygarage/truemail/tree/master.svg?style=svg)](https://circleci.com/gh/rubygarage/truemail/tree/master) +[![Maintainability](https://api.codeclimate.com/v1/badges/657aa241399927dcd2e2/maintainability)](https://codeclimate.com/github/rubygarage/truemail/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/657aa241399927dcd2e2/test_coverage)](https://codeclimate.com/github/rubygarage/truemail/test_coverage) [![Gem Version](https://badge.fury.io/rb/truemail.svg)](https://badge.fury.io/rb/truemail) [![CircleCI](https://circleci.com/gh/rubygarage/truemail/tree/master.svg?style=svg)](https://circleci.com/gh/rubygarage/truemail/tree/master) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) The Truemail gem helps you validate emails by regex pattern, presence of domain mx-records, and real existence of email account on a current email server. @@ -170,7 +170,7 @@ require 'truemail' Truemail.configure do |config| config.verifier_email = 'verifier@example.com' - config.config.email_pattern = /regex_pattern/ + config.email_pattern = /regex_pattern/ end Truemail.validate('email@example.com', with: :regex) @@ -195,7 +195,7 @@ Validation by MX records is the second validation level. It uses Regex validatio [Regex validation] -> [MX validation] ``` -Truemail MX validation performs strictly following the [RFC 5321](https://tools.ietf.org/html/rfc5321#section-5) standard. +Please note, Truemail MX validator not performs strict compliance of the [RFC 5321](https://tools.ietf.org/html/rfc5321#section-5) standard for best validation outcome. Example of usage: @@ -419,7 +419,7 @@ end ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/rubygarage/truemail. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +Bug reports and pull requests are welcome on GitHub at https://github.com/rubygarage/truemail. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. Please check the [open tikets](https://github.com/rubygarage/truemail/issues). Be shure to follow Contributor Code of Conduct below and our [Contributing Guidelines](CONTRIBUTING.md). ## License @@ -427,7 +427,11 @@ The gem is available as open source under the terms of the [MIT License](https:/ ## Code of Conduct -Everyone interacting in the Truemail project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/truemail/blob/master/CODE_OF_CONDUCT.md). +Everyone interacting in the Truemail project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md). + +## Versioning + +Truemail uses [Semantic Versioning 2.0.0](https://semver.org) --- RubyGarage Logo diff --git a/lib/truemail/validate/base.rb b/lib/truemail/validate/base.rb index f99affe..a009c6a 100644 --- a/lib/truemail/validate/base.rb +++ b/lib/truemail/validate/base.rb @@ -22,6 +22,10 @@ def success(condition) def add_error(message) result.errors[self.class.name.split('::').last.downcase.to_sym] = message end + + def mail_servers + result.mail_servers + end end end end diff --git a/lib/truemail/validate/mx.rb b/lib/truemail/validate/mx.rb index 89857ae..ca385cf 100644 --- a/lib/truemail/validate/mx.rb +++ b/lib/truemail/validate/mx.rb @@ -6,12 +6,13 @@ class Mx < Truemail::Validate::Base require 'resolv' ERROR = 'target host(s) not found' + NULL_MX_RECORD = 'null_mx_record' def run return false unless Truemail::Validate::Regex.check(result) result.domain = result.email[Truemail::RegexConstant::REGEX_DOMAIN_FROM_EMAIL, 1] - return true if success(mx_lookup) - add_error(Truemail::Validate::Mx::ERROR) + return true if success(mx_lookup && domain_not_include_null_mx) + mail_servers.clear && add_error(Truemail::Validate::Mx::ERROR) false end @@ -28,17 +29,28 @@ def mx_lookup end def fetch_target_hosts(hosts) - result.mail_servers.push(*hosts) + mail_servers.push(*hosts) + end + + def null_mx?(domain_mx_records) + mx_record = domain_mx_records.first + domain_mx_records.one? && mx_record.preference.zero? && mx_record.exchange.to_s.empty? + end + + def domain_not_include_null_mx + !mail_servers.include?(Truemail::Validate::Mx::NULL_MX_RECORD) end def mx_records(domain) - Resolv::DNS.new.getresources(domain, Resolv::DNS::Resource::IN::MX).sort_by(&:preference).map do |mx_record| - Resolv.getaddress(mx_record.exchange.to_s) - end + domain_mx_records = Resolv::DNS.new.getresources(domain, Resolv::DNS::Resource::IN::MX) + return [Truemail::Validate::Mx::NULL_MX_RECORD] if null_mx?(domain_mx_records) + domain_mx_records.sort_by(&:preference).map do |mx_record| + Resolv.getaddresses(mx_record.exchange.to_s) + end.flatten end def mail_servers_found? - !result.mail_servers.empty? + !mail_servers.empty? end def hosts_from_mx_records? diff --git a/lib/truemail/validate/smtp.rb b/lib/truemail/validate/smtp.rb index c4ade20..4947845 100644 --- a/lib/truemail/validate/smtp.rb +++ b/lib/truemail/validate/smtp.rb @@ -29,10 +29,6 @@ def request smtp_results.last end - def mail_servers - result.mail_servers - end - def attempts @attempts ||= mail_servers.one? ? { attempts: Truemail.configuration.connection_attempts } : {} diff --git a/lib/truemail/version.rb b/lib/truemail/version.rb index 2535d83..b1c74cd 100644 --- a/lib/truemail/version.rb +++ b/lib/truemail/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Truemail - VERSION = '0.1.5' + VERSION = '0.1.6' end diff --git a/spec/truemail/validate/mx_spec.rb b/spec/truemail/validate/mx_spec.rb index bdaaeb7..1403d8c 100644 --- a/spec/truemail/validate/mx_spec.rb +++ b/spec/truemail/validate/mx_spec.rb @@ -8,6 +8,7 @@ describe 'defined constants' do specify { expect(described_class).to be_const_defined(:ERROR) } + specify { expect(described_class).to be_const_defined(:NULL_MX_RECORD) } end describe '.check' do @@ -42,26 +43,58 @@ context 'when mx records found' do let(:mx_records_file) { "#{File.expand_path('../../', __dir__)}/support/objects/mx_records.yml" } - before do - allow(Resolv::DNS).to receive_message_chain(:new, :getresources).and_return(mx_records_object) - allow(Resolv).to receive(:getaddress).and_return(host_address) - end + before { allow(Resolv::DNS).to receive_message_chain(:new, :getresources).and_return(mx_records_object) } - specify do - expect(mx_validator_instance).to receive(:hosts_from_mx_records?).and_call_original - expect(mx_validator_instance).not_to receive(:hosts_from_cname_records?) - expect(mx_validator_instance).not_to receive(:host_from_a_record?) + context 'with null mx' do + let(:target_mx_record) { mx_records_object.first } - expect { mx_validator } - .to change(result_instance, :domain) - .from(nil).to(email[Truemail::RegexConstant::REGEX_EMAIL_PATTERN, 3]) - .and change(result_instance, :mail_servers) - .from([]).to(mail_servers_by_ip) - .and not_change(result_instance, :success) + before do + allow(mx_validator_instance).to receive(:hosts_from_mx_records?).and_call_original + allow(mx_validator_instance).to receive(:mx_records).and_call_original + allow(mx_validator_instance).to receive(:null_mx?).and_call_original + + allow(mx_records_object).to receive(:one?).and_return(true) + allow(target_mx_record).to receive_message_chain(:preference, :zero?).and_return(true) + allow(target_mx_record).to receive_message_chain(:exchange, :to_s, :empty?).and_return(true) + end + + specify do + expect(mx_validator_instance).not_to receive(:hosts_from_cname_records?) + expect(mx_validator_instance).not_to receive(:host_from_a_record?) + + expect { mx_validator } + .to change(result_instance, :domain) + .from(nil).to(email[Truemail::RegexConstant::REGEX_EMAIL_PATTERN, 3]) + .and not_change(result_instance, :mail_servers) + .and change(result_instance, :success).from(true).to(false) + end + + it 'returns false' do + expect(mx_validator).to be(false) + end end - it 'returns true' do - expect(mx_validator).to be(true) + context 'without null mx' do + before { allow(Resolv).to receive(:getaddresses).and_return([host_address]) } + + specify do + expect(mx_validator_instance).to receive(:hosts_from_mx_records?).and_call_original + expect(mx_validator_instance).to receive(:mx_records).and_call_original + expect(mx_validator_instance).to receive(:null_mx?).and_call_original + expect(mx_validator_instance).not_to receive(:hosts_from_cname_records?) + expect(mx_validator_instance).not_to receive(:host_from_a_record?) + + expect { mx_validator } + .to change(result_instance, :domain) + .from(nil).to(email[Truemail::RegexConstant::REGEX_EMAIL_PATTERN, 3]) + .and change(result_instance, :mail_servers) + .from([]).to(mail_servers_by_ip) + .and not_change(result_instance, :success) + end + + it 'returns true' do + expect(mx_validator).to be(true) + end end end