mailgunner 1.3.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16c8da4bf004d3e8b0ce0b398815294a6d5e801d
+  data.tar.gz: c2fa0a69df8ec9a64648dd3a8979d0bef4bbb593
+SHA512:
+  metadata.gz: 7a6464e5137f28e412ba186dab76d85927b12e59362896a4e7cf9da57cffa02aa575d020221ab3f37154204432a4f03eb99c2390425a664d95d0c9bb0ccc645f
+  data.tar.gz: b7ca7c319178f0c893111a14778e1c4266d12d14b49fe514e47152489a61ed5e1328fc00e7cecc4fe578110cd3edbd4819b554782b9cc41b3644705fd52e5e89

data/README.md

@@ -23,12 +23,6 @@ mailgun = Mailgunner::Client.new({
 })
 
 response = mailgun.get_stats(limit: 5)
-
-if response.ok?
-  # do something with response.object
-else
-  # handle client/server error
-end
 ```
 
 

data/lib/mailgunner.rb

@@ -1,10 +1,11 @@
 require 'net/http'
 require 'json'
 require 'cgi'
-require 'mailgunner/response'
 require 'mailgunner/delivery_method' if defined?(ActionMailer)
 
 module Mailgunner
+  class Error < StandardError; end
+
   class Client
     attr_accessor :domain, :api_key, :http
 
@@ -13,14 +14,6 @@ module Mailgunner
 
       @api_key = options.fetch(:api_key) { ENV.fetch('MAILGUN_API_KEY') }
 
-      if options.has_key?(:json)
-        Kernel.warn 'Mailgunner::Client :json option is deprecated'
-
-        @json = options[:json]
-      else
-        @json = JSON
-      end
-
       @http = Net::HTTP.new('api.mailgun.net', Net::HTTP.https_default_port)
 
       @http.use_ssl = true
@@ -58,6 +51,26 @@ module Mailgunner
       post('/v2/domains', attributes)
     end
 
+    def delete_domain(name)
+      delete("/v2/domains/#{escape name}")
+    end
+
+    def get_credentials
+      get("/v2/domains/#{escape @domain}/credentials")
+    end
+
+    def add_credentials(attributes)
+      post("/v2/domains/#{escape @domain}/credentials", attributes)
+    end
+
+    def update_credentials(login, attributes)
+      put("/v2/domains/#{escape @domain}/credentials/#{escape login}", attributes)
+    end
+
+    def delete_credentials(login)
+      delete("/v2/domains/#{escape @domain}/credentials/#{escape login}")
+    end
+
     def get_unsubscribes(params = {})
       get("/v2/#{escape @domain}/unsubscribes", params)
     end
@@ -249,23 +262,35 @@ module Mailgunner
 
       yield message if block_given?
 
-      Response.new(@http.request(message), :json => @json)
+      parse(@http.request(message))
     end
 
-    def request_uri(path, params_hash)
-      if params_hash.empty?
-        path
+    def parse(response)
+      if Net::HTTPSuccess === response
+        json?(response) ? JSON.parse(response.body) : response.body
       else
-        tmp = []
-
-        params_hash.each do |key, values|
-          Array(values).each do |value|
-            tmp << "#{escape(key)}=#{escape(value)}"
-          end
+        if json?(response)
+          raise Error, "HTTP #{response.code}: #{JSON.parse(response.body).fetch('message')}"
+        else
+          raise Error, "HTTP #{response.code}"
         end
+      end
+    end
 
-        path + '?' + tmp.join('&')
+    def json?(response)
+      content_type = response['Content-Type']
+
+      content_type && content_type.split(';').first == 'application/json'
+    end
+
+    def request_uri(path, hash)
+      return path if hash.empty?
+
+      query_params = hash.map do |key, values|
+        Array(values).map { |value| "#{escape(key)}=#{escape(value)}" }
       end
+
+      path + '?' + query_params.flatten.join('&')
     end
 
     def escape(component)

data/lib/mailgunner/delivery_method.rb

@@ -1,9 +1,6 @@
 require 'mail/check_delivery_params'
 
 module Mailgunner
-  class DeliveryFailed < StandardError
-  end
-
   class DeliveryMethod
     include Mail::CheckDeliveryParams
 
@@ -22,15 +19,7 @@ module Mailgunner
     def deliver!(mail)
       check_delivery_params(mail)
 
-      response = @client.send_mime(mail)
-
-      if response.ok?
-        return response
-      elsif response.json? && response.object.has_key?('message')
-        raise DeliveryFailed, response.object['message']
-      else
-        raise DeliveryFailed, "#{response.code} #{response.message}"
-      end
+      @client.send_mime(mail)
     end
   end
 

data/mailgunner.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'mailgunner'
-  s.version = '1.3.0'
+  s.version = '2.0.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
@@ -8,10 +8,10 @@ Gem::Specification.new do |s|
   s.description = 'A Ruby wrapper for the Mailgun API'
   s.summary = 'See description'
   s.files = Dir.glob('{lib,spec}/**/*') + %w(README.md mailgunner.gemspec)
-  s.add_development_dependency('rake', '>= 0.9.3')
-  s.add_development_dependency('mocha', '~> 0.13.2')
-  s.add_development_dependency('webmock', '~> 1.13.0')
-  s.add_development_dependency('mail', '~> 2.5.4')
-  s.add_development_dependency('actionmailer', '~> 4.0.0')
+  s.required_ruby_version = '>= 1.9.3'
+  s.add_development_dependency('rake', '~> 10.1')
+  s.add_development_dependency('webmock', '~> 1.18')
+  s.add_development_dependency('mail', '~> 2.5')
+  s.add_development_dependency('actionmailer', '~> 4.0')
   s.require_path = 'lib'
 end

data/spec/mailgunner_delivery_method_spec.rb

@@ -42,7 +42,9 @@ describe 'Mailgunner::DeliveryMethod' do
       body: '{"message": "Invalid API key"}'
     })
 
-    proc { ExampleMailer.registration_confirmation(email: @address).deliver }.must_raise(Mailgunner::DeliveryFailed)
+    exception = proc { ExampleMailer.registration_confirmation(email: @address).deliver }.must_raise(Mailgunner::Error)
+
+    exception.message.must_include('Invalid API key')
   end
 
   it 'allows the domain to be specified explicitly via the delivery method settings' do

data/spec/mailgunner_spec.rb

@@ -1,6 +1,5 @@
 require 'minitest/autorun'
 require 'webmock/minitest'
-require 'mocha/setup'
 require 'mailgunner'
 require 'json'
 require 'mail'
@@ -13,11 +12,17 @@ describe 'Mailgunner::Client' do
 
     @base_url = "https://api:#{@api_key}@api.mailgun.net/v2"
 
+    @json_response = {headers: {'Content-Type' => 'application/json;charset=utf-8'}, body: '{"key":"value"}'}
+
+    @json_response_object = {'key' => 'value'}
+
     @client = Mailgunner::Client.new(domain: @domain, api_key: @api_key)
 
     @address = 'user@example.com'
 
     @encoded_address = 'user%40example.com'
+
+    @login = 'bob.bar'
   end
 
   describe 'http method' do
@@ -59,26 +64,26 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'validate_address method' do
-    it 'calls the address validate resource with the given email address and returns a response object' do
-      stub_request(:get, "#@base_url/address/validate?address=#@encoded_address")
+    it 'calls the address validate resource with the given email address and returns the response object' do
+      stub_request(:get, "#@base_url/address/validate?address=#@encoded_address").to_return(@json_response)
 
-      @client.validate_address(@address).must_be_instance_of(Mailgunner::Response)
+      @client.validate_address(@address).must_equal(@json_response_object)
     end
   end
 
   describe 'parse_addresses method' do
-    it 'calls the address parse resource with the given email addresses and returns a response object' do
-      stub_request(:get, "#@base_url/address/parse?addresses=bob%40example.com%2Ceve%40example.com")
+    it 'calls the address parse resource with the given email addresses and returns the response object' do
+      stub_request(:get, "#@base_url/address/parse?addresses=bob%40example.com%2Ceve%40example.com").to_return(@json_response)
 
-      @client.parse_addresses(['bob@example.com', 'eve@example.com']).must_be_instance_of(Mailgunner::Response)
+      @client.parse_addresses(['bob@example.com', 'eve@example.com']).must_equal(@json_response_object)
     end
   end
 
   describe 'send_message method' do
-    it 'posts to the domain messages resource and returns a response object' do
-      stub_request(:post, "#@base_url/#@domain/messages")
+    it 'posts to the domain messages resource and returns the response object' do
+      stub_request(:post, "#@base_url/#@domain/messages").to_return(@json_response)
 
-      @client.send_message({}).must_be_instance_of(Mailgunner::Response)
+      @client.send_message({}).must_equal(@json_response_object)
     end
 
     it 'encodes the message attributes' do
@@ -102,34 +107,34 @@ describe 'Mailgunner::Client' do
       })
     end
 
-    it 'posts to the domain messages resource and returns a response object' do
-      stub_request(:post, "#@base_url/#@domain/messages.mime")
+    it 'posts to the domain messages resource and returns the response object' do
+      stub_request(:post, "#@base_url/#@domain/messages.mime").to_return(@json_response)
 
-      @client.send_mime(@mail).must_be_instance_of(Mailgunner::Response)
+      @client.send_mime(@mail).must_equal(@json_response_object)
     end
   end
 
   describe 'get_domains method' do
-    it 'fetches the domains resource and returns a response object' do
-      stub_request(:get, "#@base_url/domains")
+    it 'fetches the domains resource and returns the response object' do
+      stub_request(:get, "#@base_url/domains").to_return(@json_response)
 
-      @client.get_domains.must_be_instance_of(Mailgunner::Response)
+      @client.get_domains.must_equal(@json_response_object)
     end
   end
 
   describe 'get_domain method' do
-    it 'fetches the domain resource and returns a response object' do
-      stub_request(:get, "#@base_url/domains/#@domain")
+    it 'fetches the domain resource and returns the response object' do
+      stub_request(:get, "#@base_url/domains/#@domain").to_return(@json_response)
 
-      @client.get_domain(@domain).must_be_instance_of(Mailgunner::Response)
+      @client.get_domain(@domain).must_equal(@json_response_object)
     end
   end
 
   describe 'add_domain method' do
-    it 'posts to the domains resource and returns a response object' do
-      stub_request(:post, "#@base_url/domains")
+    it 'posts to the domains resource and returns the response object' do
+      stub_request(:post, "#@base_url/domains").to_return(@json_response)
 
-      @client.add_domain({}).must_be_instance_of(Mailgunner::Response)
+      @client.add_domain({}).must_equal(@json_response_object)
     end
 
     it 'encodes the domain attributes' do
@@ -139,11 +144,57 @@ describe 'Mailgunner::Client' do
     end
   end
 
+  describe 'delete_domain method' do
+    it 'deletes the domain resource with the given name and returns the response object' do
+      stub_request(:delete, "#@base_url/domains/#@domain").to_return(@json_response)
+
+      @client.delete_domain(@domain).must_equal(@json_response_object)
+    end
+  end
+
+  describe 'get_credentials method' do
+    it 'fetches the domain credentials resource and returns the response object' do
+      stub_request(:get, "#@base_url/domains/#@domain/credentials").to_return(@json_response)
+
+      @client.get_credentials.must_equal(@json_response_object)
+    end
+  end
+
+  describe 'add_credentials method' do
+    it 'posts to the domain credentials resource and returns the response object' do
+      stub_request(:post, "#@base_url/domains/#@domain/credentials").with(body: "login=#@login").to_return(@json_response)
+
+      @client.add_credentials(login: @login).must_equal(@json_response_object)
+    end
+  end
+
+  describe 'update_credentials method' do
+    it 'updates the domain credentials resource with the given login and returns the response object' do
+      stub_request(:put, "#@base_url/domains/#@domain/credentials/#@login").to_return(@json_response)
+
+      @client.update_credentials(@login, {}).must_equal(@json_response_object)
+    end
+
+    it 'encodes the password attribute' do
+      stub_request(:put, "#@base_url/domains/#@domain/credentials/#@login").with(body: 'password=secret')
+
+      @client.update_credentials(@login, password: 'secret')
+    end
+  end
+
+  describe 'delete_credentials method' do
+    it 'deletes the domain credentials resource with the given login and returns the response object' do
+      stub_request(:delete, "#@base_url/domains/#@domain/credentials/#@login").to_return(@json_response)
+
+      @client.delete_credentials(@login).must_equal(@json_response_object)
+    end
+  end
+
   describe 'get_unsubscribes method' do
-    it 'fetches the domain unsubscribes resource and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/unsubscribes")
+    it 'fetches the domain unsubscribes resource and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/unsubscribes").to_return(@json_response)
 
-      @client.get_unsubscribes.must_be_instance_of(Mailgunner::Response)
+      @client.get_unsubscribes.must_equal(@json_response_object)
     end
 
     it 'encodes skip and limit parameters' do
@@ -154,26 +205,26 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_unsubscribe method' do
-    it 'fetches the unsubscribe resource with the given address and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/unsubscribes/#@encoded_address")
+    it 'fetches the unsubscribe resource with the given address and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/unsubscribes/#@encoded_address").to_return(@json_response)
 
-      @client.get_unsubscribe(@address).must_be_instance_of(Mailgunner::Response)
+      @client.get_unsubscribe(@address).must_equal(@json_response_object)
     end
   end
 
   describe 'delete_unsubscribe method' do
-    it 'deletes the domain unsubscribe resource with the given address and returns a response object' do
-      stub_request(:delete, "#@base_url/#@domain/unsubscribes/#@encoded_address")
+    it 'deletes the domain unsubscribe resource with the given address and returns the response object' do
+      stub_request(:delete, "#@base_url/#@domain/unsubscribes/#@encoded_address").to_return(@json_response)
 
-      @client.delete_unsubscribe(@address).must_be_instance_of(Mailgunner::Response)
+      @client.delete_unsubscribe(@address).must_equal(@json_response_object)
     end
   end
 
   describe 'add_unsubscribe method' do
-    it 'posts to the domain unsubscribes resource and returns a response object' do
-      stub_request(:post, "#@base_url/#@domain/unsubscribes")
+    it 'posts to the domain unsubscribes resource and returns the response object' do
+      stub_request(:post, "#@base_url/#@domain/unsubscribes").to_return(@json_response)
 
-      @client.add_unsubscribe({}).must_be_instance_of(Mailgunner::Response)
+      @client.add_unsubscribe({}).must_equal(@json_response_object)
     end
 
     it 'encodes the unsubscribe attributes' do
@@ -184,10 +235,10 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_complaints method' do
-    it 'fetches the domain complaints resource and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/complaints")
+    it 'fetches the domain complaints resource and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/complaints").to_return(@json_response)
 
-      @client.get_complaints.must_be_instance_of(Mailgunner::Response)
+      @client.get_complaints.must_equal(@json_response_object)
     end
 
     it 'encodes skip and limit parameters' do
@@ -198,18 +249,18 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_complaint method' do
-    it 'fetches the complaint resource with the given address and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/complaints/#@encoded_address")
+    it 'fetches the complaint resource with the given address and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/complaints/#@encoded_address").to_return(@json_response)
 
-      @client.get_complaint(@address).must_be_instance_of(Mailgunner::Response)
+      @client.get_complaint(@address).must_equal(@json_response_object)
     end
   end
 
   describe 'add_complaint method' do
-    it 'posts to the domain complaints resource and returns a response object' do
-      stub_request(:post, "#@base_url/#@domain/complaints")
+    it 'posts to the domain complaints resource and returns the response object' do
+      stub_request(:post, "#@base_url/#@domain/complaints").to_return(@json_response)
 
-      @client.add_complaint({}).must_be_instance_of(Mailgunner::Response)
+      @client.add_complaint({}).must_equal(@json_response_object)
     end
 
     it 'encodes the complaint attributes' do
@@ -220,18 +271,18 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'delete_complaint method' do
-    it 'deletes the domain complaint resource with the given address and returns a response object' do
-      stub_request(:delete, "#@base_url/#@domain/complaints/#@encoded_address")
+    it 'deletes the domain complaint resource with the given address and returns the response object' do
+      stub_request(:delete, "#@base_url/#@domain/complaints/#@encoded_address").to_return(@json_response)
 
-      @client.delete_complaint(@address).must_be_instance_of(Mailgunner::Response)
+      @client.delete_complaint(@address).must_equal(@json_response_object)
     end
   end
 
   describe 'get_bounces method' do
-    it 'fetches the domain bounces resource and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/bounces")
+    it 'fetches the domain bounces resource and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/bounces").to_return(@json_response)
 
-      @client.get_bounces.must_be_instance_of(Mailgunner::Response)
+      @client.get_bounces.must_equal(@json_response_object)
     end
 
     it 'encodes skip and limit parameters' do
@@ -242,18 +293,18 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_bounce method' do
-    it 'fetches the bounce resource with the given address and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/bounces/#@encoded_address")
+    it 'fetches the bounce resource with the given address and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/bounces/#@encoded_address").to_return(@json_response)
 
-      @client.get_bounce(@address).must_be_instance_of(Mailgunner::Response)
+      @client.get_bounce(@address).must_equal(@json_response_object)
     end
   end
 
   describe 'add_bounce method' do
-    it 'posts to the domain bounces resource and returns a response object' do
-      stub_request(:post, "#@base_url/#@domain/bounces")
+    it 'posts to the domain bounces resource and returns the response object' do
+      stub_request(:post, "#@base_url/#@domain/bounces").to_return(@json_response)
 
-      @client.add_bounce({}).must_be_instance_of(Mailgunner::Response)
+      @client.add_bounce({}).must_equal(@json_response_object)
     end
 
     it 'encodes the bounce attributes' do
@@ -264,18 +315,18 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'delete_bounce method' do
-    it 'deletes the domain bounce resource with the given address and returns a response object' do
-      stub_request(:delete, "#@base_url/#@domain/bounces/#@encoded_address")
+    it 'deletes the domain bounce resource with the given address and returns the response object' do
+      stub_request(:delete, "#@base_url/#@domain/bounces/#@encoded_address").to_return(@json_response)
 
-      @client.delete_bounce(@address).must_be_instance_of(Mailgunner::Response)
+      @client.delete_bounce(@address).must_equal(@json_response_object)
     end
   end
 
   describe 'get_stats method' do
-    it 'fetches the domain stats resource and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/stats")
+    it 'fetches the domain stats resource and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/stats").to_return(@json_response)
 
-      @client.get_stats.must_be_instance_of(Mailgunner::Response)
+      @client.get_stats.must_equal(@json_response_object)
     end
 
     it 'encodes skip and limit parameters' do
@@ -292,10 +343,10 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_events method' do
-    it 'fetches the domain events resource and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/events")
+    it 'fetches the domain events resource and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/events").to_return(@json_response)
 
-      @client.get_events.must_be_instance_of(Mailgunner::Response)
+      @client.get_events.must_equal(@json_response_object)
     end
 
     it 'encodes optional parameters' do
@@ -306,10 +357,10 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_routes method' do
-    it 'fetches the routes resource and returns a response object' do
-      stub_request(:get, "#@base_url/routes")
+    it 'fetches the routes resource and returns the response object' do
+      stub_request(:get, "#@base_url/routes").to_return(@json_response)
 
-      @client.get_routes.must_be_instance_of(Mailgunner::Response)
+      @client.get_routes.must_equal(@json_response_object)
     end
 
     it 'encodes skip and limit parameters' do
@@ -320,18 +371,18 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_route method' do
-    it 'fetches the route resource with the given id and returns a response object' do
-      stub_request(:get, "#@base_url/routes/4f3bad2335335426750048c6")
+    it 'fetches the route resource with the given id and returns the response object' do
+      stub_request(:get, "#@base_url/routes/4f3bad2335335426750048c6").to_return(@json_response)
 
-      @client.get_route('4f3bad2335335426750048c6').must_be_instance_of(Mailgunner::Response)
+      @client.get_route('4f3bad2335335426750048c6').must_equal(@json_response_object)
     end
   end
 
   describe 'add_route method' do
-    it 'posts to the routes resource and returns a response object' do
-      stub_request(:post, "#@base_url/routes")
+    it 'posts to the routes resource and returns the response object' do
+      stub_request(:post, "#@base_url/routes").to_return(@json_response)
 
-      @client.add_route({}).must_be_instance_of(Mailgunner::Response)
+      @client.add_route({}).must_equal(@json_response_object)
     end
 
     it 'encodes the route attributes' do
@@ -342,10 +393,10 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'update_route method' do
-    it 'updates the route resource with the given id and returns a response object' do
-      stub_request(:put, "#@base_url/routes/4f3bad2335335426750048c6")
+    it 'updates the route resource with the given id and returns the response object' do
+      stub_request(:put, "#@base_url/routes/4f3bad2335335426750048c6").to_return(@json_response)
 
-      @client.update_route('4f3bad2335335426750048c6', {}).must_be_instance_of(Mailgunner::Response)
+      @client.update_route('4f3bad2335335426750048c6', {}).must_equal(@json_response_object)
     end
 
     it 'encodes the route attributes' do
@@ -356,18 +407,18 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'delete_route method' do
-    it 'deletes the route resource with the given id and returns a response object' do
-      stub_request(:delete, "#@base_url/routes/4f3bad2335335426750048c6")
+    it 'deletes the route resource with the given id and returns the response object' do
+      stub_request(:delete, "#@base_url/routes/4f3bad2335335426750048c6").to_return(@json_response)
 
-      @client.delete_route('4f3bad2335335426750048c6').must_be_instance_of(Mailgunner::Response)
+      @client.delete_route('4f3bad2335335426750048c6').must_equal(@json_response_object)
     end
   end
 
   describe 'get_campaigns method' do
-    it 'fetches the domain campaigns resource and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/campaigns")
+    it 'fetches the domain campaigns resource and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/campaigns").to_return(@json_response)
 
-      @client.get_campaigns.must_be_instance_of(Mailgunner::Response)
+      @client.get_campaigns.must_equal(@json_response_object)
     end
 
     it 'encodes skip and limit parameters' do
@@ -378,18 +429,18 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_campaign method' do
-    it 'fetches the campaign resource with the given id and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/campaigns/id")
+    it 'fetches the campaign resource with the given id and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/campaigns/id").to_return(@json_response)
 
-      @client.get_campaign('id').must_be_instance_of(Mailgunner::Response)
+      @client.get_campaign('id').must_equal(@json_response_object)
     end
   end
 
   describe 'add_campaign method' do
-    it 'posts to the domain campaigns resource and returns a response object' do
-      stub_request(:post, "#@base_url/#@domain/campaigns")
+    it 'posts to the domain campaigns resource and returns the response object' do
+      stub_request(:post, "#@base_url/#@domain/campaigns").to_return(@json_response)
 
-      @client.add_campaign({}).must_be_instance_of(Mailgunner::Response)
+      @client.add_campaign({}).must_equal(@json_response_object)
     end
 
     it 'encodes the campaign attributes' do
@@ -400,10 +451,10 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'update_campaign method' do
-    it 'updates the campaign resource and returns a response object' do
-      stub_request(:put, "#@base_url/#@domain/campaigns/id")
+    it 'updates the campaign resource and returns the response object' do
+      stub_request(:put, "#@base_url/#@domain/campaigns/id").to_return(@json_response)
 
-      @client.update_campaign('id', {}).must_be_instance_of(Mailgunner::Response)
+      @client.update_campaign('id', {}).must_equal(@json_response_object)
     end
 
     it 'encodes the campaign attributes' do
@@ -414,18 +465,18 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'delete_campaign method' do
-    it 'deletes the domain campaign resource with the given id and returns a response object' do
-      stub_request(:delete, "#@base_url/#@domain/campaigns/id")
+    it 'deletes the domain campaign resource with the given id and returns the response object' do
+      stub_request(:delete, "#@base_url/#@domain/campaigns/id").to_return(@json_response)
 
-      @client.delete_campaign('id').must_be_instance_of(Mailgunner::Response)
+      @client.delete_campaign('id').must_equal(@json_response_object)
     end
   end
 
   describe 'get_campaign_events method' do
-    it 'fetches the domain campaign events resource and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/campaigns/id/events")
+    it 'fetches the domain campaign events resource and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/campaigns/id/events").to_return(@json_response)
 
-      @client.get_campaign_events('id').must_be_instance_of(Mailgunner::Response)
+      @client.get_campaign_events('id').must_equal(@json_response_object)
     end
 
     it 'encodes the optional parameters' do
@@ -436,10 +487,10 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_campaign_stats method' do
-    it 'fetches the domain campaign stats resource and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/campaigns/id/stats")
+    it 'fetches the domain campaign stats resource and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/campaigns/id/stats").to_return(@json_response)
 
-      @client.get_campaign_stats('id').must_be_instance_of(Mailgunner::Response)
+      @client.get_campaign_stats('id').must_equal(@json_response_object)
     end
 
     it 'encodes the optional parameters' do
@@ -450,10 +501,10 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_campaign_clicks method' do
-    it 'fetches the domain campaign clicks resource and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/campaigns/id/clicks")
+    it 'fetches the domain campaign clicks resource and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/campaigns/id/clicks").to_return(@json_response)
 
-      @client.get_campaign_clicks('id').must_be_instance_of(Mailgunner::Response)
+      @client.get_campaign_clicks('id').must_equal(@json_response_object)
     end
 
     it 'encodes the optional parameters' do
@@ -464,10 +515,10 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_campaign_opens method' do
-    it 'fetches the domain campaign opens resource and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/campaigns/id/opens")
+    it 'fetches the domain campaign opens resource and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/campaigns/id/opens").to_return(@json_response)
 
-      @client.get_campaign_opens('id').must_be_instance_of(Mailgunner::Response)
+      @client.get_campaign_opens('id').must_equal(@json_response_object)
     end
 
     it 'encodes the optional parameters' do
@@ -478,10 +529,10 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_campaign_unsubscribes method' do
-    it 'fetches the domain campaign unsubscribes resource and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/campaigns/id/unsubscribes")
+    it 'fetches the domain campaign unsubscribes resource and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/campaigns/id/unsubscribes").to_return(@json_response)
 
-      @client.get_campaign_unsubscribes('id').must_be_instance_of(Mailgunner::Response)
+      @client.get_campaign_unsubscribes('id').must_equal(@json_response_object)
     end
 
     it 'encodes the optional parameters' do
@@ -492,10 +543,10 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_campaign_complaints method' do
-    it 'fetches the domain campaign complaints resource and returns a response object' do
-      stub_request(:get, "#@base_url/#@domain/campaigns/id/complaints")
+    it 'fetches the domain campaign complaints resource and returns the response object' do
+      stub_request(:get, "#@base_url/#@domain/campaigns/id/complaints").to_return(@json_response)
 
-      @client.get_campaign_complaints('id').must_be_instance_of(Mailgunner::Response)
+      @client.get_campaign_complaints('id').must_equal(@json_response_object)
     end
 
     it 'encodes the optional parameters' do
@@ -506,10 +557,10 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_lists method' do
-    it 'fetches the lists resource and returns a response object' do
-      stub_request(:get, "#@base_url/lists")
+    it 'fetches the lists resource and returns the response object' do
+      stub_request(:get, "#@base_url/lists").to_return(@json_response)
 
-      @client.get_lists.must_be_instance_of(Mailgunner::Response)
+      @client.get_lists.must_equal(@json_response_object)
     end
 
     it 'encodes skip and limit parameters' do
@@ -520,18 +571,18 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_list method' do
-    it 'fetches the list resource with the given address and returns a response object' do
-      stub_request(:get, "#@base_url/lists/developers%40mailgun.net")
+    it 'fetches the list resource with the given address and returns the response object' do
+      stub_request(:get, "#@base_url/lists/developers%40mailgun.net").to_return(@json_response)
 
-      @client.get_list('developers@mailgun.net').must_be_instance_of(Mailgunner::Response)
+      @client.get_list('developers@mailgun.net').must_equal(@json_response_object)
     end
   end
 
   describe 'add_list method' do
-    it 'posts to the lists resource and returns a response object' do
-      stub_request(:post, "#@base_url/lists")
+    it 'posts to the lists resource and returns the response object' do
+      stub_request(:post, "#@base_url/lists").to_return(@json_response)
 
-      @client.add_list({}).must_be_instance_of(Mailgunner::Response)
+      @client.add_list({}).must_equal(@json_response_object)
     end
 
     it 'encodes the list attributes' do
@@ -542,10 +593,10 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'update_list method' do
-    it 'updates the list resource and returns a response object' do
-      stub_request(:put, "#@base_url/lists/developers%40mailgun.net")
+    it 'updates the list resource and returns the response object' do
+      stub_request(:put, "#@base_url/lists/developers%40mailgun.net").to_return(@json_response)
 
-      @client.update_list('developers@mailgun.net', {}).must_be_instance_of(Mailgunner::Response)
+      @client.update_list('developers@mailgun.net', {}).must_equal(@json_response_object)
     end
 
     it 'encodes the list attributes' do
@@ -556,18 +607,18 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'delete_list method' do
-    it 'deletes the list resource with the given address and returns a response object' do
-      stub_request(:delete, "#@base_url/lists/developers%40mailgun.net")
+    it 'deletes the list resource with the given address and returns the response object' do
+      stub_request(:delete, "#@base_url/lists/developers%40mailgun.net").to_return(@json_response)
 
-      @client.delete_list('developers@mailgun.net').must_be_instance_of(Mailgunner::Response)
+      @client.delete_list('developers@mailgun.net').must_equal(@json_response_object)
     end
   end
 
   describe 'get_list_members method' do
-    it 'fetches the list members resource and returns a response object' do
-      stub_request(:get, "#@base_url/lists/developers%40mailgun.net/members")
+    it 'fetches the list members resource and returns the response object' do
+      stub_request(:get, "#@base_url/lists/developers%40mailgun.net/members").to_return(@json_response)
 
-      @client.get_list_members('developers@mailgun.net').must_be_instance_of(Mailgunner::Response)
+      @client.get_list_members('developers@mailgun.net').must_equal(@json_response_object)
     end
 
     it 'encodes skip and limit parameters' do
@@ -578,18 +629,18 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_list_member method' do
-    it 'fetches the list member resource with the given address and returns a response object' do
-      stub_request(:get, "#@base_url/lists/developers%40mailgun.net/members/#@encoded_address")
+    it 'fetches the list member resource with the given address and returns the response object' do
+      stub_request(:get, "#@base_url/lists/developers%40mailgun.net/members/#@encoded_address").to_return(@json_response)
 
-      @client.get_list_member('developers@mailgun.net', @address).must_be_instance_of(Mailgunner::Response)
+      @client.get_list_member('developers@mailgun.net', @address).must_equal(@json_response_object)
     end
   end
 
   describe 'add_list_member method' do
-    it 'posts to the list members resource and returns a response object' do
-      stub_request(:post, "#@base_url/lists/developers%40mailgun.net/members")
+    it 'posts to the list members resource and returns the response object' do
+      stub_request(:post, "#@base_url/lists/developers%40mailgun.net/members").to_return(@json_response)
 
-      @client.add_list_member('developers@mailgun.net', {}).must_be_instance_of(Mailgunner::Response)
+      @client.add_list_member('developers@mailgun.net', {}).must_equal(@json_response_object)
     end
 
     it 'encodes the list attributes' do
@@ -600,10 +651,10 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'update_list_member method' do
-    it 'updates the list member resource with the given address and returns a response object' do
-      stub_request(:put, "#@base_url/lists/developers%40mailgun.net/members/#@encoded_address")
+    it 'updates the list member resource with the given address and returns the response object' do
+      stub_request(:put, "#@base_url/lists/developers%40mailgun.net/members/#@encoded_address").to_return(@json_response)
 
-      @client.update_list_member('developers@mailgun.net', @address, {}).must_be_instance_of(Mailgunner::Response)
+      @client.update_list_member('developers@mailgun.net', @address, {}).must_equal(@json_response_object)
     end
 
     it 'encodes the list member attributes' do
@@ -614,26 +665,18 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'delete_list_member method' do
-    it 'deletes the list member resource with the given address and returns a response object' do
-      stub_request(:delete, "#@base_url/lists/developers%40mailgun.net/members/#@encoded_address")
+    it 'deletes the list member resource with the given address and returns the response object' do
+      stub_request(:delete, "#@base_url/lists/developers%40mailgun.net/members/#@encoded_address").to_return(@json_response)
 
-      @client.delete_list_member('developers@mailgun.net', @address).must_be_instance_of(Mailgunner::Response)
+      @client.delete_list_member('developers@mailgun.net', @address).must_equal(@json_response_object)
     end
   end
 
   describe 'get_list_stats method' do
-    it 'fetches the list stats resource and returns a response object' do
-      stub_request(:get, "#@base_url/lists/developers%40mailgun.net/stats")
-
-      @client.get_list_stats('developers@mailgun.net').must_be_instance_of(Mailgunner::Response)
-    end
-  end
-
-  describe 'when initialized with a different json implementation' do
-    it 'emits a deprecation warning' do
-      Kernel.expects(:warn).with(regexp_matches(/Mailgunner::Client :json option is deprecated/))
+    it 'fetches the list stats resource and returns the response object' do
+      stub_request(:get, "#@base_url/lists/developers%40mailgun.net/stats").to_return(@json_response)
 
-      Mailgunner::Client.new(domain: @domain, api_key: @api_key, json: stub)
+      @client.get_list_stats('developers@mailgun.net').must_equal(@json_response_object)
     end
   end
 end

metadata

@@ -1,96 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: mailgunner
 version: !ruby/object:Gem::Version
-  version: 1.3.0
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-03 00:00:00.000000000 Z
+date: 2014-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.3
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.3
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.13.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.13.2
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: '1.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: '1.18'
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.4
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.4
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4.0'
 description: A Ruby wrapper for the Mailgun API
 email:
 - mail@timcraft.com
@@ -98,37 +73,33 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/mailgunner/delivery_method.rb
-- lib/mailgunner/response.rb
+- README.md
 - lib/mailgunner.rb
+- lib/mailgunner/delivery_method.rb
+- mailgunner.gemspec
 - spec/mailgunner_delivery_method_spec.rb
-- spec/mailgunner_response_spec.rb
 - spec/mailgunner_spec.rb
-- README.md
-- mailgunner.gemspec
 homepage: http://github.com/timcraft/mailgunner
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: See description
 test_files: []
-has_rdoc: 

data/lib/mailgunner/response.rb

@@ -1,37 +0,0 @@
-module Mailgunner
-  class Response
-    def initialize(http_response, options = {})
-      @http_response = http_response
-
-      @json = options.fetch(:json) { JSON }
-    end
-
-    def method_missing(name, *args, &block)
-      @http_response.send(name, *args, &block)
-    end
-
-    def respond_to_missing?(name, include_private = false)
-      @http_response.respond_to?(name)
-    end
-
-    def ok?
-      code.to_i == 200
-    end
-
-    def client_error?
-      (400 .. 499).include?(code.to_i)
-    end
-
-    def server_error?
-      (500 .. 599).include?(code.to_i)
-    end
-
-    def json?
-      self['Content-Type'].split(';').first == 'application/json'
-    end
-
-    def object
-      @object ||= @json.parse(body)
-    end
-  end
-end

data/spec/mailgunner_response_spec.rb

@@ -1,101 +0,0 @@
-require 'minitest/autorun'
-require 'mocha/setup'
-require 'mailgunner'
-
-describe 'Mailgunner::Response' do
-  before do
-    @http_response = mock()
-
-    @response = Mailgunner::Response.new(@http_response)
-  end
-
-  it 'delegates missing methods to the http response object' do
-    @http_response.stubs(:code).returns('200')
-
-    @response.code.must_equal('200')
-  end
-
-  describe 'ok query method' do
-    it 'returns true if the status code is 200' do
-      @http_response.expects(:code).returns('200')
-
-      @response.ok?.must_equal(true)
-    end
-
-    it 'returns false otherwise' do
-      @http_response.expects(:code).returns('400')
-
-      @response.ok?.must_equal(false)
-    end
-  end
-
-  describe 'client_error query method' do
-    it 'returns true if the status code is 4xx' do
-      @http_response.stubs(:code).returns(%w(400 401 402 404).sample)
-
-      @response.client_error?.must_equal(true)
-    end
-
-    it 'returns false otherwise' do
-      @http_response.stubs(:code).returns('200')
-
-      @response.client_error?.must_equal(false)
-    end
-  end
-
-  describe 'server_error query method' do
-    it 'returns true if the status code is 5xx' do
-      @http_response.stubs(:code).returns(%w(500 502 503 504).sample)
-
-      @response.server_error?.must_equal(true)
-    end
-
-    it 'returns false otherwise' do
-      @http_response.stubs(:code).returns('200')
-
-      @response.server_error?.must_equal(false)
-    end
-  end
-
-  describe 'json query method' do
-    it 'returns true if the response has a json content type' do
-      @http_response.expects(:[]).with('Content-Type').returns('application/json;charset=utf-8')
-
-      @response.json?.must_equal(true)
-    end
-
-    it 'returns false otherwise' do
-      @http_response.expects(:[]).with('Content-Type').returns('text/html')
-
-      @response.json?.must_equal(false)
-    end
-  end
-
-  describe 'object method' do
-    it 'decodes the response body as json and returns a hash' do
-      @http_response.expects(:body).returns('{"foo":"bar"}')
-
-      @response.object.must_equal({'foo' => 'bar'})
-    end
-  end
-end
-
-describe 'Mailgunner::Response initialized with an alternative json implementation' do
-  before do
-    @json = mock()
-
-    @http_response = stub
-
-    @response = Mailgunner::Response.new(@http_response, :json => @json)
-  end
-
-  describe 'object method' do
-    it 'uses the alternative json implementation to parse the response body' do
-      @http_response.stubs(:body).returns(response_body = '{"foo":"bar"}')
-
-      @json.expects(:parse).with(response_body)
-
-      @response.object
-    end
-  end
-end