nexmo 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47f16f5764c3fe417e459938495ca477c35fe795
-  data.tar.gz: ff55281f11a6bde0f430d0b532105055f4e11d81
+  metadata.gz: 3ef6856f5c4e7fb5d1aaf2dc94c0487501afa661
+  data.tar.gz: d5483a19e91810334838fcc842da883d0536673c
 SHA512:
-  metadata.gz: fbe03e55277356116df31c26682b2c0ba77adb28e34c854d6f9b7324095add975100e5ad527fa1f74e02e38c0669d78560939813537089c2f7409489001bd62d
-  data.tar.gz: 5fc3ff3f2db8e057f92d8910e2a4821319f5c61c0c3fa7b21cfdb3ab73457a8e9a518487ce33616e44f32f385a11476ff0ff1fec8b0d010f13a9fb9c754b2b8e
+  metadata.gz: b5643454f0546a2301fff3543a96ff321d190263f37cbb202abee9fd494fb9474ae1b278aa5ff8ffaafada94e0c5b9f8850dcdb16f02c96c8ed1fc667a397f31
+  data.tar.gz: 40f9abaa788cc4c177e109f738f3142ac28047e0154e44f44459a55ce608f2f7077a4b7fd4c999e06b9cbb1b202581eb35f9e0a53e68c32059318ae81e734d35

data/LICENSE.txt

@@ -0,0 +1,9 @@
+Copyright (c) TIMCRAFT <http://timcraft.com>
+
+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.
+
+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.

data/README.md

@@ -2,7 +2,7 @@ nexmo
 =====
 
 
-A Ruby wrapper for the [Nexmo API](https://www.nexmo.com/documentation/api/index.html).
+A Ruby wrapper for the [Nexmo API](https://docs.nexmo.com/).
 
 
 Installation
@@ -14,8 +14,8 @@ Installation
 Sending a message
 -----------------
 
-Construct a Nexmo::Client object and use the #send_message method to
-send a message. For example:
+Construct a Nexmo::Client object with your API credentials and call
+the #send_message method to send a message. For example:
 
 ```ruby
 require 'nexmo'
@@ -25,10 +25,14 @@ nexmo = Nexmo::Client.new(key: 'YOUR API KEY', secret: 'YOUR API SECRET')
 nexmo.send_message(from: 'Ruby', to: 'YOUR NUMBER', text: 'Hello world')
 ```
 
-This method call returns the message id if the message was sent successfully,
-or raises an exception if there was an error. 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.
+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.
+
+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
+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).
 
 
 Production environment variables
@@ -39,11 +43,3 @@ to use environment variables, as described by [12factor.net/config](http://12fac
 Nexmo::Client defaults to extracting the api key/secret it needs from the
 NEXMO_API_KEY and NEXMO_API_SECRET environment variables if the key/secret
 options were not specified explicitly.
-
-
-Troubleshooting
----------------
-
-Remember that phone numbers should be specified in international format.
-
-Please report all bugs/issues via the GitHub issue tracker.

data/lib/nexmo.rb

@@ -8,7 +8,7 @@ module Nexmo
   class AuthenticationError < Error; end
 
   class Client
-    attr_accessor :key, :secret, :http
+    attr_accessor :key, :secret
 
     def initialize(options = {})
       @key = options.fetch(:key) { ENV.fetch('NEXMO_API_KEY') }
@@ -16,10 +16,6 @@ module Nexmo
       @secret = options.fetch(:secret) { ENV.fetch('NEXMO_API_SECRET') }
 
       @host = options.fetch(:host) { 'rest.nexmo.com' }
-
-      @http = Net::HTTP.new(@host, Net::HTTP.https_default_port)
-
-      @http.use_ssl = true
     end
 
     def send_message(params)
@@ -29,11 +25,9 @@ module Nexmo
 
       status = item['status'].to_i
 
-      if status == 0
-        item['message-id']
-      else
-        raise Error, "#{item['error-text']} (status=#{status})"
-      end
+      raise Error, "#{item['error-text']} (status=#{status})" unless status.zero?
+
+      return item
     end
 
     def get_balance
@@ -105,23 +99,53 @@ module Nexmo
     end
 
     def initiate_tts_call(params)
-      post('/tts/json', params)
+      post('https://api.nexmo.com/tts/json', params)
     end
 
     def initiate_tts_prompt_call(params)
-      post('/tts-prompt/json', params)
+      post('https://api.nexmo.com/tts-prompt/json', params)
+    end
+
+    def send_verification_request(params)
+      post('https://api.nexmo.com/verify/json', params)
+    end
+
+    def check_verification_request(params)
+      post('https://api.nexmo.com/verify/check/json', params)
+    end
+
+    def get_verification_request(id)
+      get('https://api.nexmo.com/verify/search/json', :request_id => id)
+    end
+
+    def request_number_insight(params)
+      post('/ni/json', params)
     end
 
     private
 
     def get(path, params = {})
-      parse @http.get(request_uri(path, params.merge(:api_key => @key, :api_secret => @secret)))
+      uri = URI.join("https://#{@host}", path)
+      uri.query = query_string(params.merge(:api_key => @key, :api_secret => @secret))
+
+      get_request = Net::HTTP::Get.new(uri.request_uri)
+
+      http = Net::HTTP.new(uri.host, Net::HTTP.https_default_port)
+      http.use_ssl = true
+
+      parse http.request(get_request)
     end
 
     def post(path, params)
-      body = URI.encode_www_form(params.merge(:api_key => @key, :api_secret => @secret))
+      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)
 
-      parse @http.post(path, body, {'Content-Type' => 'application/x-www-form-urlencoded'})
+      http = Net::HTTP.new(uri.host, Net::HTTP.https_default_port)
+      http.use_ssl = true
+
+      parse http.request(post_request)
     end
 
     def parse(http_response)
@@ -139,16 +163,8 @@ module Nexmo
       end
     end
 
-    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
+    def query_string(params)
+      params.flat_map { |k, vs| Array(vs).map { |v| "#{escape(k)}=#{escape(v)}" } }.join('&')
     end
 
     def escape(component)

data/nexmo.gemspec

@@ -1,14 +1,17 @@
 Gem::Specification.new do |s|
   s.name = 'nexmo'
-  s.version = '2.0.0'
+  s.version = '3.0.0'
+  s.license = 'LGPL-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 Ruby wrapper for the Nexmo API'
   s.summary = 'See description'
-  s.files = Dir.glob('{lib,spec}/**/*') + %w(README.md nexmo.gemspec)
-  s.add_development_dependency('rake', '>= 0.9.3')
-  s.add_development_dependency('webmock', '~> 1.18.0')
+  s.files = Dir.glob('{lib,spec}/**/*') + %w(LICENSE.txt README.md nexmo.gemspec)
+  s.required_ruby_version = '>= 1.9.3'
+  s.add_development_dependency('rake', '~> 10.1')
+  s.add_development_dependency('webmock', '~> 1.18')
+  s.add_development_dependency('minitest', '~> 5.0')
   s.require_path = 'lib'
 end

data/spec/nexmo_spec.rb

@@ -10,6 +10,8 @@ describe 'Nexmo::Client' do
   before do
     @base_url = 'https://rest.nexmo.com'
 
+    @api_base_url = 'https://api.nexmo.com'
+
     @form_urlencoded_data = {body: /(.+?)=(.+?)(&(.+?)=(.+?))+/, headers: {'Content-Type' => 'application/x-www-form-urlencoded'}}
 
     @json_response_body = json_response_body('{"key":"value"}')
@@ -21,21 +23,13 @@ describe 'Nexmo::Client' do
     @client = Nexmo::Client.new(key: 'key', secret: 'secret')
   end
 
-  describe 'http method' 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 'send_message method' do
-    it 'posts to the sms json resource and returns the message id' do
+    it 'posts to the sms json resource and returns the response message object' do
       response_body = json_response_body('{"messages":[{"status":0,"message-id":"id"}]}')
 
       stub_request(:post, "#@base_url/sms/json").with(@form_urlencoded_data).to_return(response_body)
 
-      @client.send_message(@example_message_hash).must_equal('id')
+      @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
@@ -229,7 +223,7 @@ describe 'Nexmo::Client' do
 
   describe 'initiate_tts_call method' do
     it 'posts to the tts json resource and returns the response object' do
-      url = "#@base_url/tts/json"
+      url = "#@api_base_url/tts/json"
 
       stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
 
@@ -239,7 +233,7 @@ describe 'Nexmo::Client' do
 
   describe 'initiate_tts_prompt_call method' do
     it 'posts to the tts prompt json resource and returns the response object' do
-      url = "#@base_url/tts-prompt/json"
+      url = "#@api_base_url/tts-prompt/json"
 
       stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
 
@@ -247,6 +241,46 @@ describe 'Nexmo::Client' do
     end
   end
 
+  describe 'send_verification_request method' do
+    it 'posts to the verify json resource and returns the response object' do
+      url = "#@api_base_url/verify/json"
+
+      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+
+      @client.send_verification_request(number: '447525856424', brand: 'MyApp')
+    end
+  end
+
+  describe 'check_verification_request method' do
+    it 'posts to the verify json resource and returns the response object' do
+      url = "#@api_base_url/verify/check/json"
+
+      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+
+      @client.check_verification_request(request_id: '8g88g88eg8g8gg9g90', code: '123445')
+    end
+  end
+
+  describe 'get_verification_request method' do
+    it 'fetches the verify search resource with the given request id and returns the response object' do
+      url = "#@api_base_url/verify/search/json?api_key=key&api_secret=secret&request_id=8g88g88eg8g8gg9g90"
+
+      stub_request(:get, url).to_return(@json_response_body)
+
+      @client.get_verification_request('8g88g88eg8g8gg9g90')
+    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"
+
+      stub_request(:post, url).with(@form_urlencoded_data).to_return(@json_response_body)
+
+      @client.request_number_insight(number: '447525856424', callback: 'https://example.com')
+    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)
 
@@ -260,8 +294,14 @@ describe 'Nexmo::Client' do
   end
 
   it 'provides an option for specifying a different hostname to connect to' do
+    url = "https://rest-sandbox.nexmo.com/number/search?api_key=key&api_secret=secret&country=CA&size=25"
+
+    request = stub_request(:get, url).to_return(@json_response_body)
+
     @client = Nexmo::Client.new(key: 'key', secret: 'secret', host: 'rest-sandbox.nexmo.com')
 
-    @client.http.address.must_equal('rest-sandbox.nexmo.com')
+    @client.number_search(:CA, :size => 25)
+
+    assert_requested(request)
   end
 end

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-25 00:00:00.000000000 Z
+date: 2015-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.3
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.3
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: '5.0'
 description: A Ruby wrapper for the Nexmo API
 email:
 - mail@timcraft.com
@@ -45,12 +59,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
 - README.md
 - lib/nexmo.rb
 - nexmo.gemspec
 - spec/nexmo_spec.rb
 homepage: http://github.com/timcraft/nexmo
-licenses: []
+licenses:
+- LGPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -60,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="