0.0
No commit activity in last 3 years
No release in over 3 years
Alidayu sms sdk ruby version of Aliyun.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 1.15
~> 10.0
 Project Readme

Alidayu-sms

Alidayu sms sdk ruby version of Aliyun(阿里云阿里大于短信SDK).

Installation

# Manually from RubyGems.org
$ gem install alidayu-sms

# Or Gemfile if you are using Bundler
$ gem alidayu-sms

Usage

alisms = Alidayu::Sms.new(sms_template: YOUR_SMS_TEMPLATE, sms_sign: YOUR_SMS_SIGN)
alisms.send_to(138xxxxxxxx, {code: 1234})
# true or false

# or use send! if you wanna raise error
alisms.send_to!(138xxxxxxxx, {code: 1234})
# true or raise Alidayu::RequestError

You can also use send_sms to send Alidayu sms, it's an alias of send_to.

Configuration

Before you sending any sms message, a valid configuration is necessary. Alidayu-sms supports you use it under Rails or in pure Ruby environment.

Rails

The Alidayu-sms configuration file is a YAML file, by default located at config/alidayu.yml. You need to set your Alidayu access_key which you can get from Aliyun. Here is an example configuration file:

# config/alidayu.yml
development: &defaults
  access_key_id: YOUR_ACCESS_KEY_ID
  access_key_secret: YOUR_ACCESS_KEY_SECRET

test:
  <<: *defaults

production:
  <<: *defaults

Non-rails

If you are using Sinatra or anything pure Ruby, use Alidayu::Sms.configuration to configrate Alidayu-sms.

require 'alidayu/sms'

Alidayu::Sms.configuration do |config|
  config.access_key_id = YOUR_ACCESS_KEY_ID
  config.access_key_secret = YOUR_ACCESS_KEY_SECRET
end

License

Released under the MIT license. See LICENSE file for details.