sendout 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 706fa9e63a38a65a0f1ba595ce0a271934bbe583
-  data.tar.gz: 5d4aa896e141a7af735f6ce81ec923f2c3b88905
+  metadata.gz: 29cb2c668bb07e4485bc82d69d76625051f7b6ab
+  data.tar.gz: da5c7b91628f1db64659c58c7be7348615d51ba8
 SHA512:
-  metadata.gz: 0ac85d630b16c4a6ff0373007ff627b0790270d3d7b3f1e33ebf1693b71233fd76b518e35ef1913449d71cbcf7ed17dfffc057d6bdb61c6c895fe3ebb930fd77
-  data.tar.gz: ee8419630468706004c6351b249e0393ae2c84802f70a23cbd19ff38dd8d2ab2b88e02bf3f468235fa8d25a2be20191332891a92b0f4a0ecc57e3ccee98b263d
+  metadata.gz: 171169a51130caea135c360a42880bc34df565e56bca613024a4a0d4a6c4e1fb4511f6b1fd5687fcc0769637281f82e67d35c810ba3a3015817fd0144721030d
+  data.tar.gz: a64f321c4fe168052d0f961a0b2d98dca945a65969386e00327a3c68291aca788562c6f54bdeeaf2f65e11cc725960d4f76de2f5d5c8c59ef55f30a5199bdbf2

data/README.md

@@ -1,8 +1,6 @@
 # Sendout
 
-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/sendout`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A ruby gem createb by [SmartTechys](http://www.smarttechys.co.ao) for the [SendOut](https://www.sendoutapp.com) API that allows your application to send text messages (Angolan and International).
 
 ## Installation
 
@@ -20,22 +18,63 @@ Or install it yourself as:
 
     $ gem install sendout
 
+## Setup
+
+- Make sure you've registed at [SendOut](https://www.sendoutapp.com) and have produced your token(api_token) and id(your registered phone number).
+- Setup your environments variables
+```ruby
+SO_API_ID=244911222333
+SO_API_TOKEN=your_api_token_obtained_from_control_panel_at_sendout
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+At the moment there's only two sendOut endpoints in production:
 
-## Development
+- Check your balance
+- Send one or bulk message
+
+### Check your balance
+
+```ruby
+Sendout.check_balance
+
+# It will return a json
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+{ 
+  "cliente": {
+     "saldo": "512"
+     "enviada": "203"
+  } 
+}
+```
+
+### Send one or bulk message
+
+```ruby
+Sendout.send_sms(num, msg)
+
+# The num has to be an array and the msg an string. This method will return a boolean
+```
+## Help and Docs
+
+- [SendOut](https://www.sendoutapp.com)
+- [RDoc](https://www.rubydoc.info/gems/0.1.0)
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Development
+
+- You can fork it
+- bundle
+- bundle rake exec
+- Make your feature addition or fix a bug
+- Do not  mess with the rakefile version or history (do not submit version bump PLEASE or put it in a different commit so we can ignore it when pull)
+- Send us the pull request
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sendout. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/smaziano/sendout. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/sendout/version.rb

@@ -1,3 +1,3 @@
 module Sendout
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/sendout.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{A Ruby gem for SendOut API(https://www.sendoutapp.com) made by SmartTechys(http://smarttechys.co.ao).}
   spec.description   = %q{A ruby gem to connect your application with SendOut API to send text messages(Internacional) from Angola.}
-  spec.homepage      = "https://github.com/smaziano/sendout."
+  spec.homepage      = "https://github.com/smaziano/sendout"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendout
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sergio Maziano
@@ -84,8 +84,9 @@ files:
 - bin/setup
 - lib/sendout.rb
 - lib/sendout/version.rb
+- sendout-0.1.0.gem
 - sendout.gemspec
-homepage: https://github.com/smaziano/sendout.
+homepage: https://github.com/smaziano/sendout
 licenses:
 - MIT
 metadata: {}