bandwidth-sdk 0.1.0

data/lib/bandwidth/exceptions/api_exception.rb

@@ -0,0 +1,20 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < StandardError
+    attr_reader :response, :response_code
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason)
+      @response = response
+      @response_code = response.status_code
+    end
+  end
+end

data/lib/bandwidth/http/api_response.rb

@@ -0,0 +1,36 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Http response received.
+  class ApiResponse
+    attr_reader(:status_code, :reason_phrase, :headers, :raw_body, :request,
+                :data, :errors)
+
+    # The constructor
+    # @param [HttpResponse] The original, raw response from the api.
+    # @param [Object] The data field specified for the response.
+    # @param [Array<String>] Any errors returned by the server.
+    def initialize(http_response,
+                   data: nil,
+                   errors: nil)
+      @status_code = http_response.status_code
+      @reason_phrase = http_response.reason_phrase
+      @headers = http_response.headers
+      @raw_body = http_response.raw_body
+      @request = http_response.request
+      @data = data
+      @errors = errors
+    end
+
+    def success?
+      status_code >= 200 && status_code < 300
+    end
+
+    def error?
+      status_code >= 400 && status_code < 600
+    end
+  end
+end

data/lib/bandwidth/http/auth/voice_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 VoiceBasicAuth
+    # 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.voice_basic_auth_user_name
+      password = config.voice_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

@@ -0,0 +1,64 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'faraday/http_cache'
+require 'faraday_middleware'
+
+module Bandwidth
+  # An implementation of HttpClient.
+  class FaradayClient < HttpClient
+    # The constructor.
+    def initialize(timeout:, max_retries:, retry_interval:,
+                   backoff_factor:, cache: false, verify: true)
+      @connection = Faraday.new do |faraday|
+        faraday.use Faraday::HttpCache, serializer: Marshal if cache
+        faraday.use FaradayMiddleware::FollowRedirects
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.ssl[:ca_file] = Certifi.where
+        faraday.ssl[:verify] = verify
+        faraday.request :retry, max: max_retries, interval: retry_interval,
+                                backoff_factor: backoff_factor
+        faraday.adapter Faraday.default_adapter
+        faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
+        faraday.options[:timeout] = timeout if timeout > 0
+      end
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_string(http_request)
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
+        request.headers = http_request.headers
+        unless http_request.parameters.empty?
+          request.body = http_request.parameters
+        end
+      end
+      convert_response(response, http_request)
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_binary(http_request)
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
+        request.headers = http_request.headers
+        unless http_request.parameters.empty?
+          request.body = http_request.parameters
+        end
+      end
+      convert_response(response, http_request)
+    end
+
+    # Method overridden from HttpClient.
+    def convert_response(response, http_request)
+      HttpResponse.new(response.status, response.reason_phrase,
+                       response.headers, response.body, http_request)
+    end
+  end
+end

data/lib/bandwidth/http/http_call_back.rb

@@ -0,0 +1,24 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack
+    # A controller will call this method before making an HTTP Request.
+    # @param [HttpRequest] The HttpRequest object which the HttpClient
+    # will execute.
+    def on_before_request(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # A controller will call this method after making an HTTP Request.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def on_after_response(_http_response)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+  end
+end

data/lib/bandwidth/http/http_client.rb

@@ -0,0 +1,104 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # An interface for the methods that an HTTP Client must implement.
+  #
+  # This class should not be instantiated but should be used as a base class
+  # for HTTP Client classes.
+  class HttpClient
+    # Execute an HttpRequest when the response is expected to be a string.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_string(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Execute an HttpRequest when the response is expected to be binary.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_binary(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Converts the HTTP Response from the client to an HttpResponse object.
+    # @param [Dynamic] The response object received from the client.
+    def convert_response(_response)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Get a GET HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def get(query_url,
+            headers: {})
+      HttpRequest.new(HttpMethodEnum::GET,
+                      query_url,
+                      headers: headers)
+    end
+
+    # Get a HEAD HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def head(query_url,
+             headers: {})
+      HttpRequest.new(HttpMethodEnum::HEAD,
+                      query_url,
+                      headers: headers)
+    end
+
+    # Get a POST HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def post(query_url,
+             headers: {},
+             parameters: {})
+      HttpRequest.new(HttpMethodEnum::POST,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a PUT HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def put(query_url,
+            headers: {},
+            parameters: {})
+      HttpRequest.new(HttpMethodEnum::PUT,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a PATCH HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def patch(query_url,
+              headers: {},
+              parameters: {})
+      HttpRequest.new(HttpMethodEnum::PATCH,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a DELETE HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def delete(query_url,
+               headers: {},
+               parameters: {})
+      HttpRequest.new(HttpMethodEnum::DELETE,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+  end
+end

data/lib/bandwidth/http/http_method_enum.rb

@@ -0,0 +1,13 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum
+    HTTPMETHODENUM = [GET = 'GET'.freeze, POST = 'POST'.freeze,
+                      PUT = 'PUT'.freeze, PATCH = 'PATCH'.freeze,
+                      DELETE = 'DELETE'.freeze, HEAD = 'HEAD'.freeze].freeze
+  end
+end

data/lib/bandwidth/http/http_request.rb

@@ -0,0 +1,50 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Represents a single Http Request.
+  class HttpRequest
+    attr_accessor :http_method, :query_url, :headers,
+                  :parameters, :username, :password
+
+    # The constructor.
+    # @param [HttpMethodEnum] The HTTP method.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def initialize(http_method,
+                   query_url,
+                   headers: {},
+                   parameters: {})
+      @http_method = http_method
+      @query_url = query_url
+      @headers = headers
+      @parameters = parameters
+    end
+
+    # Add a header to the HttpRequest.
+    # @param [String] The name of the header.
+    # @param [String] The value of the header.
+    def add_header(name, value)
+      @headers[name] = value
+    end
+
+    # Add a parameter to the HttpRequest.
+    # @param [String] The name of the parameter.
+    # @param [String] The value of the parameter.
+    def add_parameter(name, value)
+      @parameters[name] = value
+    end
+
+    # Add a query parameter to the HttpRequest.
+    # @param [String] The name of the query parameter.
+    # @param [String] The value of the query parameter.
+    def add_query_parameter(name, value)
+      @query_url = APIHelper.append_url_with_query_parameters(@query_url,
+                                                              name => value)
+      @query_url = APIHelper.clean_url(@query_url)
+    end
+  end
+end

data/lib/bandwidth/http/http_response.rb

@@ -0,0 +1,29 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Http response received.
+  class HttpResponse
+    attr_reader :status_code, :reason_phrase, :headers, :raw_body, :request
+
+    # The constructor
+    # @param [Integer] The status code returned by the server.
+    # @param [String] The reason phrase returned by the server.
+    # @param [Hash] The headers sent by the server in the response.
+    # @param [String] The raw body of the response.
+    # @param [HttpRequest] The request that resulted in this response.
+    def initialize(status_code,
+                   reason_phrase,
+                   headers,
+                   raw_body,
+                   request)
+      @status_code = status_code
+      @reason_phrase = reason_phrase
+      @headers = headers
+      @raw_body = raw_body
+      @request = request
+    end
+  end
+end

data/lib/bandwidth/models/base_model.rb

@@ -0,0 +1,36 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Base model.
+  class BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..-1]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+        if value.instance_of? Array
+          hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+        elsif value.instance_of? Hash
+          hash[key] = {}
+          value.each do |k, v|
+            hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+          end
+        else
+          hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+        end
+      end
+      hash
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash.reject { |k, v| v.nil? }
+      hash.to_json(options)
+    end
+  end
+end

data/lib/bandwidth/voice_lib/voice.rb

@@ -0,0 +1,23 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+
+require_relative 'voice/client.rb'
+
+# Models
+require_relative 'voice/models/api_call_response.rb'
+require_relative 'voice/models/api_create_call_request.rb'
+require_relative 'voice/models/api_modify_call_request.rb'
+require_relative 'voice/models/bandwidth_callback_message_voice.rb'
+require_relative 'voice/models/answer_method_enum.rb'
+require_relative 'voice/models/disconnect_method_enum.rb'
+require_relative 'voice/models/redirect_method_enum.rb'
+require_relative 'voice/models/state_enum.rb'
+
+require_relative 'voice/bxml/bxml.rb'
+
+# Controllers
+require_relative 'voice/controllers/base_controller.rb'
+require_relative 'voice/controllers/calls_controller.rb'

data/lib/bandwidth/voice_lib/voice/bxml/bxml.rb

@@ -0,0 +1,36 @@
+require 'builder'
+Dir[File.dirname(__FILE__) + '/verbs/*'].each {|file|
+  require_relative file
+}
+
+module Bandwidth
+	module Voice
+	  class Response
+	    # Initializer
+	    # @param verbs [Array] optional list of verbs to include into response
+	    def initialize(verbs = nil)
+	      @verbs = verbs || []
+	    end
+
+	    # Return XML presentaion of this response
+	    def to_xml()
+	      xml = Builder::XmlMarkup.new()
+	      xml.instruct!(:xml, :version=>'1.0', :encoding=>'UTF-8')
+	      xml.Response do
+	        @verbs.each {|verb| verb.to_xml(xml)}
+	      end
+	      xml.target!()
+	    end
+
+	    # Add one or more verbs to this response
+	    def push(*verbs)
+	      @verbs.push(*verbs)
+	    end
+
+	    # Add a verb to this response
+	    def <<(verb)
+	      @verbs << verb
+	    end
+	  end
+	end
+end