mailgun 0.8 → 0.11

data/spec/list_spec.rb

@@ -16,9 +16,9 @@ describe Mailgun::MailingList do
   describe "list mailing lists" do
     it "should make a GET request with the right params" do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
-      Mailgun.should_receive(:submit)
+      expect(Mailgun).to receive(:submit)
       .with(:get, "#{@mailgun.lists.send(:list_url)}", {}).and_return(sample_response)
-    
+
       @mailgun.lists.list
     end
   end
@@ -26,7 +26,7 @@ describe Mailgun::MailingList do
   describe "find list adress" do
     it "should make a GET request with correct params to find given email address" do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
-      Mailgun.should_receive(:submit)
+      expect(Mailgun).to receive(:submit)
       .with(:get, "#{@mailgun.lists.send(:list_url, @sample[:list_email])}")
       .and_return(sample_response)
 
@@ -37,7 +37,7 @@ describe Mailgun::MailingList do
   describe "create list" do
     it "should make a POST request with correct params to add a given email address" do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
-      Mailgun.should_receive(:submit)
+      expect(Mailgun).to receive(:submit)
       .with(:post, "#{@mailgun.lists.send(:list_url)}", {:address => @sample[:list_email]})
       .and_return(sample_response)
 
@@ -48,7 +48,7 @@ describe Mailgun::MailingList do
   describe "update list" do
     it "should make a PUT request with correct params" do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
-      Mailgun.should_receive(:submit)
+      expect(Mailgun).to receive(:submit)
       .with(:put, "#{@mailgun.lists.send(:list_url, @sample[:list_email])}", {:address => @sample[:email]})
       .and_return(sample_response)
 
@@ -59,7 +59,7 @@ describe Mailgun::MailingList do
   describe "delete list" do
     it "should make a DELETE request with correct params" do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
-      Mailgun.should_receive(:submit)
+      expect(Mailgun).to receive(:submit)
       .with(:delete, "#{@mailgun.lists.send(:list_url, @sample[:list_email])}")
       .and_return(sample_response)
 

data/spec/log_spec.rb

@@ -16,7 +16,7 @@ describe Mailgun::Log do
     it "should make a GET request with the right params" do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
       log_url = @mailgun.log(@sample[:domain]).send(:log_url)
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:get, log_url, {}).
         and_return(sample_response)
 
@@ -24,4 +24,4 @@ describe Mailgun::Log do
     end
   end
 
-end
+end

data/spec/mailbox_spec.rb

@@ -17,7 +17,7 @@ describe Mailgun::Mailbox do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
       mailboxes_url = @mailgun.mailboxes(@sample[:domain]).send(:mailbox_url)
 
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:get,mailboxes_url, {}).
         and_return(sample_response)
 
@@ -28,7 +28,7 @@ describe Mailgun::Mailbox do
   describe "create mailbox" do
     it "should make a POST request with the right params"	do
       mailboxes_url = @mailgun.mailboxes(@sample[:domain]).send(:mailbox_url)
-      Mailgun.should_receive(:submit)
+      expect(Mailgun).to receive(:submit)
         .with(:post, mailboxes_url,
           :mailbox  => @sample[:email],
           :password => @sample[:password])
@@ -41,7 +41,7 @@ describe Mailgun::Mailbox do
   describe "update mailbox" do
     it "should make a PUT request with the right params" do
       mailboxes_url = @mailgun.mailboxes(@sample[:domain]).send(:mailbox_url, @sample[:mailbox_name])
-      Mailgun.should_receive(:submit)
+      expect(Mailgun).to receive(:submit)
         .with(:put, mailboxes_url, :password => @sample[:password])
         .and_return({})
 
@@ -53,7 +53,7 @@ describe Mailgun::Mailbox do
   describe "destroy mailbox" do
     it "should make a DELETE request with the right params" do
       mailboxes_url = @mailgun.mailboxes(@sample[:domain]).send(:mailbox_url, @sample[:name])
-      Mailgun.should_receive(:submit)
+      expect(Mailgun).to receive(:submit)
         .with(:delete, mailboxes_url)
         .and_return({})
 

data/spec/route_spec.rb

@@ -16,7 +16,7 @@ describe Mailgun::Route do
 }
 EOF.to_json
 
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:get, "#{@mailgun.routes.send(:route_url)}", {}).
         and_return(sample_response)
     end
@@ -26,7 +26,7 @@ EOF.to_json
     end
 
     it "should respond with an Array" do
-      @mailgun.routes.list.should be_kind_of(Array)
+      expect(@mailgun.routes.list).to be_kind_of(Array)
     end
   end
 
@@ -48,7 +48,7 @@ EOF.to_json
 }
 EOF
 
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:get, "#{@mailgun.routes.send(:route_url, @sample_route_id)}").
         and_return(sample_response)
 
@@ -65,10 +65,10 @@ EOF
       options[:expression]  = [:match_recipient, "sample.mailgun.org"]
       options[:action]      = [[:forward, "http://test-site.com"], [:stop]]
 
-      Mailgun.should_receive(:submit)
-        .with(:post, @mailgun.routes.send(:route_url), instance_of(Multimap))
+      expect(Mailgun).to receive(:submit)
+        .with(:post, @mailgun.routes.send(:route_url), instance_of(Hash))
         .and_return("{\"route\": {\"id\": \"@sample_route_id\"}}")
-      
+
       @mailgun.routes.create(
         options[:description],
         options[:priority],
@@ -80,11 +80,10 @@ EOF
 
   describe "update route" do
     it "should make a PUT request with the right params" do
-      options = {}
-      options[:description] = "test_route"
+      options = { description: "test_route" }
 
-      Mailgun.should_receive(:submit)
-        .with(:put, "#{@mailgun.routes.send(:route_url, @sample_route_id)}", instance_of(Multimap))
+      expect(Mailgun).to receive(:submit)
+        .with(:put, "#{@mailgun.routes.send(:route_url, @sample_route_id)}", { 'description' => ["test_route"] })
         .and_return("{\"id\": \"#{@sample_route_id}\"}")
       @mailgun.routes.update @sample_route_id, options
     end
@@ -92,7 +91,7 @@ EOF
 
   describe "delete route" do
     it "should make a DELETE request with the right params" do
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:delete, "#{@mailgun.routes.send(:route_url, @sample_route_id)}").
         and_return("{\"id\": \"#{@sample_route_id}\"}")
       @mailgun.routes.destroy @sample_route_id

data/spec/secure_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+require './spec/helpers/mailgun_helper.rb'
+
+RSpec.configure do |c|
+  c.include MailgunHelper
+end
+
+describe Mailgun::Secure do
+
+  before :each do
+    @mailgun = Mailgun({:api_key => "some-api-key"})   # used to get the default values
+  end
+
+  it "generate_request_auth helper should generate a timestamp, a token and a signature" do
+    timestamp, token, signature = generate_request_auth("some-api-key")
+
+    expect(timestamp).to_not    be_nil
+    expect(token.length).to     eq 50
+    expect(signature.length).to eq 64
+  end
+
+  it "check_request_auth should return true for a recently generated authentication" do
+    timestamp, token, signature = generate_request_auth("some-api-key")
+
+    result = @mailgun.secure.check_request_auth(timestamp, token, signature)
+
+    expect(result).to be true
+  end
+
+  it "check_request_auth should return false for an authentication generated more than 5 minutes ago" do
+    timestamp, token, signature = generate_request_auth("some-api-key", -6)
+
+    result = @mailgun.secure.check_request_auth(timestamp, token, signature)
+
+    expect(result).to be false
+  end
+
+  it "check_request_auth should return true for an authentication generated any time when the check offset is 0" do
+    timestamp, token, signature = generate_request_auth("some-api-key", -6)
+
+    result = @mailgun.secure.check_request_auth(timestamp, token, signature, 0)
+
+    expect(result).to be true
+  end
+
+  it "check_request_auth should return false for a different api key, token or signature" do
+    timestamp, token, signature = generate_request_auth("some-different-api-key")
+
+    result = @mailgun.secure.check_request_auth(timestamp, token, signature)
+
+    expect(result).to be false
+  end
+
+end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'simplecov'
 SimpleCov.start
 
 require "rspec"
+require "pry"
 require "mailgun"
 
 RSpec.configure do |config|

data/spec/unsubscribe_spec.rb

@@ -9,7 +9,7 @@ describe Mailgun::Unsubscribe do
       :email  => "test@sample.mailgun.org",
       :name   => "test",
       :domain => "sample.mailgun.org",
-      :tag   => 'tag1' 
+      :tag   => 'tag1'
     }
   end
 
@@ -17,7 +17,7 @@ describe Mailgun::Unsubscribe do
     it "should make a GET request with the right params" do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
       unsubscribes_url = @mailgun.unsubscribes(@sample[:domain]).send(:unsubscribe_url)
-      Mailgun.should_receive(:submit).
+      expect(Mailgun).to receive(:submit).
         with(:get, unsubscribes_url, {}).
         and_return(sample_response)
 
@@ -30,7 +30,7 @@ describe Mailgun::Unsubscribe do
       sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
       unsubscribes_url = @mailgun.unsubscribes(@sample[:domain]).send(:unsubscribe_url, @sample[:email])
 
-      Mailgun.should_receive(:submit)
+      expect(Mailgun).to receive(:submit)
         .with(:get, unsubscribes_url)
         .and_return(sample_response)
 
@@ -43,7 +43,7 @@ describe Mailgun::Unsubscribe do
       response_message = "{\"message\"=>\"Unsubscribe event has been removed\", \"address\"=>\"#{@sample[:email]}\"}"
       unsubscribes_url = @mailgun.unsubscribes(@sample[:domain]).send(:unsubscribe_url, @sample[:email])
 
-      Mailgun.should_receive(:submit)
+      expect(Mailgun).to receive(:submit)
         .with(:delete, unsubscribes_url)
         .and_return(response_message)
 
@@ -55,7 +55,7 @@ describe Mailgun::Unsubscribe do
     context "to tag" do
       it "should make a POST request with correct params to add a given email address to unsubscribe from a tag" do
         response_message = "{\"message\"=>\"Address has been added to the unsubscribes table\", \"address\"=>\"#{@sample[:email]}\"}"
-        Mailgun.should_receive(:submit)
+        expect(Mailgun).to receive(:submit)
           .with(:post, "#{@mailgun.unsubscribes(@sample[:domain]).send(:unsubscribe_url)}",{:address=>@sample[:email], :tag=>@sample[:tag]})
           .and_return(response_message)
 
@@ -68,7 +68,7 @@ describe Mailgun::Unsubscribe do
         sample_response = "{\"items\": [{\"size_bytes\": 0,  \"mailbox\": \"postmaster@bsample.mailgun.org\" }  ]}"
         unsubscribes_url = @mailgun.unsubscribes(@sample[:domain]).send(:unsubscribe_url)
 
-        Mailgun.should_receive(:submit)
+        expect(Mailgun).to receive(:submit)
           .with(:post, unsubscribes_url, {
             :address => @sample[:email], :tag => '*'
           })

data/spec/webhook_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe Mailgun::Webhook do
+
+  before :each do
+    @mailgun = Mailgun({:api_key => "api-key", :webhook_url => "http://postbin.heroku.com/860bcd65"})
+
+    @sample = {
+      :id     => "click",
+      :url    => "http://postbin.heroku.com/860bcd65"
+    }
+  end
+
+  describe "list avabilable webhook ids" do
+    it "should return the correct ids" do
+      expect(@mailgun.webhooks.available_ids).to match_array %i(bounce deliver drop spam unsubscribe click open)
+    end
+  end
+
+  describe "list webhooks" do
+    it "should make a GET request with the correct params" do
+
+      sample_response = "{\"total_count\": 1, \"items\": [{\"webhooks\":{\"open\":{\"url\":\"http://postbin.heroku.com/860bcd65\"},\"click\":{\"url\":\"http://postbin.heroku.com/860bcd65\"}}}]}"
+      webhooks_url = @mailgun.webhooks.send(:webhook_url)
+
+      expect(Mailgun).to receive(:submit).
+        with(:get, webhooks_url).
+        and_return(sample_response)
+
+      @mailgun.webhooks.list
+    end
+  end
+
+  describe "find a webhook" do
+    it "should make a GET request with correct params to find a given webhook" do
+      sample_response = "{\"webhook\": {\"url\":\"http://postbin.heroku.com/860bcd65\"}"
+      webhooks_url = @mailgun.webhooks.send(:webhook_url, @sample[:id])
+
+      expect(Mailgun).to receive(:submit).
+        with(:get, webhooks_url).
+        and_return(sample_response)
+
+      @mailgun.webhooks.find(@sample[:id])
+    end
+  end
+
+  describe "add a webhook" do
+    context "using the default webhook url" do
+      it "should make a POST request with correct params to add a webhook" do
+        sample_response = "{\"message\":\"Webhook has been created\",\"webhook\":{\"url\":\"http://postbin.heroku.com/860bcd65\"}}"
+        webhooks_url = @mailgun.webhooks.send(:webhook_url)
+
+        expect(Mailgun).to receive(:submit).
+          with(:post, webhooks_url, {:id => @sample[:id], :url => @sample[:url]}).
+          and_return(sample_response)
+
+        @mailgun.webhooks.create(@sample[:id])
+      end
+    end
+    context "overwriting the default webhook url" do
+      it "should make a POST request with correct params to add a webhook" do
+        sample_response = "{\"message\":\"Webhook has been created\",\"webhook\":{\"url\":\"http://postbin.heroku.com/860bcd65\"}}"
+        webhooks_url = @mailgun.webhooks.send(:webhook_url)
+        overwritten_url = 'http://mailgun.net/webhook'
+
+        expect(Mailgun).to receive(:submit).
+          with(:post, webhooks_url, {:id => @sample[:id], :url => overwritten_url}).
+          and_return(sample_response)
+
+        @mailgun.webhooks.create(@sample[:id], overwritten_url)
+      end
+    end
+  end
+
+  describe "update a webhook" do
+    context "using the default webhook url" do
+      it "should make a POST request with correct params to add a webhook" do
+        sample_response = "{\"message\":\"Webhook has been updated\",\"webhook\":{\"url\":\"http://postbin.heroku.com/860bcd65\"}}"
+        webhooks_url = @mailgun.webhooks.send(:webhook_url, @sample[:id])
+
+        expect(Mailgun).to receive(:submit).
+          with(:put, webhooks_url, {:url => @sample[:url]}).
+          and_return(sample_response)
+
+        @mailgun.webhooks.update(@sample[:id])
+      end
+    end
+    context "overwriting the default webhook url" do
+      it "should make a POST request with correct params to add a webhook" do
+        sample_response = "{\"message\":\"Webhook has been updated\",\"webhook\":{\"url\":\"http://postbin.heroku.com/860bcd65\"}}"
+        webhooks_url = @mailgun.webhooks.send(:webhook_url, @sample[:id])
+        overwritten_url = 'http://mailgun.net/webhook'
+
+        expect(Mailgun).to receive(:submit).
+          with(:put, webhooks_url, {:url => overwritten_url}).
+          and_return(sample_response)
+
+        @mailgun.webhooks.update(@sample[:id], overwritten_url)
+      end
+    end
+  end
+
+  describe "delete a webhook" do
+    it "should make a DELETE request with correct params" do
+      sample_response = "{\"message\":\"Webhook has been deleted\",\"webhook\":{\"url\":\"http://postbin.heroku.com/860bcd65\"}}"
+      webhooks_url = @mailgun.webhooks.send(:webhook_url, @sample[:id])
+
+      expect(Mailgun).to receive(:submit).
+        with(:delete, webhooks_url).
+        and_return(sample_response)
+
+      @mailgun.webhooks.delete(@sample[:id])
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailgun
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: '0.11'
 platform: ruby
 authors:
 - Akash Manohar J
@@ -9,22 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-09 00:00:00.000000000 Z
+date: 2016-10-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -40,7 +26,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,19 +40,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 description: Mailgun library for Ruby
 email:
 - akash@akash.im
@@ -75,14 +61,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CONTRIBUTORS.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/mailgun.rb
+- lib/mailgun/address.rb
 - lib/mailgun/base.rb
 - lib/mailgun/bounce.rb
+- lib/mailgun/client.rb
 - lib/mailgun/complaint.rb
 - lib/mailgun/domain.rb
 - lib/mailgun/list.rb
@@ -92,7 +81,9 @@ files:
 - lib/mailgun/mailgun_error.rb
 - lib/mailgun/message.rb
 - lib/mailgun/route.rb
+- lib/mailgun/secure.rb
 - lib/mailgun/unsubscribe.rb
+- lib/mailgun/webhook.rb
 - lib/multimap/.gitignore
 - lib/multimap/LICENSE
 - lib/multimap/README.rdoc
@@ -113,18 +104,23 @@ files:
 - lib/multimap/spec/set_examples.rb
 - lib/multimap/spec/spec_helper.rb
 - mailgun.gemspec
+- spec/address_spec.rb
 - spec/base_spec.rb
 - spec/bounce_spec.rb
+- spec/client_spec.rb
 - spec/complaint_spec.rb
 - spec/domain_spec.rb
+- spec/helpers/mailgun_helper.rb
 - spec/list/member_spec.rb
 - spec/list/message_spec.rb
 - spec/list_spec.rb
 - spec/log_spec.rb
 - spec/mailbox_spec.rb
 - spec/route_spec.rb
+- spec/secure_spec.rb
 - spec/spec_helper.rb
 - spec/unsubscribe_spec.rb
+- spec/webhook_spec.rb
 homepage: http://github.com/HashNuke/mailgun
 licenses: []
 metadata: {}
@@ -144,20 +140,25 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Idiomatic library for using the mailgun API from within ruby
 test_files:
+- spec/address_spec.rb
 - spec/base_spec.rb
 - spec/bounce_spec.rb
+- spec/client_spec.rb
 - spec/complaint_spec.rb
 - spec/domain_spec.rb
+- spec/helpers/mailgun_helper.rb
 - spec/list/member_spec.rb
 - spec/list/message_spec.rb
 - spec/list_spec.rb
 - spec/log_spec.rb
 - spec/mailbox_spec.rb
 - spec/route_spec.rb
+- spec/secure_spec.rb
 - spec/spec_helper.rb
 - spec/unsubscribe_spec.rb
+- spec/webhook_spec.rb