bandwidth-sdk 2.1.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d875d4483cba8ab212869295640686010de4dfe22fc576c9ab76fcea68d270b
-  data.tar.gz: 0aeb54d8f7b3f17a723059d9e7fc823b1e717d749f4e76319f6f07690be1ac66
+  metadata.gz: 07e5fe50a991db2fb94f074067e8288020c363c5aef6640f9e56d7e5f2ddc0c6
+  data.tar.gz: 7d726b1e2b912c334bc376d1851f087fc609f1c0ab20ad478dfd9c297f35b59e
 SHA512:
-  metadata.gz: 741d727da5bf655ae535c62a4a0eb8479a95ac6e5464550d5bbda26f504df0b1ccc51ff1e15e6f60881a22957a81406295a20eec3a8f98145a23f4a617364ccb
-  data.tar.gz: 8ef95f432381be68a58135bd354d181790db79aebb8e04a822abbf7ecfcb1b4183c6157b73b6f46dd213e590be79bedc86794d80f6c8045eb0479cc9be2af083
+  metadata.gz: 525fd5027e01ea00e4912d5f8f02f5f89442a794558f79d3df37065c6bb3a8fd567e3bf3e11713771a166965a5e532abcbf15d8a99d6ace7120d868eb6877dbc
+  data.tar.gz: eccbe5576ad3f247f8e24b0e7708f1caf04339e0ed6741e649bb9e1344f85f662b76016af062735a8965375f4786ea55c1a0120b246e0d3edf9e32c48e6ba510

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'
@@ -35,5 +38,4 @@ require_relative 'bandwidth/http/auth/messaging_basic_auth.rb'
 require_relative 'bandwidth/voice_lib/voice'
 require_relative 'bandwidth/http/auth/voice_basic_auth.rb'
 
-
 # Controllers

data/lib/bandwidth/configuration.rb

@@ -59,7 +59,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
@@ -111,20 +111,20 @@ 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'
       }
-    }
+    }.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/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'

data/lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb

@@ -11,59 +11,6 @@ module Messaging
       super(config, http_call_back: http_call_back)
     end
 
-    # getMessage
-    # @return [void] response from the API call
-    def get_message
-      # Prepare query url.
-      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/ping'
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.get(
-        _query_url
-      )
-      MessagingBasicAuth.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
-        raise GenericClientException.new(
-          '400 Request is malformed or invalid',
-          _response
-        )
-      elsif _response.status_code == 401
-        raise PathClientException.new(
-          '401 The specified user does not have access to the account',
-          _response
-        )
-      elsif _response.status_code == 403
-        raise PathClientException.new(
-          '403 The user does not have access to this API',
-          _response
-        )
-      elsif _response.status_code == 404
-        raise PathClientException.new(
-          '404 Path not found',
-          _response
-        )
-      elsif _response.status_code == 415
-        raise GenericClientException.new(
-          '415 The content-type of the request is incorrect',
-          _response
-        )
-      elsif _response.status_code == 429
-        raise GenericClientException.new(
-          '429 The rate limit has been reached',
-          _response
-        )
-      end
-      validate_response(_response)
-
-      # Return appropriate response type.
-      ApiResponse.new(_response)
-    end
-
     # listMedia
     # @param [String] user_id Required parameter: Example:
     # @param [String] continuation_token Optional parameter: Example:
@@ -95,32 +42,32 @@ module Messaging
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
       elsif _response.status_code == 401
-        raise PathClientException.new(
+        raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
       elsif _response.status_code == 403
-        raise PathClientException.new(
+        raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
       elsif _response.status_code == 404
-        raise PathClientException.new(
+        raise MessagingException.new(
           '404 Path not found',
           _response
         )
       elsif _response.status_code == 415
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
       elsif _response.status_code == 429
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
         )
@@ -158,32 +105,32 @@ module Messaging
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
       elsif _response.status_code == 401
-        raise PathClientException.new(
+        raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
       elsif _response.status_code == 403
-        raise PathClientException.new(
+        raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
       elsif _response.status_code == 404
-        raise PathClientException.new(
+        raise MessagingException.new(
           '404 Path not found',
           _response
         )
       elsif _response.status_code == 415
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
       elsif _response.status_code == 429
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
         )
@@ -198,15 +145,16 @@ module Messaging
     # @param [String] user_id Required parameter: Example:
     # @param [String] media_id Required parameter: Example:
     # @param [Long] content_length Required parameter: Example:
-    # @param [String] body Required parameter: Example:
-    # @param [String] content_type Optional parameter: Example:
+    # @param [File | UploadIO] body Required parameter: Example:
+    # @param [String] content_type Optional parameter:
+    # Example:application/octet-stream
     # @param [String] cache_control Optional parameter: Example:
     # @return [void] response from the API call
     def upload_media(user_id,
                      media_id,
                      content_length,
                      body,
-                     content_type: nil,
+                     content_type: 'application/octet-stream',
                      cache_control: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
@@ -218,10 +166,19 @@ module Messaging
       )
       _query_url = APIHelper.clean_url _query_builder
 
+      if body.is_a? FileWrapper
+        body_wrapper = body.file
+        body_content_type = body.content_type
+      else
+        body_wrapper = body
+        body_content_type = content_type
+      end
+
       # Prepare headers.
       _headers = {
+        'content-type' => body_content_type,
+        'content-length' => body_wrapper.size.to_s,
         'Content-Length' => content_length,
-        'Content-Type' => content_type,
         'Cache-Control' => cache_control
       }
 
@@ -229,39 +186,39 @@ module Messaging
       _request = config.http_client.put(
         _query_url,
         headers: _headers,
-        parameters: body
+        parameters: body_wrapper
       )
       MessagingBasicAuth.apply(config, _request)
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
       elsif _response.status_code == 401
-        raise PathClientException.new(
+        raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
       elsif _response.status_code == 403
-        raise PathClientException.new(
+        raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
       elsif _response.status_code == 404
-        raise PathClientException.new(
+        raise MessagingException.new(
           '404 Path not found',
           _response
         )
       elsif _response.status_code == 415
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
       elsif _response.status_code == 429
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
         )
@@ -297,32 +254,32 @@ module Messaging
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
       elsif _response.status_code == 401
-        raise PathClientException.new(
+        raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
       elsif _response.status_code == 403
-        raise PathClientException.new(
+        raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
       elsif _response.status_code == 404
-        raise PathClientException.new(
+        raise MessagingException.new(
           '404 Path not found',
           _response
         )
       elsif _response.status_code == 415
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
       elsif _response.status_code == 429
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
         )
@@ -365,32 +322,32 @@ module Messaging
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
       elsif _response.status_code == 401
-        raise PathClientException.new(
+        raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
       elsif _response.status_code == 403
-        raise PathClientException.new(
+        raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
       elsif _response.status_code == 404
-        raise PathClientException.new(
+        raise MessagingException.new(
           '404 Path not found',
           _response
         )
       elsif _response.status_code == 415
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
       elsif _response.status_code == 429
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
         )