https://github.com/lenage/emay_soap
Emay Ruby API Wrapper http://www.emay.cn/
https://github.com/lenage/emay_soap
Last synced: 5 days ago
JSON representation
Emay Ruby API Wrapper http://www.emay.cn/
- Host: GitHub
- URL: https://github.com/lenage/emay_soap
- Owner: lenage
- License: mit
- Created: 2015-01-09T03:25:18.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-01-09T08:49:06.000Z (over 11 years ago)
- Last Synced: 2026-05-13T21:08:20.418Z (about 1 month ago)
- Language: Ruby
- Size: 129 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# EmaySoap
Made easy to use Emay(http://www.emay.cn/) to send sms in Ruby.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'emay_soap'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install emay_soap
## Usage
#### Setup
```ruby
# Provide authentication credentials
EmaySoap.setup do |c|
c.cdkey = 'yourcdkey'
c.key = 'yourkeywant to use' # max length 15
c.password = 'yourpassword'
end
client = EmaySoap.client
```
or
```ruby
# Provide authentication credentials
client = EmaySoap::Client.new(cdkey: 'yourcdkey', key: 'yoursessionkey', password: 'yourpassword')
```
#### Play with API
```ruby
# Emay requires you register your CD_KEY before send SMS
client.regist_ex
# List all APIs
client.operations
# Query Balance
client.get_balance
# Query each fee of SMS
client.get_each_fee
# Send SMS
client.send_sms
# change your session key
client.logout
client.key = 'yournewkey'
client.regist_ex
```
## Contributing
1. Fork it ( https://github.com/lenage/emay_soap/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