mailgun-ruby 1.4.5 → 1.4.6

data/docs/Templates.md

@@ -1,92 +0,0 @@
-Mailgun - Templates
-====================
-
-This is the Mailgun Ruby *Templates* utilities.
-
-The below assumes you've already installed the Mailgun Ruby SDK in to your
-project. If not, go back to the master README for instructions.
-
-Usage - Templates
------------------------
-
-**Build a message with a template:**
-
-```ruby
-mb_obj = Mailgun::MessageBuilder.new
-
-mb_obj.from("sender@example.com")
-mb_obj.add_recipient("to", "recipient@example.com")
-mb_obj.subject ("This is the subject!")
-message.template('example.template.name')
-message.template_version('example.tag')
-
-mg_client.send_message "sending_domain.com", mb_obj
-```
-
-**Rails Example. Build a message with a template:**
-
-```ruby
-class UserMailer < ApplicationMailer
-  def welcome_email
-    message = mail(
-    	from: "sender@example.com",
-    	to: "recipient@example.com",
-    	subject: "This is the subject!",
-    	template: 'example.template.name'
-    ) do |format|
-      format.text { render plain: "Test!" }
-    end
-    message.tap do |message|
-      message.mailgun_template_variables ||= {
-       'version' => 'example.tag'
-      }
-    end
-  end
-end
-```
-
-Template Handlebars
--------------------------
-
-```
-{{#if english}}
-<p>This text is in the English language.</p>
-{{else if spanish}}
-<p>Este texto está en idioma español.</p>
-{{else if french}}
-<p>Ce texte est en langue française.</p>
-{{/if}}
-```
-
-In order to send the spanish version, for example:
-
-```ruby
-message.variable('spanish', 'true')
-```
-
-Also, Rails example:
-
-```ruby
-class UserMailer < ApplicationMailer
-  def welcome_email
-    message = mail(
-    	from: "sender@example.com",
-    	to: "recipient@example.com",
-    	subject: "This is the subject!",
-    	template: 'example.template.name'
-    ) do |format|
-      format.text { render plain: "Test!" }
-    end
-    message.tap do |message|
-      message.mailgun_variables ||= {
-       'spanish' => 'true'
-      }
-    end
-  end
-end
-```
-
-More Documentation
-------------------
-See the official [Mailgun Templates Docs](https://documentation.mailgun.com/en/latest/api-templates.html)
-for more information

data/docs/Webhooks.md

@@ -1,65 +0,0 @@
-Mailgun - Webhooks
-====================
-
-This is the Mailgun Ruby *Webhook* utilities.
-
-The below assumes you've already installed the Mailgun Ruby SDK in to your
-project. If not, go back to the master README for instructions.
-
-Usage - Webhooks
------------------------
-
-```ruby
-# First, instantiate the Mailgun Client with your API key
-mg_client = Mailgun::Client.new('your-api-key')
-hook = Mailgun::Webhooks.new(mg_client)
-
-# Get a list webhooks for a domain.
-hook.list 'my.perfect.domain'
-
-# View a single webhook detail
-hook.info 'my.perfect.domain', 'delivered'
-
-# Add a single url for all webhooks
-hook.create_all 'my.perfect.domain', 'https://the.webhook.url/'
-
-# Add a url for a specific webhook
-hook.create 'my.perfect.domain', 'delivered', 'https://the.webhook.url/'
-
-# Update the url for a specific webhook
-hook.update 'my.perfect.domain', 'delivered', 'https://the.webhook.url/'
-
-# Remove a url for a specific webhook
-hook.remove 'my.perfect.domain', 'delivered'
-
-# Remove all webhooks for a domain
-hook.remove_all 'my.perfect.domain'
-```
-
-Usage - Webhooks (v4)
------------------------
-
-The v4 endpoints work with a URL across multiple event types in a single request.
-They require a client configured for the `v4` API.
-
-```ruby
-mg_client = Mailgun::Client.new('your-api-key', 'api.mailgun.net', 'v4')
-hook = Mailgun::Webhooks.new(mg_client)
-
-# Associate a url with one or more event types
-hook.create_v4 'my.perfect.domain', url: 'https://the.webhook.url/', event_types: %w[delivered opened]
-
-# Replace the event types associated with a url
-hook.update_v4 'my.perfect.domain', url: 'https://the.webhook.url/', event_types: %w[clicked]
-
-# Remove one or more urls from all event types they are associated with
-hook.remove_v4 'my.perfect.domain', url: 'https://the.webhook.url/'
-hook.remove_v4 'my.perfect.domain', url: ['https://the.webhook.url/', 'https://another.webhook.url/']
-```
-
-Each v4 method returns a Hash of the domain's webhooks keyed by event type.
-
-More Documentation
-------------------
-See the official [Mailgun Webhooks Docs](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-webhooks)
-for more information

data/docs/railgun/EmailValidation.md

@@ -1,34 +0,0 @@
-Mailgun - Email Validation
-====================
-
-This is the Mailgun Ruby *Email Validation* utilities.
-
-The below assumes you've already installed the Mailgun Ruby SDK in to your
-project. If not, go back to the master README for instructions.
-
-Usage - Email Validation
------------------------
-
-```ruby
-# First, instantiate the Mailgun Address. It pulls api key for Client from Mailgun.api_key variable.
-email_validator = Mailgun::Address.new
-
-# Given an arbitrary address, validates address based off defined checks.
-# Response Example:
-# {
-#     "address": "existingemail@realdomain.com",
-#     "is_disposable_address": false,
-#     "is_role_address": false,
-#     "reason": [],
-#     "result": "deliverable",
-#     "risk": "low"
-# }
-email_validator.validate('email@example.com')
-
-
-```
-
-More Documentation
-------------------
-See the official [Mailgun Email Validation Docs](https://documentation.mailgun.com/en/latest/api-email-validation.html)
-for more information

data/docs/railgun/Overview.md

@@ -1,11 +0,0 @@
-Overview
-========
-
-Railgun is a Rails add-on that allows ActionMailer to send via the Mailgun API.
-
-See [railgun-sample](https://github.com/pirogoeth/railgun-sample/) for examples of integrating Railgun with your Rails app.
-
-
-## Table of Contents
-
-- [Parameters](/docs/railgun/Parameters.md)

data/docs/railgun/Parameters.md

@@ -1,83 +0,0 @@
-Parameters
-==========
-
-When sending messages via Railgun, it is often useful to set options, headers, and variables
-that should be added to the `POST` request against the messages endpoint.
-
-
-## Options
-
-See [Mailgun Docs | Sending](https://documentation.mailgun.com/en/latest/api-sending.html#sending) for available options.
-
----
-
-To set options on a message:
-
-```ruby
-# app/controllers/some_controller.rb
-
-message = YourMailer.your_message(@args)
-
-message.mailgun_options ||= {
-  "tracking-opens" => "true",
-  "tracking-clicks" => "htmlonly",
-  "tag" => "some,tags",
-}
-```
-
-
-## Variables
-
-See [Mailgun Docs | Attaching Data to Messages](https://documentation.mailgun.com/en/latest/user_manual.html#attaching-data-to-messages) for more information.
-
----
-
-To set variables on a message:
-
-```ruby
-# app/controllers/some_controller.rb
-
-message = YourMailer.your_message(@args)
-
-message.mailgun_variables ||= {
-  "user_info" => {"id" => "1", "name" => "tstark"},
-}
-```
-
-
-## Headers
-
-See [Mailgun Docs | Sending](https://documentation.mailgun.com/en/latest/api-sending.html#sending) for more information.
-
----
-
-To set headers on a message *from a controller*:
-
-```ruby
-# app/controllers/some_controller.rb
-
-message = YourMailer.your_message(@args)
-
-message.mailgun_headers ||= {
-  "X-Sent-From-Rails" => "true",
-}
-```
-
-To set headers on a message *from a mailer*:
-
-```ruby
-# app/mailers/your_mailer.rb
-
-class YourMailer < ApplicationMailer
-  # ...
-
-  def your_message(args)
-    headers({
-      "X-Sent-From-Rails" => "true",
-    })
-
-    mail to: "some-address@example.org", ...
-  end
-
-end
-```

data/mailgun.gemspec

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'mailgun/version'
-
-Gem::Specification.new do |spec|
-  spec.name             = 'mailgun-ruby'
-  spec.version          = Mailgun::VERSION
-  spec.homepage         = 'https://www.mailgun.com/'
-  spec.platform         = Gem::Platform::RUBY
-  spec.license          = 'Apache-2.0'
-
-  spec.summary          = "Mailgun's Official Ruby SDK"
-  spec.description      = "Mailgun's Official Ruby SDK for interacting with the Mailgun API."
-
-  spec.authors          = ['Mailgun', 'Travis Swientek']
-  spec.email            = 'support@mailgunhq.com'
-
-  spec.metadata['documentation_uri'] = 'https://documentation.mailgun.com/'
-  spec.metadata['source_code_uri'] = 'https://github.com/mailgun/mailgun-ruby'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.required_ruby_version = '>= 3.0.0'
-
-  spec.add_development_dependency 'bundler', '>= 1.16.2'
-  spec.add_development_dependency 'pry', '~> 0.16.0'
-  spec.add_development_dependency 'rails'
-  spec.add_development_dependency 'rake', '~> 13.3.1'
-  spec.add_development_dependency 'rspec', '~> 3.13.0'
-  spec.add_development_dependency 'rspec-its', '~> 2.0.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-rake'
-  spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'simplecov-json'
-  spec.add_development_dependency 'vcr', '~> 6.4.0'
-  spec.add_development_dependency 'webmock', '~> 3.7'
-  spec.add_dependency 'faraday', '~> 2.1'
-  spec.add_dependency 'faraday-multipart', '< 2'
-  spec.add_dependency 'mini_mime'
-  spec.add_dependency 'zeitwerk'
-end

data/spec/integration/account_webhooks_spec.rb

@@ -1,57 +0,0 @@
-# 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/analytics_tags_spec.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'analytics_tags' }
-
-describe 'AnalyticsTags', vcr: vcr_opts do
-  let(:api_version) { APIVERSION }
-  let(:mg_client) { Mailgun::Client.new(APIKEY, APIHOST, api_version, SSL) }
-  let(:mg_obj) { Mailgun::AnalyticsTags.new(mg_client) }
-  let(:api_version) { 'v1' }
-
-  describe '#update' do
-    it 'updates a tag' do
-      response = mg_obj.update('test1', 'test_description')
-
-      expect(response).to be_truthy
-    end
-  end
-
-  describe '#list' do
-    it 'returns a list of tags' do
-      response = mg_obj.list(
-        {
-          pagination: {
-            sort: 'lastseen:desc',
-            limit: 10
-          },
-          include_subaccounts: true
-        }
-      )
-
-      expect(response[0]['account_id']).to eq('test')
-      expect(response[0]['tag']).to eq('test1')
-    end
-  end
-
-  describe '#remove' do
-    it 'removes a tag' do
-      response = mg_obj.remove('test1')
-
-      expect(response).to be_truthy
-    end
-  end
-
-  describe '#limits' do
-    it 'returns limits' do
-      response = mg_obj.limits
-
-      expect(response['limit']).to eq(100_000)
-    end
-  end
-end

data/spec/integration/api_keys_spec.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'api_keys' }
-
-describe 'ApiKeys', 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::ApiKeys.new(mg_client) }
-
-  it 'creates an api key' do
-    result = mg_obj.create(
-      {
-        kind: 'user',
-        'description': 'test test',
-        'role': 'admin'
-      }
-    )
-
-    expect(result['description']).to eq('test test')
-  end
-
-  it 'gets api keys' do
-    result = mg_obj.list
-
-    expect(result[0]['id']).to eq('test')
-  end
-
-  it 'gets api keys filtered by kind and domain' do
-    result = mg_obj.list(kind: 'domain', domain_name: 'DOMAIN.TEST')
-
-    domain_keys = result.select { |key| key['kind'] == 'domain' }
-    expect(domain_keys.map { |key| key['domain_name'] }).to eq(['DOMAIN.TEST'])
-    expect(result.map { |key| key['kind'] }).not_to include('user', 'web')
-  end
-
-  it 'removes an api key' do
-    result = mg_obj.remove('test')
-
-    expect(result).to be_truthy
-  end
-
-  it 'regenerates public api key' do
-    result = mg_obj.regenerate
-
-    expect(result).to be_truthy
-  end
-end

data/spec/integration/bounces_spec.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'bounces' }
-
-describe 'For the Bounces endpoint', order: :defined, vcr: vcr_opts do
-  before(:all) do
-    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN
-    @email = "integration-test+email@#{TESTDOMAIN}"
-  end
-
-  it 'creates a bounce' do
-    @result = @mg_obj.post("#{@domain}/bounces",
-                           { address: @email,
-                             code: 550,
-                             error: 'Integration Test' })
-
-    @result.to_h!
-    expect(@result.body['message']).to eq('Address has been added to the bounces table')
-    expect(@result.body['address']).to eq(@email)
-  end
-
-  it 'get a bounce.' do
-    result = @mg_obj.get("#{@domain}/bounces/#{CGI.escape(@email)}")
-
-    result.to_h!
-    expect(result.body['code']).to eq('550')
-    expect(result.body['address']).to eq(@email)
-    expect(result.body['error']).to eq('Integration Test')
-  end
-
-  it 'gets a list of bounces.' do
-    result = @mg_obj.get("#{@domain}/bounces")
-
-    result.to_h!
-    expect(result.body['items'].length).to be > 0
-  end
-
-  it 'deletes a bounce' do
-    @mg_obj.delete("#{@domain}/bounces/#{CGI.escape(@email)}")
-  end
-end

data/spec/integration/campaign_spec.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'campaigns' }
-
-describe 'For the campaigns endpoint', vcr: vcr_opts do
-  before(:all) do
-    skip 'pending removal'
-    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN
-    @campaign_id = 'integration_test_campaign'
-  end
-
-  it 'creates a campaign' do
-    result = @mg_obj.post("#{@domain}/campaigns", { name: 'My Campaign',
-                                                    id: @campaign_id })
-
-    result.to_h!
-    expect(result.body['message']).to eq('Campaign created')
-    expect(result.body['campaign']['id']).to eq(@campaign_id)
-    expect(result.body['campaign']['name']).to eq('My Campaign')
-  end
-
-  it 'get a campaign.' do
-    result = @mg_obj.get("#{@domain}/campaigns/#{@campaign_id}")
-
-    result.to_h!
-    expect(result.body['id']).to eq(@campaign_id)
-    expect(result.body['name']).to eq('My Campaign')
-  end
-
-  it 'gets a list of all campaigns.' do
-    result = @mg_obj.get("#{@domain}/campaigns", { limit: 50 })
-
-    result.to_h!
-    expect(result.body['total_count']).to be > 0
-  end
-
-  it 'update a campaign.' do
-    result = @mg_obj.put("#{@domain}/campaigns/#{@campaign_id}", { name: 'My Updated Campaign',
-                                                                   id: @campaign_id })
-
-    result.to_h!
-    expect(result.body['message']).to eq('Campaign updated')
-    expect(result.body['campaign']['id']).to eq(@campaign_id)
-    expect(result.body['campaign']['name']).to eq('My Updated Campaign')
-  end
-
-  it 'get campaign events.' do
-    expect { @mg_obj.get("#{@domain}/campaigns/#{@campaign_id}/events", { groupby: 'clicked' }) }.not_to raise_error
-  end
-
-  it 'get campaign stats.' do
-    expect { @mg_obj.get("#{@domain}/campaigns/#{@campaign_id}/stats", { groupby: 'domain' }) }.not_to raise_error
-  end
-
-  it 'removes a campaign' do
-    @mg_obj.delete("#{@domain}/campaigns/#{@campaign_id}")
-  end
-end

data/spec/integration/complaints_spec.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'complaints' }
-
-describe 'For the Complaints endpoint', order: :defined, vcr: vcr_opts do
-  before(:all) do
-    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN
-    @email = "integration-test-email@#{TESTDOMAIN}"
-  end
-
-  it 'creates a complaint' do
-    @result = @mg_obj.post("#{@domain}/complaints", { address: @email })
-
-    @result.to_h!
-    expect(@result.body['message']).to eq('Address has been added to the complaints table')
-    expect(@result.body['address']).to eq(@email)
-  end
-
-  it 'get a complaint.' do
-    result = @mg_obj.get("#{@domain}/complaints/#{@email}")
-
-    result.to_h!
-    expect(result.body['address']).to eq(@email)
-  end
-
-  it 'gets a list of complaints.' do
-    result = @mg_obj.get("#{@domain}/complaints")
-
-    result.to_h!
-    expect(result.body['items'].length).to be > 0
-  end
-
-  it 'removes a complaint' do
-    @mg_obj.delete("#{@domain}/complaints/#{@email}")
-  end
-end