mailgunner 2.5.0 → 3.2.0

data/lib/mailgunner/client.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+require 'net/http'
+require 'json'
+
+module Mailgunner
+  class Client
+    def initialize(domain: nil, api_key: nil, api_host: nil)
+      @domain = domain || Mailgunner.config.domain
+
+      @api_key = api_key || Mailgunner.config.api_key
+
+      @api_host = api_host || Mailgunner.config.api_host
+
+      @http = Net::HTTP.new(@api_host, Net::HTTP.https_default_port)
+
+      @http.use_ssl = true
+    end
+
+    private
+
+    ATTRIBUTES = PARAMS = HEADERS = {}.freeze
+
+    def get(path, query: PARAMS, headers: HEADERS)
+      uri = URI(path)
+      uri.query = Params.encode(query) unless query.empty?
+
+      request = Net::HTTP::Get.new(uri.to_s)
+
+      headers.each { |k, v| request[k] = v }
+
+      transmit(request)
+    end
+
+    def post(path, attributes = ATTRIBUTES)
+      transmit(Net::HTTP::Post.new(path)) { |message| message.set_form_data(attributes) }
+    end
+
+    def multipart_post(path, data)
+      transmit(Net::HTTP::Post.new(path)) { |message| message.set_form(data, 'multipart/form-data') }
+    end
+
+    def put(path, attributes = ATTRIBUTES)
+      transmit(Net::HTTP::Put.new(path)) { |message| message.set_form_data(attributes) }
+    end
+
+    def delete(path)
+      transmit(Net::HTTP::Delete.new(path))
+    end
+
+    def transmit(message)
+      message.basic_auth('api', @api_key)
+      message['User-Agent'] = Mailgunner.config.user_agent
+
+      yield message if block_given?
+
+      response = @http.request(message)
+
+      unless response.is_a?(Net::HTTPSuccess)
+        raise Error.parse(response)
+      end
+
+      if response['Content-Type']&.start_with?('application/json')
+        return JSON.parse(response.body, object_class: Struct)
+      end
+
+      response.body
+    end
+
+    def escape(component)
+      Params.escape(component)
+    end
+  end
+end

data/lib/mailgunner/client/domains.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Mailgunner
+  class Client
+    def get_domains(params = PARAMS)
+      get('/v3/domains', query: params)
+    end
+
+    def get_domain(name)
+      get("/v3/domains/#{escape name}")
+    end
+
+    def add_domain(attributes = ATTRIBUTES)
+      post('/v3/domains', attributes)
+    end
+
+    def delete_domain(name)
+      delete("/v3/domains/#{escape name}")
+    end
+
+    def verify_domain(name)
+      put("/v3/domains/#{escape name}/verify")
+    end
+
+    def get_credentials
+      get("/v3/domains/#{escape @domain}/credentials")
+    end
+
+    def add_credentials(attributes)
+      post("/v3/domains/#{escape @domain}/credentials", attributes)
+    end
+
+    def update_credentials(login, attributes)
+      put("/v3/domains/#{escape @domain}/credentials/#{escape login}", attributes)
+    end
+
+    def delete_credentials(login)
+      delete("/v3/domains/#{escape @domain}/credentials/#{escape login}")
+    end
+
+    def get_connection_settings
+      get("/v3/domains/#{escape @domain}/connection")
+    end
+
+    def update_connection_settings(attributes)
+      put("/v3/domains/#{escape @domain}/connection", attributes)
+    end
+
+    def get_tracking_settings
+      get("/v3/domains/#{escape @domain}/tracking")
+    end
+
+    def update_open_tracking_settings(params = PARAMS)
+      put("/v3/domains/#{escape @domain}/tracking/open", params)
+    end
+
+    def update_click_tracking_settings(params = PARAMS)
+      put("/v3/domains/#{escape @domain}/tracking/click", params)
+    end
+
+    def update_unsubscribe_tracking_settings(params = PARAMS)
+      put("/v3/domains/#{escape @domain}/tracking/unsubscribe", params)
+    end
+
+    def update_dkim_authority(params = PARAMS)
+      put("/v3/domains/#{escape @domain}/dkim_authority", params)
+    end
+
+    def update_dkim_selector(params = PARAMS)
+      put("/v3/domains/#{escape @domain}/dkim_selector", params)
+    end
+
+    def update_web_prefix(params = PARAMS)
+      put("/v3/domains/#{escape @domain}/web_prefix", params)
+    end
+  end
+end

data/lib/mailgunner/client/email_validation.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mailgunner
+  class Client
+    def validate_address(value)
+      get('/v4/address/validate', query: {address: value})
+    end
+
+    def get_bulk_validations
+      get('/v4/address/validate/bulk')
+    end
+
+    def create_bulk_validation(list_id)
+      post("/v4/address/validate/bulk/#{escape list_id}")
+    end
+
+    def get_bulk_validation(list_id)
+      get("/v4/address/validate/bulk/#{escape list_id}")
+    end
+
+    def cancel_bulk_validation(list_id)
+      delete("/v4/address/validate/bulk/#{escape list_id}")
+    end
+  end
+end

data/lib/mailgunner/client/events.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Mailgunner
+  class Client
+    def get_events(params = PARAMS)
+      get("/v3/#{escape @domain}/events", query: params)
+    end
+  end
+end

data/lib/mailgunner/client/ips.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mailgunner
+  class Client
+    def get_all_ips(params = PARAMS)
+      get('/v3/ips', query: params)
+    end
+
+    def get_ip(address)
+      get("/v3/ips/#{escape address}")
+    end
+
+    def get_ips
+      get("/v3/domains/#{escape @domain}/ips")
+    end
+
+    def add_ip(address)
+      post("/v3/domains/#{escape @domain}/ips", ip: address)
+    end
+
+    def delete_ip(address)
+      delete("/v3/domains/#{escape @domain}/ips/#{escape address}")
+    end
+  end
+end

data/lib/mailgunner/client/mailing_lists.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Mailgunner
+  class Client
+    def get_lists(params = PARAMS)
+      get('/v3/lists/pages', query: params)
+    end
+
+    def get_list(address)
+      get("/v3/lists/#{escape address}")
+    end
+
+    def add_list(attributes = ATTRIBUTES)
+      post('/v3/lists', attributes)
+    end
+
+    def update_list(address, attributes = ATTRIBUTES)
+      put("/v3/lists/#{escape address}", attributes)
+    end
+
+    def delete_list(address)
+      delete("/v3/lists/#{escape address}")
+    end
+
+    def get_list_members(list_address, params = PARAMS)
+      get("/v3/lists/#{escape list_address}/members/pages", query: params)
+    end
+
+    def get_list_member(list_address, member_address)
+      get("/v3/lists/#{escape list_address}/members/#{escape member_address}")
+    end
+
+    def add_list_member(list_address, member_attributes)
+      post("/v3/lists/#{escape list_address}/members", member_attributes)
+    end
+
+    def update_list_member(list_address, member_address, member_attributes)
+      put("/v3/lists/#{escape list_address}/members/#{escape member_address}", member_attributes)
+    end
+
+    def delete_list_member(list_address, member_address)
+      delete("/v3/lists/#{escape list_address}/members/#{escape member_address}")
+    end
+  end
+end

data/lib/mailgunner/client/messages.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Mailgunner
+  class Client
+    def get_message(key)
+      get("/v3/domains/#{escape @domain}/messages/#{escape key}")
+    end
+
+    def get_mime_message(key)
+      get("/v3/domains/#{escape @domain}/messages/#{escape key}", headers: {'Accept' => 'message/rfc2822'})
+    end
+
+    def send_message(attributes = ATTRIBUTES)
+      post("/v3/#{escape @domain}/messages", attributes)
+    end
+
+    def send_mime(mail)
+      to = ['to', Array(mail.destinations).join(',')]
+
+      message = ['message', mail.encoded, {filename: 'message.mime'}]
+
+      multipart_post("/v3/#{escape @domain}/messages.mime", [to, message])
+    end
+
+    def delete_message(key)
+      delete("/v3/domains/#{escape @domain}/messages/#{escape key}")
+    end
+  end
+end

data/lib/mailgunner/client/routes.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mailgunner
+  class Client
+    def get_routes(params = PARAMS)
+      get('/v3/routes', query: params)
+    end
+
+    def get_route(id)
+      get("/v3/routes/#{escape id}")
+    end
+
+    def add_route(attributes = ATTRIBUTES)
+      post('/v3/routes', attributes)
+    end
+
+    def update_route(id, attributes = ATTRIBUTES)
+      put("/v3/routes/#{escape id}", attributes)
+    end
+
+    def delete_route(id)
+      delete("/v3/routes/#{escape id}")
+    end
+  end
+end

data/lib/mailgunner/client/stats.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Mailgunner
+  class Client
+    def get_total_stats(params = PARAMS)
+      get("/v3/#{escape @domain}/stats/total", query: params)
+    end
+  end
+end

data/lib/mailgunner/client/suppressions.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Mailgunner
+  class Client
+    def get_bounces(params = PARAMS)
+      get("/v3/#{escape @domain}/bounces", query: params)
+    end
+
+    def get_bounce(address)
+      get("/v3/#{escape @domain}/bounces/#{escape address}")
+    end
+
+    def add_bounce(attributes = ATTRIBUTES)
+      post("/v3/#{escape @domain}/bounces", attributes)
+    end
+
+    def delete_bounce(address)
+      delete("/v3/#{escape @domain}/bounces/#{escape address}")
+    end
+
+    def delete_bounces
+      delete("/v3/#{escape @domain}/bounces")
+    end
+
+    def get_unsubscribes(params = PARAMS)
+      get("/v3/#{escape @domain}/unsubscribes", query: params)
+    end
+
+    def get_unsubscribe(address)
+      get("/v3/#{escape @domain}/unsubscribes/#{escape address}")
+    end
+
+    def delete_unsubscribe(address_or_id)
+      delete("/v3/#{escape @domain}/unsubscribes/#{escape address_or_id}")
+    end
+
+    def add_unsubscribe(attributes = ATTRIBUTES)
+      post("/v3/#{escape @domain}/unsubscribes", attributes)
+    end
+
+    def get_complaints(params = PARAMS)
+      get("/v3/#{escape @domain}/complaints", query: params)
+    end
+
+    def get_complaint(address)
+      get("/v3/#{escape @domain}/complaints/#{escape address}")
+    end
+
+    def add_complaint(attributes = ATTRIBUTES)
+      post("/v3/#{escape @domain}/complaints", attributes)
+    end
+
+    def delete_complaint(address)
+      delete("/v3/#{escape @domain}/complaints/#{escape address}")
+    end
+
+    def get_whitelists(params = PARAMS)
+      get("/v3/#{escape @domain}/whitelists", query: params)
+    end
+
+    def get_whitelist(address_or_domain)
+      get("/v3/#{escape @domain}/whitelists/#{escape address_or_domain}")
+    end
+
+    def add_whitelist(attributes = ATTRIBUTES)
+      post("/v3/#{escape @domain}/whitelists", attributes)
+    end
+
+    def delete_whitelist(address_or_domain)
+      delete("/v3/#{escape @domain}/whitelists/#{escape address_or_domain}")
+    end
+  end
+end

data/lib/mailgunner/client/tags.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mailgunner
+  class Client
+    def get_tags(params = PARAMS)
+      get("/v3/#{escape @domain}/tags", query: params)
+    end
+
+    def get_tag(id)
+      get("/v3/#{escape @domain}/tags/#{escape id}")
+    end
+
+    def update_tag(id, attributes)
+      put("/v3/#{escape @domain}/tags/#{escape id}", attributes)
+    end
+
+    def get_tag_stats(id, params)
+      get("/v3/#{escape @domain}/tags/#{escape id}/stats", query: params)
+    end
+
+    def delete_tag(id)
+      delete("/v3/#{escape @domain}/tags/#{escape id}")
+    end
+  end
+end

data/lib/mailgunner/client/webhooks.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mailgunner
+  class Client
+    def get_webhooks
+      get("/v3/domains/#{escape @domain}/webhooks")
+    end
+
+    def get_webhook(id)
+      get("/v3/domains/#{escape @domain}/webhooks/#{escape id}")
+    end
+
+    def add_webhook(attributes = ATTRIBUTES)
+      post("/v3/domains/#{escape @domain}/webhooks", attributes)
+    end
+
+    def update_webhook(id, attributes = ATTRIBUTES)
+      put("/v3/domains/#{escape @domain}/webhooks/#{escape id}", attributes)
+    end
+
+    def delete_webhook(id)
+      delete("/v3/domains/#{escape @domain}/webhooks/#{escape id}")
+    end
+  end
+end