bandwidth-sdk 2.1.1 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d875d4483cba8ab212869295640686010de4dfe22fc576c9ab76fcea68d270b
-  data.tar.gz: 0aeb54d8f7b3f17a723059d9e7fc823b1e717d749f4e76319f6f07690be1ac66
+  metadata.gz: e10eadbf6902f10e74e9e2574332439ce256b7b8a57d8c7e87f6a776857376c0
+  data.tar.gz: 585279582d7e65c7a88dbb284d72a05f399be1a4c36dbc169fdeecd8a5317e61
 SHA512:
-  metadata.gz: 741d727da5bf655ae535c62a4a0eb8479a95ac6e5464550d5bbda26f504df0b1ccc51ff1e15e6f60881a22957a81406295a20eec3a8f98145a23f4a617364ccb
-  data.tar.gz: 8ef95f432381be68a58135bd354d181790db79aebb8e04a822abbf7ecfcb1b4183c6157b73b6f46dd213e590be79bedc86794d80f6c8045eb0479cc9be2af083
+  metadata.gz: e2c78bbe4acf58b05f186547b72e39f10cd198e68fe22051ab268027177544e51111b95af0f3a44b9ec1d1e038ca8420ef2a871c537fbb17138e430fc8cab1d1
+  data.tar.gz: ad3b16633b516c60e14c8a9469acb912f74bc36c5e737fa636d4f2c32808636e76e718a1e3bcd7f30e7dcf2d93b278e31fdd1a71c08e5fe1574d16a484a0d184

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 => 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,11 @@ 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

data/lib/bandwidth/client.rb

@@ -12,18 +12,32 @@ 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,
                    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,
@@ -31,8 +45,12 @@ module Bandwidth
                                     environment: environment,
                                     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

@@ -16,7 +16,9 @@ module Bandwidth
     SERVER = [
       DEFAULT = 'default'.freeze,
       MESSAGINGDEFAULT = 'MessagingDefault'.freeze,
-      VOICEDEFAULT = 'VoiceDefault'.freeze
+      TWOFACTORAUTHDEFAULT = 'TwoFactorAuthDefault'.freeze,
+      VOICEDEFAULT = 'VoiceDefault'.freeze,
+      WEBRTCDEFAULT = 'WebRtcDefault'.freeze
     ].freeze
   end
 
@@ -32,8 +34,12 @@ module Bandwidth
     attr_reader :environment
     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
@@ -43,8 +49,12 @@ module Bandwidth
                    backoff_factor: 1, environment: Environment::PRODUCTION,
                    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 +69,7 @@ module Bandwidth
       @backoff_factor = backoff_factor
 
       # Current API environment
-      @environment = environment
+      @environment = String(environment)
 
       # The username to use with basic authentication
       @messaging_basic_auth_user_name = messaging_basic_auth_user_name
@@ -67,12 +77,24 @@ 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
@@ -81,8 +103,12 @@ module Bandwidth
                    backoff_factor: nil, environment: 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
@@ -90,8 +116,12 @@ module Bandwidth
       environment ||= self.environment
       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,
@@ -99,8 +129,12 @@ module Bandwidth
         environment: environment,
         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 +145,22 @@ 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'
       }
-    }
+    }.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
+      ENVIRONMENTS[environment][server].clone
     end
   end
 end

data/lib/bandwidth/http/auth/two_factor_auth_basic_auth.rb

@@ -0,0 +1,22 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'base64'
+
+module Bandwidth
+  # Utility class for basic authorization.
+  class TwoFactorAuthBasicAuth
+    # Add basic authentication to the request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    def self.apply(config, http_request)
+      username = config.two_factor_auth_basic_auth_user_name
+      password = config.two_factor_auth_basic_auth_password
+      value = Base64.strict_encode64("#{username}:#{password}")
+      header_value = "Basic #{value}"
+      http_request.headers['Authorization'] = header_value
+    end
+  end
+end

data/lib/bandwidth/http/auth/web_rtc_basic_auth.rb

@@ -0,0 +1,22 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'base64'
+
+module Bandwidth
+  # Utility class for basic authorization.
+  class WebRtcBasicAuth
+    # Add basic authentication to the request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    def self.apply(config, http_request)
+      username = config.web_rtc_basic_auth_user_name
+      password = config.web_rtc_basic_auth_password
+      value = Base64.strict_encode64("#{username}:#{password}")
+      header_value = "Basic #{value}"
+      http_request.headers['Authorization'] = header_value
+    end
+  end
+end

data/lib/bandwidth/http/faraday_client.rb

@@ -34,9 +34,7 @@ module Bandwidth
         http_request.query_url
       ) do |request|
         request.headers = http_request.headers
-        unless http_request.parameters.empty?
-          request.body = http_request.parameters
-        end
+        request.body = http_request.parameters
       end
       convert_response(response, http_request)
     end
@@ -48,9 +46,7 @@ module Bandwidth
         http_request.query_url
       ) do |request|
         request.headers = http_request.headers
-        unless http_request.parameters.empty?
-          request.body = http_request.parameters
-        end
+        request.body = http_request.parameters
       end
       convert_response(response, http_request)
     end

data/lib/bandwidth/messaging_lib/messaging.rb

@@ -7,7 +7,6 @@
 require_relative 'messaging/client.rb'
 
 # Models
-require_relative 'messaging/models/field_error.rb'
 require_relative 'messaging/models/media.rb'
 require_relative 'messaging/models/tag.rb'
 require_relative 'messaging/models/deferred_result.rb'
@@ -16,8 +15,7 @@ require_relative 'messaging/models/bandwidth_message.rb'
 require_relative 'messaging/models/message_request.rb'
 
 # Exceptions
-require_relative 'messaging/exceptions/generic_client_exception.rb'
-require_relative 'messaging/exceptions/path_client_exception.rb'
+require_relative 'messaging/exceptions/messaging_exception.rb'
 # Controllers
 require_relative 'messaging/controllers/base_controller.rb'
 require_relative 'messaging/controllers/api_controller.rb'