Getting Started with bandwidth

Bandwidth's set of APIs

Building

The generated code depends on a few Ruby gems. The references to these gems are added in the gemspec file. The easiest way to resolve the dependencies, build the gem and install it is through Rake:

1. Install Rake if not already installed: gem install rake
   1. Install Bundler if not already installed: gem install bundler
   2. From terminal/cmd navigate to the root directory of the SDK.
   3. Invoke: rake install

Alternatively, you can build and install the gem manually:

1. From terminal/cmd navigate to the root directory of the SDK.
   1. Run the build command: gem build bandwidth.gemspec
   2. Run the install command: gem install bandwidth-1.0.1.gem

Installation

The following section explains how to use the bandwidth ruby gem in a new Rails project using RubyMine™. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

1. Starting a new project

Close any existing projects in RubyMine™ by selecting File -> Close Project. Next, click on Create New Project to create a new project from scratch.

Next, provide TestApp as the project name, choose Rails Application as the project type, and click OK.

In the next dialog make sure that the correct Ruby SDK is being used (minimum 2.0.0) and click OK.

2. Add reference of the gem

In order to use the Tester gem in the new project we must add a gem reference. Locate the Gemfile in the Project Explorer window under the TestApp project node. The file contains references to all gems being used in the project. Here, add the reference to the library gem by adding the following line: gem 'bandwidth', '~> 1.0.1'

3. Adding a new Rails Controller

Once the TestApp project is created, a folder named controllers will be visible in the Project Explorer under the following path: TestApp > app > controllers. Right click on this folder and select New -> Run Rails Generator....

Selecting the said option will popup a small window where the generator names are displayed. Here, select the controller template.

Next, a popup window will ask you for a Controller name and included Actions. For controller name provide Hello and include an action named Index and click OK.

A new controller class named HelloController will be created in a file named hello_controller.rb containing a method named Index. In this method, add code for initialization and a sample for its usage.

Usage

To initialize the API client, the following parameters need to be passed.

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
timeout	Float	The value to use for connection timeout
max_retries	Integer	The number of times to retry an endpoint call if it fails
retry_interval	Float	Pause in seconds between retries
backoff_factor	Float	The amount to multiply each successive retry's interval amount by in order to provide backoff

The API client can be initialized using a Configuration object as following.

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

*