bandwidth-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dda3a64e6345a2b4b57ff3e2ef4925b1aa325dd6
+  data.tar.gz: 579af4d2e8973ebf0577bcb86be0a1cea0186dcc
+SHA512:
+  metadata.gz: ec54ff2a4c0da9ca4e0da7125ef1ea4eb5ba480eccbb2bdfb53ae5336a18ddb177d1a8e4416f2f4db01fafc257fa9b2205dd797f2c6f8e77148b021416b2d906
+  data.tar.gz: da2b2fed5ae62674e1b6cfdd47df80157f599d61c7abfb139e07b1bce1f38944c15b5d296e42aa390113461fff47d3f91e2de2e663807eea6afcfa051ad27102

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2016 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1 @@
+# Bandwidth's Ruby SDK

data/lib/bandwidth.rb

@@ -0,0 +1,37 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+require 'json'
+require 'faraday'
+require 'certifi'
+require 'logging'
+
+require_relative 'bandwidth/api_helper.rb'
+require_relative 'bandwidth/client.rb'
+
+# Http
+require_relative 'bandwidth/http/api_response.rb'
+require_relative 'bandwidth/http/http_call_back.rb'
+require_relative 'bandwidth/http/http_client.rb'
+require_relative 'bandwidth/http/faraday_client.rb'
+require_relative 'bandwidth/http/http_method_enum.rb'
+require_relative 'bandwidth/http/http_request.rb'
+require_relative 'bandwidth/http/http_response.rb'
+
+# Models
+require_relative 'bandwidth/models/base_model.rb'
+
+# Exceptions
+require_relative 'bandwidth/exceptions/api_exception.rb'
+
+require_relative 'bandwidth/configuration.rb'
+
+# Namespaces
+require_relative 'bandwidth/voice_lib/voice'
+require_relative 'bandwidth/http/auth/voice_basic_auth.rb'
+
+
+# Controllers

data/lib/bandwidth/api_helper.rb

@@ -0,0 +1,280 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # API utility class
+  class APIHelper
+    # Serializes an array parameter (creates key value pairs).
+    # @param [String] The name of the parameter.
+    # @param [Array] The value of the parameter.
+    # @param [String] The format of the serialization.
+    def self.serialize_array(key, array, formatting: 'indexed')
+      tuples = []
+
+      if formatting == 'unindexed'
+        tuples += array.map { |element| ["#{key}[]", element] }
+      elsif formatting == 'indexed'
+        tuples += array.map.with_index do |element, index|
+          ["#{key}[#{index}]", element]
+        end
+      elsif formatting == 'plain'
+        tuples += array.map { |element| [key, element] }
+      else
+        raise ArgumentError, 'Invalid format provided.'
+      end
+      tuples
+    end
+
+    # Replaces template parameters in the given url.
+    # @param [String] The query string builder to replace the template
+    # parameters.
+    # @param [Hash] The parameters to replace in the url.
+    def self.append_url_with_template_parameters(query_builder, parameters)
+      # perform parameter validation
+      unless query_builder.instance_of? String
+        raise ArgumentError, 'Given value for parameter \"query_builder\" is
+          invalid.'
+      end
+
+      # 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?
+          replace_value = ''
+        elsif value.instance_of? Array
+          value.map! { |element| CGI.escape(element.to_s) }
+          replace_value = value.join('/')
+        else
+          replace_value = CGI.escape(value.to_s)
+        end
+
+        # Find the template parameter and replace it with its value.
+        query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+      end
+      query_builder
+    end
+
+    # 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')
+      # Perform parameter validation.
+      unless query_builder.instance_of? String
+        raise ArgumentError, 'Given value for parameter \"query_builder\"
+          is invalid.'
+      end
+
+      # Return if there are no parameters to replace.
+      return query_builder if parameters.nil?
+
+      parameters.each do |key, value|
+        seperator = query_builder.include?('?') ? '&' : '?'
+        unless value.nil?
+          if value.instance_of? Array
+            value.compact!
+            query_builder += if array_serialization == 'csv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join(',')}"
+                             elsif array_serialization == 'psv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join('|')}"
+                             elsif array_serialization == 'tsv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join("\t")}"
+                             else
+                               "#{seperator}#{APIHelper.serialize_array(
+                                 key, value, formatting: array_serialization
+                               ).map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }
+                               .join('&')}"
+                             end
+          else
+            query_builder += "#{seperator}#{key}=#{CGI.escape(value.to_s)}"
+          end
+        end
+      end
+      query_builder
+    end
+
+    # Validates and processes the given Url.
+    # @param [String] The given Url to process.
+    # @return [String] Pre-processed Url as string.
+    def self.clean_url(url)
+      # Perform parameter validation.
+      raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
+
+      # Ensure that the urls are absolute.
+      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+
+      # Get the http protocol match.
+      protocol = matches[1]
+
+      # Check if parameters exist.
+      index = url.index('?')
+
+      # Remove redundant forward slashes.
+      query = url[protocol.length...(!index.nil? ? index : url.length)]
+      query.gsub!(%r{\/\/+}, '/')
+
+      # Get the parameters.
+      parameters = !index.nil? ? url[url.index('?')...url.length] : ''
+
+      # Return processed url.
+      protocol + query + parameters
+    end
+
+    # Parses JSON string.
+    # @param [String] A JSON string.
+    def self.json_deserialize(json)
+      return JSON.parse(json)
+    rescue StandardError
+      raise TypeError, 'Server responded with invalid JSON.'
+    end
+
+    # Removes elements with empty values from a hash.
+    # @param [Hash] The hash to clean.
+    def self.clean_hash(hash)
+      hash.delete_if { |_key, value| value.to_s.strip.empty? }
+    end
+
+    # 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')
+      encoded = {}
+      form_parameters.each do |key, value|
+        encoded.merge!(APIHelper.form_encode(value, key, formatting:
+          array_serialization))
+      end
+      encoded
+    end
+
+    def self.custom_merge(a, b)
+      x = {}
+      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|
+              x[k].push(v)
+            end
+          else
+            x[k].push(value_a)
+          end
+          if value_b.instance_of? Array
+            value_b.each do |v|
+              x[k].push(v)
+            end
+          else
+            x[k].push(value_b)
+          end
+          a.delete(k)
+          b.delete(k)
+        end
+      end
+      x.merge!(a)
+      x.merge!(b)
+      x
+    end
+
+    # Form encodes an object.
+    # @param [Dynamic] An object to form encode.
+    # @param [String] The name of the object.
+    # @return [Hash] A form encoded representation of the object in the form
+    # of a hash.
+    def self.form_encode(obj, instance_name, formatting: 'indexed')
+      retval = {}
+
+      serializable_types = [String, Numeric, TrueClass,
+                            FalseClass, Date, DateTime]
+
+      # If this is a structure, resolve it's field names.
+      obj = obj.to_hash if obj.is_a? BaseModel
+
+      # Create a form encoded hash for this object.
+      if obj.nil?
+        nil
+      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 + ']'))
+          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 + '[]',
+                                          formatting: formatting)
+                  else
+                    APIHelper.form_encode(value, instance_name,
+                                          formatting: formatting)
+                  end
+            retval = APIHelper.custom_merge(retval, abc)
+          end
+        else
+          obj.each_with_index do |value, index|
+            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
+              index.to_s + ']', 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))
+        end
+      else
+        retval[instance_name] = obj
+      end
+      retval
+    end
+
+    # Retrieves a field from a Hash/Array based on an Array of keys/indexes
+    # @param [Hash, Array] The hash to extract data from
+    # @param [Array<String, Integer>] The keys/indexes to use
+    # @return [Object] The extracted value
+    def self.map_response(obj, keys)
+      val = obj
+      begin
+        keys.each do |key|
+          val = if val.is_a? Array
+                  if key.to_i.to_s == key
+                    val[key.to_i]
+                  else
+                    val = nil
+                  end
+                else
+                  val.fetch(key.to_sym)
+                end
+        end
+      rescue NoMethodError, TypeError, IndexError
+        val = nil
+      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

@@ -0,0 +1,32 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  #  bandwidth client class.
+  class Client
+    attr_reader :config
+    # Access to voice_client controller.
+    # @return [Voice::Client] Returns the client instance.
+    def voice_client
+      @voice_client ||= Voice::Client.new(config: config)
+    end
+
+    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
+                   backoff_factor: 1, environment: Environment::PRODUCTION,
+                   voice_basic_auth_user_name: 'TODO: Replace',
+                   voice_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,
+                                    voice_basic_auth_user_name: voice_basic_auth_user_name,
+                                    voice_basic_auth_password: voice_basic_auth_password)
+                else
+                  config
+                end
+    end
+  end
+end

data/lib/bandwidth/configuration.rb

@@ -0,0 +1,111 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze,
+      VOICEDEFAULT = 'VoiceDefault'.freeze
+    ].freeze
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # 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 :environment
+    attr_reader :voice_basic_auth_user_name
+    attr_reader :voice_basic_auth_password
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
+                   backoff_factor: 1, environment: Environment::PRODUCTION,
+                   voice_basic_auth_user_name: 'TODO: Replace',
+                   voice_basic_auth_password: 'TODO: Replace')
+      # The value to use for connection timeout
+      @timeout = timeout
+
+      # The number of times to retry an endpoint call if it fails
+      @max_retries = max_retries
+
+      # Pause in seconds between retries
+      @retry_interval = retry_interval
+
+      # The amount to multiply each successive retry's interval amount
+      # by in order to provide backoff
+      @backoff_factor = backoff_factor
+
+      # Current API environment
+      @environment = environment
+
+      # 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 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,
+                   voice_basic_auth_user_name: nil,
+                   voice_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
+      voice_basic_auth_user_name ||= self.voice_basic_auth_user_name
+      voice_basic_auth_password ||= self.voice_basic_auth_password
+
+      Configuration.new(timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        environment: environment,
+                        voice_basic_auth_user_name: voice_basic_auth_user_name,
+                        voice_basic_auth_password: voice_basic_auth_password)
+    end
+
+    def create_http_client
+      FaradayClient.new(timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor)
+    end
+
+    # All the environments the SDK can run in.
+    @environments = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'api.bandwidth.com',
+        Server::VOICEDEFAULT => 'https://voice.bandwidth.com'
+      }
+    }
+
+    # 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
+    end
+  end
+end