mailgun-ruby 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e560063e4d8cf1632c762c36b84bafa2c7eb356
-  data.tar.gz: df5159ba95e42cdb82a4102c6af18f6e35c3523b
+  metadata.gz: 8d2289f0c188dd1fd14e9560f3e7f9d8b14e9193
+  data.tar.gz: 35e39b90b7185d846a515c642b7eb2340f09d37d
 SHA512:
-  metadata.gz: 50ad029f9bf264cc0393413a61b3de2fd24269cac123d1ea26e72edc320fd8cf9d9080d346604c2aaf4055edf2e990453beadeee096cf03df58801522dab5420
-  data.tar.gz: 9c5228866ab40ae51021adf56cb71ba578de65c9fc8d72f0b9af7985c2971357bd3cc12333b41037826af4d46a01322c05d4d1be949baa9a034dde5e11fc74ed
+  metadata.gz: ad0617bd4042f6dc27561c5ee864ec84f034f40c2b2fde569d996e10adfe830dbc9983d71b1be34dfd236154918c2659d1cebdee0487cb7e70f7685419037503
+  data.tar.gz: 39002d5ffd24977418dadc676925df6503cd09aa73122bf3c5c2b15fac8575dcf3717e4a11b4d28229b283123c35ccf0b8aaaffb47c63b75dc5b9f201bf5fcde

data/README.md

@@ -18,7 +18,7 @@ gem install mailgun-ruby
 Gemfile:
 
 ```ruby
-gem 'mailgun-ruby', "~>1.0.1"
+gem 'mailgun-ruby', "~>1.0.2"
 ```
 
 Include

data/lib/mailgun.rb

@@ -6,6 +6,7 @@ require 'json'
 require "mailgun/version"
 require "mailgun/lists/opt_in_handler"
 require "mailgun/messages/batch_message"
+require "mailgun/events/events"
 require "mailgun/messages/message_builder"
 require "mailgun/exceptions/exceptions"
 
@@ -84,7 +85,7 @@ module Mailgun
     def get(resource_path, params=nil, accept="*/*")
       begin
         if params
-          response = http_client[resource_path].get(:params => params, :accept => accept)
+          response = @http_client[resource_path].get(:params => params, :accept => accept)
         else
           response = @http_client[resource_path].get(:accept => accept)
         end

data/lib/mailgun/events/events.rb

@@ -0,0 +1,74 @@
+require 'mailgun'
+require "mailgun/exceptions/exceptions"
+
+
+module Mailgun
+
+  # A Mailgun::Events object makes it really simple to consume
+  # Mailgun's events from the Events endpoint.
+  #
+  #
+  # See the Github documentation for full examples.
+
+  class Events
+
+    def initialize(client, domain)
+      @client = client
+      @domain = domain
+      @paging_next = nil
+      @paging_previous = nil
+    end
+
+    # Issues a simple get against the client.
+    #
+    # @param [Hash] params A hash of query options and/or filters.
+    # @return [Mailgun::Response] Mailgun Response object.
+
+    def get(params=nil)
+      _get(params)
+    end
+
+    # Using built in paging, obtains the next set of data.
+    #
+    # @return [Mailgun::Response] Mailgun Response object.
+
+    def next()
+      _get(nil, @paging_next)
+    end
+
+    # Using built in paging, obtains the previous set of data.
+    #
+    # @return [Mailgun::Response] Mailgun Response object.
+
+    def previous()
+      _get(nil, @paging_previous)
+    end
+
+    private
+
+    def _get(params=nil, paging=nil)
+      response = @client.get(construct_url(paging), params)
+      extract_paging(response)
+      response
+    end
+
+    def extract_paging(response)
+      paging_next = response.to_h["paging"]["next"]
+      paging_previous = response.to_h["paging"]["previous"]
+
+      # This is pretty hackish. But the URL will never change in API v2.
+      @paging_next = paging_next.split("/")[6]
+      @paging_previous = paging_previous.split("/")[6]
+    end
+
+    def construct_url(paging=nil)
+      if paging
+        "#{@domain}/events/#{paging}"
+      else
+        "#{@domain}/events"
+      end
+    end
+
+  end
+
+end

data/lib/mailgun/lists/opt_in_handler.rb

@@ -1,7 +1,7 @@
-require 'digest'
 require 'json'
 require 'uri'
 require 'base64'
+require 'digest/hmac'
 
 module Mailgun
 
@@ -16,11 +16,19 @@ module Mailgun
     # @return [String] A url encoded URL suffix hash.
 
     def self.generate_hash(mailing_list, secret_app_id, recipient_address)
-      hash = {'s' => Digest::MD5.hexdigest("#{secret_app_id}#{recipient_address}"),
-              'l' => mailing_list,
-              'r' => recipient_address}
+      innerPayload = {'l' => mailing_list,
+                      'r' => recipient_address}
 
-      URI.escape(Base64.encode64(JSON.generate(hash)))
+      innerPayloadEncoded = Base64.encode64(JSON.generate(innerPayload))
+
+      digest = Digest::HMAC.hexdigest(innerPayloadEncoded, secret_app_id, Digest::SHA1)
+
+      outerPayload = {'h' => digest,
+                      'p' => innerPayloadEncoded}
+
+      outerPayloadEncoded = Base64.encode64(JSON.generate(outerPayload))
+
+      URI.escape(outerPayloadEncoded)
     end
 
     # Validates the hash provided from the generate_hash method.
@@ -30,12 +38,16 @@ module Mailgun
     # @return [Hash or Boolean] A hash with 'recipient_address' and 'mailing_list', if validates. Otherwise, boolean false.
 
     def self.validate_hash(secret_app_id, unique_hash)
-      url_parameters = JSON.parse(Base64.decode64(URI.unescape(unique_hash)))
-      generated_hash = Digest::MD5.hexdigest("#{secret_app_id}#{url_parameters['r']}")
-      hash_provided = url_parameters['s']
+      outerPayload = JSON.parse(Base64.decode64(URI.unescape(unique_hash)))
+
+      generated_hash = Digest::HMAC.hexdigest(outerPayload['p'], secret_app_id, Digest::SHA1)
+
+      innerPayload = JSON.parse(Base64.decode64(URI.unescape(outerPayload['p'])))
+
+      hash_provided = outerPayload['h']
 
       if(generated_hash == hash_provided)
-        return {'recipient_address' => url_parameters['r'], 'mailing_list' => url_parameters['l']}
+        return {'recipient_address' => innerPayload['r'], 'mailing_list' => innerPayload['l']}
       else
         return false
       end

data/lib/mailgun/version.rb

@@ -1,5 +1,5 @@
 module Mailgun
 
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 
 end

data/spec/integration/mailgun_spec.rb

@@ -21,7 +21,7 @@ describe 'The method send_message()' do
                                             :subject => 'Hash Integration Test',
                                             :text => 'INTEGRATION TESTING',
                                             'o:testmode' => true})
-    result.to_hash!
+    result.to_h!
     result.body.should include("message")
     result.body.should include("id")
   end
@@ -36,7 +36,7 @@ describe 'The method send_message()' do
 
     result = @mg_obj.send_message(@domain, mb_obj)
 
-    result.to_hash!
+    result.to_h!
     result.body.should include("message")
     result.body.should include("id")
   end
@@ -63,7 +63,7 @@ Testing some Mailgun awesomness!'
 
     result = @mg_obj.send_message(@domain, message_params)
 
-    result.to_hash!
+    result.to_h!
     result.body.should include("message")
     result.body.should include("id")
   end
@@ -82,7 +82,7 @@ describe 'For the domains endpoint' do
                                        :smtp_password => 'super_secret',
                                        :spam_action => 'tag'})
 
-    @result.to_hash!
+    @result.to_h!
     @result.body.should include("domain")
     expect(@result.body["domain"]["name"]).to eq(@domain)
     expect(@result.body["domain"]["spam_action"]).to eq("tag")
@@ -92,7 +92,7 @@ describe 'For the domains endpoint' do
   it 'get the domain.' do
     result = @mg_obj.get("domains/#{@domain}")
 
-    result.to_hash!
+    result.to_h!
     result.body.should include("domain")
     result.body["domain"]["name"].should eq(@domain)
   end
@@ -100,14 +100,14 @@ describe 'For the domains endpoint' do
   it 'gets a list of domains.' do
     result = @mg_obj.get("domains")
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["total_count"]).to be > 0
   end
 
   it 'deletes a domain.' do
     result = @mg_obj.delete("domains/#{@domain}")
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["message"]).to eq("Domain has been deleted")
   end
 
@@ -131,7 +131,7 @@ describe 'For the Unsubscribes endpoint' do
                            {:address => @email,
                             :tag => '*'})
 
-    @result.to_hash!
+    @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
@@ -139,7 +139,7 @@ describe 'For the Unsubscribes endpoint' do
   it 'get an unsubscribee.' do
     result = @mg_obj.get("#{@domain}/unsubscribes/#{@email}")
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["total_count"]).to eq 1
     expect(result.body["items"][0]["address"]).to eq(@email)
   end
@@ -147,7 +147,7 @@ describe 'For the Unsubscribes endpoint' do
   it 'gets a list of unsubscribes.' do
     result = @mg_obj.get("#{@domain}/unsubscribes")
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["total_count"]).to be > 0
   end
 
@@ -173,7 +173,7 @@ describe 'For the Complaints endpoint' do
     @email = "integration-test-#{random_number}@example.com"
     @result = @mg_obj.post("#{@domain}/complaints", {:address => @email})
 
-    @result.to_hash!
+    @result.to_h!
     expect(@result.body["message"]).to eq("Address has been added to the complaints table")
     expect(@result.body["address"]).to eq(@email)
   end
@@ -181,7 +181,7 @@ describe 'For the Complaints endpoint' do
   it 'get a complaint.' do
     result = @mg_obj.get("#{@domain}/complaints/#{@email}")
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["complaint"]["count"]).to eq 1
     expect(result.body["complaint"]["address"]).to eq(@email)
   end
@@ -189,7 +189,7 @@ describe 'For the Complaints endpoint' do
   it 'gets a list of complaints.' do
     result = @mg_obj.get("#{@domain}/complaints")
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["total_count"]).to be > 0
   end
 
@@ -218,7 +218,7 @@ describe 'For the Bounces endpoint' do
                             :code => 550,
                             :error => "Integration Test"})
 
-    @result.to_hash!
+    @result.to_h!
     expect(@result.body["message"]).to eq("Address has been added to the bounces table")
     expect(@result.body["address"]).to eq(@email)
   end
@@ -226,7 +226,7 @@ describe 'For the Bounces endpoint' do
   it 'get a bounce.' do
     result = @mg_obj.get("#{@domain}/bounces/#{@email}")
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["bounce"]["code"]).to eq("550")
     expect(result.body["bounce"]["address"]).to eq(@email)
     expect(result.body["bounce"]["error"]).to eq("Integration Test")
@@ -235,7 +235,7 @@ describe 'For the Bounces endpoint' do
   it 'gets a list of bounces.' do
     result = @mg_obj.get("#{@domain}/bounces")
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["total_count"]).to be > 0
   end
 
@@ -276,7 +276,7 @@ describe 'For the Events endpoint' do
   it 'get an event.' do
     result = @mg_obj.get("#{@domain}/events", {:limit => 1})
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["items"].length).to be_within(1).of(1)
     expect(result.body["paging"]).to include("next")
     expect(result.body["paging"]).to include("previous")
@@ -298,7 +298,7 @@ describe 'For the Routes endpoint' do
                                       :expression => 'match_recipient(".*@example.com")',
                                       :action => 'forward("alice@example.com")'})
 
-    result.to_hash!
+    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("alice@example.com")')
@@ -311,7 +311,7 @@ describe 'For the Routes endpoint' do
   it 'get the route.' do
     result = @mg_obj.get("routes/#{@route_id}")
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["route"]["description"]).to eq("Integration Test Route")
     expect(result.body["route"]["actions"]).to include('forward("alice@example.com")')
     expect(result.body["route"]["expression"]).to include('match_recipient(".*@example.com")')
@@ -321,7 +321,7 @@ describe 'For the Routes endpoint' do
   it 'gets a list of all routes.' do
     result = @mg_obj.get("routes", {:limit => 50})
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["total_count"]).to be > 0
   end
 
@@ -331,7 +331,7 @@ describe 'For the Routes endpoint' do
                                                   :expression => 'match_recipient(".*@example.com")',
                                                   :action => 'forward("update@example.com")'})
 
-    result.to_hash!
+    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("update@example.com")')
@@ -358,7 +358,7 @@ describe 'For the campaigns endpoint' do
     result = @mg_obj.post("#{@domain}/campaigns", {:name => 'My Campaign',
                                                    :id => @campaign_id})
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["message"]).to eq("Campaign created")
     expect(result.body["campaign"]["id"]).to eq(@campaign_id)
     expect(result.body["campaign"]["name"]).to eq('My Campaign')
@@ -367,7 +367,7 @@ describe 'For the campaigns endpoint' do
   it 'get a campaign.' do
     result = @mg_obj.get("#{@domain}/campaigns/#{@campaign_id}")
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["id"]).to eq(@campaign_id)
     expect(result.body["name"]).to eq('My Campaign')
   end
@@ -375,7 +375,7 @@ describe 'For the campaigns endpoint' do
   it 'gets a list of all campaigns.' do
     result = @mg_obj.get("#{@domain}/campaigns", {:limit => 50})
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["total_count"]).to be > 0
   end
 
@@ -383,7 +383,7 @@ describe 'For the campaigns endpoint' do
     result = @mg_obj.put("#{@domain}/campaigns/#{@campaign_id}", {:name => 'My Updated Campaign',
                                                                   :id => @campaign_id})
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["message"]).to eq("Campaign updated")
     expect(result.body["campaign"]["id"]).to eq(@campaign_id)
     expect(result.body["campaign"]["name"]).to eq('My Updated Campaign')
@@ -419,7 +419,7 @@ describe 'For the webhooks endpoint' do
     result = @mg_obj.post("domains/#{@domain}/webhooks", {:id => 'bounce',
                                                           :url => 'http://example.com/mailgun/events/bounce'})
 
-    result.to_hash!
+    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/bounce')
   end
@@ -427,14 +427,14 @@ describe 'For the webhooks endpoint' do
   it 'get a webhook.' do
     result = @mg_obj.get("domains/#{@domain}/webhooks/bounce")
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["webhook"]["url"]).to eq('http://example.com/mailgun/events/bounce')
   end
 
   it 'gets a list of all webhooks.' do
     result = @mg_obj.get("domains/#{@domain}/webhooks")
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["webhooks"]["bounce"]["url"]).to eq('http://example.com/mailgun/events/bounce')
   end
 
@@ -442,7 +442,7 @@ describe 'For the webhooks endpoint' do
     result = @mg_obj.put("domains/#{@domain}/webhooks/bounce", {:id => 'bounce',
                                                                 :url => 'http://example.com/mailgun/events/new_bounce'})
 
-    result.to_hash!
+    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/new_bounce')
   end
@@ -472,7 +472,7 @@ describe 'For the Mailing Lists endpoint' do
                                     :description => 'This list should be deleted automatically.',
                                     :access_level => 'members'})
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["message"]).to eq("Mailing list has been created")
     expect(result.body["list"]["address"]).to eq(@ml_address)
     expect(result.body["list"]["name"]).to eq('Integration Test List')
@@ -481,7 +481,7 @@ describe 'For the Mailing Lists endpoint' do
   it 'get a list.' do
     result = @mg_obj.get("lists/#{@ml_address}")
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["list"]["address"]).to eq(@ml_address)
     expect(result.body["list"]["name"]).to eq('Integration Test List')
   end
@@ -489,7 +489,7 @@ describe 'For the Mailing Lists endpoint' do
   it 'gets a list of all lists.' do
     result = @mg_obj.get("lists", {:limit => 50})
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["total_count"]).to be > 0
   end
 
@@ -500,7 +500,7 @@ describe 'For the Mailing Lists endpoint' do
                           :description => 'This list should be deleted automatically.',
                           :access_level => 'readonly'})
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["message"]).to eq("Mailing list has been updated")
     expect(result.body["list"]["address"]).to eq(@ml_address)
     expect(result.body["list"]["name"]).to eq('Integration Test List Update')
@@ -537,7 +537,7 @@ describe 'For the Mailing Lists Members endpoint' do
                            :subscribed => true,
                            :upsert => 'no'})
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["message"]).to eq("Mailing list member has been created")
     expect(result.body["member"]["address"]).to eq(@ml_member)
     expect(result.body["member"]["name"]).to eq('Jane Doe')
@@ -546,7 +546,7 @@ describe 'For the Mailing Lists Members endpoint' do
   it 'get a list member.' do
     result = @mg_obj.get("lists/#{@ml_address}/members/#{@ml_member}")
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["member"]["address"]).to eq(@ml_member)
     expect(result.body["member"]["name"]).to eq('Jane Doe')
   end
@@ -556,7 +556,7 @@ describe 'For the Mailing Lists Members endpoint' do
                          {:name => 'Jane Doe Update',
                           :subscribed => false})
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["message"]).to eq("Mailing list member has been updated")
     expect(result.body["member"]["address"]).to eq(@ml_member)
     expect(result.body["member"]["name"]).to eq('Jane Doe Update')
@@ -581,7 +581,7 @@ describe 'For the Email Validation endpoint' do
     result = @mg_obj.get("address/validate",
                          {:address => "test@example.com"})
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["is_valid"]).to eq(false)
     expect(result.body["address"]).to eq("test@example.com")
   end
@@ -590,7 +590,7 @@ describe 'For the Email Validation endpoint' do
     result = @mg_obj.get("address/parse",
                          {:addresses => "Alice <alice@example.com>,bob@example.com,example.com"})
 
-    result.to_hash!
+    result.to_h!
     expect(result.body["parsed"]).to include("Alice <alice@example.com>")
     expect(result.body["parsed"]).to include("bob@example.com")
     expect(result.body["unparseable"]).to include("example.com")

data/spec/unit/connection/test_client.rb

@@ -1,65 +1,73 @@
 require 'spec_helper'
-require "time"
-require "json"
+require 'time'
+require 'json'
 
 module Mailgun
   class UnitClient
 
-    attr_reader :url, :options, :block, :body, :code
+    attr_reader :options, :block, :body, :code, :response
 
-    def initialize(url, options={}, backwards_compatibility=nil, &block)
-      @url = url
+    def initialize(endpoint, &block)
       @block = block
-      @options = options
+      @endpoint = endpoint
       @body = nil
       @code = nil
     end
 
-    def [](resource_path, &new_block)
+    def [](endpoint, &new_block)
       case
-      when block_given? then self.class.new(resource_path, options, &new_block)
-      when block        then self.class.new(resource_path, options, &block)
+      when block_given? then self.class.new(endpoint, &new_block)
+      when block        then self.class.new(endpoint, &block)
       else
-        self.class.new(resource_path, options)
+        self.class.new(endpoint)
       end
     end
 
-    def post(options)
+    def send_message(working_domain, data)
+      case data
+      when Hash
+        if data.has_key?(:message)
+          if data[:message].is_a?(String)
+            data[:message] = convert_string_to_file(data[:message])
+          end
+          post("#{working_domain}/messages.mime", data)
+        else
+          post("#{working_domain}/messages", data)
+        end
+      when MessageBuilder
+        post("#{working_domain}/messages", data.message)
+      else
+        raise ParameterError.new("Unknown data type for data parameter.", data)
+      end
+    end
+
+    def post(path, data)
       begin
-        response = response_generator("messages")
-        Response.new(response)
+        Response.new(response_generator(@endpoint))
       rescue Exception => e
         raise CommunicationError.new(e), e.response
       end
     end
 
-    def get(options, query_string = nil)
+    def get(path, query_string = nil)
       begin
-        if query_string
-
-          response = response_generator("bounces")
-        else
-          response = response_generator("bounces")
-        end
-        Response.new(response)
+        Response.new(response_generator(@endpoint))
       rescue Exception => e
         raise CommunicationError.new(e), e.response
       end
     end
 
-    def put(options)
+    def put(path, data)
       begin
-        response = response_generator("lists")
-        Response.new(response)
+        Response.new(response_generator(@endpoint))
       rescue Exception => e
         raise CommunicationError.new(e), e.response
       end
     end
 
-    def delete()
+    def delete(path)
       begin
-        response = response_generator("campaigns")
-        Response.new(response)
+        Response.new(response_generator(@endpoint))
       rescue Exception => e
         raise CommunicationError.new(e), e.response
       end
@@ -68,19 +76,23 @@ module Mailgun
     private
 
     def response_generator(resource_endpoint)
-      case resource_endpoint
-      when "messages"
+      if resource_endpoint == "messages"
         t = Time.now
         id = "<#{t.to_i}.#{rand(99999999)}.5817@example.com>"
-        @body = JSON.generate({"message" => "Queued. Thank you.", "id" => id})
-      when "bounces"
-        @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"}})
-      when "lists"
-        @body = JSON.generate({"member" => {"vars" => {"age" => 26}, "name" => "Foo Bar", "subscribed" => false, "address" => "bar@example.com"}, "message" => "Mailing list member has been updated"})
-      when "campaigns"
-        @body = JSON.generate({"message" => "Campaign has been deleted", "id" => "ABC123"})
+        return 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"}})
+      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"})
+      end
+      if resource_endpoint == "campaigns"
+        return 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=="}})
       end
-      self
     end
   end
 
@@ -89,14 +101,14 @@ module Mailgun
     attr_accessor :body
 
     def initialize(response)
-      @body = response.body
+      @body = response
     end
 
     # Return response as Ruby Hash
     #
     # @return [Hash] A standard Ruby Hash containing the HTTP result.
 
-    def to_hash
+    def to_h
       begin
         JSON.parse(@body)
       rescue Exception => e
@@ -108,7 +120,7 @@ module Mailgun
     #
     # @return [Hash] A standard Ruby Hash containing the HTTP result.
 
-    def to_hash!
+    def to_h!
       begin
         @body = JSON.parse(@body)
       rescue Exception => e
@@ -139,5 +151,49 @@ module Mailgun
         raise ParseError.new(e), e
       end
     end
+
+    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_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

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe 'The method get' do
+  it 'should return a proper hash of log data.' 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")
+  end
+end
+
+
+describe 'The method next' do
+  it 'should return the next series of data.' 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")
+  end
+end
+
+describe 'The method previous' do
+  it 'should return the previous series of data.' 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")
+  end
+end

data/spec/unit/lists/opt_in_handler_spec.rb

@@ -5,7 +5,7 @@ describe 'The method generate_hash' do
     @mailing_list = "mylist@example.com"
     @secret_app_id = "mysupersecretpassword"
     @recipient_address = "bob@example.com"
-    @precalculated_hash = "eyJzIjoiNDc4ZjVlM2M0MWQyNDdlZGQ2NDMzYzdkZTRjOTg3MTYiLCJsIjoi%0AbXlsaXN0QGV4YW1wbGUuY29tIiwiciI6ImJvYkBleGFtcGxlLmNvbSJ9%0A"
+    @precalculated_hash = "eyJoIjoiMmY3ZmY1MzFlOGJmMjA0OWNhMTI3ZmU4ZTQyNjZkOTljYzhkMTdk%0AMiIsInAiOiJleUpzSWpvaWJYbHNhWE4wUUdWNFlXMXdiR1V1WTI5dElpd2lj%0AaUk2SW1KdllrQmxlR0Z0Y0d4bExtTnZcbmJTSjlcbiJ9%0A"
   end
 
   it 'generates a web safe hash for the recipient wishing to subscribe' do

data/spec/unit/mailgun_spec.rb

@@ -1,22 +1,14 @@
 require 'spec_helper'
 
-module Mailgun
-  class Client
-    def initialize(api_key, api_host="api.mailgun.net", api_version="v2")
-      @http_client = Mailgun::UnitClient::new(api_key, api_host, api_version)
-    end
-  end
-end
-
 describe 'Mailgun instantiation' do
   it 'instantiates an HttpClient object' do
-    expect {@mg_obj = Mailgun::Client.new("Fake-API-Key")}.not_to raise_error
+    expect {@mg_obj = Mailgun::UnitClient.new("messages")}.not_to raise_error
   end
 end
 
 describe 'The method send_message()' do
   before(:each) do
-    @mg_obj = Mailgun::Client.new("Fake-API-Key")
+    @mg_obj = Mailgun::UnitClient.new("messages")
     @domain = "test.com"
     @list_address = "mylist@test.com"
     @member_address = "subscribee@test.com"
@@ -38,7 +30,7 @@ describe 'The method send_message()' do
                     'text' => 'Test Data'}
     result = @mg_obj.send_message("testdomain.com", data)
 
-    result.to_hash!
+    result.to_h!
     result.body.should include("message")
     result.body.should include("id")
   end
@@ -48,7 +40,7 @@ describe 'The method send_message()' do
                     'message' => 'Sample Data/mime.txt'}
     result = @mg_obj.send_message("testdomain.com", data)
 
-    result.to_hash!
+    result.to_h!
     result.body.should include("message")
     result.body.should include("id")
   end
@@ -56,7 +48,7 @@ end
 
 describe 'The method post()' do
   before(:each) do
-    @mg_obj = Mailgun::Client.new("Fake-API-Key")
+    @mg_obj = Mailgun::UnitClient.new("messages")
     @domain = "test.com"
   end
   it 'in this case, sends a simple message.' do
@@ -66,7 +58,7 @@ describe 'The method post()' do
                     'text' => 'Test Data'}
     result = @mg_obj.post("#{@domain}/messages", data)
 
-    result.to_hash!
+    result.to_h!
     result.body.should include("message")
     result.body.should include("id")
   end
@@ -74,7 +66,7 @@ end
 
 describe 'The method put()' do
   before(:each) do
-    @mg_obj = Mailgun::Client.new("Fake-API-Key")
+    @mg_obj = Mailgun::UnitClient.new("lists")
     @domain = "test.com"
     @list_address = "mylist@test.com"
     @member_address = "subscribee@test.com"
@@ -85,7 +77,7 @@ describe 'The method put()' do
                     'name' => 'Foo Bar'}
     result = @mg_obj.put("lists/#{@list_address}/members#{@member_address}", data)
 
-    result.to_hash!
+    result.to_h!
     result.body.should include("member")
     result.body["member"].should include("vars")
     result.body["member"]["vars"].should include("age")
@@ -99,7 +91,7 @@ end
 
 describe 'The method get()' do
   before(:each) do
-    @mg_obj = Mailgun::Client.new("Fake-API-Key")
+    @mg_obj = Mailgun::UnitClient.new("bounces")
     @domain = "test.com"
   end
   it 'in this case, obtains a list of bounces for the domain, limit of 5, skipping the first 10.' do
@@ -107,7 +99,7 @@ describe 'The method get()' do
                     'limit' => '5'}
     result = @mg_obj.get("#{@domain}/bounces", query_string)
 
-    result.to_hash!
+    result.to_h!
     result.body.should include("total_count")
     result.body.should include("items")
   end
@@ -115,14 +107,14 @@ end
 
 describe 'The method delete()' do
   before(:each) do
-    @mg_obj = Mailgun::Client.new("Fake-API-Key")
+    @mg_obj = Mailgun::UnitClient.new("campaigns")
     @domain = "test.com"
   end
 
   it 'issues a generic delete request.' do
     result = @mg_obj.delete("#{@domain}/campaigns/ABC123")
 
-    result.to_hash!
+    result.to_h!
     result.body.should include("message")
     result.body.should include("id")
   end

data/spec/unit/messages/batch_message_spec.rb

@@ -1,16 +1,8 @@
 require 'spec_helper'
 
-module Mailgun
-  class Client
-    def initialize(api_key, api_host="api.mailgun.net", api_version="v2")
-      @http_client = UnitClient::new(api_key, api_host, api_version)
-    end
-  end
-end
-
 describe 'BatchMessage attribute readers' do
   it 'should be readable' do
-    @mb_client = Mailgun::Client.new("My-Fake-API-Key")
+    @mb_client = Mailgun::UnitClient.new("messages")
     @mb_obj = Mailgun::BatchMessage.new(@mb_client, "example.com")
     @mb_obj.should respond_to(:message_ids)
     @mb_obj.should respond_to(:message)
@@ -23,7 +15,7 @@ end
 describe 'The instantiation of Batch Message' do
 
   before(:each) do
-    @mb_client = Mailgun::Client.new("My-Fake-API-Key")
+    @mb_client = Mailgun::UnitClient.new("messages")
     @mb_obj = Mailgun::BatchMessage.new(@mb_client, "example.com")
   end
 
@@ -70,7 +62,7 @@ end
 
 describe 'The method add_recipient' do
   before(:each) do
-    @mb_client = Mailgun::Client.new("My-Fake-API-Key")
+    @mb_client = Mailgun::UnitClient.new("messages")
     @mb_obj = Mailgun::BatchMessage.new(@mb_client, "example.com")
     @address_1   = 'jane@example.com'
     @variables_1 = {'first' => 'Jane', 'last' => 'Doe', 'tracking' => 'ABC123'}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Mailgun
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-15 00:00:00.000000000 Z
+date: 2014-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,6 +97,7 @@ files:
 - Rakefile
 - Snippets.md
 - lib/mailgun.rb
+- lib/mailgun/events/events.rb
 - lib/mailgun/exceptions/exceptions.rb
 - lib/mailgun/lists/opt_in_handler.rb
 - lib/mailgun/messages/batch_message.rb
@@ -107,6 +108,7 @@ files:
 - spec/integration/messages/sample_data/mime.txt
 - spec/spec_helper.rb
 - spec/unit/connection/test_client.rb
+- spec/unit/events/events_spec.rb
 - spec/unit/lists/opt_in_handler_spec.rb
 - spec/unit/mailgun_spec.rb
 - spec/unit/messages/batch_message_spec.rb
@@ -147,6 +149,7 @@ test_files:
 - spec/integration/messages/sample_data/mime.txt
 - spec/spec_helper.rb
 - spec/unit/connection/test_client.rb
+- spec/unit/events/events_spec.rb
 - spec/unit/lists/opt_in_handler_spec.rb
 - spec/unit/mailgun_spec.rb
 - spec/unit/messages/batch_message_spec.rb