mailgunner 2.6.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffd33ded9bd33ca044bbe54fc8d89a876bb9949fb91c98ef0f677cc0ca82f4f5
-  data.tar.gz: 7d4ba505f5b1de914fc360b23f64d14497e40e6ca01ecb4e8421560c0404e36d
+  metadata.gz: a596ae861173d54342b029a7c17985553cc7f7222722ec55e05e0344beacf08f
+  data.tar.gz: 481ac3d5b13702ca41598db5868d8b12c4f7a6302264bb216937938c60e1b3c7
 SHA512:
-  metadata.gz: bfea517bd1e392add5a730c417a8aa479279503a574b9855e22a37a8bf1da56c8d972900173fbecb1cc39b73cf0c5eb6772a44b3681c3f2566c5ce9ff2aa4559
-  data.tar.gz: 739a82133f746ad9117dbd6655dec76324de3b1cf3394c2c35672a44306e9cab643e7b29174f7cd2823a477d82e174cbb68a40cf21c54f4dd007dc0c528c1ac0
+  metadata.gz: eb7904e35154121959f7c7f392c72b6f472579ea02baec660487203674b601d9cedb039800fb0847f097f94283d93e52088c6bb00eb3641ce22d7643204f7e38
+  data.tar.gz: 3eb5b428d621fee6ea3605353869e479e8b765e858e1fe1f3e596ebcf7a095f0892d292be22e9cf956f6d9e5e294ec79dd6300b8addf193d36a01584af94bf43

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2018 TIMCRAFT
+Copyright (c) 2012-2019 TIMCRAFT
 
 This is an Open Source project licensed under the terms of the LGPLv3 license.
 Please see <http://www.gnu.org/licenses/lgpl-3.0.html> for license text.

data/README.md

@@ -11,20 +11,20 @@ Ruby client for the [Mailgun API](https://documentation.mailgun.com/en/latest/ap
     $ gem install mailgunner
 
 
-## Quick start
+## Usage
 
 ```ruby
 require 'mailgunner'
 
-mailgun = Mailgunner::Client.new({
-  domain: 'samples.mailgun.org',
-  api_key: 'key-3ax6xnjp29jd6fds4gc373sgvjxteol0'
-})
+Mailgunner.configure do |config|
+  config.domain = 'samples.mailgun.org'
+  config.api_key = 'key-3ax6xnjp29jd6fds4gc373sgvjxteol0'
+end
 
-response = mailgun.get_domains
+mailgun = Mailgunner::Client.new
 
-response['items'].each do |item|
-  p item.values_at('id', 'name')
+mailgun.get_domains.items.each do |item|
+  puts "#{item.id} #{item.name}"
 end
 ```
 
@@ -62,30 +62,12 @@ Outside of Rails you can set `ActionMailer::Base.delivery_method` directly.
 
 ## Specifying the region
 
-Mailgun offers both a US and EU region to send your e-mail from. Mailgunner uses
+Mailgun offers both a US and EU region to send your email from. Mailgunner uses
 the US region by default. If you wish to use the EU region set the `api_host`
 config option like so:
 
 ```ruby
-mailgun = Mailgunner::Client.new({
-  domain: 'eu.samples.mailgun.org',
-  api_key: 'key-3ax6xnjp29jd6fds4gc373sgvjxteol0',
-  api_host: 'api.eu.mailgun.net'
-})
-```
-
-
-## Email validation
-
-If you only need to use Mailgun's [email address validation service](http://documentation.mailgun.com/api-email-validation.html),
-you can instead use your Mailgun public key to authenticate like this:
-
-```ruby
-require 'mailgunner'
-
-public_key = 'pubkey-5ogiflzbnjrljiky49qxsiozqef5jxp7'
-
-mailgun = Mailgunner::Client.new(api_key: public_key)
-
-response = mailgun.validate_address('john@gmail.com')
+Mailgunner.configure do |config|
+  config.api_host = 'api.eu.mailgun.net'
+end
 ```

data/lib/mailgunner.rb

@@ -1,5 +1,8 @@
 require 'mailgunner/version'
 require 'mailgunner/errors'
+require 'mailgunner/params'
+require 'mailgunner/config'
+require 'mailgunner/struct'
 require 'mailgunner/client'
 require 'mailgunner/client/domains'
 require 'mailgunner/client/email_validation'
@@ -14,3 +17,13 @@ require 'mailgunner/client/tags'
 require 'mailgunner/client/webhooks'
 require 'mailgunner/delivery_method' if defined?(Mail)
 require 'mailgunner/railtie' if defined?(Rails)
+
+module Mailgunner
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure
+    yield config
+  end
+end

data/lib/mailgunner/client.rb

@@ -1,18 +1,15 @@
 # frozen_string_literal: true
 require 'net/http'
 require 'json'
-require 'cgi'
 
 module Mailgunner
   class Client
-    attr_accessor :domain, :api_key, :http
+    def initialize(domain: nil, api_key: nil, api_host: nil)
+      @domain = domain || Mailgunner.config.domain
 
-    def initialize(options = {})
-      @domain = options.fetch(:domain) { default_domain }
+      @api_key = api_key || Mailgunner.config.api_key
 
-      @api_key = options.fetch(:api_key) { ENV.fetch('MAILGUN_API_KEY') }
-
-      @api_host = options.fetch(:api_host) { 'api.mailgun.net' }
+      @api_host = api_host || Mailgunner.config.api_host
 
       @http = Net::HTTP.new(@api_host, Net::HTTP.https_default_port)
 
@@ -21,21 +18,20 @@ module Mailgunner
 
     private
 
-    def default_domain
-      return NoDomainProvided unless ENV.key?('MAILGUN_SMTP_LOGIN')
+    ATTRIBUTES = PARAMS = HEADERS = {}.freeze
 
-      ENV['MAILGUN_SMTP_LOGIN'].to_s.split('@').last
-    end
+    def get(path, query: PARAMS, headers: HEADERS)
+      uri = URI(path)
+      uri.query = Params.encode(query) unless query.empty?
 
-    def get(path, params = {}, headers = {})
-      request = Net::HTTP::Get.new(request_uri(path, params))
+      request = Net::HTTP::Get.new(uri.to_s)
 
       headers.each { |k, v| request[k] = v }
 
       transmit(request)
     end
 
-    def post(path, attributes = {})
+    def post(path, attributes = ATTRIBUTES)
       transmit(Net::HTTP::Post.new(path)) { |message| message.set_form_data(attributes) }
     end
 
@@ -43,7 +39,7 @@ module Mailgunner
       transmit(Net::HTTP::Post.new(path)) { |message| message.set_form(data, 'multipart/form-data') }
     end
 
-    def put(path, attributes = {})
+    def put(path, attributes = ATTRIBUTES)
       transmit(Net::HTTP::Put.new(path)) { |message| message.set_form_data(attributes) }
     end
 
@@ -51,52 +47,27 @@ module Mailgunner
       transmit(Net::HTTP::Delete.new(path))
     end
 
-    USER_AGENT = "Ruby/#{RUBY_VERSION} Mailgunner/#{VERSION}"
-
     def transmit(message)
       message.basic_auth('api', @api_key)
-      message['User-Agent'] = USER_AGENT
+      message['User-Agent'] = Mailgunner.config.user_agent
 
       yield message if block_given?
 
-      parse(@http.request(message))
-    end
+      response = @http.request(message)
 
-    def parse(response)
-      case response
-      when Net::HTTPSuccess
-        parse_success(response)
-      when Net::HTTPUnauthorized
-        raise AuthenticationError, "HTTP #{response.code}"
-      when Net::HTTPClientError
-        raise ClientError, "HTTP #{response.code}"
-      when Net::HTTPServerError
-        raise ServerError, "HTTP #{response.code}"
-      else
-        raise Error, "HTTP #{response.code}"
+      unless response.is_a?(Net::HTTPSuccess)
+        raise Error.parse(response)
       end
-    end
 
-    def parse_success(response)
-      return JSON.parse(response.body) if json?(response)
+      if response['Content-Type']&.start_with?('application/json')
+        return JSON.parse(response.body, object_class: Struct)
+      end
 
       response.body
     end
 
-    def json?(response)
-      content_type = response['Content-Type']
-
-      content_type && content_type.split(';').first == 'application/json'
-    end
-
-    def request_uri(path, params)
-      return path if params.empty?
-
-      path + '?' + params.flat_map { |k, vs| Array(vs).map { |v| "#{escape(k)}=#{escape(v)}" } }.join('&')
-    end
-
     def escape(component)
-      CGI.escape(component.to_s)
+      Params.escape(component)
     end
   end
 end

data/lib/mailgunner/client/domains.rb

@@ -2,15 +2,15 @@
 
 module Mailgunner
   class Client
-    def get_domains(params = {})
-      get('/v3/domains', params)
+    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 = {})
+    def add_domain(attributes = ATTRIBUTES)
       post('/v3/domains', attributes)
     end
 
@@ -41,5 +41,21 @@ module Mailgunner
     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
   end
 end

data/lib/mailgunner/client/email_validation.rb

@@ -3,11 +3,23 @@
 module Mailgunner
   class Client
     def validate_address(value)
-      get('/v3/address/validate', address: value)
+      get('/v4/address/validate', query: {address: value})
     end
 
-    def parse_addresses(values)
-      get('/v3/address/parse', addresses: Array(values).join(','))
+    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

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

data/lib/mailgunner/client/ips.rb

@@ -2,8 +2,8 @@
 
 module Mailgunner
   class Client
-    def get_all_ips(params = {})
-      get('/v3/ips', params)
+    def get_all_ips(params = PARAMS)
+      get('/v3/ips', query: params)
     end
 
     def get_ip(address)

data/lib/mailgunner/client/mailing_lists.rb

@@ -2,19 +2,19 @@
 
 module Mailgunner
   class Client
-    def get_lists(params = {})
-      get('/v3/lists', params)
+    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 = {})
+    def add_list(attributes = ATTRIBUTES)
       post('/v3/lists', attributes)
     end
 
-    def update_list(address, attributes = {})
+    def update_list(address, attributes = ATTRIBUTES)
       put("/v3/lists/#{escape address}", attributes)
     end
 
@@ -22,8 +22,8 @@ module Mailgunner
       delete("/v3/lists/#{escape address}")
     end
 
-    def get_list_members(list_address, params = {})
-      get("/v3/lists/#{escape list_address}/members", params)
+    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)

data/lib/mailgunner/client/messages.rb

@@ -7,10 +7,10 @@ module Mailgunner
     end
 
     def get_mime_message(key)
-      get("/v3/domains/#{escape @domain}/messages/#{escape key}", {}, {'Accept' => 'message/rfc2822'})
+      get("/v3/domains/#{escape @domain}/messages/#{escape key}", headers: {'Accept' => 'message/rfc2822'})
     end
 
-    def send_message(attributes = {})
+    def send_message(attributes = ATTRIBUTES)
       post("/v3/#{escape @domain}/messages", attributes)
     end
 

data/lib/mailgunner/client/routes.rb

@@ -2,19 +2,19 @@
 
 module Mailgunner
   class Client
-    def get_routes(params = {})
-      get('/v3/routes', params)
+    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 = {})
+    def add_route(attributes = ATTRIBUTES)
       post('/v3/routes', attributes)
     end
 
-    def update_route(id, attributes = {})
+    def update_route(id, attributes = ATTRIBUTES)
       put("/v3/routes/#{escape id}", attributes)
     end
 

data/lib/mailgunner/client/stats.rb

@@ -2,14 +2,8 @@
 
 module Mailgunner
   class Client
-    def get_stats(params = {})
-      Kernel.warn 'Mailgunner::Client#get_stats is deprecated'
-
-      get("/v3/#{escape @domain}/stats", params)
-    end
-
-    def get_total_stats(params = {})
-      get("/v3/#{escape @domain}/stats/total", params)
+    def get_total_stats(params = PARAMS)
+      get("/v3/#{escape @domain}/stats/total", query: params)
     end
   end
 end

data/lib/mailgunner/client/suppressions.rb

@@ -2,15 +2,15 @@
 
 module Mailgunner
   class Client
-    def get_bounces(params = {})
-      get("/v3/#{escape @domain}/bounces", params)
+    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 = {})
+    def add_bounce(attributes = ATTRIBUTES)
       post("/v3/#{escape @domain}/bounces", attributes)
     end
 
@@ -22,8 +22,8 @@ module Mailgunner
       delete("/v3/#{escape @domain}/bounces")
     end
 
-    def get_unsubscribes(params = {})
-      get("/v3/#{escape @domain}/unsubscribes", params)
+    def get_unsubscribes(params = PARAMS)
+      get("/v3/#{escape @domain}/unsubscribes", query: params)
     end
 
     def get_unsubscribe(address)
@@ -34,24 +34,40 @@ module Mailgunner
       delete("/v3/#{escape @domain}/unsubscribes/#{escape address_or_id}")
     end
 
-    def add_unsubscribe(attributes = {})
+    def add_unsubscribe(attributes = ATTRIBUTES)
       post("/v3/#{escape @domain}/unsubscribes", attributes)
     end
 
-    def get_complaints(params = {})
-      get("/v3/#{escape @domain}/complaints", params)
+    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 = {})
+    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", 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