mailgun-ruby 1.3.1 → 1.3.3

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 (36) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/CHANGELOG.md +27 -0
  4. data/README.md +1 -2
  5. data/docs/MessageBuilder.md +12 -0
  6. data/lib/mailgun/client.rb +2 -0
  7. data/lib/mailgun/domains/domains.rb +19 -0
  8. data/lib/mailgun/messages/message_builder.rb +12 -1
  9. data/lib/mailgun/version.rb +1 -1
  10. data/mailgun.gemspec +4 -2
  11. data/spec/integration/domains_spec.rb +95 -92
  12. data/spec/integration/email_validation_spec.rb +2 -1
  13. data/spec/integration/list_spec.rb +1 -1
  14. data/spec/integration/mailer_spec.rb +5 -5
  15. data/spec/integration/mailgun_spec.rb +9 -7
  16. data/spec/integration/routes_spec.rb +17 -1
  17. data/spec/integration/stats_spec.rb +1 -1
  18. data/spec/integration/unsubscribes_spec.rb +2 -2
  19. data/spec/integration/webhook_spec.rb +1 -1
  20. data/spec/spec_helper.rb +1 -0
  21. data/spec/unit/events/events_spec.rb +1 -1
  22. data/spec/unit/messages/message_builder_spec.rb +1 -1
  23. data/vcr_cassettes/bounces.yml +29 -277
  24. data/vcr_cassettes/complaints.yml +66 -136
  25. data/vcr_cassettes/domains.yml +288 -1451
  26. data/vcr_cassettes/email_validation.yml +37 -229
  27. data/vcr_cassettes/events.yml +20 -792
  28. data/vcr_cassettes/exceptions.yml +1 -1
  29. data/vcr_cassettes/list_members.yml +66 -394
  30. data/vcr_cassettes/mailing_list.yml +8 -8
  31. data/vcr_cassettes/routes.yml +90 -398
  32. data/vcr_cassettes/stats.yml +3 -44
  33. data/vcr_cassettes/suppressions.yml +159 -1162
  34. data/vcr_cassettes/unsubscribes.yml +4 -4
  35. metadata +35 -11
  36. data/docs/Messages.md +0 -107
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4cd509b2c1f407b43b66a9ef400bb94845be7bf358ee0516dfc64f8ef9f139b7
4
- data.tar.gz: aad61052482bfb86b04ef0111a4495346d2b48cf046543c1c2fb600ca06916db
3
+ metadata.gz: 898306ea7328a14244502b3d2ff1a17e8bef15cf7e0851bcce8967622a817a7b
4
+ data.tar.gz: d131c5aa68d89c974e49cbe48a4d225866d035e3b04f39002cd018a3efc806f2
5
5
  SHA512:
6
- metadata.gz: 452423c6da36c0f23ec08d3a613002027fa80c41f48c3b0a8072ccc35df1230d16512273bce584ea470dc9ba05f557e8a5a617a95efe5305e663d2de4f18b54b
7
- data.tar.gz: 5b28c5065060bcff51c7711b0a4b32796fa2c79ef83251fff5a11fbd0a573c80f4d7018b289c42d9a3c273d21941ffd7fa8eee3dcd317bf7463a45fd4131899d
6
+ metadata.gz: 2fda61d4a1d727a9eecfcde2647414f10db540f3c1409aaa6ef6d35a7825b52c3e8a5f6028b80a6278f435b0fc5b08ba3ddbca73376bab76888b0cba56399b9a
7
+ data.tar.gz: 27716e8b77cf7e9a3a95f35896f402a62a8f5c31c65caf7fc4ce74f2ceac9f076757a79a5467114443a01a3f9cb983e40631de3921e56729dce4dc39a71170e0
data/.gitignore CHANGED
@@ -21,3 +21,4 @@ ruby
21
21
  .ruby-env.yml
22
22
  .rspec-local
23
23
  .tool-versions
24
+ .idea
data/CHANGELOG.md CHANGED
@@ -4,6 +4,33 @@ All notable changes to this project will be documented in this file.
4
4
 
5
5
  ## [Unreleased]
6
6
 
7
+ ## [1.3.2] - 2025-01-30
8
+
9
+ ### Fixed
10
+
11
+ - Use Faraday::FlatParamsEncoder (https://github.com/mailgun/mailgun-ruby/pull/334)
12
+ - Update Message Builder doc (https://github.com/mailgun/mailgun-ruby/pull/338)
13
+ - Add Domain api version warnings (https://github.com/mailgun/mailgun-ruby/pull/339)
14
+
15
+ ## [1.3.1] - 2025-01-26
16
+
17
+ ### Fixed
18
+
19
+ - Fix mock mailgun responds (https://github.com/mailgun/mailgun-ruby/pull/331)
20
+ - Change mime-types to runtime dependency (https://github.com/mailgun/mailgun-ruby/pull/332)
21
+
22
+ ## [1.3.0] - 2025-01-26
23
+
24
+ ### Added
25
+
26
+ - Faraday as http client (https://github.com/mailgun/mailgun-ruby/pull/330)
27
+
28
+ ### Fixed
29
+
30
+ - Added documentation for updating webhook (https://github.com/mailgun/mailgun-ruby/pull/325)
31
+ - Remove duplicated entry from CHANGELOG (https://github.com/mailgun/mailgun-ruby/pull/318)
32
+ - Update template and metrics docs (https://github.com/mailgun/mailgun-ruby/pull/329)
33
+
7
34
  ## [1.2.16] - 2024-11-29
8
35
 
9
36
  ### Added
data/README.md CHANGED
@@ -19,7 +19,7 @@ gem install mailgun-ruby
19
19
  Gemfile:
20
20
 
21
21
  ```ruby
22
- gem 'mailgun-ruby', '~>1.2.16'
22
+ gem 'mailgun-ruby', '~>1.3.2'
23
23
  ```
24
24
 
25
25
  Usage
@@ -181,7 +181,6 @@ For usage examples on each API endpoint, head over to our official documentation
181
181
  pages. Or the [Snippets](docs/Snippets.md) file.
182
182
 
183
183
  This SDK includes the following components:
184
- - [Messages](docs/Messages.md)
185
184
  - [Message Builder](docs/MessageBuilder.md)
186
185
  - [Batch Message](docs/MessageBuilder.md#usage---batch-message)
187
186
  - [Opt-In Handler](docs/OptInHandler.md)
data/docs/MessageBuilder.md CHANGED
@@ -31,12 +31,18 @@ mb_obj.add_recipient(:to, "john.doe@example.com", {"first" => "John", "last" =>
31
31
  # Define a cc recipient.
32
32
  mb_obj.add_recipient(:cc, "sally.doe@example.com", {"first" => "Sally", "last" => "Doe"});
33
33
 
34
+ # Define the reply-to address.
35
+ mb_obj.reply_to("bob.doe@example.com", {"first" => "Bob", "last" => "Doe"});
36
+
34
37
  # Define the subject.
35
38
  mb_obj.subject("A message from the Ruby SDK using Message Builder!");
36
39
 
37
40
  # Define the body of the message.
38
41
  mb_obj.body_text("This is the text body of the message!");
39
42
 
43
+ # Define the HTML text of the message
44
+ mb_obj.body_html("<html><body><p>This is the text body of the message</p></body></html>");
45
+
40
46
  # Set the Message-Id header, provide a valid Message-Id.
41
47
  mb_obj.message_id("<20141014000000.11111.11111@example.com>")
42
48
 
@@ -63,6 +69,12 @@ mb_obj.add_inline_image "/path/to/file/header.png"
63
69
  # Schedule message in the future
64
70
  mb_obj.deliver_at("tomorrow 8:00AM PST");
65
71
 
72
+ # Turn Click Tracking on
73
+ mb_obj.track_clicks(true)
74
+
75
+ # Turn Click Tracking off
76
+ mb_obj.track_clicks(false)
77
+
66
78
  # Finally, send your message using the client
67
79
  result = mg_client.send_message("sending_domain.com", mb_obj)
68
80
 
data/lib/mailgun/client.rb CHANGED
@@ -33,10 +33,12 @@ module Mailgun
33
33
  request_options.merge!(request: {timeout: timeout}) if timeout
34
34
 
35
35
  @http_client = Faraday.new(request_options) do |conn|
36
+ conn.request :multipart
36
37
  conn.request :authorization, :basic, 'api', api_key
37
38
  conn.request :url_encoded
38
39
  conn.response :raise_error, include_request: true
39
40
  conn.adapter Faraday.default_adapter
41
+ conn.options.params_encoder = Faraday::FlatParamsEncoder
40
42
  end
41
43
 
42
44
  @test_mode = test_mode
data/lib/mailgun/domains/domains.rb CHANGED
@@ -19,6 +19,7 @@ module Mailgun
19
19
  #
20
20
  # Returns [Array] A list of domains (hash)
21
21
  def list(options = {})
22
+ warn('WARN: Client api version must be v4') unless @client.api_version == 'v4'
22
23
  @client.get('domains', options).to_h['items']
23
24
  end
24
25
  alias_method :get_domains, :list
@@ -29,6 +30,7 @@ module Mailgun
29
30
  #
30
31
  # Returns [Hash] Information on the requested domains.
31
32
  def info(domain)
33
+ warn('WARN: Client api version must be v4') unless @client.api_version == 'v4'
32
34
  fail(ParameterError, 'No domain given to find on Mailgun', caller) unless domain
33
35
  @client.get("domains/#{domain}").to_h!
34
36
  end
@@ -43,6 +45,7 @@ module Mailgun
43
45
  #
44
46
  # Returns [Hash] Information on the updated/verified domains
45
47
  def verify(domain)
48
+ warn('WARN: Client api version must be v4') unless @client.api_version == 'v4'
46
49
  fail(ParameterError, 'No domain given to verify on Mailgun', caller) unless domain
47
50
  @client.put("domains/#{domain}/verify", nil).to_h!
48
51
  end
@@ -61,6 +64,7 @@ module Mailgun
61
64
  #
62
65
  # Returns [Hash] of created domain
63
66
  def create(domain, options = {})
67
+ warn('WARN: Client api version must be v4') unless @client.api_version == 'v4'
64
68
  fail(ParameterError, 'No domain given to add on Mailgun', caller) unless domain
65
69
  options = { smtp_password: nil, spam_action: 'disabled', wildcard: false }.merge(options)
66
70
  options[:name] = domain
@@ -75,6 +79,7 @@ module Mailgun
75
79
  #
76
80
  # Returns [Boolean] if successful or not
77
81
  def remove(domain)
82
+ warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
78
83
  fail(ParameterError, 'No domain given to remove on Mailgun', caller) unless domain
79
84
  @client.delete("domains/#{domain}").to_h['message'] == 'Domain has been deleted'
80
85
  end
@@ -95,6 +100,7 @@ module Mailgun
95
100
  #
96
101
  # Returns [Hash] of updated domain
97
102
  def update(domain, options = {})
103
+ warn('WARN: Client api version must be v4') unless @client.api_version == 'v4'
98
104
  fail(ParameterError, 'No domain given to update on Mailgun', caller) unless domain
99
105
  @client.put("domains/#{domain}", options).to_h
100
106
  end
@@ -108,6 +114,7 @@ module Mailgun
108
114
  #
109
115
  # Returns [Hash] with message key
110
116
  def create_smtp_credentials(domain, options = {})
117
+ warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
111
118
  fail(ParameterError, 'No domain given to create credentials on Mailgun', caller) unless domain
112
119
  @client.post("domains/#{domain}/credentials", options).to_h
113
120
  end
@@ -121,6 +128,7 @@ module Mailgun
121
128
  #
122
129
  # Returns [Hash] with message key
123
130
  def update_smtp_credentials(domain, login, options = {})
131
+ warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
124
132
  fail(ParameterError, 'No domain given to update credentials on Mailgun', caller) unless domain
125
133
  fail(ParameterError, 'No login given to update credentials on Mailgun', caller) unless login
126
134
  @client.put("domains/#{domain}/credentials/#{login}", options).to_h
@@ -133,6 +141,7 @@ module Mailgun
133
141
  #
134
142
  # Returns [Hash] with message and spec keys
135
143
  def delete_smtp_credentials(domain, login)
144
+ warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
136
145
  fail(ParameterError, 'No domain given to delete credentials on Mailgun', caller) unless domain
137
146
  fail(ParameterError, 'No login given to delete credentials on Mailgun', caller) unless login
138
147
  @client.delete("domains/#{domain}/credentials/#{login}").to_h
@@ -144,6 +153,7 @@ module Mailgun
144
153
  #
145
154
  # Returns [Hash] Information on the delivery connection settings
146
155
  def get_domain_connection_settings(domain)
156
+ warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
147
157
  fail(ParameterError, 'No domain given to retrieve connections on Mailgun', caller) unless domain
148
158
  @client.get("domains/#{domain}/connection").to_h
149
159
  end
@@ -158,6 +168,7 @@ module Mailgun
158
168
  #
159
169
  # Returns [Hash] Information on the delivery connection settings
160
170
  def update_domain_connection_settings(domain, options = {})
171
+ warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
161
172
  fail(ParameterError, 'No domain given to update connections on Mailgun', caller) unless domain
162
173
  @client.put("domains/#{domain}/connection", options).to_h
163
174
  end
@@ -168,6 +179,7 @@ module Mailgun
168
179
  #
169
180
  # Returns [Hash] Information on the tracking settings
170
181
  def get_domain_tracking_settings(domain)
182
+ warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
171
183
  fail(ParameterError, 'No domain given to retrieve tracking settings on Mailgun', caller) unless domain
172
184
  @client.get("domains/#{domain}/tracking").to_h
173
185
  end
@@ -181,6 +193,7 @@ module Mailgun
181
193
  #
182
194
  # Returns [Hash] Information on the tracking open settings
183
195
  def update_domain_tracking_open_settings(domain, options = {})
196
+ warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
184
197
  fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
185
198
  @client.put("domains/#{domain}/tracking/open", options).to_h
186
199
  end
@@ -193,6 +206,7 @@ module Mailgun
193
206
  #
194
207
  # Returns [Hash] Information on the tracking click settings
195
208
  def update_domain_tracking_click_settings(domain, options = {})
209
+ warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
196
210
  fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
197
211
  @client.put("domains/#{domain}/tracking/click", options).to_h
198
212
  end
@@ -207,6 +221,7 @@ module Mailgun
207
221
  #
208
222
  # Returns [Hash] Information on the tracking unsubscribe settings
209
223
  def update_domain_tracking_unsubscribe_settings(domain, options = {})
224
+ warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
210
225
  fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
211
226
  @client.put("domains/#{domain}/tracking/unsubscribe", options).to_h
212
227
  end
@@ -220,6 +235,7 @@ module Mailgun
220
235
  #
221
236
  # Returns [Hash] Information on the DKIM authority
222
237
  def update_domain_dkim_authority(domain, options = {})
238
+ warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
223
239
  fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
224
240
  @client.put("domains/#{domain}/dkim_authority", options).to_h
225
241
  end
@@ -232,6 +248,7 @@ module Mailgun
232
248
  #
233
249
  # Returns [Hash] with message key
234
250
  def update_domain_dkim_selector(domain, options = {})
251
+ warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
235
252
  fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
236
253
  @client.put("domains/#{domain}/dkim_selector", options).to_h
237
254
  end
@@ -244,6 +261,7 @@ module Mailgun
244
261
  #
245
262
  # Returns [Hash] with message key
246
263
  def update_domain_web_prefix(domain, options = {})
264
+ warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
247
265
  fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
248
266
  @client.put("domains/#{domain}/web_prefix", options).to_h
249
267
  end
@@ -323,6 +341,7 @@ module Mailgun
323
341
  #
324
342
  # Returns [Array] A list of domains (hash)
325
343
  def get_domain_stats(domain, options = {})
344
+ warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
326
345
  fail(ParameterError, 'No domain given to list stats on Mailgun', caller) unless domain
327
346
  @client.get("#{domain}/stats/total", options).to_h
328
347
  end
data/lib/mailgun/messages/message_builder.rb CHANGED
@@ -1,5 +1,6 @@
1
1
  require 'mime/types'
2
2
  require 'time'
3
+ require 'faraday/multipart'
3
4
 
4
5
  module Mailgun
5
6
 
@@ -384,6 +385,16 @@ module Mailgun
384
385
  @message[parameter] << (value || '')
385
386
  end
386
387
 
388
+ # Adds multipart attachment using Faraday::Multipart::FilePart
389
+ #
390
+ # @param [String] parameter The message object parameter name.
391
+ # @param [String] value The attachment.
392
+ # @return [void]
393
+ def add_faraday_attachment(parameter, attachment)
394
+ content_type = attachment.respond_to?(:content_type) ? attachment.content_type : nil
395
+ @message[parameter] << Faraday::Multipart::FilePart.new(attachment, content_type)
396
+ end
397
+
387
398
  # Converts boolean type to string
388
399
  #
389
400
  # @param [String] value The item to convert
@@ -469,7 +480,7 @@ module Mailgun
469
480
  attachment.instance_variable_set :@original_filename, filename
470
481
  attachment.instance_eval 'def original_filename; @original_filename; end'
471
482
  end
472
- set_multi_complex(disposition, attachment)
483
+ add_faraday_attachment(disposition, attachment)
473
484
  end
474
485
  end
475
486
 
data/lib/mailgun/version.rb CHANGED
@@ -1,4 +1,4 @@
1
1
  # It's the version. Yeay!
2
2
  module Mailgun
3
- VERSION = '1.3.1'
3
+ VERSION = '1.3.3'
4
4
  end
data/mailgun.gemspec CHANGED
@@ -28,14 +28,16 @@ Gem::Specification.new do |spec|
28
28
  spec.required_ruby_version = '>= 2.2.2'
29
29
 
30
30
  spec.add_development_dependency 'bundler', '>= 1.16.2'
31
- spec.add_development_dependency 'rspec', '~> 3.8.0'
31
+ spec.add_development_dependency 'rspec', '~> 3.13.0'
32
+ spec.add_development_dependency 'rspec-its', '~> 2.0.0'
32
33
  spec.add_development_dependency 'rake', '~> 12.3.2'
33
34
  spec.add_development_dependency 'webmock', '~> 3.7'
34
- spec.add_development_dependency 'pry', '~> 0.11.3'
35
+ spec.add_development_dependency 'pry', '~> 0.15.2'
35
36
  spec.add_development_dependency 'vcr', '~> 3.0.3'
36
37
  spec.add_development_dependency 'simplecov', '~> 0.16.1'
37
38
  spec.add_development_dependency 'rails'
38
39
  spec.add_dependency 'mime-types'
39
40
  spec.add_dependency 'faraday', "~> 2.1"
41
+ spec.add_dependency 'faraday-multipart', '~> 1.1.0'
40
42
 
41
43
  end
data/spec/integration/domains_spec.rb CHANGED
@@ -4,54 +4,67 @@ require 'mailgun'
4
4
  vcr_opts = { :cassette_name => "domains" }
5
5
 
6
6
  describe 'For the domains endpoint', vcr: vcr_opts do
7
- before(:all) do
8
- @mg_client = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
9
- @mg_obj = Mailgun::Domains.new(@mg_client)
10
- @domain = "integration-test.domain.invalid"
11
- end
7
+ let(:api_version) { APIVERSION }
8
+ let(:mg_client) { Mailgun::Client.new(APIKEY, APIHOST, api_version, SSL) }
9
+ let(:mg_obj) { Mailgun::Domains.new(mg_client) }
10
+ let(:domain) { 'integration-test.domain.invalid' }
11
+
12
+ describe '#add_domain' do
13
+ let(:api_version) { 'v4' }
12
14
 
13
- it 'creates the domain' do
14
- result = @mg_obj.add_domain(@domain, { smtp_password: 'super_secret', spam_action: 'tag' })
15
+ it 'creates a domain' do
16
+ response = mg_obj.add_domain(domain, { spam_action: 'tag' })
15
17
 
16
- expect(result['domain']["name"]).to eq(@domain)
17
- expect(result['domain']["spam_action"]).to eq("tag")
18
- expect(result['domain']["smtp_password"]).to eq("super_secret")
18
+ expect(response['domain']['name']).to eq(domain)
19
+ expect(response['domain']['spam_action']).to eq('tag')
20
+ end
19
21
  end
20
22
 
21
- it 'get the domain.' do
22
- result = @mg_obj.get(@domain)
23
+ describe '#get' do
24
+ let(:api_version) { 'v4' }
25
+
26
+ it 'returns the domain' do
27
+ response = mg_obj.get(domain)
23
28
 
24
- expect(result).to include("domain")
25
- expect(result["domain"]["name"]).to eq(@domain)
29
+ expect(response).to include('domain')
30
+ expect(response['domain']['name']).to eq(domain)
31
+ end
26
32
  end
27
33
 
28
- it 'gets a list of domains.' do
29
- result = @mg_obj.get_domains
34
+ describe '#get_domains' do
35
+ let(:api_version) { 'v4' }
36
+
37
+ it 'returns a list of domains' do
38
+ response = mg_obj.get_domains
30
39
 
31
- expect(result.size).to be > 0
40
+ expect(response.size).to be > 0
41
+ end
32
42
  end
33
43
 
34
- it 'deletes a domain.' do
35
- result = @mg_obj.delete(@domain)
44
+ context '#update' do
45
+ let(:api_version) { 'v4' }
36
46
 
37
- expect(result).to be_truthy
47
+ it 'updates the domain' do
48
+ response = mg_obj.update(domain, { spam_action: 'block', web_scheme: 'https', wildcard: true })
49
+
50
+ expect(response['domain']['spam_action']).to eq('block')
51
+ expect(response['domain']['web_scheme']).to eq('https')
52
+ expect(response['domain']['wildcard']).to eq(true)
53
+ end
38
54
  end
39
55
 
40
- it 'updates the domain' do
41
- result = @mg_obj.update(@domain, { spam_action: 'block', web_scheme: 'https', wildcard: true })
56
+ context 'delete a domain' do
57
+ subject(:response) { mg_obj.delete(domain) }
42
58
 
43
- expect(result['domain']["spam_action"]).to eq('block')
44
- expect(result['domain']["web_scheme"]).to eq('https')
45
- expect(result['domain']["wildcard"]).to eq(true)
59
+ it { is_expected.to be_falsey }
46
60
  end
47
61
 
48
62
  describe '#create_smtp_credentials' do
49
63
  it 'creates smtp credentials for domain' do
50
- result = @mg_obj.create_smtp_credentials(
51
- @domain,
64
+ result = mg_obj.create_smtp_credentials(
65
+ domain,
52
66
  {
53
- login: 'test_login',
54
- password: 'test_password'
67
+ login: 'test_login'
55
68
  }
56
69
  )
57
70
 
@@ -61,11 +74,11 @@ describe 'For the domains endpoint', vcr: vcr_opts do
61
74
 
62
75
  describe '#update_smtp_credentials' do
63
76
  it 'updates smtp credentials for domain' do
64
- result = @mg_obj.update_smtp_credentials(
65
- @domain,
77
+ result = mg_obj.update_smtp_credentials(
78
+ domain,
66
79
  'test_login',
67
80
  {
68
- password: 'test_password2'
81
+ spec: 'abc'
69
82
  }
70
83
  )
71
84
 
@@ -75,19 +88,8 @@ describe 'For the domains endpoint', vcr: vcr_opts do
75
88
 
76
89
  describe '#delete_smtp_credentials' do
77
90
  it 'deletes smtp credentials for domain' do
78
- result = @mg_obj.delete_smtp_credentials(
79
- @domain,
80
- 'test_login'
81
- )
82
-
83
- expect(result['message']).to eq('Credentials have been deleted')
84
- end
85
- end
86
-
87
- describe '#delete_smtp_credentials' do
88
- it 'deletes smtp credentials for domain' do
89
- result = @mg_obj.delete_smtp_credentials(
90
- @domain,
91
+ result = mg_obj.delete_smtp_credentials(
92
+ domain,
91
93
  'test_login'
92
94
  )
93
95
 
@@ -97,8 +99,8 @@ describe 'For the domains endpoint', vcr: vcr_opts do
97
99
 
98
100
  describe '#get_domain_connection_settings' do
99
101
  it 'returns delivery connection settings for the defined domain' do
100
- result = @mg_obj.get_domain_connection_settings(
101
- @domain
102
+ result = mg_obj.get_domain_connection_settings(
103
+ domain
102
104
  )
103
105
 
104
106
  expect(result).to include(
@@ -110,8 +112,8 @@ describe 'For the domains endpoint', vcr: vcr_opts do
110
112
 
111
113
  describe '#update_domain_connection_settings' do
112
114
  it 'updates the specified delivery connection settings' do
113
- result = @mg_obj.update_domain_connection_settings(
114
- @domain,
115
+ result = mg_obj.update_domain_connection_settings(
116
+ domain,
115
117
  {
116
118
  require_tls: true,
117
119
  skip_verification: true
@@ -127,19 +129,19 @@ describe 'For the domains endpoint', vcr: vcr_opts do
127
129
 
128
130
  describe '#get_domain_tracking_settings' do
129
131
  it 'returns tracking settings for the defined domain' do
130
- result = @mg_obj.get_domain_tracking_settings(
131
- @domain
132
+ result = mg_obj.get_domain_tracking_settings(
133
+ domain
132
134
  )
133
135
 
134
136
  expect(result).to include('tracking')
135
- expect(result['tracking']['click']['active']).to eq(true)
137
+ expect(result['tracking']['click']['active']).to eq(false)
136
138
  end
137
139
  end
138
140
 
139
141
  describe '#update_domain_tracking_open_settings' do
140
142
  it 'updates the specified tracking open settings' do
141
- result = @mg_obj.update_domain_tracking_open_settings(
142
- @domain,
143
+ result = mg_obj.update_domain_tracking_open_settings(
144
+ domain,
143
145
  {
144
146
  active: false
145
147
  }
@@ -151,8 +153,8 @@ describe 'For the domains endpoint', vcr: vcr_opts do
151
153
 
152
154
  describe '#update_domain_tracking_click_settings' do
153
155
  it 'updates the specified tracking click settings' do
154
- result = @mg_obj.update_domain_tracking_click_settings(
155
- @domain,
156
+ result = mg_obj.update_domain_tracking_click_settings(
157
+ domain,
156
158
  {
157
159
  active: false
158
160
  }
@@ -164,8 +166,8 @@ describe 'For the domains endpoint', vcr: vcr_opts do
164
166
 
165
167
  describe '#update_domain_tracking_unsubscribe_settings' do
166
168
  it 'updates the specified tracking unsubscribe settings' do
167
- result = @mg_obj.update_domain_tracking_unsubscribe_settings(
168
- @domain,
169
+ result = mg_obj.update_domain_tracking_unsubscribe_settings(
170
+ domain,
169
171
  {
170
172
  active: false
171
173
  }
@@ -177,34 +179,34 @@ describe 'For the domains endpoint', vcr: vcr_opts do
177
179
 
178
180
  describe '#update_domain_dkim_authority' do
179
181
  it 'updates the DKIM authority for a domain' do
180
- result = @mg_obj.update_domain_dkim_authority(
181
- @domain,
182
+ result = mg_obj.update_domain_dkim_authority(
183
+ domain,
182
184
  {
183
- active: false
185
+ self: true
184
186
  }
185
187
  )
186
188
 
187
- expect(result['message']).to eq('Domain DKIM authority has been changed')
189
+ expect(result['message']).to eq('Domain DKIM authority has not been changed')
188
190
  end
189
191
  end
190
192
 
191
193
  describe '#update_domain_dkim_selector' do
192
194
  it 'updates the DKIM selector for a domain' do
193
- result = @mg_obj.update_domain_dkim_selector(
194
- @domain,
195
+ result = mg_obj.update_domain_dkim_selector(
196
+ domain,
195
197
  {
196
198
  dkim_selector: 'mailo1'
197
199
  }
198
200
  )
199
201
 
200
- expect(result['message']).to eq('Domain DKIM authority changed')
202
+ expect(result['message']).to eq('DKIM selector changed')
201
203
  end
202
204
  end
203
205
 
204
206
  describe '#update_domain_web_prefix' do
205
207
  it 'updates the the CNAME used for tracking opens and clicks' do
206
- result = @mg_obj.update_domain_web_prefix(
207
- @domain,
208
+ result = mg_obj.update_domain_web_prefix(
209
+ domain,
208
210
  {
209
211
  web_prefix: 'email'
210
212
  }
@@ -215,15 +217,12 @@ describe 'For the domains endpoint', vcr: vcr_opts do
215
217
  end
216
218
 
217
219
  describe 'V4' do
218
- before do
219
- @mg_client = Mailgun::Client.new(APIKEY, APIHOST, 'v4', SSL)
220
- @mg_obj = Mailgun::Domains.new(@mg_client)
221
- end
220
+ let(:api_version) { 'v4' }
222
221
 
223
222
  describe '#get_domain_keys' do
224
223
  it 'lists the domain keys for a specified signing domain' do
225
- result = @mg_obj.get_domain_keys(
226
- @domain
224
+ result = mg_obj.get_domain_keys(
225
+ domain
227
226
  )
228
227
 
229
228
  expect(result).to include('items')
@@ -233,9 +232,10 @@ describe 'For the domains endpoint', vcr: vcr_opts do
233
232
 
234
233
  describe '#activate_domain_key' do
235
234
  it 'activates a domain key' do
236
- result = @mg_obj.activate_domain_key(
237
- @domain,
238
- 'smtp'
235
+
236
+ result = mg_obj.activate_domain_key(
237
+ domain,
238
+ 'mailo1'
239
239
  )
240
240
 
241
241
  expect(result['message']).to eq('domain key activated')
@@ -244,11 +244,9 @@ describe 'For the domains endpoint', vcr: vcr_opts do
244
244
 
245
245
  describe '#deactivate_domain_key' do
246
246
  it 'deactivates a domain key' do
247
- result = @mg_obj.deactivate_domain_key(
248
- {
249
- signing_domain: 'x509.zeefarmer.com',
250
- selector: 'tetetet'
251
- }
247
+ result = mg_obj.deactivate_domain_key(
248
+ domain,
249
+ 'tetetet'
252
250
  )
253
251
 
254
252
  expect(result['message']).to eq('domain key deactivated')
@@ -257,15 +255,12 @@ describe 'For the domains endpoint', vcr: vcr_opts do
257
255
  end
258
256
 
259
257
  describe '#delete_domain_key' do
260
- before do
261
- @mg_client = Mailgun::Client.new(APIKEY, APIHOST, 'v1', SSL)
262
- @mg_obj = Mailgun::Domains.new(@mg_client)
263
- end
258
+ let(:api_version) { 'v1' }
264
259
 
265
260
  it 'deletes a domain key' do
266
- result = @mg_obj.delete_domain_key(
261
+ result = mg_obj.delete_domain_key(
267
262
  {
268
- signing_domain: @domain,
263
+ signing_domain: domain,
269
264
  selector: 'test'
270
265
  }
271
266
  )
@@ -276,16 +271,24 @@ describe 'For the domains endpoint', vcr: vcr_opts do
276
271
 
277
272
  describe '#get_domain_stats' do
278
273
  it 'returns total stats for a given domain' do
279
- result = @mg_obj.get_domain_stats(
280
- @domain,
274
+ result = mg_obj.get_domain_stats(
275
+ domain,
281
276
  {
282
- event: 'clicked',
283
- start: 'Sun, 23 Dec 2023 01:23:45 JST',
284
- duration: '24h'
277
+ event: 'clicked'
285
278
  }
286
279
  )
287
280
 
288
281
  expect(result).to include('stats')
289
282
  end
290
283
  end
284
+
285
+ def create_mg_object(version)
286
+ mg_client = Mailgun::Client.new(APIKEY, APIHOST, version, SSL)
287
+ Mailgun::Domains.new(mg_client)
288
+ end
289
+
290
+ def create_domain
291
+ mg_obj = create_mg_object('v4')
292
+ mg_obj.add_domain(domain)
293
+ end
291
294
  end