truemail-rspec 1.0.0 → 1.1.0

data/.reek.yml

@@ -1,44 +0,0 @@
-detectors:
-  IrresponsibleModule:
-    enabled: false
-
-  FeatureEnvy:
-    exclude:
-      - Truemail::RSpec::ConfigurationHelper#create_configuration
-      - Truemail::RSpec::ValidatorHelper#request_instance
-      - Truemail::RSpec::AuditorHelper#create_auditor
-
-  ControlParameter:
-    exclude:
-      - Truemail::RSpec::AuditorHelper#create_auditor
-      - Truemail::RSpec::ValidatorHelper#create_servers_list
-
-  NestedIterators:
-    exclude:
-      - Truemail::RSpec::ConfigurationHelper#configuration_block
-
-  BooleanParameter:
-    exclude:
-      - Truemail::RSpec::ValidatorHelper#create_validator
-      - Truemail::RSpec::AuditorHelper#create_auditor
-
-  DuplicateMethodCall:
-    exclude:
-      - Truemail::RSpec::ValidatorHelper#mx_layer
-      - Truemail::RSpec::ValidatorHelper#mx_blacklist_layer
-      - Truemail::RSpec::ValidatorHelper#smtp_layer
-      - Truemail::RSpec::ValidatorHelper#unstub_validation_layers
-
-  TooManyInstanceVariables:
-    exclude:
-      - Truemail::RSpec::ValidatorHelper::ValidatorFactory
-
-  UtilityFunction:
-    exclude:
-      - Truemail::RSpec::ValidatorHelper#create_servers_list
-
-  LongParameterList:
-    enabled: false
-
-  TooManyStatements:
-    enabled: false

data/.rspec

@@ -1,2 +0,0 @@
---require spec_helper
---format documentation

data/.rubocop.yml

@@ -1,70 +0,0 @@
-require:
-  - rubocop-rspec
-  - rubocop-performance
-
-AllCops:
-  DisplayCopNames:    true
-  DisplayStyleGuide:  true
-  TargetRubyVersion:  2.5
-  NewCops: enable
-
-# Metrics ---------------------------------------------------------------------
-
-Metrics/ClassLength:
-  Max: 150
-
-Metrics/MethodLength:
-  Max: 15
-
-# Naming ----------------------------------------------------------------------
-
-Naming/VariableNumber:
-  Enabled: false
-
-# Style -----------------------------------------------------------------------
-
-Style/Documentation:
-  Enabled: false
-
-# Layout ----------------------------------------------------------------------
-
-Layout/LineLength:
-  Max: 140
-
-Layout/ClassStructure:
-  Enabled: true
-  Categories:
-    module_inclusion:
-      - include
-      - prepend
-      - extend
-  ExpectedOrder:
-      - module_inclusion
-      - constants
-      - public_class_methods
-      - initializer
-      - public_methods
-      - protected_methods
-      - private_methods
-
-Layout/EmptyLineAfterGuardClause:
-  Enabled: false
-
-# Gemspec ---------------------------------------------------------------------
-
-Gemspec/RequireMFA:
-  Enabled: false
-
-# RSpec -----------------------------------------------------------------------
-
-RSpec/ExampleLength:
-  Enabled: false
-
-RSpec/NestedGroups:
-  Enabled: false
-
-RSpec/MultipleExpectations:
-  Enabled: false
-
-RSpec/MultipleMemoizedHelpers:
-  Enabled: false

data/.ruby-gemset

@@ -1 +0,0 @@
-truemail-rspec

data/CHANGELOG.md

@@ -1,267 +0,0 @@
-# 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.0.0] - 2022-10-25
-
-### Added
-
-- Ability to create `Truemail::Validator` instance for `Whitelist/Blacklist` validation layer
-
-### Updated
-
-- Updated `Truemail::RSpec::ValidatorHelper::ValidatorFactory#process_validator_params`, tests
-- Updated gem runtime dependencies
-- Updated gem development dependencies
-- Updated gem readme, gem version
-
-## [0.9.2] - 2022-10-09
-
-### Updated
-
-- Updated gem runtime dependencies
-- Updated gem development dependencies
-- Updated gem readme, gem version
-
-## [0.9.1] - 2022-03-02
-
-### Updated
-
-- Updated gem runtime dependencies
-- Updated gem development dependencies
-- Updated gem readme, gem version
-
-## [0.9.0] - 2022-02-23
-
-### Added
-
-- Added development environment guide docs
-
-### Updated
-
-- Updated gem runtime dependencies
-- Updated gem development dependencies
-- Updated minimal Ruby version for RubyGems environment
-- Updated CircleCI configs
-- Updated contributing guide
-
-## [0.8.0] - 2022-01-25
-
-### Updated
-
-- Updated gem runtime dependencies
-- Updated gem development dependencies
-- Updated default Ruby version for test environment
-- Updated rubocop/codeclimate configs
-
-## [0.7.0] - 2021-08-11
-
-### Updated
-
-- gem runtime dependencies
-- gem development dependencies
-
-### Changed
-
-- `faker` to `ffaker` dependency
-
-## [0.6.0] - 2021-05-13
-
-### Added
-
-```ruby
-# Truemail::Validator instance, successful case
-create_validator(:mx_blacklist)
-=> #<Truemail::Validator:0x00007fea91a1d528
- @result=
-  #<struct Truemail::Validator::Result
-   success=true,
-   email="danyell@brakus-dooley.co",
-   domain="brakus-dooley.co",
-   mail_servers=["175.244.212.125", "69.106.253.221", "7.125.70.85", "152.249.195.7"],
-   errors={},
-   smtp_debug=nil,
-   configuration=
-    #<Truemail::Configuration:0x00007fea98977248
-     @blacklisted_domains=[],
-     @blacklisted_mx_ip_addresses=[],
-     @connection_attempts=2,
-     @connection_timeout=2,
-     @default_validation_type=:smtp,
-     @dns=[],
-     @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)/,
-     @not_rfc_mx_lookup_flow=false,
-     @response_timeout=2,
-     @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i,
-     @smtp_fail_fast=false,
-     @smtp_safe_check=false,
-     @validation_type_by_domain={},
-     @verifier_domain="lubowitz.com",
-     @verifier_email="shante.keeling@lubowitz.com",
-     @whitelist_validation=false,
-     @whitelisted_domains=[]>>,
- @validation_type=:mx_blacklist>
-
-# Truemail::Validator instance, failure case
-create_validator(:mx_blacklist, success: false)
-=> #<Truemail::Validator:0x00007fea988cfd18
- @result=
-  #<struct Truemail::Validator::Result
-   success=false,
-   email="mike.treutel@heathcote.biz",
-   domain="heathcote.biz",
-   mail_servers=["212.76.177.170", "253.244.87.72", "144.225.110.224"],
-   errors={:mx_blacklist=>"blacklisted mx server ip address"},
-   smtp_debug=nil,
-   configuration=
-    #<Truemail::Configuration:0x00007fea988ee150
-     @blacklisted_domains=[],
-     @blacklisted_mx_ip_addresses=["212.76.177.170", "253.244.87.72", "144.225.110.224"],
-     @connection_attempts=2,
-     @connection_timeout=2,
-     @default_validation_type=:smtp,
-     @dns=[],
-     @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)/,
-     @not_rfc_mx_lookup_flow=false,
-     @response_timeout=2,
-     @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i,
-     @smtp_fail_fast=false,
-     @smtp_safe_check=false,
-     @validation_type_by_domain={},
-     @verifier_domain="grant-flatley.org",
-     @verifier_email="mariano@grant-flatley.org",
-     @whitelist_validation=false,
-     @whitelisted_domains=[]>>,
- @validation_type=:mx_blacklist>
-```
-
-- Ability to create `Truemail::Validator` instance for `MxBlacklist` validation layer
-- Stub for `MxBlacklist` validation layer
-- CircleCI config for using multiple Ruby versions
-
-### Updated
-
-- Updated gem development dependencies
-
-### Fixed
-
-- Simplecov coverage issues
-
-## [0.5.0] - 2021-05-05
-
-### Added
-
-- Ability to set size for servers list
-
-```ruby
-create_servers_list(42) # => returns array with 42 random ip addresses
-```
-
-### Updated
-
-- gem runtime dependencies
-- gem development dependencies
-
-## [0.4.0] - 2021-02-24
-
-### Updated
-
-- gem runtime dependencies
-- gem development dependencies
-
-## [0.3.3] - 2020-12-06
-
-### Added
-
-- `faker` import
-
-### Updated
-
-- gem development dependencies
-
-## [0.3.2] - 2020-12-06
-
-### Fixed
-
-- Namespace collisions for `faker`
-
-## [0.3.1] - 2020-12-06
-
-### Added
-
-- Required `faker` runtime dependency
-
-## [0.3.0] - 2020-12-06
-
-### Added
-
-Ability to pass custom context into rcptto error:
-
-```ruby
-create_validator(
-  validation_type, # optional, type:Symbol, can be :regex, :mx or :smtp, by default creates :smtp validation
-  email, # optional, type:String, by default random email
-  mail_servers, # optional, type:Array(String), by default array with random ip addresses
-  success: true, # optional, type:Bool, by default true
-  rcptto_error: 'custom context of rcptto error' # optional, type:String, by default it's equal to 'user not found'
-  configuration: create_configuration # optional, type:Truemail::Configuration, by default creates random configuration
-)
-```
-
-### Changed
-
-- Updated `Truemail::RSpec::ValidatorHelper`
-- gem development, runtime dependencies
-- gem documentation
-
-## [0.2.1] - 2020-09-21
-
-### Changed
-
-Migrated to updated Ruby 2.7.x syntax.
-
-- Updated `Truemail::RSpec::ConfigurationHelper`
-
-## [0.2.0] - 2020-08-31
-
-### Added
-
-- auditor RSpec helper
-
-### Removed
-
-- gem public documentation
-
-## [0.1.3] - 2020-08-24
-
-### Added
-
-- gem public documentation
-
-### Changed
-
-- gem development dependencies
-- linters configs
-
-## [0.1.2] - 2020-05-08
-
-### Changed
-
-- gem development dependencies
-- gem documentation
-
-## [0.1.1] - 2019-11-22
-
-### Changed
-
-- gem development dependencies
-- linters configs
-- gem documentation
-
-## [0.1.0] - 2019-11-19
-
-### Added
-
-- configuration RSpec helper
-- validator RSpec helper
-- gem documentation

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at admin@bestweb.com.ua. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -1,48 +0,0 @@
-# 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 [issue/bug reports](#issuebug-reports), [feature requests](#feature-requests), [questions](#questions) and submitting [pull requests](#pull-requests).
-
-## Issue/bug 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 issue/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 `develop` branch in the repository
-3. Truemail [issue template](.github/ISSUE_TEMPLATE/issue_report.md)/[bug template](.github/ISSUE_TEMPLATE/bug_report.md)
-
-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.
-
-## Questions
-
-We're always open to a new conversations. So if you have any questions just ask us.
-
-## 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. Truemail [pull request template](.github/PULL_REQUEST_TEMPLATE.md)
-2. Fork the repo, checkout to `develop` branch
-3. Run the tests. This is to make sure your starting point works
-4. Read our [branch naming convention](.github/BRANCH_NAMING_CONVENTION.md)
-5. Create a new branch
-6. Read our [setup development environment guide](.github/DEVELOPMENT_ENVIRONMENT_GUIDE.md)
-7. Make your changes. Please note that your PR should include tests for the new codebase!
-9. Push to your fork and submit a pull request to `develop` branch

data/Gemfile

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-gemspec

data/README.md

@@ -1,178 +0,0 @@
-# ![Truemail RSpec helpers](https://truemail-rb.org/assets/images/truemail_logo.png)
-
-[![Maintainability](https://api.codeclimate.com/v1/badges/d23d82c1c1bdbc271b81/maintainability)](https://codeclimate.com/github/truemail-rb/truemail-rspec/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/d23d82c1c1bdbc271b81/test_coverage)](https://codeclimate.com/github/truemail-rb/truemail-rspec/test_coverage)
-[![CircleCI](https://circleci.com/gh/truemail-rb/truemail-rspec/tree/master.svg?style=svg)](https://circleci.com/gh/truemail-rb/truemail-rspec/tree/master)
-[![Gem Version](https://badge.fury.io/rb/truemail-rspec.svg)](https://badge.fury.io/rb/truemail-rspec)
-[![Downloads](https://img.shields.io/gem/dt/truemail-rspec.svg?colorA=004d99&colorB=0073e6)](https://rubygems.org/gems/truemail-rspec)
-[![Gitter](https://badges.gitter.im/truemail-rb/community.svg)](https://gitter.im/truemail-rb/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-[![GitHub](https://img.shields.io/github/license/truemail-rb/truemail-rspec)](LICENSE.txt)
-[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
-
-`truemail-rspec` gem helps you to create `Truemail::Configuration`, `Truemail::Auditor` and `Truemail::Validator` instances for your RSpec environment.
-
-> Actual and maintainable documentation :books: for developers is living [here](https://truemail-rb.org/truemail-rspec).
-
-## Table of Contents
-
-- [Features](#features)
-- [Requirements](#requirements)
-- [Installation](#installation)
-- [Usage](#usage)
-  - [Create configuration instance](#create-configuration-instance)
-    - [Configuration instance with default random params](#configuration-instance-with-default-random-params)
-    - [Configuration instance with predefined params](#configuration-instance-with-predefined-params)
-  - [Create auditor instance](#create-auditor-instance)
-    - [create_auditor](#create_auditor)
-  - [Create validator instance](#create-validator-instance)
-    - [create_servers_list](#create_servers_list)
-    - [create_validator](#create_validator)
-- [Truemail family](#truemail-family)
-- [Contributing](#contributing)
-- [License](#license)
-- [Code of Conduct](#code-of-conduct)
-- [Credits](#credits)
-- [Versioning](#versioning)
-- [Changelog](CHANGELOG.md)
-
-## Requirements
-
-Ruby MRI 2.5.0+
-
-## Features
-
-- Ability to create `Truemail::Configuration` instance with random or with predefined params
-- Ability to create `Truemail::Auditor` instance with random or with predefined params
-- Ability to create `Truemail::Validator` instance with random or with predefined params
-
-## Installation
-
-Add this line to your application's `Gemfile`:
-
-```ruby
-group :development, :test do
-  gem 'truemail-rspec', require: false
-end
-```
-
-And add into your `spec_helper.rb` or `rails_helper.rb`:
-
-```ruby
-require 'truemail/rspec'
-
-RSpec.configure do |config|
-  config.include Truemail::RSpec
-end
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install truemail-rspec
-
-## Usage
-
-### Create configuration instance
-
-Allows to create configuration instance with random or with predefined params.
-
-#### Configuration instance with default random params
-
-```ruby
-create_configuration
-
-# => returns Truemail::Configuration instance with
-# random verifier_email and default Truemail::Configuration params
-```
-
-#### Configuration instance with predefined params
-
-All `Truemail::Configuration` [available params](https://github.com/truemail-rb/truemail#setting-global-configuration)
-
-```ruby
-create_configuration(verifier_email: 'email@domain.com', verifier_domain: 'other-domain.com')
-# => returns Truemail::Configuration instance with custom settings
-```
-
-### Create auditor instance
-
-Allows to create auditor instance with default random or with predefined params.
-
-#### create_auditor
-
-```ruby
-create_auditor(
-  success: true, # optional, type:Bool, by default true
-  current_host_ip: current_host_ip, # optional, type:String, by default random IPv4 address
-  warnings: warnings, # optional, type:Hash, by default creates auditor result warnings
-  configuration: create_configuration # optional, type:Truemail::Configuration, by default creates random configuration
-)
-
-# => returns Truemail::Auditor instance follow passed params
-```
-
-### Create validator instance
-
-Allows to create validator instance with default random or with predefined params.
-
-#### create_servers_list
-
-```ruby
-create_servers_list # => returns array with random ip addresses
-create_servers_list(42) # => returns array with 42 random ip addresses
-```
-
-#### create_validator
-
-```ruby
-create_validator(
-  validation_type, # optional, type:Symbol, can be :emails_list, :domains_list, :regex, :mx, :mx_blacklist or :smtp, by default creates :smtp validation
-  email, # optional, type:String, by default random email
-  mail_servers, # optional, type:Array(String), by default array with random ip addresses
-  success: true, # optional, type:Bool, by default true
-  rcptto_error: 'custom context of rcptto error' # optional, type:String, by default it's equal to 'user not found'
-  configuration: create_configuration # optional, type:Truemail::Configuration, by default creates random configuration
-)
-
-# => returns Truemail::Validator instance follow passed params
-```
-
----
-
-## Truemail family
-
-All Truemail solutions: https://truemail-rb.org
-
-| Name | Type | Description |
-| --- | --- | --- |
-| [truemail](https://github.com/truemail-rb/truemail) | ruby gem | Configurable framework agnostic plain Ruby email validator, main core |
-| [truemail-go](https://github.com/truemail-rb/truemail-go) | go package | Configurable Golang email validator, main core |
-| [truemail server](https://github.com/truemail-rb/truemail-rack) | ruby app | Lightweight rack based web API wrapper for Truemail gem |
-| [truemail-rack-docker](https://github.com/truemail-rb/truemail-rack-docker-image) | docker image | Lightweight rack based web API [dockerized image](https://hub.docker.com/r/truemail/truemail-rack) :whale: of Truemail server |
-| [truemail-ruby-client](https://github.com/truemail-rb/truemail-ruby-client) | ruby gem | Web API Ruby client for Truemail Server |
-| [truemail-crystal-client](https://github.com/truemail-rb/truemail-crystal-client) | crystal shard | Web API Crystal client for Truemail Server |
-| [truemail-java-client](https://github.com/truemail-rb/truemail-java-client) | java lib | Web API Java client for Truemail Server |
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/truemail-rb/truemail-rspec. 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 tickets](https://github.com/truemail-rb/truemail-rspec/issues). Be sure to follow Contributor Code of Conduct below and our [Contributing Guidelines](CONTRIBUTING.md).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the `truemail-rspec` project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
-
-## Credits
-
-- [The Contributors](https://github.com/truemail-rb/truemail-rspec/graphs/contributors) for code and awesome suggestions
-- [The Stargazers](https://github.com/truemail-rb/truemail-rspec/stargazers) for showing their support
-
-## Versioning
-
-`truemail-rspec` uses [Semantic Versioning 2.0.0](https://semver.org)