mailgun-ruby 1.4.1 → 1.4.2

data/lib/railgun/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Railgun
   class Railtie < ::Rails::Railtie
     ActiveSupport.on_load(:action_mailer) do

data/lib/railgun.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # require ruby dependencies
 require 'json'
 

data/mailgun.gemspec

@@ -1,10 +1,10 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# 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/'
@@ -23,21 +23,22 @@ Gem::Specification.new do |spec|
   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.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 'rake', '~> 13.3.1'
-  spec.add_development_dependency 'webmock', '~> 3.7'
-  spec.add_development_dependency 'pry', '~> 0.16.0'
-  spec.add_development_dependency 'vcr', '~> 6.4.0'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
-  spec.add_development_dependency 'rails'
-  spec.add_dependency 'mini_mime'
-  spec.add_dependency 'faraday', "~> 2.1"
+  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/analytics_tags_spec.rb

@@ -0,0 +1,54 @@
+# 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
+
+  context '#limits' do
+    it 'returns limits' do
+      response = mg_obj.limits
+
+      expect(response['limit']).to eq(100_000)
+    end
+  end
+end

data/spec/integration/bounces_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'mailgun'
 
-vcr_opts = { :cassette_name => "bounces" }
+vcr_opts = { cassette_name: 'bounces' }
 
 describe 'For the Bounces endpoint', order: :defined, vcr: vcr_opts do
   before(:all) do
@@ -12,33 +14,32 @@ describe 'For the Bounces endpoint', order: :defined, vcr: vcr_opts do
 
   it 'creates a bounce' do
     @result = @mg_obj.post("#{@domain}/bounces",
-                           {:address => @email,
-                            :code => 550,
-                            :error => "Integration Test"})
+                           { 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)
+    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")
+    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
+    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,57 +1,59 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'mailgun'
 
-vcr_opts = { :cassette_name => "campaigns" }
+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"
+    @campaign_id = 'integration_test_campaign'
   end
 
   it 'creates a campaign' do
-    result = @mg_obj.post("#{@domain}/campaigns", {:name => 'My Campaign',
-                                                   :id => @campaign_id})
+    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')
+    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')
+    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 = @mg_obj.get("#{@domain}/campaigns", { limit: 50 })
 
     result.to_h!
-    expect(result.body["total_count"]).to be > 0
+    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 = @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')
+    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
+    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
+    expect { @mg_obj.get("#{@domain}/campaigns/#{@campaign_id}/stats", { groupby: 'domain' }) }.not_to raise_error
   end
 
   it 'removes a campaign' do

data/spec/integration/complaints_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'mailgun'
 
-vcr_opts = { :cassette_name => "complaints" }
+vcr_opts = { cassette_name: 'complaints' }
 
 describe 'For the Complaints endpoint', order: :defined, vcr: vcr_opts do
   before(:all) do
@@ -11,25 +13,25 @@ describe 'For the Complaints endpoint', order: :defined, vcr: vcr_opts do
   end
 
   it 'creates a complaint' do
-    @result = @mg_obj.post("#{@domain}/complaints", {:address => @email})
+    @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)
+    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)
+    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
+    expect(result.body['items'].length).to be > 0
   end
 
   it 'removes a complaint' do

data/spec/integration/domains_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'mailgun'
 
-vcr_opts = { :cassette_name => "domains" }
+vcr_opts = { cassette_name: 'domains' }
 
 describe 'For the domains endpoint', vcr: vcr_opts do
   let(:api_version) { APIVERSION }
@@ -71,7 +73,6 @@ describe 'For the domains endpoint', vcr: vcr_opts do
     end
   end
 
-
   context 'Domain::Keys methods' do
     describe '#list_domain_keys' do
       let(:api_version) { 'v1' }
@@ -123,7 +124,6 @@ describe 'For the domains endpoint', vcr: vcr_opts do
       let(:api_version) { 'v4' }
 
       it 'activates a domain key' do
-
         result = mg_obj.activate_domain_key(
           domain,
           'mailo1'
@@ -187,7 +187,7 @@ describe 'For the domains endpoint', vcr: vcr_opts do
   end
 
   context 'Domain::Tracking methods' do
-    # TODO add missing:
+    # TODO: add missing:
     # get_domain_tracking_certificate
     # regenerate_domain_tracking_certificate
     # generate_domain_tracking_certificate
@@ -244,7 +244,7 @@ describe 'For the domains endpoint', vcr: vcr_opts do
   end
 
   context 'Domain::DKIM_Security methods' do
-    # TODO add missing:
+    # TODO: add missing:
     # dkim_rotation
     # dkim_rotate
   end
@@ -261,7 +261,7 @@ describe 'For the domains endpoint', vcr: vcr_opts do
           }
         )
 
-        expect(result['message']).to eq("Created 1 credentials pair(s)")
+        expect(result['message']).to eq('Created 1 credentials pair(s)')
       end
     end
 

data/spec/integration/email_validation_spec.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 require 'mailgun'
 require 'mailgun/address'
 
-vcr_opts = { :cassette_name => "email_validation" }
+vcr_opts = { cassette_name: 'email_validation' }
 
 describe 'For the email validation endpoint', order: :defined, vcr: vcr_opts do
   before(:all) do
     @mg_obj = Mailgun::Address.new
 
-    @valid = ["Alice <alice@example.com>", "bob@example.com"]
-    @invalid = ["example.org"]
+    @valid = ['Alice <alice@example.com>', 'bob@example.com']
+    @invalid = ['example.org']
 
     @all_addrs = @valid + @invalid
   end
@@ -19,54 +21,53 @@ describe 'For the email validation endpoint', order: :defined, vcr: vcr_opts do
     skip 'is parse method removed?'
     res = @mg_obj.parse(@all_addrs)
 
-    expect(res["parsed"]).to eq(@valid)
-    expect(res["unparsable"]).to eq(@invalid)
+    expect(res['parsed']).to eq(@valid)
+    expect(res['unparsable']).to eq(@invalid)
   end
 
   it 'validates alice@mailgun.net with info' do
-    res = @mg_obj.validate("alice@mailgun.net")
+    res = @mg_obj.validate('alice@mailgun.net')
 
     expected = {
-        "address" => "alice@mailgun.net",
-        "did_you_mean" => nil,
-        "is_disposable_address" => false,
-        "is_role_address" => false,
-        "is_valid" => true,
-        "mailbox_verification" => "true",
-        "reason" => nil,
-        "parts" => {
-            "display_name" => nil,
-            "domain" => "mailgun.net",
-            "local_part" => "alice",
-        },
+      'address' => 'alice@mailgun.net',
+      'did_you_mean' => nil,
+      'is_disposable_address' => false,
+      'is_role_address' => false,
+      'is_valid' => true,
+      'mailbox_verification' => 'true',
+      'reason' => nil,
+      'parts' => {
+        'display_name' => nil,
+        'domain' => 'mailgun.net',
+        'local_part' => 'alice'
+      }
     }
     expect(res).to eq(expected)
   end
 
   it 'performs mailbox validation for alice@mailgun.net' do
-    res = @mg_obj.validate("alice@mailgun.net", true)
+    res = @mg_obj.validate('alice@mailgun.net', true)
 
-    expect(res["mailbox_verification"]).to eq("true")
+    expect(res['mailbox_verification']).to eq('true')
   end
 
   it 'fails to validate example.org' do
-    res = @mg_obj.validate("example.org")
+    res = @mg_obj.validate('example.org')
 
     expected = {
-        "address" => "example.org",
-        "did_you_mean" => nil,
-        "is_disposable_address" => false,
-        "is_role_address" => false,
-        "is_valid" => false,
-        "mailbox_verification" => "unknown",
-        #"reason" => "Validation failed for 'example.org', reason: 'malformed address; missing @ sign'",
-        "parts" => {
-            "display_name" => nil,
-            "domain" => nil,
-            "local_part" => nil,
-        },
+      'address' => 'example.org',
+      'did_you_mean' => nil,
+      'is_disposable_address' => false,
+      'is_role_address' => false,
+      'is_valid' => false,
+      'mailbox_verification' => 'unknown',
+      # "reason" => "Validation failed for 'example.org', reason: 'malformed address; missing @ sign'",
+      'parts' => {
+        'display_name' => nil,
+        'domain' => nil,
+        'local_part' => nil
+      }
     }
     expect(res).to eq(expected)
   end
-
 end

data/spec/integration/events_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'mailgun'
 require 'mailgun/events/events'
 
-vcr_opts = { :cassette_name => "events" }
+vcr_opts = { cassette_name: 'events' }
 
 describe 'For the Events endpoint', vcr: vcr_opts do
   before(:all) do
@@ -12,12 +14,12 @@ describe 'For the Events endpoint', vcr: vcr_opts do
   end
 
   it 'can get an event.' do
-    result = @mg_obj.get("#{@domain}/events", {:limit => 1})
+    result = @mg_obj.get("#{@domain}/events", { limit: 1 })
 
     result.to_h!
-    expect(result.body["items"].length).to be_within(1).of(1)
-    expect(result.body["paging"]).to include("next")
-    expect(result.body["paging"]).to include("previous")
+    expect(result.body['items'].length).to be_within(1).of(1)
+    expect(result.body['paging']).to include('next')
+    expect(result.body['paging']).to include('previous')
   end
 
   it 'can iterate over all events with `each`' do

data/spec/integration/list_members_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'mailgun'
 
-vcr_opts = { :cassette_name => "list_members" }
+vcr_opts = { cassette_name: 'list_members' }
 
 describe 'For the Mailing Lists Members endpoint', order: :defined, vcr: vcr_opts do
   before(:all) do
@@ -10,54 +12,53 @@ describe 'For the Mailing Lists Members endpoint', order: :defined, vcr: vcr_opt
     @ml_address = "integration_test_list@#{@domain}"
     @ml_member = "integration_test_member_member@#{@domain}"
   end
-  
+
   it 'creates a list' do
-    result = @mg_obj.post("lists", {:address => @ml_address,
-                           :name => 'Integration Test List',
-                           :description => 'This list should be deleted automatically.',
-                           :access_level => 'members'})
+    result = @mg_obj.post('lists', { address: @ml_address,
+                                     name: 'Integration Test List',
+                                     description: 'This list should be deleted automatically.',
+                                     access_level: 'members' })
     result.to_h!
-    expect(result.body["message"]).to eq("Mailing list has been created")
-    expect(result.body["list"]["address"]).to eq(@ml_address)
-    expect(result.body["list"]["name"]).to eq('Integration Test List')
+    expect(result.body['message']).to eq('Mailing list has been created')
+    expect(result.body['list']['address']).to eq(@ml_address)
+    expect(result.body['list']['name']).to eq('Integration Test List')
   end
 
   it 'adds a list member' do
     result = @mg_obj.post("lists/#{@ml_address}/members",
-                          {:address => @ml_member,
-                           :name => 'Jane Doe',
-                           :subscribed => true,
-                           :upsert => 'no'})
+                          { address: @ml_member,
+                            name: 'Jane Doe',
+                            subscribed: true,
+                            upsert: 'no' })
 
     result.to_h!
-    expect(result.body["message"]).to eq("Mailing list member has been created")
-    expect(result.body["member"]["address"]).to eq(@ml_member)
-    expect(result.body["member"]["name"]).to eq('Jane Doe')
+    expect(result.body['message']).to eq('Mailing list member has been created')
+    expect(result.body['member']['address']).to eq(@ml_member)
+    expect(result.body['member']['name']).to eq('Jane Doe')
   end
-  
+
   it 'gets a list member.' do
     result = @mg_obj.get("lists/#{@ml_address}/members/#{@ml_member}")
 
     result.to_h!
-    expect(result.body["member"]["address"]).to eq(@ml_member)
-    expect(result.body["member"]["name"]).to eq('Jane Doe')
+    expect(result.body['member']['address']).to eq(@ml_member)
+    expect(result.body['member']['name']).to eq('Jane Doe')
   end
 
   it 'updates a list member.' do
     result = @mg_obj.put("lists/#{@ml_address}/members/#{@ml_member}",
-                         {:name => 'Jane Doe Update',
-                          :subscribed => false})
+                         { name: 'Jane Doe Update',
+                           subscribed: false })
 
     result.to_h!
-    expect(result.body["message"]).to eq("Mailing list member has been updated")
-    expect(result.body["member"]["address"]).to eq(@ml_member)
-    expect(result.body["member"]["name"]).to eq('Jane Doe Update')
-    expect(result.body["member"]["subscribed"]).to eq(false)
+    expect(result.body['message']).to eq('Mailing list member has been updated')
+    expect(result.body['member']['address']).to eq(@ml_member)
+    expect(result.body['member']['name']).to eq('Jane Doe Update')
+    expect(result.body['member']['subscribed']).to eq(false)
   end
 
   it 'removes a list member' do
     @mg_obj.delete("lists/#{@ml_address}/members/#{@ml_member}")
     @mg_obj.delete("lists/#{@ml_address}")
   end
-
 end

data/spec/integration/list_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'mailgun'
 
-vcr_opts = { :cassette_name => "mailing_list" }
+vcr_opts = { cassette_name: 'mailing_list' }
 
 describe 'For the Mailing Lists endpoint', vcr: vcr_opts do
   before(:all) do
@@ -11,48 +13,47 @@ describe 'For the Mailing Lists endpoint', vcr: vcr_opts do
   end
 
   it 'creates a list' do
-    result = @mg_obj.post("lists", {:address => @ml_address,
-                                    :name => 'Integration Test List',
-                                    :description => 'This list should be deleted automatically.',
-                                    :access_level => 'members'})
+    result = @mg_obj.post('lists', { address: @ml_address,
+                                     name: 'Integration Test List',
+                                     description: 'This list should be deleted automatically.',
+                                     access_level: 'members' })
 
     result.to_h!
-    expect(result.body["message"]).to eq("Mailing list has been created")
-    expect(result.body["list"]["address"]).to eq(@ml_address)
-    expect(result.body["list"]["name"]).to eq('Integration Test List')
+    expect(result.body['message']).to eq('Mailing list has been created')
+    expect(result.body['list']['address']).to eq(@ml_address)
+    expect(result.body['list']['name']).to eq('Integration Test List')
   end
 
   it 'gets a list.' do
     result = @mg_obj.get("lists/#{@ml_address}")
 
     result.to_h!
-    expect(result.body["list"]["address"]).to eq(@ml_address)
-    expect(result.body["list"]["name"]).to eq('Integration Test List')
+    expect(result.body['list']['address']).to eq(@ml_address)
+    expect(result.body['list']['name']).to eq('Integration Test List')
   end
 
   it 'gets a list of all lists.' do
-    result = @mg_obj.get("lists", {:limit => 50})
+    result = @mg_obj.get('lists', { limit: 50 })
 
     result.to_h!
-    expect(result.body["total_count"]).to be > 0
+    expect(result.body['total_count']).to be > 0
   end
 
   it 'updates a list.' do
     result = @mg_obj.put("lists/#{@ml_address}",
-                         {:address => @ml_address,
-                          :name => 'Integration Test List Update',
-                          :description => 'This list should be deleted automatically.',
-                          :access_level => 'readonly'})
+                         { address: @ml_address,
+                           name: 'Integration Test List Update',
+                           description: 'This list should be deleted automatically.',
+                           access_level: 'readonly' })
 
     result.to_h!
-    expect(result.body["message"]).to eq("Mailing list has been updated")
-    expect(result.body["list"]["address"]).to eq(@ml_address)
-    expect(result.body["list"]["name"]).to eq('Integration Test List Update')
-    expect(result.body["list"]["access_level"]).to eq('readonly')
+    expect(result.body['message']).to eq('Mailing list has been updated')
+    expect(result.body['list']['address']).to eq(@ml_address)
+    expect(result.body['list']['name']).to eq('Integration Test List Update')
+    expect(result.body['list']['access_level']).to eq('readonly')
   end
 
   it 'deletes a list' do
     @mg_obj.delete("lists/#{@ml_address}")
   end
-
 end