mailgunner 1.0.0

data/README.md

@@ -0,0 +1,45 @@
+A Ruby wrapper for the [Mailgun API](http://documentation.mailgun.net/api_reference.html)
+=========================================================================================
+
+
+Quick Start
+-----------
+
+```ruby
+require 'mailgunner'
+
+mailgun = Mailgunner::Client.new(domain: 'samples.mailgun.org', api_key: 'key-3ax6xnjp29jd6fds4gc373sgvjxteol0')
+
+response = mailgun.get_stats(limit: 5)
+
+if response.ok?
+  # do something with response.object
+else
+  # handle client/server error
+end
+```
+
+
+Alternative JSON Implementations
+--------------------------------
+
+Mailgunner::Client defaults to using the "json" library which is available
+in the Ruby 1.9 standard library, and as a gem for Ruby 1.8. You can specify
+an alternative implementation using the json option when constructing a client
+object. For example, to use [multi_json](https://rubygems.org/gems/multi_json):
+
+```ruby
+mailgun = Mailgunner::Client.new(:json => MultiJson)
+```
+
+
+Environment Variables
+---------------------
+
+Best practice for storing credentials for external services is to use environment
+variables, as described by [12factor.net/config](http://www.12factor.net/config).
+
+Mailgunner::Client defaults to extracting the domain and api_key values it needs
+from the MAILGUN_API_KEY and MAILGUN_SMTP_LOGIN environment variables. These will
+exist if you are using Mailgun on Heroku, or you can set them manually.
+

data/lib/mailgunner.rb

@@ -0,0 +1,300 @@
+require 'net/http'
+require 'json'
+require 'cgi'
+require 'uri'
+
+module Mailgunner
+  class Client
+    attr_accessor :domain, :api_key, :json, :http
+
+    def initialize(options = {})
+      @domain = options.fetch(:domain) { ENV.fetch('MAILGUN_SMTP_LOGIN').split('@').last }
+
+      @api_key = options.fetch(:api_key) { ENV.fetch('MAILGUN_API_KEY') }
+
+      @json = options.fetch(:json) { JSON }
+
+      @http = Net::HTTP.new('api.mailgun.net', Net::HTTP.https_default_port)
+
+      @http.use_ssl = true
+    end
+
+    def send_message(attributes = {})
+      post("/v2/#{escape @domain}/messages", attributes)
+    end
+
+    def get_domains(params = {})
+      get('/v2/domains', params)
+    end
+
+    def get_domain(name)
+      get("/v2/domains/#{escape name}")
+    end
+
+    def add_domain(attributes = {})
+      post('/v2/domains', attributes)
+    end
+
+    def get_unsubscribes(params = {})
+      get("/v2/#{escape @domain}/unsubscribes", params)
+    end
+
+    def get_unsubscribe(address)
+      get("/v2/#{escape @domain}/unsubscribes/#{escape address}")
+    end
+
+    def delete_unsubscribe(address_or_id)
+      delete("/v2/#{escape @domain}/unsubscribes/#{escape address_or_id}")
+    end
+
+    def add_unsubscribe(attributes = {})
+      post("/v2/#{escape @domain}/unsubscribes", attributes)
+    end
+
+    def get_complaints(params = {})
+      get("/v2/#{escape @domain}/complaints", params)
+    end
+
+    def get_complaint(address)
+      get("/v2/#{escape @domain}/complaints/#{escape address}")
+    end
+
+    def add_complaint(attributes = {})
+      post("/v2/#{escape @domain}/complaints", attributes)
+    end
+
+    def delete_complaint(address)
+      delete("/v2/#{escape @domain}/complaints/#{escape address}")
+    end
+
+    def get_bounces(params = {})
+      get("/v2/#{escape @domain}/bounces", params)
+    end
+
+    def get_bounce(address)
+      get("/v2/#{escape @domain}/bounces/#{escape address}")
+    end
+
+    def add_bounce(attributes = {})
+      post("/v2/#{escape @domain}/bounces", attributes)
+    end
+
+    def delete_bounce(address)
+      delete("/v2/#{escape @domain}/bounces/#{escape address}")
+    end
+
+    def get_stats(params = {})
+      get("/v2/#{escape @domain}/stats", params)
+    end
+
+    def get_log(params = {})
+      get("/v2/#{escape @domain}/log", params)
+    end
+
+    def get_routes(params = {})
+      get('/v2/routes', params)
+    end
+
+    def get_route(id)
+      get("/v2/routes/#{escape id}")
+    end
+
+    def add_route(attributes = {})
+      post('/v2/routes', attributes)
+    end
+
+    def update_route(id, attributes = {})
+      put("/v2/routes/#{escape id}", attributes)
+    end
+
+    def delete_route(id)
+      delete("/v2/routes/#{escape id}")
+    end
+
+    def get_mailboxes(params = {})
+      get("/v2/#{escape @domain}/mailboxes", params)
+    end
+
+    def add_mailbox(attributes = {})
+      post("/v2/#{escape @domain}/mailboxes", attributes)
+    end
+
+    def update_mailbox(name, attributes = {})
+      put("/v2/#{escape @domain}/mailboxes/#{escape name}", attributes)
+    end
+
+    def delete_mailbox(name)
+      delete("/v2/#{escape @domain}/mailboxes/#{escape name}")
+    end
+
+    def get_campaigns(params = {})
+      get("/v2/#{escape @domain}/campaigns", params)
+    end
+
+    def get_campaign(id)
+      get("/v2/#{escape @domain}/campaigns/#{escape id}")
+    end
+
+    def add_campaign(attributes = {})
+      post("/v2/#{escape @domain}/campaigns", attributes)
+    end
+
+    def update_campaign(id, attributes = {})
+      put("/v2/#{escape @domain}/campaigns/#{escape id}", attributes)
+    end
+
+    def delete_campaign(id)
+      delete("/v2/#{escape @domain}/campaigns/#{escape id}")
+    end
+
+    def get_campaign_events(campaign_id, params = {})
+      get("/v2/#{escape @domain}/campaigns/#{escape campaign_id}/events", params)
+    end
+
+    def get_campaign_stats(campaign_id, params = {})
+      get("/v2/#{escape @domain}/campaigns/#{escape campaign_id}/stats", params)
+    end
+
+    def get_campaign_clicks(campaign_id, params = {})
+      get("/v2/#{escape @domain}/campaigns/#{escape campaign_id}/clicks", params)
+    end
+
+    def get_campaign_opens(campaign_id, params = {})
+      get("/v2/#{escape @domain}/campaigns/#{escape campaign_id}/opens", params)
+    end
+
+    def get_campaign_unsubscribes(campaign_id, params = {})
+      get("/v2/#{escape @domain}/campaigns/#{escape campaign_id}/unsubscribes", params)
+    end
+
+    def get_campaign_complaints(campaign_id, params = {})
+      get("/v2/#{escape @domain}/campaigns/#{escape campaign_id}/complaints", params)
+    end
+
+    def get_lists(params = {})
+      get('/v2/lists', params)
+    end
+
+    def get_list(address)
+      get("/v2/lists/#{escape address}")
+    end
+
+    def add_list(attributes = {})
+      post('/v2/lists', attributes)
+    end
+
+    def update_list(address, attributes = {})
+      put("/v2/lists/#{escape address}", attributes)
+    end
+
+    def delete_list(address)
+      delete("/v2/lists/#{escape address}")
+    end
+
+    def get_list_members(list_address, params = {})
+      get("/v2/lists/#{escape list_address}/members", params)
+    end
+
+    def get_list_member(list_address, member_address)
+      get("/v2/lists/#{escape list_address}/members/#{escape member_address}")
+    end
+
+    def add_list_member(list_address, member_attributes)
+      post("/v2/lists/#{escape list_address}/members", member_attributes)
+    end
+
+    def update_list_member(list_address, member_address, member_attributes)
+      put("/v2/lists/#{escape list_address}/members/#{escape member_address}", member_attributes)
+    end
+
+    def delete_list_member(list_address, member_address)
+      delete("/v2/lists/#{escape list_address}/members/#{escape member_address}")
+    end
+
+    def get_list_stats(list_address)
+      get("/v2/lists/#{escape list_address}/stats")
+    end
+
+    private
+
+    def get(path, params = {})
+      transmit(Net::HTTP::Get, request_uri(path, params))
+    end
+
+    def post(path, attributes = {})
+      transmit(Net::HTTP::Post, path, attributes)
+    end
+
+    def put(path, attributes = {})
+      transmit(Net::HTTP::Put, path, attributes)
+    end
+
+    def delete(path)
+      transmit(Net::HTTP::Delete, path)
+    end
+
+    def transmit(subclass, path, attributes = nil)
+      message = subclass.new(path)
+      message.basic_auth('api', @api_key)
+      message.body = URI.encode_www_form(attributes) if attributes
+
+      Response.new(@http.request(message), :json => @json)
+    end
+
+    def request_uri(path, params_hash)
+      if params_hash.empty?
+        path
+      else
+        tmp = []
+
+        params_hash.each do |key, values|
+          Array(values).each do |value|
+            tmp << "#{escape(key)}=#{escape(value)}"
+          end
+        end
+
+        path + '?' + tmp.join('&')
+      end
+    end
+
+    def escape(component)
+      CGI.escape(component.to_s)
+    end
+  end
+
+  class Response
+    def initialize(http_response, options = {})
+      @http_response = http_response
+
+      @json = options.fetch(:json) { JSON }
+    end
+
+    def method_missing(name, *args, &block)
+      @http_response.send(name, *args, &block)
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      @http_response.respond_to?(name)
+    end
+
+    def ok?
+      code.to_i == 200
+    end
+
+    def client_error?
+      (400 .. 499).include?(code.to_i)
+    end
+
+    def server_error?
+      (500 .. 599).include?(code.to_i)
+    end
+
+    def json?
+      self['Content-Type'].split(';').first == 'application/json'
+    end
+
+    def object
+      @object ||= @json.load(body)
+    end
+  end
+end

data/mailgunner.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name = 'mailgunner'
+  s.version = '1.0.0'
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Tim Craft']
+  s.email = ['mail@timcraft.com']
+  s.homepage = 'http://github.com/timcraft/mailgunner'
+  s.description = 'A Ruby wrapper for the Mailgun API'
+  s.summary = 'See description'
+  s.files = Dir.glob('{lib,spec}/**/*') + %w(README.md mailgunner.gemspec)
+  s.add_development_dependency('rake', '>= 0.9.3')
+  s.add_development_dependency('mocha', '~> 0.10.3')
+  s.require_path = 'lib'
+end

data/spec/mailgunner_spec.rb

@@ -0,0 +1,763 @@
+require 'minitest/autorun'
+require 'mailgunner'
+require 'mocha'
+
+class Net::HTTPGenericRequest
+  def inspect
+    if request_body_permitted?
+      "<#{self.class.name} #{path} #{body}>"
+    else
+      "<#{self.class.name} #{path}>"
+    end
+  end
+end
+
+describe 'Mailgunner::Client' do
+  before do
+    @domain = 'samples.mailgun.org'
+
+    @api_key = 'xxx'
+
+    @client = Mailgunner::Client.new(domain: @domain, api_key: @api_key)
+
+    @address = 'user@example.com'
+
+    @encoded_address = 'user%40example.com'
+  end
+
+  def expect(request_class, arg)
+    matcher = String === arg ? responds_with(:path, arg) : arg
+
+    @client.http.expects(:request).with(all_of(instance_of(request_class), matcher)).returns(stub)
+  end
+
+  describe 'http method' do
+    it 'returns a net http object that uses ssl' do
+      @client.http.must_be_instance_of(Net::HTTP)
+
+      @client.http.use_ssl?.must_equal(true)
+    end
+  end
+
+  describe 'domain method' do
+    it 'returns the value passed to the constructor' do
+      @client.domain.must_equal(@domain)
+    end
+
+    it 'defaults to the domain in the MAILGUN_SMTP_LOGIN environment variable' do
+      ENV['MAILGUN_SMTP_LOGIN'] = 'postmaster@samples.mailgun.org'
+
+      Mailgunner::Client.new(api_key: @api_key).domain.must_equal(@domain)
+    end
+  end
+
+  describe 'api_key method' do
+    it 'returns the value passed to the constructor' do
+      @client.api_key.must_equal(@api_key)
+    end
+
+    it 'defaults to the value of MAILGUN_API_KEY environment variable' do
+      ENV['MAILGUN_API_KEY'] = @api_key
+
+      Mailgunner::Client.new(domain: @domain).api_key.must_equal(@api_key)
+    end
+  end
+
+  describe 'json method' do
+    it 'returns the value passed to the constructor' do
+      json = stub
+
+      Mailgunner::Client.new(json: json).json.must_equal(json)
+    end
+
+    it 'defaults to the standard library json implementation' do
+      @client.json.must_equal(JSON)
+    end
+  end
+
+  describe 'send_message method' do
+    it 'posts to the domain messages resource and returns a response object' do
+      expect(Net::HTTP::Post, "/v2/#@domain/messages")
+
+      @client.send_message({}).must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the message attributes' do
+      expect(Net::HTTP::Post, responds_with(:body, "to=#@encoded_address"))
+
+      @client.add_domain({to: @address})
+    end
+
+    it 'encodes the message attributes as multipart form data when sending attachments' do
+      # TODO
+    end
+  end
+
+  describe 'get_domains method' do
+    it 'fetches the domains resource and returns a response object' do
+      expect(Net::HTTP::Get, '/v2/domains')
+
+      @client.get_domains.must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'get_domain method' do
+    it 'fetches the domain resource and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/domains/#@domain")
+
+      @client.get_domain(@domain).must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'add_domain method' do
+    it 'posts to the domains resource and returns a response object' do
+      expect(Net::HTTP::Post, '/v2/domains')
+
+      @client.add_domain({}).must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the domain attributes' do
+      expect(Net::HTTP::Post, responds_with(:body, "name=#@domain"))
+
+      @client.add_domain({name: @domain})
+    end
+  end
+
+  describe 'get_unsubscribes method' do
+    it 'fetches the domain unsubscribes resource and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/unsubscribes")
+
+      @client.get_unsubscribes.must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes skip and limit parameters' do
+      expect(Net::HTTP::Get, "/v2/#@domain/unsubscribes?skip=1&limit=2")
+
+      @client.get_unsubscribes(skip: 1, limit: 2)
+    end
+  end
+
+  describe 'get_unsubscribe method' do
+    it 'fetches the unsubscribe resource with the given address and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/unsubscribes/#@encoded_address")
+
+      @client.get_unsubscribe(@address).must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'delete_unsubscribe method' do
+    it 'deletes the domain unsubscribe resource with the given address and returns a response object' do
+      expect(Net::HTTP::Delete, "/v2/#@domain/unsubscribes/#@encoded_address")
+
+      @client.delete_unsubscribe(@address).must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'add_unsubscribe method' do
+    it 'posts to the domain unsubscribes resource and returns a response object' do
+      expect(Net::HTTP::Post, "/v2/#@domain/unsubscribes")
+
+      @client.add_unsubscribe({}).must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the unsubscribe attributes' do
+      expect(Net::HTTP::Post, responds_with(:body, "address=#@encoded_address"))
+
+      @client.add_unsubscribe({address: @address})
+    end
+  end
+
+  describe 'get_complaints method' do
+    it 'fetches the domain complaints resource and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/complaints")
+
+      @client.get_complaints.must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes skip and limit parameters' do
+      expect(Net::HTTP::Get, "/v2/#@domain/complaints?skip=1&limit=2")
+
+      @client.get_complaints(skip: 1, limit: 2)
+    end
+  end
+
+  describe 'get_complaint method' do
+    it 'fetches the complaint resource with the given address and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/complaints/#@encoded_address")
+
+      @client.get_complaint(@address).must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'add_complaint method' do
+    it 'posts to the domain complaints resource and returns a response object' do
+      expect(Net::HTTP::Post, "/v2/#@domain/complaints")
+
+      @client.add_complaint({}).must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the complaint attributes' do
+      expect(Net::HTTP::Post, responds_with(:body, "address=#@encoded_address"))
+
+      @client.add_complaint({address: @address})
+    end
+  end
+
+  describe 'delete_complaint method' do
+    it 'deletes the domain complaint resource with the given address and returns a response object' do
+      expect(Net::HTTP::Delete, "/v2/#@domain/complaints/#@encoded_address")
+
+      @client.delete_complaint(@address).must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'get_bounces method' do
+    it 'fetches the domain bounces resource and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/bounces")
+
+      @client.get_bounces.must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes skip and limit parameters' do
+      expect(Net::HTTP::Get, "/v2/#@domain/bounces?skip=1&limit=2")
+
+      @client.get_bounces(skip: 1, limit: 2)
+    end
+  end
+
+  describe 'get_bounce method' do
+    it 'fetches the bounce resource with the given address and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/bounces/#@encoded_address")
+
+      @client.get_bounce(@address).must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'add_bounce method' do
+    it 'posts to the domain bounces resource and returns a response object' do
+      expect(Net::HTTP::Post, "/v2/#@domain/bounces")
+
+      @client.add_bounce({}).must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the bounce attributes' do
+      expect(Net::HTTP::Post, responds_with(:body, "address=#@encoded_address"))
+
+      @client.add_bounce({address: @address})
+    end
+  end
+
+  describe 'delete_bounce method' do
+    it 'deletes the domain bounce resource with the given address and returns a response object' do
+      expect(Net::HTTP::Delete, "/v2/#@domain/bounces/#@encoded_address")
+
+      @client.delete_bounce(@address).must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'get_stats method' do
+    it 'fetches the domain stats resource and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/stats")
+
+      @client.get_stats.must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes skip and limit parameters' do
+      expect(Net::HTTP::Get, "/v2/#@domain/stats?skip=1&limit=2")
+
+      @client.get_stats(skip: 1, limit: 2)
+    end
+
+    it 'encodes an event parameter with multiple values' do
+      expect(Net::HTTP::Get, "/v2/#@domain/stats?event=sent&event=opened")
+
+      @client.get_stats(event: %w(sent opened))
+    end
+  end
+
+  describe 'get_log method' do
+    it 'fetches the domain stats resource and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/log")
+
+      @client.get_log.must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes skip and limit parameters' do
+      expect(Net::HTTP::Get, "/v2/#@domain/log?skip=1&limit=2")
+
+      @client.get_log(skip: 1, limit: 2)
+    end
+  end
+
+  describe 'get_routes method' do
+    it 'fetches the global routes resource and returns a response object' do
+      expect(Net::HTTP::Get, '/v2/routes')
+
+      @client.get_routes.must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes skip and limit parameters' do
+      expect(Net::HTTP::Get, '/v2/routes?skip=1&limit=2')
+
+      @client.get_routes(skip: 1, limit: 2)
+    end
+  end
+
+  describe 'get_route method' do
+    it 'fetches the route resource with the given id and returns a response object' do
+      expect(Net::HTTP::Get, '/v2/routes/4f3bad2335335426750048c6')
+
+      @client.get_route('4f3bad2335335426750048c6').must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'add_route method' do
+    it 'posts to the routes resource and returns a response object' do
+      expect(Net::HTTP::Post, '/v2/routes')
+
+      @client.add_route({}).must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the route attributes' do
+      expect(Net::HTTP::Post, responds_with(:body, 'description=Example+route&priority=1'))
+
+      @client.add_route({description: 'Example route', priority: 1})
+    end
+  end
+
+  describe 'update_route method' do
+    it 'updates the route resource with the given id and returns a response object' do
+      expect(Net::HTTP::Put, '/v2/routes/4f3bad2335335426750048c6')
+
+      @client.update_route('4f3bad2335335426750048c6', {}).must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the route attributes' do
+      expect(Net::HTTP::Put, responds_with(:body, 'priority=10'))
+
+      @client.update_route('4f3bad2335335426750048c6', {priority: 10})
+    end
+  end
+
+  describe 'delete_route method' do
+    it 'deletes the route resource with the given id and returns a response object' do
+      expect(Net::HTTP::Delete, '/v2/routes/4f3bad2335335426750048c6')
+
+      @client.delete_route('4f3bad2335335426750048c6').must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'get_mailboxes method' do
+    it 'fetches the domain mailboxes resource and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/mailboxes")
+
+      @client.get_mailboxes.must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes skip and limit parameters' do
+      expect(Net::HTTP::Get, "/v2/#@domain/mailboxes?skip=1&limit=2")
+
+      @client.get_mailboxes(skip: 1, limit: 2)
+    end
+  end
+
+  describe 'add_mailbox method' do
+    it 'posts to the domain mailboxes resource and returns a response object' do
+      expect(Net::HTTP::Post, "/v2/#@domain/mailboxes")
+
+      @client.add_mailbox({}).must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the mailbox attributes' do
+      expect(Net::HTTP::Post, responds_with(:body, 'mailbox=user'))
+
+      @client.add_mailbox({mailbox: 'user'})
+    end
+  end
+
+  describe 'update_mailbox method' do
+    it 'updates the mailbox resource and returns a response object' do
+      expect(Net::HTTP::Put, "/v2/#@domain/mailboxes/user")
+
+      @client.update_mailbox('user', {}).must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the mailbox attributes' do
+      expect(Net::HTTP::Put, responds_with(:body, 'password=secret'))
+
+      @client.update_mailbox('user', {password: 'secret'})
+    end
+  end
+
+  describe 'delete_mailbox method' do
+    it 'deletes the domain mailbox resource with the given address and returns a response object' do
+      expect(Net::HTTP::Delete, "/v2/#@domain/mailboxes/user")
+
+      @client.delete_mailbox('user').must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'get_campaigns method' do
+    it 'fetches the domain campaigns resource and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/campaigns")
+
+      @client.get_campaigns.must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes skip and limit parameters' do
+      expect(Net::HTTP::Get, "/v2/#@domain/campaigns?skip=1&limit=2")
+
+      @client.get_campaigns(skip: 1, limit: 2)
+    end
+  end
+
+  describe 'get_campaign method' do
+    it 'fetches the campaign resource with the given id and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/campaigns/id")
+
+      @client.get_campaign('id').must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'add_campaign method' do
+    it 'posts to the domain campaigns resource and returns a response object' do
+      expect(Net::HTTP::Post, "/v2/#@domain/campaigns")
+
+      @client.add_campaign({}).must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the campaign attributes' do
+      expect(Net::HTTP::Post, responds_with(:body, 'id=id'))
+
+      @client.add_campaign({id: 'id'})
+    end
+  end
+
+  describe 'update_campaign method' do
+    it 'updates the campaign resource and returns a response object' do
+      expect(Net::HTTP::Put, "/v2/#@domain/campaigns/id")
+
+      @client.update_campaign('id', {}).must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the campaign attributes' do
+      expect(Net::HTTP::Put, responds_with(:body, 'name=Example+Campaign'))
+
+      @client.update_campaign('id', {name: 'Example Campaign'})
+    end
+  end
+
+  describe 'delete_campaign method' do
+    it 'deletes the domain campaign resource with the given id and returns a response object' do
+      expect(Net::HTTP::Delete, "/v2/#@domain/campaigns/id")
+
+      @client.delete_campaign('id').must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'get_campaign_events method' do
+    it 'fetches the domain campaign events resource and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/campaigns/id/events")
+
+      @client.get_campaign_events('id').must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the optional parameters' do
+      expect(Net::HTTP::Get, "/v2/#@domain/campaigns/id/events?country=US&limit=100")
+
+      @client.get_campaign_events('id', country: 'US', limit: 100)
+    end
+  end
+
+  describe 'get_campaign_stats method' do
+    it 'fetches the domain campaign stats resource and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/campaigns/id/stats")
+
+      @client.get_campaign_stats('id').must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the optional parameters' do
+      expect(Net::HTTP::Get, "/v2/#@domain/campaigns/id/stats?groupby=dailyhour")
+
+      @client.get_campaign_stats('id', groupby: 'dailyhour')
+    end
+  end
+
+  describe 'get_campaign_clicks method' do
+    it 'fetches the domain campaign clicks resource and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/campaigns/id/clicks")
+
+      @client.get_campaign_clicks('id').must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the optional parameters' do
+      expect(Net::HTTP::Get, "/v2/#@domain/campaigns/id/clicks?groupby=month&limit=100")
+
+      @client.get_campaign_clicks('id', groupby: 'month', limit: 100)
+    end
+  end
+
+  describe 'get_campaign_opens method' do
+    it 'fetches the domain campaign opens resource and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/campaigns/id/opens")
+
+      @client.get_campaign_opens('id').must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the optional parameters' do
+      expect(Net::HTTP::Get, "/v2/#@domain/campaigns/id/opens?groupby=month&limit=100")
+
+      @client.get_campaign_opens('id', groupby: 'month', limit: 100)
+    end
+  end
+
+  describe 'get_campaign_unsubscribes method' do
+    it 'fetches the domain campaign unsubscribes resource and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/campaigns/id/unsubscribes")
+
+      @client.get_campaign_unsubscribes('id').must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the optional parameters' do
+      expect(Net::HTTP::Get, "/v2/#@domain/campaigns/id/unsubscribes?groupby=month&limit=100")
+
+      @client.get_campaign_unsubscribes('id', groupby: 'month', limit: 100)
+    end
+  end
+
+  describe 'get_campaign_complaints method' do
+    it 'fetches the domain campaign complaints resource and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/#@domain/campaigns/id/complaints")
+
+      @client.get_campaign_complaints('id').must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the optional parameters' do
+      expect(Net::HTTP::Get, "/v2/#@domain/campaigns/id/complaints?groupby=month&limit=100")
+
+      @client.get_campaign_complaints('id', groupby: 'month', limit: 100)
+    end
+  end
+
+  describe 'get_lists method' do
+    it 'fetches the domain lists resource and returns a response object' do
+      expect(Net::HTTP::Get, '/v2/lists')
+
+      @client.get_lists.must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes skip and limit parameters' do
+      expect(Net::HTTP::Get, '/v2/lists?skip=1&limit=2')
+
+      @client.get_lists(skip: 1, limit: 2)
+    end
+  end
+
+  describe 'get_list method' do
+    it 'fetches the list resource with the given address and returns a response object' do
+      expect(Net::HTTP::Get, '/v2/lists/developers%40mailgun.net')
+
+      @client.get_list('developers@mailgun.net').must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'add_list method' do
+    it 'posts to the domain lists resource and returns a response object' do
+      expect(Net::HTTP::Post, '/v2/lists')
+
+      @client.add_list({}).must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the list attributes' do
+      expect(Net::HTTP::Post, responds_with(:body, 'address=developers%40mailgun.net'))
+
+      @client.add_list({address: 'developers@mailgun.net'})
+    end
+  end
+
+  describe 'update_list method' do
+    it 'updates the list resource and returns a response object' do
+      expect(Net::HTTP::Put, '/v2/lists/developers%40mailgun.net')
+
+      @client.update_list('developers@mailgun.net', {}).must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the list attributes' do
+      expect(Net::HTTP::Put, responds_with(:body, 'name=Example+list'))
+
+      @client.update_list('developers@mailgun.net', {name: 'Example list'})
+    end
+  end
+
+  describe 'delete_list method' do
+    it 'deletes the domain list resource with the given address and returns a response object' do
+      expect(Net::HTTP::Delete, '/v2/lists/developers%40mailgun.net')
+
+      @client.delete_list('developers@mailgun.net').must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'get_list_members method' do
+    it 'fetches the list members resource and returns a response object' do
+      expect(Net::HTTP::Get, '/v2/lists/developers%40mailgun.net/members')
+
+      @client.get_list_members('developers@mailgun.net').must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes skip and limit parameters' do
+      expect(Net::HTTP::Get, '/v2/lists/developers%40mailgun.net/members?skip=1&limit=2')
+
+      @client.get_list_members('developers@mailgun.net', skip: 1, limit: 2)
+    end
+  end
+
+  describe 'get_list_member method' do
+    it 'fetches the list member resource with the given address and returns a response object' do
+      expect(Net::HTTP::Get, "/v2/lists/developers%40mailgun.net/members/#@encoded_address")
+
+      @client.get_list_member('developers@mailgun.net', @address).must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'add_list_member method' do
+    it 'posts to the list members resource and returns a response object' do
+      expect(Net::HTTP::Post, '/v2/lists/developers%40mailgun.net/members')
+
+      @client.add_list_member('developers@mailgun.net', {}).must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the list attributes' do
+      expect(Net::HTTP::Post, responds_with(:body, "address=#@encoded_address"))
+
+      @client.add_list_member('developers@mailgun.net', {address: @address})
+    end
+  end
+
+  describe 'update_list_member method' do
+    it 'updates the list member resource with the given address and returns a response object' do
+      expect(Net::HTTP::Put, "/v2/lists/developers%40mailgun.net/members/#@encoded_address")
+
+      @client.update_list_member('developers@mailgun.net', @address, {}).must_be_instance_of(Mailgunner::Response)
+    end
+
+    it 'encodes the list member attributes' do
+      expect(Net::HTTP::Put, responds_with(:body, 'subscribed=no'))
+
+      @client.update_list_member('developers@mailgun.net', @address, {subscribed: 'no'})
+    end
+  end
+
+  describe 'delete_list_member method' do
+    it 'deletes the list member resource with the given address and returns a response object' do
+      expect(Net::HTTP::Delete, "/v2/lists/developers%40mailgun.net/members/#@encoded_address")
+
+      @client.delete_list_member('developers@mailgun.net', @address).must_be_instance_of(Mailgunner::Response)
+    end
+  end
+
+  describe 'get_list_stats method' do
+    it 'fetches the list stats resource and returns a response object' do
+      expect(Net::HTTP::Get, '/v2/lists/developers%40mailgun.net/stats')
+
+      @client.get_list_stats('developers@mailgun.net').must_be_instance_of(Mailgunner::Response)
+    end
+  end
+end
+
+describe 'Mailgunner::Response' do
+  before do
+    @http_response = mock()
+
+    @response = Mailgunner::Response.new(@http_response)
+  end
+
+  it 'delegates missing methods to the http response object' do
+    @http_response.stubs(:code).returns('200')
+
+    @response.code.must_equal('200')
+  end
+
+  describe 'ok query method' do
+    it 'returns true if the status code is 200' do
+      @http_response.expects(:code).returns('200')
+
+      @response.ok?.must_equal(true)
+    end
+
+    it 'returns false otherwise' do
+      @http_response.expects(:code).returns('400')
+
+      @response.ok?.must_equal(false)
+    end
+  end
+
+  describe 'client_error query method' do
+    it 'returns true if the status code is 4xx' do
+      @http_response.stubs(:code).returns(%w(400 401 402 404).sample)
+
+      @response.client_error?.must_equal(true)
+    end
+
+    it 'returns false otherwise' do
+      @http_response.stubs(:code).returns('200')
+
+      @response.client_error?.must_equal(false)
+    end
+  end
+
+  describe 'server_error query method' do
+    it 'returns true if the status code is 5xx' do
+      @http_response.stubs(:code).returns(%w(500 502 503 504).sample)
+
+      @response.server_error?.must_equal(true)
+    end
+
+    it 'returns false otherwise' do
+      @http_response.stubs(:code).returns('200')
+
+      @response.server_error?.must_equal(false)
+    end
+  end
+
+  describe 'json query method' do
+    it 'returns true if the response has a json content type' do
+      @http_response.expects(:[]).with('Content-Type').returns('application/json;charset=utf-8')
+
+      @response.json?.must_equal(true)
+    end
+
+    it 'returns false otherwise' do
+      @http_response.expects(:[]).with('Content-Type').returns('text/html')
+
+      @response.json?.must_equal(false)
+    end
+  end
+
+  describe 'object method' do
+    it 'decodes the response body as json and returns a hash' do
+      @http_response.expects(:body).returns('{"foo":"bar"}')
+
+      @response.object.must_equal({'foo' => 'bar'})
+    end
+  end
+end
+
+describe 'Mailgunner::Response initialized with an alternative json implementation' do
+  before do
+    @json = mock()
+
+    @http_response = mock()
+
+    @response = Mailgunner::Response.new(@http_response, :json => @json)
+  end
+
+  describe 'object method' do
+    it 'uses the alternative json implementation to parse the response body' do
+      @http_response.stubs(:body).returns(response_body = '{"foo":"bar"}')
+
+      @json.expects(:load).with(response_body)
+
+      @response.object
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: mailgunner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Tim Craft
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+description: A Ruby wrapper for the Mailgun API
+email:
+- mail@timcraft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mailgunner.rb
+- spec/mailgunner_spec.rb
+- README.md
+- mailgunner.gemspec
+homepage: http://github.com/timcraft/mailgunner
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: See description
+test_files: []
+has_rdoc: