wj-mailgun-ruby 1.1.7

data/spec/integration/stats_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "stats" }
+
+describe 'For the Stats endpoint', vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+  end
+
+  it 'get some stats.' do
+    @mg_obj.get("#{@domain}/stats", {:limit => 50, :skip => 10, :event => 'sent'})
+  end
+end

data/spec/integration/suppressions_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+require 'mailgun'
+require 'mailgun/suppressions'
+
+vcr_opts = { :cassette_name => 'suppressions' }
+
+describe 'For the suppressions handling class', order: :defined, vcr: vcr_opts do
+
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY)
+    @suppress = Mailgun::Suppressions.new(@mg_obj, TESTDOMAIN)
+
+    @addresses = ['test1@example.com', 'test2@example.org', 'test3@example.net', 'test4@example.info']
+  end
+
+  it 'can batch-add bounces' do
+    bounces = []
+    @addresses.each do |addr|
+      bounces.push({
+        :address => addr,
+        :code => 500,
+        :error => 'integration testing',
+      })
+    end
+
+    response, nested = @suppress.create_bounces bounces
+    response.to_h!
+
+    expect(response.code).to eq(200)
+    expect(response.body['message']).to eq('4 addresses have been added to the bounces table')
+    expect(nested.length).to eq(0)
+  end
+
+  it 'raises ParameterError if no bounce[:address] is present' do
+    bounces = []
+    bounces.push({
+      :code => 500,
+      :error => 'integration testing',
+    })
+
+    expect { @suppress.create_bounces bounces }.to raise_error(Mailgun::ParameterError)
+  end
+
+  it 'removes a single bounce address' do
+    @addresses.each do |addr|
+      response = @suppress.delete_bounce addr
+      response.to_h!
+
+      expect(response.code).to eq(200)
+      expect(response.body['message']).to eq('Bounced address has been removed')
+    end
+  end
+
+  it 'can batch-add unsubscribes' do
+    unsubscribes = []
+    @addresses.each do |addr|
+      unsubscribes.push({
+        :address => addr,
+        :tag => 'integration',
+      })
+    end
+
+    response, nested = @suppress.create_unsubscribes unsubscribes
+    response.to_h!
+
+    expect(response.code).to eq(200)
+    expect(response.body['message']).to eq('4 addresses have been added to the unsubscribes table')
+    expect(nested.length).to eq(0)
+  end
+
+  it 'raises ParameterError if no unsubscribe[:address] is present' do
+    unsubscribes = []
+    unsubscribes.push({
+      :tag => 'integration',
+    })
+
+    expect { @suppress.create_unsubscribes unsubscribes }.to raise_error(Mailgun::ParameterError)
+  end
+
+  it 'removes a single unsubscribe address' do
+    @addresses.each do |addr|
+      response = @suppress.delete_unsubscribe addr
+      response.to_h!
+
+      expect(response.code).to eq(200)
+      expect(response.body['message']).to eq('Unsubscribe event has been removed')
+    end
+  end
+
+  it 'can batch-add complaints' do
+    complaints = []
+    @addresses.each do |addr|
+      complaints.push :address => addr
+    end
+
+    response, nested = @suppress.create_complaints complaints
+    response.to_h!
+
+    expect(response.code).to eq(200)
+    expect(response.body['message']).to eq('4 complaint addresses have been added to the complaints table')
+    expect(nested.length).to eq(0)
+  end
+
+  it 'raises ParameterError if no complaint[:address] is present' do
+    complaints = []
+    complaints.push({
+      :tag => 'integration',
+    })
+
+    expect { @suppress.create_complaints complaints }.to raise_error(Mailgun::ParameterError)
+  end
+
+  it 'removes a single complaint address' do
+    @addresses.each do |addr|
+      response = @suppress.delete_complaint addr
+      response.to_h!
+
+      expect(response.code).to eq(200)
+      expect(response.body['message']).to eq('Spam complaint has been removed')
+    end
+  end
+
+  # TODO: Add tests for pagination support.
+end
+

data/spec/integration/unsubscribes_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "unsubscribes" }
+
+describe 'For the Unsubscribes 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 'adds an unsubscriber' do
+    result = @mg_obj.post "#{@domain}/unsubscribes", address: @email, tag: '*'
+
+    result.to_h!
+    expect(result.body["message"]).to eq("Address has been added to the unsubscribes table")
+    expect(result.body["address"]).to eq(@email)
+  end
+
+  it 'get an unsubscribee.' do
+    result = @mg_obj.get "#{@domain}/unsubscribes/#{@email}"
+
+    result.to_h!
+    expect(result.body["address"]).to eq(@email)
+  end
+
+  it 'gets a list of unsubscribes.' do
+    result = @mg_obj.get "#{@domain}/unsubscribes"
+
+    result.to_h!
+    expect(result.body["items"].length).to be > 0
+  end
+
+  it 'removes an unsubscribee' do
+    result = @mg_obj.delete "#{@domain}/unsubscribes/#{@email}"
+
+    result.to_h!
+    expect(result.body['address']).to eq(@email)
+    expect(result.body["message"]).to eq("Unsubscribe event has been removed")
+  end
+end

data/spec/integration/webhook_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "webhooks" }
+
+describe 'For the webhooks endpoint', order: :defined, vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+    @testhook = 'bounce'
+    @testhookup = 'bounceup'
+  end
+
+  it 'creates a webhook' do
+    result = @mg_obj.post("domains/#{@domain}/webhooks", { id: 'bounce',
+                                                           url: "http://example.com/mailgun/events/#{@testhook}" } )
+
+    result.to_h!
+    expect(result.body["message"]).to eq("Webhook has been created")
+    expect(result.body["webhook"]["url"]).to eq("http://example.com/mailgun/events/#{@testhook}")
+  end
+
+  it 'gets a webhook.' do
+    result = @mg_obj.get("domains/#{@domain}/webhooks/#{@testhook}")
+
+    result.to_h!
+    expect(result.body["webhook"]["url"]).to eq("http://example.com/mailgun/events/#{@testhook}")
+  end
+
+  it 'gets a list of all webhooks.' do
+    result = @mg_obj.get("domains/#{@domain}/webhooks")
+
+    result.to_h!
+    expect(result.body["webhooks"]["bounce"]["url"]).to eq("http://example.com/mailgun/events/#{@testhook}")
+  end
+
+  it 'updates a webhook.' do
+    result = @mg_obj.put("domains/#{@domain}/webhooks/bounce", {:id => 'bounce',
+                                                                :url => "http://example.com/mailgun/events/#{@testhookup}"})
+
+    result.to_h!
+    expect(result.body["message"]).to eq("Webhook has been updated")
+    expect(result.body["webhook"]["url"]).to eq("http://example.com/mailgun/events/#{@testhookup}")
+  end
+
+  it 'removes a webhook' do
+    result = @mg_obj.delete("domains/#{@domain}/webhooks/bounce")
+
+    result.to_h!
+    expect(result.body['message']).to eq("Webhook has been deleted")
+    expect(result.body['webhook']['url']).to eq("http://example.com/mailgun/events/#{@testhookup}")
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'bundler'
+require 'bundler/setup'
+Bundler.setup(:development)
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+require 'mailgun'
+
+require 'vcr'
+require 'webmock/rspec'
+
+#WebMock.disable_net_connect!(allow_localhost: true)
+require_relative 'unit/connection/test_client'
+
+RSpec.configure do |c|
+  c.raise_errors_for_deprecations!
+end
+
+APIHOST = "api.mailgun.net"
+APIVERSION = "v3"
+SSL = true
+
+# For integration tests modify .ruby-env.yml
+# use .ruby-env.yml.example for an example
+# alternatively
+# set environment variables as named in .ruby-env.yml.example
+envfile = File.join(File.dirname(__FILE__), '..','.ruby-env.yml')
+envs = File.exist?(envfile) ? YAML.load_file(envfile) : ENV
+APIKEY = envs['MAILGUN_APIKEY']
+PUB_APIKEY = envs['MAILGUN_PUB_APIKEY']
+TESTDOMAIN = envs['MAILGUN_TESTDOMAIN']
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'vcr_cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.default_cassette_options = { record: :new_episodes }
+  c.filter_sensitive_data('<APIKEY>') { APIKEY }
+  c.filter_sensitive_data('DOMAIN.TEST') { TESTDOMAIN }
+  c.filter_sensitive_data('<PUBKEY>') { PUB_APIKEY }
+end

data/spec/unit/connection/test_client.rb

@@ -0,0 +1,99 @@
+require 'time'
+require 'json'
+
+module Mailgun
+  class UnitClient < Mailgun::Client
+
+    attr_reader :options, :block, :body, :code, :response
+
+    def initialize(endpoint, &block)
+      @block = block
+      @endpoint = endpoint
+      @body = nil
+      @code = nil
+    end
+
+    def [](endpoint, &new_block)
+      case
+      when block_given? then self.class.new(endpoint, &new_block)
+      when block        then self.class.new(endpoint, &block)
+      else
+        self.class.new(endpoint)
+      end
+    end
+
+    def send_message(working_domain, data)
+      case data
+      when Hash
+        if data.has_key?(:message)
+          if data[:message].is_a?(String)
+            data[:message] = convert_string_to_file(data[:message])
+          end
+          post("#{working_domain}/messages.mime", data)
+        else
+          post("#{working_domain}/messages", data)
+        end
+      when MessageBuilder
+        post("#{working_domain}/messages", data.message)
+      else
+        raise ParameterError.new("Unknown data type for data parameter.", data)
+      end
+    end
+
+    def post(path, data)
+      begin
+        Mailgun::Response.new(response_generator(@endpoint))
+      rescue => e
+        p e
+        raise CommunicationError.new(e), e.response
+      end
+    end
+
+    def get(path, query_string = nil)
+      begin
+        Mailgun::Response.new(response_generator(@endpoint))
+      rescue => e
+        raise CommunicationError.new(e), e.response
+      end
+    end
+
+    def put(path, data)
+      begin
+        Mailgun::Response.new(response_generator(@endpoint))
+      rescue => e
+        raise CommunicationError.new(e), e.response
+      end
+    end
+
+    def delete(path)
+      begin
+        Mailgun::Response.new(response_generator(@endpoint))
+      rescue => e
+        raise CommunicationError.new(e), e.response
+      end
+    end
+
+    private
+
+    def response_generator(resource_endpoint)
+      if resource_endpoint == "messages"
+        t = Time.now
+        id = "<#{t.to_i}.#{rand(99999999)}.5817@example.com>"
+        return OpenStruct.new({ "body" => JSON.generate({"message" => "Queued. Thank you.", "id" => id}) })
+      end
+      if resource_endpoint == "bounces"
+        return OpenStruct.new({ "body" => JSON.generate({"total_count" => 1, "items" => {"created_at" => "Fri, 21 Oct 2011 11:02:55 GMT", "code" => 550, "address" => "baz@example.com", "error" => "Message was not accepted -- invalid mailbox. Local mailbox baz@example.com is unavailable: user not found"}}) })
+      end
+      if resource_endpoint == "lists"
+        return OpenStruct.new({ "body" => JSON.generate({"member" => {"vars" => {"age" => 26}, "name" => "Foo Bar", "subscribed" => false, "address" => "bar@example.com"}, "message" => "Mailing list member has been updated"}) })
+      end
+      if resource_endpoint == "campaigns"
+        return OpenStruct.new({ "body" => JSON.generate({"message" => "Campaign has been deleted", "id" => "ABC123"}) })
+      end
+      if resource_endpoint == "events"
+        return OpenStruct.new({ "body" => JSON.generate({"items" => [], "paging" => {"next"=> "https://api.mailgun.net/v3/thisisatestdomainformailgun.com/events/W3siYiI6ICIyMDE0LTA1LTA3VDAwOjQ1OjUxLjc0MDg5MiswMDowMCIsICJlIjogIjIwMTQtMDUtMDVUMDA6NDU6NTEuNzQwOTgzKzAwOjAwIn0sIHsiYiI6ICIyMDE0LTA1LTA3VDAwOjQ1OjUxLjc0MDg5MiswMDowMCIsICJlIjogIjIwMTQtMDUtMDVUMDA6NDU6NTEuNzQwOTgzKzAwOjAwIn0sIFsiZiJdLCBudWxsLCB7ImFjY291bnQuaWQiOiAiNGU4MjMwZjYxNDc2ZDg2NzEzMDBjNDc2IiwgImRvbWFpbi5uYW1lIjogInRoaXNpc2F0ZXN0ZG9tYWluZm9ybWFpbGd1bi5jb20iLCAic2V2ZXJpdHkiOiAiTk9UIGludGVybmFsIn0sIDEwMCwgbnVsbF0=", "previous"=> "https://api.mailgun.net/v2/thisisatestdomainformailgun.com/events/W3siYiI6ICIyMDE0LTA1LTA3VDAwOjQ1OjUxLjc0MDg5MiswMDowMCIsICJlIjogIjIwMTQtMDUtMDVUMDA6NDU6NTEuNzQwOTgzKzAwOjAwIn0sIHsiYiI6ICIyMDE0LTA1LTA3VDAwOjQ1OjUxLjc0MDg5MiswMDowMCIsICJlIjogIjIwMTQtMDUtMDdUMDA6NDU6NTEuNzQxODkyKzAwOjAwIn0sIFsicCIsICJmIl0sIG51bGwsIHsiYWNjb3VudC5pZCI6ICI0ZTgyMzBmNjE0NzZkODY3MTMwMGM0NzYiLCAiZG9tYWluLm5hbWUiOiAidGhpc2lzYXRlc3Rkb21haW5mb3JtYWlsZ3VuLmNvbSIsICJzZXZlcml0eSI6ICJOT1QgaW50ZXJuYWwifSwgMTAwLCBudWxsXQ=="}}) })
+      end
+    end
+  end
+
+end

data/spec/unit/events/events_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe 'The method get' do
+  it 'should return a proper hash of log data.' do
+    @mg_obj = Mailgun::UnitClient.new('events')
+    events = Mailgun::Events.new(@mg_obj, "samples.mailgun.org")
+    result = events.get()
+
+    expect(result.body).to include("items")
+    expect(result.body).to include("paging")
+  end
+end
+
+
+describe 'The method next' do
+  it 'should return the next series of data.' do
+    @mg_obj = Mailgun::UnitClient.new('events')
+    events = Mailgun::Events.new(@mg_obj, "samples.mailgun.org")
+    result = events.next()
+
+    expect(result.body).to include("items")
+    expect(result.body).to include("paging")
+  end
+end
+
+describe 'The method previous' do
+  it 'should return the previous series of data.' do
+    @mg_obj = Mailgun::UnitClient.new('events')
+    events = Mailgun::Events.new(@mg_obj, "samples.mailgun.org")
+    result = events.previous()
+
+    expect(result.body).to include("items")
+    expect(result.body).to include("paging")
+  end
+end
+
+describe 'The method each' do
+  it 'should iterate over all event items.' do
+    @mg_obj = Mailgun::UnitClient.new('events')
+    events = Mailgun::Events.new(@mg_obj, "samples.mailgun.org")
+    # Events from the UnitClient are actually empty.
+    count = 0
+    events.each do |e|
+      count = count + 1
+    end
+
+    # Better than nothing..
+    expect(count).to eq(0)
+  end
+end

data/spec/unit/lists/opt_in_handler_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe 'The method generate_hash' do
+  before(:each) do
+    @mailing_list = "mylist@example.com"
+    @secret_app_id = "mysupersecretpassword"
+    @recipient_address = "bob@example.com"
+    @precalculated_hash = "eyJoIjoiMmY3ZmY1MzFlOGJmMjA0OWNhMTI3ZmU4ZTQyNjZkOTljYzhkMTdk%0AMiIsInAiOiJleUpzSWpvaWJYbHNhWE4wUUdWNFlXMXdiR1V1WTI5dElpd2lj%0AaUk2SW1KdllrQmxlR0Z0Y0d4bExtTnZcbmJTSjlcbiJ9%0A"
+  end
+
+  it 'generates a web safe hash for the recipient wishing to subscribe' do
+    my_hash = Mailgun::OptInHandler.generate_hash(@mailing_list, @secret_app_id, @recipient_address)
+    
+    expect(my_hash).to eq(@precalculated_hash)
+  end
+
+  it 'generates a web safe hash for the recipient wishing to subscribe' do
+    validate_result = Mailgun::OptInHandler.validate_hash(@secret_app_id, @precalculated_hash)
+    
+    expect(validate_result.length).to eq(2)
+    expect(validate_result['recipient_address']).to eq(@recipient_address)
+    expect(validate_result['mailing_list']).to eq(@mailing_list)
+  end
+end