bandwidth-sdk 7.0.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b67b83b111ec3185ce0614d96b9f46ea31270db7e0b44a069cc8d87e16bf2bd5
-  data.tar.gz: b4c1575cda3afab5b3a17ccf70883ddd68815ec9e3e55c162d778cc7667dd8ad
+  metadata.gz: 72d08e72e19066da912c18946e2bcb7e38c3da78f58005388dd2a6d1b8bc98da
+  data.tar.gz: 26a7f5cd86a6a3ea974062f66de43b7edee59bf1e7f74fb2ec6e5272a22cdbea
 SHA512:
-  metadata.gz: 7de5c586dc71cc06134c42008931b6508e5fca4a7baecd02dd94b5d9c5d1e26f10c6266c020ef6c91429a0e50e10678a32803e07c2af30e74833fe0a55ea7f65
-  data.tar.gz: 61b41ff9f216fee03ff287270a13666575006b870ecdc38c9edf8b4de93e7db0a4d45d37becf2b11bd52cfba399058739b3e9bea48d086d71d01983ef2da28f7
+  metadata.gz: cfa230d51fe36a6c513821b05975e1d28a0a14f70e326cd802c20788cbc966f20405f9d3c82e478e2c0095b7ffedda699050d981986e50eecad4716c4c525453
+  data.tar.gz: e99889889de6d0893da79e616aa9cce33dcc76395c692258c0dfb98f0cde7e38d7901579dd9542acd1e0594ebf0dde25407a5c06be09307fea30ea07197ba04e

data/README.md

@@ -1,5 +1,15 @@
 # Bandwidth Ruby SDK
 
+[![Test](https://github.com/Bandwidth/ruby-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/Bandwidth/ruby-sdk/actions/workflows/test.yml)
+
+
+| **OS** | **Ruby** |
+|:---:|:---:|
+| Windows 2016 | 2.6, 2.7, 3.0 |
+| Windows 2019 | 2.6, 2.7, 3.0 |
+| Ubuntu 18.04 | 2.6, 2.7, 3.0 |
+| Ubuntu 20.04 | 2.6, 2.7, 3.0 |
+
 ## Getting Started
 
 ### Installation

data/lib/bandwidth/api_helper.rb

@@ -13,13 +13,14 @@ module Bandwidth
     def self.serialize_array(key, array, formatting: 'indexed')
       tuples = []
 
-      if formatting == 'unindexed'
+      case formatting
+      when 'unindexed'
         tuples += array.map { |element| ["#{key}[]", element] }
-      elsif formatting == 'indexed'
+      when 'indexed'
         tuples += array.map.with_index do |element, index|
           ["#{key}[#{index}]", element]
         end
-      elsif formatting == 'plain'
+      when 'plain'
         tuples += array.map { |element| [key, element] }
       else
         raise ArgumentError, 'Invalid format provided.'
@@ -60,7 +61,7 @@ module Bandwidth
         end
 
         # Find the template parameter and replace it with its value.
-        query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+        query_builder = query_builder.gsub("{#{key}}", replace_value)
       end
       query_builder
     end
@@ -85,15 +86,16 @@ module Bandwidth
         unless value.nil?
           if value.instance_of? Array
             value.compact!
-            query_builder += if array_serialization == 'csv'
+            query_builder += case array_serialization
+                             when 'csv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
                                end.join(',')}"
-                             elsif array_serialization == 'psv'
+                             when 'psv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
                                end.join('|')}"
-                             elsif array_serialization == 'tsv'
+                             when 'tsv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
                                end.join("\t")}"
@@ -119,7 +121,7 @@ module Bandwidth
       raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
 
       # Ensure that the urls are absolute.
-      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      matches = url.match(%r{^(https?://[^/]+)})
       raise ArgumentError, 'Invalid Url format.' if matches.nil?
 
       # Get the http protocol match.
@@ -130,7 +132,7 @@ module Bandwidth
 
       # Remove redundant forward slashes.
       query = url[protocol.length...(!index.nil? ? index : url.length)]
-      query.gsub!(%r{\/\/+}, '/')
+      query.gsub!(%r{//+}, '/')
 
       # Get the parameters.
       parameters = !index.nil? ? url[url.index('?')...url.length] : ''
@@ -142,7 +144,7 @@ module Bandwidth
     # Parses JSON string.
     # @param [String] A JSON string.
     def self.json_deserialize(json)
-      return JSON.parse(json)
+      JSON.parse(json)
     rescue StandardError
       raise TypeError, 'Server responded with invalid JSON.'
     end
@@ -171,6 +173,7 @@ module Bandwidth
       a.each do |key, value_a|
         b.each do |k, value_b|
           next unless key == k
+
           x[k] = []
           if value_a.instance_of? Array
             value_a.each do |v|
@@ -215,13 +218,12 @@ module Bandwidth
       elsif obj.instance_of? Array
         if formatting == 'indexed'
           obj.each_with_index do |value, index|
-            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-              index.to_s + ']'))
+            retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{index}]"))
           end
         elsif serializable_types.map { |x| obj[0].is_a? x }.any?
           obj.each do |value|
             abc = if formatting == 'unindexed'
-                    APIHelper.form_encode(value, instance_name + '[]',
+                    APIHelper.form_encode(value, "#{instance_name}[]",
                                           formatting: formatting)
                   else
                     APIHelper.form_encode(value, instance_name,
@@ -231,14 +233,14 @@ module Bandwidth
           end
         else
           obj.each_with_index do |value, index|
-            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-              index.to_s + ']', formatting: formatting))
+            retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{index}]",
+                                                formatting: formatting))
           end
         end
       elsif obj.instance_of? Hash
         obj.each do |key, value|
-          retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-            key.to_s + ']', formatting: formatting))
+          retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{key}]",
+                                              formatting: formatting))
         end
       elsif obj.instance_of? File
         retval[instance_name] = UploadIO.new(

data/lib/bandwidth/configuration.rb

@@ -28,25 +28,13 @@ module Bandwidth
   # are configured in this class.
   class Configuration
     # The attribute readers for properties.
-    attr_reader :http_client
-    attr_reader :timeout
-    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 :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
-    attr_reader :web_rtc_basic_auth_password
+    attr_reader :http_client, :timeout, :max_retries, :retry_interval, :backoff_factor,
+                :retry_statuses, :retry_methods, :environment, :base_url,
+                :messaging_basic_auth_user_name, :messaging_basic_auth_password,
+                :multi_factor_auth_basic_auth_user_name, :multi_factor_auth_basic_auth_password,
+                :phone_number_lookup_basic_auth_user_name, :phone_number_lookup_basic_auth_password,
+                :voice_basic_auth_user_name, :voice_basic_auth_password,
+                :web_rtc_basic_auth_user_name, :web_rtc_basic_auth_password
 
     class << self
       attr_reader :environments

data/lib/bandwidth/http/faraday_client.rb

@@ -27,7 +27,7 @@ module Bandwidth
                                 methods: retry_methods
         faraday.adapter Faraday.default_adapter
         faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
-        faraday.options[:timeout] = timeout if timeout > 0
+        faraday.options[:timeout] = timeout if timeout.positive?
       end
     end
 

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

@@ -11,7 +11,7 @@ module Messaging
       super(config, http_call_back: http_call_back)
     end
 
-    # listMedia
+    # Gets a list of your media files. No query parameters are supported.
     # @param [String] account_id Required parameter: User's account ID
     # @param [String] continuation_token Optional parameter: Continuation token
     # used to retrieve subsequent media.
@@ -42,32 +42,33 @@ module Messaging
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise MessagingException.new(
           '404 Path not found',
           _response
         )
-      elsif _response.status_code == 415
+      when 415
         raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
-      elsif _response.status_code == 429
+      when 429
         raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
@@ -83,7 +84,7 @@ module Messaging
       )
     end
 
-    # getMedia
+    # Downloads a media file you previously uploaded.
     # @param [String] account_id Required parameter: User's account ID
     # @param [String] media_id Required parameter: Media ID to retrieve
     # @return [Binary] response from the API call
@@ -107,32 +108,33 @@ module Messaging
       _response = execute_request(_request, binary: true)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise MessagingException.new(
           '404 Path not found',
           _response
         )
-      elsif _response.status_code == 415
+      when 415
         raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
-      elsif _response.status_code == 429
+      when 429
         raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
@@ -146,7 +148,8 @@ module Messaging
       )
     end
 
-    # uploadMedia
+    # Uploads a file the normal HTTP way. You may add headers to the request in
+    # order to provide some control to your media-file.
     # @param [String] account_id Required parameter: User's account ID
     # @param [String] media_id Required parameter: The user supplied custom
     # media ID
@@ -197,32 +200,33 @@ module Messaging
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise MessagingException.new(
           '404 Path not found',
           _response
         )
-      elsif _response.status_code == 415
+      when 415
         raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
-      elsif _response.status_code == 429
+      when 429
         raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
@@ -234,7 +238,10 @@ module Messaging
       ApiResponse.new(_response)
     end
 
-    # deleteMedia
+    # Deletes a media file from Bandwidth API server. Make sure you don't have
+    # any application scripts still using the media before you delete. If you
+    # accidentally delete a media file, you can immediately upload a new file
+    # with the same name.
     # @param [String] account_id Required parameter: User's account ID
     # @param [String] media_id Required parameter: The media ID to delete
     # @return [void] response from the API call
@@ -258,32 +265,33 @@ module Messaging
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise MessagingException.new(
           '404 Path not found',
           _response
         )
-      elsif _response.status_code == 415
+      when 415
         raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
-      elsif _response.status_code == 429
+      when 429
         raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
@@ -295,7 +303,7 @@ module Messaging
       ApiResponse.new(_response)
     end
 
-    # getMessages
+    # Gets a list of messages based on query parameters.
     # @param [String] account_id Required parameter: User's account ID
     # @param [String] message_id Optional parameter: The ID of the message to
     # search for. Special characters need to be encoded using URL encoding
@@ -365,32 +373,33 @@ module Messaging
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise MessagingException.new(
           '404 Path not found',
           _response
         )
-      elsif _response.status_code == 415
+      when 415
         raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
-      elsif _response.status_code == 429
+      when 429
         raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
@@ -405,7 +414,8 @@ module Messaging
       )
     end
 
-    # createMessage
+    # Endpoint for sending text messages and picture messages using V2
+    # messaging.
     # @param [String] account_id Required parameter: User's account ID
     # @param [MessageRequest] body Required parameter: Example:
     # @return [BandwidthMessage] response from the API call
@@ -436,32 +446,33 @@ module Messaging
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise MessagingException.new(
           '404 Path not found',
           _response
         )
-      elsif _response.status_code == 415
+      when 415
         raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
-      elsif _response.status_code == 429
+      when 429
         raise MessagingException.new(
           '429 The rate limit has been reached',
           _response

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

@@ -19,14 +19,12 @@ module Bandwidth
 
     def validate_parameters(args)
       args.each do |_name, value|
-        if value.nil?
-          raise ArgumentError, "Required parameter #{_name} cannot be nil."
-        end
+        raise ArgumentError, "Required parameter #{_name} cannot be nil." if value.nil?
       end
     end
 
     def execute_request(request, binary: false)
-      @http_call_back.on_before_request(request) if @http_call_back
+      @http_call_back&.on_before_request(request)
 
       APIHelper.clean_hash(request.headers)
       request.headers.merge!(@global_headers)
@@ -36,7 +34,7 @@ module Bandwidth
                  else
                    config.http_client.execute_as_string(request)
                  end
-      @http_call_back.on_after_response(response) if @http_call_back
+      @http_call_back&.on_after_response(response)
 
       response
     end

data/lib/bandwidth/messaging_lib/messaging/exceptions/messaging_exception.rb

@@ -6,6 +6,9 @@
 module Bandwidth
   # MessagingException class.
   class MessagingException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :type
@@ -27,8 +30,8 @@ module Bandwidth
     # @param [Hash] The deserialized response sent by the server in the
     # response body.
     def unbox(hash)
-      @type = hash['type']
-      @description = hash['description']
+      @type = hash.key?('type') ? hash['type'] : SKIP
+      @description = hash.key?('description') ? hash['description'] : SKIP
     end
   end
 end

data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_callback_message.rb

@@ -6,6 +6,9 @@
 module Bandwidth
   # BandwidthCallbackMessage Model.
   class BandwidthCallbackMessage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :time
@@ -42,18 +45,35 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        time
+        type
+        to
+        error_code
+        description
+        message
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(time = nil,
                    type = nil,
                    to = nil,
                    error_code = nil,
                    description = nil,
                    message = nil)
-      @time = time
-      @type = type
-      @to = to
-      @error_code = error_code
-      @description = description
-      @message = message
+      @time = time unless time == SKIP
+      @type = type unless type == SKIP
+      @to = to unless to == SKIP
+      @error_code = error_code unless error_code == SKIP
+      @description = description unless description == SKIP
+      @message = message unless message == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -61,11 +81,11 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      time = hash['time']
-      type = hash['type']
-      to = hash['to']
-      error_code = hash['errorCode']
-      description = hash['description']
+      time = hash.key?('time') ? hash['time'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      to = hash.key?('to') ? hash['to'] : SKIP
+      error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
       message = BandwidthMessage.from_hash(hash['message']) if hash['message']
 
       # Create object from extracted values.