Test mode implementation, #24

README.md

@@ -19,7 +19,7 @@ gem install mailgun-ruby
 Gemfile:
 
 ```ruby
-gem 'mailgun-ruby', '~>1.1.1'
+gem 'mailgun-ruby', '~>1.1.2'
 ```
 
 Usage
@@ -45,7 +45,7 @@ Or obtain the last couple log items:
 
 ```ruby
 # First, instantiate the Mailgun Client with your API key
-mg_client = Mailgun::Client.new 'your-api-key'
+mg_client = Mailgun::Client.new 'your-secret-api-key'
 
 # Define the domain you wish to query
 domain = 'example.com'
@@ -60,7 +60,7 @@ Rails
 The library can be initialized with a Rails initializer containing similar:
 ```ruby
 Mailgun.configure do |config|
-  config.api_key = 'your-secret-key'
+  config.api_key = 'your-secret-api-key'
 end
 ```
 Or have the initializer read your environment setting if you perfer.

lib/mailgun/client.rb

@@ -12,13 +12,36 @@ class Client
     def initialize(api_key = Mailgun.api_key,
                    api_host = 'api.mailgun.net',
                    api_version = 'v3',
-                   ssl = true)
+                   ssl = true,
+                   test_mode = false)
 
       endpoint = endpoint_generator(api_host, api_version, ssl)
       @http_client = RestClient::Resource.new(endpoint,
                                               user: 'api',
                                               password: api_key,
                                               user_agent: "mailgun-sdk-ruby/#{Mailgun::VERSION}")
+      @test_mode = test_mode
+    end
+
+    # Enable test mode
+    #
+    # Prevents sending of any messages.
+    def enable_test_mode!
+      @test_mode = true
+    end
+
+    # Disable test mode
+    #
+    # Reverts the test_mode flag and allows the client to send messages.
+    def disable_test_mode!
+      @test_mode = false
+    end
+
+    # Client is in test mode?
+    #
+    # @return [Boolean] Is the client set in test mode?
+    def test_mode?
+      @test_mode
     end
 
     # Simple Message Sending
@@ -28,6 +51,15 @@ def initialize(api_key = Mailgun.api_key,
     # containing required parameters for the requested resource.
     # @return [Mailgun::Response] A Mailgun::Response object.
     def send_message(working_domain, data)
+      if test_mode? then
+        return Response.from_hash(
+          {
+            :body => '{"id": "test-mode-mail@localhost", "message": "Queued. Thank you."}',
+            :code => 200,
+          }
+        )
+      end
+
       case data
       when Hash
         if data.key?(:message)

lib/mailgun/response.rb

@@ -1,3 +1,5 @@
+require 'ostruct'
+
 module Mailgun
   # A Mailgun::Response object is instantiated for each response generated
   # by the Client request. The Response object supports deserialization of
@@ -10,6 +12,11 @@ class Response
     #   slightly different
     attr_accessor :body, :code
 
+    def self.from_hash(h)
+      # Create a "fake" response object with the data passed from h
+      self.new OpenStruct.new(h)
+    end
+
     def initialize(response)
       @body = response.body
       @code = response.code

lib/mailgun/version.rb

@@ -1,4 +1,4 @@
 # It's the version. Yeay!
 module Mailgun
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end

spec/integration/mailgun_spec.rb

@@ -54,6 +54,28 @@
     expect(result.body).to include("id")
   end
 
+  it 'fakes message send while in *client* test mode' do
+    @mg_obj.enable_test_mode!
+
+    expect(@mg_obj.test_mode?).to eq(true)
+
+    data = { :from => "joe@#{@domain}",
+             :to => "bob@#{@domain}",
+             :subject => "Test",
+             :text => "Test Data" }
+
+    result = @mg_obj.send_message(@domain, data)
+
+    result.to_h!
+
+    expect(result.body).to include("message")
+    expect(result.body).to include("id")
+
+    expect(result.code).to eq(200)
+    expect(result.body['id']).to eq("test-mode-mail@localhost")
+    expect(result.body['message']).to eq("Queued. Thank you.")
+  end
+
   it 'sends a message builder message in test mode.' do
     mb_obj = Mailgun::MessageBuilder.new()
     mb_obj.from("sender@#{@domain}", {'first' => 'Sending', 'last' => 'User'})

spec/unit/mailgun_spec.rb

@@ -25,9 +25,9 @@
 
   it 'sends a message' do
     data = { 'from' => 'joe@test.com',
-                    'to' => 'bob@example.com',
-                    'subject' => 'Test',
-                    'text' => 'Test Data'}
+             'to' => 'bob@example.com',
+             'subject' => 'Test',
+             'text' => 'Test Data' }
     result = @mg_obj.send_message("testdomain.com", data)
 
     result.to_h!
@@ -42,7 +42,7 @@
     result = @mg_obj.send_message("testdomain.com", data)
 
     result.to_h!
-    
+
     expect(result.body).to include("message")
     expect(result.body).to include("id")
   end
@@ -61,7 +61,7 @@
     result = @mg_obj.post("#{@domain}/messages", data)
 
     result.to_h!
-    
+
     expect(result.body).to include("message")
     expect(result.body).to include("id")
   end
@@ -81,7 +81,7 @@
     result = @mg_obj.put("lists/#{@list_address}/members#{@member_address}", data)
 
     result.to_h!
-    
+
     expect(result.body).to include("member")
     expect(result.body["member"]).to include("vars")
     expect(result.body["member"]["vars"]).to include("age")
@@ -104,7 +104,7 @@
     result = @mg_obj.get("#{@domain}/bounces", query_string)
 
     result.to_h!
-    
+
     expect(result.body).to include("total_count")
     expect(result.body).to include("items")
   end
@@ -120,7 +120,7 @@
     result = @mg_obj.delete("#{@domain}/campaigns/ABC123")
 
     result.to_h!
-    
+
     expect(result.body).to include("message")
     expect(result.body).to include("id")
   end