Sha256: 0c660f0c09752fd8eadf88dfbd90167220bce0417a3de1c009d385e9f059cc98

Contents?: true

Size: 1.24 KB

Versions: 3

Compression:

Stored size: 1.24 KB

Contents

# SmsghSms

This is a ruby wrapper that abstracts the SMSGH's SMS API. This gem has extra garnishing to make smsing via Ruby more tasteful and less painful.

## Installation

Add this line to your application's Gemfile:

    gem 'smsgh_sms'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install smsgh_sms

## Usage

Setup your SMSGH API username and password

	SmsghSms.api_username = "YOUR_USERNAME"
	SmsghSms.api_password = "YOUR_PASSWORD"
	
Optionally set global Sender ID

	SmsghSms.api_senderid = "YOUR_SENDERID"
	
Sending an SMS Message

	SmsghSms.push(:to => 'PHONE-NUMBER', :msg => "Your SMS Message goes here")
	
How to override the global SENDER ID config

	SmsghSms.push(:to => 'PHONE-NUMBER', :msg => "Your SMS Message goes here", :from => "SENDERID")
	
Sample Results Returned

	{:status=>200, :notice=>"OK: 62357215"}
	
Any returned status code other than 200 is a failed response.

## About SMSGH

SMSGH is the premier messaging company in Ghana. Find out more about them at http://smsgh.com

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
smsgh_sms-1.0.2 README.md
smsgh_sms-1.0.1 README.md
smsgh_sms-0.1.0 README.md