wj-mailgun-ruby 1.1.7

data/spec/integration/domains_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "domains" }
+
+describe 'For the domains endpoint', vcr: vcr_opts do
+  before(:all) do
+    @mg_client = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @mg_obj = Mailgun::Domains.new(@mg_client)
+    @domain = "integration-test.domain.invalid"
+  end
+
+  it 'creates the domain' do
+    result = @mg_obj.add_domain(@domain, { smtp_password: 'super_secret', spam_action: 'tag' })
+
+    expect(result['domain']["name"]).to eq(@domain)
+    expect(result['domain']["spam_action"]).to eq("tag")
+    expect(result['domain']["smtp_password"]).to eq("super_secret")
+  end
+
+  it 'get the domain.' do
+    result = @mg_obj.get(@domain)
+
+    expect(result).to include("domain")
+    expect(result["domain"]["name"]).to eq(@domain)
+  end
+
+  it 'gets a list of domains.' do
+    result = @mg_obj.get_domains
+
+    expect(result.size).to be > 0
+  end
+
+  it 'deletes a domain.' do
+    result = @mg_obj.delete(@domain)
+
+    expect(result).to be_truthy
+  end
+end

data/spec/integration/email_validation_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+require 'mailgun'
+require 'mailgun/address'
+
+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(PUB_APIKEY)
+
+    @valid = ["Alice <alice@example.com>", "bob@example.com"]
+    @invalid = ["example.org"]
+
+    @all_addrs = @valid + @invalid
+  end
+
+  it 'returns parsed and unparsable lists' do
+    res = @mg_obj.parse(@all_addrs)
+
+    expect(res["parsed"]).to eq(@valid)
+    expect(res["unparseable"]).to eq(@invalid)
+  end
+
+  it 'validates alice@mailgun.net with info' do
+    res = @mg_obj.validate("alice@mailgun.net")
+
+    expected = {
+        "address" => "alice@mailgun.net",
+        "did_you_mean" => nil,
+        "is_valid" => true,
+        "parts" => {
+            "display_name" => nil,
+            "domain" => "mailgun.net",
+            "local_part" => "alice",
+        },
+    }
+    expect(res).to eq(expected)
+  end
+
+  it 'fails to validate example.org' do
+    res = @mg_obj.validate("example.org")
+
+    expected = {
+        "address" => "example.org",
+        "did_you_mean" => nil,
+        "is_valid" => false,
+        "parts" => {
+            "display_name" => nil,
+            "domain" => nil,
+            "local_part" => nil,
+        },
+    }
+    expect(res).to eq(expected)
+  end
+
+end

data/spec/integration/events_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'mailgun'
+require 'mailgun/events/events'
+
+vcr_opts = { :cassette_name => "events" }
+
+describe 'For the Events endpoint', vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+    @events = Mailgun::Events.new(@mg_obj, @domain)
+  end
+
+  it 'can get an event.' do
+    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")
+  end
+
+  it 'can iterate over all events with `each`' do
+    @events.each do |e|
+      expect(e.id).to eq("JAx9z641TuGGUyaJlD9sCQ")
+    end
+  end
+end

data/spec/integration/list_members_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "list_members" }
+
+describe 'For the Mailing Lists Members endpoint', order: :defined, vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+    @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.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')
+  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'})
+
+    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')
+  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')
+  end
+
+  it 'updates a list member.' do
+    result = @mg_obj.put("lists/#{@ml_address}/members/#{@ml_member}",
+                         {: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)
+  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

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "mailing_list" }
+
+describe 'For the Mailing Lists endpoint', vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+    @ml_address = "integration_test_list@#{@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.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')
+  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')
+  end
+
+  it 'gets a list of all lists.' do
+    result = @mg_obj.get("lists", {:limit => 50})
+
+    result.to_h!
+    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'})
+
+    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')
+  end
+
+  it 'deletes a list' do
+    @mg_obj.delete("lists/#{@ml_address}")
+  end
+
+end

data/spec/integration/mailgun_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+require 'mailgun'
+require 'mailgun/exceptions/exceptions'
+
+vcr_opts = { :cassette_name => "instance" }
+
+describe 'Mailgun instantiation', vcr: vcr_opts do
+  it 'instantiates an HttpClient object' do
+    expect {@mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)}.not_to raise_error
+  end
+end
+
+vcr_opts = { :cassette_name => "exceptions" }
+
+describe 'Client exceptions', vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+  end
+
+  it 'display useful error information' do
+    begin
+      @mg_obj.send_message("not-our-doma.in", {
+          :from => "sally@not-our-doma.in",
+          :to => "bob@#{@domain}",
+          :subject => 'Exception Integration Test',
+          :text => 'INTEGRATION TESTING'
+      })
+    rescue Mailgun::CommunicationError => err
+      expect(err.message).to eq('404 Not Found: Domain not found: not-our-doma.in')
+    else
+      fail
+    end
+  end
+end
+
+vcr_opts = { :cassette_name => "send_message" }
+
+describe 'The method send_message()', vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+  end
+
+  it 'sends a standard message in test mode.' do
+    result = @mg_obj.send_message(@domain, {:from => "bob@#{@domain}",
+                                    :to => "sally@#{@domain}",
+                                    :subject => 'Hash Integration Test',
+                                    :text => 'INTEGRATION TESTING',
+                                    'o:testmode' => true}
+                                  )
+    result.to_h!
+    expect(result.body).to include("message")
+    expect(result.body).to include("id")
+  end
+
+  it 'fakes message send while in *client* test mode' do
+    @mg_obj.enable_test_mode!
+
+    expect(@mg_obj.test_mode?).to eq(true)
+
+    data = { :from => "joe@#{@domain}",
+             :to => "bob@#{@domain}",
+             :subject => "Test",
+             :text => "Test Data" }
+
+    result = @mg_obj.send_message(@domain, data)
+
+    result.to_h!
+
+    expect(result.body).to include("message")
+    expect(result.body).to include("id")
+
+    expect(result.code).to eq(200)
+    expect(result.body['id']).to eq("test-mode-mail@localhost")
+    expect(result.body['message']).to eq("Queued. Thank you.")
+  end
+
+  it 'sends a message builder message in test mode.' do
+    mb_obj = Mailgun::MessageBuilder.new()
+    mb_obj.from("sender@#{@domain}", {'first' => 'Sending', 'last' => 'User'})
+    mb_obj.add_recipient(:to, "recipient@#{@domain}", {'first' => 'Recipient', 'last' => 'User'})
+    mb_obj.subject("Message Builder Integration Test")
+    mb_obj.body_text("This is the text body.")
+    mb_obj.test_mode(true)
+
+    result = @mg_obj.send_message(@domain, mb_obj)
+
+    result.to_h!
+    expect(result.body).to include("message")
+    expect(result.body).to include("id")
+  end
+
+  it 'sends a custom MIME message in test mode.' do
+    mime_string = 'Delivered-To: mgbox01@gmail.com
+Received: by luna.mailgun.net with HTTP; Tue, 26 Nov 2013 17:59:11 +0000
+Mime-Version: 1.0
+Content-Type: text/plain; charset="ascii"
+Subject: Hello
+From: Excited User <me@samples.mailgun.org>
+To: sally@example.com
+Message-Id: <20131126175911.25310.92289@samples.mailgun.org>
+Content-Transfer-Encoding: 7bit
+X-Mailgun-Sid: WyI2NTU4MSIsICJtZ2JveDAxQGdtYWlsLmNvbSIsICIxZmYiXQ==
+Date: Tue, 26 Nov 2013 17:59:22 +0000
+X-Mailgun-Drop-Message: yes
+Sender: me@samples.mailgun.org
+
+Testing some Mailgun awesomness!'
+
+    message_params = {:to => "sally@#{@domain}",
+                      :message => mime_string}
+
+    result = @mg_obj.send_message(@domain, message_params)
+
+    result.to_h!
+    expect(result.body).to include("message")
+    expect(result.body).to include("id")
+  end
+end
+

data/spec/integration/messages/sample_data/mime.txt

@@ -0,0 +1,38 @@
+X-SBRS: 5.6
+X-SenderGroup: WHITELIST
+X-MailFlowPolicy: $TRUSTED
+DKIM-Signature: a=rsa-sha256; v=1; c=relaxed/relaxed; d=trstx.com; q=dns/txt; s=mx;
+ t=1381182797; h=Mime-Version: Content-Type: Subject: From: To:
+ Message-Id: Date: Sender: Content-Transfer-Encoding;
+ bh=r6P1omjKL3m7gDuZC6dZEJU6trgWm1IRwAJb8h4wtfg=; b=UPFaFGiuDx2yZjCmiMEji0fIXvGMNwXUsuaX4Ss9p5EUkqE25eYjeJaJZ5w5FK+t0jsUPZqu
+ FIH6sftQv7GBEbSktY6sv7dgv5q2yVlY8YNG7CXvUZdWmvwfQVvfL9j1RHJo9H3QpXT9c8bZ
+ p9rpYmqZtZEz2ZesPj4kzUaB0lU=
+DomainKey-Signature: a=rsa-sha1; c=nofws; d=trstx.com; s=mx; q=dns;
+ h=Mime-Version: Content-Type: Subject: From: To: Message-Id: Date:
+ Sender: Content-Transfer-Encoding;
+ b=QUYQf9OP16DphNAjeF95+G7V6DaqL4FA+m1sjIEWHdLzrGTQkiYTpzJdne3lzSypB0DwaG
+ AT9zOhjjN64DWFOkJD2Ce5t6vfHa/GC3FCUMq3xz/Big94g+kOciawkHyUhCrmPyh/D7kWx1
+ J75UIAdmE9XQ9bCSPhZ2MRaOv7b8c=
+Received: by luna.mailgun.net with HTTP; Mon, 07 Oct 2013 21:53:16 +0000
+Content-Type: text/plain; charset="ascii"
+Subject: Test Subject
+From: <joe@example.com>
+To: <bob@sample.com>
+Message-ID: <20131007215316.27052.7818@example.com>
+X-Mailgun-Sid: WyI4MzY1OSIsICJ0cmF2aXMuc3dpZW50ZWtAcmFja3NwYWasdfewNvbSIsICJjZjQ4Il0=
+Date: Mon, 7 Oct 2013 21:53:17 +0000
+Sender: <joe@example.com>
+Content-Transfer-Encoding: 7bit
+MIME-Version: 1.0
+
+--3a8c26e9f23c4ac193606295aa17fa6f
+Content-Type: text/plain; charset="ascii"
+Content-Transfer-Encoding: 7bit
+
+Testing some Mailgun awesomness!
+--3a8c26e9f23c4ac193606295aa17fa6f
+Content-Type: text/html; charset="ascii"
+Content-Transfer-Encoding: 7bit
+
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">Test
+--3a8c26e9f23c4ac193606295aa17fa6f--

data/spec/integration/routes_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "routes" }
+
+describe 'For the Routes endpoint', order: :defined, vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+    @forward_to = "alice@#{@domain}"
+    @recipient = ".*@#{@domain}"
+  end
+
+  it 'creates a route' do
+    result = @mg_obj.post("routes",  { priority: 10,
+                                       description: 'Integration Test Route',
+                                       expression: "match_recipient(\"#{@forward_to}\")",
+                                       action: "forward(\"#{@recipient}\")" })
+
+    result.to_h!
+    expect(result.body["message"]).to eq("Route has been created")
+    expect(result.body["route"]["description"]).to eq("Integration Test Route")
+    expect(result.body["route"]["actions"]).to include("forward(\"#{@recipient}\")")
+    expect(result.body["route"]["expression"]).to include("match_recipient(\"#{@forward_to}\")")
+    expect(result.body["route"]["priority"]).to eq(10)
+  end
+
+  it 'gets a list of all routes.' do
+    result = @mg_obj.get("routes", {:limit => 50})
+
+    result.to_h!
+    expect(result.body["total_count"]).to be > 0
+  end
+
+  it 'gets the route.' do
+    result = @mg_obj.get("routes", {:limit => 1})
+    route_id = result.to_h['items'].first['id']
+
+    result = @mg_obj.get("routes/#{route_id}")
+
+    result.to_h!
+    expect(result.body["route"]["description"]).to eq("Integration Test Route")
+    expect(result.body["route"]["actions"]).to include("forward(\"#{@recipient}\")")
+    expect(result.body["route"]["expression"]).to include("match_recipient(\"#{@forward_to}\")")
+    expect(result.body["route"]["priority"]).to eq(10)
+  end
+
+  it 'updates the route.' do
+    result = @mg_obj.get("routes", {:limit => 1})
+    route_id = result.to_h['items'].first['id']
+
+    result = @mg_obj.put("routes/#{route_id}",  {:priority => 10,
+                                                  :description => 'Integration Test Route Update',
+                                                  :expression => "match_recipient(\"#{@forward_to}\")",
+                                                  :action => "forward(\"#{@recipient}\")"})
+
+    result.to_h!
+    expect(result.body["message"]).to eq("Route has been updated")
+    expect(result.body["description"]).to eq("Integration Test Route Update")
+    expect(result.body["actions"]).to include("forward(\"#{@recipient}\")")
+    expect(result.body["expression"]).to include("match_recipient(\"#{@forward_to}\")")
+    expect(result.body["priority"]).to eq(10)
+  end
+
+  it 'removes a route' do
+    result = @mg_obj.get("routes", {:limit => 1})
+    route_id = result.to_h['items'].first['id']
+
+    @mg_obj.delete("routes/#{route_id}")
+
+    result.to_h!
+  end
+
+end