nexmo 0.4.0 → 0.5.0

data/README.md

@@ -41,7 +41,7 @@ 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)
+The Nexmo documentation contains a [list of error codes](http://nexmo.com/documentation/index.html#response_code)
 which may be useful if you have problems sending a message.
 
 

data/lib/nexmo.rb

@@ -1,13 +1,15 @@
 require 'net/http'
-require 'net/https'
 require 'json'
 require 'uri'
+require 'cgi'
 
 module Nexmo
   class Client
-    def initialize(key, secret)
+    def initialize(key, secret, options = {})
       @key, @secret = key, secret
 
+      @json = options.fetch(:json) { JSON }
+
       @headers = {'Content-Type' => 'application/x-www-form-urlencoded'}
 
       @http = Net::HTTP.new('rest.nexmo.com', 443)
@@ -20,22 +22,22 @@ module Nexmo
     def send_message(data)
       response = @http.post('/sms/json', encode(data), headers)
 
-      if ok?(response) && json?(response)
-        object = JSON.parse(response.body)['messages'].first
+      if response.code.to_i == 200 && response['Content-Type'].split(?;).first == 'application/json'
+        object = @json.load(response.body)['messages'].first
 
         status = object['status'].to_i
 
         if status == 0
-          Object.new(:message_id => object['message-id'], :success? => true, :failure? => false)
+          Success.new(object['message-id'])
         else
           error = Error.new("#{object['error-text']} (status=#{status})")
 
-          Object.new(:error => error, :http => response, :status => status, :success? => false, :failure? => true)
+          Failure.new(error, response, status)
         end
       else
         error = Error.new("Unexpected HTTP response (code=#{response.code})")
 
-        Object.new(:error => error, :http => response, :success? => false, :failure? => true)
+        Failure.new(error, response)
       end
     end
 
@@ -67,28 +69,42 @@ module Nexmo
       get("/search/rejections/#{key}/#{secret}", params)
     end
 
+    def search_messages(params)
+      get("/search/messages/#{key}/#{secret}", Hash === params ? params : {ids: Array(params)})
+    end
+
     private
 
     def get(path, params = {})
-      Response.new(@http.get(params.empty? ? path : "#{path}?#{URI.encode_www_form(params)}"))
+      Response.new(@http.get(request_uri(path, params)), json: @json)
     end
 
-    def ok?(response)
-      response.code.to_i == 200
+    def encode(data)
+      URI.encode_www_form data.merge(:username => @key, :password => @secret)
     end
 
-    def json?(response)
-      response['Content-Type'].split(?;).first == 'application/json'
+    def request_uri(path, hash = {})
+      if hash.empty?
+        path
+      else
+        query_params = hash.map do |key, values|
+          Array(values).map { |value| "#{escape(key)}=#{escape(value)}" }
+        end
+
+        path + '?' + query_params.flatten.join(?&)
+      end
     end
 
-    def encode(data)
-      URI.encode_www_form data.merge(:username => @key, :password => @secret)
+    def escape(component)
+      CGI.escape(component.to_s)
     end
   end
 
   class Response
-    def initialize(http_response)
+    def initialize(http_response, options = {})
       @http_response = http_response
+
+      @json = options.fetch(:json) { JSON }
     end
 
     def method_missing(name, *args, &block)
@@ -104,37 +120,27 @@ module Nexmo
     end
 
     def object
-      JSON.parse(body, object_class: Object)
+      @object ||= @json.load(body)
     end
   end
 
-  class Object
-    def initialize(attributes = {})
-      @attributes = attributes.to_hash
-    end
-
-    def [](name)
-      @attributes[name]
-    end
-
-    def []=(name, value)
-      @attributes[name.to_s.tr(?-, ?_).to_sym] = value
+  class Success < Struct.new(:message_id)
+    def success?
+      true
     end
 
-    def to_hash
-      @attributes
+    def failure?
+      false
     end
+  end
 
-    def respond_to_missing?(name, include_private = false)
-      @attributes.has_key?(name)
+  class Failure < Struct.new(:error, :http, :status)
+    def success?
+      false
     end
 
-    def method_missing(name, *args, &block)
-      if @attributes.has_key?(name) && args.empty? && block.nil?
-        @attributes[name]
-      else
-        super name, *args, &block
-      end
+    def failure?
+      true
     end
   end
 

data/nexmo.gemspec

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

data/spec/nexmo_spec.rb

@@ -1,9 +1,10 @@
 require 'minitest/autorun'
 require 'mocha'
+require 'oj'
 
 require_relative '../lib/nexmo'
 
-describe Nexmo::Client do
+describe 'Nexmo::Client' do
   before do
     @client = Nexmo::Client.new('key', 'secret')
   end
@@ -134,9 +135,23 @@ describe Nexmo::Client do
       @client.get_message_rejections(date: 'YYYY-MM-DD').must_be_instance_of(Nexmo::Response)
     end
   end
+
+  describe 'search_messages method' do
+    it 'fetches the search messages resource with the given parameters and returns a response object' do
+      @client.http.expects(:get).with('/search/messages/key/secret?date=YYYY-MM-DD&to=1234567890').returns(stub)
+
+      @client.search_messages(date: 'YYYY-MM-DD', to: 1234567890).must_be_instance_of(Nexmo::Response)
+    end
+
+    it 'should encode a non hash argument as a list of ids' do
+      @client.http.expects(:get).with('/search/messages/key/secret?ids=id1&ids=id2').returns(stub)
+
+      @client.search_messages(%w(id1 id2))
+    end
+  end
 end
 
-describe Nexmo::Response do
+describe 'Nexmo::Response' do
   before do
     @http_response = mock()
 
@@ -178,46 +193,26 @@ describe Nexmo::Response do
   end
 
   describe 'object method' do
-    it 'decodes the response body as json and returns an object' do
-      @http_response.expects(:body).returns('{}')
+    it 'decodes the response body as json and returns a hash' do
+      @http_response.expects(:body).returns('{"value":0.0}')
 
-      @response.object.must_be_instance_of(Nexmo::Object)
+      @response.object.must_equal({'value' => 0})
     end
   end
 end
 
-describe Nexmo::Object do
+describe 'Nexmo::Response initialized with a different json implementation' do
   before do
-    @value = 'xxx'
-
-    @object = Nexmo::Object.new(message_id: @value)
-  end
+    @http_response = mock()
 
-  it 'provides method access for attributes passed to the constructor' do
-    @object.message_id.must_equal(@value)
+    @response = Nexmo::Response.new(@http_response, json: Oj)
   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
+  describe 'object method' do
+    it 'decodes the response body as json and returns a hash' do
+      @http_response.expects(:body).returns('{"value":0.0}')
 
-  describe 'to_hash method' do
-    it 'returns a hash containing the object attributes' do
-      @object.to_hash.must_equal({message_id: @value})
+      @response.object.must_equal({'value' => 0})
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,40 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-06 00:00:00.000000000 Z
+date: 2012-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :runtime
+        version: 0.9.12
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 0.9.12
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.7
 description: A simple wrapper for the Nexmo API
 email:
 - mail@timcraft.com