mimi_mailer 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjQxOTk1ZTgxMDM4ZDU5NTdlNmNjMzk1MDVkZDhkYmVmMTY0Y2JmNQ==
+  data.tar.gz: !binary |-
+    M2NmNzZkNTkzYTBjNzFmODcwNGZlNDliNzg5MjljYzIxM2E2YmY3Yg==
+SHA512:
+  metadata.gz: !binary |-
+    ZjMwZjliODEzZDNkYmZjYWZhMTE0MDVhNDhlNjkyNDc4OTA4ZThmZGY4YjI1
+    MjEwMjgzMmFmY2NhNGFkNWE1MDc3YTYxYTg0M2VlMTBlYTk5ZDRlMWE0ZTZk
+    OGJkYTcwY2RkOGNlOWUyZjA1Zjk5NjUzZTY0NDRhZGRkYjI4NmQ=
+  data.tar.gz: !binary |-
+    Mjc5MDBjNjVlZWYwYTMxZGQxMmZlNGJhZDBhMDk5NmY2NGZlMzFmYzA3OWRi
+    NmQzMThhYmMyNGE3MDc5YzY0YjNlZGExN2YxZTE1OGFlMWU3OGYzMmMyYWFh
+    NjNjN2E1NzFjNWY3MWQ5N2Q2NjU1ZTRkY2Y0YTgyOWVkMWQ2OTI=

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.ruby-*
+*.sublime-*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.1.0
+
+* Added `bulk_mail`
+
+## 0.0.1
+
+* Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mimi_mailer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jeff Browning
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,127 @@
+# MimiMailer
+
+This gem provides a simple low-frills way to send transactional emails using the [Mad Mimi Mailer API](https://madmimi.com/developer/mailer/methods). If you need more, please check out our full-sized [madmimi gem](http://rubygems.org/gems/madmimi).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mimi_mailer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mimi_mailer
+
+## Usage
+
+If you aren't using bundler,
+
+```ruby
+require "mimi_mailer"
+```
+
+and then configure the mailer to use your Mad Mimi API settings.
+
+```ruby
+MimiMailer.configure do |config|
+  config.username = "you@example.com"
+  config.api_key  = "your_api_key"
+  config.default_from_address = "your default from address" # optional -- will use your username if not configured
+end
+```
+
+Then, create a mailer class that subclasses `MimiMailer::Base` and implements a delivery method like so:
+
+```ruby
+class UserWelcomeMailer < MimiMailer::Base
+  from_address 'someone@example.com' # A class-specific from address
+
+  def self.deliver(user)
+    mail(promotion_name: 'promotion_name', to: user.email, subject: "subject", body: { name: user.name })
+  end
+end
+
+```
+
+### MimiMailer::Base.mail
+
+`MimiMailer::Base.mail` accepts the following options:
+
+```ruby
+{
+  # Required. The name of the Mad Mimi promotion you want to send
+  promotion_name: 'promotion_name',
+
+  # Required. Who you want to send the email to. Also may be specified with :recipient.
+  to: 'someone@example.com',
+
+  # Who you want the email to be from. If not specified, this will fall back to the
+  # class-specific from address or the configured default_from_address
+  from: 'you@example.com',
+
+  # The subject of the email
+  subject: 'A nice email',
+
+  # Placeholders that will be merged into a composed promotion on Mad Mimi. :raw_html
+  # and/or :raw_plain_text may be specified instead (see below)
+  body: {
+    first_name: user.first_name,
+    last_name: user.last_name
+  }
+}
+```
+
+### MimiMailer::Base.bulk_mail
+
+`MimiMailer::Base.bulk_mail` accepts the following options:
+
+```ruby
+{
+  # Required. The name of the Mad Mimi promotion you want to send
+  promotion_name: 'promotion_name',
+
+  # Required. The name of the audience list to import into and send to.
+  audience_list: 'audience_list',
+
+  # Required. The email recipients list in CSV format. Also may be specified with :csv_file.
+  to: "email,first name,last name,car\ndave@example.com,Dave,Hoover,Ford\ncolin@example.com,Colin,Harris,Chevy",
+
+  # Who you want the email to be from. If not specified, this will fall back to the
+  # class-specific from address or the configured default_from_address
+  from: 'you@example.com',
+
+  # The subject of the email
+  subject: 'A nice email',
+
+  # Placeholders that will be merged into a composed promotion on Mad Mimi. :raw_html
+  # and/or :raw_plain_text may be specified instead (see below)
+  body: {
+    first_name: user.first_name,
+    last_name: user.last_name
+  }
+}
+```
+
+### Email body
+
+The email contents can be specified using **either**:
+
+`:body`
+
+The body hash contains keys and values that will be substituted into correspoding promotion placeholders.
+
+**or**
+
+`:raw_html`
+
+The raw HTML body of the email. May be used in conjunction with `:raw_plain_text`.
+
+`:raw_plain_text`
+
+The raw plain text body of the email. May be used in conjunction with `:raw_html`.
+
+Please take a look at our [transactional email API guide](https://madmimi.com/developer/mailer/transactional) for more information about these and other options.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mimi_mailer.rb

@@ -0,0 +1,31 @@
+require 'httparty'
+require "mimi_mailer/version"
+require 'mimi_mailer/base'
+require 'mimi_mailer/configuration'
+
+module MimiMailer
+  class InvalidConfigurationError < StandardError;end
+
+  extend self
+
+  def configure
+    raise ArgumentError.new("A block must be supplied") unless block_given?
+    yield config
+  end
+
+  def config
+    @config ||= MimiMailer::Configuration.new
+  end
+
+  def enable_deliveries!
+    config.deliveries_enabled = true
+  end
+
+  def disable_deliveries!
+    config.deliveries_enabled = false
+  end
+
+  def deliveries_enabled?
+    config.deliveries_enabled
+  end
+end

data/lib/mimi_mailer/base.rb

@@ -0,0 +1,74 @@
+module MimiMailer
+  class Base
+    include HTTParty
+    base_uri 'https://api.madmimi.com'
+
+    def self.from_address(new_address = nil)
+      if new_address.nil?
+        @from_address || MimiMailer.config.default_from_address || MimiMailer.config.username
+      else
+        @from_address = new_address
+      end
+    end
+
+    def self.deliver(*args)
+      raise NotImplementedError.new("#{self.class.name}.deliver must be overridden")
+    end
+
+    def self.mail(options = {})
+      if MimiMailer.deliveries_enabled?
+        check_config!
+
+        options = default_options.merge(options)
+        options[:recipient] = options.delete(:to) if options[:recipient].nil?
+        options[:body] = options[:body].to_yaml unless options[:body].nil?
+
+        mail_options_sanity_check! options
+
+        response = post('/mailer', body: options)
+
+        response.body.to_i
+      end
+    end
+
+    def self.bulk_mail(options = {})
+      if MimiMailer.deliveries_enabled?
+        check_config!
+
+        options = default_options.merge(options)
+        options[:csv_file] = options.delete(:to) if options[:csv_file].nil?
+        options[:body] = options[:body].to_yaml unless options[:body].nil?
+
+        bulk_mail_options_sanity_check! options
+
+        response = post('/mailer/to_imported_list', body: options)
+
+        response.body.to_i
+      end
+    end
+
+    def self.default_options
+      @default_options.merge(
+        username: MimiMailer.config.username,
+        api_key:  MimiMailer.config.api_key,
+        from:     from_address
+      )
+    end
+
+  protected
+    def self.check_config!
+      raise MimiMailer::InvalidConfigurationError unless MimiMailer.config.valid?
+    end
+
+    def self.mail_options_sanity_check!(options)
+      raise ArgumentError.new(":recipient or :to must be specified") if options[:recipient].nil?
+      raise ArgumentError.new(":promotion_name must be specified") if options[:promotion_name].nil?
+    end
+
+    def self.bulk_mail_options_sanity_check!(options)
+      raise ArgumentError.new(":csv_file or :to must be specified") if options[:csv_file].nil?
+      raise ArgumentError.new(":audience_list must be specified") if options[:audience_list].nil?
+      raise ArgumentError.new(":promotion_name must be specified") if options[:promotion_name].nil?
+    end
+  end
+end

data/lib/mimi_mailer/configuration.rb

@@ -0,0 +1,24 @@
+module MimiMailer
+  class Configuration < OpenStruct
+
+    REQUIRED_KEYS = %w(username api_key default_from_address deliveries_enabled)
+
+    def initialize(config = {})
+      default_config = {
+        username: nil,
+        api_key: nil,
+        default_from_address: nil,
+        deliveries_enabled: true
+      }
+
+      config = default_config.merge(config)
+
+      super config
+    end
+
+    def valid?
+      REQUIRED_KEYS.each { |key| return false if send(key.to_sym).nil? }
+      true
+    end
+  end
+end

data/lib/mimi_mailer/version.rb

@@ -0,0 +1,3 @@
+module MimiMailer
+  VERSION = "0.1.0"
+end

data/mimi_mailer.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mimi_mailer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mimi_mailer"
+  spec.version       = MimiMailer::VERSION
+  spec.authors       = ["Jeff Browning"]
+  spec.email         = ["jeff@jkbrowning.com"]
+  spec.summary       = %q{A stripped-down way to interact with the Mimi mailer API}
+  spec.description   = %q{This gem is unsupported. Use at your own risk. :)}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.files                 = `git ls-files`.split($/)
+  spec.executables           = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files            = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths         = ["lib"]
+
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "bundler", "~> 1.2"
+  spec.add_development_dependency "rake"
+end

data/spec/mimi_mailer/base_spec.rb

@@ -0,0 +1,378 @@
+require 'spec_helper'
+
+describe MimiMailer::Base do
+  let(:promotion_name) { "kittens" }
+  let(:email_subject) { "omg kittens" }
+  let(:body) { { cats: "rule", dogs: "drool" } }
+  let(:username) { "cats@themansion.org" }
+  let(:api_key)  { "apikey" }
+  let(:default_from) { "catsinthecradle@themansion.com" }
+
+  subject { MimiMailer::Base }
+
+  describe ".deliver" do
+    class TestMailer < MimiMailer::Base; end
+
+    subject { TestMailer }
+
+    it "raies an error if not implemented" do
+      expect {
+        subject.deliver
+      }.to raise_error(NotImplementedError, /overridden/i)
+    end
+  end
+
+  describe ".mail" do
+    let(:to_address) { "dog@thepound.org" }
+    let(:endpoint) { "https://api.madmimi.com/mailer" }
+    let(:default_options) {
+      {
+        promotion_name: promotion_name,
+        to: to_address,
+        from: default_from,
+        subject: email_subject
+      }
+    }
+
+    before do
+      stub_request(:post, "https://api.madmimi.com/mailer")
+      MimiMailer.config.stub(
+        username: username, api_key: api_key, default_from_address: default_from)
+      MimiMailer.stub(deliveries_enabled?: true)
+      subject.stub(from_address: default_from)
+    end
+
+    it "raises an error if the config is not valid" do
+      MimiMailer.config.stub(valid?: false)
+      expect {
+        subject.mail(default_options)
+      }.to raise_error(MimiMailer::InvalidConfigurationError)
+    end
+
+    it "raises an error if :to is not specified" do
+      default_options.delete(:to)
+      expect {
+        subject.mail(default_options)
+      }.to raise_error(ArgumentError, /to.+specified/i)
+    end
+
+    it "raises an error if :promotion_name is not specified" do
+      default_options.delete(:promotion_name)
+      expect {
+        subject.mail(default_options)
+      }.to raise_error(ArgumentError, /promotion_name.+specified/i)
+    end
+
+    it "posts to the correct API endpoint" do
+      subject.mail(default_options)
+      expect(a_request(:post, endpoint)).to have_been_requested
+    end
+
+    it "passes in the correct the username" do
+      request = stub_request(:post, endpoint).with(
+        body: hash_including(username: username))
+
+      subject.mail(default_options)
+      expect(request).to have_been_requested
+    end
+
+    it "passes in the correct the api_key" do
+      request = stub_request(:post, endpoint).with(
+        body: hash_including(api_key: api_key))
+
+      subject.mail(default_options)
+      expect(request).to have_been_requested
+    end
+
+    it "passes in the right subject" do
+      request = stub_request(:post, endpoint).with(
+        body: hash_including(subject: email_subject))
+
+      subject.mail(default_options)
+      expect(request).to have_been_requested
+    end
+
+    it "passes in the right promotion name" do
+      request = stub_request(:post, endpoint).with(
+        body: hash_including(promotion_name: promotion_name))
+
+      subject.mail(default_options)
+      expect(request).to have_been_requested
+    end
+
+    it "passes in the right recipient" do
+      request = stub_request(:post, endpoint).with(
+        body: hash_including(recipient: to_address))
+
+      subject.mail(default_options)
+      expect(request).to have_been_requested
+    end
+
+    context "when it contains a :body parameter" do
+      let(:options) { default_options.merge(body: body) }
+
+      it "passes in the yaml-converted body" do
+        expected_body = body.to_yaml
+
+        request = stub_request(:post, endpoint).with(
+          body: hash_including(body: expected_body))
+
+        subject.mail(options)
+        expect(request).to have_been_requested
+      end
+    end
+
+    context "when it contains a :raw_plain_text parameter" do
+      let(:raw_plain_text) { "Cameron the cat would never miss a trick" }
+      let(:options) { default_options.merge(raw_plain_text: raw_plain_text) }
+
+      it "passes in the unmodified body" do
+        request = stub_request(:post, endpoint).with(
+          body: hash_including(raw_plain_text: raw_plain_text))
+
+        subject.mail(options)
+        expect(request).to have_been_requested
+      end
+    end
+
+    context "when it contains a :raw_html parameter" do
+      let(:raw_html) { "<h1>OMG KITTENS</h1>" }
+      let(:options) { default_options.merge(raw_html: raw_html) }
+
+      it "passes in the unmodified body" do
+        request = stub_request(:post, endpoint).with(
+          body: hash_including(raw_html: raw_html))
+
+        subject.mail(options)
+        expect(request).to have_been_requested
+      end
+    end
+
+    it "returns the Mimi transaction ID" do
+      transaction_id = rand(1000)
+      stub_request(:post, endpoint).to_return(
+        body: transaction_id.to_s)
+
+      result = subject.mail(default_options)
+      expect(result).to eql(transaction_id)
+    end
+
+    it "passes in the right from address" do
+      request = stub_request(:post, endpoint).with(
+        body: hash_including(from: default_from))
+
+      subject.mail(default_options)
+      expect(request).to have_been_requested
+    end
+
+    context "when deliveries are disabled" do
+      before { MimiMailer.stub(deliveries_enabled?: false) }
+
+      it "does not post anything" do
+        request = stub_request(:post, endpoint)
+        subject.mail(default_options)
+        expect(request).to_not have_been_requested
+      end
+    end
+  end
+
+  describe ".bulk_mail" do
+    let(:audience_list) { "kittens lovers" }
+    let(:csv_file) { "email,first name,last name\ntomcat@example.com,Tom,Cat\nbigdog@example.com,Big,Dog" }
+    let(:endpoint) { "https://api.madmimi.com/mailer/to_imported_list" }
+    let(:default_options) {
+      {
+        audience_list: audience_list,
+        promotion_name: promotion_name,
+        to: csv_file,
+        from: default_from,
+        subject: email_subject
+      }
+    }
+
+    before do
+      stub_request(:post, endpoint)
+      MimiMailer.config.stub(
+        username: username, api_key: api_key, default_from_address: default_from)
+      MimiMailer.stub(deliveries_enabled?: true)
+      subject.stub(from_address: default_from)
+    end
+
+    it "raises an error if the config is not valid" do
+      MimiMailer.config.stub(valid?: false)
+      expect {
+        subject.bulk_mail(default_options)
+      }.to raise_error(MimiMailer::InvalidConfigurationError)
+    end
+
+    it "raises an error if :to is not specified" do
+      default_options.delete(:to)
+      expect {
+        subject.bulk_mail(default_options)
+      }.to raise_error(ArgumentError, /to.+specified/i)
+    end
+
+    it "raises an error if :promotion_name is not specified" do
+      default_options.delete(:promotion_name)
+      expect {
+        subject.bulk_mail(default_options)
+      }.to raise_error(ArgumentError, /promotion_name.+specified/i)
+    end
+
+    it "raises an error if :audience_list is not specified" do
+      default_options.delete(:audience_list)
+      expect {
+        subject.bulk_mail(default_options)
+      }.to raise_error(ArgumentError, /audience_list.+specified/i)
+    end
+
+    it "posts to the correct API endpoint" do
+      subject.bulk_mail(default_options)
+      expect(a_request(:post, endpoint)).to have_been_requested
+    end
+
+    it "passes in the correct the username" do
+      request = stub_request(:post, endpoint).with(
+        body: hash_including(username: username))
+
+      subject.bulk_mail(default_options)
+      expect(request).to have_been_requested
+    end
+
+    it "passes in the correct the api_key" do
+      request = stub_request(:post, endpoint).with(
+        body: hash_including(api_key: api_key))
+
+      subject.bulk_mail(default_options)
+      expect(request).to have_been_requested
+    end
+
+    it "passes in the right subject" do
+      request = stub_request(:post, endpoint).with(
+        body: hash_including(subject: email_subject))
+
+      subject.bulk_mail(default_options)
+      expect(request).to have_been_requested
+    end
+
+    it "passes in the right promotion name" do
+      request = stub_request(:post, endpoint).with(
+        body: hash_including(promotion_name: promotion_name))
+
+      subject.bulk_mail(default_options)
+      expect(request).to have_been_requested
+    end
+
+    it "passes in the right csv file" do
+      request = stub_request(:post, endpoint).with(
+        body: hash_including(csv_file: csv_file))
+
+      subject.bulk_mail(default_options)
+      expect(request).to have_been_requested
+    end
+
+    context "when it contains a :body parameter" do
+      let(:options) { default_options.merge(body: body) }
+
+      it "passes in the yaml-converted body" do
+        expected_body = body.to_yaml
+
+        request = stub_request(:post, endpoint).with(
+          body: hash_including(body: expected_body))
+
+        subject.bulk_mail(options)
+        expect(request).to have_been_requested
+      end
+    end
+
+    context "when it contains a :raw_plain_text parameter" do
+      let(:raw_plain_text) { "Cameron the cat would never miss a trick" }
+      let(:options) { default_options.merge(raw_plain_text: raw_plain_text) }
+
+      it "passes in the unmodified body" do
+        request = stub_request(:post, endpoint).with(
+          body: hash_including(raw_plain_text: raw_plain_text))
+
+        subject.bulk_mail(options)
+        expect(request).to have_been_requested
+      end
+    end
+
+    context "when it contains a :raw_html parameter" do
+      let(:raw_html) { "<h1>OMG KITTENS</h1>" }
+      let(:options) { default_options.merge(raw_html: raw_html) }
+
+      it "passes in the unmodified body" do
+        request = stub_request(:post, endpoint).with(
+          body: hash_including(raw_html: raw_html))
+
+        subject.bulk_mail(options)
+        expect(request).to have_been_requested
+      end
+    end
+
+    it "returns the Mimi transaction ID" do
+      transaction_id = rand(1000)
+      stub_request(:post, endpoint).to_return(
+        body: transaction_id.to_s)
+
+      result = subject.bulk_mail(default_options)
+      expect(result).to eql(transaction_id)
+    end
+
+    it "passes in the right from address" do
+      request = stub_request(:post, endpoint).with(
+        body: hash_including(from: default_from))
+
+      subject.bulk_mail(default_options)
+      expect(request).to have_been_requested
+    end
+
+    context "when deliveries are disabled" do
+      before { MimiMailer.stub(deliveries_enabled?: false) }
+
+      it "does not post anything" do
+        request = stub_request(:post, endpoint)
+        subject.bulk_mail(default_options)
+        expect(request).to_not have_been_requested
+      end
+    end
+  end
+
+  describe ".from_address" do
+    class MailerWithFromAddress < MimiMailer::Base
+      from_address 'tomcat@example.com'
+    end
+
+    class MailerWithOtherFromAddress < MimiMailer::Base
+      from_address 'harrycat@example.com'
+    end
+
+    class MailerWithoutFromAddress < MimiMailer::Base
+    end
+
+    let(:default_from) { 'socks@whitehouse.gov' }
+
+    before { MimiMailer.config.stub(default_from_address: default_from) }
+
+    it "sets and returns the configured class from address" do
+      expect(MailerWithFromAddress.from_address).to eql('tomcat@example.com')
+    end
+
+    it "returns the default from address if the class doesn't have its own" do
+      expect(MailerWithoutFromAddress.from_address).to eql(default_from)
+    end
+
+    it "does not return another class' email address" do
+      expect(MailerWithFromAddress.from_address).to eql('tomcat@example.com')
+      expect(MailerWithOtherFromAddress.from_address).to eql('harrycat@example.com')
+    end
+
+    it "returns the username if default_from_address is not configured" do
+      username = "kittycat@example.com"
+      MimiMailer.config.unstub(:default_from_address)
+      MimiMailer.config.stub(username: username)
+      expect(MailerWithoutFromAddress.from_address).to eql(username)
+    end
+  end
+end

data/spec/mimi_mailer/configuration_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe MimiMailer::Configuration do
+  describe "value setting and retrieval" do
+    subject { MimiMailer::Configuration.new }
+
+    it "works with method syntax" do
+      username = "user@example.com"
+      subject.username = username
+      expect(subject.username).to eql(username)
+    end
+
+    it "works when setting initial values on initialization" do
+      username = "user@example.com"
+      subject = MimiMailer::Configuration.new(username: username)
+      expect(subject.username).to eql(username)
+    end
+  end
+
+  describe "valid?" do
+    context "valid config" do
+      subject { MimiMailer::Configuration.new(username: "user@example.com",
+                                              api_key: "key",
+                                              default_from_address: "addy@example.com") }
+
+      it "returns true if all required config is set" do
+        expect(subject.valid?).to be_true
+      end
+    end
+
+    context "invalid config" do
+      subject { MimiMailer::Configuration.new }
+
+      it "returns false if a required option is not set" do
+        expect(subject.valid?).to be_false
+      end
+    end
+  end
+end

data/spec/mimi_mailer_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe MimiMailer do
+  context 'configuration' do
+    describe '.configure' do
+      it "raises an error if a block is not supplied" do
+        expect {
+          MimiMailer.configure
+        }.to raise_error(ArgumentError)
+      end
+
+      it "yeilds a MimiMailer::Configuration object" do
+        expect { |b|
+          MimiMailer.configure(&b)
+        }.to yield_with_args(MimiMailer::Configuration)
+      end
+    end
+
+    describe ".config" do
+      it "returns a MimiMailer::Configuration object" do
+        expect(MimiMailer.config).to be_a(MimiMailer::Configuration)
+      end
+
+      it "returns the same MimiMailer::Configuration object on subsequent calls" do
+        config = MimiMailer.config
+        expect(MimiMailer.config).to equal(config)
+      end
+    end
+
+    describe ".enable_deliveries!" do
+      it "sets MimiMailer.config.deliveries_enabled to true" do
+        MimiMailer.config.deliveries_enabled = false
+        expect {
+          MimiMailer.enable_deliveries!
+        }.to change { MimiMailer.config.deliveries_enabled }.to(true)
+      end
+    end
+
+    describe ".disable_deliveries!" do
+      it "sets MimiMailer.config.deliveries_enabled to false" do
+        MimiMailer.config.deliveries_enabled = true
+        expect {
+          MimiMailer.disable_deliveries!
+        }.to change { MimiMailer.config.deliveries_enabled }.to(false)
+      end
+    end
+
+    describe ".deliveries_enabled?" do
+      it "defers to config.deliveries_enabled" do
+        MimiMailer.config.should_receive(:deliveries_enabled)
+        MimiMailer.deliveries_enabled?
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'webmock/rspec'
+require 'mimi_mailer'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: mimi_mailer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Browning
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is unsupported. Use at your own risk. :)
+email:
+- jeff@jkbrowning.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mimi_mailer.rb
+- lib/mimi_mailer/base.rb
+- lib/mimi_mailer/configuration.rb
+- lib/mimi_mailer/version.rb
+- mimi_mailer.gemspec
+- spec/mimi_mailer/base_spec.rb
+- spec/mimi_mailer/configuration_spec.rb
+- spec/mimi_mailer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A stripped-down way to interact with the Mimi mailer API
+test_files:
+- spec/mimi_mailer/base_spec.rb
+- spec/mimi_mailer/configuration_spec.rb
+- spec/mimi_mailer_spec.rb
+- spec/spec_helper.rb