nexmo 5.5.0 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7339e40c57dc348e205411f04ffdb1d5f96bd0bb41fd481a4781c6a91b9c06c0
-  data.tar.gz: cb033f687f94529c18faf2b9bee41f7e9383fdc7954e9cf38f3cf15642d1bbeb
+  metadata.gz: dcef65e09c820aa2be62979694389d22332b6950ac9032e83aeacc1b9a3b09ec
+  data.tar.gz: 736e0c49c1c24d7fa76876b92a9cd1eef5ea0fa2dbe8137b8f5b8f6e5424df8a
 SHA512:
-  metadata.gz: bbddc5433b0356fc806c999dbfc1185b5e5d90989cb1e1742812713e0624d3b7ed07fb21e333c55d0c774e44aec42e00c7bcc3e15f1b5079b4e3b1f626441c57
-  data.tar.gz: c56b00b6a05d095268289cb2238ee4d38f05b8da67f2d4c0d839f4ae89f09462fd44138b9e880187e75b01dbd356ed74dfad5038aefcf7588f93776a1ff408b5
+  metadata.gz: b8e63854abd113d5670356a17d82ac7264c5f7b3e41d1db43252091200c05d574a2e4c48e29e487d4a5a8eb8f85e27968d1f65e037f83bc6dbf4f42944f5a667
+  data.tar.gz: 504269980fdcfa37612957e6d6d514a8adf8c7471ba3b6f3407b54ff54d4cd05ec4226875fecae5e341df5d7372836e9484b50c898ec5a73412eac02d02b9133

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2018 Nexmo Inc
+Copyright (c) 2016-2019 Nexmo Inc
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -9,6 +9,7 @@ need a Nexmo account. Sign up [for free at nexmo.com][signup].
 * [Installation](#installation)
 * [Usage](#usage)
 * [SMS API](#sms-api)
+* [2FA API](#2fa-api)
 * [Voice API](#voice-api)
 * [Verify API](#verify-api)
 * [Number Insight API](#number-insight-api)
@@ -102,6 +103,23 @@ end
 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)
 
 
+## 2FA API
+
+### Send a 2FA Token
+
+```ruby
+response = client.tfa.send(to: 'YOUR NUMBER', pin: '12345')
+
+if response.messages.first.status == '0'
+  puts "Sent message id=#{response.messages.first.message_id}"
+else
+  puts "Error: #{response.messages.first.error_text}"
+end
+```
+
+Docs: [https://developer.nexmo.com/api/sms/us-short-codes/2fa](https://developer.nexmo.com/api/sms/us-short-codes/2fa?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+
+
 ## Voice API
 
 ### Create an outbound call

data/lib/nexmo.rb

@@ -6,8 +6,8 @@ require 'nexmo/json'
 require 'nexmo/jwt'
 require 'nexmo/signature'
 require 'nexmo/user_agent'
-require 'nexmo/entity'
 require 'nexmo/keys'
+require 'nexmo/entity'
 require 'nexmo/problem'
 require 'nexmo/errors/error'
 require 'nexmo/errors/client_error'
@@ -38,4 +38,5 @@ require 'nexmo/pricing'
 require 'nexmo/redact'
 require 'nexmo/secrets'
 require 'nexmo/sms'
+require 'nexmo/tfa'
 require 'nexmo/verify'

data/lib/nexmo/client.rb

@@ -165,6 +165,10 @@ module Nexmo
       @sms ||= SMS.new(self)
     end
 
+    def tfa
+      @tfa ||= TFA.new(self)
+    end
+
     def verify
       @verify ||= Verify.new(self)
     end

data/lib/nexmo/entity.rb

@@ -1,13 +1,13 @@
 module Nexmo
   class Entity
+    include Keys
+
     def initialize(**kwargs)
       @attributes = kwargs
     end
 
     def []=(key, value)
-      name = self.class.attribute_names[key]
-
-      @attributes[name] = value
+      @attributes[attribute_key(key)] = value
     end
 
     def respond_to_missing?(name, include_private = false)
@@ -31,23 +31,5 @@ module Nexmo
     attr_reader :attributes
 
     protected :attributes
-
-    private
-
-    def self.attribute_names
-      @attribute_names ||= Hash.new do |hash, key|
-        hash[key] = attribute_name(key)
-      end
-    end
-
-    def self.attribute_name(key)
-      return key if key.is_a?(Symbol)
-
-      key.split(PATTERN).join(UNDERSCORE).downcase.to_sym
-    end
-
-    PATTERN = /[\-_]|(?<=\w)(?=[A-Z])/
-
-    UNDERSCORE = '_'
   end
 end

data/lib/nexmo/keys.rb

@@ -27,5 +27,19 @@ module Nexmo
     def camelcase_key(k)
       k.to_s.gsub(/_(\w)/) { $1.upcase }
     end
+
+    ATTRIBUTE_KEYS = Hash.new { |h, k| h[k] = k.split(PATTERN).join('_').downcase.to_sym }
+
+    PATTERN = /[\-_]|(?<=\w)(?=[A-Z])/
+
+    private_constant :ATTRIBUTE_KEYS
+
+    private_constant :PATTERN
+
+    def attribute_key(k)
+      return k if k.is_a?(Symbol)
+
+      ATTRIBUTE_KEYS[k]
+    end
   end
 end

data/lib/nexmo/params.rb

@@ -15,10 +15,10 @@ module Nexmo
       string + '&' + encoded
     end
 
-    private
-
     def self.escape(component)
       CGI.escape(component.to_s)
     end
+
+    private_class_method :escape
   end
 end

data/lib/nexmo/signature.rb

@@ -19,8 +19,6 @@ module Nexmo
       self.class.check(params, @client.signature_secret)
     end
 
-    private
-
     def self.digest(params, secret)
       md5 = Digest::MD5.new
 
@@ -32,5 +30,7 @@ module Nexmo
 
       md5.hexdigest
     end
+
+    private_class_method :digest
   end
 end

data/lib/nexmo/tfa.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Nexmo
+  class TFA < Namespace
+    include Keys
+
+    self.host = 'rest.nexmo.com'
+
+    def send(params)
+      request('/sc/us/2fa/json', params: hyphenate(params), type: Post)
+    end
+  end
+end

data/lib/nexmo/version.rb

@@ -1,3 +1,3 @@
 module Nexmo
-  VERSION = '5.5.0'
+  VERSION = '5.6.0'
 end

data/nexmo.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rake', '~> 12.0')
   s.add_development_dependency('minitest', '~> 5.0')
   s.add_development_dependency('webmock', '~> 3.0')
+  s.add_development_dependency('simplecov', '~> 0.16')
   s.require_path = 'lib'
   s.metadata = {
     'homepage' => 'https://github.com/Nexmo/nexmo-ruby',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo
 version: !ruby/object:Gem::Version
-  version: 5.5.0
+  version: 5.6.0
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-03 00:00:00.000000000 Z
+date: 2019-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 description: Nexmo Client Library for Ruby
 email:
 - devrel@nexmo.com
@@ -114,6 +128,7 @@ files:
 - lib/nexmo/secrets.rb
 - lib/nexmo/signature.rb
 - lib/nexmo/sms.rb
+- lib/nexmo/tfa.rb
 - lib/nexmo/user_agent.rb
 - lib/nexmo/verify.rb
 - lib/nexmo/version.rb
@@ -141,8 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: This is the Ruby client library for Nexmo's API. To use it you'll need a