nexmo 0.2.2 → 0.3.0

data/README.md

@@ -0,0 +1,56 @@
+A simple wrapper for the [Nexmo](http://nexmo.com/) API
+=======================================================
+
+
+Installation
+------------
+
+Run `gem install nexmo` and `require 'nexmo'`,
+or do the gemfile/bundle thing if you're using Rails.
+
+
+Usage
+-----
+
+Construct a client object with your Nexmo API credentials:
+
+```ruby
+nexmo = Nexmo::Client.new('...KEY...', '...SECRET...')
+```
+
+The underlying HTTP object is easily accessible. For example, you may want
+to adjust the SSL verification when testing locally:
+
+```ruby
+nexmo.http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+```
+
+Use the `send_message` method to send an SMS, passing the API
+parameters as a hash:
+
+```ruby
+response = nexmo.send_message({
+  from: 'RUBY',
+  to: '...NUMBER...',
+  text: 'Hello world'
+})
+```
+
+Phone numbers should be specified in international format. If the response
+is successful you can access the message id, and if it's a failure you can
+retrieve the error message and/or the underlying HTTP response returned from
+the server:
+
+```ruby
+if response.success?
+  # store response.message_id
+elsif response.failure?
+  # check response.error.message and/or response.http
+  # raise response.error
+end
+```
+
+The Nexmo documentation contains a [list of error codes](http://nexmo.com/documentation/index.html#dlr_error)
+which may be useful if you have problems sending a message.
+
+That's all folks. Chunky bacon.

data/lib/nexmo.rb

@@ -20,14 +20,18 @@ module Nexmo
     def send_message(data)
       response = @http.post('/sms/json', encode(data), headers)
 
-      object = JSON.parse(response.body)['messages'].first
+      if response.code.to_i == 200 && response['Content-Type'] == 'application/json'
+        object = JSON.parse(response.body)['messages'].first
 
-      status = object['status'].to_i
+        status = object['status'].to_i
 
-      if status == 0
-        Success.new(object['message-id'])
+        if status == 0
+          Success.new(object['message-id'])
+        else
+          Failure.new(Error.new("#{object['error-text']} (status=#{status})"), response)
+        end
       else
-        Failure.new(Error.new("#{object['error-text']} (status=#{status})"))
+        Failure.new(Error.new("Unexpected HTTP response (code=#{response.code})"), response)
       end
     end
 
@@ -48,7 +52,7 @@ module Nexmo
     end
   end
 
-  class Failure < Struct.new(:error)
+  class Failure < Struct.new(:error, :http)
     def success?
       false
     end

data/nexmo.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
   s.name = 'nexmo'
-  s.version = '0.2.2'
+  s.version = '0.3.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
   s.homepage = 'http://github.com/timcraft/nexmo'
   s.description = 'A simple wrapper for the Nexmo API'
   s.summary = 'See description'
-  s.files = Dir.glob('{lib,spec}/**/*') + %w(README.txt nexmo.gemspec)
+  s.files = Dir.glob('{lib,spec}/**/*') + %w(README.md nexmo.gemspec)
   s.add_dependency('json', ['~> 1.5'])
   s.add_development_dependency('mocha')
   s.require_path = 'lib'

data/spec/nexmo_spec.rb

@@ -26,8 +26,9 @@ describe Nexmo::Client do
       @headers = {'Content-Type' => 'application/x-www-form-urlencoded'}
     end
 
-    it 'should make the correct http call return a successful response if the first message status equals 0' do
-      http_response = stub(:body => '{"messages":[{"status":0,"message-id":"id"}]}')
+    it 'should make the correct http call and return a success object if the first message status equals 0' do
+      http_response = stub(:code => '200', :body => '{"messages":[{"status":0,"message-id":"id"}]}')
+      http_response.expects(:[]).with('Content-Type').returns('application/json')
 
       data = 'from=ruby&to=number&text=Hey%21&username=key&password=secret'
 
@@ -40,8 +41,9 @@ describe Nexmo::Client do
       response.message_id.must_equal('id')
     end
 
-    it 'should return a failure response if the first message status does not equal 0' do
-      http_response = stub(:body => '{"messages":[{"status":2,"error-text":"Missing from param"}]}')
+    it 'should return a failure object if the first message status does not equal 0' do
+      http_response = stub(:code => '200', :body => '{"messages":[{"status":2,"error-text":"Missing from param"}]}')
+      http_response.expects(:[]).with('Content-Type').returns('application/json')
 
       data = 'to=number&text=Hey%21&username=key&password=secret'
 
@@ -52,6 +54,22 @@ describe Nexmo::Client do
       response.success?.must_equal(false)
       response.failure?.must_equal(true)
       response.error.to_s.must_equal('Missing from param (status=2)')
+      response.http.wont_be_nil
+    end
+
+    it 'should return a failure object if the server returns an unexpected http response' do
+      http_response = stub(:code => '503')
+
+      data = 'from=ruby&to=number&text=Hey%21&username=key&password=secret'
+
+      @client.http.expects(:post).with('/sms/json', data, @headers).returns(http_response)
+
+      response = @client.send_message({from: 'ruby', to: 'number', text: 'Hey!'})
+
+      response.success?.must_equal(false)
+      response.failure?.must_equal(true)
+      response.error.to_s.must_equal('Unexpected HTTP response (code=503)')
+      response.http.wont_be_nil
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-21 00:00:00.000000000 Z
+date: 2012-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &3707430 !ruby/object:Gem::Requirement
+  requirement: &3132970 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *3707430
+  version_requirements: *3132970
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &3707100 !ruby/object:Gem::Requirement
+  requirement: &3132770 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *3707100
+  version_requirements: *3132770
 description: A simple wrapper for the Nexmo API
 email:
 - mail@timcraft.com
@@ -42,7 +42,7 @@ extra_rdoc_files: []
 files:
 - lib/nexmo.rb
 - spec/nexmo_spec.rb
-- README.txt
+- README.md
 - nexmo.gemspec
 homepage: http://github.com/timcraft/nexmo
 licenses: []
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: See description

data/README.txt

@@ -1,42 +0,0 @@
-A simple wrapper for the Nexmo API (http://nexmo.com/).
-
-Install via rubygems:
-
-  gem install nexmo
-
-Either require it, or add it to your Rails Gemfile:
-
-  require 'nexmo'
-
-  gem 'nexmo'
-
-Construct a client with your Nexmo API credentials:
-
-  nexmo = Nexmo::Client.new('...KEY...', '...SECRET...')
-
-The underlying HTTP object is easily accessible. For example, you may want
-to adjust the SSL verification when testing locally:
-
-  nexmo.http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-
-Use the send_message method to send an SMS, passing the API parameters
-as a hash:
-
-  response = nexmo.send_message({
-    from: 'RUBY',
-    to: '...NUMBER...',
-    text: 'Hello world'
-  })
-
-If the response is successful you can access the message id, and if it's
-a failure you can either check the error message or choose to raise the
-error as an exception:
-
-  if response.success?
-    # store response.message_id
-  elsif response.failure?
-    # check response.error.message
-    # raise response.error
-  end
-
-Chunky bacon.