mailgun 0.7 → 0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f299f5774c3b4633c5585f6fd12c81c47c06de1c
-  data.tar.gz: fefddce633b68496cd6248cd93e70e1e6684ce38
+  metadata.gz: 20809378b057a083d20b98dd3dffb1d771d2845e
+  data.tar.gz: b063e69d0b35dca7f8a934e7a2e2fd3f9f5d57ff
 SHA512:
-  metadata.gz: 6171bc203666c967ab67d3f9bed2ff5c2177810bf13895e2c67d5ef8158c09dd1ede7cd396f22c62a86a05f14efda28180af0600dd344aec366555da9a9fb5c5
-  data.tar.gz: 6b5c901517191cdf63704b22859b0c4bb03d516cc48efbe8eefe2a085278b84d8dec4eee9a9bfc98514911daece3d2e8127ae4be0777a3136d484f2583211918
+  metadata.gz: a568bf6b8ca38bd594d0f08e336c2d3a93961b32fe216e2d954e80b527675d8f8cbd91de0c8413e540135abed41be64e329e6dfe81911d71ad14196027daeed9
+  data.tar.gz: b307a01536f51da5b8bbd462ae477105685e95adab6e48f8c6c02dca6438f2affb929e8a0e76da4830dcee00fb33d9cbd4c40bdfad51b4b264bad3ecf128492e

data/.gitignore

@@ -15,7 +15,3 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-startup.rb
-Guardfile
-.DS_Store
-lib/startup.rb

data/CONTRIBUTORS.md

@@ -0,0 +1,23 @@
+* Alan deLevie / ([@adelevie](http://github.com/adelevie))
+  * Sending email
+
+* Andrés Bravo / ([@andresbravog](http://github.com/andresbravog))
+  * Support for bounces API
+
+* [@gabriel](http://github.com/gabriel)
+  * Fix to accept domain in options
+
+* Kaz Walker / [@KazW](http://github.com/KazW>)
+  * Syntax highlighting for readme
+
+* [@mirzac](http://github.com/mirzac>)
+  * Fix to accept domain in options
+
+* [@kdayton-](http://github.com/kdayton->)
+  * Support for domains API
+
+* Scott Carleton / [@scotterc](http://github.com/scotterc)
+  * new functionality and improvements
+
+* Yomi Colledge / [@baphled](http://github.com/baphled)
+  * For refactoring API configuration and some documentation

data/README.md

@@ -17,14 +17,14 @@ Mailgun exposes the following resources:
   * Complaints
   * Domain management
 
-Patches are welcome (and easy!). 
+Patches are welcome (and easy!).
 
 ## Sending mail using ActionMailer
 
 If you simply want to send mail using Mailgun, just set the smtp settings in the Rails application like the following. Replace wherever necessary in the following snippet :)
 ```ruby
 ActionMailer::Base.smtp_settings = {
-  :port           => 587, 
+  :port           => 587,
   :address        => 'smtp.mailgun.org',
   :user_name      => 'postmaster@your.mailgun.domain',
   :password       => 'mailgun-smtp-password',
@@ -71,7 +71,7 @@ parameters = {
 @mailgun.lists.create "devs@your.mailgun.domain"
 
 # List all Mailing lists
-@mailgun.lists.all
+@mailgun.lists.list
 
 # Find a mailing list
 @mailgun.lists.find "devs@your.mailgun.domain"
@@ -114,6 +114,21 @@ parameters = {
 @mailbox.mailboxes.destroy "bond@mi6.co.uk"
 ```
 
+#### Bounces
+```ruby
+# List last bounces (100 limit)
+@mailgun.bounces.list
+
+# Find bounces
+@mailgun.bounces.find "user@ema.il"
+
+# Add bounce
+@maligun.bounces.add "user@ema.il"
+
+# Clean user bounces
+@mailbox.bounces.destroy "user@ema.il"
+```
+
 #### Routes
 ```ruby
 # Initialize your Mailgun object:
@@ -137,9 +152,9 @@ parameters = {
 # Update a route via its id
 # (all keys are optional)
 @mailgun.routes.update "4e97c1b2ba8a48567f007fb6", {
-     :priority => 2,
-     :filter   => [:match_header, :subject, "*.support"],
-     :actions  => [[:forward, "http://new-site.com/incoming-emails"]]
+     :priority   => 2,
+     :expression => [:match_header, :subject, "*.support"],
+     :actions    => [[:forward, "http://new-site.com/incoming-emails"]]
      }
 
 # Destroy a route via its id
@@ -181,9 +196,10 @@ Supported route actions are: `:forward`, and `:stop`
   * Submit your change as a Pull Request and update the GitHub issue to let us know it is ready for review.
 
 
+
+
 ## TODO
 
-  * Mailgun() is overwriting api key. api key is not persisting
   * Add skip and limit functionality
   * Distinguish failed in logs
   * Distinguish delivered in logs
@@ -192,18 +208,17 @@ Supported route actions are: `:forward`, and `:stop`
   * Campaign?
 
 
-## Authors
+## Maintainer
 
-* Akash Manohar J ([@HashNuke](http://github.com/HashNuke))
-* Sean Grove ([@sgrove](http://github.com/sgrove))
+Akash Manohar / [@HashNuke](http://github.com/HashNuke)
+
+
+## Authors
 
-## Contrubutions
+* Akash Manohar / [@HashNuke](http://github.com/HashNuke)
+* Sean Grove / [@sgrove](http://github.com/sgrove)
 
-* Yomi Colledge ([@baphled](http://github.com/baphled))
-* Scott Carleton ([@scotterc](http://github.com/scotterc)) - new functionality and improvements
-* Alan deLevie ([@adelevie](http://github.com/adelevie)) - Sending email
-* kdayton (<http://github.com/kdayton->) - Support for domains API
-* gabriel (<http://github.com/gabriel>) - Fix to accept domain in options
+See CONTRIBUTORS.md file for contributor credits.
 
 ## License
 

data/lib/mailgun.rb

@@ -1,6 +1,8 @@
 require "rest-client"
 require "json"
-require "multimap"
+require "multimap/lib/multimap"
+require "multimap/lib/multiset"
+require "multimap/lib/nested_multimap"
 
 require "mailgun/mailgun_error"
 require "mailgun/base"
@@ -19,5 +21,6 @@ require "mailgun/message"
 
 def Mailgun(options={})
   options[:api_key] = Mailgun.api_key if Mailgun.api_key
+  options[:domain] = Mailgun.domain if Mailgun.domain
   Mailgun::Base.new(options)
 end

data/lib/mailgun/base.rb

@@ -13,7 +13,7 @@ module Mailgun
       Mailgun.api_version     = options.fetch(:api_version)     { "v2"  }
       Mailgun.test_mode       = options.fetch(:test_mode)       { false }
       Mailgun.api_key         = options.fetch(:api_key)         { raise ArgumentError.new(":api_key is a required argument to initialize Mailgun") if Mailgun.api_key.nil?}
-      Mailgun.domain          = options.fetch(:domain)
+      Mailgun.domain          = options.fetch(:domain)          { nil }
     end
 
     # Returns the base url used in all Mailgun API calls
@@ -29,15 +29,15 @@ module Mailgun
     def messages(domain = Mailgun.domain)
       @messages ||= Mailgun::Message.new(self, domain)
     end
-    
+
     def routes
       @routes ||= Mailgun::Route.new(self)
     end
-    
+
     def bounces(domain = Mailgun.domain)
       Mailgun::Bounce.new(self, domain)
     end
-    
+
     def domains
       Mailgun::Domain.new(self)
     end

data/lib/mailgun/bounce.rb

@@ -10,17 +10,38 @@ module Mailgun
     end
     
     # List all bounces for a given domain
+    #
+    # @param options [Hash] options to populate to mailgun find
+    # @option options limit (100) [Integer] limit of results
+    # @option options skip  (0)   [Integer] number of results to skip
+    #
+    # @returns [Array<Hash>] array of bouces
     def list(options={})
       Mailgun.submit(:get, bounce_url, options)["items"] || []
     end
 
     # Find bounce events for an email address
+    #
+    # @returns [<Hash>] found bouce
     def find(email)
       Mailgun.submit :get, bounce_url(email)
     end
 
-    def add(email)
-      Mailgun.submit :post, bounce_url, :address => email
+    # Creates a bounce for an email address
+    #
+    # @param email [String] email address to bounce
+    # @param options [Hash] options to populate to mailgun bounce creation
+    # @option options code (550) [Integer] Error code
+    # @option options error  ('')   [String] Error description
+    #
+    # @returns [<Hash>] created bouce
+    def add(email, options={})
+      Mailgun.submit :post, bounce_url, {:address => email}.merge(options)
+    end
+    
+    # Cleans the bounces for an email address
+    def destroy(email)
+      Mailgun.submit :delete, bounce_url(email)  
     end
 
     private
@@ -31,4 +52,4 @@ module Mailgun
     end
     
   end
-end
+end

data/lib/mailgun/message.rb

@@ -8,7 +8,7 @@ module Mailgun
     # send email
     def send_email(parameters={})
       # options:
-      # :from, :to, :cc, :bcc, :subject, :text, :html 
+      # :from, :to, :cc, :bcc, :subject, :text, :html
       # :with_attachment
       # :with_attachments
       # :at for delayed delivery time option

data/lib/multimap/.gitignore

@@ -0,0 +1,4 @@
+*.bundle
+coverage/
+html/
+tmp/

data/lib/multimap/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Joshua Peek
+
+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/lib/multimap/README.rdoc

@@ -0,0 +1,16 @@
+= Multimap
+
+A Ruby multimap implementation that also includes multiset and nested multimap implementations.
+
+== Example
+
+  require 'multimap'
+
+  map = Multimap.new
+  map["a"] = 100
+  map["b"] = 200
+  map["a"] = 300
+
+  map["a"]                              # -> [100, 300]
+  map["b"]                              # -> [200]
+  map.keys                              # -> #<Multiset: {"a", "a", "b"}>

data/lib/multimap/Rakefile

@@ -0,0 +1,34 @@
+require 'rubygems/specification'
+spec = eval(File.read('multimap.gemspec'))
+
+if spec.has_rdoc
+  require 'rake/rdoctask'
+
+  Rake::RDocTask.new { |rdoc|
+    rdoc.options = spec.rdoc_options
+    rdoc.rdoc_files = spec.files
+  }
+end
+
+
+task :default => :spec
+
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new do |t|
+  t.warning = true
+end
+
+
+begin
+  require 'rake/extensiontask'
+
+  Rake::ExtensionTask.new do |ext|
+    ext.name = 'nested_multimap_ext'
+    ext.gem_spec = $spec
+  end
+
+  desc "Run specs using C ext"
+  task "spec:ext" => [:compile, :spec, :clobber]
+rescue LoadError
+end

data/lib/multimap/benchmarks/bm_nested_multimap_construction.rb

@@ -0,0 +1,60 @@
+$: << 'lib'
+require 'nested_multimap'
+
+tiny_mapping = {
+  ["a"] => 100
+}
+
+medium_mapping = {
+  ["a"] => 100,
+  ["a", "b", "c"] => 200,
+  ["b"] => 300,
+  ["b", "c"] => 400,
+  ["c"] => 500,
+  ["c", "d"] => 600,
+  ["c", "d", "e"] => 700,
+  ["c", "d", "e", "f"] => 800
+}
+
+huge_mapping = {}
+alpha = ("a".."zz").to_a
+100.times do |n|
+  keys = ("a"..alpha[n % alpha.length]).to_a
+  huge_mapping[keys] = n * 100
+end
+
+require 'benchmark'
+
+Benchmark.bmbm do |x|
+  x.report("base:") {
+    NestedMultimap.new
+  }
+
+  x.report("tiny:") {
+    map = NestedMultimap.new
+    tiny_mapping.each_pair { |keys, value|
+      map[*keys] = value
+    }
+  }
+
+  x.report("medium:") {
+    map = NestedMultimap.new
+    medium_mapping.each_pair { |keys, value|
+      map[*keys] = value
+    }
+  }
+
+  x.report("huge:") {
+    map = NestedMultimap.new
+    huge_mapping.each_pair { |keys, value|
+      map[*keys] = value
+    }
+  }
+end
+
+#   Pure Ruby
+#               user     system      total        real
+# base:     0.000000   0.000000   0.000000 (  0.000014)
+# tiny:     0.000000   0.000000   0.000000 (  0.000054)
+# medium:   0.000000   0.000000   0.000000 (  0.000186)
+# huge:     0.050000   0.000000   0.050000 (  0.051302)

data/lib/multimap/benchmarks/bm_nested_multimap_lookup.rb

@@ -0,0 +1,33 @@
+$: << 'lib'
+require 'nested_multimap'
+
+hash = { "a" => true }
+
+map = NestedMultimap.new
+map["a"] = 100
+map["a", "b", "c"] = 200
+map["a", "b", "c", "d", "e", "f"] = 300
+
+require 'benchmark'
+
+TIMES = 100_000
+Benchmark.bmbm do |x|
+  x.report("base:")    { TIMES.times { hash["a"] } }
+  x.report("best:")    { TIMES.times { map["a"] } }
+  x.report("average:") { TIMES.times { map["a", "b", "c"] } }
+  x.report("worst:")   { TIMES.times { map["a", "b", "c", "d", "e", "f"] } }
+end
+
+#   Pure Ruby
+#                user     system      total        real
+# base:      0.050000   0.000000   0.050000 (  0.049722)
+# best:      0.480000   0.010000   0.490000 (  0.491012)
+# average:   0.770000   0.000000   0.770000 (  0.773535)
+# worst:     1.120000   0.010000   1.130000 (  1.139097)
+
+#   C extension
+#                user     system      total        real
+# base:      0.050000   0.000000   0.050000 (  0.050990)
+# best:      0.090000   0.000000   0.090000 (  0.088981)
+# average:   0.130000   0.000000   0.130000 (  0.132098)
+# worst:     0.150000   0.000000   0.150000 (  0.158293)

data/lib/multimap/ext/extconf.rb

@@ -0,0 +1,6 @@
+if RUBY_PLATFORM == 'java'
+  File.open('Makefile', 'w') { |f| f.puts("install:\n\t$(echo Skipping native extensions)") }
+else
+  require 'mkmf'
+  create_makefile('nested_multimap_ext')
+end

data/lib/multimap/ext/nested_multimap_ext.c

@@ -0,0 +1,24 @@
+#include "ruby.h"
+
+VALUE cNestedMultimap;
+
+static VALUE rb_nested_multimap_aref(int argc, VALUE *argv, VALUE self)
+{
+	int i;
+	VALUE r, h;
+
+	for (i = 0, r = self; rb_obj_is_kind_of(r, cNestedMultimap) == Qtrue; i++) {
+		h = rb_funcall(r, rb_intern("_internal_hash"), 0);
+		Check_Type(h, T_HASH);
+		r = (i < argc) ? rb_hash_aref(h, argv[i]) : RHASH(h)->ifnone;
+	}
+
+	return r;
+}
+
+void Init_nested_multimap_ext() {
+	cNestedMultimap = rb_const_get(rb_cObject, rb_intern("NestedMultimap"));
+	// rb_funcall(cNestedMultimap, rb_intern("remove_method"), 1, rb_intern("[]"));
+	rb_eval_string("NestedMultimap.send(:remove_method, :[])");
+	rb_define_method(cNestedMultimap, "[]", rb_nested_multimap_aref, -1);
+}