mailgun 0.0.1 → 0.0.2

data/Gemfile

@@ -1,4 +1,10 @@
 source 'http://rubygems.org'
 
+gem "rest-client"
+
+group :development do
+  gem "rspec"
+end
+
 # Specify your gem's dependencies in mailgun.gemspec
 gemspec

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2011 Bushido Inc.
+
+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,58 @@
+Mailgun
+=========
+This gem allows for idiomatic Mailgun usage from within ruby. Mailgun is a kickass email-as-a-service that lets you use email as if it made sense. Check it out at http://mailgun.net/
+
+The official gem repo is at https://github.com/Bushido/mailgun
+
+Mailgun exposes the following resources:
+
+  * Routes
+  * Log
+  * Stats
+  * Messages
+  * Mailboxes
+
+Currently the gem only exposes the Mailbox API, but patches are welcome (and easy!). 
+
+Usage
+=====
+We mimic the ActiveRecord-style interface.
+
+    # Initialize your Mailgun object:
+    @mailgun = Mailgun(:api_key => 'your-api-key')
+    
+    # Create a mailbox
+    @mailgun.mailbox.create "new-mailbox@your-domain.com", "password"
+    
+    # List all mailboxes that belong to a domain
+    @mailgun.mailboxes.list domain.com"
+    
+    # Destroy a mailbox (queue bond-villian laughter)
+    # "I'm sorry Bond, it seems your mailbox will be... destroyed!"
+    @mailbox.mailboxes.destroy "bond@mi5.co.uk"
+
+Making Your Changes
+===================
+
+  * Fork the project (Github has really good step-by-step directions)
+  * Start a feature/bugfix branch
+  * Commit and push until you are happy with your contribution
+  * Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
+  * After making your changes, be sure to run the Mailgun RSpec specs to make sure everything works.
+  * Submit your change as a Pull Request and update the GitHub issue to let us know it is ready for review.
+
+Authors
+=======
+
+  * Akash Manohar J (akash@akash.im)
+  * Sean Grove (sean@gobushido.com)
+
+Thanks
+======
+Huge thanks to the Mailgun guys for such an amazing service! No time spent on mailservers == way more time spent drinking!
+
+License & Copyright
+===================
+Released under the MIT license. See LICENSE for more details.
+
+All copyright Bushido Inc. 2011

data/lib/mailgun/base.rb

@@ -0,0 +1,34 @@
+module Mailgun
+  class Base
+    attr_accessor :api_key,
+                  :api_version,
+                  :protocol,
+                  :mailgun_host,
+                  :use_test_mode
+
+    # Options taken from
+    # http://documentation.mailgun.net/quickstart.html#authentication
+    # * Mailgun host - location of mailgun api servers
+    # * Procotol - http or https [default to https]
+    # * API key and version
+    # * Test mode - if enabled, doesn't actually send emails (see http://documentation.mailgun.net/user_manual.html#sending-in-test-mode)
+    def initialize(options)
+      @mailgun_host = options.fetch(:mailgun_host) {"api.mailgun.net"}
+      @protocol     = options.fetch(:protocol)     { "https"  }
+      @api_version  = options.fetch(:api_version)  { "v2"  }
+      @test_mode    = options.fetch(:test_mode)    { false }
+
+      @api_key      = options.fetch(:api_key)      { raise ArgumentError(":api_key is a required argument to initialize Mailgun") }
+    end
+
+    # Returns the base url used in all Mailgun API calls
+    def base_url
+      "#{@protocol}://api:#{api_key}@#{mailgun_host}/#{api_version}"
+    end
+
+    # Returns an instance of Mailgun::Mailbox configured for the current API user
+    def mailboxes
+      @mailboxes ||= Mailgun::Mailbox.new(self)
+    end
+  end
+end

data/lib/mailgun/mail.rb

@@ -0,0 +1,20 @@
+module Mailgun
+  class Mail
+
+    def initialize(mailgun)
+      @mailgun = mailgun
+    end
+
+    # send email
+    def send_email()
+      # TODO with the following options
+      # :from, :to, :cc, :bcc, :subject, :text, :html 
+      # :with_attachment
+      # :with_attachments
+      # :at for delayed delivery time option
+      # :in_test_mode BOOL. override the @use_test_mode setting
+      # :tags to add tags to the email
+      # :track BOOL
+    end
+  end
+end

data/lib/mailgun/mailbox.rb

@@ -0,0 +1,52 @@
+module Mailgun
+  class Mailbox
+
+    # Used internally, called from Mailgun::Base
+    def initialize(mailgun)
+      @mailgun = mailgun
+    end
+
+    # List all mailboxes for a given domain
+    # * domain the domain for which all mailboxes will listed
+    def list(domain)
+      submit :get, mailbox_url(domain)
+    end
+    
+
+    # Creates a mailbox on the Mailgun server with the given password
+    def create(address, password)
+      submit :post, mailbox_url(address.split("@").last), :mailbox =>  address,
+      :password => password
+    end
+
+
+    # Sets the password for a mailbox
+    def update_password(address, password)
+      mailbox_name, domain = address.split("@")
+
+      submit :put, mailbox_url(domain, mailbox_name), :password => password
+    end
+
+
+    # Destroys the mailbox
+    def destroy(address)
+      mailbox_name, domain = address.split("@")
+
+      submit :delete,  mailbox_url(domain, mailbox_name)
+    end
+
+
+    private
+
+    # Helper method to generate the proper url for Mailgun mailbox API calls
+    def mailbox_url(domain, mailbox_name=nil)
+      "#{@mailgun.base_url}/#{domain}/mailboxes#{'/' + mailbox_name if mailbox_name}"
+    end
+
+
+    # Submits the API call to the Mailgun server
+    def submit(method, url, parameters={})
+      JSON(RestClient.send(method, url, parameters))
+    end
+  end
+end

data/lib/mailgun.rb

@@ -1,5 +1,9 @@
-require "mailgun/version"
+require "rest-client"
+require "json"
 
-module Mailgun
-  # Your code goes here...
+require 'mailgun/base'
+require 'mailgun/mailbox'
+
+def Mailgun(options)
+  Mailgun::Base.new(options)
 end

data/mailgun.gemspec

@@ -1,11 +1,10 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/mailgun/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Akash Manohar J"]
-  gem.email         = ["akash@akash.im"]
+  gem.authors       = ["Akash Manohar J", "Sean Grove"]
+  gem.email         = ["akash@akash.im", "s@bushi.do"]
   gem.description   = %q{Mailgun library for Ruby}
-  gem.summary       = %q{The gem itself is a todo for now}
+  gem.summary       = %q{Idiomatic library for using the mailgun API from within ruby}
   gem.homepage      = ""
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -13,5 +12,5 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "mailgun"
   gem.require_paths = ["lib"]
-  gem.version       = Mailgun::VERSION
+  gem.version       = "0.0.2"
 end

data/spec/base_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Mailgun::Base do
+
+	before :each do
+		@mailgun = Mailgun({:api_key => "some-junk-string"})		# used to get the default values
+
+		@sample_options = {
+			:api_key 		 	=> @mailgun.api_key,
+			:api_version 	=> @mailgun.api_version,
+			:protocol 		=> @mailgun.protocol,
+			:mailgun_host => @mailgun.mailgun_host
+		}
+  end
+
+  describe "new" do
+    it "Mailgun() method should return a new Mailgun object" do
+      @mailgun.should be_kind_of(Mailgun::Base)
+    end
+
+    it "should use https by default" do
+      @mailgun.protocol.should == "https"
+    end
+  end
+
+	describe "base_url" do
+		it "should return https url if use_https is true" do
+			mailgun = Mailgun(@sample_options)
+			mailgun.send(:base_url).should == "https://api:#{mailgun.api_key}@#{mailgun.mailgun_host}/#{mailgun.api_version}"
+		end
+	end
+end

data/spec/mailbox_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Mailgun::Mailbox do
+
+	before :each do
+		@mailgun = Mailgun({:api_key => "api-key"})		# used to get the default values
+
+		@mailbox_options = {
+      :email  => "test@sample.mailgun.com",
+      :name   => "test",
+      :domain => "sample.mailgun.com"
+    }
+	end
+
+	describe "list_mailboxes" do
+		it "should make a get request with the right params" do
+			RestClient.should_receive(:get)
+      .with("#{@mailgun.send(:base_url)}/#{@mailbox_options[:domain]}/mailboxes", {}).and_return("{}")
+
+			@mailgun.mailboxes.list @mailbox_options[:domain]
+		end
+	end
+
+	describe "create mailbox" do
+		it "should make a post request with the right params"	do
+			RestClient.should_receive(:post)
+								.with("#{@mailgun.send(:base_url)}/#{@mailbox_options[:domain]}/mailboxes",
+											:mailbox  => @mailbox_options[:email],
+											:password => @mailbox_options[:password])
+								.and_return({})
+
+			@mailgun.mailboxes.create(@mailbox_options[:email], @mailbox_options[:password])
+		end
+	end
+
+	describe "update mailbox password" do
+		it "should make a put request with the right params" do
+			RestClient.should_receive(:put)
+								.with("#{@mailgun.send(:base_url)}/#{@mailbox_options[:domain]}/mailboxes/#{@mailbox_options[:name]}",
+											:password => @mailbox_options[:password])
+								.and_return({})
+
+			@mailgun.mailboxes.update_password @mailbox_options[:email],
+                                         @mailbox_options[:password]
+		end
+	end
+
+  	describe "destroy mailbox" do
+		it "should make a put request with the right params" do
+			RestClient.should_receive(:delete)
+      .with("#{@mailgun.send(:base_url)}/#{@mailbox_options[:domain]}/mailboxes/#{@mailbox_options[:name]}", {})
+      .and_return({})
+
+			@mailgun.mailboxes.destroy @mailbox_options[:email]
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+
+require "rspec"
+require "mailgun"
+
+RSpec.configure do |config|
+end

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: mailgun
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
 - Akash Manohar J
+- Sean Grove
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -14,16 +15,24 @@ dependencies: []
 description: Mailgun library for Ruby
 email:
 - akash@akash.im
+- s@bushi.do
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
 - lib/mailgun.rb
-- lib/mailgun/version.rb
+- lib/mailgun/base.rb
+- lib/mailgun/mail.rb
+- lib/mailgun/mailbox.rb
 - mailgun.gemspec
+- spec/base_spec.rb
+- spec/mailbox_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -47,5 +56,8 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: The gem itself is a todo for now
-test_files: []
+summary: Idiomatic library for using the mailgun API from within ruby
+test_files:
+- spec/base_spec.rb
+- spec/mailbox_spec.rb
+- spec/spec_helper.rb

data/lib/mailgun/version.rb

@@ -1,3 +0,0 @@
-module Mailgun
-  VERSION = "0.0.1"
-end