README.md in dns_mock-1.3.1 vs README.md in dns_mock-1.4.0
- old
+ new
@@ -27,14 +27,15 @@
- [Changelog](CHANGELOG.md)
## Features
- Ability to mimic any DNS records (`A`, `AAAA`, `CNAME`, `MX`, `NS`, `PTR`, `SOA` and `TXT`)
-- Zero runtime dependencies
+- Automatically converts hostnames to RDNS/[Punycode](https://en.wikipedia.org/wiki/Punycode) representation
- Lightweight UDP DNS mock server with dynamic/manual port assignment
- Test framework agnostic (it's PORO, so you can use it outside of `RSpec`, `Test::Unit` or `MiniTest`)
- Simple and intuitive DSL
+- Only one runtime dependency
## Requirements
Ruby MRI 2.5.0+
@@ -65,11 +66,11 @@
a: %w[1.1.1.1 2.2.2.2],
aaaa: %w[2a00:1450:4001:81e::200e],
ns: %w[ns1.domain.com ns2.domain.com],
mx: %w[mx1.domain.com mx2.domain.com:50], # you can specify host(s) or host(s) with priority, use '.:0' for definition null MX record
txt: %w[txt_record_1 txt_record_2],
- cname: 'some.domain.com',
+ cname: 'maƱana.com', # you can specify hostname in UTF-8. It will be converted to xn--maana-pta.com automatically
soa: [
{
mname: 'dns1.domain.com',
rname: 'dns2.domain.com',
serial: 2_035_971_683,
@@ -83,11 +84,11 @@
'1.2.3.4' => { # You can define RDNS host address without lookup prefix. It will be converted to 4.3.2.1.in-addr.arpa automatically
ptr: %w[domain_1.com domain_2.com]
}
}
-# Main DnsMock interface
+# Public DnsMock interface
# records:Hash, port:Integer, exception_if_not_found:Boolean
# are optional params. By default creates dns mock server with
# empty records. A free port for server will be randomly assigned
# in the range from 49152 to 65535, if record not found exception
# won't raises. Please note if you specify zero port number,
@@ -134,10 +135,10 @@
require 'dns_mock/test_framework/rspec'
```
#### DnsMock RSpec helper
-Just add `DnsMock::TestFramework::RSpec::Helper` if you wanna use shortcut `dns_mock_server` for DnsMock server instance into your `RSpec.describe` blocks:
+Just add `DnsMock::TestFramework::RSpec::Helper` if you wanna use shortcut `dns_mock_server` for DnsMock server instance inside of your `RSpec.describe` blocks:
```ruby
# spec/support/config/dns_mock.rb
RSpec.configure do |config|
config.include DnsMock::TestFramework::RSpec::Helper