dns_mock 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb90f7f7c21ba2fff7de8259e0ac994a0781c212d7de77c05eebbe209b2f7f4c
-  data.tar.gz: e6ac11bad8d86f035063f2b6ca09c681a66988a647c7051a2a80de5b3f0d0ff9
+  metadata.gz: 030004dfb97793bf507c84fbd56965bd5af1aa3c9652db58c20d40ec1467936f
+  data.tar.gz: b4b0d01e9750ac32c4f1577542a668393abb8780615930263765acbb810854a2
 SHA512:
-  metadata.gz: a50714bf62ee1976954cd4cd351399b29d67d240a89e4da379e8da4a5b33c12f323bbed706e5233f23d9edafa609fce52a0f6f3454aab414254368a5069a552f
-  data.tar.gz: 1d2ad40b18259ba6132215bb486dd2d8e9c0e7cf1df195b1538589c0d8fbc034f2436f3d062fed9823e61df54c50c4c958340f9b8e4a04093044ce6bc708ded9
+  metadata.gz: 9e3a43b5a4519bca6e4909d8632081cac6699f57a5090223d97bbf95b32be684f8cb1437cf0ce64080a3476d787a874eb028e2416566d041dfba8211cb41ba60
+  data.tar.gz: 259b19d489e11ed66e4b9aa4e5aa55f88913edeb66ed5e767c378940c00bcc934dde3842eeaf5b2ee88456c69e221fd4d9d91ef28ac2fc6a2bfada0f05188e48

data/.reek.yml

@@ -17,17 +17,23 @@ detectors:
       - DnsMock::ContextGeneratorHelper#random_ip_v4_address
       - DnsMock::ContextGeneratorHelper#random_ip_v6_address
       - DnsMock::ContextGeneratorHelper#random_txt_record_context
+      - DnsMock::ContextGeneratorHelper#to_punycode_hostname
       - DnsMock::RecordsDictionaryHelper#create_records_dictionary_by_records
       - DnsMock::ServerHelper#start_random_server
       - DnsMock::ServerHelper#stop_all_running_servers
-      - DnsMock::Server::RecordsDictionaryBuilder#rdns_lookup_prefix
       - DnsMock::ContextGeneratorHelper#random_port_number
       - DnsMock::TestFramework::RSpec::Helper#dns_mock_server
+      - DnsMock::ContextGeneratorHelper#to_rdns_hostaddress
+
+  DuplicateMethodCall:
+    exclude:
+      - DnsMock::ContextGeneratorHelper#create_records
 
   ControlParameter:
     exclude:
       - DnsMock::Error::Helper#raise_unless
       - DnsMock::Server#initialize
+      - DnsMock::ContextGeneratorHelper#to_punycode_hostname
 
   MissingSafeMethod:
     exclude:

data/CHANGELOG.md

@@ -2,6 +2,65 @@
 
 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.4.0] - 2021-07-13
+
+### Added
+
+- Added ability to use internationalized hostnames. All hostnames in UTF-8 will be represented as [Punycode](https://en.wikipedia.org/wiki/Punycode)
+- Added `simpleidn` as runtime dependency
+- Added `DnsMock::Representer::Punycode`, tests
+
+```ruby
+records = {
+  'mañana.com' => {
+    mx: %w[másletras.mañana.com]
+  }
+}
+
+DnsMock.start_server(port: 5300, records: records)
+```
+
+```bash
+dig @localhost -p 5300 MX xn--maana-pta.com
+```
+
+```
+; <<>> DiG 9.10.6 <<>> @localhost -p 5300 MX xn--maana-pta.com
+; (2 servers found)
+;; global options: +cmd
+;; Got answer:
+;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 4612
+;; flags: rd; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 1
+;; WARNING: recursion requested but not available
+
+;; OPT PSEUDOSECTION:
+; EDNS: version: 0, flags:; udp: 4096
+;; QUESTION SECTION:
+;xn--maana-pta.com.		IN	MX
+
+;; ANSWER SECTION:
+xn--maana-pta.com.	1	IN	MX	10 xn--msletras-8ya.xn--maana-pta.com.
+
+;; Query time: 0 msec
+;; SERVER: 127.0.0.1#5300(127.0.0.1)
+;; WHEN: Tue Jul 13 15:38:47 EEST 2021
+;; MSG SIZE  rcvd: 79
+```
+
+### Changed
+
+- Refactored `DnsMock::Representer::RdnsLookup`, tests
+- Updated `DnsMock::Record::Factory::Base`
+- Updated `DnsMock::Server::RecordsDictionaryBuilder`, tests
+- Updated `DnsMock::Record::Factory::Cname`, tests
+- Updated `DnsMock::Record::Factory::Mx`, tests
+- Updated `DnsMock::Record::Factory::Ns`, tests
+- Updated `DnsMock::Record::Factory::Ptr`, tests
+- Updated `DnsMock::Record::Factory::Soa`, tests
+- Updated `DnsMock::ContextGeneratorHelper`, tests
+- Updated reek config
+- Updated gem documentation, version
+
 ## [1.3.1] - 2021-07-07
 
 ### Changed
@@ -12,11 +71,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [1.3.0] - 2021-06-14
 
-Detecting random available port via OS features. Thanks [@ioquatix](https://github.com/ioquatix) for [suggestion](https://github.com/mocktools/ruby-dns-mock/issues/42) 🚀
+### Added
+
+- Detecting random available port via OS features. Thanks [@ioquatix](https://github.com/ioquatix) for [suggestion](https://github.com/mocktools/ruby-dns-mock/issues/42) 🚀
 
 ### Removed
 
-- Removed `DnsMock::Server::RandomAvailablePort`
+- Removed `DnsMock::Server::RandomAvailablePort`, tests
 
 ### Changed
 
@@ -61,9 +122,11 @@ Detecting random available port via OS features. Thanks [@ioquatix](https://gith
 
 ## [1.2.0] - 2021-02-04
 
-### Ability to specify MX record priority
+### Added
+
+- Ability to specify custom priority of MX record if it needed
 
-Added ability to specify custom priority of MX record if it needed. Now it impossible to define null or backup MX records. Please note, if you haven't specified a priority of MX record, it will be assigned automatically. MX records builder is assigning priority with step 10 from first item of defined MX records array.
+Now is possible to define null or backup MX records. Please note, if you haven't specified a priority of MX record, it will be assigned automatically. MX records builder is assigning priority with step 10 from first item of defined MX records array.
 
 ```ruby
 records = {
@@ -96,9 +159,9 @@ example.com.		1	IN	MX	40 mx3.domain.com.
 
 ## [1.1.0] - 2021-02-01
 
-### RSpec native support
+### Added
 
-Added DnsMock helper which can simplify integration with RSpec.
+- RSpec native support. DnsMock helper help you to simplify integration with RSpec
 
 ```ruby
 # spec/support/config/dns_mock.rb
@@ -130,9 +193,11 @@ end
 
 ## [1.0.0] - 2021-01-29
 
-### Configurable record not found behaviour
+### Added
 
-Added configurable strategy for record not found case. By default it won't raise an exception when DNS record not found in mocked records dictionary:
+- Configurable strategy for record not found case
+
+By default it won't raise an exception when DNS record not found in mocked records dictionary:
 
 ```ruby
 DnsMock.start_server(port: 5300)
@@ -178,13 +243,15 @@ DnsMock.start_server(exception_if_not_found: true)
 
 ### Fixed
 
-Fixed RDNS lookup representatin for IP address in PTR record feature.
+- RDNS lookup representatin for IP address in PTR record feature.
 
 ## [0.2.0] - 2021-01-26
 
-### PTR record support
+### Added
+
+- PTR record support. Ability to mock PTR records
 
-Added ability to mock PTR records. Please note, you can define host address without RDNS lookup prefix (`.in-addr.arpa`). `DnsMock` will do it for you.
+Please note, you can define host address without RDNS lookup prefix (`.in-addr.arpa`). `DnsMock` will do it for you.
 
 ```ruby
 records = {
@@ -216,6 +283,6 @@ dig @localhost -p 5300 -x 1.2.3.4
 
 ## [0.1.0] - 2021-01-19
 
-### First release
+### Added
 
-Implemented first version of `DnsMock`. Thanks [@le0pard](https://github.com/le0pard) for idea & support 🚀
+- First release of `DnsMock`. Thanks [@le0pard](https://github.com/le0pard) for idea & support 🚀

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    dns_mock (1.3.1)
+    dns_mock (1.4.0)
+      simpleidn (~> 0.2.1)
 
 GEM
   remote: https://rubygems.org/
@@ -35,7 +36,7 @@ GEM
       iniparse (~> 1.4)
       rexml (~> 3.2)
     parallel (1.20.1)
-    parser (3.0.1.1)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -45,7 +46,7 @@ GEM
       pry (~> 0.13.0)
     psych (3.3.2)
     rainbow (3.0.0)
-    rake (13.0.4)
+    rake (13.0.6)
     reek (6.0.4)
       kwalify (~> 0.7.0)
       parser (~> 3.0.0)
@@ -108,14 +109,14 @@ PLATFORMS
   x86_64-darwin-20
 
 DEPENDENCIES
-  bundler (~> 2.2, >= 2.2.22)
+  bundler (~> 2.2, >= 2.2.23)
   bundler-audit (~> 0.8.0)
   dns_mock!
   faker (~> 2.18)
   fasterer (~> 0.9.0)
   overcommit (~> 0.58.0)
   pry-byebug (~> 3.9)
-  rake (~> 13.0, >= 13.0.4)
+  rake (~> 13.0, >= 13.0.6)
   reek (~> 6.0, >= 6.0.4)
   rspec (~> 3.10)
   rspec-dns (~> 0.1.8)
@@ -125,4 +126,4 @@ DEPENDENCIES
   simplecov (~> 0.17.1)
 
 BUNDLED WITH
-   2.2.22
+   2.2.23

data/README.md

@@ -29,10 +29,11 @@
 ## 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
 
@@ -67,7 +68,7 @@ records = {
     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',
@@ -85,7 +86,7 @@ records = {
   }
 }
 
-# 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
@@ -136,7 +137,7 @@ 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

data/dns_mock.gemspec

@@ -31,13 +31,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.2', '>= 2.2.22'
+  spec.add_runtime_dependency 'simpleidn', '~> 0.2.1'
+
+  spec.add_development_dependency 'bundler', '~> 2.2', '>= 2.2.23'
   spec.add_development_dependency 'bundler-audit', '~> 0.8.0'
   spec.add_development_dependency 'faker', '~> 2.18'
   spec.add_development_dependency 'fasterer', '~> 0.9.0'
   spec.add_development_dependency 'overcommit', '~> 0.58.0'
   spec.add_development_dependency 'pry-byebug', '~> 3.9'
-  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.4'
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
   spec.add_development_dependency 'reek', '~> 6.0', '>= 6.0.4'
   spec.add_development_dependency 'rspec', '~> 3.10'
   spec.add_development_dependency 'rspec-dns', '~> 0.1.8'

data/lib/dns_mock/core.rb

@@ -18,6 +18,11 @@ module DnsMock
     require_relative '../dns_mock/error/helper'
   end
 
+  module Representer
+    require_relative '../dns_mock/representer/punycode'
+    require_relative '../dns_mock/representer/rdns_lookup'
+  end
+
   module Record
     module Factory
       require_relative '../dns_mock/record/factory/base'

data/lib/dns_mock/record/factory/base.rb

@@ -23,8 +23,13 @@ module DnsMock
           end
         end
 
-        def initialize(dns_name = ::Resolv::DNS::Name, record_data:)
+        def initialize(
+          dns_name = ::Resolv::DNS::Name,
+          punycode_representer = DnsMock::Representer::Punycode,
+          record_data:
+        )
           @dns_name = dns_name
+          @punycode_representer = punycode_representer
           @record_data = record_data
         end
 
@@ -38,7 +43,7 @@ module DnsMock
 
         private
 
-        attr_reader :dns_name, :record_data
+        attr_reader :dns_name, :punycode_representer, :record_data
 
         def record_type
           self.class.name.split('::').last.upcase
@@ -46,7 +51,7 @@ module DnsMock
 
         def create_dns_name(hostname)
           raise ::ArgumentError, "cannot interpret as DNS name: #{hostname}" unless hostname.is_a?(::String)
-          dns_name.create("#{hostname}.")
+          dns_name.create("#{punycode_representer.call(hostname)}.")
         end
       end
     end

data/lib/dns_mock/representer/punycode.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DnsMock
+  module Representer
+    Punycode = ::Class.new do
+      require 'simpleidn'
+
+      def self.call(hostname)
+        return hostname if hostname.ascii_only?
+
+        SimpleIDN.to_ascii(hostname)
+      end
+    end
+  end
+end

data/lib/dns_mock/representer/rdns_lookup.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DnsMock
+  module Representer
+    class RdnsLookup
+      IP_OCTET_GROUPS = /(\d+).(\d+).(\d+).(\d+)/.freeze
+      RDNS_LOOKUP_REPRESENTATION = '\4.\3.\2.\1.in-addr.arpa'
+
+      def self.call(host_address)
+        host_address.gsub(
+          DnsMock::Representer::RdnsLookup::IP_OCTET_GROUPS,
+          DnsMock::Representer::RdnsLookup::RDNS_LOOKUP_REPRESENTATION
+        )
+      end
+    end
+  end
+end

data/lib/dns_mock/server/records_dictionary_builder.rb

@@ -6,8 +6,6 @@ module DnsMock
       include DnsMock::Error::Helper
 
       IP_ADDRESS_PATTERN = /\A((1\d|[1-9]|2[0-4])?\d|25[0-5])(\.\g<1>){3}\z/.freeze
-      IP_OCTET_GROUPS = /(\d+).(\d+).(\d+).(\d+)/.freeze
-      RDNS_LOOKUP_REPRESENTATION = '\4.\3.\2.\1.in-addr.arpa'
       TYPE_MAPPER = DnsMock::AVAILABLE_DNS_RECORD_TYPES.zip(
         [
           [DnsMock::Record::Builder::A, DnsMock::Record::Factory::A, ::Array],
@@ -27,7 +25,12 @@ module DnsMock
 
       attr_reader :records
 
-      def initialize
+      def initialize(
+        punycode_representer = DnsMock::Representer::Punycode,
+        rdns_lookup_representer = DnsMock::Representer::RdnsLookup
+      )
+        @punycode_representer = punycode_representer
+        @rdns_lookup_representer = rdns_lookup_representer
         @records = {}
       end
 
@@ -35,7 +38,7 @@ module DnsMock
         raise_unless(DnsMock::Error::ArgumentType.new(records_to_build.class), records_to_build.is_a?(::Hash))
         records_to_build.each do |hostname, dns_records|
           raise_unless(DnsMock::Error::RecordHostType.new(hostname, hostname.class), hostname.is_a?(::String))
-          records[rdns_lookup_prefix(hostname)] = dns_records.each_with_object({}) do |(record_type, records_data), records_instances_by_type|
+          records[representer(hostname)] = dns_records.each_with_object({}) do |(record_type, records_data), records_instances_by_type|
             records_instances_by_type[record_type] = build_records_instances_by_type(record_type, records_data)
           end
         end
@@ -45,13 +48,12 @@ module DnsMock
 
       private
 
-      def rdns_lookup_prefix(hostname)
-        return hostname unless hostname[DnsMock::Server::RecordsDictionaryBuilder::IP_ADDRESS_PATTERN]
+      attr_reader :punycode_representer, :rdns_lookup_representer
 
-        hostname.gsub(
-          DnsMock::Server::RecordsDictionaryBuilder::IP_OCTET_GROUPS,
-          DnsMock::Server::RecordsDictionaryBuilder::RDNS_LOOKUP_REPRESENTATION
-        )
+      def representer(hostname)
+        return rdns_lookup_representer.call(hostname) if hostname[DnsMock::Server::RecordsDictionaryBuilder::IP_ADDRESS_PATTERN]
+
+        punycode_representer.call(hostname)
       end
 
       def build_records_instances_by_type(record_type, records_to_build)

data/lib/dns_mock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DnsMock
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dns_mock
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Vladislav Trotsenko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2021-07-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: simpleidn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -19,7 +33,7 @@ dependencies:
         version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.22
+        version: 2.2.23
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +43,7 @@ dependencies:
         version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.22
+        version: 2.2.23
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +123,7 @@ dependencies:
         version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.4
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -119,7 +133,7 @@ dependencies:
         version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.4
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -299,6 +313,8 @@ files:
 - lib/dns_mock/record/factory/ptr.rb
 - lib/dns_mock/record/factory/soa.rb
 - lib/dns_mock/record/factory/txt.rb
+- lib/dns_mock/representer/punycode.rb
+- lib/dns_mock/representer/rdns_lookup.rb
 - lib/dns_mock/response/answer.rb
 - lib/dns_mock/response/message.rb
 - lib/dns_mock/server.rb