Project

isms-ruby

0.0
No commit activity in last 3 years
No release in over 3 years
A gem to interface with iSMS's API (www.isms.com.my) for SMS sending.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.7
~> 10.0
~> 3.2.0

Runtime

~> 0.9.1
 Project Readme

isms-ruby

A wrapper gem for iSMS (Malaysia) API.

Check www.isms.com.my for API documentation.

Currently only supports sending SMS.

Installation

Add this line to your application's Gemfile:

gem 'isms-ruby'

And then execute:

$ bundle

Or install it yourself as:

$ gem install isms-ruby

Usage

In an initializer file, configure as follows:

require 'isms'

ISMS.configure do |config|
  config.username = ENV['ISMS_USERNAME'] || 'username'
  config.password = ENV['ISMS_PASSWORD'] || 'password'
  config.protocol = 'https'
end

Then, initialize a client and send an SMS as follows:

client = ISMS::Client.new
response = client.send_sms('Hello world!', '60121231234')

# => { code: 200, description: 'SUCCESS' }
# => { code: -1001, description: 'AUTHENTICATION FAILED' }
# etc.

Check out other response codes at http://isms.com.my/response_result.php

Contributing

  1. Fork it ( https://github.com/ernsheong/isms-ruby/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

To run the specs:

$ bundle exec rspec