mailgunner 1.0.0 → 1.1.0

data/README.md

@@ -1,14 +1,26 @@
-A Ruby wrapper for the [Mailgun API](http://documentation.mailgun.net/api_reference.html)
-=========================================================================================
+mailgunner
+==========
 
 
-Quick Start
+A Ruby wrapper for the [Mailgun API](http://documentation.mailgun.net/api_reference.html).
+
+
+Installation
+------------
+
+    $ gem install mailgunner
+
+
+Quick start
 -----------
 
 ```ruby
 require 'mailgunner'
 
-mailgun = Mailgunner::Client.new(domain: 'samples.mailgun.org', api_key: 'key-3ax6xnjp29jd6fds4gc373sgvjxteol0')
+mailgun = Mailgunner::Client.new({
+  domain: 'samples.mailgun.org',
+  api_key: 'key-3ax6xnjp29jd6fds4gc373sgvjxteol0'
+})
 
 response = mailgun.get_stats(limit: 5)
 
@@ -20,20 +32,7 @@ end
 ```
 
 
-Alternative JSON Implementations
---------------------------------
-
-Mailgunner::Client defaults to using the "json" library which is available
-in the Ruby 1.9 standard library, and as a gem for Ruby 1.8. You can specify
-an alternative implementation using the json option when constructing a client
-object. For example, to use [multi_json](https://rubygems.org/gems/multi_json):
-
-```ruby
-mailgun = Mailgunner::Client.new(:json => MultiJson)
-```
-
-
-Environment Variables
+Environment variables
 ---------------------
 
 Best practice for storing credentials for external services is to use environment
@@ -42,4 +41,3 @@ variables, as described by [12factor.net/config](http://www.12factor.net/config)
 Mailgunner::Client defaults to extracting the domain and api_key values it needs
 from the MAILGUN_API_KEY and MAILGUN_SMTP_LOGIN environment variables. These will
 exist if you are using Mailgun on Heroku, or you can set them manually.
-

data/lib/mailgunner.rb

@@ -5,20 +5,38 @@ require 'uri'
 
 module Mailgunner
   class Client
-    attr_accessor :domain, :api_key, :json, :http
+    attr_accessor :domain, :api_key, :http
 
     def initialize(options = {})
       @domain = options.fetch(:domain) { ENV.fetch('MAILGUN_SMTP_LOGIN').split('@').last }
 
       @api_key = options.fetch(:api_key) { ENV.fetch('MAILGUN_API_KEY') }
 
-      @json = options.fetch(:json) { JSON }
+      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
     end
 
+    def json
+      Kernel.warn 'Mailgunner::Client#json is deprecated'
+
+      @json
+    end
+
+    def json=(json)
+      Kernel.warn 'Mailgunner::Client#json= is deprecated'
+
+      @json = json
+    end
+
     def send_message(attributes = {})
       post("/v2/#{escape @domain}/messages", attributes)
     end
@@ -112,18 +130,26 @@ module Mailgunner
     end
 
     def get_mailboxes(params = {})
+      Kernel.warn 'Mailgunner::Client#get_mailboxes is deprecated'
+
       get("/v2/#{escape @domain}/mailboxes", params)
     end
 
     def add_mailbox(attributes = {})
+      Kernel.warn 'Mailgunner::Client#add_mailbox is deprecated'
+
       post("/v2/#{escape @domain}/mailboxes", attributes)
     end
 
     def update_mailbox(name, attributes = {})
+      Kernel.warn 'Mailgunner::Client#update_mailbox is deprecated'
+
       put("/v2/#{escape @domain}/mailboxes/#{escape name}", attributes)
     end
 
     def delete_mailbox(name)
+      Kernel.warn 'Mailgunner::Client#delete_mailbox is deprecated'
+
       delete("/v2/#{escape @domain}/mailboxes/#{escape name}")
     end
 
@@ -294,7 +320,7 @@ module Mailgunner
     end
 
     def object
-      @object ||= @json.load(body)
+      @object ||= @json.parse(body)
     end
   end
 end

data/mailgunner.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'mailgunner'
-  s.version = '1.0.0'
+  s.version = '1.1.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
@@ -9,6 +9,7 @@ Gem::Specification.new do |s|
   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.10.3')
+  s.add_development_dependency('mocha', '~> 0.13.2')
+  s.add_development_dependency('faux', '~> 1.1.0')
   s.require_path = 'lib'
 end

data/spec/mailgunner_spec.rb

@@ -1,6 +1,8 @@
 require 'minitest/autorun'
+require 'mocha/setup'
 require 'mailgunner'
-require 'mocha'
+require 'faux'
+require 'json'
 
 class Net::HTTPGenericRequest
   def inspect
@@ -63,18 +65,6 @@ describe 'Mailgunner::Client' do
     end
   end
 
-  describe 'json method' do
-    it 'returns the value passed to the constructor' do
-      json = stub
-
-      Mailgunner::Client.new(json: json).json.must_equal(json)
-    end
-
-    it 'defaults to the standard library json implementation' do
-      @client.json.must_equal(JSON)
-    end
-  end
-
   describe 'send_message method' do
     it 'posts to the domain messages resource and returns a response object' do
       expect(Net::HTTP::Post, "/v2/#@domain/messages")
@@ -348,7 +338,11 @@ describe 'Mailgunner::Client' do
   end
 
   describe 'get_mailboxes method' do
-    it 'fetches the domain mailboxes resource and returns a response object' do
+    before do
+      Kernel.stubs(:warn)
+    end
+
+    it 'emits a deprecation warning and fetches the domain mailboxes resource and returns a response object' do
       expect(Net::HTTP::Get, "/v2/#@domain/mailboxes")
 
       @client.get_mailboxes.must_be_instance_of(Mailgunner::Response)
@@ -359,9 +353,21 @@ describe 'Mailgunner::Client' do
 
       @client.get_mailboxes(skip: 1, limit: 2)
     end
+
+    it 'emits a deprecation warning' do
+      Kernel.expects(:warn).with(regexp_matches(/Mailgunner::Client#get_mailboxes is deprecated/))
+
+      @client.http.stubs(:request)
+
+      @client.get_mailboxes
+    end
   end
 
   describe 'add_mailbox method' do
+    before do
+      Kernel.stubs(:warn)
+    end
+
     it 'posts to the domain mailboxes resource and returns a response object' do
       expect(Net::HTTP::Post, "/v2/#@domain/mailboxes")
 
@@ -373,9 +379,21 @@ describe 'Mailgunner::Client' do
 
       @client.add_mailbox({mailbox: 'user'})
     end
+
+    it 'emits a deprecation warning' do
+      Kernel.expects(:warn).with(regexp_matches(/Mailgunner::Client#add_mailbox is deprecated/))
+
+      @client.http.stubs(:request)
+
+      @client.add_mailbox({})
+    end
   end
 
   describe 'update_mailbox method' do
+    before do
+      Kernel.stubs(:warn)
+    end
+
     it 'updates the mailbox resource and returns a response object' do
       expect(Net::HTTP::Put, "/v2/#@domain/mailboxes/user")
 
@@ -387,14 +405,34 @@ describe 'Mailgunner::Client' do
 
       @client.update_mailbox('user', {password: 'secret'})
     end
+
+    it 'emits a deprecation warning' do
+      Kernel.expects(:warn).with(regexp_matches(/Mailgunner::Client#update_mailbox is deprecated/))
+
+      @client.http.stubs(:request)
+
+      @client.update_mailbox('user', {})
+    end
   end
 
   describe 'delete_mailbox method' do
+    before do
+      Kernel.stubs(:warn)
+    end
+
     it 'deletes the domain mailbox resource with the given address and returns a response object' do
       expect(Net::HTTP::Delete, "/v2/#@domain/mailboxes/user")
 
       @client.delete_mailbox('user').must_be_instance_of(Mailgunner::Response)
     end
+
+    it 'emits a deprecation warning' do
+      Kernel.expects(:warn).with(regexp_matches(/Mailgunner::Client#delete_mailbox is deprecated/))
+
+      @client.http.stubs(:request)
+
+      @client.delete_mailbox('user')
+    end
   end
 
   describe 'get_campaigns method' do
@@ -662,6 +700,41 @@ describe 'Mailgunner::Client' do
       @client.get_list_stats('developers@mailgun.net').must_be_instance_of(Mailgunner::Response)
     end
   end
+
+  describe 'json method' do
+    it 'emits a deprecation warning and returns the standard library json module' do
+      Kernel.expects(:warn).with(regexp_matches(/Mailgunner::Client#json is deprecated/))
+
+      Mailgunner::Client.new.json.must_equal(JSON)
+    end
+  end
+
+  describe 'json equals method' do
+    it 'emits a deprecation warning' do
+      Kernel.expects(:warn).with(regexp_matches(/Mailgunner::Client#json= is deprecated/))
+
+      Mailgunner::Client.new.json = nil
+    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/))
+ 
+      Mailgunner::Client.new(domain: @domain, api_key: @api_key, json: stub)
+    end
+
+    describe 'json method' do
+      it 'emits a deprecation warning and returns the value passed to the constructor' do
+        json = stub
+
+        Kernel.expects(:warn).once
+        Kernel.expects(:warn).with(regexp_matches(/Mailgunner::Client#json is deprecated/))
+
+        Mailgunner::Client.new(json: json).json.must_equal(json)
+      end
+    end
+  end
 end
 
 describe 'Mailgunner::Response' do
@@ -744,9 +817,9 @@ end
 
 describe 'Mailgunner::Response initialized with an alternative json implementation' do
   before do
-    @json = mock()
+    @json = faux(JSON)
 
-    @http_response = mock()
+    @http_response = stub
 
     @response = Mailgunner::Response.new(@http_response, :json => @json)
   end
@@ -755,7 +828,7 @@ describe 'Mailgunner::Response initialized with an alternative json implementati
     it 'uses the alternative json implementation to parse the response body' do
       @http_response.stubs(:body).returns(response_body = '{"foo":"bar"}')
 
-      @json.expects(:load).with(response_body)
+      @json.expects(:parse).with(response_body)
 
       @response.object
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailgunner
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-02 00:00:00.000000000 Z
+date: 2013-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 0.13.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 0.13.2
+- !ruby/object:Gem::Dependency
+  name: faux
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 description: A Ruby wrapper for the Mailgun API
 email:
 - mail@timcraft.com
@@ -74,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: See description