mailgunner 2.5.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d953d49216e0419f517316128a12974aefc63ce7
-  data.tar.gz: 23857d5d6ddf925bb6d07a5f20c5069afe80d0e2
+SHA256:
+  metadata.gz: 0c41e367b2b2934d3507be230520c72cb62feb57b03c91f1cb6c593578c88956
+  data.tar.gz: 4a08ca142232d72e11208051711f3a8f9abd437f0e29c99104d3a5d9c8745995
 SHA512:
-  metadata.gz: 2b4c452b40c78d8d569efdc93ce24d0980616546e69fedde804721331ff47d536f93ceba3341c6f0ff7854a4a7957979e21121ba766980f29d01a876f2a0a5d5
-  data.tar.gz: 6e531aa0c226284e539f5e5b9128e30ef9c3fcd21da511dbacc95ec2c8c8b6ebe0ec41ef2d60469a2510a5b10355a3a91b17ce3c73a1842d10a79acb1fd441ae
+  metadata.gz: e16b51a2710153ce19414399bc2fa5cb147a9c2eba7b1daed4e9b4768727ce0a091f1ed6874055640d71f41ff8c5225d77fddcf781b7d136954d193d31adeae2
+  data.tar.gz: e93e0cf4f5f2ef7879a6fe1bfd62fc8c5280e84e60a707c4c489b21ce3c09e06b37a9b1269a85827037575e9ef18e85f4915a89e2080ee03b130c6f52630b31f

data/CHANGES.md

@@ -0,0 +1,214 @@
+# 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,9 +1,10 @@
 # mailgunner
 
-[![Gem Version](https://badge.fury.io/rb/mailgunner.svg)](https://badge.fury.io/rb/mailgunner) [![Build Status](https://api.travis-ci.org/timcraft/mailgunner.svg?branch=master)](https://travis-ci.org/timcraft/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](http://documentation.mailgun.net/api_reference.html).
+Ruby client for the [Mailgun API](https://documentation.mailgun.com/en/latest/api_reference.html).
 
 
 ## Installation
@@ -11,26 +12,29 @@ Ruby client for the [Mailgun API](http://documentation.mailgun.net/api_reference
     $ 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_stats(limit: 5)
+mailgun = Mailgunner::Client.new
+
+mailgun.get_domains.items.each do |item|
+  puts "#{item.id} #{item.name}"
+end
 ```
 
 
 ## Storing the API key
 
-Best practice for storing credentials for external services is to use environment
-variables, as described by [12factor.net/config](http://www.12factor.net/config).
-Mailgunner::Client defaults to extracting the domain and api_key values it needs
-from the MAILGUN_API_KEY and MAILGUN_SMTP_LOGIN environment variables. These will
+Best practice for credentials is to [store them in the environment](https://www.12factor.net/config#store_config_in_the_environment).
+`Mailgunner::Client` defaults to extracting the domain and api_key values it needs
+from the `MAILGUN_API_KEY` and `MAILGUN_SMTP_LOGIN` environment variables—these will
 exist if you are using Mailgun on Heroku, or you can set them manually.
 
 
@@ -42,33 +46,29 @@ the following line to `config/environments/production.rb`:
 
 ```ruby
 config.action_mailer.delivery_method = :mailgun
-````
+```
 
 If for some reason you can't set the required ENV variables, you can configure Mailgunner
 through ActionMailer settings:
 
 ```ruby
 config.action_mailer.mailgun_settings = {
-  domain: 'test.com'
+  domain: 'test.com',
   api_key: 'your-api-key'
 }
-
 ```
 
 Outside of Rails you can set `ActionMailer::Base.delivery_method` directly.
 
 
-## Email validation
+## Specifying the region
 
-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:
+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
-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,385 +1,29 @@
-require 'net/http'
-require 'json'
-require 'cgi'
 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'
+require 'mailgunner/client/events'
+require 'mailgunner/client/ips'
+require 'mailgunner/client/mailing_lists'
+require 'mailgunner/client/messages'
+require 'mailgunner/client/routes'
+require 'mailgunner/client/stats'
+require 'mailgunner/client/suppressions'
+require 'mailgunner/client/tags'
+require 'mailgunner/client/webhooks'
 require 'mailgunner/delivery_method' if defined?(Mail)
 require 'mailgunner/railtie' if defined?(Rails)
 
 module Mailgunner
-  class Client
-    attr_accessor :domain, :api_key, :http
-
-    def initialize(options = {})
-      @domain = if options.key?(:domain)
-        options.fetch(:domain)
-      elsif ENV.key?('MAILGUN_SMTP_LOGIN')
-        ENV['MAILGUN_SMTP_LOGIN'].to_s.split('@').last
-      else
-        NoDomainProvided
-      end
-
-      @api_key = options.fetch(:api_key) { ENV.fetch('MAILGUN_API_KEY') }
-
-      @http = Net::HTTP.new('api.mailgun.net', Net::HTTP.https_default_port)
-
-      @http.use_ssl = true
-    end
-
-    def validate_address(value)
-      get('/v3/address/validate', address: value)
-    end
-
-    def parse_addresses(values)
-      get('/v3/address/parse', addresses: Array(values).join(','))
-    end
-
-    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}", {}, {'Accept' => 'message/rfc2822'})
-    end
-
-    def send_message(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
-
-    def get_domains(params = {})
-      get('/v3/domains', params)
-    end
-
-    def get_domain(name)
-      get("/v3/domains/#{escape name}")
-    end
-
-    def add_domain(attributes = {})
-      post('/v3/domains', attributes)
-    end
-
-    def delete_domain(name)
-      delete("/v3/domains/#{escape name}")
-    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_unsubscribes(params = {})
-      get("/v3/#{escape @domain}/unsubscribes", 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 = {})
-      post("/v3/#{escape @domain}/unsubscribes", attributes)
-    end
-
-    def get_complaints(params = {})
-      get("/v3/#{escape @domain}/complaints", params)
-    end
-
-    def get_complaint(address)
-      get("/v3/#{escape @domain}/complaints/#{escape address}")
-    end
-
-    def add_complaint(attributes = {})
-      post("/v3/#{escape @domain}/complaints", attributes)
-    end
-
-    def delete_complaint(address)
-      delete("/v3/#{escape @domain}/complaints/#{escape address}")
-    end
-
-    def get_bounces(params = {})
-      get("/v3/#{escape @domain}/bounces", params)
-    end
-
-    def get_bounce(address)
-      get("/v3/#{escape @domain}/bounces/#{escape address}")
-    end
-
-    def add_bounce(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_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)
-    end
-
-    def get_events(params = {})
-      get("/v3/#{escape @domain}/events", params)
-    end
-
-    def get_tags(params = {})
-      get("/v3/#{escape @domain}/tags", 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", params)
-    end
-
-    def delete_tag(id)
-      delete("/v3/#{escape @domain}/tags/#{escape id}")
-    end
-
-    def get_routes(params = {})
-      get('/v3/routes', params)
-    end
-
-    def get_route(id)
-      get("/v3/routes/#{escape id}")
-    end
-
-    def add_route(attributes = {})
-      post('/v3/routes', attributes)
-    end
-
-    def update_route(id, attributes = {})
-      put("/v3/routes/#{escape id}", attributes)
-    end
-
-    def delete_route(id)
-      delete("/v3/routes/#{escape id}")
-    end
-
-    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 = {})
-      post("/v3/domains/#{escape @domain}/webhooks", attributes)
-    end
-
-    def update_webhook(id, attributes = {})
-      put("/v3/domains/#{escape @domain}/webhooks/#{escape id}", attributes)
-    end
-
-    def delete_webhook(id)
-      delete("/v3/domains/#{escape @domain}/webhooks/#{escape id}")
-    end
-
-    def get_campaigns(params = {})
-      get("/v3/#{escape @domain}/campaigns", params)
-    end
-
-    def get_campaign(id)
-      get("/v3/#{escape @domain}/campaigns/#{escape id}")
-    end
-
-    def add_campaign(attributes = {})
-      post("/v3/#{escape @domain}/campaigns", attributes)
-    end
-
-    def update_campaign(id, attributes = {})
-      put("/v3/#{escape @domain}/campaigns/#{escape id}", attributes)
-    end
-
-    def delete_campaign(id)
-      delete("/v3/#{escape @domain}/campaigns/#{escape id}")
-    end
-
-    def get_campaign_events(campaign_id, params = {})
-      get("/v3/#{escape @domain}/campaigns/#{escape campaign_id}/events", params)
-    end
-
-    def get_campaign_stats(campaign_id, params = {})
-      get("/v3/#{escape @domain}/campaigns/#{escape campaign_id}/stats", params)
-    end
-
-    def get_campaign_clicks(campaign_id, params = {})
-      get("/v3/#{escape @domain}/campaigns/#{escape campaign_id}/clicks", params)
-    end
-
-    def get_campaign_opens(campaign_id, params = {})
-      get("/v3/#{escape @domain}/campaigns/#{escape campaign_id}/opens", params)
-    end
-
-    def get_campaign_unsubscribes(campaign_id, params = {})
-      get("/v3/#{escape @domain}/campaigns/#{escape campaign_id}/unsubscribes", params)
-    end
-
-    def get_campaign_complaints(campaign_id, params = {})
-      get("/v3/#{escape @domain}/campaigns/#{escape campaign_id}/complaints", params)
-    end
-
-    def get_lists(params = {})
-      get('/v3/lists', params)
-    end
-
-    def get_list(address)
-      get("/v3/lists/#{escape address}")
-    end
-
-    def add_list(attributes = {})
-      post('/v3/lists', attributes)
-    end
-
-    def update_list(address, 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 = {})
-      get("/v3/lists/#{escape list_address}/members", 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
-
-    private
-
-    def get(path, params = {}, headers = {})
-      request = Net::HTTP::Get.new(request_uri(path, params))
-
-      headers.each { |k, v| request[k] = v }
-
-      transmit(request)
-    end
-
-    def post(path, 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 = {})
-      transmit(Net::HTTP::Put.new(path)) { |message| message.set_form_data(attributes) }
-    end
-
-    def delete(path)
-      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
-
-      yield message if block_given?
-
-      parse(@http.request(message))
-    end
-
-    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}"
-      end
-    end
-
-    def parse_success(response)
-      return JSON.parse(response.body) if json?(response)
-
-      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 self.config
+    @config ||= Config.new
+  end
 
-    def escape(component)
-      CGI.escape(component.to_s)
-    end
+  def self.configure
+    yield config
   end
 end