README.md in truemail-rspec-0.1.3 vs README.md in truemail-rspec-0.2.0
- old
+ new
@@ -1,6 +1,6 @@
-# <img src='https://repository-images.githubusercontent.com/222414074/393c9600-09f9-11ea-8d21-345619b97b11' height='250' alt='Truemail RSpec helpers' />
+
[](https://codeclimate.com/github/truemail-rb/truemail-rspec/maintainability) [](https://codeclimate.com/github/truemail-rb/truemail-rspec/test_coverage) [](https://circleci.com/gh/truemail-rb/truemail-rspec/tree/master) [](https://badge.fury.io/rb/truemail-rspec) [](https://rubygems.org/gems/truemail-rspec) [](CODE_OF_CONDUCT.md)
`truemail-rspec` gem helps you create `Truemail::Configuration` and `Truemail::Validator` instances for your RSpec environment.
@@ -11,13 +11,15 @@
- [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 DSL](#create_validator-dsl)
+ - [create_validator](#create_validator)
- [Truemail family](#truemail-family)
- [Contributing](#contributing)
- [License](#license)
- [Code of Conduct](#code-of-conduct)
- [Credits](#credits)
@@ -83,20 +85,37 @@
```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_validator DSL
+#### create_validator
```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