mailgun 0.0.3 → 0.5

data/lib/mailgun/unsubscribe.rb

@@ -0,0 +1,38 @@
+module Mailgun
+  class Unsubscribe
+    # Used internally, called from Mailgun::Base
+    def initialize(mailgun)
+      @mailgun = mailgun
+    end
+    
+    # List all unsubscribes for a given domain
+    # * domain the domain for which all unsubscribes will listed
+    def list(domain = Mailgun.domain)
+      response = Mailgun.submit :get, unsubscribe_url(domain)
+
+      if response
+        response["items"].collect {|item| item["address"]}
+      end
+    end
+
+    def find(domain = Mailgun.domain, email)
+      Mailgun.submit :get, unsubscribe_url(domain, email)
+    end
+
+    def add(email, domain=Mailgun.domain, tag='*')
+      Mailgun.submit :post, unsubscribe_url(domain), {:address => email, :tag => tag}
+    end
+
+    def remove(domain = Mailgun.domain, email)
+      Mailgun.submit :delete, unsubscribe_url(domain, email)
+    end
+    
+    private
+
+    # Helper method to generate the proper url for Mailgun unsubscribe API calls
+    def unsubscribe_url(domain, address=nil)
+      "#{@mailgun.base_url}/#{domain}/unsubscribes#{'/' + address if address}"
+    end
+    
+  end
+end

data/lib/mailgun.rb

@@ -1,9 +1,21 @@
 require "rest-client"
 require "json"
+require "multimap"
 
-require 'mailgun/base'
-require 'mailgun/mailbox'
+require "mailgun/mailgun_error"
+require "mailgun/base"
+require "mailgun/route"
+require "mailgun/mailbox"
+require "mailgun/bounce"
+require "mailgun/unsubscribe"
+require "mailgun/complaint"
+require "mailgun/log"
+require "mailgun/list"
+require "mailgun/list/member"
 
-def Mailgun(options)
+#require "startup"
+
+def Mailgun(options={})
+  options[:api_key] = Mailgun.api_key if Mailgun.api_key
   Mailgun::Base.new(options)
 end

data/mailgun.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Akash Manohar J", "Sean Grove"]
-  gem.email         = ["akash@akash.im", "s@bushi.do", "sean@fakecoolguys.com"]
+  gem.email         = ["akash@akash.im"]
   gem.description   = %q{Mailgun library for Ruby}
   gem.summary       = %q{Idiomatic library for using the mailgun API from within ruby}
   gem.homepage      = "http://github.com/Bushido/mailgun"
@@ -12,5 +12,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "mailgun"
   gem.require_paths = ["lib"]
-  gem.version       = "0.0.3"
+  gem.version       = "0.5"
+  
+  gem.add_dependency(%q<rest-client>, [">= 0"])
+  gem.add_dependency(%q<multimap>, [">= 0"])
 end

data/spec/base_spec.rb

@@ -2,31 +2,125 @@ require 'spec_helper'
 
 describe Mailgun::Base do
 
-	before :each do
-		@mailgun = Mailgun({:api_key => "some-junk-string"})		# used to get the default values
-
-		@sample_options = {
-			:api_key 		 	=> @mailgun.api_key,
-			:api_version 	=> @mailgun.api_version,
-			:protocol 		=> @mailgun.protocol,
-			:mailgun_host => @mailgun.mailgun_host
-		}
+  it "should raise an error if the api_key has not been set" do
+    expect do
+      Mailgun()
+    end.to raise_error ArgumentError
   end
 
-  describe "new" do
+  it "can be called directly if the api_key has been set via Mailgun.configure" do
+    Mailgun.config { |c| c.api_key = "some-junk-string" }
+    expect do
+      Mailgun()
+    end.to_not raise_error ArgumentError
+  end
+
+  it "can be instanced with the api_key as a param" do
+    expect do
+      Mailgun({:api_key => "some-junk-string"})
+    end.to_not raise_error ArgumentError
+  end
+
+  describe "Mailgun.new" do
     it "Mailgun() method should return a new Mailgun object" do
-      @mailgun.should be_kind_of(Mailgun::Base)
+      mailgun = Mailgun({:api_key => "some-junk-string"})
+      mailgun.should be_kind_of(Mailgun::Base)
+    end
+  end
+
+  describe "resources" do
+    before :each do
+      @mailgun = Mailgun({:api_key => "some-junk-string"})
     end
 
-    it "should use https by default" do
-      @mailgun.protocol.should == "https"
+    it "Mailgun#mailboxes should return an instance of Mailgun::Mailbox" do
+      @mailgun.mailboxes.should 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)
     end
   end
 
-	describe "base_url" do
-		it "should return https url if use_https is true" do
-			mailgun = Mailgun(@sample_options)
-			mailgun.send(:base_url).should == "https://api:#{mailgun.api_key}@#{mailgun.mailgun_host}/#{mailgun.api_version}"
-		end
-	end
+
+  
+  describe "internal helper methods" do
+    before :each do
+      @mailgun = Mailgun({:api_key => "some-junk-string"})
+    end
+
+    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}"
+      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"
+      end
+    end
+    
+  end
+
+  describe "configuration" do
+    describe "default settings" do
+      it "api_version is v2" do
+        Mailgun.api_version.should eql 'v2'
+      end
+      it "should use https by default" do
+        Mailgun.protocol.should == "https"
+      end
+      it "mailgun_host is 'api.mailgun.net'" do
+        Mailgun.mailgun_host.should eql 'api.mailgun.net'
+      end
+
+      it "test_mode is false" do
+        Mailgun.test_mode.should eql false
+      end
+
+      it "domain is not set" do
+        Mailgun.domain.should be_nil
+      end
+    end
+
+    describe "setting configurations" do
+      before(:each) do
+        Mailgun.configure do |c|
+          c.api_key = 'some-api-key'
+          c.api_version = 'v2'
+          c.protocol = 'https'
+          c.mailgun_host = 'api.mailgun.net'
+          c.test_mode = false
+          c.domain = 'some-domain'
+        end
+      end
+
+      it "allows me to set my API key easily" do
+        Mailgun.api_key.should eql 'some-api-key'
+      end
+
+      it "allows me to set the api_version attribute" do
+        Mailgun.api_version.should eql 'v2'
+      end
+
+      it "allows me to set the protocol attribute" do
+        Mailgun.protocol.should eql 'https'
+      end
+      
+      it "allows me to set the mailgun_host attribute" do
+        Mailgun.mailgun_host.should eql 'api.mailgun.net'
+      end
+      it "allows me to set the test_mode attribute" do
+        Mailgun.test_mode.should eql false
+      end
+
+      it "allows me to set my domain easily" do
+        Mailgun.domain.should eql 'some-domain'
+      end
+    end
+  end
 end

data/spec/bounce_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Mailgun::Bounce do
+
+  before :each do
+    @mailgun = Mailgun({:api_key => "api-key"})		# used to get the default values
+
+    @bounce_options = {
+      :email  => "test@sample.mailgun.org",
+      :name   => "test",
+      :domain => "sample.mailgun.org"
+    }
+  end
+
+  describe "list bounces" do
+    it "should make a GET request with the right params" do
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
+      RestClient.should_receive(:get).with("#{@mailgun.bounces.send(:bounce_url, @bounce_options[:domain])}", {}).and_return(sample_response)
+    
+      @mailgun.bounces.list @bounce_options[:domain]
+    end
+  end
+
+  describe "find bounces" 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\" }  ]}"
+      RestClient.should_receive(:get)
+      .with("#{@mailgun.bounces.send(:bounce_url, @bounce_options[:domain], @bounce_options[:email])}", {})
+      .and_return(sample_response)
+
+      @mailgun.bounces.find(@bounce_options[:domain], @bounce_options[:email])
+    end
+  end
+
+  describe "add bounces" do
+    it "should make a POST request with correct params to add a given email address" do
+      #sample_response = "{\"message\"=>\"Address has been added to the bounces table\", \"address\"=>\"#{@bounce_options[:email]}\"}"
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
+      RestClient.should_receive(:post)
+      .with("#{@mailgun.bounces.send(:bounce_url, @bounce_options[:domain])}", {:address => @bounce_options[:email]})
+      .and_return(sample_response)
+
+      @mailgun.bounces.add(@bounce_options[:domain], @bounce_options[:email])
+    end
+  end
+
+end

data/spec/complaint_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Mailgun::Complaint do
+
+  before :each do
+    @mailgun = Mailgun({:api_key => "api-key"})		# used to get the default values
+
+    @complaint_options = {
+      :email  => "test@sample.mailgun.org",
+      :name   => "test",
+      :domain => "sample.mailgun.org"
+    }
+  end
+
+  describe "list complaints" do
+    it "should make a GET request with the right params" do
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
+      RestClient.should_receive(:get).with("#{@mailgun.complaints.send(:complaint_url, @complaint_options[:domain])}", {}).and_return(sample_response)
+
+      @mailgun.complaints.list @complaint_options[:domain]
+    end
+  end
+
+  describe "find complaint" do
+    it "should make a GET request with the right params to find given email address" do
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
+      RestClient.should_receive(:get)
+      .with("#{@mailgun.complaints.send(:complaint_url, @complaint_options[:domain], @complaint_options[:email])}", {})
+      .and_return(sample_response)
+
+      @mailgun.complaints.find(@complaint_options[:domain], @complaint_options[:email])
+    end
+  end
+
+  describe "delete complaint" do
+    it "should make a DELETE request with correct params to remove a given email address" do
+      response_message = "{\"message\"=>\"Complaint event has been removed\", \"address\"=>\"#{@complaint_options[:email]}\"}"
+      Mailgun.should_receive(:submit)
+      .with(:delete, "#{@mailgun.complaints.send(:complaint_url, @complaint_options[:domain], @complaint_options[:email])}")
+      .and_return(response_message)
+
+      @mailgun.complaints.remove(@complaint_options[:domain], @complaint_options[:email])
+    end
+  end
+
+  describe "add complaint" do
+    it "should make a POST request with correct params to add a given email address to complaint from a tag" do
+      response_message = "{\"message\"=>\"Address has been added to the complaints table\", \"address\"=>\"#{@complaint_options[:email]}\"}"
+      Mailgun.should_receive(:submit)
+      .with(:post, "#{@mailgun.complaints.send(:complaint_url, @complaint_options[:domain])}",{:address=>@complaint_options[:email]})
+      .and_return(response_message)
+      @mailgun.complaints.add(@complaint_options[:domain],@complaint_options[:email])
+    end
+  end
+
+end

data/spec/list/member_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Mailgun::List::Member do
+
+  before :each do
+    @mailgun = Mailgun({:api_key => "api-key"})		# used to get the default values
+
+    @list_member_options = {
+      :email      => "test@sample.mailgun.org",
+      :list_email => "test_list@sample.mailgun.org",
+      :name       => "test",
+      :domain     => "sample.mailgun.org"
+    }
+  end
+
+  describe "list members" do
+    it "should make a GET request with the right params" do
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
+      RestClient.should_receive(:get).with("#{@mailgun.list_members.send(:list_member_url, @list_member_options[:list_email])}", {}).and_return(sample_response)
+    
+      @mailgun.list_members.list @list_member_options[:list_email]
+    end
+  end
+
+  describe "find member in list" 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\" }  ]}"
+      RestClient.should_receive(:get)
+      .with("#{@mailgun.list_members.send(:list_member_url, @list_member_options[:list_email], @list_member_options[:email])}", {})
+      .and_return(sample_response)
+
+      @mailgun.list_members.find(@list_member_options[:list_email], @list_member_options[:email])
+    end
+  end
+
+  describe "add member to list" do
+    it "should make a POST request with correct params to add a given email address" do
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
+      RestClient.should_receive(:post)
+      .with("#{@mailgun.list_members.send(:list_member_url, @list_member_options[:list_email])}", {
+        :address => @list_member_options[:email], :subscribed => 'yes', :upsert => 'no'
+      }).and_return(sample_response)
+
+      @mailgun.list_members.add(@list_member_options[:list_email], @list_member_options[:email])
+    end
+  end
+
+  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\" }  ]}"
+      RestClient.should_receive(:put)
+      .with("#{@mailgun.list_members.send(:list_member_url, @list_member_options[:list_email], @list_member_options[:email])}", {
+        :address => @list_member_options[:email], :subscribed => 'yes'
+      }).and_return(sample_response)
+
+      @mailgun.list_members.update(@list_member_options[:list_email], @list_member_options[:email])
+    end
+  end
+
+  describe "delete member from list" do
+    it "should make a DELETE request with correct params" do
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
+      RestClient.should_receive(:delete)
+      .with("#{@mailgun.list_members.send(:list_member_url, @list_member_options[:list_email], @list_member_options[:email])}", {})
+      .and_return(sample_response)
+
+      @mailgun.list_members.remove(@list_member_options[:list_email], @list_member_options[:email])
+    end
+  end
+
+end

data/spec/list_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Mailgun::List do
+
+  before :each do
+    @mailgun = Mailgun({:api_key => "api-key"})		# used to get the default values
+
+    @list_options = {
+      :email      => "test@sample.mailgun.org",
+      :list_email => "dev@samples.mailgun.org",
+      :name       => "test",
+      :domain     => "sample.mailgun.org"
+    }
+  end
+
+  describe "all list" do
+    it "should make a GET request with the right params" do
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
+      RestClient.should_receive(:get)
+      .with("#{@mailgun.lists.send(:list_url)}", {}).and_return(sample_response)
+    
+      @mailgun.lists.all
+    end
+  end
+
+  describe "find list adress" 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\" }  ]}"
+      RestClient.should_receive(:get)
+      .with("#{@mailgun.lists.send(:list_url, @list_options[:list_email])}", {})
+      .and_return(sample_response)
+
+      @mailgun.lists.find(@list_options[:list_email])
+    end
+  end
+
+  describe "create list" do
+    it "should make a POST request with correct params to add a given email address" do
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
+      RestClient.should_receive(:post)
+      .with("#{@mailgun.lists.send(:list_url)}", {:address => @list_options[:list_email]})
+      .and_return(sample_response)
+
+      @mailgun.lists.create(@list_options[:list_email])
+    end
+  end
+
+  describe "update list" do
+    it "should make a PUT request with correct params" do
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
+      RestClient.should_receive(:put)
+      .with("#{@mailgun.lists.send(:list_url, @list_options[:list_email])}", {:address => @list_options[:email]})
+      .and_return(sample_response)
+
+      @mailgun.lists.update(@list_options[:list_email], @list_options[:email])
+    end
+  end
+
+  describe "delete list" do
+    it "should make a DELETE request with correct params" do
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
+      RestClient.should_receive(:delete)
+      .with("#{@mailgun.lists.send(:list_url, @list_options[:list_email])}", {})
+      .and_return(sample_response)
+
+      @mailgun.lists.delete(@list_options[:list_email])
+    end
+  end
+
+end

data/spec/log_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Mailgun::Log do
+
+  before :each do
+    @mailgun = Mailgun({:api_key => "api-key"})		# used to get the default values
+
+    @log_options = {
+      :email  => "test@sample.mailgun.org",
+      :name   => "test",
+      :domain => "sample.mailgun.org"
+    }
+  end
+
+  describe "list log" do
+    it "should make a GET request with the right params" do
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
+      RestClient.should_receive(:get).with("#{@mailgun.log.send(:log_url, @log_options[:domain])}", {:limit => 100, :skip => 0}).and_return(sample_response)
+
+      @mailgun.log.list @log_options[:domain]
+    end
+  end
+
+end

data/spec/mailbox_spec.rb

@@ -2,56 +2,56 @@ require 'spec_helper'
 
 describe Mailgun::Mailbox do
 
-	before :each do
-		@mailgun = Mailgun({:api_key => "api-key"})		# used to get the default values
+  before :each do
+    @mailgun = Mailgun({:api_key => "api-key"})		# used to get the default values
 
-		@mailbox_options = {
-      :email  => "test@sample.mailgun.com",
+    @mailbox_options = {
+      :email  => "test@sample.mailgun.org",
       :name   => "test",
-      :domain => "sample.mailgun.com"
+      :domain => "sample.mailgun.org"
     }
-	end
-
-	describe "list_mailboxes" do
-		it "should make a get request with the right params" do
-			RestClient.should_receive(:get)
-      .with("#{@mailgun.send(:base_url)}/#{@mailbox_options[:domain]}/mailboxes", {}).and_return("{}")
-
-			@mailgun.mailboxes.list @mailbox_options[:domain]
-		end
-	end
-
-	describe "create mailbox" do
-		it "should make a post request with the right params"	do
-			RestClient.should_receive(:post)
-								.with("#{@mailgun.send(:base_url)}/#{@mailbox_options[:domain]}/mailboxes",
-											:mailbox  => @mailbox_options[:email],
-											:password => @mailbox_options[:password])
-								.and_return({})
-
-			@mailgun.mailboxes.create(@mailbox_options[:email], @mailbox_options[:password])
-		end
-	end
-
-	describe "update mailbox password" do
-		it "should make a put request with the right params" do
-			RestClient.should_receive(:put)
-								.with("#{@mailgun.send(:base_url)}/#{@mailbox_options[:domain]}/mailboxes/#{@mailbox_options[:name]}",
-											:password => @mailbox_options[:password])
-								.and_return({})
-
-			@mailgun.mailboxes.update_password @mailbox_options[:email],
-                                         @mailbox_options[:password]
-		end
-	end
-
-  	describe "destroy mailbox" do
-		it "should make a put request with the right params" do
-			RestClient.should_receive(:delete)
-      .with("#{@mailgun.send(:base_url)}/#{@mailbox_options[:domain]}/mailboxes/#{@mailbox_options[:name]}", {})
-      .and_return({})
-
-			@mailgun.mailboxes.destroy @mailbox_options[:email]
-		end
-	end
+  end
+
+  describe "list mailboxes" do
+    it "should make a GET request with the right params" do
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
+      RestClient.should_receive(:get).with("#{@mailgun.mailboxes.send(:mailbox_url, @mailbox_options[:domain])}", {}).and_return(sample_response)
+
+      @mailgun.mailboxes.list @mailbox_options[:domain]
+    end
+  end
+
+  describe "create mailbox" do
+    it "should make a POST request with the right params"	do
+      RestClient.should_receive(:post)
+        .with("#{@mailgun.mailboxes.send(:mailbox_url, @mailbox_options[:domain])}",
+        :mailbox  => @mailbox_options[:email],
+        :password => @mailbox_options[:password])
+        .and_return({})
+
+      @mailgun.mailboxes.create(@mailbox_options[:email], @mailbox_options[:password])
+    end
+  end
+
+  describe "update mailbox" do
+    it "should make a PUT request with the right params" do
+      RestClient.should_receive(:put)
+        .with("#{@mailgun.mailboxes.send(:mailbox_url, @mailbox_options[:domain], @mailbox_options[:name])}",
+        :password => @mailbox_options[:password])
+        .and_return({})
+
+      @mailgun.mailboxes.update_password @mailbox_options[:email],
+      @mailbox_options[:password]
+    end
+  end
+
+  describe "destroy mailbox" do
+    it "should make a DELETE request with the right params" do
+      RestClient.should_receive(:delete)
+        .with("#{@mailgun.mailboxes.send(:mailbox_url, @mailbox_options[:domain], @mailbox_options[:name])}", {})
+        .and_return({})
+
+      @mailgun.mailboxes.destroy @mailbox_options[:email]
+    end
+  end
 end