rubymail 0.11

data/spec/list/member_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Rubymail::MailingList::Member do
+
+  before :each do
+    @rubymail = Rubymail({:api_key => "api-key"})		
+
+    @sample = {
+      :email      => "test@sample.rubymail.org",
+      :list_email => "test_list@sample.rubymail.org",
+      :name       => "test",
+      :domain     => "sample.rubymail.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.rubymail.org\" }  ]}"
+      mailing_list_members_url = @rubymail.list_members(@sample[:list_email]).send(:list_member_url)
+
+      expect(Rubymail).to receive(:submit).
+        with(:get, mailing_list_members_url, {}).
+        and_return(sample_response)
+
+      @rubymail.list_members(@sample[:list_email]).list
+    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.rubymail.org\" }  ]}"
+      mailing_list_members_url = @rubymail.list_members(@sample[:list_email]).send(:list_member_url, @sample[:email])
+
+      expect(Rubymail).to receive(:submit).
+        with(:get, mailing_list_members_url).
+        and_return(sample_response)
+
+      @rubymail.list_members(@sample[:list_email]).find(@sample[: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.rubymail.org\" }  ]}"
+      mailing_list_members_url = @rubymail.list_members(@sample[:list_email]).send(:list_member_url)
+
+      expect(Rubymail).to receive(:submit).
+        with(:post, mailing_list_members_url, {
+          :address => @sample[:email]
+        }).
+        and_return(sample_response)
+
+      @rubymail.list_members(@sample[:list_email]).add(@sample[: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.rubymail.org\" }  ]}"
+      expect(Rubymail).to receive(:submit).
+        with(:put, "#{@rubymail.list_members(@sample[:list_email]).send(:list_member_url, @sample[:email])}", {
+          :address => @sample[:email]
+        }).
+        and_return(sample_response)
+
+      @rubymail.list_members(@sample[:list_email]).update(@sample[: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.rubymail.org\" }  ]}"
+      mailing_list_members_url = @rubymail.list_members(@sample[:list_email]).send(:list_member_url, @sample[:email])
+      expect(Rubymail).to receive(:submit).
+        with(:delete, mailing_list_members_url).
+        and_return(sample_response)
+
+      @rubymail.list_members(@sample[:list_email]).remove(@sample[:email])
+    end
+  end
+
+end

data/spec/list/message_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Rubymail::Log do
+
+  before :each do
+    @rubymail = Rubymail({:api_key => "api-key"})   
+
+    @sample = {
+      :email  => "test@sample.rubymail.org",
+      :name   => "test",
+      :domain => "sample.rubymail.org"
+    }
+  end
+
+  describe "send email" do
+    it "should make a POST request to send an email" do
+
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.rubymail.org\" }  ]}"
+      expect(Rubymail).to receive(:submit)
+      .with(:get, "#{@rubymail.lists.send(:list_url, @sample[:list_email])}")
+      .and_return(sample_response)
+
+      @rubymail.lists.find(@sample[:list_email])
+
+      sample_response = "{\"message\": \"Queued. Thank you.\",\"id\": \"<20111114174239.25659.5817@samples.rubymail.org>\"}"
+      parameters = {
+        :to => "cooldev@your.rubymail.domain",
+        :subject => "missing tps reports",
+        :text => "yeah, we're gonna need you to come in on friday...yeah.",
+        :from => "lumberg.bill@initech.rubymail.domain"
+      }
+      expect(Rubymail).to receive(:submit)                            \
+        .with(:post, @rubymail.messages.messages_url, parameters) \
+        .and_return(sample_response)
+
+      @rubymail.messages.send_email(parameters)
+    end
+  end
+
+end

data/spec/list_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Rubymail::MailingList do
+
+  before :each do
+    @rubymail = Rubymail({:api_key => "api-key"})		
+
+    @sample = {
+      :email      => "test@sample.rubymail.org",
+      :list_email => "dev@samples.rubymail.org",
+      :name       => "test",
+      :domain     => "sample.rubymail.org"
+    }
+  end
+
+  describe "list mailing lists" do
+    it "should make a GET request with the right params" do
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.rubymail.org\" }  ]}"
+      expect(Rubymail).to receive(:submit)
+      .with(:get, "#{@rubymail.lists.send(:list_url)}", {}).and_return(sample_response)
+
+      @rubymail.lists.list
+    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.rubymail.org\" }  ]}"
+      expect(Rubymail).to receive(:submit)
+      .with(:get, "#{@rubymail.lists.send(:list_url, @sample[:list_email])}")
+      .and_return(sample_response)
+
+      @rubymail.lists.find(@sample[: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.rubymail.org\" }  ]}"
+      expect(Rubymail).to receive(:submit)
+      .with(:post, "#{@rubymail.lists.send(:list_url)}", {:address => @sample[:list_email]})
+      .and_return(sample_response)
+
+      @rubymail.lists.create(@sample[: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.rubymail.org\" }  ]}"
+      expect(Rubymail).to receive(:submit)
+      .with(:put, "#{@rubymail.lists.send(:list_url, @sample[:list_email])}", {:address => @sample[:email]})
+      .and_return(sample_response)
+
+      @rubymail.lists.update(@sample[:list_email], @sample[: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.rubymail.org\" }  ]}"
+      expect(Rubymail).to receive(:submit)
+      .with(:delete, "#{@rubymail.lists.send(:list_url, @sample[:list_email])}")
+      .and_return(sample_response)
+
+      @rubymail.lists.delete(@sample[:list_email])
+    end
+  end
+
+end

data/spec/log_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Rubymail::Log do
+
+  before :each do
+    @rubymail = Rubymail({:api_key => "api-key"})		
+
+    @sample = {
+      :email  => "test@sample.rubymail.org",
+      :name   => "test",
+      :domain => "sample.rubymail.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.rubymail.org\" }  ]}"
+      log_url = @rubymail.log(@sample[:domain]).send(:log_url)
+      expect(Rubymail).to receive(:submit).
+        with(:get, log_url, {}).
+        and_return(sample_response)
+
+      @rubymail.log(@sample[:domain]).list
+    end
+  end
+
+end

data/spec/mailbox_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Rubymail::Mailbox do
+
+  before :each do
+    @rubymail = Rubymail({:api_key => "api-key"})		
+
+    @sample = {
+      :email  => "test@sample.rubymail.org",
+      :mailbox_name => "test",
+      :domain => "sample.rubymail.org"
+    }
+  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.rubymail.org\" }  ]}"
+      mailboxes_url = @rubymail.mailboxes(@sample[:domain]).send(:mailbox_url)
+
+      expect(Rubymail).to receive(:submit).
+        with(:get,mailboxes_url, {}).
+        and_return(sample_response)
+
+      @rubymail.mailboxes(@sample[:domain]).list
+    end
+  end
+
+  describe "create mailbox" do
+    it "should make a POST request with the right params"	do
+      mailboxes_url = @rubymail.mailboxes(@sample[:domain]).send(:mailbox_url)
+      expect(Rubymail).to receive(:submit)
+        .with(:post, mailboxes_url,
+          :mailbox  => @sample[:email],
+          :password => @sample[:password])
+        .and_return({})
+
+      @rubymail.mailboxes(@sample[:domain]).create(@sample[:mailbox_name], @sample[:password])
+    end
+  end
+
+  describe "update mailbox" do
+    it "should make a PUT request with the right params" do
+      mailboxes_url = @rubymail.mailboxes(@sample[:domain]).send(:mailbox_url, @sample[:mailbox_name])
+      expect(Rubymail).to receive(:submit)
+        .with(:put, mailboxes_url, :password => @sample[:password])
+        .and_return({})
+
+      @rubymail.mailboxes(@sample[:domain]).
+        update_password(@sample[:mailbox_name], @sample[:password])
+    end
+  end
+
+  describe "destroy mailbox" do
+    it "should make a DELETE request with the right params" do
+      mailboxes_url = @rubymail.mailboxes(@sample[:domain]).send(:mailbox_url, @sample[:name])
+      expect(Rubymail).to receive(:submit)
+        .with(:delete, mailboxes_url)
+        .and_return({})
+
+      @rubymail.mailboxes(@sample[:domain]).destroy(@sample[:name])
+    end
+  end
+end

data/spec/route_spec.rb

@@ -0,0 +1,100 @@
+require "spec_helper"
+
+describe Rubymail::Route do
+
+  before :each do
+    @rubymail = Rubymail({:api_key => "api-key"})		
+    @sample_route_id = "a45cd"
+  end
+
+  describe "list routes" do
+    before :each do
+      sample_response = <<EOF
+{
+  "total_count": 0,
+  "items": []
+}
+EOF.to_json
+
+      expect(Rubymail).to receive(:submit).
+        with(:get, "#{@rubymail.routes.send(:route_url)}", {}).
+        and_return(sample_response)
+    end
+
+    it "should make a GET request with the right params" do
+      @rubymail.routes.list
+    end
+
+    it "should respond with an Array" do
+      expect(@rubymail.routes.list).to be_kind_of(Array)
+    end
+  end
+
+  describe "get route" do
+    it "should make a GET request with the right params" do
+      sample_response = <<EOF
+{
+  "route": {
+      "description": "Sample route",
+      "created_at": "Wed, 15 Feb 2012 13:03:31 GMT",
+      "actions": [
+          "forward(\"http://myhost.com/messages/\")",
+          "stop()"
+      ],
+      "priority": 1,
+      "expression": "match_recipient(\".*@samples.rubymail.org\")",
+      "id": "4f3bad2335335426750048c6"
+  }
+}
+EOF
+
+      expect(Rubymail).to receive(:submit).
+        with(:get, "#{@rubymail.routes.send(:route_url, @sample_route_id)}").
+        and_return(sample_response)
+
+      @rubymail.routes.find @sample_route_id
+    end
+  end
+
+  describe "create route" do
+    it "should make a POST request with the right params" do
+      options = {}
+
+      options[:description] = "test_route"
+      options[:priority]    = 1
+      options[:expression]  = [:match_recipient, "sample.rubymail.org"]
+      options[:action]      = [[:forward, "http://test-site.com"], [:stop]]
+
+      expect(Rubymail).to receive(:submit)
+        .with(:post, @rubymail.routes.send(:route_url), instance_of(Hash))
+        .and_return("{\"route\": {\"id\": \"@sample_route_id\"}}")
+
+      @rubymail.routes.create(
+        options[:description],
+        options[:priority],
+        options[:expression],
+        options[:action],
+      )
+    end
+  end
+
+  describe "update route" do
+    it "should make a PUT request with the right params" do
+      options = { description: "test_route" }
+
+      expect(Rubymail).to receive(:submit)
+        .with(:put, "#{@rubymail.routes.send(:route_url, @sample_route_id)}", { 'description' => ["test_route"] })
+        .and_return("{\"id\": \"#{@sample_route_id}\"}")
+      @rubymail.routes.update @sample_route_id, options
+    end
+  end
+
+  describe "delete route" do
+    it "should make a DELETE request with the right params" do
+      expect(Rubymail).to receive(:submit).
+        with(:delete, "#{@rubymail.routes.send(:route_url, @sample_route_id)}").
+        and_return("{\"id\": \"#{@sample_route_id}\"}")
+      @rubymail.routes.destroy @sample_route_id
+    end
+  end
+end

data/spec/secure_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require './spec/helpers/rubymail_helper.rb'
+
+RSpec.configure do |c|
+  c.include RubymailHelper
+end
+
+describe Rubymail::Secure do
+
+  before :each do
+    @rubymail = Rubymail({:api_key => "some-api-key"})   # used to get the default values
+  end
+
+  it "generate_request_auth helper should generate a timestamp, a token and a signature" do
+    timestamp, token, signature = generate_request_auth("some-api-key")
+
+    expect(timestamp).to_not    be_nil
+    expect(token.length).to     eq 50
+    expect(signature.length).to eq 64
+  end
+
+  it "check_request_auth should return true for a recently generated authentication" do
+    timestamp, token, signature = generate_request_auth("some-api-key")
+
+    result = @rubymail.secure.check_request_auth(timestamp, token, signature)
+
+    expect(result).to be true
+  end
+
+  it "check_request_auth should return false for an authentication generated more than 5 minutes ago" do
+    timestamp, token, signature = generate_request_auth("some-api-key", -6)
+
+    result = @rubymail.secure.check_request_auth(timestamp, token, signature)
+
+    expect(result).to be false
+  end
+
+  it "check_request_auth should return true for an authentication generated any time when the check offset is 0" do
+    timestamp, token, signature = generate_request_auth("some-api-key", -6)
+
+    result = @rubymail.secure.check_request_auth(timestamp, token, signature, 0)
+
+    expect(result).to be true
+  end
+
+  it "check_request_auth should return false for a different api key, token or signature" do
+    timestamp, token, signature = generate_request_auth("some-different-api-key")
+
+    result = @rubymail.secure.check_request_auth(timestamp, token, signature)
+
+    expect(result).to be false
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'simplecov'
+SimpleCov.start
+
+require "rspec"
+require "pry"
+require "rubymail"
+
+RSpec.configure do |config|
+end

data/spec/unsubscribe_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Rubymail::Unsubscribe do
+
+  before :each do
+    @rubymail = Rubymail({:api_key => "api-key"})		
+
+    @sample = {
+      :email  => "test@sample.rubymail.org",
+      :name   => "test",
+      :domain => "sample.rubymail.org",
+      :tag   => 'tag1'
+    }
+  end
+
+  describe "list unsubscribes" do
+    it "should make a GET request with the right params" do
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.rubymail.org\" }  ]}"
+      unsubscribes_url = @rubymail.unsubscribes(@sample[:domain]).send(:unsubscribe_url)
+      expect(Rubymail).to receive(:submit).
+        with(:get, unsubscribes_url, {}).
+        and_return(sample_response)
+
+      @rubymail.unsubscribes(@sample[:domain]).list
+    end
+  end
+
+  describe "find unsubscribe" 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.rubymail.org\" }  ]}"
+      unsubscribes_url = @rubymail.unsubscribes(@sample[:domain]).send(:unsubscribe_url, @sample[:email])
+
+      expect(Rubymail).to receive(:submit)
+        .with(:get, unsubscribes_url)
+        .and_return(sample_response)
+
+      @rubymail.unsubscribes(@sample[:domain]).find(@sample[:email])
+    end
+  end
+
+  describe "delete unsubscribe" do
+    it "should make a DELETE request with correct params to remove a given email address" do
+      response_message = "{\"message\"=>\"Unsubscribe event has been removed\", \"address\"=>\"#{@sample[:email]}\"}"
+      unsubscribes_url = @rubymail.unsubscribes(@sample[:domain]).send(:unsubscribe_url, @sample[:email])
+
+      expect(Rubymail).to receive(:submit)
+        .with(:delete, unsubscribes_url)
+        .and_return(response_message)
+
+      @rubymail.unsubscribes(@sample[:domain]).remove(@sample[:email])
+    end
+  end
+
+  describe "add unsubscribe" do
+    context "to tag" do
+      it "should make a POST request with correct params to add a given email address to unsubscribe from a tag" do
+        response_message = "{\"message\"=>\"Address has been added to the unsubscribes table\", \"address\"=>\"#{@sample[:email]}\"}"
+        expect(Rubymail).to receive(:submit)
+          .with(:post, "#{@rubymail.unsubscribes(@sample[:domain]).send(:unsubscribe_url)}",{:address=>@sample[:email], :tag=>@sample[:tag]})
+          .and_return(response_message)
+
+        @rubymail.unsubscribes(@sample[:domain]).add(@sample[:email], @sample[:tag])
+      end
+    end
+
+    context "on all" do
+      it "should make a POST request with correct params to add a given email address to unsubscribe from all tags" do
+        sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.rubymail.org\" }  ]}"
+        unsubscribes_url = @rubymail.unsubscribes(@sample[:domain]).send(:unsubscribe_url)
+
+        expect(Rubymail).to receive(:submit)
+          .with(:post, unsubscribes_url, {
+            :address => @sample[:email], :tag => '*'
+          })
+          .and_return(sample_response)
+
+        @rubymail.unsubscribes(@sample[:domain]).add(@sample[:email])
+      end
+    end
+  end
+
+end

data/spec/webhook_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe Rubymail::Webhook do
+
+  before :each do
+    @rubymail = Rubymail({:api_key => "api-key", :webhook_url => "http://postbin.heroku.com/860bcd65"})
+
+    @sample = {
+      :id     => "click",
+      :url    => "http://postbin.heroku.com/860bcd65"
+    }
+  end
+
+  describe "list avabilable webhook ids" do
+    it "should return the correct ids" do
+      expect(@rubymail.webhooks.available_ids).to match_array %i(bounce deliver drop spam unsubscribe click open)
+    end
+  end
+
+  describe "list webhooks" do
+    it "should make a GET request with the correct params" do
+
+      sample_response = "{\"total_count\": 1, \"items\": [{\"webhooks\":{\"open\":{\"url\":\"http://postbin.heroku.com/860bcd65\"},\"click\":{\"url\":\"http://postbin.heroku.com/860bcd65\"}}}]}"
+      webhooks_url = @rubymail.webhooks.send(:webhook_url)
+
+      expect(Rubymail).to receive(:submit).
+        with(:get, webhooks_url).
+        and_return(sample_response)
+
+      @rubymail.webhooks.list
+    end
+  end
+
+  describe "find a webhook" do
+    it "should make a GET request with correct params to find a given webhook" do
+      sample_response = "{\"webhook\": {\"url\":\"http://postbin.heroku.com/860bcd65\"}"
+      webhooks_url = @rubymail.webhooks.send(:webhook_url, @sample[:id])
+
+      expect(Rubymail).to receive(:submit).
+        with(:get, webhooks_url).
+        and_return(sample_response)
+
+      @rubymail.webhooks.find(@sample[:id])
+    end
+  end
+
+  describe "add a webhook" do
+    context "using the default webhook url" do
+      it "should make a POST request with correct params to add a webhook" do
+        sample_response = "{\"message\":\"Webhook has been created\",\"webhook\":{\"url\":\"http://postbin.heroku.com/860bcd65\"}}"
+        webhooks_url = @rubymail.webhooks.send(:webhook_url)
+
+        expect(Rubymail).to receive(:submit).
+          with(:post, webhooks_url, {:id => @sample[:id], :url => @sample[:url]}).
+          and_return(sample_response)
+
+        @rubymail.webhooks.create(@sample[:id])
+      end
+    end
+    context "overwriting the default webhook url" do
+      it "should make a POST request with correct params to add a webhook" do
+        sample_response = "{\"message\":\"Webhook has been created\",\"webhook\":{\"url\":\"http://postbin.heroku.com/860bcd65\"}}"
+        webhooks_url = @rubymail.webhooks.send(:webhook_url)
+        overwritten_url = 'http://rubymail.net/webhook'
+
+        expect(Rubymail).to receive(:submit).
+          with(:post, webhooks_url, {:id => @sample[:id], :url => overwritten_url}).
+          and_return(sample_response)
+
+        @rubymail.webhooks.create(@sample[:id], overwritten_url)
+      end
+    end
+  end
+
+  describe "update a webhook" do
+    context "using the default webhook url" do
+      it "should make a POST request with correct params to add a webhook" do
+        sample_response = "{\"message\":\"Webhook has been updated\",\"webhook\":{\"url\":\"http://postbin.heroku.com/860bcd65\"}}"
+        webhooks_url = @rubymail.webhooks.send(:webhook_url, @sample[:id])
+
+        expect(Rubymail).to receive(:submit).
+          with(:put, webhooks_url, {:url => @sample[:url]}).
+          and_return(sample_response)
+
+        @rubymail.webhooks.update(@sample[:id])
+      end
+    end
+    context "overwriting the default webhook url" do
+      it "should make a POST request with correct params to add a webhook" do
+        sample_response = "{\"message\":\"Webhook has been updated\",\"webhook\":{\"url\":\"http://postbin.heroku.com/860bcd65\"}}"
+        webhooks_url = @rubymail.webhooks.send(:webhook_url, @sample[:id])
+        overwritten_url = 'http://rubymail.net/webhook'
+
+        expect(Rubymail).to receive(:submit).
+          with(:put, webhooks_url, {:url => overwritten_url}).
+          and_return(sample_response)
+
+        @rubymail.webhooks.update(@sample[:id], overwritten_url)
+      end
+    end
+  end
+
+  describe "delete a webhook" do
+    it "should make a DELETE request with correct params" do
+      sample_response = "{\"message\":\"Webhook has been deleted\",\"webhook\":{\"url\":\"http://postbin.heroku.com/860bcd65\"}}"
+      webhooks_url = @rubymail.webhooks.send(:webhook_url, @sample[:id])
+
+      expect(Rubymail).to receive(:submit).
+        with(:delete, webhooks_url).
+        and_return(sample_response)
+
+      @rubymail.webhooks.delete(@sample[:id])
+    end
+  end
+end