mailgun-ruby 1.4.3 → 1.4.4

data/lib/mailgun/webhooks/webhooks.rb

@@ -4,6 +4,8 @@ module Mailgun
   # A Mailgun::Webhooks object is a simple CRUD interface to Mailgun Webhooks.
   # Uses Mailgun
   class Webhooks
+    include ApiVersionChecker
+
     ACTIONS = %w[accepted clicked complained delivered opened permanent_fail temporary_fail unsubscribed].freeze
 
     # Public creates a new Mailgun::Webhooks instance.
@@ -22,7 +24,14 @@ module Mailgun
       res = @client.get("domains/#{domain}/webhooks", options)
       res.to_h['webhooks']
     end
-    alias get_webhooks list
+
+    # :nocov:
+
+    def get_webhooks(domain, options = {})
+      warn('`get_webhooks` method will be deprecated in future versions of Mailgun. Please use `list` instead.')
+      list(domain, options)
+    end
+    # :nocov:
 
     # Public: Get webook information for a specific action
     #
@@ -31,13 +40,19 @@ module Mailgun
     #
     # Returns a String of the url for the identified webhook or an
     #   empty String if one is not set
-    def info(domain, action)
+    def get(domain, action)
       res = @client.get("domains/#{domain}/webhooks/#{action}")
       res.to_h['webhook']['urls'] || ''
-    rescue NoMethodError
-      ''
     end
-    alias get_webhook_url info
+
+    # :nocov:
+    %i[info get_webhook_url].each do |method|
+      define_method(method) do |domain, action|
+        warn("`#{method}` method will be deprecated in future versions of Mailgun. Please use `get` instead.")
+        get(domain, action)
+      end
+    end
+    # :nocov:
 
     # Public: Add webhook
     #
@@ -50,8 +65,16 @@ module Mailgun
       res = @client.post("domains/#{domain}/webhooks", id: action, url: url)
       res.to_h['webhook']['urls'].include?(url) && res.to_h['message'] == 'Webhook has been created'
     end
-    alias add create
-    alias add_webhook create
+
+    # :nocov:
+    %i[add add_webhook].each do |method|
+      define_method(method) do |domain, action, url|
+        url ||= ''
+        warn("`#{method}` method will be deprecated in future versions of Mailgun. Please use `create` instead.")
+        create(domain, action, url)
+      end
+    end
+    # :nocov:
 
     # Public: Sets all webhooks to the same URL
     #
@@ -59,15 +82,17 @@ module Mailgun
     # url    - A String of the url to set all webhooks to
     #
     # Returns true or false
-    def create_all(domain, url = '')
-      ACTIONS.each do |action|
-        add_webhook domain, action, url
+    # :nocov:
+    %i[create_all add_all_webhooks].each do |method|
+      define_method(method) do |domain|
+        warn("`#{method}` method will be deprecated in future versions of Mailgun. Please use `create` instead.")
+
+        ACTIONS.each do |action|
+          create domain, action, url
+        end
       end
-      true
-    rescue StandardError
-      false
     end
-    alias add_all_webhooks create_all
+    # :nocov:
 
     # Public: Update webhook
     #
@@ -81,9 +106,15 @@ module Mailgun
       raise Mailgun::ParameterError('Action not provided to identify webhook to update') unless action
 
       res = @client.put("domains/#{domain}/webhooks/#{action}", id: action, url: url)
-      res.to_h['webhook']['urls'] == url && res.to_h['message'] == 'Webhook has been updated'
+      res.to_h['message'] == 'Webhook has been updated'
     end
-    alias update_webhook update
+
+    # :nocov:
+    def update_webhook(domain, action, url = '')
+      warn('`update_webhook` method will be deprecated in future versions of Mailgun. Please use `update` instead.')
+      update(domain, action, url)
+    end
+    # :nocov:
 
     # Public: Delete a specific webhook
     #
@@ -96,25 +127,36 @@ module Mailgun
       raise Mailgun::ParameterError('Action not provided to identify webhook to remove') unless action
 
       @client.delete("domains/#{domain}/webhooks/#{action}").to_h['message'] == 'Webhook has been deleted'
-    rescue Mailgun::CommunicationError
-      false
     end
-    alias delete remove
-    alias delete_webhook remove
+
+    # :nocov:
+    %i[delete delete_webhook].each do |method|
+      define_method(method) do |domain, action|
+        warn("`#{method}` method will be deprecated in future versions of Mailgun. Please use `remove` instead.")
+        remove(domain, action)
+      end
+    end
+    # :nocov:
 
     # Public: Delete all webhooks for a domain
     #
     # domain - A required String of the domain to remove all webhooks for
     #
     # Returns a Boolean on the success
-    def remove_all(domain)
-      raise Mailgun::ParameterError('Domain not provided to remove webhooks from') unless domain
+    # :nocov:
+    %i[remove_all delete_all delete_all_webooks].each do |method|
+      define_method(method) do |domain|
+        warn("`#{method}` method will be deprecated in future versions of Mailgun. Please use `remove` instead.")
 
-      ACTIONS.each do |action|
-        delete_webhook domain, action
+        raise Mailgun::ParameterError('Domain not provided to remove webhooks from') unless domain
+
+        ACTIONS.each do |action|
+          remove domain, action
+        end
       end
     end
-    alias delete_all remove_all
-    alias delete_all_webooks remove_all
+    # :nocov:
+
+    enforces_api_version 'v3', :list, :get, :create, :update, :remove
   end
 end

data/spec/integration/account_webhooks_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { cassette_name: 'account_webhooks' }
+
+describe 'For the webhooks endpoint', order: :defined, vcr: vcr_opts do
+  let(:api_version) { 'v1' }
+  let(:mg_client) { Mailgun::Client.new(APIKEY, APIHOST, api_version, SSL) }
+  let(:mg_obj) { Mailgun::AccountWebhooks.new(mg_client) }
+
+  it 'creates a webhook' do
+    result = mg_obj.create(
+      description: 'test',
+      event_types: 'accepted',
+      url: 'http://example.com/mailgun/events'
+    )
+
+    expect(result).to have_key('webhook_id')
+  end
+
+  it 'gets a webhook' do
+    result = mg_obj.get('test')
+
+    expect(result['url']).to eq('http://example.com/mailgun/events')
+  end
+
+  it 'gets a list of all account webhooks' do
+    result = mg_obj.list
+
+    expect(result[0]['url']).to eq('http://example.com/mailgun/events')
+  end
+
+  it 'updates a webhook' do
+    result = mg_obj.update(
+      'test',
+      description: 'test2',
+      event_types: 'accepted',
+      url: 'http://example.com/mailgun/events'
+    )
+
+    expect(result).to be_truthy
+  end
+
+  it 'removes a webhook' do
+    result = mg_obj.remove_by_id('test')
+
+    expect(result).to be_truthy
+  end
+
+  it 'removes all webhooks' do
+    result = mg_obj.remove(all: true)
+
+    expect(result).to be_truthy
+  end
+end

data/spec/integration/domain_keys_spec.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { cassette_name: 'domains' }
+
+describe 'DomainKeys', vcr: vcr_opts do
+  let(:api_version) { APIVERSION }
+  let(:mg_client) { Mailgun::Client.new(APIKEY, APIHOST, api_version, SSL) }
+  let(:mg_obj) { Mailgun::DomainKeys.new(mg_client) }
+  let(:domain) { 'integration-test.domain.invalid' }
+
+  describe '#list_domain_keys' do
+    let(:api_version) { 'v1' }
+
+    it 'lists all domain keys' do
+      result = mg_obj.list_domain_keys(
+        {
+          signing_domain: domain
+        }
+      )
+
+      expect(result).to include('items')
+      expect(result['items'].first['selector']).to eq('k1')
+    end
+  end
+
+  describe '#create_domain_key' do
+    let(:api_version) { 'v1' }
+
+    it 'creates a domain key' do
+      result = mg_obj.create_domain_key(
+        {
+          signing_domain: domain,
+          selector: 'test'
+        }
+      )
+
+      expect(result['signing_domain']).to eq(domain)
+      expect(result['selector']).to eq('test')
+    end
+  end
+
+  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['message']).to eq('success')
+    end
+  end
+
+  describe '#activate_domain_key' do
+    let(:api_version) { 'v4' }
+
+    it 'activates a domain key' do
+      result = mg_obj.activate_domain_key(
+        domain,
+        'mailo1'
+      )
+
+      expect(result['message']).to eq('domain key activated')
+    end
+  end
+
+  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).to include('items')
+      expect(result['items'].first['selector']).to eq('mailo1')
+    end
+  end
+
+  describe '#deactivate_domain_key' do
+    let(:api_version) { 'v4' }
+
+    it 'deactivates a domain key' do
+      result = mg_obj.deactivate_domain_key(
+        domain,
+        'tetetet'
+      )
+
+      expect(result['message']).to eq('domain key deactivated')
+    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
+        }
+      )
+
+      expect(result['message']).to eq('Domain DKIM authority has not 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('DKIM selector changed')
+    end
+  end
+end

data/spec/integration/domains_spec.rb

@@ -73,119 +73,6 @@ describe 'For the domains endpoint', vcr: vcr_opts do
     end
   end
 
-  context 'Domain::Keys methods' do
-    describe '#list_domain_keys' do
-      let(:api_version) { 'v1' }
-
-      it 'lists all domain keys' do
-        result = mg_obj.list_domain_keys(
-          {
-            signing_domain: domain
-          }
-        )
-
-        expect(result).to include('items')
-        expect(result['items'].first['selector']).to eq('k1')
-      end
-    end
-
-    describe '#create_domain_key' do
-      let(:api_version) { 'v1' }
-
-      it 'creates a domain key' do
-        result = mg_obj.create_domain_key(
-          {
-            signing_domain: domain,
-            selector: 'test'
-          }
-        )
-
-        expect(result['signing_domain']).to eq(domain)
-        expect(result['selector']).to eq('test')
-      end
-    end
-
-    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['message']).to eq('success')
-      end
-    end
-
-    describe '#activate_domain_key' do
-      let(:api_version) { 'v4' }
-
-      it 'activates a domain key' do
-        result = mg_obj.activate_domain_key(
-          domain,
-          'mailo1'
-        )
-
-        expect(result['message']).to eq('domain key activated')
-      end
-    end
-
-    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).to include('items')
-        expect(result['items'].first['selector']).to eq('mailo1')
-      end
-    end
-
-    describe '#deactivate_domain_key' do
-      let(:api_version) { 'v4' }
-
-      it 'deactivates a domain key' do
-        result = mg_obj.deactivate_domain_key(
-          domain,
-          'tetetet'
-        )
-
-        expect(result['message']).to eq('domain key deactivated')
-      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
-          }
-        )
-
-        expect(result['message']).to eq('Domain DKIM authority has not 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('DKIM selector changed')
-      end
-    end
-  end
-
   context 'Domain::Tracking methods' do
     # TODO: add missing:
     # get_domain_tracking_certificate

data/spec/integration/webhook_spec.rb

@@ -6,55 +6,40 @@ require 'mailgun'
 vcr_opts = { cassette_name: 'webhooks' }
 
 describe 'For the webhooks endpoint', order: :defined, vcr: vcr_opts do
-  before(:all) do
-    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = 'DOMAIN.TEST'
-    @testhook = 'accepted'
-    @testhookup = 'accepted'
-  end
+  let(:api_version) { 'v3' }
+  let(:mg_client) { Mailgun::Client.new(APIKEY, APIHOST, api_version, SSL) }
+  let(:mg_obj) { Mailgun::Webhooks.new(mg_client) }
+  let(:domain) { 'DOMAIN.TEST' }
+  let(:testhook) { 'accepted' }
+  let(:testhookup) { 'accepted' }
 
   it 'creates a webhook' do
-    result = @mg_obj.post("domains/#{@domain}/webhooks", { id: @testhook,
-                                                           url: "http://example.com/mailgun/events/#{@testhook}" })
+    result = mg_obj.create(domain, testhook, "http://example.com/mailgun/events/#{testhook}")
 
-    result.to_h!
-    expect(result.body['message']).to eq('Webhook has been created')
-    expect(result.body['webhook']['urls']).to include("http://example.com/mailgun/events/#{@testhook}")
+    expect(result).to be_truthy
   end
 
-  it 'gets a webhook.' do
-    result = @mg_obj.get("domains/#{@domain}/webhooks/#{@testhook}")
+  it 'gets a webhook' do
+    result = mg_obj.get(domain, testhook)
 
-    result.to_h!
-    expect(result.body['webhook']['urls']).to include("http://example.com/mailgun/events/#{@testhook}")
+    expect(result).to include("http://example.com/mailgun/events/#{testhook}")
   end
 
-  it 'gets a list of all webhooks.' do
-    result = @mg_obj.get("domains/#{@domain}/webhooks")
+  it 'gets a list of all webhooks' do
+    result = mg_obj.list(domain)
 
-    result.to_h!
-    expect(result.body['webhooks']['accepted']['urls']).to include("http://example.com/mailgun/events/#{@testhook}")
+    expect(result['accepted']['urls'][0]).to include("http://example.com/mailgun/events/#{testhook}")
   end
 
-  it 'updates a webhook.' do
-    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']['urls']).to include("http://example.com/mailgun/events/#{@testhookup}")
+  it 'updates a webhook' do
+    result = mg_obj.update(domain, testhook, "http://example.com/mailgun/events/#{testhookup}")
+
+    expect(result).to be_truthy
   end
 
   it 'removes a webhook' do
-    result = @mg_obj.delete("domains/#{@domain}/webhooks/#{@testhook}")
+    result = mg_obj.remove(domain, testhook)
 
-    result.to_h!
-    expect(result.body['message']).to eq('Webhook has been deleted')
-    expect(result.body['webhook']['urls']).to include("http://example.com/mailgun/events/#{@testhookup}")
+    expect(result).to be_truthy
   end
 end