mailgunner 2.6.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffd33ded9bd33ca044bbe54fc8d89a876bb9949fb91c98ef0f677cc0ca82f4f5
-  data.tar.gz: 7d4ba505f5b1de914fc360b23f64d14497e40e6ca01ecb4e8421560c0404e36d
+  metadata.gz: 335c9306bcba99a231c0346ae15845bf458f76b673246d2c22b1359b846f1a55
+  data.tar.gz: ef5b9d5c4af263b98e9bc9384f4e800fe06bea4919a2db0a7710deb14c12e001
 SHA512:
-  metadata.gz: bfea517bd1e392add5a730c417a8aa479279503a574b9855e22a37a8bf1da56c8d972900173fbecb1cc39b73cf0c5eb6772a44b3681c3f2566c5ce9ff2aa4559
-  data.tar.gz: 739a82133f746ad9117dbd6655dec76324de3b1cf3394c2c35672a44306e9cab643e7b29174f7cd2823a477d82e174cbb68a40cf21c54f4dd007dc0c528c1ac0
+  metadata.gz: 5ee12a7c01d4d978f520eede84647b49e5c44434dc8040cbd1a75596c7580b6f25a40f3caad2db727cafe0b320e5d48ea93a278cf0bab4fba193ccd6ba7be0dd
+  data.tar.gz: bab9b97bd1ea0c7ad3c872c6ed1ebe4f0d4d8db77272207aa5d6e57f92c129cae048fec5b5bcdec30b55aa44ccccf5a8226af6fa5443f0ba69cae7a08ab04f16

data/CHANGES.md

@@ -0,0 +1,218 @@
+# 3.2.1
+
+* Fixed outdated changelog_uri
+
+# 3.2.0
+
+* Added update_web_prefix method
+
+* Added update_dkim_selector method
+
+* Added update_dkim_authority method
+
+* Added verify_domain method (#23)
+
+# 3.1.1
+
+* Fixed missing keyword argument in Mailgunner::Client#get_whitelists method
+
+* Fixed last argument as keyword parameters deprecation warning on Ruby 2.7
+
+# 3.1.0
+
+* Allow delivery method settings to be modified before delivery (#22)
+
+# 3.0.0
+
+* Changed required_ruby_version to >= 2.5.0
+
+* Added Mailgunner::Config class
+
+  You can now configure options globally. For example:
+
+      Mailgunner.configure do |config|
+        config.api_host = 'api.eu.mailgun.net'
+      end
+
+  This may or may not be a breaking change, depending on how you are currently initializing client objects.
+
+* Added Mailgunner::Struct class
+
+  Return values are now instances of the Mailgunner::Struct class. You can access nested keys in various ways:
+
+      response.items
+      response['items']
+      response[:items]
+      response.to_h.dig('items')
+
+  This may or may not be a breaking change, depending on how you are currently using return values.
+
+* Added parsing of error messages in response bodies
+
+* Removed Mailgunner::Client#get_stats method
+
+* Removed Mailgunner::Client#parse_addresses method
+
+* Changed Mailgunner::Client#validate_address to v4 endpoint
+
+* Changed Mailgunner::Client#get_lists method to new endpoint
+
+* Changed Mailgunner::Client#get_list_members method to new endpoint
+
+* Added Mailgunner::Client#get_bulk_validations method
+
+* Added Mailgunner::Client#create_bulk_validation method
+
+* Added Mailgunner::Client#get_bulk_validation method
+
+* Added Mailgunner::Client#cancel_bulk_validation method
+
+* Added Mailgunner::Client#get_whitelists method
+
+* Added Mailgunner::Client#get_whitelist method
+
+* Added Mailgunner::Client#add_whitelist method
+
+* Added Mailgunner::Client#delete_whitelist method
+
+* Added Mailgunner::Client#get_tracking_settings method
+
+* Added Mailgunner::Client#update_open_tracking_settings method
+
+* Added Mailgunner::Client#update_click_tracking_settings method
+
+* Added Mailgunner::Client#update_unsubscribe_tracking_settings method
+
+# 2.6.0
+
+* Added `api_host` option for EU region (thanks @drummerroma and @markoudev)
+
+* Added Mailgunner::Client#get_all_ips method
+
+* Added Mailgunner::Client#get_ip method
+
+* Added Mailgunner::Client#get_ips method
+
+* Added Mailgunner::Client#add_ip method
+
+* Added Mailgunner::Client#delete_ip method
+
+* Removed legacy campaign methods
+
+# 2.5.0
+
+* Fixed compatibility with mail v2.6.6+ (#13)
+
+* Added Mailgunner::Client#get_webhooks method
+
+* Added Mailgunner::Client#get_webhook method
+
+* Added Mailgunner::Client#add_webhook method
+
+* Added Mailgunner::Client#update_webhook method
+
+* Added Mailgunner::Client#delete_webhook method
+
+* Added Mailgun::AuthenticationError exception class
+
+* Added Mailgun::ClientError exception class
+
+* Added Mailgun::ServerError exception class
+
+# 2.4.0
+
+* Fixed Rails load order issue when specifying mailgun_settings (#10)
+
+* Added Mailgunner::Client#get_connection_settings method
+
+* Added Mailgunner::Client#update_connection_settings method
+
+* Added Mailgunner::Client#get_tags method
+
+* Added Mailgunner::Client#get_tag method
+
+* Added Mailgunner::Client#update_tag method
+
+* Added Mailgunner::Client#get_tag_stats method
+
+* Added Mailgunner::Client#delete_tag method
+
+* Added Mailgunner::Client#delete_bounces method
+
+# 2.3.0
+
+* Added Mailgunner::Client#get_total_stats method
+
+* Deprecated Mailgunner::Client#get_stats method
+
+* Removed Mailgunner::Client#get_list_stats method
+
+# 2.2.2
+
+* Fixed cc and bcc recipients not included in multipart sends (#9)
+
+# 2.2.1
+
+* Fixed Rails load order issue (#8)
+
+# 2.2.0
+
+* Added Mailgunner::Client#get_message method
+
+* Added Mailgunner::Client#get_mime_message method
+
+* Added Mailgunner::Client#delete_message method
+
+* Updated API version prefix from v2 to v3
+
+# 2.1.0
+
+* Mailgunner::DeliveryMethod can now be used with Mail directly
+
+* An exception is now raised when calling domain methods if the domain is not provided
+
+* The api_key option can now be specified in ActionMailer::Base.mailgun_settings
+
+# 2.0.0
+
+* Removed deprecated :json option
+
+* Removed Mailgunner::Response class in favour of using exceptions to signal errors
+
+* Added Mailgunner::Client#delete_domain method
+
+* Added Mailgunner::Client methods for managing SMTP credentials
+
+# 1.3.0
+
+* Added [ActionMailer](https://rubygems.org/gems/actionmailer) integration
+
+* Added Mailgunner::Client#send_mime method for sending [mail](https://rubygems.org/gems/mail) objects in MIME format
+
+* Fixed default behaviour to allow for nil domain
+
+* Removed deprecated Mailgunner::Client#get_log method
+
+* Removed deprecated mailbox methods
+
+* Removed deprecated json accessor methods
+
+# 1.2.0
+
+* Added methods for the new [Email Validation endpoint](http://documentation.mailgun.com/api-email-validation.html)
+
+* Added Mailgunner::Client#get_events method for the new [Events API endpoint](http://documentation.mailgun.com/api-events.html)
+
+* Deprecated the Mailgunner::Client#get_log method (use Mailgunner::Client#get_events instead)
+
+# 1.1.0
+
+* Fixed use of insecure JSON.load
+
+* Deprecated the mailbox methods (legacy Mailgun feature)
+
+* Deprecated the :json option and associated accessor methods
+
+# 1.0.0
+
+* First version!

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2018 TIMCRAFT
+Copyright (c) 2012-2020 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

@@ -1,6 +1,7 @@
 # mailgunner
 
-[![Gem Version](https://badge.fury.io/rb/mailgunner.svg)](https://badge.fury.io/rb/mailgunner) [![Build Status](https://api.travis-ci.org/readysteady/mailgunner.svg?branch=master)](https://travis-ci.org/readysteady/mailgunner)
+![Gem Version](https://badge.fury.io/rb/mailgunner.svg)
+![Build Status](https://github.com/readysteady/mailgunner/workflows/Test/badge.svg)
 
 
 Ruby client for the [Mailgun API](https://documentation.mailgun.com/en/latest/api_reference.html).
@@ -11,20 +12,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 +63,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