rubymail 0.11

data/lib/rubymail/unsubscribe.rb

@@ -0,0 +1,31 @@
+module Rubymail
+    class Unsubscribe
+      def initialize(rubymail, domain)
+        @rubymail = rubymail
+        @domain  = domain
+      end
+      
+      def list(options={})
+        Rubymail.submit(:get, unsubscribe_url, options)["items"]
+      end
+  
+      def find(email)
+        Rubymail.submit :get, unsubscribe_url(email)
+      end
+  
+      def add(email, tag='*')
+        Rubymail.submit :post, unsubscribe_url, {:address => email, :tag => tag}
+      end
+  
+      def remove(email)
+        Rubymail.submit :delete, unsubscribe_url(email)
+      end
+      
+      private
+  
+      def unsubscribe_url(address=nil)
+        "#{@rubymail.base_url}/#{@domain}/unsubscribes#{'/' + address if address}"
+      end
+      
+    end
+  end

data/lib/rubymail/webhook.rb

@@ -0,0 +1,43 @@
+module Rubymail
+    class Webhook
+      attr_accessor :default_webhook_url, :domain
+  
+      def initialize(rubymail, domain, url)
+        @rubymail = rubymail
+        @domain = domain
+        @default_webhook_url = url
+      end
+  
+      def available_ids
+        %w(bounce deliver drop spam unsubscribe click open).map(&:to_sym)
+      end
+  
+      def list
+        Rubymail.submit(:get, webhook_url)["webhooks"] || []
+      end
+  
+      def find(id)
+        Rubymail.submit :get, webhook_url(id)
+      end
+  
+      def create(id, url=default_webhook_url)
+        params = {:id => id, :url => url}
+        Rubymail.submit :post, webhook_url, params
+      end
+  
+      def update(id, url=default_webhook_url)
+        params = {:url => url}
+        Rubymail.submit :put, webhook_url(id), params
+      end
+  
+      def delete(id)
+        Rubymail.submit :delete, webhook_url(id)
+      end
+  
+      private
+  
+      def webhook_url(id=nil)
+        "#{@rubymail.base_url}/domains/#{domain}/webhooks#{'/' + id if id}"
+      end
+    end
+  end

data/lib/rubymail.rb

@@ -0,0 +1,31 @@
+require "json"
+require "multimap/lib/multimap"
+require "multimap/lib/multiset"
+require "multimap/lib/nested_multimap"
+
+require "rubymail/rubymail_error"
+require "rubymail/base"
+require "rubymail/domain"
+require "rubymail/route"
+require "rubymail/mailbox"
+require "rubymail/bounce"
+require "rubymail/unsubscribe"
+require "rubymail/webhook"
+require "rubymail/complaint"
+require "rubymail/log"
+require "rubymail/list"
+require "rubymail/list/member"
+require "rubymail/message"
+require "rubymail/secure"
+require "rubymail/address"
+require "rubymail/client"
+
+#require "startup"
+
+def Rubymail(options={})
+  options[:api_key] = Rubymail.api_key if Rubymail.api_key
+  options[:domain] = Rubymail.domain if Rubymail.domain
+  options[:webhook_url] = Rubymail.webhook_url if Rubymail.webhook_url
+  options[:public_api_key] = Rubymail.public_api_key if Rubymail.public_api_key
+  Rubymail::Base.new(options)
+end

data/rubymail.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |gem|
+  gem.authors       = ["Krishpranav"]
+  gem.email         = ["krisna.pranav@gmail.com"]
+  gem.description   = %q{ruby mail framework}
+  gem.summary       = %q{ruby mail framework}
+  gem.homepage      = "http://github.com/krishpranav/rubymail"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "rubymail"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.11"
+
+  gem.add_development_dependency(%q<rspec>, [">= 2"])
+  gem.add_development_dependency(%q<pry>, [">= 0"])
+  gem.add_development_dependency(%q<webmock>, [">= 2"])
+end

data/spec/address_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Rubymail::Address do
+
+  before :each do
+    @sample = "foo@rubymail.net"
+  end
+
+  describe "validate an address" do
+    it "should require a public api key" do
+      rubymail = Rubymail({:api_key => "api-key"})
+      expect { rubymail.addresses }.to raise_error(ArgumentError, ":public_api_key is a required argument to validate addresses")
+    end
+    it "should make a GET request with correct params to find a given webhook" do
+      rubymail = Rubymail({:api_key => "api-key", :public_api_key => "public-api-key"})
+
+      sample_response = "{\"is_valid\":true,\"address\":\"foo@rubymail.net\",\"parts\":{\"display_name\":null,\"local_part\":\"foo\",\"domain\":\"rubymail.net\"},\"did_you_mean\":null}"
+      validate_url = rubymail.addresses.send(:address_url, 'validate')
+
+      expect(Rubymail).to receive(:submit).
+        with(:get, validate_url, {:address => @sample}).
+        and_return(sample_response)
+
+      rubymail.addresses.validate(@sample)
+    end
+  end
+end

data/spec/base_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe Rubymail::Base do
+
+  it "should raise an error if the api_key has not been set" do
+    Rubymail.config { |c| c.api_key = nil }
+    expect do
+      Rubymail()
+    end.to raise_error ArgumentError
+  end
+
+  it "can be called directly if the api_key has been set via Rubymail.configure" do
+    Rubymail.config { |c| c.api_key = "some-junk-string" }
+    expect do
+      Rubymail()
+    end.not_to raise_error()
+  end
+
+  it "can be instanced with the api_key as a param" do
+    expect do
+      Rubymail({:api_key => "some-junk-string"})
+    end.not_to raise_error()
+  end
+
+  describe "Rubymail.new" do
+    it "Rubymail() method should return a new Rubymail object" do
+      rubymail = Rubymail({:api_key => "some-junk-string"})
+      expect(rubymail).to be_kind_of(Rubymail::Base)
+    end
+  end
+
+  describe "resources" do
+    before :each do
+      @rubymail = Rubymail({:api_key => "some-junk-string"})
+    end
+
+    it "Rubymail#mailboxes should return an instance of Rubymail::Mailbox" do
+      expect(@rubymail.mailboxes).to be_kind_of(Rubymail::Mailbox)
+    end
+
+    it "Rubymail#routes should return an instance of Rubymail::Route" do
+      expect(@rubymail.routes).to be_kind_of(Rubymail::Route)
+    end
+  end
+
+  describe "internal helper methods" do
+    before :each do
+      @rubymail = Rubymail({:api_key => "some-junk-string"})
+    end
+
+    describe "Rubymail#base_url" do
+      it "should return https url if use_https is true" do
+      expect(@rubymail.base_url).to eq "https://api:#{Rubymail.api_key}@#{Rubymail.rubymail_host}/#{Rubymail.api_version}"
+      end
+    end
+
+    describe "Rubymail.submit" do
+      let(:client_double) { double(Rubymail::Client) }
+
+      it "should send method and arguments to Rubymail::Client" do
+        expect(Rubymail::Client).to receive(:new)
+          .with('/')
+          .and_return(client_double)
+        expect(client_double).to receive(:test_method)
+          .with({:arg1=>"val1"})
+          .and_return('{}')
+
+        Rubymail.submit :test_method, '/', :arg1=>"val1"
+      end
+    end
+  end
+
+  describe "configuration" do
+    describe "default settings" do
+      it "api_version is v3" do
+        expect(Rubymail.api_version).to eql 'v3'
+      end
+      it "should use https by default" do
+        expect(Rubymail.protocol).to eq "https"
+      end
+      it "rubymail_host is 'api.rubymail.net'" do
+        expect(Rubymail.rubymail_host).to eql 'api.rubymail.net'
+      end
+
+      it "test_mode is false" do
+        expect(Rubymail.test_mode).to eql false
+      end
+
+      it "domain is not set" do
+        expect(Rubymail.domain).to be_nil
+      end
+    end
+
+    describe "setting configurations" do
+      before(:each) do
+        Rubymail.configure do |c|
+          c.api_key = 'some-api-key'
+          c.api_version = 'v2'
+          c.protocol = 'https'
+          c.rubymail_host = 'api.rubymail.net'
+          c.test_mode = false
+          c.domain = 'some-domain'
+        end
+      end
+
+      after(:each) { Rubymail.configure { |c| c.domain = nil } }
+
+      it "allows me to set my API key easily" do
+        expect(Rubymail.api_key).to eql 'some-api-key'
+      end
+
+      it "allows me to set the api_version attribute" do
+        expect(Rubymail.api_version).to eql 'v2'
+      end
+
+      it "allows me to set the protocol attribute" do
+        expect(Rubymail.protocol).to eql 'https'
+      end
+
+      it "allows me to set the rubymail_host attribute" do
+        expect(Rubymail.rubymail_host).to eql 'api.rubymail.net'
+      end
+      it "allows me to set the test_mode attribute" do
+        expect(Rubymail.test_mode).to eql false
+      end
+
+      it "allows me to set my domain easily" do
+        expect(Rubymail.domain).to eql 'some-domain'
+      end
+    end
+  end
+end

data/spec/bounce_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Rubymail::Bounce 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 bounces" do
+    it "should make a GET request with the right params" do
+      sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.rubymail.org\" }  ]}"
+      bounces_url = @rubymail.bounces(@sample[:domain]).send(:bounce_url)
+
+      expect(Rubymail).to receive(:submit).
+        with(:get, bounces_url, {}).
+        and_return(sample_response)
+
+      @rubymail.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.rubymail.org\" }  ]}"
+      bounces_url = @rubymail.bounces(@sample[:domain]).send(:bounce_url, @sample[:email])
+
+      expect(Rubymail).to receive(:submit).
+        with(:get, bounces_url).
+        and_return(sample_response)
+
+      @rubymail.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 = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.rubymail.org\" }  ]}"
+      bounces_url = @rubymail.bounces(@sample[:domain]).send(:bounce_url)
+
+      expect(Rubymail).to receive(:submit).
+        with(:post, bounces_url, {:address => @sample[:email]} ).
+        and_return(sample_response)
+
+      @rubymail.bounces(@sample[:domain]).add(@sample[:email])
+    end
+  end
+
+  describe "destroy bounces" do
+    it "should make DELETE request with correct params to remove a given email address" do
+      sample_response = "{\"message\"=>\"Bounced address has been removed\", \"address\"=>\"postmaster@bsample.rubymail.org\"}"
+      bounces_url = @rubymail.bounces(@sample[:domain]).send(:bounce_url, @sample[:email])
+
+      expect(Rubymail).to receive(:submit).
+        with(:delete, bounces_url).
+        and_return(sample_response)
+
+      @rubymail.bounces(@sample[:domain]).destroy(@sample[:email])
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+require 'webmock/rspec'
+
+describe Rubymail::Client do
+  subject { described_class.new(url) }
+
+  describe '#get' do
+    context 'without query params' do
+      let(:url) { 'https://api:key@api.rubymail.net/v3/routes' }
+
+      it 'sends a GET request to the given path' do
+        stub = stub_request(:get, 'https://api.rubymail.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.rubymail.net/v3/routes' }
+
+      it 'sends a GET request to the given path with the params' do
+        stub = stub_request(:get, 'https://api.rubymail.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.rubymail.net/v3/routes/123' }
+      let(:error_body) { { "message" => "Expression is missing" }.to_json }
+
+      before do
+        stub_request(:get, 'https://api.rubymail.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.rubymail.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.rubymail.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.rubymail.net/v3/routes/123' }
+
+    it 'sends a PUT request with the params form-encoded' do
+      stub = stub_request(:put, 'https://api.rubymail.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.rubymail.net/v3/routes/123' }
+
+    it 'sends a DELETE request with the params form-encoded' do
+      stub = stub_request(:delete, 'https://api.rubymail.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

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe Rubymail::Complaint 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 complaints" do
+    it "should make a GET request with the right params" do
+      sample_response = <<EOF
+{
+  "total_count": 1,
+  "items": [
+      {
+          "count": 2,
+          "created_at": "Tue, 15 Nov 2011 08:25:11 GMT",
+          "address": "romanto@profista.com"
+      }
+  ]
+}
+EOF
+
+      complaints_url = @rubymail.complaints(@sample[:domain]).send(:complaint_url)
+
+      expect(Rubymail).to receive(:submit).
+        with(:get, complaints_url, {}).
+        and_return(sample_response)
+
+      @rubymail.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 = @rubymail.complaints(@sample[:domain]).send(:complaint_url)
+
+      expect(Rubymail).to receive(:submit)
+        .with(:post, complaints_url, {:address => @sample[:email]})
+        .and_return(sample_response)
+
+      @rubymail.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 = <<EOF
+{
+  "complaint": {
+      "count": 2,
+      "created_at": "Tue, 15 Nov 2011 08:25:11 GMT",
+      "address": "romanto@profista.com"
+  }
+}
+EOF
+
+      complaints_url = @rubymail.complaints(@sample[:domain]).send(:complaint_url, @sample[:email])
+
+      expect(Rubymail).to receive(:submit)
+        .with(:get, complaints_url)
+        .and_return(sample_response)
+
+      @rubymail.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
+      sample_response = <<EOF
+{
+    "message": "Complaint event has been removed",
+    "address": "#{@sample[:email]}"}"
+}
+EOF
+
+      complaints_url = @rubymail.complaints(@sample[:domain]).send(:complaint_url, @sample[:email])
+
+      expect(Rubymail).to receive(:submit)
+        .with(:delete, complaints_url)
+        .and_return(sample_response)
+
+      @rubymail.complaints(@sample[:domain]).destroy(@sample[:email])
+    end
+  end
+
+end

data/spec/domain_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Rubymail::Domain 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 domains" do
+    it "should make a GET request with the right params" do
+
+      sample_response = "{\"total_count\": 1, \"items\": [{\"created_at\": \"Tue, 12 Feb 2013 20:13:49 GMT\", \"smtp_login\": \"postmaster@sample.rubymail.org\", \"name\": \"sample.rubymail.org\", \"smtp_password\": \"67bw67bz7w\" }]}"
+      domains_url = @rubymail.domains.send(:domain_url)
+
+      expect(Rubymail).to receive(:submit).
+        with(:get, domains_url, {}).
+        and_return(sample_response)
+
+      @rubymail.domains.list
+    end
+  end
+
+  describe "find domains" do
+    it "should make a GET request with correct params to find given domain" do
+      sample_response = "{\"domain\": {\"created_at\": \"Tue, 12 Feb 2013 20:13:49 GMT\", \"smtp_login\": \"postmaster@bample.rubymail.org\", \"name\": \"sample.rubymail.org\", \"smtp_password\": \"67bw67bz7w\" }, \"receiving_dns_records\": [], \"sending_dns_records\": []}"
+      domains_url = @rubymail.domains.send(:domain_url, @sample[:domain])
+
+      expect(Rubymail).to receive(:submit).
+        with(:get, domains_url).
+        and_return(sample_response)
+
+      @rubymail.domains.find(@sample[:domain])
+    end
+  end
+
+  describe "add domains" do
+    it "should make a POST request with correct params to add a domain" do
+      sample_response = "{\"domain\": {\"created_at\": \"Tue, 12 Feb 2013 20:13:49 GMT\", \"smtp_login\": \"postmaster@sample.rubymail.org\",\"name\": \"sample.rubymail.org\",\"smtp_password\": \"67bw67bz7w\"}, \"message\": \"Domain has been created\"}"
+      domains_url = @rubymail.domains.send(:domain_url)
+
+      expect(Rubymail).to receive(:submit).
+        with(:post, domains_url, {:name => @sample[:domain]} ).
+        and_return(sample_response)
+
+      @rubymail.domains.create(@sample[:domain])
+    end
+  end
+
+  describe "delete domain" do
+    it "should make a DELETE request with correct params" do
+      sample_response = "{\"message\": \"Domain has been deleted\"}"
+      domains_url = @rubymail.domains.send(:domain_url, @sample[:domain])
+
+      expect(Rubymail).to receive(:submit).
+        with(:delete, domains_url).
+        and_return(sample_response)
+
+      @rubymail.domains.delete(@sample[:domain])
+    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.rubymail.org\", \"name\": \"sample.rubymail.org\", \"smtp_password\": \"67bw67bz7w\", \"state\": \"active\"}, \"message\": \"Domain DNS records have been updated\", \"receiving_dns_records\": [], \"sending_dns_records\": []}"
+      verify_domain_url = "#{@rubymail.domains.send(:domain_url, @sample[:domain])}/verify"
+
+      expect(Rubymail).to receive(:submit)
+        .with(:put, verify_domain_url)
+        .and_return(sample_response)
+
+      @rubymail.domains.verify(@sample[:domain])
+    end
+  end
+end

data/spec/helpers/rubymail_helper.rb

@@ -0,0 +1,9 @@
+module RubymailHelper
+    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