mailgun-ruby 1.0.3 → 1.1.0

data/spec/integration/routes_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "routes" }
+
+describe 'For the Routes endpoint', order: :defined, vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+    @forward_to = "alice@#{@domain}"
+    @recipient = ".*@#{@domain}"
+  end
+
+  it 'creates a route' do
+    result = @mg_obj.post("routes",  { priority: 10,
+                                       description: 'Integration Test Route',
+                                       expression: "match_recipient(\"#{@forward_to}\")",
+                                       action: "forward(\"#{@recipient}\")" })
+
+    result.to_h!
+    expect(result.body["message"]).to eq("Route has been created")
+    expect(result.body["route"]["description"]).to eq("Integration Test Route")
+    expect(result.body["route"]["actions"]).to include("forward(\"#{@recipient}\")")
+    expect(result.body["route"]["expression"]).to include("match_recipient(\"#{@forward_to}\")")
+    expect(result.body["route"]["priority"]).to eq(10)
+  end
+
+  it 'gets a list of all routes.' do
+    result = @mg_obj.get("routes", {:limit => 50})
+
+    result.to_h!
+    expect(result.body["total_count"]).to be > 0
+  end
+
+  it 'gets the route.' do
+    result = @mg_obj.get("routes", {:limit => 1})
+    route_id = result.to_h['items'].first['id']
+
+    result = @mg_obj.get("routes/#{route_id}")
+
+    result.to_h!
+    expect(result.body["route"]["description"]).to eq("Integration Test Route")
+    expect(result.body["route"]["actions"]).to include("forward(\"#{@recipient}\")")
+    expect(result.body["route"]["expression"]).to include("match_recipient(\"#{@forward_to}\")")
+    expect(result.body["route"]["priority"]).to eq(10)
+  end
+
+  it 'updates the route.' do
+    result = @mg_obj.get("routes", {:limit => 1})
+    route_id = result.to_h['items'].first['id']
+
+    result = @mg_obj.put("routes/#{route_id}",  {:priority => 10,
+                                                  :description => 'Integration Test Route Update',
+                                                  :expression => "match_recipient(\"#{@forward_to}\")",
+                                                  :action => "forward(\"#{@recipient}\")"})
+
+    result.to_h!
+    expect(result.body["message"]).to eq("Route has been updated")
+    expect(result.body["description"]).to eq("Integration Test Route Update")
+    expect(result.body["actions"]).to include("forward(\"#{@recipient}\")")
+    expect(result.body["expression"]).to include("match_recipient(\"#{@forward_to}\")")
+    expect(result.body["priority"]).to eq(10)
+  end
+
+  it 'removes a route' do
+    result = @mg_obj.get("routes", {:limit => 1})
+    route_id = result.to_h['items'].first['id']
+
+    @mg_obj.delete("routes/#{route_id}")
+
+    result.to_h!
+  end
+
+end

data/spec/integration/stats_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "stats" }
+
+describe 'For the Stats endpoint', vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+  end
+
+  it 'get some stats.' do
+    @mg_obj.get("#{@domain}/stats", {:limit => 50, :skip => 10, :event => 'sent'})
+  end
+end

data/spec/integration/unsubscribes_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "unsubscribes" }
+
+describe 'For the Unsubscribes endpoint', order: :defined, vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+    @email = "integration-test-email@#{TESTDOMAIN}"
+  end
+
+  it 'adds an unsubscriber' do
+    result = @mg_obj.post "#{@domain}/unsubscribes", address: @email, tag: '*'
+
+    result.to_h!
+    expect(result.body["message"]).to eq("Address has been added to the unsubscribes table")
+    expect(result.body["address"]).to eq(@email)
+  end
+
+  it 'get an unsubscribee.' do
+    result = @mg_obj.get "#{@domain}/unsubscribes/#{@email}"
+
+    result.to_h!
+    expect(result.body["address"]).to eq(@email)
+  end
+
+  it 'gets a list of unsubscribes.' do
+    result = @mg_obj.get "#{@domain}/unsubscribes"
+
+    result.to_h!
+    expect(result.body["items"].length).to be > 0
+  end
+
+  it 'removes an unsubscribee' do
+    result = @mg_obj.delete "#{@domain}/unsubscribes/#{@email}"
+
+    result.to_h!
+    expect(result.body['address']).to eq(@email)
+    expect(result.body["message"]).to eq("Unsubscribe event has been removed")
+  end
+end

data/spec/integration/webhook_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "webhooks" }
+
+describe 'For the webhooks endpoint', order: :defined, vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+    @testhook = 'bounce'
+    @testhookup = 'bounceup'
+  end
+
+  it 'creates a webhook' do
+    result = @mg_obj.post("domains/#{@domain}/webhooks", { id: 'bounce',
+                                                           url: "http://example.com/mailgun/events/#{@testhook}" } )
+
+    result.to_h!
+    expect(result.body["message"]).to eq("Webhook has been created")
+    expect(result.body["webhook"]["url"]).to eq("http://example.com/mailgun/events/#{@testhook}")
+  end
+
+  it 'gets a webhook.' do
+    result = @mg_obj.get("domains/#{@domain}/webhooks/#{@testhook}")
+
+    result.to_h!
+    expect(result.body["webhook"]["url"]).to eq("http://example.com/mailgun/events/#{@testhook}")
+  end
+
+  it 'gets a list of all webhooks.' do
+    result = @mg_obj.get("domains/#{@domain}/webhooks")
+
+    result.to_h!
+    expect(result.body["webhooks"]["bounce"]["url"]).to eq("http://example.com/mailgun/events/#{@testhook}")
+  end
+
+  it 'updates a webhook.' do
+    result = @mg_obj.put("domains/#{@domain}/webhooks/bounce", {:id => 'bounce',
+                                                                :url => "http://example.com/mailgun/events/#{@testhookup}"})
+
+    result.to_h!
+    expect(result.body["message"]).to eq("Webhook has been updated")
+    expect(result.body["webhook"]["url"]).to eq("http://example.com/mailgun/events/#{@testhookup}")
+  end
+
+  it 'removes a webhook' do
+    result = @mg_obj.delete("domains/#{@domain}/webhooks/bounce")
+
+    result.to_h!
+    expect(result.body['message']).to eq("Webhook has been deleted")
+    expect(result.body['webhook']['url']).to eq("http://example.com/mailgun/events/#{@testhookup}")
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,15 +1,45 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'rubygems'
 require 'bundler'
 require 'bundler/setup'
 Bundler.setup(:development)
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
 require 'mailgun'
+
+require 'vcr'
+require 'webmock/rspec'
+
+#WebMock.disable_net_connect!(allow_localhost: true)
 require_relative 'unit/connection/test_client'
 
-# INSERT YOUR API KEYS HERE
-APIKEY = "key"
-PUB_APIKEY = "pubkey"
+RSpec.configure do |c|
+  c.raise_errors_for_deprecations!
+end
+
 APIHOST = "api.mailgun.net"
-APIVERSION = "v2"
-SSL= true
+APIVERSION = "v3"
+SSL = true
+
+# For integration tests modify .ruby-env.yml
+# use .ruby-env.yml.example for an example
+# alternatively
+# set environment variables as named in .ruby-env.yml.example
+envfile = File.join(File.dirname(__FILE__), '..','.ruby-env.yml')
+envs = File.exist?(envfile) ? YAML.load_file(envfile) : ENV
+APIKEY = envs['MAILGUN_APIKEY']
+PUB_APIKEY = envs['MAILGUN_PUB_APIKEY']
+TESTDOMAIN = envs['MAILGUN_TESTDOMAIN']
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'vcr_cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.default_cassette_options = { record: :new_episodes }
+  c.filter_sensitive_data('<APIKEY>') { APIKEY }
+  c.filter_sensitive_data('DOMAIN.TEST') { TESTDOMAIN }
+  c.filter_sensitive_data('<PUBKEY>') { PUB_APIKEY }
+end

data/spec/unit/connection/test_client.rb

@@ -1,9 +1,8 @@
-require 'spec_helper'
 require 'time'
 require 'json'
 
 module Mailgun
-  class UnitClient
+  class UnitClient < Mailgun::Client
 
     attr_reader :options, :block, :body, :code, :response
 
@@ -43,32 +42,33 @@ module Mailgun
 
     def post(path, data)
       begin
-        Response.new(response_generator(@endpoint))
-      rescue Exception => e
+        Mailgun::Response.new(response_generator(@endpoint))
+      rescue => e
+        p e
         raise CommunicationError.new(e), e.response
       end
     end
 
     def get(path, query_string = nil)
       begin
-        Response.new(response_generator(@endpoint))
-      rescue Exception => e
+        Mailgun::Response.new(response_generator(@endpoint))
+      rescue => e
         raise CommunicationError.new(e), e.response
       end
     end
 
     def put(path, data)
       begin
-        Response.new(response_generator(@endpoint))
-      rescue Exception => e
+        Mailgun::Response.new(response_generator(@endpoint))
+      rescue => e
         raise CommunicationError.new(e), e.response
       end
     end
 
     def delete(path)
       begin
-        Response.new(response_generator(@endpoint))
-      rescue Exception => e
+        Mailgun::Response.new(response_generator(@endpoint))
+      rescue => e
         raise CommunicationError.new(e), e.response
       end
     end
@@ -79,101 +79,21 @@ module Mailgun
       if resource_endpoint == "messages"
         t = Time.now
         id = "<#{t.to_i}.#{rand(99999999)}.5817@example.com>"
-        return JSON.generate({"message" => "Queued. Thank you.", "id" => id})
+        return OpenStruct.new({ "body" => JSON.generate({"message" => "Queued. Thank you.", "id" => id}) })
       end
       if resource_endpoint == "bounces"
-        return JSON.generate({"total_count" => 1, "items" => {"created_at" => "Fri, 21 Oct 2011 11:02:55 GMT", "code" => 550, "address" => "baz@example.com", "error" => "Message was not accepted -- invalid mailbox. Local mailbox baz@example.com is unavailable: user not found"}})
+        return OpenStruct.new({ "body" => JSON.generate({"total_count" => 1, "items" => {"created_at" => "Fri, 21 Oct 2011 11:02:55 GMT", "code" => 550, "address" => "baz@example.com", "error" => "Message was not accepted -- invalid mailbox. Local mailbox baz@example.com is unavailable: user not found"}}) })
       end
       if resource_endpoint == "lists"
-        return JSON.generate({"member" => {"vars" => {"age" => 26}, "name" => "Foo Bar", "subscribed" => false, "address" => "bar@example.com"}, "message" => "Mailing list member has been updated"})
+        return OpenStruct.new({ "body" => JSON.generate({"member" => {"vars" => {"age" => 26}, "name" => "Foo Bar", "subscribed" => false, "address" => "bar@example.com"}, "message" => "Mailing list member has been updated"}) })
       end
       if resource_endpoint == "campaigns"
-        return JSON.generate({"message" => "Campaign has been deleted", "id" => "ABC123"})
+        return OpenStruct.new({ "body" => JSON.generate({"message" => "Campaign has been deleted", "id" => "ABC123"}) })
       end
       if resource_endpoint == "events"
-        return JSON.generate({"items" => [], "paging" => {"next"=> "https://api.mailgun.net/v2/thisisatestdomainformailgun.com/events/W3siYiI6ICIyMDE0LTA1LTA3VDAwOjQ1OjUxLjc0MDg5MiswMDowMCIsICJlIjogIjIwMTQtMDUtMDVUMDA6NDU6NTEuNzQwOTgzKzAwOjAwIn0sIHsiYiI6ICIyMDE0LTA1LTA3VDAwOjQ1OjUxLjc0MDg5MiswMDowMCIsICJlIjogIjIwMTQtMDUtMDVUMDA6NDU6NTEuNzQwOTgzKzAwOjAwIn0sIFsiZiJdLCBudWxsLCB7ImFjY291bnQuaWQiOiAiNGU4MjMwZjYxNDc2ZDg2NzEzMDBjNDc2IiwgImRvbWFpbi5uYW1lIjogInRoaXNpc2F0ZXN0ZG9tYWluZm9ybWFpbGd1bi5jb20iLCAic2V2ZXJpdHkiOiAiTk9UIGludGVybmFsIn0sIDEwMCwgbnVsbF0=", "previous"=> "https://api.mailgun.net/v2/thisisatestdomainformailgun.com/events/W3siYiI6ICIyMDE0LTA1LTA3VDAwOjQ1OjUxLjc0MDg5MiswMDowMCIsICJlIjogIjIwMTQtMDUtMDVUMDA6NDU6NTEuNzQwOTgzKzAwOjAwIn0sIHsiYiI6ICIyMDE0LTA1LTA3VDAwOjQ1OjUxLjc0MDg5MiswMDowMCIsICJlIjogIjIwMTQtMDUtMDdUMDA6NDU6NTEuNzQxODkyKzAwOjAwIn0sIFsicCIsICJmIl0sIG51bGwsIHsiYWNjb3VudC5pZCI6ICI0ZTgyMzBmNjE0NzZkODY3MTMwMGM0NzYiLCAiZG9tYWluLm5hbWUiOiAidGhpc2lzYXRlc3Rkb21haW5mb3JtYWlsZ3VuLmNvbSIsICJzZXZlcml0eSI6ICJOT1QgaW50ZXJuYWwifSwgMTAwLCBudWxsXQ=="}})
+        return OpenStruct.new({ "body" => JSON.generate({"items" => [], "paging" => {"next"=> "https://api.mailgun.net/v3/thisisatestdomainformailgun.com/events/W3siYiI6ICIyMDE0LTA1LTA3VDAwOjQ1OjUxLjc0MDg5MiswMDowMCIsICJlIjogIjIwMTQtMDUtMDVUMDA6NDU6NTEuNzQwOTgzKzAwOjAwIn0sIHsiYiI6ICIyMDE0LTA1LTA3VDAwOjQ1OjUxLjc0MDg5MiswMDowMCIsICJlIjogIjIwMTQtMDUtMDVUMDA6NDU6NTEuNzQwOTgzKzAwOjAwIn0sIFsiZiJdLCBudWxsLCB7ImFjY291bnQuaWQiOiAiNGU4MjMwZjYxNDc2ZDg2NzEzMDBjNDc2IiwgImRvbWFpbi5uYW1lIjogInRoaXNpc2F0ZXN0ZG9tYWluZm9ybWFpbGd1bi5jb20iLCAic2V2ZXJpdHkiOiAiTk9UIGludGVybmFsIn0sIDEwMCwgbnVsbF0=", "previous"=> "https://api.mailgun.net/v2/thisisatestdomainformailgun.com/events/W3siYiI6ICIyMDE0LTA1LTA3VDAwOjQ1OjUxLjc0MDg5MiswMDowMCIsICJlIjogIjIwMTQtMDUtMDVUMDA6NDU6NTEuNzQwOTgzKzAwOjAwIn0sIHsiYiI6ICIyMDE0LTA1LTA3VDAwOjQ1OjUxLjc0MDg5MiswMDowMCIsICJlIjogIjIwMTQtMDUtMDdUMDA6NDU6NTEuNzQxODkyKzAwOjAwIn0sIFsicCIsICJmIl0sIG51bGwsIHsiYWNjb3VudC5pZCI6ICI0ZTgyMzBmNjE0NzZkODY3MTMwMGM0NzYiLCAiZG9tYWluLm5hbWUiOiAidGhpc2lzYXRlc3Rkb21haW5mb3JtYWlsZ3VuLmNvbSIsICJzZXZlcml0eSI6ICJOT1QgaW50ZXJuYWwifSwgMTAwLCBudWxsXQ=="}}) })
       end
     end
   end
 
-  class Response
-
-    attr_accessor :body
-
-    def initialize(response)
-      @body = response
-    end
-
-    # Return response as Ruby Hash
-    #
-    # @return [Hash] A standard Ruby Hash containing the HTTP result.
-
-    def to_h
-      begin
-        JSON.parse(@body)
-      rescue Exception => e
-        raise ParseError.new(e), e
-      end
-    end
-
-    # Replace @body with Ruby Hash
-    #
-    # @return [Hash] A standard Ruby Hash containing the HTTP result.
-
-    def to_h!
-      begin
-        @body = JSON.parse(@body)
-      rescue Exception => e
-        raise ParseError.new(e), e
-      end
-    end
-
-    # Return response as Yaml
-    #
-    # @return [String] A string containing response as YAML
-
-    def to_yaml
-      begin
-        YAML::dump(JSON.parse(@body))
-      rescue Exception => e
-        raise ParseError.new(e), e
-      end
-    end
-
-    # Replace @body with YAML
-    #
-    # @return [String] A string containing response as YAML
-
-    def to_yaml!
-      begin
-        @body = YAML::dump(JSON.parse(@body))
-      rescue Exception => e
-        raise ParseError.new(e), e
-      end
-    end
-
-    # Return response as Yaml
-    #
-    # @return [String] A string containing response as YAML
-
-    def to_y
-      begin
-        YAML::dump(JSON.parse(@body))
-      rescue Exception => e
-        raise ParseError.new(e), e
-      end
-    end
-
-    # Replace @body with YAML
-    #
-    # @return [String] A string containing response as YAML
-
-    def to_y!
-      begin
-        @body = YAML::dump(JSON.parse(@body))
-      rescue Exception => e
-        raise ParseError.new(e), e
-      end
-    end
-  end
 end

data/spec/unit/events/events_spec.rb

@@ -5,8 +5,9 @@ describe 'The method get' do
     @mg_obj = Mailgun::UnitClient.new('events')
     events = Mailgun::Events.new(@mg_obj, "samples.mailgun.org")
     result = events.get()
-    result.body.should include("items")
-    result.body.should include("paging")
+    
+    expect(result.body).to include("items")
+    expect(result.body).to include("paging")
   end
 end
 
@@ -16,8 +17,9 @@ describe 'The method next' do
     @mg_obj = Mailgun::UnitClient.new('events')
     events = Mailgun::Events.new(@mg_obj, "samples.mailgun.org")
     result = events.next()
-    result.body.should include("items")
-    result.body.should include("paging")
+    
+    expect(result.body).to include("items")
+    expect(result.body).to include("paging")
   end
 end
 
@@ -26,7 +28,8 @@ describe 'The method previous' do
     @mg_obj = Mailgun::UnitClient.new('events')
     events = Mailgun::Events.new(@mg_obj, "samples.mailgun.org")
     result = events.previous()
-    result.body.should include("items")
-    result.body.should include("paging")
+
+    expect(result.body).to include("items")
+    expect(result.body).to include("paging")
   end
 end

data/spec/unit/lists/opt_in_handler_spec.rb

@@ -10,13 +10,15 @@ describe 'The method generate_hash' do
 
   it 'generates a web safe hash for the recipient wishing to subscribe' do
     my_hash = Mailgun::OptInHandler.generate_hash(@mailing_list, @secret_app_id, @recipient_address)
-    my_hash.should eq(@precalculated_hash)
+    
+    expect(my_hash).to eq(@precalculated_hash)
   end
 
   it 'generates a web safe hash for the recipient wishing to subscribe' do
     validate_result = Mailgun::OptInHandler.validate_hash(@secret_app_id, @precalculated_hash)
-    validate_result.length.should eq(2)
-    validate_result['recipient_address'].should eq(@recipient_address)
-    validate_result['mailing_list'].should eq(@mailing_list)
+    
+    expect(validate_result.length).to eq(2)
+    expect(validate_result['recipient_address']).to eq(@recipient_address)
+    expect(validate_result['mailing_list']).to eq(@mailing_list)
   end
 end