truemail-rspec 0.1.3 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. checksums.yaml +4 -4
  2. data/.codeclimate.yml +1 -0
  3. data/.reek.yml +6 -0
  4. data/.rubocop.yml +96 -77
  5. data/CHANGELOG.md +10 -0
  6. data/Gemfile.lock +5 -2
  7. data/README.md +22 -3
  8. data/lib/truemail/rspec.rb +2 -0
  9. data/lib/truemail/rspec/auditor_helper.rb +20 -0
  10. data/lib/truemail/rspec/version.rb +1 -1
  11. data/truemail-rspec.gemspec +9 -0
  12. metadata +29 -12
  13. data/docs/.nojekyll +0 -0
  14. data/docs/_coverpage.md +0 -8
  15. data/docs/_sidebar.md +0 -9
  16. data/docs/contact-support.md +0 -14
  17. data/docs/index.html +0 -40
  18. data/docs/introduction.md +0 -18
  19. data/docs/quick-start.md +0 -33
  20. data/docs/truemail-family.md +0 -11
  21. data/docs/usage.md +0 -47
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: da5963e4ac15443d4412310fe26af7b908a459a5697d4975532149741dbc3a62
4
- data.tar.gz: e4e478a4f490fc6f48ee4d975203becf8efd91d4014ef8d0bfd6dc287dbdefa8
3
+ metadata.gz: c7de32a7986443299d54b09e4c667a7c0c25fb883105d33d24a9730cd1fa2766
4
+ data.tar.gz: 9d73fda356b527a5120e2b382e228ad6413632b06ffb457e436d63f8b3914bf8
5
5
  SHA512:
6
- metadata.gz: 2eb99db638aaa8ad2e7f8bd33fb595421fcafb3d6885ea67f1e81a62a9e09fc489a7b00bf29d85ef0f09dcc3f7a489eeb4da0a737779a56584449fa63354705e
7
- data.tar.gz: a8e61ef6b120d3a05bd7ffcc33c98eb6bd1b934ccfc5fd5d70da1b1a919e59eb9d2737da1aa4c4d59856dfde3fc5f00c5e9bde5bc4c401b1aa16eafc105b95a1
6
+ metadata.gz: 1bd7ca83b7b7d99e87f1726a1304cd56c5657d497e7051ec2ad47d1e58722bf487ca5be92c86f1723a759e7966342c1da095acb279fb533ea2959a8d9903fe0f
7
+ data.tar.gz: 3c2966b0c7afc2dfa247c8510e17cef99d7aff4a563c334ae48356523437f266567b94c4bfd29d6e0f45958c3704b89b8668e2b0c03a9862fbe0e20102e98a7a
data/.codeclimate.yml CHANGED
@@ -7,6 +7,7 @@ checks:
7
7
  plugins:
8
8
  rubocop:
9
9
  enabled: true
10
+ channel: rubocop-0-89
10
11
 
11
12
  reek:
12
13
  enabled: true
data/.reek.yml CHANGED
@@ -6,6 +6,11 @@ detectors:
6
6
  exclude:
7
7
  - Truemail::RSpec::ConfigurationHelper#create_configuration
8
8
  - Truemail::RSpec::ValidatorHelper#request_instance
9
+ - Truemail::RSpec::AuditorHelper#create_auditor
10
+
11
+ ControlParameter:
12
+ exclude:
13
+ - Truemail::RSpec::AuditorHelper#create_auditor
9
14
 
10
15
  NestedIterators:
11
16
  exclude:
@@ -14,6 +19,7 @@ detectors:
14
19
  BooleanParameter:
15
20
  exclude:
16
21
  - Truemail::RSpec::ValidatorHelper#create_validator
22
+ - Truemail::RSpec::AuditorHelper#create_auditor
17
23
 
18
24
  DuplicateMethodCall:
19
25
  exclude:
data/.rubocop.yml CHANGED
@@ -1,5 +1,6 @@
1
1
  require:
2
2
  - rubocop-rspec
3
+ - rubocop-performance
3
4
 
4
5
  AllCops:
5
6
  DisplayCopNames: true
@@ -39,6 +40,75 @@ Style/EmptyCaseCondition:
39
40
  Style/RescueStandardError:
40
41
  Enabled: false
41
42
 
43
+ Style/AccessorGrouping:
44
+ Enabled: true
45
+
46
+ Style/ArrayCoercion:
47
+ Enabled: true
48
+
49
+ Style/BisectedAttrAccessor:
50
+ Enabled: true
51
+
52
+ Style/CaseLikeIf:
53
+ Enabled: true
54
+
55
+ Style/ExplicitBlockArgument:
56
+ Enabled: true
57
+
58
+ Style/ExponentialNotation:
59
+ Enabled: true
60
+
61
+ Style/GlobalStdStream:
62
+ Enabled: true
63
+
64
+ Style/HashAsLastArrayItem:
65
+ Enabled: true
66
+
67
+ Style/HashEachMethods:
68
+ Enabled: true
69
+
70
+ Style/HashLikeCase:
71
+ Enabled: true
72
+
73
+ Style/HashTransformKeys:
74
+ Enabled: true
75
+
76
+ Style/HashTransformValues:
77
+ Enabled: true
78
+
79
+ Style/OptionalBooleanParameter:
80
+ Enabled: true
81
+
82
+ Style/RedundantAssignment:
83
+ Enabled: true
84
+
85
+ Style/RedundantFetchBlock:
86
+ Enabled: true
87
+
88
+ Style/RedundantFileExtensionInRequire:
89
+ Enabled: true
90
+
91
+ Style/RedundantRegexpCharacterClass:
92
+ Enabled: true
93
+
94
+ Style/RedundantRegexpEscape:
95
+ Enabled: true
96
+
97
+ Style/SingleArgumentDig:
98
+ Enabled: true
99
+
100
+ Style/SlicingWithRange:
101
+ Enabled: true
102
+
103
+ Style/StringConcatenation:
104
+ Enabled: true
105
+
106
+ Layout/EmptyLinesAroundAttributeAccessor:
107
+ Enabled: true
108
+
109
+ Layout/SpaceAroundMethodCallOperator:
110
+ Enabled: true
111
+
42
112
  Layout/LineLength:
43
113
  Max: 140
44
114
 
@@ -49,15 +119,9 @@ Layout/ClassStructure:
49
119
  - include
50
120
  - prepend
51
121
  - extend
52
- associations:
53
- - has_one
54
- - has_many
55
- - belongs_to
56
- - has_and_belongs_to_many
57
122
  ExpectedOrder:
58
123
  - module_inclusion
59
124
  - constants
60
- - associations
61
125
  - public_class_methods
62
126
  - initializer
63
127
  - public_methods
@@ -70,39 +134,6 @@ Layout/EmptyLineAfterGuardClause:
70
134
  Lint/NonDeterministicRequireOrder:
71
135
  Enabled: false
72
136
 
73
- RSpec/ExampleLength:
74
- Enabled: false
75
-
76
- RSpec/NestedGroups:
77
- Enabled: false
78
-
79
- RSpec/MultipleExpectations:
80
- Enabled: false
81
-
82
- RSpec/MessageChain:
83
- Enabled: false
84
-
85
- RSpec/ContextWording:
86
- Enabled: false
87
-
88
- RSpec/AnyInstance:
89
- Enabled: false
90
-
91
- RSpec/MessageSpies:
92
- Enabled: false
93
-
94
- RSpec/MultipleDescribes:
95
- Enabled: false
96
-
97
- RSpec/MultipleMemoizedHelpers:
98
- Enabled: false
99
-
100
- Layout/EmptyLinesAroundAttributeAccessor:
101
- Enabled: true
102
-
103
- Layout/SpaceAroundMethodCallOperator:
104
- Enabled: true
105
-
106
137
  Lint/BinaryOperatorWithIdenticalOperands:
107
138
  Enabled: true
108
139
 
@@ -145,65 +176,53 @@ Lint/TopLevelReturnWithArgument:
145
176
  Lint/UnreachableLoop:
146
177
  Enabled: true
147
178
 
148
- Style/AccessorGrouping:
149
- Enabled: true
150
-
151
- Style/ArrayCoercion:
152
- Enabled: true
153
-
154
- Style/BisectedAttrAccessor:
155
- Enabled: true
156
-
157
- Style/CaseLikeIf:
179
+ Performance/AncestorsInclude:
158
180
  Enabled: true
159
181
 
160
- Style/ExplicitBlockArgument:
182
+ Performance/BigDecimalWithNumericArgument:
161
183
  Enabled: true
162
184
 
163
- Style/ExponentialNotation:
185
+ Performance/RedundantSortBlock:
164
186
  Enabled: true
165
187
 
166
- Style/GlobalStdStream:
188
+ Performance/RedundantStringChars:
167
189
  Enabled: true
168
190
 
169
- Style/HashAsLastArrayItem:
191
+ Performance/ReverseFirst:
170
192
  Enabled: true
171
193
 
172
- Style/HashEachMethods:
194
+ Performance/SortReverse:
173
195
  Enabled: true
174
196
 
175
- Style/HashLikeCase:
197
+ Performance/Squeeze:
176
198
  Enabled: true
177
199
 
178
- Style/HashTransformKeys:
200
+ Performance/StringInclude:
179
201
  Enabled: true
180
202
 
181
- Style/HashTransformValues:
182
- Enabled: true
183
-
184
- Style/OptionalBooleanParameter:
185
- Enabled: true
203
+ RSpec/ExampleLength:
204
+ Enabled: false
186
205
 
187
- Style/RedundantAssignment:
188
- Enabled: true
206
+ RSpec/NestedGroups:
207
+ Enabled: false
189
208
 
190
- Style/RedundantFetchBlock:
191
- Enabled: true
209
+ RSpec/MultipleExpectations:
210
+ Enabled: false
192
211
 
193
- Style/RedundantFileExtensionInRequire:
194
- Enabled: true
212
+ RSpec/MessageChain:
213
+ Enabled: false
195
214
 
196
- Style/RedundantRegexpCharacterClass:
197
- Enabled: true
215
+ RSpec/ContextWording:
216
+ Enabled: false
198
217
 
199
- Style/RedundantRegexpEscape:
200
- Enabled: true
218
+ RSpec/AnyInstance:
219
+ Enabled: false
201
220
 
202
- Style/SingleArgumentDig:
203
- Enabled: true
221
+ RSpec/MessageSpies:
222
+ Enabled: false
204
223
 
205
- Style/SlicingWithRange:
206
- Enabled: true
224
+ RSpec/MultipleDescribes:
225
+ Enabled: false
207
226
 
208
- Style/StringConcatenation:
209
- Enabled: true
227
+ RSpec/MultipleMemoizedHelpers:
228
+ Enabled: false
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  # Changelog
2
2
  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).
3
3
 
4
+ ## [0.2.0] - 2020-08-31
5
+
6
+ ### Added
7
+
8
+ - auditor RSpec helper
9
+
10
+ ### Removed
11
+
12
+ - gem public documentation
13
+
4
14
  ## [0.1.3] - 2020-08-24
5
15
 
6
16
  ### Added
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- truemail-rspec (0.1.3)
4
+ truemail-rspec (0.2.0)
5
5
  rspec (~> 3.9)
6
6
  truemail (~> 1.4, >= 1.4.1)
7
7
 
@@ -72,6 +72,8 @@ GEM
72
72
  unicode-display_width (>= 1.4.0, < 2.0)
73
73
  rubocop-ast (0.3.0)
74
74
  parser (>= 2.7.1.4)
75
+ rubocop-performance (1.7.1)
76
+ rubocop (>= 0.82.0)
75
77
  rubocop-rspec (1.43.1)
76
78
  rubocop (~> 0.87)
77
79
  ruby-progressbar (1.10.1)
@@ -86,7 +88,7 @@ GEM
86
88
  simpleidn (0.1.1)
87
89
  unf (~> 0.1.4)
88
90
  thor (1.0.1)
89
- truemail (1.6.1)
91
+ truemail (1.8.0)
90
92
  simpleidn (~> 0.1.1)
91
93
  unf (0.1.4)
92
94
  unf_ext
@@ -107,6 +109,7 @@ DEPENDENCIES
107
109
  reek (~> 6.0, >= 6.0.1)
108
110
  rspec (~> 3.9)
109
111
  rubocop (~> 0.89.1)
112
+ rubocop-performance (~> 1.7, >= 1.7.1)
110
113
  rubocop-rspec (~> 1.43, >= 1.43.1)
111
114
  simplecov (~> 0.17.1)
112
115
  truemail-rspec!
data/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # <img src='https://repository-images.githubusercontent.com/222414074/393c9600-09f9-11ea-8d21-345619b97b11' height='250' alt='Truemail RSpec helpers' />
1
+ ![Truemail RSpec helpers](https://repository-images.githubusercontent.com/222414074/393c9600-09f9-11ea-8d21-345619b97b11)
2
2
 
3
3
  [![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) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
4
4
 
@@ -13,9 +13,11 @@
13
13
  - [Create configuration instance](#create-configuration-instance)
14
14
  - [Configuration instance with default random params](#configuration-instance-with-default-random-params)
15
15
  - [Configuration instance with predefined params](#configuration-instance-with-predefined-params)
16
+ - [Create auditor instance](#create-auditor-instance)
17
+ - [create_auditor](#create-auditor)
16
18
  - [Create validator instance](#create-validator-instance)
17
19
  - [create_servers_list](#create_servers_list)
18
- - [create_validator DSL](#create_validator-dsl)
20
+ - [create_validator](#create_validator)
19
21
  - [Truemail family](#truemail-family)
20
22
  - [Contributing](#contributing)
21
23
  - [License](#license)
@@ -85,6 +87,23 @@ create_configuration(verifier_email: 'email@domain.com', verifier_domain: 'other
85
87
  # => returns Truemail::Configuration instance with custom settings
86
88
  ```
87
89
 
90
+ ### Create auditor instance
91
+
92
+ Allows to create auditor instance with default random or with predefined params.
93
+
94
+ #### create_auditor
95
+
96
+ ```ruby
97
+ create_auditor(
98
+ success: true, # optional, type:Bool, by default true
99
+ current_host_ip: current_host_ip, # optional, type:String, by default random IPv4 address
100
+ warnings: warnings, # optional, type:Hash, by default creates auditor result warnings
101
+ configuration: create_configuration # optional, type:Truemail::Configuration, by default creates random configuration
102
+ )
103
+
104
+ # => returns Truemail::Auditor instance follow passed params
105
+ ```
106
+
88
107
  ### Create validator instance
89
108
 
90
109
  Allows to create validator instance with default random or with predefined params.
@@ -95,7 +114,7 @@ Allows to create validator instance with default random or with predefined param
95
114
  create_servers_list # => returns array with random ip addresses
96
115
  ```
97
116
 
98
- #### create_validator DSL
117
+ #### create_validator
99
118
 
100
119
  ```ruby
101
120
  create_validator(
data/lib/truemail/rspec.rb CHANGED
@@ -2,11 +2,13 @@
2
2
 
3
3
  require 'truemail/rspec/version'
4
4
  require 'truemail/rspec/configuration_helper'
5
+ require 'truemail/rspec/auditor_helper'
5
6
  require 'truemail/rspec/validator_helper'
6
7
 
7
8
  module Truemail
8
9
  module RSpec
9
10
  include Truemail::RSpec::ConfigurationHelper
11
+ include Truemail::RSpec::AuditorHelper
10
12
  include Truemail::RSpec::ValidatorHelper
11
13
  end
12
14
  end
data/lib/truemail/rspec/auditor_helper.rb ADDED
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Truemail
4
+ module RSpec
5
+ module AuditorHelper
6
+ def create_auditor(
7
+ success: true,
8
+ current_host_ip: FFaker::Internet.ip_v4_address,
9
+ warnings: { ip: Truemail::Audit::Ip::IPIFY_ERROR },
10
+ configuration: create_configuration
11
+ )
12
+ Truemail::Auditor.new(configuration: configuration).tap do |auditor|
13
+ auditor_result = auditor.result
14
+ auditor_result.current_host_ip = current_host_ip if success
15
+ auditor_result.warnings = warnings unless success
16
+ end
17
+ end
18
+ end
19
+ end
20
+ end
data/lib/truemail/rspec/version.rb CHANGED
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Truemail
4
4
  module RSpec
5
- VERSION = '0.1.3'
5
+ VERSION = '0.2.0'
6
6
  end
7
7
  end
data/truemail-rspec.gemspec CHANGED
@@ -16,6 +16,14 @@ Gem::Specification.new do |spec|
16
16
  spec.homepage = 'https://github.com/truemail-rb/truemail-rspec'
17
17
  spec.license = 'MIT'
18
18
 
19
+ spec.metadata = {
20
+ 'homepage_uri' => 'https://truemail-rb.org',
21
+ 'changelog_uri' => 'https://github.com/truemail-rb/truemail-rspec/blob/master/CHANGELOG.md',
22
+ 'source_code_uri' => 'https://github.com/truemail-rb/truemail-rspec',
23
+ 'documentation_uri' => 'https://truemail-rb.org/truemail-rspec/',
24
+ 'bug_tracker_uri' => 'https://github.com/truemail-rb/truemail-rspec/issues'
25
+ }
26
+
19
27
  spec.required_ruby_version = '>= 2.5.0'
20
28
 
21
29
  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -33,6 +41,7 @@ Gem::Specification.new do |spec|
33
41
  spec.add_development_dependency 'reek', '~> 6.0', '>= 6.0.1'
34
42
  spec.add_development_dependency 'rspec', '~> 3.9'
35
43
  spec.add_development_dependency 'rubocop', '~> 0.89.1'
44
+ spec.add_development_dependency 'rubocop-performance', '~> 1.7', '>= 1.7.1'
36
45
  spec.add_development_dependency 'rubocop-rspec', '~> 1.43', '>= 1.43.1'
37
46
  spec.add_development_dependency 'simplecov', '~> 0.17.1'
38
47
  spec.add_runtime_dependency 'rspec', '~> 3.9'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: truemail-rspec
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.3
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Vladislav Trotsenko
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2020-08-24 00:00:00.000000000 Z
11
+ date: 2020-08-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -162,6 +162,26 @@ dependencies:
162
162
  - - "~>"
163
163
  - !ruby/object:Gem::Version
164
164
  version: 0.89.1
165
+ - !ruby/object:Gem::Dependency
166
+ name: rubocop-performance
167
+ requirement: !ruby/object:Gem::Requirement
168
+ requirements:
169
+ - - "~>"
170
+ - !ruby/object:Gem::Version
171
+ version: '1.7'
172
+ - - ">="
173
+ - !ruby/object:Gem::Version
174
+ version: 1.7.1
175
+ type: :development
176
+ prerelease: false
177
+ version_requirements: !ruby/object:Gem::Requirement
178
+ requirements:
179
+ - - "~>"
180
+ - !ruby/object:Gem::Version
181
+ version: '1.7'
182
+ - - ">="
183
+ - !ruby/object:Gem::Version
184
+ version: 1.7.1
165
185
  - !ruby/object:Gem::Dependency
166
186
  name: rubocop-rspec
167
187
  requirement: !ruby/object:Gem::Requirement
@@ -258,16 +278,8 @@ files:
258
278
  - Rakefile
259
279
  - bin/console
260
280
  - bin/setup
261
- - docs/.nojekyll
262
- - docs/_coverpage.md
263
- - docs/_sidebar.md
264
- - docs/contact-support.md
265
- - docs/index.html
266
- - docs/introduction.md
267
- - docs/quick-start.md
268
- - docs/truemail-family.md
269
- - docs/usage.md
270
281
  - lib/truemail/rspec.rb
282
+ - lib/truemail/rspec/auditor_helper.rb
271
283
  - lib/truemail/rspec/configuration_helper.rb
272
284
  - lib/truemail/rspec/validator_helper.rb
273
285
  - lib/truemail/rspec/version.rb
@@ -275,7 +287,12 @@ files:
275
287
  homepage: https://github.com/truemail-rb/truemail-rspec
276
288
  licenses:
277
289
  - MIT
278
- metadata: {}
290
+ metadata:
291
+ homepage_uri: https://truemail-rb.org
292
+ changelog_uri: https://github.com/truemail-rb/truemail-rspec/blob/master/CHANGELOG.md
293
+ source_code_uri: https://github.com/truemail-rb/truemail-rspec
294
+ documentation_uri: https://truemail-rb.org/truemail-rspec/
295
+ bug_tracker_uri: https://github.com/truemail-rb/truemail-rspec/issues
279
296
  post_install_message:
280
297
  rdoc_options: []
281
298
  require_paths:
data/docs/.nojekyll DELETED
File without changes
data/docs/_coverpage.md DELETED
@@ -1,8 +0,0 @@
1
- ![logo](https://repository-images.githubusercontent.com/222414074/393c9600-09f9-11ea-8d21-345619b97b11)
2
-
3
- # truemail-rspec
4
-
5
- > Truemail Configuration and Validator helpers for your RSpec environment.
6
-
7
- [Get Started](introduction)
8
- [GitHub](https://github.com/truemail-rb/truemail-rspec)
data/docs/_sidebar.md DELETED
@@ -1,9 +0,0 @@
1
- - [Introduction](introduction)
2
- - [Quick Start](quick-start)
3
- - [Usage](usage)
4
- - [Contact & Support](contact-support)
5
- - [Truemail Family](truemail-family)
6
- - [Changelog](changelog)
7
- - **Links**
8
- - [![GitHub](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)GitHub](https://github.com/truemail-rb/truemail-rspec)
9
- - [![Ruby Gems](https://icongr.am/devicon/ruby-plain.svg?size=16&color=currentColor&size=16)Ruby Gems](https://rubygems.org/gems/truemail-rspec)
data/docs/contact-support.md DELETED
@@ -1,14 +0,0 @@
1
- # Contact & Support
2
-
3
- ## Contributing
4
-
5
- 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 tikets](https://github.com/truemail-rb/truemail-rspec/issues). Be shure to follow Contributor Code of Conduct below and our [Contributing Guidelines](CONTRIBUTING.md).
6
-
7
- ## Code of Conduct
8
-
9
- 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).
10
-
11
- ## Credits
12
-
13
- - [The Contributors](https://github.com/truemail-rb/truemail-rspec/graphs/contributors) for code and awesome suggestions
14
- - [The Stargazers](https://github.com/truemail-rb/truemail-rspec/stargazers) for showing their support
data/docs/index.html DELETED
@@ -1,40 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="UTF-8">
5
- <title>truemail-rspec docs</title>
6
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
7
- <meta name="description" content="truemail-rspec gem documentation">
8
- <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
9
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
10
- </head>
11
- <body>
12
- <div id="app"></div>
13
- <script>
14
- window.$docsify = {
15
- name: 'truemail-rspec',
16
- repo: 'https://github.com/truemail-rb/truemail-rspec',
17
- coverpage: true,
18
- loadSidebar: true,
19
- homepage: 'introduction.md',
20
- alias: {
21
- '.*?/changelog': 'https://raw.githubusercontent.com/truemail-rb/truemail-rspec/master/CHANGELOG.md',
22
- },
23
- auto2top: true,
24
- maxLevel: 3,
25
- subMaxLevel: 3,
26
- search: {
27
- depth: 3,
28
- noData: 'No results!',
29
- placeholder: 'Search...'
30
- }
31
- };
32
- </script>
33
- <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
34
- <script src="//cdn.jsdelivr.net/npm/docsify-copy-code@2"></script>
35
- <script src="//cdn.jsdelivr.net/npm/docsify-pagination@2/dist/docsify-pagination.min.js"></script>
36
- <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
37
- <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-ruby.min.js"></script>
38
- <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
39
- </body>
40
- </html>
data/docs/introduction.md DELETED
@@ -1,18 +0,0 @@
1
- # Introduction
2
-
3
- [![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) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
4
-
5
- `truemail-rspec` gem helps you create `Truemail::Configuration` and `Truemail::Validator` instances for your RSpec environment.
6
-
7
- ## Features
8
-
9
- - Ability to create `Truemail::Configuration` instance with random or with predefined params
10
- - Ability to create `Truemail::Validator` instance with random or with predefined params
11
-
12
- ## License
13
-
14
- The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
15
-
16
- ## Versioning
17
-
18
- `truemail-rspec` uses [Semantic Versioning 2.0.0](https://semver.org)
data/docs/quick-start.md DELETED
@@ -1,33 +0,0 @@
1
- # Quick Start
2
-
3
- ## Requirements
4
-
5
- !> Ruby MRI 2.5.0+
6
-
7
- ## Installation
8
-
9
- Add this line to your application's `Gemfile`:
10
-
11
- ```ruby
12
- group :development, :test do
13
- gem 'truemail-rspec', require: false
14
- end
15
- ```
16
-
17
- And add into your `spec_helper.rb` or `rails_helper.rb`:
18
-
19
- ```ruby
20
- require 'truemail/rspec'
21
-
22
- RSpec.configure do |config|
23
- config.include Truemail::RSpec
24
- end
25
- ```
26
-
27
- And then execute:
28
-
29
- $ bundle
30
-
31
- Or install it yourself as:
32
-
33
- $ gem install truemail-rspec
data/docs/truemail-family.md DELETED
@@ -1,11 +0,0 @@
1
- # Truemail Family
2
-
3
- ?> All Truemail extensions: https://github.com/truemail-rb
4
-
5
- | Name | Type | Description |
6
- | --- | --- | --- |
7
- | [truemail](https://github.com/rubygarage/truemail) | ruby gem | Configurable plain Ruby email validator, main core |
8
- | [truemail server](https://github.com/truemail-rb/truemail-rack) | ruby app | Lightweight rack based web API wrapper for Truemail |
9
- | [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 |
10
- | [truemail-ruby-client](https://github.com/truemail-rb/truemail-ruby-client) | ruby gem | Truemail web API client library for Ruby |
11
- | [truemail-crystal-client](https://github.com/truemail-rb/truemail-crystal-client) | crystal shard | Truemail web API client library for Crystal |
data/docs/usage.md DELETED
@@ -1,47 +0,0 @@
1
- # Usage
2
-
3
- ## Create configuration instance
4
-
5
- Allows to create configuration instance with random or with predefined params.
6
-
7
- ### Configuration instance with default random params
8
-
9
- ```ruby
10
- create_configuration
11
-
12
- # => returns Truemail::Configuration instance with
13
- # random verifier_email and default Truemail::Configuration params
14
- ```
15
-
16
- ### Configuration instance with predefined params
17
-
18
- All `Truemail::Configuration` [available params](https://github.com/rubygarage/truemail#setting-global-configuration)
19
-
20
- ```ruby
21
- create_configuration(verifier_email: 'email@domain.com', verifier_domain: 'other-domain.com')
22
- # => returns Truemail::Configuration instance with custom settings
23
- ```
24
-
25
- ## Create validator instance
26
-
27
- Allows to create validator instance with default random or with predefined params.
28
-
29
- ### create_servers_list
30
-
31
- ```ruby
32
- create_servers_list # => returns array with random ip addresses
33
- ```
34
-
35
- ### create_validator DSL
36
-
37
- ```ruby
38
- create_validator(
39
- validation_type, # optional, type:Symbol, can be :regex, :mx or :smtp, by default creates :smtp validation
40
- email, # optional, type:String, by default random email
41
- mail_servers, # optional, type:Array(String), by default array with random ip addresses
42
- success: true, # optional, type:Bool, by default true
43
- configuration: create_configuration # optional, type:Truemail::Configuration, by default creates random configuration
44
- )
45
-
46
- # => returns Truemail::Validator instance follow passed params
47
- ```