<commit_before># Skebby

TODO: Write a gem description

## Installation

Add this line to your application's Gemfile:

    gem 'skebby'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install skebby

## Usage

TODO: Write usage instructions here

## Contributing

1. [Fork it](http://github.com/interconn/skebby/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<commit_msg>Update README with usage instructions<commit_after># Skebby

This is a Ruby gem providing a wrapper around [Skebby](http://www.skebby.it/) 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:

```ruby
skebby = Skebby::Client.new(username: 'john.doe', password: '<PASSWORD>')
```

### Check the remaining credit

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

### Send an SMS (SMS Classic)

```ruby
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](http://www.skebby.it/business/index/send-docs/)).

### Send an SMS (SMS Basic)

```ruby
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](http://www.skebby.it/business/index/send-docs/)).

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

```ruby
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](http://www.skebby.it/business/index/send-docs/)).

## Contributing

1. [Fork it](http://github.com/interconn/skebby/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
{'fraction_non_alphanumeric': 0.13387755102040816, 'fraction_numerical': 0.04285714285714286, 'mean_word_length': 4.10625, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 0, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1804097', 'n_tokens_mistral': 938, 'n_tokens_neox': 829, 'n_words': 272}