Skebby Gem Version Build Status Dependency Status Code Climate

This is a Ruby gem providing a wrapper around Skebby's RESTful API.

Installation

Add this line to your application's Gemfile:

gem 'skebby'

And then execute:

$ bundle

Or install it yourself as:

$ gem install skebby

Usage

Initialize the client

To initialize the API client you only need to provide your credentials:

skebby = Skebby::Client.new(username: 'john.doe', password: 'foobar')

Check the remaining credit

skebby.get_credit # { credit_left: 1.61972, classic_sms: 25, basic_sms: 35 }

Send an SMS (SMS Classic)

skebby.send_sms_classic(
  recipients: ['393459187391', '393786104981'],
  text:       'Hello, world!'
) # { remaining_sms: 5 }

(Note: You can provide other parameters. For more info, check Skebby's docs).

Send an SMS (SMS Basic)

skebby.send_sms_basic(
  recipients: ['393459187391', '393786104981'],
  text:       'Hello, world!'
) # { remaining_sms: 5 }

(Note: You can provide other parameters. For more info, check Skebby's docs).

Send an SMS and request a read-receipt (SMS Classic Plus)

skebby.send_sms_classic_report(
  recipients: ['393459187391', '393786104981'],
  text:       'Hello, world!'
) # { remaining_sms: 5, dispatch_id: 1392562134 }

(Note: You can provide other parameters. For more info, check Skebby's docs).

Contributing

  1. Fork it
  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