nexmo 0.3.1 → 0.4.0

data/README.md

@@ -2,55 +2,50 @@ A simple wrapper for the [Nexmo](http://nexmo.com/) API
 =======================================================
 
 
-Installation
+Requirements
 ------------
 
-Run `gem install nexmo` and `require 'nexmo'`,
-or do the gemfile/bundle thing if you're using Rails.
+Ruby 1.9; Ruby 1.8 is not currently supported.
 
 
-Usage
------
+Installation
+------------
 
-Construct a client object with your Nexmo API credentials:
+    gem install nexmo
 
-```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:
+Quick Start
+-----------
 
 ```ruby
-nexmo.http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-```
+require 'nexmo'
 
-Use the `send_message` method to send an SMS, passing the API
-parameters as a hash:
+nexmo = Nexmo::Client.new('...API KEY...', '...API SECRET...')
 
-```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
+  puts "Sent message: #{response.message_id}"
 elsif response.failure?
-  # check response.error.message and/or response.http
-  # raise response.error
+  raise response.error
 end
 ```
 
+
+Troubleshooting
+---------------
+
+Phone numbers should be specified in international format.
+
 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.
+
+Bugs/Issues
+-----------
+
+Please report all bugs/issues via the GitHub issue tracker.

data/lib/nexmo.rb

@@ -20,45 +20,121 @@ module Nexmo
     def send_message(data)
       response = @http.post('/sms/json', encode(data), headers)
 
-      if response.code.to_i == 200 && response['Content-Type'].sub(/;.*/, '') == 'application/json'
+      if ok?(response) && json?(response)
         object = JSON.parse(response.body)['messages'].first
 
         status = object['status'].to_i
 
         if status == 0
-          Success.new(object['message-id'])
+          Object.new(:message_id => object['message-id'], :success? => true, :failure? => false)
         else
-          Failure.new(Error.new("#{object['error-text']} (status=#{status})"), response, status)
+          error = Error.new("#{object['error-text']} (status=#{status})")
+
+          Object.new(:error => error, :http => response, :status => status, :success? => false, :failure? => true)
         end
       else
-        Failure.new(Error.new("Unexpected HTTP response (code=#{response.code})"), response)
+        error = Error.new("Unexpected HTTP response (code=#{response.code})")
+
+        Object.new(:error => error, :http => response, :success? => false, :failure? => true)
       end
     end
 
+    def get_balance
+      get("/account/get-balance/#{key}/#{secret}")
+    end
+
+    def get_country_pricing(country_code)
+      get("/account/get-pricing/outbound/#{key}/#{secret}/#{country_code}")
+    end
+
+    def get_prefix_pricing(prefix)
+      get("/account/get-prefix-pricing/outbound/#{key}/#{secret}/#{prefix}")
+    end
+
+    def get_account_numbers(params)
+      get("/account/numbers/#{key}/#{secret}", params)
+    end
+
+    def number_search(country_code, params = {})
+      get("/number/search/#{key}/#{secret}/#{country_code}", params)
+    end
+
+    def get_message(id)
+      get("/search/message/#{key}/#{secret}/#{id}")
+    end
+
+    def get_message_rejections(params)
+      get("/search/rejections/#{key}/#{secret}", params)
+    end
+
     private
 
+    def get(path, params = {})
+      Response.new(@http.get(params.empty? ? path : "#{path}?#{URI.encode_www_form(params)}"))
+    end
+
+    def ok?(response)
+      response.code.to_i == 200
+    end
+
+    def json?(response)
+      response['Content-Type'].split(?;).first == 'application/json'
+    end
+
     def encode(data)
       URI.encode_www_form data.merge(:username => @key, :password => @secret)
     end
   end
 
-  class Success < Struct.new(:message_id)
-    def success?
-      true
+  class Response
+    def initialize(http_response)
+      @http_response = http_response
+    end
+
+    def method_missing(name, *args, &block)
+      @http_response.send(name, *args, &block)
     end
 
-    def failure?
-      false
+    def ok?
+      code.to_i == 200
+    end
+
+    def json?
+      self['Content-Type'].split(?;).first == 'application/json'
+    end
+
+    def object
+      JSON.parse(body, object_class: Object)
     end
   end
 
-  class Failure < Struct.new(:error, :http, :status)
-    def success?
-      false
+  class Object
+    def initialize(attributes = {})
+      @attributes = attributes.to_hash
     end
 
-    def failure?
-      true
+    def [](name)
+      @attributes[name]
+    end
+
+    def []=(name, value)
+      @attributes[name.to_s.tr(?-, ?_).to_sym] = value
+    end
+
+    def to_hash
+      @attributes
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      @attributes.has_key?(name)
+    end
+
+    def method_missing(name, *args, &block)
+      if @attributes.has_key?(name) && args.empty? && block.nil?
+        @attributes[name]
+      else
+        super name, *args, &block
+      end
     end
   end
 

data/nexmo.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'nexmo'
-  s.version = '0.3.1'
+  s.version = '0.4.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']

data/spec/nexmo_spec.rb

@@ -9,67 +9,215 @@ describe Nexmo::Client do
   end
 
   describe 'http method' do
-    it 'should return a Net::HTTP object that uses SSL' do
+    it 'returns a net http object that uses ssl' do
       @client.http.must_be_instance_of(Net::HTTP)
       @client.http.use_ssl?.must_equal(true)
     end
   end
 
   describe 'headers method' do
-    it 'should return a hash' do
+    it 'returns a hash' do
       @client.headers.must_be_kind_of(Hash)
     end
   end
 
   describe 'send_message method' do
-    before do
-      @headers = {'Content-Type' => 'application/x-www-form-urlencoded'}
-    end
-
-    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"}]}')
+    it 'posts to the sms resource' do
+      http_response = stub(code: '200', body: '{"messages":[{"status":0,"message-id":"id"}]}')
       http_response.expects(:[]).with('Content-Type').returns('application/json;charset=utf-8')
 
       data = 'from=ruby&to=number&text=Hey%21&username=key&password=secret'
 
-      @client.http.expects(:post).with('/sms/json', data, @headers).returns(http_response)
+      headers = {'Content-Type' => 'application/x-www-form-urlencoded'}
 
-      response = @client.send_message({from: 'ruby', to: 'number', text: 'Hey!'})
+      @client.http.expects(:post).with('/sms/json', data, headers).returns(http_response)
 
-      response.success?.must_equal(true)
-      response.failure?.must_equal(false)
-      response.message_id.must_equal('id')
+      @client.send_message({from: 'ruby', to: 'number', text: 'Hey!'})
     end
 
-    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')
+    describe 'when the first message status equals 0' do
+      it 'returns a success object' do
+        http_response = stub(code: '200', body: '{"messages":[{"status":0,"message-id":"id"}]}')
+        http_response.expects(:[]).with('Content-Type').returns('application/json;charset=utf-8')
+
+        @client.http.stubs(:post).returns(http_response)
+
+        response = @client.send_message({from: 'ruby', to: 'number', text: 'Hey!'})
+        response.success?.must_equal(true)
+        response.failure?.must_equal(false)
+        response.message_id.must_equal('id')
+      end
+    end
 
-      data = 'to=number&text=Hey%21&username=key&password=secret'
+    describe 'when the first message status does not equal 0' do
+      it 'returns a failure object' do
+        http_response = stub(code: '200', body: '{"messages":[{"status":2,"error-text":"Missing from param"}]}')
+        http_response.expects(:[]).with('Content-Type').returns('application/json')
 
-      @client.http.expects(:post).with('/sms/json', data, @headers).returns(http_response)
+        @client.http.stubs(:post).returns(http_response)
 
-      response = @client.send_message({to: 'number', text: 'Hey!'})
+        response = @client.send_message({to: 'number', text: 'Hey!'})
 
-      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
+        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
     end
 
-    it 'should return a failure object if the server returns an unexpected http response' do
-      http_response = stub(:code => '503')
+    describe 'when the server returns an unexpected http response' do
+      it 'returns a failure object' do
+        @client.http.stubs(:post).returns(stub(code: '503'))
 
-      data = 'from=ruby&to=number&text=Hey%21&username=key&password=secret'
+        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
+
+  describe 'get_balance method' do
+    it 'fetches the account balance resource and returns a response object' do
+      @client.http.expects(:get).with('/account/get-balance/key/secret').returns(stub)
+
+      @client.get_balance.must_be_instance_of(Nexmo::Response)
+    end
+  end
+
+  describe 'get_country_pricing method' do
+    it 'fetches the outbound pricing resource for the given country and returns a response object' do
+      @client.http.expects(:get).with('/account/get-pricing/outbound/key/secret/CA').returns(stub)
+
+      @client.get_country_pricing(:CA).must_be_instance_of(Nexmo::Response)
+    end
+  end
+
+  describe 'get_prefix_pricing method' do
+    it 'fetches the outbound pricing resource for the given prefix and returns a response object' do
+      @client.http.expects(:get).with('/account/get-prefix-pricing/outbound/key/secret/44').returns(stub)
+
+      @client.get_prefix_pricing(44).must_be_instance_of(Nexmo::Response)
+    end
+  end
+
+  describe 'get_account_numbers method' do
+    it 'fetches the account numbers resource with the given parameters and returns a response object' do
+      @client.http.expects(:get).with('/account/numbers/key/secret?size=25&pattern=33').returns(stub)
+
+      @client.get_account_numbers(size: 25, pattern: 33).must_be_instance_of(Nexmo::Response)
+    end
+  end
+
+  describe 'number_search method' do
+    it 'fetches the number search resource for the given country with the given parameters and returns a response object' do
+      @client.http.expects(:get).with('/number/search/key/secret/CA?size=25').returns(stub)
+
+      @client.number_search(:CA, size: 25).must_be_instance_of(Nexmo::Response)
+    end
+  end
+
+  describe 'get_message method' do
+    it 'fetches the message search resource for the given message id and returns a response object' do
+      @client.http.expects(:get).with('/search/message/key/secret/00A0B0C0').returns(stub)
+
+      @client.get_message('00A0B0C0').must_be_instance_of(Nexmo::Response)
+    end
+  end
+
+  describe 'get_message_rejections method' do
+    it 'fetches the message rejections resource with the given parameters and returns a response object' do
+      @client.http.expects(:get).with('/search/rejections/key/secret?date=YYYY-MM-DD').returns(stub)
+
+      @client.get_message_rejections(date: 'YYYY-MM-DD').must_be_instance_of(Nexmo::Response)
+    end
+  end
+end
 
-      @client.http.expects(:post).with('/sms/json', data, @headers).returns(http_response)
+describe Nexmo::Response do
+  before do
+    @http_response = mock()
+
+    @response = Nexmo::Response.new(@http_response)
+  end
+
+  it 'delegates to the underlying http response' do
+    @http_response.expects(: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 '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 an object' do
+      @http_response.expects(:body).returns('{}')
+
+      @response.object.must_be_instance_of(Nexmo::Object)
+    end
+  end
+end
+
+describe Nexmo::Object do
+  before do
+    @value = 'xxx'
+
+    @object = Nexmo::Object.new(message_id: @value)
+  end
 
-      response = @client.send_message({from: 'ruby', to: 'number', text: 'Hey!'})
+  it 'provides method access for attributes passed to the constructor' do
+    @object.message_id.must_equal(@value)
+  end
+
+  describe 'square brackets method' do
+    it 'returns the value of the given attribute' do
+      @object[:message_id].must_equal(@value)
+    end
+  end
+
+  describe 'square brackets equals method' do
+    it 'sets the value of the given attribute' do
+      @object['message_id'] = 'abc'
+      @object.message_id.wont_equal(@value)
+    end
+
+    it 'replaces dashes in keys with underscores' do
+      @object['message-id'] = 'abc'
+      @object.message_id.wont_equal(@value)
+    end
+  end
 
-      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
+  describe 'to_hash method' do
+    it 'returns a hash containing the object attributes' do
+      @object.to_hash.must_equal({message_id: @value})
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-28 00:00:00.000000000 Z
+date: 2012-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &3095740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *3095740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &3095540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +37,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *3095540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple wrapper for the Nexmo API
 email:
 - mail@timcraft.com
@@ -64,8 +74,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: See description
 test_files: []
+has_rdoc: