Sha256: 8e6bd7e8c75c20fe827a78a8ad388b430c151a8c56d49ace77799cd646882b22

Contents?: true

Size: 1.01 KB

Versions: 2

Compression:

Stored size: 1.01 KB

Contents

ruby-transmitsms
================

Ruby gem to easily access TransmitSMS RESTful APIs

### Sample Usage
```ruby
require 'ruby-transmitsms'

# Create new Sms instance
sms = Sms.new("15eg266c832fb23c4d90f01055aef355", "bluebird")

# Send a message
response = sms.send("Hello, world", "61455123456")

# Show the result
puts response.code
puts response.body
```

### Installation
```sh
gem install ruby-transmitsms
```

### Installation with `bundler`'s Gemfile
gem "ruby-transmitsms"

## Development

### To install the required gems:
```sh
$ ./setup.sh
```

### To run  the tests:
```sh
$ ./runtest.sh
```
## API

### Sms

**initialize**(api_key, api_secret) - Sms object constructor.

params:
* `api_key`
* `api_secret`

**send**(message, to, from, send_at, list_id, dlr_callback, reply_callback, validity, replies_to_email, from_shared) - Send sms to the given `to` param or `list_id` param.

params:
* `message`
* `to`
* `from`
* `send_at`
* `list_id`
* `dlr_callback`
* `reply_callback`
* `validity`
* `replies_to_email`
* `from_shared`

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
ruby-transmitsms-0.1.0 README.md
ruby-transmitsms-0.0.1 README.md