mailgun-ruby 1.0.0

data/spec/integration/messages/sample_data/mime.txt

@@ -0,0 +1,38 @@
+X-SBRS: 5.6
+X-SenderGroup: WHITELIST
+X-MailFlowPolicy: $TRUSTED
+DKIM-Signature: a=rsa-sha256; v=1; c=relaxed/relaxed; d=trstx.com; q=dns/txt; s=mx;
+ t=1381182797; h=Mime-Version: Content-Type: Subject: From: To:
+ Message-Id: Date: Sender: Content-Transfer-Encoding;
+ bh=r6P1omjKL3m7gDuZC6dZEJU6trgWm1IRwAJb8h4wtfg=; b=UPFaFGiuDx2yZjCmiMEji0fIXvGMNwXUsuaX4Ss9p5EUkqE25eYjeJaJZ5w5FK+t0jsUPZqu
+ FIH6sftQv7GBEbSktY6sv7dgv5q2yVlY8YNG7CXvUZdWmvwfQVvfL9j1RHJo9H3QpXT9c8bZ
+ p9rpYmqZtZEz2ZesPj4kzUaB0lU=
+DomainKey-Signature: a=rsa-sha1; c=nofws; d=trstx.com; s=mx; q=dns;
+ h=Mime-Version: Content-Type: Subject: From: To: Message-Id: Date:
+ Sender: Content-Transfer-Encoding;
+ b=QUYQf9OP16DphNAjeF95+G7V6DaqL4FA+m1sjIEWHdLzrGTQkiYTpzJdne3lzSypB0DwaG
+ AT9zOhjjN64DWFOkJD2Ce5t6vfHa/GC3FCUMq3xz/Big94g+kOciawkHyUhCrmPyh/D7kWx1
+ J75UIAdmE9XQ9bCSPhZ2MRaOv7b8c=
+Received: by luna.mailgun.net with HTTP; Mon, 07 Oct 2013 21:53:16 +0000
+Content-Type: text/plain; charset="ascii"
+Subject: Test Subject
+From: <joe@example.com>
+To: <bob@sample.com>
+Message-ID: <20131007215316.27052.7818@example.com>
+X-Mailgun-Sid: WyI4MzY1OSIsICJ0cmF2aXMuc3dpZW50ZWtAcmFja3NwYWasdfewNvbSIsICJjZjQ4Il0=
+Date: Mon, 7 Oct 2013 21:53:17 +0000
+Sender: <joe@example.com>
+Content-Transfer-Encoding: 7bit
+MIME-Version: 1.0
+
+--3a8c26e9f23c4ac193606295aa17fa6f
+Content-Type: text/plain; charset="ascii"
+Content-Transfer-Encoding: 7bit
+
+Testing some Mailgun awesomness!
+--3a8c26e9f23c4ac193606295aa17fa6f
+Content-Type: text/html; charset="ascii"
+Content-Transfer-Encoding: 7bit
+
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">Test
+--3a8c26e9f23c4ac193606295aa17fa6f--

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'bundler'
+require 'bundler/setup'
+Bundler.setup(:development)
+require 'mailgun'
+require_relative 'unit/connection/test_client'
+
+# INSERT YOUR API KEYS HERE
+APIKEY = "key"
+PUB_APIKEY = "pubkey"
+APIHOST = "api.mailgun.net"
+APIVERSION = "v2"
+SSL= true

data/spec/unit/connection/test_client.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+require "time"
+require "json"
+
+module Mailgun
+  class UnitClient
+
+    attr_reader :url, :options, :block, :body, :code
+
+    def initialize(url, options={}, backwards_compatibility=nil, &block)
+      @url = url
+      @block = block
+      @options = options
+      @body = nil
+      @code = nil
+    end
+
+    def [](resource_path, &new_block)
+      case
+      when block_given? then self.class.new(resource_path, options, &new_block)
+      when block        then self.class.new(resource_path, options, &block)
+      else
+        self.class.new(resource_path, options)
+      end
+    end
+
+    def post(options)
+      begin
+        response = response_generator("messages")
+        Response.new(response)
+      rescue Exception => e
+        raise CommunicationError.new(e), e.response
+      end
+    end
+
+    def get(options, query_string = nil)
+      begin
+        if query_string
+
+          response = response_generator("bounces")
+        else
+          response = response_generator("bounces")
+        end
+        Response.new(response)
+      rescue Exception => e
+        raise CommunicationError.new(e), e.response
+      end
+    end
+
+    def put(options)
+      begin
+        response = response_generator("lists")
+        Response.new(response)
+      rescue Exception => e
+        raise CommunicationError.new(e), e.response
+      end
+    end
+
+    def delete()
+      begin
+        response = response_generator("campaigns")
+        Response.new(response)
+      rescue Exception => e
+        raise CommunicationError.new(e), e.response
+      end
+    end
+
+    private
+
+    def response_generator(resource_endpoint)
+      case resource_endpoint
+      when "messages"
+        t = Time.now
+        id = "<#{t.to_i}.#{rand(99999999)}.5817@example.com>"
+        @body = JSON.generate({"message" => "Queued. Thank you.", "id" => id})
+      when "bounces"
+        @body = JSON.generate({"total_count" => 1, "items" => {"created_at" => "Fri, 21 Oct 2011 11:02:55 GMT", "code" => 550, "address" => "baz@example.com", "error" => "Message was not accepted -- invalid mailbox. Local mailbox baz@example.com is unavailable: user not found"}})
+      when "lists"
+        @body = JSON.generate({"member" => {"vars" => {"age" => 26}, "name" => "Foo Bar", "subscribed" => false, "address" => "bar@example.com"}, "message" => "Mailing list member has been updated"})
+      when "campaigns"
+        @body = JSON.generate({"message" => "Campaign has been deleted", "id" => "ABC123"})
+      end
+      self
+    end
+  end
+
+  class Response
+
+    attr_accessor :body
+
+    def initialize(response)
+      @body = response.body
+    end
+
+    # Return response as Ruby Hash
+    #
+    # @return [Hash] A standard Ruby Hash containing the HTTP result.
+
+    def to_hash
+      begin
+        JSON.parse(@body)
+      rescue Exception => e
+        raise ParseError.new(e), e
+      end
+    end
+
+    # Replace @body with Ruby Hash
+    #
+    # @return [Hash] A standard Ruby Hash containing the HTTP result.
+
+    def to_hash!
+      begin
+        @body = JSON.parse(@body)
+      rescue Exception => e
+        raise ParseError.new(e), e
+      end
+    end
+
+    # Return response as Yaml
+    #
+    # @return [String] A string containing response as YAML
+
+    def to_yaml
+      begin
+        YAML::dump(JSON.parse(@body))
+      rescue Exception => e
+        raise ParseError.new(e), e
+      end
+    end
+
+    # Replace @body with YAML
+    #
+    # @return [String] A string containing response as YAML
+
+    def to_yaml!
+      begin
+        @body = YAML::dump(JSON.parse(@body))
+      rescue Exception => e
+        raise ParseError.new(e), e
+      end
+    end
+  end
+end

data/spec/unit/lists/opt_in_handler_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'The method generate_hash' do
+  before(:each) do
+    @mailing_list = "mylist@example.com"
+    @secret_app_id = "mysupersecretpassword"
+    @recipient_address = "bob@example.com"
+    @precalculated_hash = "eyJzIjoiNDc4ZjVlM2M0MWQyNDdlZGQ2NDMzYzdkZTRjOTg3MTYiLCJsIjoi%0AbXlsaXN0QGV4YW1wbGUuY29tIiwiciI6ImJvYkBleGFtcGxlLmNvbSJ9%0A"
+  end
+
+  it 'generates a web safe hash for the recipient wishing to subscribe' do
+    my_hash = Mailgun::OptInHandler.generate_hash(@mailing_list, @secret_app_id, @recipient_address)
+    my_hash.should eq(@precalculated_hash)
+  end
+
+  it 'generates a web safe hash for the recipient wishing to subscribe' do
+    validate_result = Mailgun::OptInHandler.validate_hash(@secret_app_id, @precalculated_hash)
+    validate_result.length.should eq(2)
+    validate_result['recipient_address'].should eq(@recipient_address)
+    validate_result['mailing_list'].should eq(@mailing_list)
+  end
+end

data/spec/unit/mailgun_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+module Mailgun
+  class Client
+    def initialize(api_key, api_host="api.mailgun.net", api_version="v2")
+      @http_client = Mailgun::UnitClient::new(api_key, api_host, api_version)
+    end
+  end
+end
+
+describe 'Mailgun instantiation' do
+  it 'instantiates an HttpClient object' do
+    expect {@mg_obj = Mailgun::Client.new("Fake-API-Key")}.not_to raise_error
+  end
+end
+
+describe 'The method send_message()' do
+  before(:each) do
+    @mg_obj = Mailgun::Client.new("Fake-API-Key")
+    @domain = "test.com"
+    @list_address = "mylist@test.com"
+    @member_address = "subscribee@test.com"
+  end
+
+  it 'accepts only specific data types' do
+    @mb_obj = Mailgun::MessageBuilder.new()
+    @mm_obj = Multimap.new()
+    @mh_obj = {}
+
+    expect {@mg_obj.send_message("test.com", "incorrect data")}.to raise_error
+    expect {@mg_obj.send_message("test.com", @mb_obj)}.not_to raise_error
+    expect {@mg_obj.send_message("test.com", @mm_obj)}.not_to raise_error
+    expect {@mg_obj.send_message("test.com", @mh_obj)}.not_to raise_error
+  end
+
+  it 'sends a message' do
+    data = {'from' => 'joe@test.com',
+                    'to' => 'bob@example.com',
+                    'subject' => 'Test',
+                    'text' => 'Test Data'}
+    result = @mg_obj.send_message("testdomain.com", data)
+
+    result.to_hash!
+    result.body.should include("message")
+    result.body.should include("id")
+  end
+
+  it 'opens the message MIME and sends the MIME message.' do
+    data = {'to' => 'joe@test.com',
+                    'message' => 'Sample Data/mime.txt'}
+    result = @mg_obj.send_message("testdomain.com", data)
+
+    result.to_hash!
+    result.body.should include("message")
+    result.body.should include("id")
+  end
+end
+
+describe 'The method post()' do
+  before(:each) do
+    @mg_obj = Mailgun::Client.new("Fake-API-Key")
+    @domain = "test.com"
+  end
+  it 'in this case, sends a simple message.' do
+    data = {'from' => 'joe@test.com',
+                    'to' => 'bob@example.com',
+                    'subject' => 'Test',
+                    'text' => 'Test Data'}
+    result = @mg_obj.post("#{@domain}/messages", data)
+
+    result.to_hash!
+    result.body.should include("message")
+    result.body.should include("id")
+  end
+end
+
+describe 'The method put()' do
+  before(:each) do
+    @mg_obj = Mailgun::Client.new("Fake-API-Key")
+    @domain = "test.com"
+    @list_address = "mylist@test.com"
+    @member_address = "subscribee@test.com"
+  end
+
+  it 'in this case, updates a member with the attributes in data.' do
+    data = {'subscribed' => false,
+                    'name' => 'Foo Bar'}
+    result = @mg_obj.put("lists/#{@list_address}/members#{@member_address}", data)
+
+    result.to_hash!
+    result.body.should include("member")
+    result.body["member"].should include("vars")
+    result.body["member"]["vars"].should include("age")
+    result.body["member"].should include("name")
+    result.body["member"].should include("subscribed")
+    result.body["member"].should include("address")
+    result.body.should include("message")
+  end
+
+end
+
+describe 'The method get()' do
+  before(:each) do
+    @mg_obj = Mailgun::Client.new("Fake-API-Key")
+    @domain = "test.com"
+  end
+  it 'in this case, obtains a list of bounces for the domain, limit of 5, skipping the first 10.' do
+    query_string = {'skip' => '10',
+                    'limit' => '5'}
+    result = @mg_obj.get("#{@domain}/bounces", query_string)
+
+    result.to_hash!
+    result.body.should include("total_count")
+    result.body.should include("items")
+  end
+end
+
+describe 'The method delete()' do
+  before(:each) do
+    @mg_obj = Mailgun::Client.new("Fake-API-Key")
+    @domain = "test.com"
+  end
+
+  it 'issues a generic delete request.' do
+    result = @mg_obj.delete("#{@domain}/campaigns/ABC123")
+
+    result.to_hash!
+    result.body.should include("message")
+    result.body.should include("id")
+  end
+end

data/spec/unit/messages/batch_message_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+
+module Mailgun
+  class Client
+    def initialize(api_key, api_host="api.mailgun.net", api_version="v2")
+      @http_client = UnitClient::new(api_key, api_host, api_version)
+    end
+  end
+end
+
+describe 'BatchMessage attribute readers' do
+  it 'should be readable' do
+    @mb_client = Mailgun::Client.new("My-Fake-API-Key")
+    @mb_obj = Mailgun::BatchMessage.new(@mb_client, "example.com")
+    @mb_obj.should respond_to(:message_ids)
+    @mb_obj.should respond_to(:message)
+    @mb_obj.should respond_to(:counters)
+    @mb_obj.should respond_to(:recipient_variables)
+    @mb_obj.should respond_to(:domain)
+  end
+end
+
+describe 'The instantiation of Batch Message' do
+
+  before(:each) do
+    @mb_client = Mailgun::Client.new("My-Fake-API-Key")
+    @mb_obj = Mailgun::BatchMessage.new(@mb_client, "example.com")
+  end
+
+  it 'contains Message, which should be of type Multimap and empty' do
+    @mb_obj.message.should be_a(Multimap)
+    @mb_obj.message.length.should eq(0)
+  end
+
+  it 'contains recipient_variables, which should be of type Hash and empty' do
+    @mb_obj.recipient_variables.should be_a(Hash)
+    @mb_obj.recipient_variables.length.should eq(0)
+  end
+
+  it 'contains domain, which should be of type string and contain example.com' do
+    @mb_obj.domain.should be_a(String)
+    @mb_obj.domain.should eq('example.com')
+  end
+
+  it 'contains message_ids, which should be of type hash and empty' do
+    @mb_obj.message_ids.should be_a(Hash)
+    @mb_obj.message_ids.length.should eq(0)
+  end
+
+  it 'contains counters, which should be of type hash and contain several important counters' do
+    @mb_obj.counters.should be_a(Hash)
+    @mb_obj.counters.should include(:recipients)
+  end
+
+  it 'contains counters, which should be of type hash and contain several important counters' do
+    @mb_obj.counters.should be_a(Hash)
+
+    @mb_obj.counters.should include(:recipients)
+    @mb_obj.counters[:recipients].should include(:to)
+    @mb_obj.counters[:recipients].should include(:cc)
+    @mb_obj.counters[:recipients].should include(:bcc)
+
+    @mb_obj.counters.should include(:attributes)
+    @mb_obj.counters[:attributes].should include(:attachment)
+    @mb_obj.counters[:attributes].should include(:campaign_id)
+    @mb_obj.counters[:attributes].should include(:custom_option)
+    @mb_obj.counters[:attributes].should include(:tag)
+  end
+end
+
+describe 'The method add_recipient' do
+  before(:each) do
+    @mb_client = Mailgun::Client.new("My-Fake-API-Key")
+    @mb_obj = Mailgun::BatchMessage.new(@mb_client, "example.com")
+    @address_1   = 'jane@example.com'
+    @variables_1 = {'first' => 'Jane', 'last' => 'Doe', 'tracking' => 'ABC123'}
+    @address_2   = 'bob@example.com'
+    @variables_2 = {'first' => 'Bob', 'last' => 'Doe', 'tracking' => 'DEF123'}
+    @address_3   = 'sam@example.com'
+    @variables_3 = {'first' => 'Sam', 'last' => 'Doe', 'tracking' => 'GHI123'}
+  end
+
+  it 'adds 1,000 recipients to the message body and validates counter is incremented then reset' do
+    recipient_type = :to
+    1000.times do
+      @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+    end
+    @mb_obj.counters[:recipients][recipient_type].should eq(1000)
+    @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+    @mb_obj.counters[:recipients][recipient_type].should eq(1)
+  end
+
+  it 'adds recipients to the message, calls finalize, and cleans up' do
+    recipient_type = :to
+    1000.times do
+      @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+    end
+    @mb_obj.counters[:recipients][recipient_type].should eq(1000)
+    @mb_obj.finalize
+    @mb_obj.message['recipient-variables'].length.should eq(0)
+    @mb_obj.message[:to].length.should eq(0)
+    @mb_obj.counters[:recipients][recipient_type].should eq(0)
+  end
+
+  it 'adds 5,005 recipients to the message body and validates we receive message_ids back' do
+    recipient_type = :to
+    5005.times do
+      @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+    end
+    @mb_obj.finalize
+    @mb_obj.message_ids.length.should eq(6)
+  end
+
+  it 'sets recipient-variables, for batch expansion' do
+    recipient_type = :to
+    @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+    @mb_obj.recipient_variables[@address_1].should eq(@variables_1)
+  end
+
+  it 'sets multiple recipient-variables, for batch expansion' do
+    recipient_type = :to
+    @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+    @mb_obj.add_recipient(recipient_type, @address_2, @variables_2)
+    @mb_obj.add_recipient(recipient_type, @address_3, @variables_3)
+    @mb_obj.recipient_variables[@address_1].should eq(@variables_1)
+    @mb_obj.recipient_variables[@address_2].should eq(@variables_2)
+    @mb_obj.recipient_variables[@address_3].should eq(@variables_3)
+  end
+
+end