bandwidth-sdk 5.0.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc4d4b047d53e1e8c3f34b37696455d916a753aa3566dad6d6fb666fc2b3fa61
-  data.tar.gz: b5cdf37c09788e890f36ef3c78ccf41f0ba18a69291f1424be7f798f207881f9
+  metadata.gz: b67b83b111ec3185ce0614d96b9f46ea31270db7e0b44a069cc8d87e16bf2bd5
+  data.tar.gz: b4c1575cda3afab5b3a17ccf70883ddd68815ec9e3e55c162d778cc7667dd8ad
 SHA512:
-  metadata.gz: 59761140cdddf9f6cda37d7aeeaeff6341a5c0bcc357cf577ae29e8fff0a6cf347f1070536f99db3b2f3f6baae3c2b93edbefb2e94468036c57ffd7a65c279b0
-  data.tar.gz: bdf68653a8640403d2bc5402c9f5af06055079640ab9229b16ac12cf48290ccffbe2ac38e40c11c3e6b518b1ebaad05344779249d0f79c940d32c3a57b36f5ed
+  metadata.gz: 7de5c586dc71cc06134c42008931b6508e5fca4a7baecd02dd94b5d9c5d1e26f10c6266c020ef6c91429a0e50e10678a32803e07c2af30e74833fe0a55ea7f65
+  data.tar.gz: 61b41ff9f216fee03ff287270a13666575006b870ecdc38c9edf8b4de93e7db0a4d45d37becf2b11bd52cfba399058739b3e9bea48d086d71d01983ef2da28f7

data/README.md

@@ -1,16 +1,14 @@
 # Bandwidth Ruby SDK
-  
-Bandwidth's API docs can be found at https://dev.bandwidth.com
 
-Ruby specific docs can be found at https://dev.bandwidth.com/sdks/ruby.html
+## Getting Started
 
-## Download & Install
+### Installation
 
 ```
 gem install bandwidth-sdk
 ```
 
-## Initialize Bandwidth Client
+### Initialize
 
 ```ruby
 require 'bandwidth'
@@ -18,21 +16,27 @@ require 'bandwidth'
 include Bandwidth
 include Bandwidth::Voice
 include Bandwidth::Messaging
+include Bandwidth::WebRtc
+include Bandwidth::TwoFactorAuth
 
 bandwidth_client = Bandwidth::Client.new(
     voice_basic_auth_user_name: 'username',
     voice_basic_auth_password: 'password',
-    messaging_basic_auth_user_name: 'token',
-    messaging_basic_auth_password: 'secret',
+    messaging_basic_auth_user_name: 'username',
+    messaging_basic_auth_password: 'username',
+    two_factor_auth_basic_auth_user_name: 'username',
+    two_factor_auth_basic_auth_password: 'password',
+    web_rtc_basic_auth_user_name: 'username',
+    web_rtc_basic_auth_password: 'password'
 )
+account_id = "12345"
 ```
 
-## Create Phone Call
+### Create Phone Call
 
 ```ruby
 voice_client = bandwidth_client.voice_client.client
 
-account_id = '1'
 body = ApiCreateCallRequest.new
 body.from = '+16666666666'
 body.to = '+17777777777'
@@ -49,7 +53,7 @@ rescue Bandwidth::ErrorResponseException => e
 end
 ```
 
-## Generate BXML
+### Generate BXML
 
 ```ruby
 response = Bandwidth::Voice::Response.new()
@@ -59,12 +63,11 @@ response.push(hangup)
 puts response.to_bxml()
 ```
 
-## Send Text Message
+### Send Text Message
 
 ```ruby
 messaging_client = bandwidth_client.messaging_client.client
 
-account_id = '1'
 body = MessageRequest.new
 body.application_id = '1-2-3'
 body.to = ['+17777777777']
@@ -72,7 +75,7 @@ body.from = '+18888888888'
 body.text = 'Hello from Bandwidth'
 
 begin
-    response = messaging_client.create_message(account_id, :body => body)
+    response = messaging_client.create_message(account_id, body)
     puts response.data.id #1570740275373xbn7mbhsfewasdr
     puts response.status_code #202
 rescue Bandwidth::GenericClientException => e
@@ -83,3 +86,77 @@ rescue Bandwidth::PathClientException => e
     puts e.response_code #400
 end
 ```
+
+### Create A MFA Request
+
+```ruby
+auth_client = bandwidth_client.two_factor_auth_client.mfa
+
+from_phone = "+18888888888"
+to_phone = "+17777777777"
+messaging_application_id = "1-d-b"
+scope = "scope"
+digits = 6
+
+body = TwoFactorCodeRequestSchema.new
+body.from = from_phone
+body.to = to_phone
+body.application_id = messaging_application_id
+body.scope = scope
+body.digits = digits
+body.message = "Your temporary {NAME} {SCOPE} code is {CODE}"
+
+auth_client.create_messaging_two_factor(account_id, body)
+
+code = "123456" #This is the user input to validate
+
+body = TwoFactorVerifyRequestSchema.new
+body.from = from_phone
+body.to = to_phone
+body.application_id = application_id
+body.scope = scope
+body.code = code
+body.digits = digits
+body.expiration_time_in_minutes = 3
+
+response = auth_client.create_verify_two_factor(account_id, body)
+puts "Auth status: " + response.data.valid.to_s
+```
+
+### WebRtc Participant & Session Management
+
+```ruby
+web_rtc_client = bandwidth_client.web_rtc_client.client
+
+create_session_body = Session.new
+create_session_body.tag = 'new-session'
+
+create_session_response = web_rtc_client.create_session(account_id, :body => create_session_body)
+session_id = create_session_response.data.id
+puts session_id
+
+create_participant_body = Participant.new
+create_participant_body.publish_permissions = [
+    PublishPermissionEnum::AUDIO,
+    PublishPermissionEnum::VIDEO
+]
+create_participant_body.callback_url = "https://sample.com"
+
+create_participant_response = web_rtc_client.create_participant(account_id, :body => create_participant_body)
+participant_id = create_participant_response.data.participant.id
+puts participant_id
+
+web_rtc_client.add_participant_to_session(account_id, session_id, participant_id)
+```
+
+## Supported Ruby Versions
+
+This package can be used with Ruby >= 2.0 
+
+## Documentation
+
+Documentation for this package can be found at https://dev.bandwidth.com/sdks/ruby.html
+
+## Credentials
+
+Information for credentials for this package can be found at https://dev.bandwidth.com/guides/accountCredentials.html

data/lib/bandwidth.rb

@@ -14,6 +14,7 @@ require_relative 'bandwidth/client.rb'
 
 # Utilities
 require_relative 'bandwidth/utilities/file_wrapper.rb'
+require_relative 'bandwidth/utilities/date_time_helper.rb'
 
 # Http
 require_relative 'bandwidth/http/api_response.rb'
@@ -35,8 +36,10 @@ require_relative 'bandwidth/configuration.rb'
 # Namespaces
 require_relative 'bandwidth/messaging_lib/messaging'
 require_relative 'bandwidth/http/auth/messaging_basic_auth.rb'
-require_relative 'bandwidth/two_factor_auth_lib/two_factor_auth'
-require_relative 'bandwidth/http/auth/two_factor_auth_basic_auth.rb'
+require_relative 'bandwidth/multi_factor_auth_lib/multi_factor_auth'
+require_relative 'bandwidth/http/auth/multi_factor_auth_basic_auth.rb'
+require_relative 'bandwidth/phone_number_lookup_lib/phone_number_lookup'
+require_relative 'bandwidth/http/auth/phone_number_lookup_basic_auth.rb'
 require_relative 'bandwidth/voice_lib/voice'
 require_relative 'bandwidth/http/auth/voice_basic_auth.rb'
 require_relative 'bandwidth/web_rtc_lib/web_rtc'

data/lib/bandwidth/api_helper.rb

@@ -68,9 +68,7 @@ module Bandwidth
     # Appends the given set of parameters to the given query string.
     # @param [String] The query string builder to add the query parameters to.
     # @param [Hash] The parameters to append.
-    # @param [String] The format of array parameter serialization.
-    def self.append_url_with_query_parameters(query_builder, parameters,
-                                              array_serialization: 'indexed')
+    def self.append_url_with_query_parameters(query_builder, parameters)
       # Perform parameter validation.
       unless query_builder.instance_of? String
         raise ArgumentError, 'Given value for parameter \"query_builder\"
@@ -80,6 +78,8 @@ module Bandwidth
       # Return if there are no parameters to replace.
       return query_builder if parameters.nil?
 
+      array_serialization = 'indexed'
+
       parameters.each do |key, value|
         seperator = query_builder.include?('?') ? '&' : '?'
         unless value.nil?
@@ -156,8 +156,8 @@ module Bandwidth
     # Form encodes a hash of parameters.
     # @param [Hash] The hash of parameters to encode.
     # @return [Hash] A hash with the same parameters form encoded.
-    def self.form_encode_parameters(form_parameters,
-                                    array_serialization: 'indexed')
+    def self.form_encode_parameters(form_parameters)
+      array_serialization = 'indexed'
       encoded = {}
       form_parameters.each do |key, value|
         encoded.merge!(APIHelper.form_encode(value, key, formatting:
@@ -273,17 +273,5 @@ module Bandwidth
       end
       val
     end
-
-    # Safely converts a string into an rfc3339 DateTime object
-    # @param [String] The datetime string
-    # @return [DateTime] A DateTime object of rfc3339 format
-    def self.rfc3339(date_time)
-      # missing timezone information
-      if date_time.end_with?('Z') || date_time.index('+')
-        DateTime.rfc3339(date_time)
-      else
-        DateTime.rfc3339(date_time + 'Z')
-      end
-    end
   end
 end

data/lib/bandwidth/client.rb

@@ -12,10 +12,15 @@ module Bandwidth
     def messaging_client
       @messaging_client ||= Messaging::Client.new(config: config)
     end
-    # Access to two_factor_auth_client controller.
-    # @return [TwoFactorAuth::Client] Returns the client instance.
-    def two_factor_auth_client
-      @two_factor_auth_client ||= TwoFactorAuth::Client.new(config: config)
+    # Access to multi_factor_auth_client controller.
+    # @return [MultiFactorAuth::Client] Returns the client instance.
+    def multi_factor_auth_client
+      @multi_factor_auth_client ||= MultiFactorAuth::Client.new(config: config)
+    end
+    # Access to phone_number_lookup_client controller.
+    # @return [PhoneNumberLookup::Client] Returns the client instance.
+    def phone_number_lookup_client
+      @phone_number_lookup_client ||= PhoneNumberLookup::Client.new(config: config)
     end
     # Access to voice_client controller.
     # @return [Voice::Client] Returns the client instance.
@@ -29,12 +34,17 @@ module Bandwidth
     end
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 1, environment: Environment::PRODUCTION,
+                   backoff_factor: 2,
+                   retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                   retry_methods: %i[get put get put],
+                   environment: Environment::PRODUCTION,
                    base_url: 'https://www.example.com',
                    messaging_basic_auth_user_name: 'TODO: Replace',
                    messaging_basic_auth_password: 'TODO: Replace',
-                   two_factor_auth_basic_auth_user_name: 'TODO: Replace',
-                   two_factor_auth_basic_auth_password: 'TODO: Replace',
+                   multi_factor_auth_basic_auth_user_name: 'TODO: Replace',
+                   multi_factor_auth_basic_auth_password: 'TODO: Replace',
+                   phone_number_lookup_basic_auth_user_name: 'TODO: Replace',
+                   phone_number_lookup_basic_auth_password: 'TODO: Replace',
                    voice_basic_auth_user_name: 'TODO: Replace',
                    voice_basic_auth_password: 'TODO: Replace',
                    web_rtc_basic_auth_user_name: 'TODO: Replace',
@@ -43,12 +53,16 @@ module Bandwidth
                   Configuration.new(timeout: timeout, max_retries: max_retries,
                                     retry_interval: retry_interval,
                                     backoff_factor: backoff_factor,
+                                    retry_statuses: retry_statuses,
+                                    retry_methods: retry_methods,
                                     environment: environment,
                                     base_url: base_url,
                                     messaging_basic_auth_user_name: messaging_basic_auth_user_name,
                                     messaging_basic_auth_password: messaging_basic_auth_password,
-                                    two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,
-                                    two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
+                                    multi_factor_auth_basic_auth_user_name: multi_factor_auth_basic_auth_user_name,
+                                    multi_factor_auth_basic_auth_password: multi_factor_auth_basic_auth_password,
+                                    phone_number_lookup_basic_auth_user_name: phone_number_lookup_basic_auth_user_name,
+                                    phone_number_lookup_basic_auth_password: phone_number_lookup_basic_auth_password,
                                     voice_basic_auth_user_name: voice_basic_auth_user_name,
                                     voice_basic_auth_password: voice_basic_auth_password,
                                     web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,

data/lib/bandwidth/configuration.rb

@@ -17,7 +17,8 @@ module Bandwidth
     SERVER = [
       DEFAULT = 'default'.freeze,
       MESSAGINGDEFAULT = 'MessagingDefault'.freeze,
-      TWOFACTORAUTHDEFAULT = 'TwoFactorAuthDefault'.freeze,
+      MULTIFACTORAUTHDEFAULT = 'MultiFactorAuthDefault'.freeze,
+      PHONENUMBERLOOKUPDEFAULT = 'PhoneNumberLookupDefault'.freeze,
       VOICEDEFAULT = 'VoiceDefault'.freeze,
       WEBRTCDEFAULT = 'WebRtcDefault'.freeze
     ].freeze
@@ -32,12 +33,16 @@ module Bandwidth
     attr_reader :max_retries
     attr_reader :retry_interval
     attr_reader :backoff_factor
+    attr_reader :retry_statuses
+    attr_reader :retry_methods
     attr_reader :environment
     attr_reader :base_url
     attr_reader :messaging_basic_auth_user_name
     attr_reader :messaging_basic_auth_password
-    attr_reader :two_factor_auth_basic_auth_user_name
-    attr_reader :two_factor_auth_basic_auth_password
+    attr_reader :multi_factor_auth_basic_auth_user_name
+    attr_reader :multi_factor_auth_basic_auth_password
+    attr_reader :phone_number_lookup_basic_auth_user_name
+    attr_reader :phone_number_lookup_basic_auth_password
     attr_reader :voice_basic_auth_user_name
     attr_reader :voice_basic_auth_password
     attr_reader :web_rtc_basic_auth_user_name
@@ -48,12 +53,17 @@ module Bandwidth
     end
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 1, environment: Environment::PRODUCTION,
+                   backoff_factor: 2,
+                   retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                   retry_methods: %i[get put get put],
+                   environment: Environment::PRODUCTION,
                    base_url: 'https://www.example.com',
                    messaging_basic_auth_user_name: 'TODO: Replace',
                    messaging_basic_auth_password: 'TODO: Replace',
-                   two_factor_auth_basic_auth_user_name: 'TODO: Replace',
-                   two_factor_auth_basic_auth_password: 'TODO: Replace',
+                   multi_factor_auth_basic_auth_user_name: 'TODO: Replace',
+                   multi_factor_auth_basic_auth_password: 'TODO: Replace',
+                   phone_number_lookup_basic_auth_user_name: 'TODO: Replace',
+                   phone_number_lookup_basic_auth_password: 'TODO: Replace',
                    voice_basic_auth_user_name: 'TODO: Replace',
                    voice_basic_auth_password: 'TODO: Replace',
                    web_rtc_basic_auth_user_name: 'TODO: Replace',
@@ -71,6 +81,12 @@ module Bandwidth
       # by in order to provide backoff
       @backoff_factor = backoff_factor
 
+      # A list of HTTP statuses to retry
+      @retry_statuses = retry_statuses
+
+      # A list of HTTP methods to retry
+      @retry_methods = retry_methods
+
       # Current API environment
       @environment = String(environment)
 
@@ -84,10 +100,16 @@ module Bandwidth
       @messaging_basic_auth_password = messaging_basic_auth_password
 
       # The username to use with basic authentication
-      @two_factor_auth_basic_auth_user_name = two_factor_auth_basic_auth_user_name
+      @multi_factor_auth_basic_auth_user_name = multi_factor_auth_basic_auth_user_name
+
+      # The password to use with basic authentication
+      @multi_factor_auth_basic_auth_password = multi_factor_auth_basic_auth_password
+
+      # The username to use with basic authentication
+      @phone_number_lookup_basic_auth_user_name = phone_number_lookup_basic_auth_user_name
 
       # The password to use with basic authentication
-      @two_factor_auth_basic_auth_password = two_factor_auth_basic_auth_password
+      @phone_number_lookup_basic_auth_password = phone_number_lookup_basic_auth_password
 
       # The username to use with basic authentication
       @voice_basic_auth_user_name = voice_basic_auth_user_name
@@ -106,11 +128,14 @@ module Bandwidth
     end
 
     def clone_with(timeout: nil, max_retries: nil, retry_interval: nil,
-                   backoff_factor: nil, environment: nil, base_url: nil,
+                   backoff_factor: nil, retry_statuses: nil, retry_methods: nil,
+                   environment: nil, base_url: nil,
                    messaging_basic_auth_user_name: nil,
                    messaging_basic_auth_password: nil,
-                   two_factor_auth_basic_auth_user_name: nil,
-                   two_factor_auth_basic_auth_password: nil,
+                   multi_factor_auth_basic_auth_user_name: nil,
+                   multi_factor_auth_basic_auth_password: nil,
+                   phone_number_lookup_basic_auth_user_name: nil,
+                   phone_number_lookup_basic_auth_password: nil,
                    voice_basic_auth_user_name: nil,
                    voice_basic_auth_password: nil,
                    web_rtc_basic_auth_user_name: nil,
@@ -119,12 +144,16 @@ module Bandwidth
       max_retries ||= self.max_retries
       retry_interval ||= self.retry_interval
       backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
       environment ||= self.environment
       base_url ||= self.base_url
       messaging_basic_auth_user_name ||= self.messaging_basic_auth_user_name
       messaging_basic_auth_password ||= self.messaging_basic_auth_password
-      two_factor_auth_basic_auth_user_name ||= self.two_factor_auth_basic_auth_user_name
-      two_factor_auth_basic_auth_password ||= self.two_factor_auth_basic_auth_password
+      multi_factor_auth_basic_auth_user_name ||= self.multi_factor_auth_basic_auth_user_name
+      multi_factor_auth_basic_auth_password ||= self.multi_factor_auth_basic_auth_password
+      phone_number_lookup_basic_auth_user_name ||= self.phone_number_lookup_basic_auth_user_name
+      phone_number_lookup_basic_auth_password ||= self.phone_number_lookup_basic_auth_password
       voice_basic_auth_user_name ||= self.voice_basic_auth_user_name
       voice_basic_auth_password ||= self.voice_basic_auth_password
       web_rtc_basic_auth_user_name ||= self.web_rtc_basic_auth_user_name
@@ -133,11 +162,14 @@ module Bandwidth
       Configuration.new(
         timeout: timeout, max_retries: max_retries,
         retry_interval: retry_interval, backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses, retry_methods: retry_methods,
         environment: environment, base_url: base_url,
         messaging_basic_auth_user_name: messaging_basic_auth_user_name,
         messaging_basic_auth_password: messaging_basic_auth_password,
-        two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,
-        two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
+        multi_factor_auth_basic_auth_user_name: multi_factor_auth_basic_auth_user_name,
+        multi_factor_auth_basic_auth_password: multi_factor_auth_basic_auth_password,
+        phone_number_lookup_basic_auth_user_name: phone_number_lookup_basic_auth_user_name,
+        phone_number_lookup_basic_auth_password: phone_number_lookup_basic_auth_password,
         voice_basic_auth_user_name: voice_basic_auth_user_name,
         voice_basic_auth_password: voice_basic_auth_password,
         web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,
@@ -148,7 +180,9 @@ module Bandwidth
     def create_http_client
       FaradayClient.new(timeout: timeout, max_retries: max_retries,
                         retry_interval: retry_interval,
-                        backoff_factor: backoff_factor)
+                        backoff_factor: backoff_factor,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods)
     end
 
     # All the environments the SDK can run in.
@@ -156,14 +190,16 @@ module Bandwidth
       Environment::PRODUCTION => {
         Server::DEFAULT => 'api.bandwidth.com',
         Server::MESSAGINGDEFAULT => 'https://messaging.bandwidth.com/api/v2',
-        Server::TWOFACTORAUTHDEFAULT => 'https://mfa.bandwidth.com/api/v1/',
+        Server::MULTIFACTORAUTHDEFAULT => 'https://mfa.bandwidth.com/api/v1',
+        Server::PHONENUMBERLOOKUPDEFAULT => 'https://numbers.bandwidth.com/api/v1',
         Server::VOICEDEFAULT => 'https://voice.bandwidth.com',
         Server::WEBRTCDEFAULT => 'https://api.webrtc.bandwidth.com/v1'
       },
       Environment::CUSTOM => {
         Server::DEFAULT => '{base_url}',
         Server::MESSAGINGDEFAULT => '{base_url}',
-        Server::TWOFACTORAUTHDEFAULT => '{base_url}',
+        Server::MULTIFACTORAUTHDEFAULT => '{base_url}',
+        Server::PHONENUMBERLOOKUPDEFAULT => '{base_url}',
         Server::VOICEDEFAULT => '{base_url}',
         Server::WEBRTCDEFAULT => '{base_url}'
       }