nexmo 4.8.0 → 5.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc7d3219d5a4d8671e83fa33eb807e317778b479
-  data.tar.gz: 51cec360405377fca50f586cc5fc5fb375a23409
+  metadata.gz: 639e15b4528acd516e42819a9e31082679af8602
+  data.tar.gz: 3668f21fa546e4de69cd4341655a64a5438d8273
 SHA512:
-  metadata.gz: 781a072b8c216d96d000aec974974f648ca5375899380279d4ac8ddb55ca5824df744b4bdf1e959d19919bfb00125159f69d0e558706c7d187badbce70df1bc1
-  data.tar.gz: e540e6124bb1d17c166ca0ddf2ab166083869f5330f1285fa42f21f85ad3df1a09ae3c0f146cb3b64ba8982d58f6e6dd208e6bff2ad5cb595d87815588f54d25
+  metadata.gz: 715dc4611c9310ae2776a43ab422c1d6a61980277b6ac62c52bfc3d02428d3d93de99749fc7e7e4d3ccfeb4c7b5cba97e5e61d6dbf55b4199b041a12d32759ab
+  data.tar.gz: 5c4f1fd0ee8fb5b8202082643b386f8aea7596b2ac5ccab568530f19f6c32cdb60331c7d159212b0e85b3cc300a1f9507df7f6cd36c8c3e5bf24e14de7a97a2c

data/README.md

@@ -17,6 +17,11 @@ need a Nexmo account. Sign up [for free at nexmo.com][signup].
 * [License](#license)
 
 
+## Requirements
+
+Nexmo Ruby supports CRuby 2.0.0+ and JRuby 9k.
+
+
 ## Installation
 
 To install the Ruby client library using Rubygems:
@@ -39,7 +44,7 @@ require 'nexmo'
 Then construct a client object with your key and secret:
 
 ```ruby
-client = Nexmo::Client.new(key: 'YOUR-API-KEY', secret: 'YOUR-API-SECRET')
+client = Nexmo::Client.new(api_key: 'YOUR-API-KEY', api_secret: 'YOUR-API-SECRET')
 ```
 
 You can now use the client object to [send a text message](#send-a-text-message),
@@ -79,12 +84,12 @@ of source control, or in some kind of key management infrastructure.
 ### Send a text message
 
 ```ruby
-response = client.send_message(from: 'Ruby', to: 'YOUR NUMBER', text: 'Hello world')
+response = client.sms.send(from: 'Ruby', to: 'YOUR NUMBER', text: 'Hello world')
 
-if response['messages'][0]['status'] == '0'
-  puts "Sent message #{response['messages'][0]['message-id']}"
+if response.messages.first.status == '0'
+  puts "Sent message id=#{response.messages.first.message_id}"
 else
-  puts "Error: #{response['messages'][0]['error-text']}"
+  puts "Error: #{response.messages.first.error_text}"
 end
 ```
 
@@ -96,7 +101,7 @@ Docs: [https://developer.nexmo.com/api/sms#request](https://developer.nexmo.com/
 ### Make a call
 
 ```ruby
-response = client.create_call({
+response = client.calls.create({
   to: [{type: 'phone', number: '14843331234'}],
   from: {type: 'phone', number: '14843335555'},
   answer_url: ['https://example.com/answer']
@@ -108,7 +113,7 @@ Docs: [https://developer.nexmo.com/api/voice#create-an-outbound-call](https://de
 ### Retrieve a list of calls
 
 ```ruby
-response = client.get_calls
+response = client.calls.list
 ```
 
 Docs: [https://developer.nexmo.com/api/voice#retrieve-information-about-all-your-calls](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#retrieve-information-about-all-your-calls)
@@ -116,7 +121,7 @@ Docs: [https://developer.nexmo.com/api/voice#retrieve-information-about-all-your
 ### Retrieve a single call
 
 ```ruby
-response = client.get_call(uuid)
+response = client.calls.get(uuid)
 ```
 
 Docs: [https://developer.nexmo.com/api/voice#retrieve-information-about-a-single-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#retrieve-information-about-a-single-call)
@@ -124,7 +129,7 @@ Docs: [https://developer.nexmo.com/api/voice#retrieve-information-about-a-single
 ### Update a call
 
 ```ruby
-response = client.update_call(uuid, action: 'hangup')
+response = client.calls.hangup(uuid)
 ```
 
 Docs: [https://developer.nexmo.com/api/voice#modify-an-existing-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#modify-an-existing-call)
@@ -134,7 +139,7 @@ Docs: [https://developer.nexmo.com/api/voice#modify-an-existing-call](https://de
 ```ruby
 stream_url = 'https://nexmo-community.github.io/ncco-examples/assets/voice_api_audio_streaming.mp3'
 
-response = client.send_audio(uuid, stream_url: stream_url)
+response = client.stream.start(uuid, stream_url: stream_url)
 ```
 
 Docs: [https://developer.nexmo.com/api/voice#stream-an-audio-file-to-an-active-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#stream-an-audio-file-to-an-active-call)
@@ -142,7 +147,7 @@ Docs: [https://developer.nexmo.com/api/voice#stream-an-audio-file-to-an-active-c
 ### Stop streaming audio to a call
 
 ```ruby
-response = client.stop_audio(uuid)
+response = client.stream.stop(uuid)
 ```
 
 Docs: [https://developer.nexmo.com/api/voice#stop-streaming-an-audio-file-to-an-active-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#stop-streaming-an-audio-file-to-an-active-call)
@@ -150,7 +155,7 @@ Docs: [https://developer.nexmo.com/api/voice#stop-streaming-an-audio-file-to-an-
 ### Send a synthesized speech message to a call
 
 ```ruby
-response = client.send_speech(uuid, text: 'Hello')
+response = client.talk.start(uuid, text: 'Hello')
 ```
 
 Docs: [https://developer.nexmo.com/api/voice#send-a-synthesized-speech-message-to-an-active-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#send-a-synthesized-speech-message-to-an-active-call)
@@ -158,7 +163,7 @@ Docs: [https://developer.nexmo.com/api/voice#send-a-synthesized-speech-message-t
 ### Stop sending a synthesized speech message to a call
 
 ```ruby
-response = client.stop_speech(uuid)
+response = client.talk.stop(uuid)
 ```
 
 Docs: [https://developer.nexmo.com/api/voice#stop-sending-a-synthesized-speech-message-to-an-active-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#stop-sending-a-synthesized-speech-message-to-an-active-call)
@@ -166,7 +171,7 @@ Docs: [https://developer.nexmo.com/api/voice#stop-sending-a-synthesized-speech-m
 ### Send DTMF tones to a call
 
 ```ruby
-response = client.send_dtmf(uuid, digits: '1234')
+response = client.dtmf.send(uuid, digits: '1234')
 ```
 
 Docs: [https://developer.nexmo.com/api/voice#send-dual-tone-multi-frequency-dtmf-tones-to-an-active-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#send-dual-tone-multi-frequency-dtmf-tones-to-an-active-call)
@@ -177,12 +182,12 @@ Docs: [https://developer.nexmo.com/api/voice#send-dual-tone-multi-frequency-dtmf
 ### Start a verification
 
 ```ruby
-response = client.start_verification(number: '441632960960', brand: 'MyApp')
+response = client.verify.request(number: '441632960960', brand: 'MyApp')
 
-if response['status'] == '0'
-  puts "Started verification request_id=#{response['request_id']}"
+if response.status == '0'
+  puts "Started verification request_id=#{response.request_id}"
 else
-  puts "Error: #{response['error_text']}"
+  puts "Error: #{response.error_text}"
 end
 ```
 
@@ -193,25 +198,25 @@ The response contains a verification request id which you will need to store tem
 ### Check a verification
 
 ```ruby
-response = client.check_verification('00e6c3377e5348cdaf567e1417c707a5', code: '1234')
+response = client.verify.check(request_id: '00e6c3377e5348cdaf567e1417c707a5', code: '1234')
 
-if response['status'] == '0'
-  puts "Verification complete, event_id=#{response['event_id']}"
+if response.status == '0'
+  puts "Verification complete, event_id=#{response.event_id}"
 else
-  puts "Error: #{response['error_text']}"
+  puts "Error: #{response.error_text}"
 end
 ```
 
 Docs: [https://developer.nexmo.com/api/verify#verify-check](https://developer.nexmo.com/api/verify?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#verify-check)
 
-The verification request id comes from the call to the start_verification method.
+The verification request id comes from the call to `client.verify.request`.
 
 The PIN code is entered into your application by the user.
 
 ### Cancel a verification
 
 ```ruby
-client.cancel_verification('00e6c3377e5348cdaf567e1417c707a5')
+client.verify.cancel('00e6c3377e5348cdaf567e1417c707a5')
 ```
 
 Docs: [https://developer.nexmo.com/api/verify#verify-control](https://developer.nexmo.com/api/verify?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#verify-control)
@@ -219,17 +224,18 @@ Docs: [https://developer.nexmo.com/api/verify#verify-control](https://developer.
 ### Trigger next verification step
 
 ```ruby
-client.trigger_next_verification_event('00e6c3377e5348cdaf567e1417c707a5')
+client.verify.trigger_next_event('00e6c3377e5348cdaf567e1417c707a5')
 ```
 
 Docs: [https://developer.nexmo.com/api/verify#verify-control](https://developer.nexmo.com/api/verify?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#verify-control)
 
+
 ## Number Insight API
 
 ### Basic Number Insight
 
 ```ruby
-client.get_basic_number_insight(number: '447700900000')
+client.number_insight.basic(number: '447700900000')
 ```
 
 Docs: [https://developer.nexmo.com/api/number-insight#request](https://developer.nexmo.com/api/number-insight?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#request)
@@ -237,7 +243,7 @@ Docs: [https://developer.nexmo.com/api/number-insight#request](https://developer
 ### Standard Number Insight
 
 ```ruby
-client.get_standard_number_insight(number: '447700900000')
+client.number_insight.standard(number: '447700900000')
 ```
 
 Docs: [https://developer.nexmo.com/api/number-insight#request](https://developer.nexmo.com/api/number-insight?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#request)
@@ -245,7 +251,7 @@ Docs: [https://developer.nexmo.com/api/number-insight#request](https://developer
 ### Advanced Number Insight
 
 ```ruby
-client.get_advanced_number_insight(number: '447700900000')
+client.number_insight.advanced(number: '447700900000')
 ```
 
 Docs: [https://developer.nexmo.com/api/number-insight#request](https://developer.nexmo.com/api/number-insight?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#request)
@@ -253,7 +259,7 @@ Docs: [https://developer.nexmo.com/api/number-insight#request](https://developer
 ### Advanced Number Insight Async
 
 ```ruby
-client.get_advanced_number_insight(number: '447700900000', callback: webhook_url)
+client.number_insight.advanced_async(number: '447700900000', callback: webhook_url)
 ```
 
 The results of the API call will be sent via HTTP POST to the webhook URL specified in the callback parameter.
@@ -266,7 +272,7 @@ Docs: [https://developer.nexmo.com/api/number-insight#request](https://developer
 ### Create an application
 
 ```ruby
-response = client.create_application(name: 'Example App', type: 'voice', answer_url: answer_url, event_url: event_url)
+response = client.applications.create(name: 'Example App', type: 'voice', answer_url: answer_url, event_url: event_url)
 ```
 
 Docs: [https://developer.nexmo.com/api/application#create-an-application](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#create-an-application)
@@ -274,7 +280,7 @@ Docs: [https://developer.nexmo.com/api/application#create-an-application](https:
 ### Retrieve a list of applications
 
 ```ruby
-response = client.get_applications
+response = client.applications.list
 ```
 
 Docs: [https://developer.nexmo.com/api/application#retrieve-your-applications](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#retrieve-your-applications)
@@ -282,7 +288,7 @@ Docs: [https://developer.nexmo.com/api/application#retrieve-your-applications](h
 ### Retrieve a single application
 
 ```ruby
-response = client.get_application(uuid)
+response = client.applications.get(uuid)
 ```
 
 Docs: [https://developer.nexmo.com/api/application#retrieve-an-application](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#retrieve-an-application)
@@ -290,7 +296,7 @@ Docs: [https://developer.nexmo.com/api/application#retrieve-an-application](http
 ### Update an application
 
 ```ruby
-response = client.update_application(uuid, answer_method: 'POST')
+response = client.applications.update(uuid, answer_method: 'POST')
 ```
 
 Docs: [https://developer.nexmo.com/api/application#update-an-application](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#update-an-application)
@@ -298,7 +304,7 @@ Docs: [https://developer.nexmo.com/api/application#update-an-application](https:
 ### Delete an application
 
 ```ruby
-response = client.delete_application(uuid)
+response = client.applications.delete(uuid)
 ```
 
 Docs: [https://developer.nexmo.com/api/application#destroy-an-application](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#destroy-an-application)
@@ -309,7 +315,7 @@ Docs: [https://developer.nexmo.com/api/application#destroy-an-application](https
 ### List owned numbers
 
 ```ruby
-client.get_account_numbers
+client.numbers.list
 ```
 
 Docs: [https://developer.nexmo.com/api/developer/numbers#list-owned-numbers](https://developer.nexmo.com/api/developer/numbers?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#list-owned-numbers)
@@ -317,7 +323,7 @@ Docs: [https://developer.nexmo.com/api/developer/numbers#list-owned-numbers](htt
 ### Search available numbers
 
 ```ruby
-client.get_available_numbers('GB')
+client.numbers.search(country: 'GB')
 ```
 
 Docs: [https://developer.nexmo.com/api/developer/numbers#search-available-numbers](https://developer.nexmo.com/api/developer/numbers?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#search-available-numbers)
@@ -325,7 +331,7 @@ Docs: [https://developer.nexmo.com/api/developer/numbers#search-available-number
 ### Buy a number
 
 ```ruby
-client.buy_number(country: 'GB', msisdn: '447700900000')
+client.numbers.buy(country: 'GB', msisdn: '447700900000')
 ```
 
 Docs: [https://developer.nexmo.com/api/developer/numbers#buy-a-number](https://developer.nexmo.com/api/developer/numbers?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#buy-a-number)
@@ -333,7 +339,7 @@ Docs: [https://developer.nexmo.com/api/developer/numbers#buy-a-number](https://d
 ### Cancel a number
 
 ```ruby
-client.cancel_number(country: 'GB', msisdn: '447700900000')
+client.numbers.cancel(country: 'GB', msisdn: '447700900000')
 ```
 
 Docs: [https://developer.nexmo.com/api/developer/numbers#cancel-a-number](https://developer.nexmo.com/api/developer/numbers?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#cancel-a-number)
@@ -341,7 +347,7 @@ Docs: [https://developer.nexmo.com/api/developer/numbers#cancel-a-number](https:
 ### Update a number
 
 ```ruby
-client.update_number(country: 'GB', msisdn: '447700900000', voiceCallbackType: 'app', voiceCallbackValue: application_id)
+client.numbers.update(country: 'GB', msisdn: '447700900000', voiceCallbackType: 'app', voiceCallbackValue: application_id)
 ```
 
 Docs: [https://developer.nexmo.com/api/developer/numbers#update-a-number](https://developer.nexmo.com/api/developer/numbers?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#update-a-number)
@@ -352,7 +358,7 @@ Docs: [https://developer.nexmo.com/api/developer/numbers#update-a-number](https:
 By default the library generates a short lived JWT per request.
 
 To generate a long lived JWT for multiple requests or to specify JWT claims
-directly call Nexmo::JWT.auth_token to generate a token, and set the auth_token
+directly call `Nexmo::JWT.generate` to generate a token, and set the auth_token
 attribute on the client object. For example:
 
 ```ruby
@@ -365,7 +371,7 @@ claims = {
 
 private_key = File.read('path/to/private.key')
 
-auth_token = Nexmo::JWT.auth_token(claims, private_key)
+auth_token = Nexmo::JWT.generate(claims, private_key)
 
 client.auth_token = auth_token
 ````
@@ -376,7 +382,7 @@ client.auth_token = auth_token
 ```ruby
 client = Nexmo::Client.new(signature_secret: 'secret')
 
-if client.check_signature(request.GET)
+if client.signature.check(request.GET)
   # valid signature
 else
   # invalid signature

data/lib/nexmo.rb

@@ -2,8 +2,28 @@ require 'nexmo/version'
 require 'nexmo/params'
 require 'nexmo/jwt'
 require 'nexmo/signature'
+require 'nexmo/user_agent'
+require 'nexmo/entity'
+require 'nexmo/keys'
 require 'nexmo/errors/error'
 require 'nexmo/errors/client_error'
 require 'nexmo/errors/server_error'
 require 'nexmo/errors/authentication_error'
+require 'nexmo/namespace'
 require 'nexmo/client'
+require 'nexmo/account'
+require 'nexmo/alerts'
+require 'nexmo/applications'
+require 'nexmo/call_dtmf'
+require 'nexmo/call_stream'
+require 'nexmo/call_talk'
+require 'nexmo/calls'
+require 'nexmo/conversions'
+require 'nexmo/files'
+require 'nexmo/messages'
+require 'nexmo/number_insight'
+require 'nexmo/numbers'
+require 'nexmo/pricing_types'
+require 'nexmo/pricing'
+require 'nexmo/sms'
+require 'nexmo/verify'

data/lib/nexmo/account.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Nexmo
+  class Account < Namespace
+    def balance
+      request('/account/get-balance')
+    end
+
+    def update(params)
+      request('/account/settings', params: params, type: Post)
+    end
+
+    def topup(params)
+      request('/account/top-up', params: params, type: Post)
+    end
+
+    private
+
+    def host
+      'rest.nexmo.com'
+    end
+  end
+end

data/lib/nexmo/alerts.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Nexmo
+  class Alerts < Namespace
+    def list
+      request('/sc/us/alert/opt-in/query/json')
+    end
+
+    def remove(params)
+      request('/sc/us/alert/opt-in/manage/json', params: params, type: Post)
+    end
+
+    alias_method :resubscribe, :remove
+
+    def send(params)
+      request('/sc/us/alert/json', params: params, type: Post)
+    end
+
+    private
+
+    def host
+      'rest.nexmo.com'
+    end
+  end
+end

data/lib/nexmo/applications.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Nexmo
+  class Applications < Namespace
+    def create(params)
+      request('/v1/applications', params: params, type: Post)
+    end
+
+    def list(params = nil)
+      request('/v1/applications', params: params)
+    end
+
+    def get(id)
+      request('/v1/applications/' + id)
+    end
+
+    def update(id, params)
+      request('/v1/applications/' + id, params: params, type: Put)
+    end
+
+    def delete(id)
+      request('/v1/applications/' + id, type: Delete)
+    end
+  end
+end

data/lib/nexmo/call_dtmf.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Nexmo
+  class CallDTMF < Namespace
+    def send(id, params)
+      request('/v1/calls/' + id + '/dtmf', params: params, type: Put)
+    end
+
+    private
+
+    def authorization_header?
+      true
+    end
+  end
+end