The Releans SDK enables developers to use Releans Services in their code. You can get started in minutes.
This client library is a Ruby gem which can be compiled and used in your Ruby and Ruby on Rails project. This library requires a few gems from the RubyGems repository.
- Open the command line interface or the terminal and navigate to the folder containing the source code.
- Run
gem build releans_api.gemspecto build the gem. - Once built, the gem can be installed on the current work environment using
gem install releans_api-1.1.0.gem
The following section explains how to use the ReleansApi 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.
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 correct Ruby SDK is being used (minimum 2.0.0) and click OK.
This will create a new Rails Application project with an existing set of files and folder.
In order to use the ReleansApi 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 'releans_api', '~> 1.1.0'
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 anmed 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.
You can test the generated SDK and the server with automatically generated test cases as follows:
- From terminal/cmd navigate to the root directory of the SDK.
- Invoke:
bundle exec rake
In order to setup authentication and initialization of the API client, you need the following information.
| Parameter | Description |
|---|---|
| o_auth_access_token | OAuth 2.0 Access Token |
API client can be initialized as following.
# Configuration parameters and credentials
o_auth_access_token = 'o_auth_access_token' # OAuth 2.0 Access Token
client = ReleansApi::ReleansApiClient.new(
o_auth_access_token: o_auth_access_token
)The added initlization code can be debugged by putting a breakpoint in the Index method and running the project in debug mode by selecting Run -> Debug 'Development: TestApp'.
The singleton instance of the MessageController class can be accessed from the API Client.
message_controller = client.message
List all messages sent by the account.
def get_all_messages(accept); end| Parameter | Tags | Description |
|---|---|---|
| accept | Required |
TODO: Add a parameter description |
accept = '*/*'
result = message_controller.get_all_messages(accept)Return the details of the message.
def get_view_message(id,
accept); end| Parameter | Tags | Description |
|---|---|---|
| id | Required |
TODO: Add a parameter description |
| accept | Required |
TODO: Add a parameter description |
id = 'id'
accept = '*/*'
result = message_controller.get_view_message(id, accept)Send a single message.
def create_send_sms_message(accept,
sender_id,
mobile_number,
message); end| Parameter | Tags | Description |
|---|---|---|
| accept | Required |
TODO: Add a parameter description |
| sender_id | Required |
Sender id to send the message from. |
| mobile_number | Required |
The mobile number supposed to receive the message. |
| message | Required |
Message text. |
accept = 'Accept'
sender_id = 'senderId'
mobile_number = 'mobileNumber'
message = 'message'
result = message_controller.create_send_sms_message(accept, sender_id, mobile_number, message)The singleton instance of the SenderController class can be accessed from the API Client.
sender_controller = client.senderReturn the details of the sender name.
def get_sender_name_details(id,
accept); end| Parameter | Tags | Description |
|---|---|---|
| id | Required |
TODO: Add a parameter description |
| accept | Required |
TODO: Add a parameter description |
id = 'sender-id'
accept = '*/*'
result = sender_controller.get_sender_name_details(id, accept)Create a new sender id to send messages using it
def create_sender_name(accept,
content_type,
body); end| Parameter | Tags | Description |
|---|---|---|
| accept | Required |
TODO: Add a parameter description |
| content_type | Required |
TODO: Add a parameter description |
| body | Required |
TODO: Add a parameter description |
accept = 'text/plain'
content_type = 'text/plain'
body = 'Your sender name'
result = sender_controller.create_sender_name(accept, content_type, body)List all senders names associated with the account
def get_all_senders(accept); end| Parameter | Tags | Description |
|---|---|---|
| accept | Required |
TODO: Add a parameter description |
accept = '*/*'
result = sender_controller.get_all_senders(accept)The singleton instance of the BalanceController class can be accessed from the API Client.
balance_controller = client.balanceGet your available balance
def get_balance(accept); end| Parameter | Tags | Description |
|---|---|---|
| accept | Required |
TODO: Add a parameter description |
accept = 'text/plain'
result = balance_controller.get_balance(accept)