Project

locasms

0.01
Low commit activity in last 3 years
No release in over a year
locasmsmcorp/locasmsHomepageDocumentationSource CodeBug TrackerWiki
Cliente para o serviço de disparo de SMS da LocaSMS e de sua versão para Short Code SMS (SMS Plataforma)
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
33,140
Stars
4
Forks
7
Watchers
4
 Releases
Current version
1.1.0
Total releases
14
First release
2013-10-12
Latest release
2022-10-29
 Issues
Open Issues
2
Closed Issues
11
Total Issues
13
Issue Closure Rate
84%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
2
Merged Pull Requests
25
Pull Request Acceptance Rate
92%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2020-01-06
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
rake
~> 13.0
rspec
~> 3.11
simplecov
~> 0.21
timecop
~> 0.9
yard
~> 0.9
rubocop
~> 1.36
rubocop-performance
~> 1.15
rubocop-rake
~> 0.6
rubocop-rspec
~> 2.13

Runtime

multi_json
~> 1.13
 Project Readme

locasms

Gem Version Code Climate CC Coverage Inline docs

⚠️ After February, 10, 2018 the base IP of the service will change as noticed on this issue. If you don't upgrade to version 0.3.1 your app will stop delivering SMS.

Client to consume API's from LocaSMS and its Short Code SMS version SMS Plataforma.

Installation

Add this line to your application's Gemfile:

gem 'locasms'

And then execute:

$ bundle

Or install it yourself as:

$ gem install locasms

Usage

Simple example:

require 'locasms'

# Default:
cli = LocaSMS::Client.new 'LOGIN', 'PASSWORD'

# Short Code:
cli = LocaSMS::Client.new 'LOGIN', 'PASSWORD', type: :shortcode

# With default url callback (optional):
cli = LocaSMS::Client.new 'LOGIN', 'PASSWORD', url_callback: 'http://url.to/callback'

# delivering message to one mobile
cli.deliver 'my message', '1155559999'

# delivering the same message to multiple mobliles at once
cli.deliver 'my message', '1199998888,5500002222'
cli.deliver 'my message', '1199998888', '5500002222'
cli.deliver 'my message', ['1199998888', '5500002222']
cli.deliver 'my message', %w(1199998888 5500002222)

# delivering message with url callback
cli.deliver 'my message', '1155559999', url_callback: 'http://url.to/callback'

# scheduling the deliver of a message to one mobile
cli.deliver_at 'my message', '2013-10-12 20:33:00', '1155559999'

# scheduling the deliver of a message to multiple mobiles at once
cli.deliver_at 'my message', '2013-10-12 20:33:00', '1199998888,5500002222'
cli.deliver_at 'my message', '2013-10-12 20:33:00', '1199998888', '5500002222'
cli.deliver_at 'my message', '2013-10-12 20:33:00', ['1199998888', '5500002222']
cli.deliver_at 'my message', '2013-10-12 20:33:00', %w(1199998888 5500002222)

# scheduling the deliver of a message with url callback
cli.deliver_at 'my message', '2013-10-12 20:33:00', '1155559999', url_callback: 'http://url.to/callback'

# geting the remaining balance
cli.balance

# geting the status of a campaign
cli.campaign_status '0000'

# holding a campaign
cli.campaign_hold '0000'

# resuming a campaign
cli.campaign_release '0000'

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 new Pull Request