nexmo 1.1.0 → 1.2.0

data/README.md

@@ -1,5 +1,8 @@
-A Ruby wrapper for the [Nexmo](http://nexmo.com/) API
-=====================================================
+nexmo
+=====
+
+
+A Ruby wrapper for the [Nexmo API](https://www.nexmo.com/documentation/api/index.html).
 
 
 Installation
@@ -84,22 +87,23 @@ OAuth::Consumer.new(consumer_key, consumer_secret, {
 Using the `:body` or `:query_string` authorization mechanisms is not supported.
 
 
-Switching JSON implementations
-------------------------------
+Custom response behaviour
+-------------------------
 
-By default the "json" library is used to encode request bodies and decode response
-bodies. This is available in the Ruby 1.9 standard library, and as a gem for Ruby 1.8.
-You can specify an alternate implementation that you wish to use explicitly when
-constructing a client object. For example, to use [multi_json](https://rubygems.org/gems/multi_json):
+You can customise the response handling by passing a block when constructing
+a Nexmo::Client object. For example, if you want to use an alternative JSON
+implementation to decode response bodies, you could do this:
 
 ```ruby
-require 'nexmo'
-require 'multi_json'
-
-nexmo = Nexmo::Client.new('...API KEY...', '...API SECRET...', :json => MultiJson)
+nexmo = Nexmo::Client.new do |response|
+  response.object = MultiJson.load(response.body) if response.ok? && response.json?
+  response
+end
 ```
 
-Ditto for anything that is compatible with the default implementation.
+This might also be useful if you prefer a different style of error handling
+(e.g. raising exceptions on error and returning the response object directly
+for 200 OK responses), if you need to log responses etc.
 
 
 Troubleshooting

data/lib/nexmo.rb

@@ -5,10 +5,16 @@ require 'cgi'
 
 module Nexmo
   class Client
-    def initialize(key = ENV['NEXMO_API_KEY'], secret = ENV['NEXMO_API_SECRET'], options = {})
-      @key, @secret = key, secret
+    def initialize(key = ENV['NEXMO_API_KEY'], secret = ENV['NEXMO_API_SECRET'], options = {}, &block)
+      @key, @secret, @block = key, secret, block
 
-      @json = options.fetch(:json) { JSON }
+      if options.has_key?(:json)
+        Kernel.warn '[nexmo] :json option is deprecated'
+
+        @json = options[:json]
+      else
+        @json = JSON
+      end
 
       @http = Net::HTTP.new('rest.nexmo.com', Net::HTTP.https_default_port)
 
@@ -80,7 +86,7 @@ module Nexmo
         @http.get(request_uri(path, params.merge(:api_key => @key, :api_secret => @secret)))
       end
 
-      Response.new(http_response, :json => @json)
+      decode(http_response)
     end
 
     def post(path, params)
@@ -90,7 +96,13 @@ module Nexmo
         @http.post(path, @json.dump(params.merge(:api_key => @key, :api_secret => @secret)), {'Content-Type' => 'application/json'})
       end
 
-      Response.new(http_response, :json => @json)
+      decode(http_response)
+    end
+
+    def decode(http_response)
+      response = Response.new(http_response, :json => @json)
+
+      @block ? @block.call(response) : response
     end
 
     def request_uri(path, hash = {})
@@ -111,6 +123,8 @@ module Nexmo
   end
 
   class Response
+    attr_writer :object
+
     def initialize(http_response, options = {})
       @http_response = http_response
 
@@ -134,7 +148,7 @@ module Nexmo
     end
 
     def object
-      @object ||= @json.load(body)
+      @object ||= @json.parse(body)
     end
   end
 

data/nexmo.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'nexmo'
-  s.version = '1.1.0'
+  s.version = '1.2.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
@@ -10,8 +10,8 @@ Gem::Specification.new do |s|
   s.files = Dir.glob('{lib,spec}/**/*') + %w(README.md nexmo.gemspec)
   s.add_development_dependency('rake', '>= 0.9.3')
   s.add_development_dependency('mocha', '~> 0.13.2')
-  s.add_development_dependency('multi_json', '~> 1.3.6')
   s.add_development_dependency('oauth', '~> 0.4.7')
+  s.add_development_dependency('faux', '~> 1.1.0')
   s.require_path = 'lib'
 
   if RUBY_VERSION == '1.8.7'

data/spec/nexmo_spec.rb

@@ -1,8 +1,9 @@
 require 'minitest/autorun'
 require 'mocha/setup'
-require 'multi_json'
+require 'faux'
 require 'nexmo'
 require 'oauth'
+require 'json'
 
 describe 'Nexmo::Client' do
   before do
@@ -162,13 +163,21 @@ describe 'Nexmo::Client' do
   end
 
   describe 'when initialized with a different json implementation' do
-    before do
-      @client = Nexmo::Client.new('key', 'secret', :json => MultiJson)
+    it 'emits a deprecation warning' do
+      Kernel.expects(:warn).with(regexp_matches(/:json option is deprecated/))
+
+      @client = Nexmo::Client.new('key', 'secret', :json => stub)
     end
 
     describe 'send_message method' do
       it 'encodes the request body using the alternative json implementation' do
-        MultiJson.expects(:dump).with(instance_of(Hash))
+        Kernel.stubs(:warn)
+
+        @json = faux(JSON)
+
+        @json.expects(:dump).with(instance_of(Hash))
+
+        @client = Nexmo::Client.new('key', 'secret', :json => @json)
 
         @client.http.stubs(:post)
 
@@ -176,6 +185,20 @@ describe 'Nexmo::Client' do
       end
     end
   end
+
+  describe 'when initialized with a block' do
+    it 'calls the block for each response and returns the return value of the block' do
+      @client = Nexmo::Client.new('key', 'secret') do |response|
+        response.must_be_instance_of(Nexmo::Response)
+
+        :return_value
+      end
+
+      @client.http.stubs(:get).returns(stub)
+
+      @client.get_balance.must_equal(:return_value)
+    end
+  end
 end
 
 describe 'Nexmo::Response' do
@@ -228,14 +251,26 @@ describe 'Nexmo::Response' do
     end
   end
 
+  describe 'object equals method' do
+    it 'sets the object to be returned by the object method' do
+      @object = stub
+
+      @response.object = @object
+
+      @response.object.must_equal(@object)
+    end
+  end
+
   describe 'when initialized with a different json implementation' do
     before do
-      @response = Nexmo::Response.new(@http_response, :json => MultiJson)
+      @json = faux(JSON)
+
+      @response = Nexmo::Response.new(@http_response, :json => @json)
     end
 
     describe 'object method' do
       it 'decodes the response body using the alternative json implementation' do
-        MultiJson.expects(:load).with('{"value":0.0}')
+        @json.expects(:parse).with('{"value":0.0}')
 
         @http_response.stubs(:body).returns('{"value":0.0}')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2013-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,13 +44,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.13.2
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: oauth
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 0.4.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,15 +58,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 0.4.7
 - !ruby/object:Gem::Dependency
-  name: oauth
+  name: faux
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.7
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.7
+        version: 1.1.0
 description: A Ruby wrapper for the Nexmo API
 email:
 - mail@timcraft.com
@@ -106,8 +106,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: See description
 test_files: []
+has_rdoc: