mailgun 0.8 → 0.11

data/spec/base_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe Mailgun::Base do
 
   it "should raise an error if the api_key has not been set" do
+    Mailgun.config { |c| c.api_key = nil }
     expect do
       Mailgun()
     end.to raise_error ArgumentError
@@ -24,7 +25,7 @@ describe Mailgun::Base do
   describe "Mailgun.new" do
     it "Mailgun() method should return a new Mailgun object" do
       mailgun = Mailgun({:api_key => "some-junk-string"})
-      mailgun.should be_kind_of(Mailgun::Base)
+      expect(mailgun).to be_kind_of(Mailgun::Base)
     end
   end
 
@@ -34,16 +35,14 @@ describe Mailgun::Base do
     end
 
     it "Mailgun#mailboxes should return an instance of Mailgun::Mailbox" do
-      @mailgun.mailboxes.should be_kind_of(Mailgun::Mailbox)
+      expect(@mailgun.mailboxes).to be_kind_of(Mailgun::Mailbox)
     end
 
     it "Mailgun#routes should return an instance of Mailgun::Route" do
-      @mailgun.routes.should be_kind_of(Mailgun::Route)
+      expect(@mailgun.routes).to be_kind_of(Mailgun::Route)
     end
   end
 
-
-  
   describe "internal helper methods" do
     before :each do
       @mailgun = Mailgun({:api_key => "some-junk-string"})
@@ -51,39 +50,44 @@ describe Mailgun::Base do
 
     describe "Mailgun#base_url" do
       it "should return https url if use_https is true" do
-      @mailgun.base_url.should == "https://api:#{Mailgun.api_key}@#{Mailgun.mailgun_host}/#{Mailgun.api_version}"
+      expect(@mailgun.base_url).to eq "https://api:#{Mailgun.api_key}@#{Mailgun.mailgun_host}/#{Mailgun.api_version}"
       end
     end
 
     describe "Mailgun.submit" do
-      it "should send method and arguments to RestClient" do
-        RestClient.should_receive(:test_method)
-          .with({:arg1=>"val1"},{})
-          .and_return({})
-        Mailgun.submit :test_method, :arg1=>"val1"
+      let(:client_double) { double(Mailgun::Client) }
+
+      it "should send method and arguments to Mailgun::Client" do
+        expect(Mailgun::Client).to receive(:new)
+          .with('/')
+          .and_return(client_double)
+        expect(client_double).to receive(:test_method)
+          .with({:arg1=>"val1"})
+          .and_return('{}')
+
+        Mailgun.submit :test_method, '/', :arg1=>"val1"
       end
     end
-    
   end
 
   describe "configuration" do
     describe "default settings" do
-      it "api_version is v2" do
-        Mailgun.api_version.should eql 'v2'
+      it "api_version is v3" do
+        expect(Mailgun.api_version).to eql 'v3'
       end
       it "should use https by default" do
-        Mailgun.protocol.should == "https"
+        expect(Mailgun.protocol).to eq "https"
       end
       it "mailgun_host is 'api.mailgun.net'" do
-        Mailgun.mailgun_host.should eql 'api.mailgun.net'
+        expect(Mailgun.mailgun_host).to eql 'api.mailgun.net'
       end
 
       it "test_mode is false" do
-        Mailgun.test_mode.should eql false
+        expect(Mailgun.test_mode).to eql false
       end
 
       it "domain is not set" do
-        Mailgun.domain.should be_nil
+        expect(Mailgun.domain).to be_nil
       end
     end
 
@@ -99,27 +103,29 @@ describe Mailgun::Base do
         end
       end
 
+      after(:each) { Mailgun.configure { |c| c.domain = nil } }
+
       it "allows me to set my API key easily" do
-        Mailgun.api_key.should eql 'some-api-key'
+        expect(Mailgun.api_key).to eql 'some-api-key'
       end
 
       it "allows me to set the api_version attribute" do
-        Mailgun.api_version.should eql 'v2'
+        expect(Mailgun.api_version).to eql 'v2'
       end
 
       it "allows me to set the protocol attribute" do
-        Mailgun.protocol.should eql 'https'
+        expect(Mailgun.protocol).to eql 'https'
       end
-      
+
       it "allows me to set the mailgun_host attribute" do
-        Mailgun.mailgun_host.should eql 'api.mailgun.net'
+        expect(Mailgun.mailgun_host).to eql 'api.mailgun.net'
       end
       it "allows me to set the test_mode attribute" do
-        Mailgun.test_mode.should eql false
+        expect(Mailgun.test_mode).to eql false
       end
 
       it "allows me to set my domain easily" do
-        Mailgun.domain.should eql 'some-domain'
+        expect(Mailgun.domain).to eql 'some-domain'
       end
     end
   end

data/spec/bounce_spec.rb

@@ -17,10 +17,10 @@ describe Mailgun::Bounce do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
       bounces_url = @mailgun.bounces(@sample[:domain]).send(:bounce_url)
 
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:get, bounces_url, {}).
         and_return(sample_response)
-    
+
       @mailgun.bounces(@sample[:domain]).list
     end
   end
@@ -30,7 +30,7 @@ describe Mailgun::Bounce do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
       bounces_url = @mailgun.bounces(@sample[:domain]).send(:bounce_url, @sample[:email])
 
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:get, bounces_url).
         and_return(sample_response)
 
@@ -43,7 +43,7 @@ describe Mailgun::Bounce do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
       bounces_url = @mailgun.bounces(@sample[:domain]).send(:bounce_url)
 
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:post, bounces_url, {:address => @sample[:email]} ).
         and_return(sample_response)
 
@@ -56,7 +56,7 @@ describe Mailgun::Bounce do
       sample_response = "{\"message\"=>\"Bounced address has been removed\", \"address\"=>\"postmaster@bsample.mailgun.org\"}"
       bounces_url = @mailgun.bounces(@sample[:domain]).send(:bounce_url, @sample[:email])
 
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:delete, bounces_url).
         and_return(sample_response)
 

data/spec/client_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+require 'webmock/rspec'
+
+describe Mailgun::Client do
+  subject { described_class.new(url) }
+
+  describe '#get' do
+    context 'without query params' do
+      let(:url) { 'https://api:key@api.mailgun.net/v3/routes' }
+
+      it 'sends a GET request to the given path' do
+        stub = stub_request(:get, 'https://api.mailgun.net/v3/routes')
+          .with(basic_auth: ['api', 'key'])
+
+        subject.get
+
+        expect(stub).to have_been_requested
+      end
+    end
+
+    context 'with query params' do
+      let(:url) { 'https://api:key@api.mailgun.net/v3/routes' }
+
+      it 'sends a GET request to the given path with the params' do
+        stub = stub_request(:get, 'https://api.mailgun.net/v3/routes?limit=10')
+          .with(basic_auth: ['api', 'key'])
+
+        subject.get(limit: 10)
+
+        expect(stub).to have_been_requested
+      end
+    end
+
+    context 'when an error happens' do
+      let(:url) { 'https://api:key@api.mailgun.net/v3/routes/123' }
+      let(:error_body) { { "message" => "Expression is missing" }.to_json }
+
+      before do
+        stub_request(:get, 'https://api.mailgun.net/v3/routes/123')
+          .with(basic_auth: ['api', 'key'])
+          .to_return(status: [400, "Bad Request"],
+                     body: error_body)
+      end
+
+      it 'raises exception that contains the error code and body' do
+        begin
+          subject.get
+        rescue => e
+          @exception = e
+        end
+
+        expect(@exception.http_code).to eq(400)
+        expect(@exception.http_body).to eq(error_body)
+      end
+    end
+  end
+
+  describe '#post' do
+    let(:url) { 'https://api:key@api.mailgun.net/v3/routes' }
+    let(:params) { { action: ['forward', 'stop'], description: 'yolo' } }
+    let(:response) do
+      {
+        "message" => "Route has been created",
+        "route" => {
+          "actions" => [
+            "forward(\"stefan@metrilo.com\")",
+            "stop()"
+          ],
+          "created_at" => "Wed, 15 Jun 2016 07:10:09 GMT",
+          "description" => "Sample route",
+          "expression" => "match_recipient(\".*@metrilo.com\")",
+          "id" => "5760ff5163badc3a756f9d2c",
+          "priority" => 5
+        }
+      }
+    end
+
+    before do
+      stub_request(:post, 'https://api.mailgun.net/v3/routes')
+        .with(basic_auth: ['api', 'key'],
+              body: 'action=forward&action=stop&description=yolo')
+        .to_return(body: response.to_json)
+    end
+
+    it 'sends a POST request with the params form-encoded' do
+      expect(subject.post(params)).to eq(response.to_json)
+    end
+  end
+
+  describe '#put' do
+    let(:url) { 'https://api:key@api.mailgun.net/v3/routes/123' }
+
+    it 'sends a PUT request with the params form-encoded' do
+      stub = stub_request(:put, 'https://api.mailgun.net/v3/routes/123')
+        .with(basic_auth: ['api', 'key'],
+              body: 'action=forward&action=stop&description=yolo')
+
+      subject.put(action: ['forward', 'stop'],
+                   description: 'yolo')
+
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#delete' do
+    let(:url) { 'https://api:key@api.mailgun.net/v3/routes/123' }
+
+    it 'sends a DELETE request with the params form-encoded' do
+      stub = stub_request(:delete, 'https://api.mailgun.net/v3/routes/123')
+        .with(basic_auth: ['api', 'key'])
+
+      subject.delete
+
+      expect(stub).to have_been_requested
+    end
+  end
+end

data/spec/complaint_spec.rb

@@ -29,7 +29,7 @@ EOF
 
       complaints_url = @mailgun.complaints(@sample[:domain]).send(:complaint_url)
 
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:get, complaints_url, {}).
         and_return(sample_response)
 
@@ -49,7 +49,7 @@ EOF
 
       complaints_url = @mailgun.complaints(@sample[:domain]).send(:complaint_url)
 
-      Mailgun.should_receive(:submit)
+      expect(Mailgun).to receive(:submit)
         .with(:post, complaints_url, {:address => @sample[:email]})
         .and_return(sample_response)
 
@@ -72,7 +72,7 @@ EOF
 
       complaints_url = @mailgun.complaints(@sample[:domain]).send(:complaint_url, @sample[:email])
 
-      Mailgun.should_receive(:submit)
+      expect(Mailgun).to receive(:submit)
         .with(:get, complaints_url)
         .and_return(sample_response)
 
@@ -92,7 +92,7 @@ EOF
 
       complaints_url = @mailgun.complaints(@sample[:domain]).send(:complaint_url, @sample[:email])
 
-      Mailgun.should_receive(:submit)
+      expect(Mailgun).to receive(:submit)
         .with(:delete, complaints_url)
         .and_return(sample_response)
 

data/spec/domain_spec.rb

@@ -18,10 +18,10 @@ describe Mailgun::Domain do
       sample_response = "{\"total_count\": 1, \"items\": [{\"created_at\": \"Tue, 12 Feb 2013 20:13:49 GMT\", \"smtp_login\": \"postmaster@sample.mailgun.org\", \"name\": \"sample.mailgun.org\", \"smtp_password\": \"67bw67bz7w\" }]}"
       domains_url = @mailgun.domains.send(:domain_url)
 
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:get, domains_url, {}).
         and_return(sample_response)
-    
+
       @mailgun.domains.list
     end
   end
@@ -31,7 +31,7 @@ describe Mailgun::Domain do
       sample_response = "{\"domain\": {\"created_at\": \"Tue, 12 Feb 2013 20:13:49 GMT\", \"smtp_login\": \"postmaster@bample.mailgun.org\", \"name\": \"sample.mailgun.org\", \"smtp_password\": \"67bw67bz7w\" }, \"receiving_dns_records\": [], \"sending_dns_records\": []}"
       domains_url = @mailgun.domains.send(:domain_url, @sample[:domain])
 
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:get, domains_url).
         and_return(sample_response)
 
@@ -44,7 +44,7 @@ describe Mailgun::Domain do
       sample_response = "{\"domain\": {\"created_at\": \"Tue, 12 Feb 2013 20:13:49 GMT\", \"smtp_login\": \"postmaster@sample.mailgun.org\",\"name\": \"sample.mailgun.org\",\"smtp_password\": \"67bw67bz7w\"}, \"message\": \"Domain has been created\"}"
       domains_url = @mailgun.domains.send(:domain_url)
 
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:post, domains_url, {:name => @sample[:domain]} ).
         and_return(sample_response)
 
@@ -57,7 +57,7 @@ describe Mailgun::Domain do
       sample_response = "{\"message\": \"Domain has been deleted\"}"
       domains_url = @mailgun.domains.send(:domain_url, @sample[:domain])
 
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:delete, domains_url).
         and_return(sample_response)
 
@@ -65,4 +65,16 @@ describe Mailgun::Domain do
     end
   end
 
+  describe 'verify domain' do
+    it 'should make a PUT request to verify with correct params' do
+      sample_response = "{\"domain\": {\"created_at\": \"Tue, 12 Feb 2013 20:13:49 GMT\", \"smtp_login\": \"postmaster@bample.mailgun.org\", \"name\": \"sample.mailgun.org\", \"smtp_password\": \"67bw67bz7w\", \"state\": \"active\"}, \"message\": \"Domain DNS records have been updated\", \"receiving_dns_records\": [], \"sending_dns_records\": []}"
+      verify_domain_url = "#{@mailgun.domains.send(:domain_url, @sample[:domain])}/verify"
+
+      expect(Mailgun).to receive(:submit)
+        .with(:put, verify_domain_url)
+        .and_return(sample_response)
+
+      @mailgun.domains.verify(@sample[:domain])
+    end
+  end
 end

data/spec/helpers/mailgun_helper.rb

@@ -0,0 +1,9 @@
+module MailgunHelper
+  def generate_request_auth(api_key, offset=0)
+    timestamp = Time.now.to_i + offset * 60
+    token = ([nil]*50).map { ((48..57).to_a+(65..90).to_a+(97..122).to_a).sample.chr }.join
+    signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), api_key, '%s%s' % [timestamp, token])
+
+    return timestamp, token, signature
+  end
+end

data/spec/list/member_spec.rb

@@ -18,10 +18,10 @@ describe Mailgun::MailingList::Member do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
       mailing_list_members_url = @mailgun.list_members(@sample[:list_email]).send(:list_member_url)
 
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:get, mailing_list_members_url, {}).
         and_return(sample_response)
-    
+
       @mailgun.list_members(@sample[:list_email]).list
     end
   end
@@ -30,8 +30,8 @@ describe Mailgun::MailingList::Member do
     it "should make a GET request with correct params to find given email address" do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
       mailing_list_members_url = @mailgun.list_members(@sample[:list_email]).send(:list_member_url, @sample[:email])
-      
-      Mailgun.should_receive(:submit).
+
+      expect(Mailgun).to receive(:submit).
         with(:get, mailing_list_members_url).
         and_return(sample_response)
 
@@ -44,7 +44,7 @@ describe Mailgun::MailingList::Member do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
       mailing_list_members_url = @mailgun.list_members(@sample[:list_email]).send(:list_member_url)
 
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:post, mailing_list_members_url, {
           :address => @sample[:email]
         }).
@@ -57,7 +57,7 @@ describe Mailgun::MailingList::Member do
   describe "update member in list" do
     it "should make a PUT request with correct params" do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:put, "#{@mailgun.list_members(@sample[:list_email]).send(:list_member_url, @sample[:email])}", {
           :address => @sample[:email]
         }).
@@ -71,7 +71,7 @@ describe Mailgun::MailingList::Member do
     it "should make a DELETE request with correct params" do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
       mailing_list_members_url = @mailgun.list_members(@sample[:list_email]).send(:list_member_url, @sample[:email])
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:delete, mailing_list_members_url).
         and_return(sample_response)
 

data/spec/list/message_spec.rb

@@ -16,7 +16,7 @@ describe Mailgun::Log do
     it "should make a POST request to send an email" do
 
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
-      Mailgun.should_receive(:submit)
+      expect(Mailgun).to receive(:submit)
       .with(:get, "#{@mailgun.lists.send(:list_url, @sample[:list_email])}")
       .and_return(sample_response)
 
@@ -29,7 +29,7 @@ describe Mailgun::Log do
         :text => "yeah, we're gonna need you to come in on friday...yeah.",
         :from => "lumberg.bill@initech.mailgun.domain"
       }
-      Mailgun.should_receive(:submit)                            \
+      expect(Mailgun).to receive(:submit)                            \
         .with(:post, @mailgun.messages.messages_url, parameters) \
         .and_return(sample_response)
 
@@ -37,4 +37,4 @@ describe Mailgun::Log do
     end
   end
 
-end
+end