https://github.com/beyarz/ruby-cellsynt
Ruby gem for interacting with Cellsynt.com
https://github.com/beyarz/ruby-cellsynt
api cellsynt ruby sms
Last synced: over 1 year ago
JSON representation
Ruby gem for interacting with Cellsynt.com
- Host: GitHub
- URL: https://github.com/beyarz/ruby-cellsynt
- Owner: Beyarz
- Created: 2021-06-23T19:19:47.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-04T23:07:21.000Z (about 5 years ago)
- Last Synced: 2024-04-24T14:58:39.543Z (about 2 years ago)
- Topics: api, cellsynt, ruby, sms
- Language: Ruby
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ruby-cellsynt
Ruby gem for interacting with [Cellsynt.com](https://www.cellsynt.com/)
[](https://badge.fury.io/rb/ruby-cellsynt)
[](https://codescene.io/projects/16653)
## Coverage
This gem allows you to interact with every parameter Cellsynt's sms gateway [offers](https://www.cellsynt.com/pdf/Cellsynt_SMS_gateway_HTTP_interface_(English).pdf)
## Examples
### Send a plain sms with 450 characters
The message size is checked at runtime. If you reach over the limit of 160 characters then the content switches into a linkable sms which concatenates the content allowing you to reach up to 918 characters instead. The parameters is automatically adjusted so you don't have to think about that.
```ruby
require 'cellsynt'
instance = Cellsynt.new('username', 'password')
instance.config[:originator] = '0711223344'
instance.config[:destination] = '0711223344'
instance.config[:text] = 'A' * 450
puts instance.send # OK: 111AAA, 222BBB, 333CCC
```
### Send a flash sms using credentials from your environment
```ruby
require 'cellsynt'
# Your environment should have these variables set
# cellsyntUser='username'
# cellsyntPass='password'
instance = Cellsynt.new
instance.config[:originator] = '0711223344'
instance.config[:destination] = '0711223344'
instance.config[:text] = 'test'
instance.config[:flash] = true
puts instance.send # OK: 123ABC
```
For more examples see [EXAMPLES.md](EXAMPLES.md)
## Installation
### Gem
`gem install ruby-cellsynt`
### Bundle
`bundle add ruby-cellsynt`
### Gemfile
`gem 'ruby-cellsynt', '~> 1.0'`
## Dev
### Getting started
`bundle install`
### Lint
`rubocop`
## License
MIT