mailgun 0.5 → 0.6

data/lib/mailgun/list.rb

@@ -1,22 +1,17 @@
 module Mailgun
-	class List
+
+  # Mailing List functionality
+  # Refer http://documentation.mailgun.net/api-mailinglists.html for optional parameters
+
+  class MailingList
     # Used internally, called from Mailgun::Base
     def initialize(mailgun)
       @mailgun = mailgun
     end
-    
-
-    ## List functionality
-
-    # TODO add default domain functionality for the address names of lists
-
-    # List all mailing lists 
-    def all
-      response = Mailgun.submit :get, list_url
 
-      if response
-        response["items"].collect {|item| item["address"]}
-      end
+    # List all mailing lists
+    def list(options={})
+      response = Mailgun.submit(:get, list_url, options)["items"] || []
     end
 
     # List a single mailing list by a given address
@@ -25,21 +20,16 @@ module Mailgun
     end
 
     # Create a mailing list with a given address
-    # with an optional name and description
-    def create(address, name=nil, description=nil)
+    def create(address, options={})
     	params = {:address => address}
-    	params[:name] = name if name
-    	params[:description] = description if description
-      Mailgun.submit :post, list_url, params
+      Mailgun.submit :post, list_url, params.merge(options)
     end
 
     # Update a mailing list with a given address
     # with an optional new address, name or description
-    def update(address, new_address, name=nil, description=nil)
-     	params = {:address => new_address}
-    	params[:name] = name if name
-    	params[:description] = description if description
-      Mailgun.submit :put, list_url(address), params
+    def update(address, new_address, options={})
+      params = {:address => new_address}
+      Mailgun.submit :put, list_url(address), params.merge(options)
     end		
 
     # Deletes a mailing list with a given address
@@ -55,5 +45,5 @@ module Mailgun
       "#{@mailgun.base_url}/lists#{'/' + address if address}"
     end
     
-	end
+  end
 end

data/lib/mailgun/list/member.rb

@@ -1,56 +1,52 @@
 module Mailgun
-  class List::Member
+  # List Member functionality
+  # Refer Mailgun docs for optional params
+  class MailingList::Member
+
     # Used internally, called from Mailgun::Base
-    def initialize(mailgun)
+    def initialize(mailgun, address)
       @mailgun = mailgun
+      @address = address
     end
-    
-    ## List Member functionality
 
     # List all mailing list members
-    # TODO add parameters: subscribed, limit, skip
-    def list(address)
-      response = Mailgun.submit :get, list_member_url(address)
-
-      if response
-        response["items"].collect {|item| item["address"]}
-      end
+    def list(options={})
+      response = Mailgun.submit(:get, list_member_url, options)["items"]
     end
 
     # List a single mailing list member by a given address
-    def find(address, member_address)
-      Mailgun.submit :get, list_member_url(address, member_address)
+    def find(member_address)
+      Mailgun.submit :get, list_member_url(member_address)
     end
 
+
     # Adds a mailing list member with a given address
-    # TODO add name, vars, subscribed, upsert
-    def add(address, member_address, name=nil, vars={}, subscribed='yes', upsert='no')
-      params = {:address => member_address, :subscribed => subscribed, :upsert => 'no'}
-      params[:name] = name if name
-      params[:vars] = vars unless vars.empty?
-      Mailgun.submit :post, list_member_url(address), params
+    # NOTE Use create instead of add?
+    def add(member_address, options={})
+      params = {:address => member_address}
+      Mailgun.submit :post, list_member_url, params.merge(options)
     end
 
+    # TODO add spec?
+    alias_method :create, :add
+
     # Update a mailing list member with a given address
-    # with an optional new member_address, name, vars and subscribed
-    def update(address, member_address, name=nil, vars={}, subscribed='yes')
-      params = {:address => member_address, :subscribed => subscribed}
-      params[:name] = name if name
-      params[:vars] = vars unless vars.empty?
-      Mailgun.submit :put, list_member_url(address, member_address), params
+    def update(member_address, options={})
+      params = {:address => member_address}
+      Mailgun.submit :put, list_member_url(member_address), params.merge(options)
     end   
 
     # Deletes a mailing list member with a given address
-    def remove(address, member_address)
-      Mailgun.submit :delete, list_member_url(address, member_address)
+    def remove(member_address)
+      Mailgun.submit :delete, list_member_url(member_address)
     end
 
 
     private
 
     # Helper method to generate the proper url for Mailgun mailbox API calls
-    def list_member_url(address, member_address=nil)
-      "#{@mailgun.base_url}/lists#{'/' + address}/members#{'/' + member_address if member_address}"
+    def list_member_url(member_address=nil)
+      "#{@mailgun.base_url}/lists#{'/' + @address}/members#{'/' + member_address if member_address}"
     end
     
   end

data/lib/mailgun/log.rb

@@ -1,25 +1,22 @@
 module Mailgun
 	class Log
     # Used internally, called from Mailgun::Base
-    def initialize(mailgun)
+    def initialize(mailgun, domain)
       @mailgun = mailgun
+      @domain = domain
     end
     
     # List all logs for a given domain
     # * domain the domain for which all complaints will listed
-    def list(domain=Mailgun.domain, limit=100, skip=0)
-      response = Mailgun.submit :get, log_url(domain), {:limit => limit, :skip => skip}
-
-      if response
-        response["items"].collect {|item| item["message"]}
-      end
+    def list(options={})
+      Mailgun.submit(:get, log_url, options)
     end
     
     private
 
     # Helper method to generate the proper url for Mailgun complaints API calls
-    def log_url(domain)
-      "#{@mailgun.base_url}/#{domain}/log"
+    def log_url
+      "#{@mailgun.base_url}/#{@domain}/log"
     end
    
 	end

data/lib/mailgun/mailbox.rb

@@ -2,49 +2,49 @@ module Mailgun
   class Mailbox
 
     # Used internally, called from Mailgun::Base
-    def initialize(mailgun)
+    def initialize(mailgun, domain)
       @mailgun = mailgun
+      @domain  = domain
     end
     
     # List all mailboxes for a given domain
     # * domain the domain for which all mailboxes will listed
-    def list(domain = Mailgun.domain)
-      response = Mailgun.submit :get, mailbox_url(domain)
-
-      if response
-        response["items"].collect {|item| item["mailbox"]}
-      end
+    def list(options={})
+      Mailgun.submit(:get, mailbox_url, options)["items"]
     end
     
 
     # Creates a mailbox on the Mailgun server with the given password
-    def create(address, password)
-      Mailgun.submit :post, mailbox_url(address.split("@").last), :mailbox =>  address,
-      :password => password
+    def create(mailbox_name, password)
+      address = "#{mailbox_name}@#{@domain}"
+      Mailgun.submit(
+        :post,
+        mailbox_url,
+        {
+          :mailbox => address,
+          :password => password
+        }
+      )
     end
 
 
     # Sets the password for a mailbox
-    def update_password(address, password)
-      mailbox_name, domain = address.split("@")
-
-      Mailgun.submit :put, mailbox_url(domain, mailbox_name), :password => password
+    def update_password(mailbox_name, password)
+      Mailgun.submit :put, mailbox_url(mailbox_name), :password => password
     end
 
 
     # Destroys the mailbox
-    def destroy(address)
-      mailbox_name, domain = address.split("@")
-
-      Mailgun.submit :delete,  mailbox_url(domain, mailbox_name)
+    def destroy(mailbox_name)
+      Mailgun.submit :delete, mailbox_url(mailbox_name)
     end
 
 
     private
 
     # Helper method to generate the proper url for Mailgun mailbox API calls
-    def mailbox_url(domain, mailbox_name=nil)
-      "#{@mailgun.base_url}/#{domain}/mailboxes#{'/' + mailbox_name if mailbox_name}"
+    def mailbox_url(mailbox_name=nil)
+      "#{@mailgun.base_url}/#{@domain}/mailboxes#{'/' + mailbox_name if mailbox_name}"
     end
 
   end

data/lib/mailgun/{mail.rb → message.rb}

@@ -1,13 +1,13 @@
 module Mailgun
-  class Mail
-
-    def initialize(mailgun)
+  class Message
+    def initialize(mailgun, domain)
       @mailgun = mailgun
+      @domain  = domain
     end
 
     # send email
-    def send_email()
-      # TODO with the following options
+    def send_email(parameters={})
+      # options:
       # :from, :to, :cc, :bcc, :subject, :text, :html 
       # :with_attachment
       # :with_attachments
@@ -15,6 +15,14 @@ module Mailgun
       # :in_test_mode BOOL. override the @use_test_mode setting
       # :tags to add tags to the email
       # :track BOOL
+      Mailgun.submit(:post, messages_url, parameters)
+    end
+
+    #private
+
+    # Helper method to generate the proper url for Mailgun message API calls
+    def messages_url
+      "#{@mailgun.base_url}/#{@domain}/messages"
     end
   end
 end

data/lib/mailgun/route.rb

@@ -5,8 +5,8 @@ module Mailgun
       @mailgun = mailgun
     end
     
-    def list(limit=100, skip=0)
-      Mailgun.submit(:get, route_url, :limit => limit, :skip => skip)["items"] || []
+    def list(options={})
+      Mailgun.submit(:get, route_url, options)["items"] || []
     end
 
     def find(route_id)

data/lib/mailgun/unsubscribe.rb

@@ -1,37 +1,33 @@
 module Mailgun
   class Unsubscribe
     # Used internally, called from Mailgun::Base
-    def initialize(mailgun)
+    def initialize(mailgun, domain)
       @mailgun = mailgun
+      @domain  = domain
     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
+    # List all unsubscribes for the domain
+    def list(options={})
+      Mailgun.submit(:get, unsubscribe_url, options)["items"]
     end
 
-    def find(domain = Mailgun.domain, email)
-      Mailgun.submit :get, unsubscribe_url(domain, email)
+    def find(email)
+      Mailgun.submit :get, unsubscribe_url(email)
     end
 
-    def add(email, domain=Mailgun.domain, tag='*')
-      Mailgun.submit :post, unsubscribe_url(domain), {:address => email, :tag => tag}
+    def add(email, tag='*')
+      Mailgun.submit :post, unsubscribe_url, {:address => email, :tag => tag}
     end
 
-    def remove(domain = Mailgun.domain, email)
-      Mailgun.submit :delete, unsubscribe_url(domain, email)
+    def remove(email)
+      Mailgun.submit :delete, unsubscribe_url(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}"
+    def unsubscribe_url(address=nil)
+      "#{@mailgun.base_url}/#{@domain}/unsubscribes#{'/' + address if address}"
     end
     
   end

data/mailgun.gemspec

@@ -12,8 +12,11 @@ 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.5"
+  gem.version       = "0.6"
   
   gem.add_dependency(%q<rest-client>, [">= 0"])
   gem.add_dependency(%q<multimap>, [">= 0"])
+
+  gem.add_development_dependency(%q<rspec>, [">= 2"])
+  gem.add_development_dependency(%q<debugger>, [">= 0"])
 end

data/spec/bounce_spec.rb

@@ -5,7 +5,7 @@ describe Mailgun::Bounce do
   before :each do
     @mailgun = Mailgun({:api_key => "api-key"})		# used to get the default values
 
-    @bounce_options = {
+    @sample = {
       :email  => "test@sample.mailgun.org",
       :name   => "test",
       :domain => "sample.mailgun.org"
@@ -15,32 +15,39 @@ describe Mailgun::Bounce do
   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)
+      bounces_url = @mailgun.bounces(@sample[:domain]).send(:bounce_url)
+
+      Mailgun.should_receive(:submit).
+        with(:get, bounces_url, {}).
+        and_return(sample_response)
     
-      @mailgun.bounces.list @bounce_options[:domain]
+      @mailgun.bounces(@sample[:domain]).list
     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)
+      bounces_url = @mailgun.bounces(@sample[:domain]).send(:bounce_url, @sample[:email])
+
+      Mailgun.should_receive(:submit).
+        with(:get, bounces_url).
+        and_return(sample_response)
 
-      @mailgun.bounces.find(@bounce_options[:domain], @bounce_options[:email])
+      @mailgun.bounces(@sample[:domain]).find(@sample[: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)
+      bounces_url = @mailgun.bounces(@sample[:domain]).send(:bounce_url)
+
+      Mailgun.should_receive(:submit).
+        with(:post, bounces_url, {:address => @sample[:email]} ).
+        and_return(sample_response)
 
-      @mailgun.bounces.add(@bounce_options[:domain], @bounce_options[:email])
+      @mailgun.bounces(@sample[:domain]).add(@sample[:email])
     end
   end
 

data/spec/complaint_spec.rb

@@ -3,9 +3,9 @@ require 'spec_helper'
 describe Mailgun::Complaint do
 
   before :each do
-    @mailgun = Mailgun({:api_key => "api-key"})		# used to get the default values
+    @mailgun = Mailgun({:api_key => "api-key"})
 
-    @complaint_options = {
+    @sample = {
       :email  => "test@sample.mailgun.org",
       :name   => "test",
       :domain => "sample.mailgun.org"
@@ -14,42 +14,89 @@ describe Mailgun::Complaint do
 
   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)
+      sample_response = <<EOF
+{
+  "total_count": 1,
+  "items": [
+      {
+          "count": 2,
+          "created_at": "Tue, 15 Nov 2011 08:25:11 GMT",
+          "address": "romanto@profista.com"
+      }
+  ]
+}
+EOF
 
-      @mailgun.complaints.list @complaint_options[:domain]
+      complaints_url = @mailgun.complaints(@sample[:domain]).send(:complaint_url)
+
+      Mailgun.should_receive(:submit).
+        with(:get, complaints_url, {}).
+        and_return(sample_response)
+
+      @mailgun.complaints(@sample[:domain]).list
+    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
+      sample_response = <<EOF
+{
+  "message": "Address has been added to the complaints table",
+  "address": "#{@sample[:email]}"
+}
+EOF
+
+      complaints_url = @mailgun.complaints(@sample[:domain]).send(:complaint_url)
+
+      Mailgun.should_receive(:submit)
+        .with(:post, complaints_url, {:address => @sample[:email]})
+        .and_return(sample_response)
+
+      @mailgun.complaints(@sample[:domain]).add(@sample[:email])
     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)
+      sample_response = <<EOF
+{
+  "complaint": {
+      "count": 2,
+      "created_at": "Tue, 15 Nov 2011 08:25:11 GMT",
+      "address": "romanto@profista.com"
+  }
+}
+EOF
+
+      complaints_url = @mailgun.complaints(@sample[:domain]).send(:complaint_url, @sample[:email])
+
+      Mailgun.should_receive(:submit)
+        .with(:get, complaints_url)
+        .and_return(sample_response)
 
-      @mailgun.complaints.find(@complaint_options[:domain], @complaint_options[:email])
+      @mailgun.complaints(@sample[:domain]).find(@sample[: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)
+      sample_response = <<EOF
+{
+    "message": "Complaint event has been removed",
+    "address": "#{@sample[:email]}"}"
+}
+EOF
 
-      @mailgun.complaints.remove(@complaint_options[:domain], @complaint_options[:email])
-    end
-  end
+      complaints_url = @mailgun.complaints(@sample[:domain]).send(:complaint_url, @sample[:email])
 
-  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])
+        .with(:delete, complaints_url)
+        .and_return(sample_response)
+
+      @mailgun.complaints(@sample[:domain]).destroy(@sample[:email])
     end
   end