mailgun-ruby 1.2.13 → 1.2.14

data/spec/integration/domains_spec.rb

@@ -44,4 +44,248 @@ describe 'For the domains endpoint', vcr: vcr_opts do
     expect(result['domain']["web_scheme"]).to eq('https')
     expect(result['domain']["wildcard"]).to eq(true)
   end
+
+  describe '#create_smtp_credentials' do
+    it 'creates smtp credentials for domain' do
+      result = @mg_obj.create_smtp_credentials(
+        @domain,
+        {
+          login: 'test_login',
+          password: 'test_password'
+        }
+      )
+
+      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',
+        {
+          password: 'test_password2'
+        }
+      )
+
+      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
+
+  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
+
+  describe '#get_domain_connection_settings' do
+    it 'returns delivery connection settings for the defined domain' do
+      result = @mg_obj.get_domain_connection_settings(
+        @domain
+      )
+
+      expect(result).to include(
+        'require_tls' => false,
+        'skip_verification' => false
+      )
+    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 '#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('tracking')
+      expect(result['tracking']['click']['active']).to eq(true)
+    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
+        }
+      )
+
+      expect(result['open']['active']).to eq(false)
+    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
+        }
+      )
+
+      expect(result['click']['active']).to eq(false)
+    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
+        }
+      )
+
+      expect(result['unsubscribe']['active']).to eq(false)
+    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,
+        {
+          active: false
+        }
+      )
+
+      expect(result['message']).to eq('Domain DKIM authority has been changed')
+    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'
+        }
+      )
+
+      expect(result['message']).to eq('Domain DKIM authority changed')
+    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'
+        }
+      )
+
+      expect(result['message']).to eq('Domain web prefix updated')
+    end
+  end
+
+  describe 'V4' do
+    before do
+      @mg_client = Mailgun::Client.new(APIKEY, APIHOST, 'v4', SSL)
+      @mg_obj = Mailgun::Domains.new(@mg_client)
+    end
+
+    describe '#get_domain_keys' do
+      it 'lists the domain keys for a specified signing domain' do
+        result = @mg_obj.get_domain_keys(
+          @domain
+        )
+
+        expect(result).to include('items')
+        expect(result['items'].first['selector']).to eq('mailo1')
+      end
+    end
+
+    describe '#activate_domain_key' do
+      it 'activates a domain key' do
+        result = @mg_obj.activate_domain_key(
+          @domain,
+          'smtp'
+        )
+
+       expect(result['message']).to eq('domain key activated')
+      end
+    end
+
+    describe '#deactivate_domain_key' do
+      it 'deactivates a domain key' do
+        result = @mg_obj.deactivate_domain_key(
+          {
+            signing_domain: 'x509.zeefarmer.com',
+            selector: 'tetetet'
+          }
+        )
+
+       expect(result['message']).to eq('domain key deactivated')
+      end
+    end
+  end
+
+  describe '#delete_domain_key' do
+    before do
+      @mg_client = Mailgun::Client.new(APIKEY, APIHOST, 'v1', SSL)
+      @mg_obj = Mailgun::Domains.new(@mg_client)
+    end
+
+    it 'deletes a domain key' do
+      result = @mg_obj.delete_domain_key(
+        {
+          signing_domain: @domain,
+          selector: 'test'
+        }
+      )
+
+     expect(result['message']).to eq('success')
+    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',
+          start: 'Sun, 23 Dec 2023 01:23:45 JST',
+          duration: '24h'
+        }
+      )
+
+     expect(result).to include('stats')
+    end
+  end
 end

data/spec/integration/events_spec.rb

@@ -22,7 +22,7 @@ describe 'For the Events endpoint', vcr: vcr_opts do
 
   it 'can iterate over all events with `each`' do
     @events.each do |e|
-      expect(e["id"]).to eq("JAx9z641TuGGUyaJlD9sCQ")
+      expect(e).to have_key('event')
     end
   end
 end

data/spec/integration/mailer_spec.rb

@@ -53,15 +53,9 @@ describe 'Invalid domain', vcr: vcr_opts do
       domain: domain
     }
   end
-  let(:mail) { UnitTestMailer.plain_message("bob@#{domain}", 'sally@not-our-doma.in' 'subject', {}) }
+  let(:mail) { UnitTestMailer.plain_message('sally@not-our-doma.in', "bob@#{domain}", 'subject', {}) }
 
   it 'raises expected error' do
-
-    Railgun::Mailer.new(config).deliver!(mail)
-  rescue Mailgun::CommunicationError => err
-    expect(err.message).to eq('401 Unauthorized: Forbidden - Invalid Domain or API key')
-  else
-    fail
-
+    expect { Railgun::Mailer.new(config).deliver!(mail) }.to raise_error Mailgun::CommunicationError, /Forbidden/
   end
 end

data/spec/integration/tags.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "tags" }
+
+describe 'For the tags endpoints', vcr: vcr_opts do
+  let(:tag_name) { 'abtest-option-a' }
+  let(:domain) { "integration-test.domain.invalid" }
+
+  before(:all) do
+    @mg_client = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @tags = Mailgun::Tags.new(@mg_client)
+  end
+
+  describe '#get_tags' do
+    it 'returs tags info' do
+      result = @tags.get_tags(domain)
+
+      expect(result.first['tag']).to eq('You can track mails as tag-units!')
+    end
+  end
+
+  describe '#get_tag' do
+    it "return the tag's info" do
+      result = @tags.get_tag(domain, tag_name)
+
+      expect(result['tag']).to eq(tag_name)
+    end
+  end
+
+  describe '#update' do
+    it "returns true" do
+      result = @tags.update(
+        domain,
+        tag_name,
+        { description: 'new description 2' }
+      )
+
+      expect(result).to eq(true)
+    end
+  end
+
+  describe '#get_tag_stats' do
+    it "returns tag stats info" do
+      result = @tags.get_tag_stats(
+        domain,
+        tag_name,
+        { 
+          event: 'accepted',
+          start: 'Tue, 23 Jan 2024 11:23:45 EST',
+          resolution: 'day'
+        }
+      )
+
+      expect(result).to include('stats')
+      expect(result['stats'].first['accepted']).to include(
+        {
+          'incoming' => 0,
+          'outgoing' => 0,
+          'total' => 0
+        }
+      )
+    end
+  end
+
+  describe '#get_countries_aggregated_stats' do
+    it "returns countries of origin for a given domain" do
+      result = @tags.get_countries_aggregated_stats(
+        domain,
+        tag_name
+      )
+
+      expect(result).to include('country')
+      expect(result['country']['ad']).to include(
+        {
+          'clicked' => 0,
+          'complained' => 0,
+          'opened' => 0,
+          'unique_clicked' => 0,
+          'unique_opened' => 0,
+          'unsubscribed' => 0
+        }
+      )
+    end
+  end
+
+  describe '#get_providers_aggregated_stats' do
+    it "returns email providers for a given domain" do
+      result = @tags.get_providers_aggregated_stats(
+        domain,
+        tag_name
+      )
+
+      expect(result).to include('provider')
+      expect(result['provider']['aol.com']).to include(
+        {
+          'clicked' => 0,
+          'complained' => 0,
+          'opened' => 0,
+          'unique_clicked' => 0,
+          'unique_opened' => 0,
+          'unsubscribed' => 0
+        }
+      )
+    end
+  end
+
+  describe '#get_devices_aggregated_stats' do
+    it "returns devices for a given domain" do
+      result = @tags.get_devices_aggregated_stats(
+        domain,
+        tag_name
+      )
+
+      expect(result).to include('device')
+      expect(result['device']['desktop']).to include(
+        {
+          'clicked' => 0,
+          'complained' => 0,
+          'opened' => 28,
+          'unique_clicked' => 0,
+          'unique_opened' => 24,
+          'unsubscribed' => 0
+        }
+      )
+    end
+  end
+
+  describe '#remove' do
+    it "returns true" do
+      result = @tags.remove(
+        domain,
+        tag_name
+      )
+
+      expect(result).to eq(true)
+    end
+  end
+end

data/spec/integration/webhook_spec.rb

@@ -7,48 +7,48 @@ describe 'For the webhooks endpoint', order: :defined, vcr: vcr_opts do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN
-    @testhook = 'bounce'
-    @testhookup = 'bounceup'
+    @testhook = 'accepted'
+    @testhookup = 'accepted'
   end
 
   it 'creates a webhook' do
-    result = @mg_obj.post("domains/#{@domain}/webhooks", { id: 'bounce',
+    result = @mg_obj.post("domains/#{@domain}/webhooks", { id: @testhook,
                                                            url: "http://example.com/mailgun/events/#{@testhook}" } )
 
     result.to_h!
     expect(result.body["message"]).to eq("Webhook has been created")
-    expect(result.body["webhook"]["url"]).to eq("http://example.com/mailgun/events/#{@testhook}")
+    expect(result.body["webhook"]["urls"]).to include("http://example.com/mailgun/events/#{@testhook}")
   end
 
   it 'gets a webhook.' do
     result = @mg_obj.get("domains/#{@domain}/webhooks/#{@testhook}")
 
     result.to_h!
-    expect(result.body["webhook"]["url"]).to eq("http://example.com/mailgun/events/#{@testhook}")
+    expect(result.body["webhook"]["urls"]).to include("http://example.com/mailgun/events/#{@testhook}")
   end
 
   it 'gets a list of all webhooks.' do
     result = @mg_obj.get("domains/#{@domain}/webhooks")
 
     result.to_h!
-    expect(result.body["webhooks"]["bounce"]["url"]).to eq("http://example.com/mailgun/events/#{@testhook}")
+    expect(result.body["webhooks"]["accepted"]["urls"]).to include("http://example.com/mailgun/events/#{@testhook}")
   end
 
   it 'updates a webhook.' do
-    result = @mg_obj.put("domains/#{@domain}/webhooks/bounce", {:id => 'bounce',
+    result = @mg_obj.put("domains/#{@domain}/webhooks/#{@testhook}", {:id => @testhook,
                                                                 :url => "http://example.com/mailgun/events/#{@testhookup}"})
 
     result.to_h!
     expect(result.body["message"]).to eq("Webhook has been updated")
-    expect(result.body["webhook"]["url"]).to eq("http://example.com/mailgun/events/#{@testhookup}")
+    expect(result.body["webhook"]["urls"]).to include("http://example.com/mailgun/events/#{@testhookup}")
   end
 
   it 'removes a webhook' do
-    result = @mg_obj.delete("domains/#{@domain}/webhooks/bounce")
+    result = @mg_obj.delete("domains/#{@domain}/webhooks/#{@testhook}")
 
     result.to_h!
     expect(result.body['message']).to eq("Webhook has been deleted")
-    expect(result.body['webhook']['url']).to eq("http://example.com/mailgun/events/#{@testhookup}")
+    expect(result.body['webhook']['urls']).to include("http://example.com/mailgun/events/#{@testhookup}")
   end
 
 end

data/spec/unit/messages/message_builder_spec.rb

@@ -186,6 +186,17 @@ describe 'The method body_text' do
   end
 end
 
+describe 'The method amp_html' do
+  it 'sets amp-html to a string, not an array' do
+    the_text = 'Don\'t mess with Texas!'
+    @mb_obj = Mailgun::MessageBuilder.new
+    @mb_obj.amp_html(the_text)
+    expect(@mb_obj.message['amp-html']).to be_a(String)
+    expect(@mb_obj.message['amp-html']).to eq(the_text)
+  end
+end
+    
+
 describe 'The method set_from_address' do
   it 'warns of set_from_address deprecation' do
     @mb_obj = Mailgun::MessageBuilder.new

data/spec/unit/railgun/content_type_spec.rb

@@ -26,6 +26,17 @@ describe 'extract_body' do
   }
   let(:html_content) { '<h3> [TEST] </h3> <br/> Hello, world!' }
 
+  let(:amp_mail_option) {
+    {
+      from:        'bob@example.com',
+      to:          'sally@example.com',
+      subject:     'RAILGUN TEST SAMPLE',
+      body:         amp_content,
+      content_type: 'text/x-amp-html',
+    }
+  }
+  let(:amp_content) { '<h3> [TEST] </h3> <br/> Hello from AMP!' }
+
   context 'with <Content-Type: text/plain>' do
     let(:sample_mail) { Mail.new(text_mail_option) }
 
@@ -53,10 +64,12 @@ describe 'extract_body' do
   context 'with <Content-Type: multipart/alternative>' do
     let(:text_mail) { Mail.new(text_mail_option) }
     let(:html_mail) { Mail.new(html_mail_option) }
+    let(:amp_mail) { Mail.new(amp_mail_option) }
 
     before do
       @sample_mail = Mail::Part.new(content_type: "multipart/alternative")
       @sample_mail.add_part text_mail
+      @sample_mail.add_part amp_mail
       @sample_mail.add_part html_mail
     end
 
@@ -67,5 +80,9 @@ describe 'extract_body' do
     it 'should return body html' do
       expect(Railgun.extract_body_html(@sample_mail)).to eq(html_content)
     end
+
+    it 'should return AMP html' do
+      expect(Railgun.extract_amp_html(@sample_mail)).to eq(amp_content)
+    end
   end
 end