mailgun-ruby 1.3.10 → 1.4.1

data/spec/integration/domains_spec.rb

@@ -9,276 +9,302 @@ describe 'For the domains endpoint', vcr: vcr_opts do
   let(:mg_obj) { Mailgun::Domains.new(mg_client) }
   let(:domain) { 'integration-test.domain.invalid' }
 
-  describe '#add_domain' do
-    let(:api_version) { 'v4' }
+  context 'Core Domains methods' do
+    describe '#list' do
+      let(:api_version) { 'v4' }
 
-    it 'creates a domain' do
-      response = mg_obj.add_domain(domain, { spam_action: 'tag' })
+      it 'returns a list of domains' do
+        response = mg_obj.list
 
-      expect(response['domain']['name']).to eq(domain)
-      expect(response['domain']['spam_action']).to eq('tag')
+        expect(response.size).to be > 0
+      end
     end
-  end
 
-  describe '#get' do
-    let(:api_version) { 'v4' }
+    describe '#create' do
+      let(:api_version) { 'v4' }
 
-    it 'returns the domain' do
-      response = mg_obj.get(domain)
+      it 'creates a domain' do
+        response = mg_obj.create(domain, { spam_action: 'tag' })
 
-      expect(response).to include('domain')
-      expect(response['domain']['name']).to eq(domain)
+        expect(response['domain']['name']).to eq(domain)
+        expect(response['domain']['spam_action']).to eq('tag')
+      end
     end
-  end
 
-  describe '#get_domains' do
-    let(:api_version) { 'v4' }
+    describe '#get' do
+      let(:api_version) { 'v4' }
 
-    it 'returns a list of domains' do
-      response = mg_obj.get_domains
+      it 'returns the domain' do
+        response = mg_obj.get(domain)
 
-      expect(response.size).to be > 0
+        expect(response).to include('domain')
+        expect(response['domain']['name']).to eq(domain)
+      end
     end
-  end
 
-  context '#update' do
-    let(:api_version) { 'v4' }
+    context '#update' do
+      let(:api_version) { 'v4' }
 
-    it 'updates the domain' do
-      response = mg_obj.update(domain, { spam_action: 'block', web_scheme: 'https', wildcard: true })
+      it 'updates the domain' do
+        response = mg_obj.update(domain, { spam_action: 'block', web_scheme: 'https', wildcard: true })
 
-      expect(response['domain']['spam_action']).to eq('block')
-      expect(response['domain']['web_scheme']).to eq('https')
-      expect(response['domain']['wildcard']).to eq(true)
+        expect(response['domain']['spam_action']).to eq('block')
+        expect(response['domain']['web_scheme']).to eq('https')
+        expect(response['domain']['wildcard']).to eq(true)
+      end
     end
-  end
-
-  context 'delete a domain' do
-    subject(:response) { mg_obj.delete(domain) }
 
-    it { is_expected.to be_falsey }
-  end
+    context '#verify' do
+      let(:api_version) { 'v4' }
 
-  describe '#create_smtp_credentials' do
-    it 'creates smtp credentials for domain' do
-      result = mg_obj.create_smtp_credentials(
-        domain,
-        {
-          login: 'test_login'
-        }
-      )
+      it 'verifies the domain' do
+        response = mg_obj.verify(domain)
 
-      expect(result['message']).to eq("Created 1 credentials pair(s)")
+        expect(response['message']).to eq('Domain DNS records have been updated')
+      end
     end
-  end
 
-  describe '#update_smtp_credentials' do
-    it 'updates smtp credentials for domain' do
-      result = mg_obj.update_smtp_credentials(
-        domain,
-        'test_login',
-        {
-          spec: 'abc'
-        }
-      )
-
-      expect(result['message']).to eq('Password changed')
+    context 'delete a domain' do
+      subject(:response) { mg_obj.remove(domain) }
+
+      it { is_expected.to be_falsey }
     end
   end
 
-  describe '#delete_smtp_credentials' do
-    it 'deletes smtp credentials for domain' do
-      result = mg_obj.delete_smtp_credentials(
-        domain,
-        'test_login'
-      )
 
-      expect(result['message']).to eq('Credentials have been deleted')
-    end
-  end
+  context 'Domain::Keys methods' do
+    describe '#list_domain_keys' do
+      let(:api_version) { 'v1' }
 
-  describe '#get_domain_connection_settings' do
-    it 'returns delivery connection settings for the defined domain' do
-      result = mg_obj.get_domain_connection_settings(
-        domain
-      )
+      it 'lists all domain keys' do
+        result = mg_obj.list_domain_keys(
+          {
+            signing_domain: domain
+          }
+        )
 
-      expect(result).to include(
-        'require_tls' => false,
-        'skip_verification' => false
-      )
+        expect(result).to include('items')
+        expect(result['items'].first['selector']).to eq('k1')
+      end
     end
-  end
 
-  describe '#update_domain_connection_settings' do
-    it 'updates the specified delivery connection settings' do
-      result = mg_obj.update_domain_connection_settings(
-        domain,
-        {
-          require_tls: true,
-          skip_verification: true
-        }
-      )
-
-      expect(result).to include(
-        'require_tls' => true,
-        'skip_verification' => true
-      )
-    end
-  end
+    describe '#create_domain_key' do
+      let(:api_version) { 'v1' }
 
-  describe '#get_domain_tracking_settings' do
-    it 'returns tracking settings for the defined domain' do
-      result = mg_obj.get_domain_tracking_settings(
-        domain
-      )
+      it 'creates a domain key' do
+        result = mg_obj.create_domain_key(
+          {
+            signing_domain: domain,
+            selector: 'test'
+          }
+        )
 
-      expect(result).to include('tracking')
-      expect(result['tracking']['click']['active']).to eq(false)
+        expect(result['signing_domain']).to eq(domain)
+        expect(result['selector']).to eq('test')
+      end
     end
-  end
 
-  describe '#update_domain_tracking_open_settings' do
-    it 'updates the specified tracking open settings' do
-      result = mg_obj.update_domain_tracking_open_settings(
-        domain,
-        {
-          active: false
-        }
-      )
+    describe '#delete_domain_key' do
+      let(:api_version) { 'v1' }
+
+      it 'deletes a domain key' do
+        result = mg_obj.delete_domain_key(
+          {
+            signing_domain: domain,
+            selector: 'test'
+          }
+        )
 
-      expect(result['open']['active']).to eq(false)
+        expect(result['message']).to eq('success')
+      end
     end
-  end
 
-  describe '#update_domain_tracking_click_settings' do
-    it 'updates the specified tracking click settings' do
-      result = mg_obj.update_domain_tracking_click_settings(
-        domain,
-        {
-          active: false
-        }
-      )
+    describe '#activate_domain_key' do
+      let(:api_version) { 'v4' }
 
-      expect(result['click']['active']).to eq(false)
+      it 'activates a domain key' do
+
+        result = mg_obj.activate_domain_key(
+          domain,
+          'mailo1'
+        )
+
+        expect(result['message']).to eq('domain key activated')
+      end
     end
-  end
 
-  describe '#update_domain_tracking_unsubscribe_settings' do
-    it 'updates the specified tracking unsubscribe settings' do
-      result = mg_obj.update_domain_tracking_unsubscribe_settings(
-        domain,
-        {
-          active: false
-        }
-      )
+    describe '#get_domain_keys' do
+      let(:api_version) { 'v4' }
+
+      it 'lists the domain keys for a specified signing domain' do
+        result = mg_obj.get_domain_keys(
+          domain
+        )
 
-      expect(result['unsubscribe']['active']).to eq(false)
+        expect(result).to include('items')
+        expect(result['items'].first['selector']).to eq('mailo1')
+      end
     end
-  end
 
-  describe '#update_domain_dkim_authority' do
-    it 'updates the DKIM authority for a domain' do
-      result = mg_obj.update_domain_dkim_authority(
-        domain,
-        {
-          self: true
-        }
-      )
+    describe '#deactivate_domain_key' do
+      let(:api_version) { 'v4' }
 
-      expect(result['message']).to eq('Domain DKIM authority has not been changed')
+      it 'deactivates a domain key' do
+        result = mg_obj.deactivate_domain_key(
+          domain,
+          'tetetet'
+        )
+
+        expect(result['message']).to eq('domain key deactivated')
+      end
     end
-  end
 
-  describe '#update_domain_dkim_selector' do
-    it 'updates the DKIM selector for a domain' do
-      result = mg_obj.update_domain_dkim_selector(
-        domain,
-        {
-          dkim_selector: 'mailo1'
-        }
-      )
+    describe '#update_domain_dkim_authority' do
+      it 'updates the DKIM authority for a domain' do
+        result = mg_obj.update_domain_dkim_authority(
+          domain,
+          {
+            self: true
+          }
+        )
 
-      expect(result['message']).to eq('DKIM selector changed')
+        expect(result['message']).to eq('Domain DKIM authority has not been changed')
+      end
     end
-  end
 
-  describe '#update_domain_web_prefix' do
-    it 'updates the the CNAME used for tracking opens and clicks' do
-      result = mg_obj.update_domain_web_prefix(
-        domain,
-        {
-          web_prefix: 'email'
-        }
-      )
+    describe '#update_domain_dkim_selector' do
+      it 'updates the DKIM selector for a domain' do
+        result = mg_obj.update_domain_dkim_selector(
+          domain,
+          {
+            dkim_selector: 'mailo1'
+          }
+        )
 
-      expect(result['message']).to eq('Domain web prefix updated')
+        expect(result['message']).to eq('DKIM selector changed')
+      end
     end
   end
 
-  describe 'V4' do
-    let(:api_version) { 'v4' }
+  context 'Domain::Tracking methods' do
+    # TODO add missing:
+    # get_domain_tracking_certificate
+    # regenerate_domain_tracking_certificate
+    # generate_domain_tracking_certificate
 
-    describe '#get_domain_keys' do
-      it 'lists the domain keys for a specified signing domain' do
-        result = mg_obj.get_domain_keys(
+    describe '#get_domain_tracking_settings' do
+      it 'returns tracking settings for the defined domain' do
+        result = mg_obj.get_domain_tracking_settings(
           domain
         )
 
-        expect(result).to include('items')
-        expect(result['items'].first['selector']).to eq('mailo1')
+        expect(result).to include('tracking')
+        expect(result['tracking']['click']['active']).to eq(false)
       end
     end
 
-    describe '#activate_domain_key' do
-      it 'activates a domain key' do
+    describe '#update_domain_tracking_click_settings' do
+      it 'updates the specified tracking click settings' do
+        result = mg_obj.update_domain_tracking_click_settings(
+          domain,
+          {
+            active: false
+          }
+        )
 
-        result = mg_obj.activate_domain_key(
+        expect(result['click']['active']).to eq(false)
+      end
+    end
+
+    describe '#update_domain_tracking_open_settings' do
+      it 'updates the specified tracking open settings' do
+        result = mg_obj.update_domain_tracking_open_settings(
           domain,
-          'mailo1'
+          {
+            active: false
+          }
         )
 
-       expect(result['message']).to eq('domain key activated')
+        expect(result['open']['active']).to eq(false)
       end
     end
 
-    describe '#deactivate_domain_key' do
-      it 'deactivates a domain key' do
-        result = mg_obj.deactivate_domain_key(
+    describe '#update_domain_tracking_unsubscribe_settings' do
+      it 'updates the specified tracking unsubscribe settings' do
+        result = mg_obj.update_domain_tracking_unsubscribe_settings(
           domain,
-          'tetetet'
+          {
+            active: false
+          }
         )
 
-       expect(result['message']).to eq('domain key deactivated')
+        expect(result['unsubscribe']['active']).to eq(false)
       end
     end
   end
 
-  describe '#delete_domain_key' do
-    let(:api_version) { 'v1' }
+  context 'Domain::DKIM_Security methods' do
+    # TODO add missing:
+    # dkim_rotation
+    # dkim_rotate
+  end
 
-    it 'deletes a domain key' do
-      result = mg_obj.delete_domain_key(
-        {
-          signing_domain: domain,
-          selector: 'test'
-        }
-      )
+  context 'Credentials methods' do
+    # TODO: to be moved to the dedicated module
 
-     expect(result['message']).to eq('success')
+    describe '#create_smtp_credentials' do
+      it 'creates smtp credentials for domain' do
+        result = mg_obj.create_smtp_credentials(
+          domain,
+          {
+            login: 'test_login'
+          }
+        )
+
+        expect(result['message']).to eq("Created 1 credentials pair(s)")
+      end
+    end
+
+    describe '#update_smtp_credentials' do
+      it 'updates smtp credentials for domain' do
+        result = mg_obj.update_smtp_credentials(
+          domain,
+          'test_login',
+          {
+            spec: 'abc'
+          }
+        )
+
+        expect(result['message']).to eq('Password changed')
+      end
+    end
+
+    describe '#delete_smtp_credentials' do
+      it 'deletes smtp credentials for domain' do
+        result = mg_obj.delete_smtp_credentials(
+          domain,
+          'test_login'
+        )
+
+        expect(result['message']).to eq('Credentials have been deleted')
+      end
     end
   end
 
-  describe '#get_domain_stats' do
-    it 'returns total stats for a given domain' do
-      result = mg_obj.get_domain_stats(
-        domain,
-        {
-          event: 'clicked'
-        }
-      )
+  context 'Reporting::Stat methods' do
+    # TODO: to be moved to the dedicated module
+
+    describe '#get_domain_stats' do
+      it 'returns total stats for a given domain' do
+        result = mg_obj.get_domain_stats(
+          domain,
+          {
+            event: 'clicked'
+          }
+        )
 
-     expect(result).to include('stats')
+        expect(result).to include('stats')
+      end
     end
   end
 

data/spec/spec_helper.rb

@@ -1,9 +1,5 @@
-require 'rubygems'
-require 'bundler'
-require 'bundler/setup'
-Bundler.setup(:development)
-
 require 'simplecov'
+
 SimpleCov.start do
   add_filter "/spec/"
 end

data/vcr_cassettes/domains.yml

@@ -1088,4 +1088,156 @@ http_interactions:
         '
     http_version:
   recorded_at: Thu, 28 Aug 2025 14:47:08 GMT
+- request:
+    method: put
+    uri: https://api.mailgun.net/v4/domains/integration-test.domain.invalid/verify
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - mailgun-sdk-ruby/1.4.0
+      Accept:
+      - "*/*"
+      Authorization:
+      - Basic xxx
+      Content-Length:
+      - '0'
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-store
+      Content-Length:
+      - '1752'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sat, 27 Dec 2025 23:47:46 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Mailgun-Key-Id:
+      - xxx
+      X-Request-Limit:
+      - '10'
+      X-Request-Remaining:
+      - '9'
+      X-Request-Reset:
+      - '1766879267069'
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"message":"Domain DNS records have been updated","domain":{"created_at":"Thu,
+        27 Nov 2025 22:42:06 GMT","id":"xxx","is_disabled":false,"name":"integration-test.domain.invalid","require_tls":false,"skip_verification":false,"smtp_login":"","spam_action":"tag","state":"unverified","type":"custom","use_automatic_sender_security":false,"web_prefix":"email","web_scheme":"http","wildcard":false,"encrypt_incoming_message":false,"message_ttl":0},"sending_dns_records":[{"is_active":false,"cached":[],"name":"k1._domainkey.integration-test.domain.invalid","record_type":"TXT","valid":"unknown","value":"k=rsa;
+        p=xxx+xxx+xxx"},{"is_active":false,"cached":[],"name":"string._domainkey.integration-test.domain.invalid","record_type":"TXT","valid":"unknown","value":"k=rsa;
+        p=xxx/xxx+xx+xxx+xxx+xxx/xxx/xxx"},{"is_active":true,"cached":[],"name":"integration-test.domain.invalid","record_type":"TXT","valid":"unknown","value":"v=spf1
+        include:mailgun.org ~all"},{"is_active":true,"cached":[],"name":"email.integration-test.domain.invalid","record_type":"CNAME","valid":"unknown","value":"mailgun.org"}],"receiving_dns_records":[{"is_active":true,"cached":[],"priority":"10","record_type":"MX","valid":"unknown","value":"mxa.mailgun.org"},{"is_active":true,"cached":[],"priority":"10","record_type":"MX","valid":"unknown","value":"mxb.mailgun.org"}]}
+
+        '
+    http_version:
+  recorded_at: Sat, 27 Dec 2025 23:47:46 GMT
+- request:
+    method: post
+    uri: https://api.mailgun.net/v1/dkim/keys
+    body:
+      encoding: UTF-8
+      string: selector=test&signing_domain=integration-test.domain.invalid
+    headers:
+      User-Agent:
+      - mailgun-sdk-ruby/1.4.0
+      Accept:
+      - "*/*"
+      Authorization:
+      - Basic xxx
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-store
+      Content-Length:
+      - '447'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sun, 28 Dec 2025 00:07:03 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Mailgun-Key-Id:
+      - xxx
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"signing_domain":"integration-test.domain.invalid","selector":"test","dns_record":{"is_active":false,"cached":[],"name":"test._domainkey.integration-test.domain.invalid","record_type":"TXT","valid":"unknown","value":"k=rsa;
+        p=xxx"}}
+
+        '
+    http_version:
+  recorded_at: Sun, 28 Dec 2025 00:07:03 GMT
+- request:
+    method: get
+    uri: https://api.mailgun.net/v1/dkim/keys?signing_domain=integration-test.domain.invalid
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - mailgun-sdk-ruby/1.4.0
+      Accept:
+      - "*/*"
+      Authorization:
+      - Basic xxx
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-store
+      Content-Length:
+      - '1767'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sun, 28 Dec 2025 00:12:23 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Mailgun-Key-Id:
+      - xxx
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"items":[{"signing_domain":"integration-test.domain.invalid","selector":"k1","dns_record":{"is_active":false,"cached":[],"name":"k1._domainkey.integration-test.domain.invalid","record_type":"TXT","valid":"unknown","value":"k=rsa;
+        p=xxx"}},{"signing_domain":"integration-test.domain.invalid","selector":"test","dns_record":{"is_active":false,"cached":[],"name":"test._domainkey.integration-test.domain.invalid","record_type":"TXT","valid":"unknown","value":"k=rsa;
+        p=xxx"}}],"paging":{"previous":"https://api.mailgun.net/v1/dkim/keys?page=xxx","first":"https://api.mailgun.net/v1/dkim/keys?page=xxx","next":"https://api.mailgun.net/v1/dkim/keys?page=xxx","last":"https://api.mailgun.net/v1/dkim/keys?page=xxx"}}
+
+        '
+    http_version:
+  recorded_at: Sun, 28 Dec 2025 00:12:23 GMT
 recorded_with: VCR 3.0.3