nexmo 3.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16f62b49870328ce5fbc096543f5a984fe558836
-  data.tar.gz: 660c5909b6a715ddfd5e0edf97b8204e57a1e775
+  metadata.gz: 2d795a930aa30a986720f2c457bcc4cd38d25bd0
+  data.tar.gz: dcdb8a13190059e0fd03839f4181cdeed6f368ad
 SHA512:
-  metadata.gz: 189fed1951c2e880eccfc8aeb11ea62087f9c4cbc52f0cfede16356f314958c37b00786e7c795e89833fb8834943c5e50d8640e528662e4eab90eb1442362555
-  data.tar.gz: e8446f7d4ee9cb7df574390aa3526cf1d607aaa6c1b4fffe5626f6d1775660733c4c0715aa7b979448b35e3b10d66c14bb2d3b92d09bf86dcf6ddc809231ea9c
+  metadata.gz: 05fe7b23621f647f18f97afe4e56702ac75927d2a403c2ed82d94a5961f6a8eec2315404b1af0e4f9531316a21317a50c290652e571ea74eceb8b9ebbada65a1
+  data.tar.gz: 698907b35b947e52e4a380ac8988449886891a8c3dee1da785fae29d6c6d2cff410fcf2b9d25f54a04e9f6b4ae45af8bbbd528ad4024ec73534dec992f0f26a5

data/LICENSE.txt

@@ -1,9 +1,24 @@
-Copyright (c) TIMCRAFT <http://timcraft.com>
+The MIT License (MIT)
 
-This is an Open Source project licensed under the terms of the LGPLv3 license.
-Please see <http://www.gnu.org/licenses/lgpl-3.0.html> for license text.
+Copyright (c) 2016 Nexmo Inc
 
-This code is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU Lesser General Public License for more details.
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -15,21 +15,24 @@ Sending a message
 -----------------
 
 Construct a Nexmo::Client object with your API credentials and call
-the #send_message method to send a message. For example:
+the #send_message method. For example:
 
 ```ruby
 require 'nexmo'
 
 nexmo = Nexmo::Client.new(key: 'YOUR API KEY', secret: 'YOUR API SECRET')
 
-nexmo.send_message(from: 'Ruby', to: 'YOUR NUMBER', text: 'Hello world')
-```
+response = nexmo.send_message(from: 'Ruby', to: 'YOUR NUMBER', text: 'Hello world')
 
-This method call returns the message id and other details if the message
-was sent successfully, or raises an exception if there was an error.
+if response['messages'][0]['status'].zero?
+  # success!
+else
+  # error response
+end
+```
 
-The Nexmo documentation contains a [list of error codes](https://docs.nexmo.com/index.php/sms-api/send-message#response_code)
-which may be useful for debugging exceptions. Remember that phone numbers
+The Nexmo documentation contains a [list of response codes](https://docs.nexmo.com/api-ref/sms-api/response/status-codes)
+which may be useful for debugging errors. Remember that phone numbers
 should be specified in international format, and other country specific
 restrictions may apply (e.g. US messages must originate from either a
 pre-approved long number or short code).

data/lib/nexmo.rb

@@ -1,3 +1,4 @@
+require 'nexmo/version'
 require 'net/http'
 require 'json'
 require 'cgi'
@@ -5,7 +6,11 @@ require 'cgi'
 module Nexmo
   class Error < StandardError; end
 
-  class AuthenticationError < Error; end
+  class ClientError < Error; end
+
+  class ServerError < Error; end
+
+  class AuthenticationError < ClientError; end
 
   class Client
     attr_accessor :key, :secret
@@ -19,15 +24,7 @@ module Nexmo
     end
 
     def send_message(params)
-      response = post('/sms/json', params)
-
-      item = response['messages'].first
-
-      status = item['status'].to_i
-
-      raise Error, "#{item['error-text']} (status=#{status})" unless status.zero?
-
-      return item
+      post('/sms/json', params)
     end
 
     def get_balance
@@ -35,11 +32,11 @@ module Nexmo
     end
 
     def get_country_pricing(country_code)
-      get('/account/get-pricing/outbound', {:country => country_code})
+      get('/account/get-pricing/outbound', country: country_code)
     end
 
     def get_prefix_pricing(prefix)
-      get('/account/get-prefix-pricing/outbound', {:prefix => prefix})
+      get('/account/get-prefix-pricing/outbound', prefix: prefix)
     end
 
     def get_account_numbers(params)
@@ -47,13 +44,7 @@ module Nexmo
     end
 
     def get_available_numbers(country_code, params = {})
-      get('/number/search', {:country => country_code}.merge(params))
-    end
-
-    def number_search(country_code, params = {})
-      Kernel.warn '[nexmo] #number_search is deprecated and will be removed, please use #get_available_numbers instead'
-
-      get_available_numbers(country_code, params)
+      get('/number/search', {country: country_code}.merge(params))
     end
 
     def buy_number(params)
@@ -69,7 +60,7 @@ module Nexmo
     end
 
     def get_message(id)
-      get('/search/message', {:id => id})
+      get('/search/message', id: id)
     end
 
     def get_message_rejections(params)
@@ -77,7 +68,7 @@ module Nexmo
     end
 
     def search_messages(params)
-      get('/search/messages', Hash === params ? params : {:ids => Array(params)})
+      get('/search/messages', Hash === params ? params : {ids: Array(params)})
     end
 
     def send_ussd_push_message(params)
@@ -121,44 +112,56 @@ module Nexmo
     end
 
     def get_verification_request(id)
-      get('https://api.nexmo.com/verify/search/json', :request_id => id)
+      get('https://api.nexmo.com/verify/search/json', request_id: id)
     end
 
     def control_verification_request(params)
       post('https://api.nexmo.com/verify/control/json', params)
     end
 
+    def get_basic_number_insight(params)
+      get('https://api.nexmo.com/number/format/json', params)
+    end
+
+    def get_number_insight(params)
+      get('https://api.nexmo.com/number/lookup/json', params)
+    end
+
     def request_number_insight(params)
       post('/ni/json', params)
     end
 
     private
 
+    USER_AGENT = "ruby-nexmo/#{VERSION}/#{RUBY_VERSION}"
+
     def get(path, params = {})
       uri = URI.join("https://#{@host}", path)
-      uri.query = query_string(params.merge(:api_key => @key, :api_secret => @secret))
+      uri.query = query_string(params.merge(api_key: @key, api_secret: @secret))
 
       get_request = Net::HTTP::Get.new(uri.request_uri)
+      get_request['User-Agent'] = USER_AGENT
 
       http = Net::HTTP.new(uri.host, Net::HTTP.https_default_port)
       http.use_ssl = true
 
-      parse http.request(get_request)
+      parse http.request(get_request), uri.host
     end
 
     def post(path, params)
       uri = URI.join("https://#{@host}", path)
 
       post_request = Net::HTTP::Post.new(uri.request_uri)
-      post_request.form_data = params.merge(:api_key => @key, :api_secret => @secret)
+      post_request.form_data = params.merge(api_key: @key, api_secret: @secret)
+      post_request['User-Agent'] = USER_AGENT
 
       http = Net::HTTP.new(uri.host, Net::HTTP.https_default_port)
       http.use_ssl = true
 
-      parse http.request(post_request)
+      parse http.request(post_request), uri.host
     end
 
-    def parse(http_response)
+    def parse(http_response, host)
       case http_response
       when Net::HTTPSuccess
         if http_response['Content-Type'].split(';').first == 'application/json'
@@ -167,9 +170,13 @@ module Nexmo
           http_response.body
         end
       when Net::HTTPUnauthorized
-        raise AuthenticationError
+        raise AuthenticationError, "#{http_response.code} response from #{host}"
+      when Net::HTTPClientError
+        raise ClientError, "#{http_response.code} response from #{host}"
+      when Net::HTTPServerError
+        raise ServerError, "#{http_response.code} response from #{host}"
       else
-        raise Error, "Unexpected HTTP response (code=#{http_response.code})"
+        raise Error, "#{http_response.code} response from #{host}"
       end
     end
 

data/lib/nexmo/version.rb

@@ -0,0 +1,3 @@
+module Nexmo
+  VERSION = '4.0.0'
+end

data/nexmo.gemspec

@@ -1,11 +1,13 @@
+require File.expand_path('lib/nexmo/version', File.dirname(__FILE__))
+
 Gem::Specification.new do |s|
   s.name = 'nexmo'
-  s.version = '3.1.0'
-  s.license = 'LGPL-3.0'
+  s.version = Nexmo::VERSION
+  s.license = 'MIT'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
-  s.homepage = 'http://github.com/timcraft/nexmo'
+  s.homepage = 'http://github.com/Nexmo/nexmo'
   s.description = 'Ruby client for the Nexmo API'
   s.summary = 'See description'
   s.files = Dir.glob('{lib,spec}/**/*') + %w(LICENSE.txt README.md nexmo.gemspec)

data/spec/nexmo_spec.rb

@@ -18,7 +18,7 @@ describe 'Nexmo::Client' do
 
     @json_response_object = {'key' => 'value'}
 
-    @example_message_hash = {:from => 'ruby', :to => 'number', :text => 'Hey!'}
+    @example_message_hash = {from: 'ruby', to: 'number', text: 'Hey!'}
 
     @client = Nexmo::Client.new(key: 'key', secret: 'secret')
   end
@@ -29,17 +29,7 @@ describe 'Nexmo::Client' do
 
       stub_request(:post, "#@base_url/sms/json").with(@form_urlencoded_data).to_return(response_body)
 
-      @client.send_message(@example_message_hash).must_equal({'status' => 0, 'message-id' => 'id'})
-    end
-
-    it 'raises an exception if the response body contains an error' do
-      response_body = json_response_body('{"messages":[{"status":2,"error-text":"Missing from param"}]}')
-
-      stub_request(:post, "#@base_url/sms/json").with(@form_urlencoded_data).to_return(response_body)
-
-      exception = proc { @client.send_message(@example_message_hash) }.must_raise(Nexmo::Error)
-
-      exception.message.must_include('Missing from param')
+      @client.send_message(@example_message_hash).must_equal({'messages' => [{'status' => 0, 'message-id' => 'id'}]})
     end
   end
 
@@ -79,31 +69,7 @@ describe 'Nexmo::Client' do
 
       stub_request(:get, url).to_return(@json_response_body)
 
-      @client.get_account_numbers(:size => 25, :pattern => 33).must_equal(@json_response_object)
-    end
-  end
-
-  describe 'number_search method' do
-    it 'fetches the number search resource for the given country with the given parameters and returns the response object' do
-      url = "#@base_url/number/search?api_key=key&api_secret=secret&country=CA&size=25"
-
-      stub_request(:get, url).to_return(@json_response_body)
-
-      @client.number_search(:CA, :size => 25).must_equal(@json_response_object)
-    end
-
-    it 'emits a deprecation warning' do
-      message = nil
-
-      url = "#@base_url/number/search?api_key=key&api_secret=secret&country=CA&size=25"
-
-      stub_request(:get, url).to_return(@json_response_body)
-
-      Kernel.stub :warn, proc { |msg| message = msg } do
-        @client.number_search(:CA, :size => 25)
-      end
-
-      message.must_match(/#number_search is deprecated/)
+      @client.get_account_numbers(size: 25, pattern: 33).must_equal(@json_response_object)
     end
   end
 
@@ -113,7 +79,7 @@ describe 'Nexmo::Client' do
 
       stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
 
-      @client.buy_number(:country => 'US', :msisdn => 'number').must_equal(@json_response_object)
+      @client.buy_number(country: 'US', msisdn: 'number').must_equal(@json_response_object)
     end
   end
 
@@ -123,7 +89,7 @@ describe 'Nexmo::Client' do
 
       stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
 
-      @client.cancel_number(:country => 'US', :msisdn => 'number').must_equal(@json_response_object)
+      @client.cancel_number(country: 'US', msisdn: 'number').must_equal(@json_response_object)
     end
   end
 
@@ -133,7 +99,7 @@ describe 'Nexmo::Client' do
 
       stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
 
-      @client.update_number(:country => 'US', :msisdn => 'number', :moHttpUrl => 'callback').must_equal(@json_response_object)
+      @client.update_number(country: 'US', msisdn: 'number', moHttpUrl: 'callback').must_equal(@json_response_object)
     end
   end
 
@@ -153,7 +119,7 @@ describe 'Nexmo::Client' do
 
       stub_request(:get, url).to_return(@json_response_body)
 
-      @client.get_message_rejections(:date => 'YYYY-MM-DD').must_equal(@json_response_object)
+      @client.get_message_rejections(date: 'YYYY-MM-DD').must_equal(@json_response_object)
     end
   end
 
@@ -163,7 +129,7 @@ describe 'Nexmo::Client' do
 
       stub_request(:get, url).to_return(@json_response_body)
 
-      @client.search_messages(:date => 'YYYY-MM-DD', :to => 1234567890).must_equal(@json_response_object)
+      @client.search_messages(date: 'YYYY-MM-DD', to: 1234567890).must_equal(@json_response_object)
     end
 
     it 'should encode a non hash argument as a list of ids' do
@@ -295,6 +261,26 @@ describe 'Nexmo::Client' do
     end
   end
 
+  describe 'get_basic_number_insight method' do
+    it 'fetches the number format json resource and returns the response object' do
+      url = "#@api_base_url/number/format/json?api_key=key&api_secret=secret&number=447525856424"
+
+      stub_request(:get, url).to_return(@json_response_body)
+
+      @client.get_basic_number_insight(number: '447525856424')
+    end
+  end
+
+  describe 'get_number_insight method' do
+    it 'fetches the number lookup json resource and returns the response object' do
+      url = "#@api_base_url/number/lookup/json?api_key=key&api_secret=secret&number=447525856424"
+
+      stub_request(:get, url).to_return(@json_response_body)
+
+      @client.get_number_insight(number: '447525856424')
+    end
+  end
+
   describe 'request_number_insight method' do
     it 'posts to the number insight resource and returns the response object' do
       url = "#@base_url/ni/json"
@@ -305,10 +291,12 @@ describe 'Nexmo::Client' do
     end
   end
 
-  it 'raises an exception if the response code is not 2xx' do
-    stub_request(:post, "#@base_url/sms/json").with(@form_urlencoded_data).to_return(status: 500)
+  it 'includes a user-agent header with the library version number and ruby version number' do
+    headers = {'User-Agent' => "ruby-nexmo/#{Nexmo::VERSION}/#{RUBY_VERSION}"}
+
+    stub_request(:post, "#@base_url/sms/json").with(headers: headers).to_return(@json_response_body)
 
-    proc { @client.send_message(@example_message_hash) }.must_raise(Nexmo::Error)
+    @client.send_message(@example_message_hash)
   end
 
   it 'raises an authentication error exception if the response code is 401' do
@@ -317,6 +305,18 @@ describe 'Nexmo::Client' do
     proc { @client.send_message(@example_message_hash) }.must_raise(Nexmo::AuthenticationError)
   end
 
+  it 'raises a client error exception if the response code is 4xx' do
+    stub_request(:post, "#@base_url/sms/json").with(@form_urlencoded_data).to_return(status: 400)
+
+    proc { @client.send_message(@example_message_hash) }.must_raise(Nexmo::ClientError)
+  end
+
+  it 'raises a server error exception if the response code is 5xx' do
+    stub_request(:post, "#@base_url/sms/json").with(@form_urlencoded_data).to_return(status: 500)
+
+    proc { @client.send_message(@example_message_hash) }.must_raise(Nexmo::ServerError)
+  end
+
   it 'provides an option for specifying a different hostname to connect to' do
     url = "https://rest-sandbox.nexmo.com/account/get-balance?api_key=key&api_secret=secret"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -62,11 +62,12 @@ files:
 - LICENSE.txt
 - README.md
 - lib/nexmo.rb
+- lib/nexmo/version.rb
 - nexmo.gemspec
 - spec/nexmo_spec.rb
-homepage: http://github.com/timcraft/nexmo
+homepage: http://github.com/Nexmo/nexmo
 licenses:
-- LGPL-3.0
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -84,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: See description