nexmo 5.3.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9af851979d214537f3ff6b20fa11f051b848d05b0a5d8fee7a7691f6b3e708d8
-  data.tar.gz: cdf846e2d27f25daf2e911107c4b4e5e0f351a2d561b3c8522798a0a716f96e8
+  metadata.gz: acbd01437020690fe8cfd847124290e384ea7ad151f373aafb7cb043197941a7
+  data.tar.gz: a12a717b8dacd66dc993c237120a1a54dee43305fdf6f5ed93565eb4d4a6a517
 SHA512:
-  metadata.gz: 546a5945d546ab3382ef76f3c91543aaec2fb26f98ac361ce58be747b47ec8b8c83f3ad4ed20722ba50fa85a70bcaf05f25545437735b9830711e59f430ae812
-  data.tar.gz: 83fcd3552be7a52eebf7a9fbbb034b74cde86fa9a112d53325b43784311140ab25acebeae3029734c4e71ddd97dbde69ad8a0ca645eb6985434468776a90d1d1
+  metadata.gz: 5a6540019a076be34194d8185b77417155cd00bc295fbc6983f7b6b58cd9b7ae68a0abad6001f4af202afbaeb5e94296b17558f31461508dd9f33ff5647f040e
+  data.tar.gz: 761584429c830e57c493f78292fe17842c4a327305b480144e91bbe2cbb263e27f7d1394e876a9d4552822dcb84f22ff38e4317c2f74e47d35639a65adec551b

data/README.md

@@ -14,6 +14,7 @@ need a Nexmo account. Sign up [for free at nexmo.com][signup].
 * [Number Insight API](#number-insight-api)
 * [Application API](#application-api)
 * [Numbers API](#numbers-api)
+* [Secret Management API](#secret-management-api)
 * [Redact API](#redact-api)
 * [Logging](#logging)
 * [JWT authentication](#jwt-authentication)
@@ -86,7 +87,7 @@ of source control, or in some kind of key management infrastructure.
 
 ## SMS API
 
-### Send a text message
+### Send an SMS
 
 ```ruby
 response = client.sms.send(from: 'Ruby', to: 'YOUR NUMBER', text: 'Hello world')
@@ -98,12 +99,12 @@ else
 end
 ```
 
-Docs: [https://developer.nexmo.com/api/sms#request](https://developer.nexmo.com/api/sms?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#request)
+Docs: [https://developer.nexmo.com/api/sms#send-an-sms](https://developer.nexmo.com/api/sms?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#send-an-sms)
 
 
 ## Voice API
 
-### Make a call
+### Create an outbound call
 
 ```ruby
 response = client.calls.create({
@@ -113,33 +114,33 @@ response = client.calls.create({
 })
 ```
 
-Docs: [https://developer.nexmo.com/api/voice#create-an-outbound-call](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#create-an-outbound-call)
+Docs: [https://developer.nexmo.com/api/voice#createCall](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#createCall)
 
-### Retrieve a list of calls
+### Get details of your calls
 
 ```ruby
 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)
+Docs: [https://developer.nexmo.com/api/voice#getCalls](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#getCalls)
 
-### Retrieve a single call
+### Get detail of a specific call
 
 ```ruby
 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)
+Docs: [https://developer.nexmo.com/api/voice#getCall](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#getCall)
 
-### Update a call
+### Modify an in progress call
 
 ```ruby
 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)
+Docs: [https://developer.nexmo.com/api/voice#updateCall](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#updateCall)
 
-### Stream audio to a call
+### Play an audio file into a call
 
 ```ruby
 stream_url = 'https://nexmo-community.github.io/ncco-examples/assets/voice_api_audio_streaming.mp3'
@@ -147,39 +148,39 @@ stream_url = 'https://nexmo-community.github.io/ncco-examples/assets/voice_api_a
 response = client.calls.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)
+Docs: [https://developer.nexmo.com/api/voice#startStream](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#startStream)
 
-### Stop streaming audio to a call
+### Stop playing an audio file into a call
 
 ```ruby
 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)
+Docs: [https://developer.nexmo.com/api/voice#stopStream](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#stopStream)
 
-### Send a synthesized speech message to a call
+### Play text to speech into a call
 
 ```ruby
 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)
+Docs: [https://developer.nexmo.com/api/voice#startTalk](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#startTalk)
 
-### Stop sending a synthesized speech message to a call
+### Stop text to speech in a call
 
 ```ruby
 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)
+Docs: [https://developer.nexmo.com/api/voice#stopTalk](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#stopTalk)
 
-### Send DTMF tones to a call
+### Play DTMF tones into a call
 
 ```ruby
 response = client.calls.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)
+Docs: [https://developer.nexmo.com/api/voice#startDTMF](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#startDTMF)
 
 
 ## Verify API
@@ -358,6 +359,41 @@ client.numbers.update(country: 'GB', msisdn: '447700900000', voice_callback_type
 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)
 
 
+## Secret Management API
+
+### Retrieve a list of secrets
+
+```ruby
+client.secrets.list
+```
+
+Docs: [https://developer.nexmo.com/api/account/secret-management#retrieveSecrets](https://developer.nexmo.com/api/account/secret-management?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#retrieveSecrets)
+
+### Create a secret
+
+```ruby
+client.secrets.create(secret: 't0ps3cr3t')
+```
+
+Docs: [https://developer.nexmo.com/api/account/secret-management#createSecret](https://developer.nexmo.com/api/account/secret-management?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#createSecret)
+
+### Retrieve a secret
+
+```ruby
+client.secrets.get(secret_id)
+```
+
+Docs: [https://developer.nexmo.com/api/account/secret-management#retrieveSecret](https://developer.nexmo.com/api/account/secret-management?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#retrieveSecret)
+
+### Revoke a secret
+
+```ruby
+client.secrets.revoke(secret_id)
+```
+
+Docs: [https://developer.nexmo.com/api/account/secret-management#revokeSecret](https://developer.nexmo.com/api/account/secret-management?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#revokeSecret)
+
+
 ## Redact API
 
 ### Redact a specific message

data/lib/nexmo.rb

@@ -12,10 +12,11 @@ require 'nexmo/errors/client_error'
 require 'nexmo/errors/server_error'
 require 'nexmo/errors/authentication_error'
 require 'nexmo/authentication/abstract'
+require 'nexmo/authentication/basic'
 require 'nexmo/authentication/bearer_token'
 require 'nexmo/authentication/key_secret_params'
 require 'nexmo/authentication/key_secret_query'
-require 'nexmo/key_value_logger'
+require 'nexmo/logger'
 require 'nexmo/namespace'
 require 'nexmo/client'
 require 'nexmo/account'
@@ -33,5 +34,6 @@ require 'nexmo/numbers'
 require 'nexmo/pricing_types'
 require 'nexmo/pricing'
 require 'nexmo/redact'
+require 'nexmo/secrets'
 require 'nexmo/sms'
 require 'nexmo/verify'

data/lib/nexmo/authentication/basic.rb

@@ -0,0 +1,9 @@
+module Nexmo
+  class Basic < AbstractAuthentication
+    def update(object)
+      return unless object.is_a?(Net::HTTPRequest)
+
+      object.basic_auth(@client.api_key, @client.api_secret)
+    end
+  end
+end

data/lib/nexmo/client.rb

@@ -33,7 +33,7 @@ module Nexmo
     end
 
     def logger=(logger)
-      @logger = Nexmo::KeyValueLogger.new(logger)
+      @logger = Logger.new(logger)
     end
 
     def token
@@ -149,6 +149,10 @@ module Nexmo
       @redact ||= Redact.new(self)
     end
 
+    def secrets
+      @secrets ||= Secrets.new(self)
+    end
+
     def sms
       @sms ||= SMS.new(self)
     end

data/lib/nexmo/logger.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+require 'logger'
+require 'forwardable'
+
+module Nexmo
+  class Logger
+    def initialize(logger)
+      @logger = logger || ::Logger.new(nil)
+    end
+
+    extend Forwardable
+
+    ::Logger::Severity.constants.map(&:downcase).each do |name|
+      def_delegator :@logger, name, name
+    end
+
+    def log_request_info(request)
+      info do
+        format('Nexmo API request', {
+          method: request.method,
+          path: request.uri.path
+        })
+      end
+    end
+
+    def log_response_info(response, host)
+      info do
+        format('Nexmo API response', {
+          host: host,
+          status: response.code,
+          type: response.content_type,
+          length: response.content_length,
+          trace_id: response['x-nexmo-trace-id']
+        })
+      end
+    end
+
+    private
+
+    def format(message, hash)
+      return message if hash.nil?
+
+      fields = hash.map { |key, value| "#{key}=#{value}" if value }.compact
+      fields.unshift(message)
+      fields.join(' ')
+    end
+  end
+end

data/lib/nexmo/namespace.rb

@@ -7,6 +7,8 @@ module Nexmo
     def initialize(client)
       @client = client
 
+      @logger = client.logger
+
       @host = self.class.host
 
       @http = Net::HTTP.new(@host, Net::HTTP.https_default_port)
@@ -44,10 +46,6 @@ module Nexmo
     Post = Net::HTTP::Post
     Delete = Net::HTTP::Delete
 
-    def logger
-      @client.logger
-    end
-
     def request(path, params: nil, type: Get, &block)
       uri = URI('https://' + @host + path)
 
@@ -62,7 +60,7 @@ module Nexmo
 
       authentication.update(uri)
 
-      message = type.new(uri.request_uri)
+      message = type.new(uri)
 
       message['User-Agent'] = @client.user_agent
 
@@ -70,15 +68,15 @@ module Nexmo
 
       self.class.request_body.update(message, params) if type::REQUEST_HAS_BODY
 
-      logger.info('Nexmo API request', method: message.method, path: uri.path)
+      @logger.log_request_info(message)
 
       response = @http.request(message, &block)
 
-      log_response_info(response)
+      @logger.log_response_info(response, @host)
 
       return if block
 
-      logger.debug(response.body)
+      @logger.debug(response.body) if response.body
 
       parse(response)
     end
@@ -103,14 +101,5 @@ module Nexmo
         raise Error
       end
     end
-
-    def log_response_info(response)
-      logger.info('Nexmo API response',
-        host: @host,
-        status: response.code,
-        type: response.content_type,
-        length: response.content_length,
-        trace_id: response['x-nexmo-trace-id'])
-    end
   end
 end

data/lib/nexmo/secrets.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Nexmo
+  class Secrets < Namespace
+    self.authentication = Basic
+
+    self.request_body = JSON
+
+    def create(params)
+      request('/accounts/' + account_id + '/secrets', params: params, type: Post)
+    end
+
+    def list
+      request('/accounts/' + account_id + '/secrets')
+    end
+
+    def get(secret_id)
+      request('/accounts/' + account_id + '/secrets/' + secret_id)
+    end
+
+    def revoke(secret_id)
+      request('/accounts/' + account_id + '/secrets/' + secret_id, type: Delete)
+    end
+
+    private
+
+    def account_id
+      @client.api_key
+    end
+  end
+end

data/lib/nexmo/version.rb

@@ -1,3 +1,3 @@
 module Nexmo
-  VERSION = '5.3.0'
+  VERSION = '5.4.0'
 end

data/nexmo.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |s|
   s.version = Nexmo::VERSION
   s.license = 'MIT'
   s.platform = Gem::Platform::RUBY
-  s.authors = ['Tim Craft']
-  s.email = ['mail@timcraft.com']
+  s.authors = ['Nexmo']
+  s.email = ['devrel@nexmo.com']
   s.homepage = 'https://github.com/Nexmo/nexmo-ruby'
   s.description = 'Nexmo Client Library for Ruby'
   s.summary = 'This is the Ruby client library for Nexmo\'s API. To use it you\'ll need a Nexmo account. Sign up for free at https://www.nexmo.com'
@@ -17,4 +17,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency('minitest', '~> 5.0')
   s.add_development_dependency('webmock', '~> 3.0')
   s.require_path = 'lib'
+  s.metadata = {
+    'homepage' => 'https://github.com/Nexmo/nexmo-ruby',
+    'source_code_uri' => 'https://github.com/Nexmo/nexmo-ruby',
+    'bug_tracker_uri' => 'https://github.com/Nexmo/nexmo-ruby/issues',
+    'changelog_uri' => 'https://github.com/Nexmo/nexmo-ruby/blob/master/CHANGES.md'
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.4.0
 platform: ruby
 authors:
-- Tim Craft
+- Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-01 00:00:00.000000000 Z
+date: 2018-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -68,7 +68,7 @@ dependencies:
         version: '3.0'
 description: Nexmo Client Library for Ruby
 email:
-- mail@timcraft.com
+- devrel@nexmo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -80,6 +80,7 @@ files:
 - lib/nexmo/alerts.rb
 - lib/nexmo/applications.rb
 - lib/nexmo/authentication/abstract.rb
+- lib/nexmo/authentication/basic.rb
 - lib/nexmo/authentication/bearer_token.rb
 - lib/nexmo/authentication/key_secret_params.rb
 - lib/nexmo/authentication/key_secret_query.rb
@@ -98,8 +99,8 @@ files:
 - lib/nexmo/form_data.rb
 - lib/nexmo/json.rb
 - lib/nexmo/jwt.rb
-- lib/nexmo/key_value_logger.rb
 - lib/nexmo/keys.rb
+- lib/nexmo/logger.rb
 - lib/nexmo/messages.rb
 - lib/nexmo/namespace.rb
 - lib/nexmo/number_insight.rb
@@ -108,6 +109,7 @@ files:
 - lib/nexmo/pricing.rb
 - lib/nexmo/pricing_types.rb
 - lib/nexmo/redact.rb
+- lib/nexmo/secrets.rb
 - lib/nexmo/signature.rb
 - lib/nexmo/sms.rb
 - lib/nexmo/user_agent.rb
@@ -117,7 +119,11 @@ files:
 homepage: https://github.com/Nexmo/nexmo-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage: https://github.com/Nexmo/nexmo-ruby
+  source_code_uri: https://github.com/Nexmo/nexmo-ruby
+  bug_tracker_uri: https://github.com/Nexmo/nexmo-ruby/issues
+  changelog_uri: https://github.com/Nexmo/nexmo-ruby/blob/master/CHANGES.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/nexmo/key_value_logger.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Nexmo
-  class KeyValueLogger
-    def initialize(logger)
-      @logger = logger
-    end
-
-    def debug(message, data = nil)
-      @logger.debug(format(message, data)) if @logger
-    end
-
-    def info(message, data = nil)
-      @logger.info(format(message, data)) if @logger
-    end
-
-    def warning(message, data = nil)
-      @logger.warning(format(message, data)) if @logger
-    end
-
-    def error(message, data = nil)
-      @logger.error(format(message, data)) if @logger
-    end
-
-    private
-
-    def format(message, hash)
-      return message if hash.nil?
-
-      fields = hash.map { |key, value| "#{key}=#{value}" if value }.compact
-      fields.unshift(message)
-      fields.join(' ')
-    end
-  end
-end