nexmo 5.1.1 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9bdcde474d49648996ce5b59a24d2d1981029fa
-  data.tar.gz: fe2b945057edcd94f9c5a5f4e80810be7b0ea83f
+  metadata.gz: a75b2e071168d3e90be330542e75ef9ec3169f45
+  data.tar.gz: ee5a64fa8f7249c8d07664fd8edec0165e722c8b
 SHA512:
-  metadata.gz: fa5f958c908fc21cde8241b940548651eb2ad23fd0cb25fcf6f066b04c6ea66872a71456ea710842cd1ea9257dceaf91c2e7d3ddcb8ad785049c6a5ff26938ae
-  data.tar.gz: 735283fe44d2e12c5b0052284bca8a520f7c15dc0bfcc28b245927dc4d06817bcb84edcb3701ba8597ae8ec3ee706b564ee795c49b9096701d93015456b7bd9b
+  metadata.gz: ddf564d5563ef4f9f29603c2932ed50bc336efdc4526fdf169ba4c2dcf4b569d5a7a27df77ce0064b6e4b5d6c45266d6eac815e770aba8f200b3794cc21b4753
+  data.tar.gz: 72cbc7f778f491e88fd1991afb66932fb40efd4eddb1215ddcfcf3fe48c677a9dba5871bb89ce0681c52e6340308c822cca5cad3bb219dd22edf33017c90dc17

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)
+* [Redact API](#redact-api)
 * [Logging](#logging)
 * [JWT authentication](#jwt-authentication)
 * [Webhook signatures](#webhook-signatures)
@@ -357,6 +358,17 @@ 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)
 
 
+## Redact API
+
+### Redact a specific message
+
+```ruby
+client.redact.transaction(id: '00A0B0C0', product: 'sms')
+```
+
+Docs: [https://developer.nexmo.com/api/redact#transaction](https://developer.nexmo.com/api/redact?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#transaction)
+
+
 ## Logging
 
 Use the logger option or attribute writer method to specify a logger. For example:

data/lib/nexmo.rb

@@ -9,6 +9,10 @@ require 'nexmo/errors/error'
 require 'nexmo/errors/client_error'
 require 'nexmo/errors/server_error'
 require 'nexmo/errors/authentication_error'
+require 'nexmo/authentication/abstract'
+require 'nexmo/authentication/bearer_token'
+require 'nexmo/authentication/key_secret_params'
+require 'nexmo/authentication/key_secret_query'
 require 'nexmo/key_value_logger'
 require 'nexmo/namespace'
 require 'nexmo/client'
@@ -26,5 +30,6 @@ require 'nexmo/number_insight'
 require 'nexmo/numbers'
 require 'nexmo/pricing_types'
 require 'nexmo/pricing'
+require 'nexmo/redact'
 require 'nexmo/sms'
 require 'nexmo/verify'

data/lib/nexmo/authentication/abstract.rb

@@ -0,0 +1,7 @@
+module Nexmo
+  class AbstractAuthentication
+    def initialize(client)
+      @client = client
+    end
+  end
+end

data/lib/nexmo/authentication/bearer_token.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Nexmo
+  class BearerToken < AbstractAuthentication
+    def update(object)
+      return unless object.is_a?(Net::HTTPRequest)
+
+      object['Authorization'] = @client.authorization
+    end
+  end
+end

data/lib/nexmo/authentication/key_secret_params.rb

@@ -0,0 +1,10 @@
+module Nexmo
+  class KeySecretParams < AbstractAuthentication
+    def update(object)
+      return unless object.is_a?(Hash)
+
+      object[:api_key] = @client.api_key
+      object[:api_secret] = @client.api_secret
+    end
+  end
+end

data/lib/nexmo/authentication/key_secret_query.rb

@@ -0,0 +1,18 @@
+module Nexmo
+  class KeySecretQuery < AbstractAuthentication
+    def update(object)
+      return unless object.is_a?(URI)
+
+      object.query = Params.join(object.query, params)
+    end
+
+    private
+
+    def params
+      {
+        api_key: @client.api_key,
+        api_secret: @client.api_secret
+      }
+    end
+  end
+end

data/lib/nexmo/call_dtmf.rb

@@ -8,8 +8,8 @@ module Nexmo
 
     private
 
-    def authorization_header?
-      true
+    def authentication
+      @authentication ||= BearerToken.new(@client)
     end
 
     def json_body?

data/lib/nexmo/call_stream.rb

@@ -12,8 +12,8 @@ module Nexmo
 
     private
 
-    def authorization_header?
-      true
+    def authentication
+      @authentication ||= BearerToken.new(@client)
     end
 
     def json_body?

data/lib/nexmo/call_talk.rb

@@ -12,8 +12,8 @@ module Nexmo
 
     private
 
-    def authorization_header?
-      true
+    def authentication
+      @authentication ||= BearerToken.new(@client)
     end
 
     def json_body?

data/lib/nexmo/calls.rb

@@ -61,8 +61,8 @@ module Nexmo
 
     private
 
-    def authorization_header?
-      true
+    def authentication
+      @authentication ||= BearerToken.new(@client)
     end
 
     def json_body?

data/lib/nexmo/client.rb

@@ -139,6 +139,10 @@ module Nexmo
       @pricing ||= PricingTypes.new(self)
     end
 
+    def redact
+      @redact ||= Redact.new(self)
+    end
+
     def sms
       @sms ||= SMS.new(self)
     end

data/lib/nexmo/files.rb

@@ -18,8 +18,8 @@ module Nexmo
 
     private
 
-    def authorization_header?
-      true
+    def authentication
+      @authentication ||= BearerToken.new(@client)
     end
   end
 end

data/lib/nexmo/namespace.rb

@@ -21,8 +21,8 @@ module Nexmo
       'api.nexmo.com'
     end
 
-    def authorization_header?
-      false
+    def authentication
+      @authentication ||= KeySecretParams.new(@client)
     end
 
     def json_body?
@@ -36,20 +36,22 @@ module Nexmo
     def request(path, params: nil, type: Get, &block)
       uri = URI('https://' + host + path)
 
-      unless authorization_header?
-        params ||= {}
-        params[:api_key] = @client.api_key
-        params[:api_secret] = @client.api_secret
-      end
+      params ||= {}
+
+      authentication.update(params)
 
-      unless type::REQUEST_HAS_BODY || params.nil? || params.empty?
+      unless type::REQUEST_HAS_BODY || params.empty?
         uri.query = Params.encode(params)
       end
 
+      authentication.update(uri)
+
       message = type.new(uri.request_uri)
-      message['Authorization'] = @client.authorization if authorization_header?
+
       message['User-Agent'] = @client.user_agent
 
+      authentication.update(message)
+
       encode_body(params, message) if type::REQUEST_HAS_BODY
 
       logger.info('Nexmo API request', method: message.method, path: uri.path)

data/lib/nexmo/params.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cgi'
 
 module Nexmo
@@ -6,6 +7,14 @@ module Nexmo
       params.flat_map { |k, vs| Array(vs).map { |v| "#{escape(k)}=#{escape(v)}" } }.join('&')
     end
 
+    def self.join(string, params)
+      encoded = encode(params)
+
+      return encoded if string.nil?
+
+      string + '&' + encoded
+    end
+
     private
 
     def self.escape(component)

data/lib/nexmo/redact.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Nexmo
+  class Redact < Namespace
+    def transaction(params)
+      request('/v1/redact/transaction', params: params, type: Post)
+    end
+
+    private
+
+    def authentication
+      @authentication ||= KeySecretQuery.new(@client)
+    end
+
+    def json_body?
+      true
+    end
+  end
+end

data/lib/nexmo/version.rb

@@ -1,3 +1,3 @@
 module Nexmo
-  VERSION = '5.1.1'
+  VERSION = '5.2.0'
 end

data/nexmo.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.files = Dir.glob('{lib,spec}/**/*') + %w(LICENSE.txt README.md nexmo.gemspec)
   s.required_ruby_version = '>= 2.0.0'
   s.add_dependency('jwt')
-  s.add_development_dependency('rake')
+  s.add_development_dependency('rake', '~> 12.0')
   s.add_development_dependency('minitest', '~> 5.0')
   s.add_development_dependency('webmock', '~> 3.0')
   s.require_path = 'lib'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 5.2.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-17 00:00:00.000000000 Z
+date: 2018-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +79,10 @@ files:
 - lib/nexmo/account.rb
 - lib/nexmo/alerts.rb
 - lib/nexmo/applications.rb
+- lib/nexmo/authentication/abstract.rb
+- lib/nexmo/authentication/bearer_token.rb
+- lib/nexmo/authentication/key_secret_params.rb
+- lib/nexmo/authentication/key_secret_query.rb
 - lib/nexmo/call_dtmf.rb
 - lib/nexmo/call_stream.rb
 - lib/nexmo/call_talk.rb
@@ -101,6 +105,7 @@ files:
 - lib/nexmo/params.rb
 - lib/nexmo/pricing.rb
 - lib/nexmo/pricing_types.rb
+- lib/nexmo/redact.rb
 - lib/nexmo/signature.rb
 - lib/nexmo/sms.rb
 - lib/nexmo/user_agent.rb