bandwidth-sdk 2.1.1 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d875d4483cba8ab212869295640686010de4dfe22fc576c9ab76fcea68d270b
-  data.tar.gz: 0aeb54d8f7b3f17a723059d9e7fc823b1e717d749f4e76319f6f07690be1ac66
+  metadata.gz: 26c4cadeb77f88938cc4adac87254af331797646e475f2985dbe93078c128058
+  data.tar.gz: 26e318c93cff54b0d8d47f36dabd4bfcfa66ec33ecd2eaa8a3d6013216f5a635
 SHA512:
-  metadata.gz: 741d727da5bf655ae535c62a4a0eb8479a95ac6e5464550d5bbda26f504df0b1ccc51ff1e15e6f60881a22957a81406295a20eec3a8f98145a23f4a617364ccb
-  data.tar.gz: 8ef95f432381be68a58135bd354d181790db79aebb8e04a822abbf7ecfcb1b4183c6157b73b6f46dd213e590be79bedc86794d80f6c8045eb0479cc9be2af083
+  metadata.gz: 05ed430d18e6bdfffa1400a86d2a92d841d3340aa9bf838a9647c534354585992bd273978008a5161b51bd6b2616d06cf4fbb4ae638f5631d2999459817d6cf4
+  data.tar.gz: 5595927b80c12008edb1d1527ac407ca97f431a1dff0acc6984ec2dcfcb9b1e11573af76a4ec40b894ff8b17033f0e226f742ea0505a353d370ad0407f36ff8e

data/LICENSE

@@ -3,7 +3,7 @@ License:
 The MIT License (MIT)
 http://opensource.org/licenses/MIT
 
-Copyright (c) 2014 - 2016 APIMATIC Limited
+Copyright (c) 2014 - 2020 APIMATIC Limited
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,70 +1,85 @@
-# Getting Started with bandwidth
-
-Bandwidth's set of APIs
-
-## Install the Package
-
-Install the gem from the command line:
-
-```ruby
-gem install bandwidth-sdk -v 2.1.1
-```
-
-Or add the gem to your Gemfile and run `bundle`:
-
-```ruby
-gem 'bandwidth-sdk', '2.1.1'
-```
-
-For additional gem details, see the [RubyGems page for the bandwidth-sdk gem](https://rubygems.org/gems/bandwidth-sdk/versions/2.1.1).
-
-## Initialize the API Client
-
-The following parameters are configurable for the API Client.
-
-| Parameter | Type | Description |
-|  --- | --- | --- |
-| `messaging_basic_auth_user_name` | `String` | The username to use with basic authentication |
-| `messaging_basic_auth_password` | `String` | The password to use with basic authentication |
-| `voice_basic_auth_user_name` | `String` | The username to use with basic authentication |
-| `voice_basic_auth_password` | `String` | The password to use with basic authentication |
-| `environment` | Environment | The API environment. <br> **Default: `Environment.PRODUCTION`** |
-| `timeout` | `Float` | The value to use for connection timeout. <br> **Default: 60** |
-| `max_retries` | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
-| `retry_interval` | `Float` | Pause in seconds between retries. <br> **Default: 1** |
-| `backoff_factor` | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 1** |
-
-The API client can be initialized as following.
-
-```ruby
-client = Bandwidth::Client.new(
-  messaging_basic_auth_user_name: 'MessagingBasicAuthUserName',
-  messaging_basic_auth_password: 'MessagingBasicAuthPassword',
-  voice_basic_auth_user_name: 'VoiceBasicAuthUserName',
-  voice_basic_auth_password: 'VoiceBasicAuthPassword',
-  environment: Environment::PRODUCTION,
-)
-```
-
-API calls return an `ApiResponse` object that includes the following fields:
-
-| Field | Description |
-|  --- | --- |
-| `status_code` | Status code of the HTTP response |
-| `reason_phrase` | Reason phrase of the HTTP response |
-| `headers` | Headers of the HTTP response as a Hash |
-| `raw_body` | The body of the HTTP response as a String |
-| `request` | HTTP request info |
-| `errors` | Errors, if they exist |
-| `data` | The deserialized body of the HTTP response |
-
-## Authorization
-
-This API does not require authentication.
-
-## API Reference
-
-### List of APIs
-
-*
-
+# 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
+
+## Download & Install
+
+```
+gem install bandwidth-sdk
+```
+
+## Initialize Bandwidth Client
+
+```ruby
+require 'bandwidth'
+
+include Bandwidth
+include Bandwidth::Voice
+include Bandwidth::Messaging
+
+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',
+)
+```
+
+## Create Phone Call
+
+```ruby
+voice_client = bandwidth_client.voice_client.client
+
+account_id = '1'
+body = ApiCreateCallRequest.new
+body.from = '+16666666666'
+body.to = '+17777777777'
+body.answer_url = 'https://test.com'
+body.application_id = '3-d-4-b-5'
+
+begin
+    response = voice_client.create_call(account_id,:body => body)
+    puts response.data.call_id #c-d45a41e5-bcb12581-b18e-4bdc-9874-6r3235dfweao
+    puts response.status_code #201
+rescue Bandwidth::ErrorResponseException => e
+    puts e.description #Invalid to: must be an E164 telephone number
+    puts e.response_code #400
+end
+```
+
+## Generate BXML
+
+```ruby
+response = Bandwidth::Voice::Response.new()
+hangup = Bandwidth::Voice::Hangup.new()
+
+response.push(hangup)
+puts response.to_bxml()
+```
+
+## 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']
+body.from = '+18888888888'
+body.text = 'Hello from Bandwidth'
+
+begin
+    response = messaging_client.create_message(account_id, body)
+    puts response.data.id #1570740275373xbn7mbhsfewasdr
+    puts response.status_code #202
+rescue Bandwidth::GenericClientException => e
+    puts e.description #Access is denied
+    puts e.response_code #403
+rescue Bandwidth::PathClientException => e
+    puts e.message #Your request could not be accepted.
+    puts e.response_code #400
+end
+```

data/lib/bandwidth.rb

@@ -12,6 +12,9 @@ require 'logging'
 require_relative 'bandwidth/api_helper.rb'
 require_relative 'bandwidth/client.rb'
 
+# Utilities
+require_relative 'bandwidth/utilities/file_wrapper.rb'
+
 # Http
 require_relative 'bandwidth/http/api_response.rb'
 require_relative 'bandwidth/http/http_call_back.rb'
@@ -32,8 +35,34 @@ 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/voice_lib/voice'
 require_relative 'bandwidth/http/auth/voice_basic_auth.rb'
+require_relative 'bandwidth/web_rtc_lib/web_rtc'
+require_relative 'bandwidth/http/auth/web_rtc_basic_auth.rb'
 
-
-# Controllers
+# External Files
+require_relative 'bandwidth/voice_lib/bxml/bxml.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/bridge.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/conference.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/forward.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/gather.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/hangup.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/pause.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/pause_recording.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/phone_number.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/play_audio.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/record.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/redirect.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/resume_recording.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/ring.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/send_dtmf.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/speak_sentence.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/start_gather.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/start_recording.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/stop_gather.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/stop_recording.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/transfer.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/xml_verb.rb'
+require_relative 'bandwidth/web_rtc_lib/utils/web_rtc_transfer.rb'

data/lib/bandwidth/api_helper.rb

@@ -41,17 +41,22 @@ module Bandwidth
       # Return if there are no parameters to replace.
       return query_builder if parameters.nil?
 
-      # Iterate and append parameters.
-      parameters.each do |key, value|
-        replace_value = ''
-
-        if value.nil?
+      parameters.each do |key, val|
+        if val.nil?
           replace_value = ''
-        elsif value.instance_of? Array
-          value.map! { |element| CGI.escape(element.to_s) }
-          replace_value = value.join('/')
+        elsif val['value'].instance_of? Array
+          if val['encode'] == true
+            val['value'].map! { |element| CGI.escape(element.to_s) }
+          else
+            val['value'].map!(&:to_s)
+          end
+          replace_value = val['value'].join('/')
         else
-          replace_value = CGI.escape(value.to_s)
+          replace_value = if val['encode'] == true
+                            CGI.escape(val['value'].to_s)
+                          else
+                            val['value'].to_s
+                          end
         end
 
         # Find the template parameter and replace it with its value.

data/lib/bandwidth/client.rb

@@ -12,27 +12,47 @@ 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)
+    end
     # Access to voice_client controller.
     # @return [Voice::Client] Returns the client instance.
     def voice_client
       @voice_client ||= Voice::Client.new(config: config)
     end
+    # Access to web_rtc_client controller.
+    # @return [WebRtc::Client] Returns the client instance.
+    def web_rtc_client
+      @web_rtc_client ||= WebRtc::Client.new(config: config)
+    end
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, 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',
                    voice_basic_auth_user_name: 'TODO: Replace',
-                   voice_basic_auth_password: 'TODO: Replace', config: nil)
+                   voice_basic_auth_password: 'TODO: Replace',
+                   web_rtc_basic_auth_user_name: 'TODO: Replace',
+                   web_rtc_basic_auth_password: 'TODO: Replace', config: nil)
       @config = if config.nil?
                   Configuration.new(timeout: timeout, max_retries: max_retries,
                                     retry_interval: retry_interval,
                                     backoff_factor: backoff_factor,
                                     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,
                                     voice_basic_auth_user_name: voice_basic_auth_user_name,
-                                    voice_basic_auth_password: voice_basic_auth_password)
+                                    voice_basic_auth_password: voice_basic_auth_password,
+                                    web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,
+                                    web_rtc_basic_auth_password: web_rtc_basic_auth_password)
                 else
                   config
                 end

data/lib/bandwidth/configuration.rb

@@ -7,7 +7,8 @@ module Bandwidth
   # An enum for SDK environments.
   class Environment
     ENVIRONMENT = [
-      PRODUCTION = 'production'.freeze
+      PRODUCTION = 'production'.freeze,
+      CUSTOM = 'custom'.freeze
     ].freeze
   end
 
@@ -16,7 +17,9 @@ module Bandwidth
     SERVER = [
       DEFAULT = 'default'.freeze,
       MESSAGINGDEFAULT = 'MessagingDefault'.freeze,
-      VOICEDEFAULT = 'VoiceDefault'.freeze
+      TWOFACTORAUTHDEFAULT = 'TwoFactorAuthDefault'.freeze,
+      VOICEDEFAULT = 'VoiceDefault'.freeze,
+      WEBRTCDEFAULT = 'WebRtcDefault'.freeze
     ].freeze
   end
 
@@ -30,10 +33,15 @@ module Bandwidth
     attr_reader :retry_interval
     attr_reader :backoff_factor
     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 :voice_basic_auth_user_name
     attr_reader :voice_basic_auth_password
+    attr_reader :web_rtc_basic_auth_user_name
+    attr_reader :web_rtc_basic_auth_password
 
     class << self
       attr_reader :environments
@@ -41,10 +49,15 @@ module Bandwidth
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, 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',
                    voice_basic_auth_user_name: 'TODO: Replace',
-                   voice_basic_auth_password: 'TODO: Replace')
+                   voice_basic_auth_password: 'TODO: Replace',
+                   web_rtc_basic_auth_user_name: 'TODO: Replace',
+                   web_rtc_basic_auth_password: 'TODO: Replace')
       # The value to use for connection timeout
       @timeout = timeout
 
@@ -59,7 +72,10 @@ module Bandwidth
       @backoff_factor = backoff_factor
 
       # Current API environment
-      @environment = environment
+      @environment = String(environment)
+
+      # baseUrl value
+      @base_url = base_url
 
       # The username to use with basic authentication
       @messaging_basic_auth_user_name = messaging_basic_auth_user_name
@@ -67,40 +83,65 @@ module Bandwidth
       # The password to use with basic authentication
       @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
+
+      # The password to use with basic authentication
+      @two_factor_auth_basic_auth_password = two_factor_auth_basic_auth_password
+
       # The username to use with basic authentication
       @voice_basic_auth_user_name = voice_basic_auth_user_name
 
       # The password to use with basic authentication
       @voice_basic_auth_password = voice_basic_auth_password
 
+      # The username to use with basic authentication
+      @web_rtc_basic_auth_user_name = web_rtc_basic_auth_user_name
+
+      # The password to use with basic authentication
+      @web_rtc_basic_auth_password = web_rtc_basic_auth_password
+
       # The Http Client to use for making requests.
       @http_client = create_http_client
     end
 
     def clone_with(timeout: nil, max_retries: nil, retry_interval: nil,
-                   backoff_factor: nil, environment: nil,
+                   backoff_factor: 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,
                    voice_basic_auth_user_name: nil,
-                   voice_basic_auth_password: nil)
+                   voice_basic_auth_password: nil,
+                   web_rtc_basic_auth_user_name: nil,
+                   web_rtc_basic_auth_password: nil)
       timeout ||= self.timeout
       max_retries ||= self.max_retries
       retry_interval ||= self.retry_interval
       backoff_factor ||= self.backoff_factor
       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
       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
+      web_rtc_basic_auth_password ||= self.web_rtc_basic_auth_password
 
       Configuration.new(
         timeout: timeout, max_retries: max_retries,
         retry_interval: retry_interval, backoff_factor: backoff_factor,
-        environment: environment,
+        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,
         voice_basic_auth_user_name: voice_basic_auth_user_name,
-        voice_basic_auth_password: voice_basic_auth_password
+        voice_basic_auth_password: voice_basic_auth_password,
+        web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,
+        web_rtc_basic_auth_password: web_rtc_basic_auth_password
       )
     end
 
@@ -111,20 +152,34 @@ module Bandwidth
     end
 
     # All the environments the SDK can run in.
-    @environments = {
+    ENVIRONMENTS = {
       Environment::PRODUCTION => {
         Server::DEFAULT => 'api.bandwidth.com',
         Server::MESSAGINGDEFAULT => 'https://messaging.bandwidth.com/api/v2',
-        Server::VOICEDEFAULT => 'https://voice.bandwidth.com'
+        Server::TWOFACTORAUTHDEFAULT => 'https://mfa.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::VOICEDEFAULT => '{base_url}',
+        Server::WEBRTCDEFAULT => '{base_url}'
       }
-    }
+    }.freeze
 
     # Generates the appropriate base URI for the environment and the server.
     # @param [Configuration::Server] The server enum for which the base URI is
     # required.
     # @return [String] The base URI.
     def get_base_uri(server = Server::DEFAULT)
-      self.class.environments[environment][server].clone
+      parameters = {
+        'base_url' => { 'value' => base_url, 'encode' => false }
+      }
+      APIHelper.append_url_with_template_parameters(
+        ENVIRONMENTS[environment][server], parameters
+      )
     end
   end
 end