smsbroadcast 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c97e287dce2421a0301dd85e52b4bdfcc265c772
-  data.tar.gz: 8a40d215ccd885df4b3468f655b9b26b25a10325
+  metadata.gz: 6a7fc95a06e596a56ab44ff53b7e523f0297362c
+  data.tar.gz: 0ce874a98434cf5fc8a282f6bc9def261adc68b2
 SHA512:
-  metadata.gz: bcf6143d6bdfbe2409bb0a2168e8b8f104b6381ce2425ed39bc3157821b81d82475bb0078b09494ae72bfed032ee2a0d8fbd3e9acf4d904178b5d577b5d117a6
-  data.tar.gz: 5831fee56b3feed4575ea6529e7665dc25412851d4f4159a920a217edbadd8b6b09bdeacfbe0cf805c80c17ae1bbe4e688a872f3b713051d27668ebce7514344
+  metadata.gz: e29a515633110d1c4de90b3c24052059888cf14d8e907b856f3a5e47482c8d8eb842d11f56781b33ecb34da1c6002307ebfa3de4b736b4c70d23d6d6629660a3
+  data.tar.gz: 6b0c7b0b72e20a73720969d97d448a92c7941f93ec24d438b42f5dd452c3669a98404f4f782e987d187946fcbbe354f9811c9468992c261eda2dee8ce0662dcf

data/README.md

@@ -1,8 +1,5 @@
 # Smsbroadcast
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/smsbroadcast`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Convenience wrapper for sending sms messages using www.smsbroadcast.com.au
 
 ## Installation
 
@@ -20,9 +17,53 @@ Or install it yourself as:
 
     $ gem install smsbroadcast
 
-## Usage
+## Configuration
+Put the following in an initializer or somewhere in your initialization flow.
+
+```ruby
+Smsbroadcast.configure do |config|
+  config.from     = "some company"
+  config.username = ENV['SMSBROADCAST_USERNAME']
+  config.password = ENV['SMSBROADCAST_PASSWORD]
+
+# OPTIONAL BELOW
+  config.url = "https://api.smsbroadcast.com.au/"
+  config.maxsplit = "1"
+  config.delay = "0"
+end
+```
+
+## Send an SMS
 
-TODO: Write usage instructions here
+```ruby
+sms = Smsbroadcast::Sms.new({
+  to: '0499999999', # or ['0499999999', '0411111111'] up to 1000 numbers
+  message: 'some message text',
+
+  # OPTIONAL BELOW
+  from: 'some company',
+  maxsplit: '1',
+  delay: '0'
+})
+
+response = sms.deliver
+
+response.status  #=> 'some status that smsbroadcast supports'
+response.number  #=> 'the number'
+response.ref     #=> 'the reference'
+response.message #=> 'the message
+```
+
+## Get Account Status
+Can't remember if this works. It's a bit weird, probably was meant to be like status = Smsbroadcast::GetStatus.call() or somesuch.
+
+```ruby
+  status = Smsbroadcast::Status.new
+  status.call()
+  status.status  #=> some status stuff
+  status.balance #=> your balance as a string? i don't remember
+  status.message #=> some sort of lovely message from the team at smsbroadcast?
+```
 
 ## Development
 

data/lib/smsbroadcast.rb

@@ -9,7 +9,6 @@ end
 
 Smsbroadcast.configure do |config|
   config.url = "https://api.smsbroadcast.com.au/"
-  config.from = "getFoodi"
   config.maxsplit = "1"
   config.delay = "0"
 end

data/lib/smsbroadcast/version.rb

@@ -1,3 +1,3 @@
 module Smsbroadcast
-  VERSION = "1.1.4"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smsbroadcast
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - sia.s.saj
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-30 00:00:00.000000000 Z
+date: 2018-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday