https://github.com/jpush/jpush-api-ruby-client
JPush's officially supported Ruby client library for accessing JPush APIs. 极光推送官方支持的 Ruby 版本服务器端 SDK。
https://github.com/jpush/jpush-api-ruby-client
Last synced: 9 months ago
JSON representation
JPush's officially supported Ruby client library for accessing JPush APIs. 极光推送官方支持的 Ruby 版本服务器端 SDK。
- Host: GitHub
- URL: https://github.com/jpush/jpush-api-ruby-client
- Owner: jpush
- License: mit
- Created: 2013-10-10T09:38:13.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2022-02-18T09:14:20.000Z (almost 4 years ago)
- Last Synced: 2024-04-26T21:02:55.603Z (over 1 year ago)
- Language: Ruby
- Homepage: https://docs.jiguang.cn
- Size: 322 KB
- Stars: 99
- Watchers: 27
- Forks: 60
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# JPush API Ruby Client
[](https://travis-ci.org/jpush/jpush-api-ruby-client)
[](https://badge.fury.io/rb/jpush)
这是 JPush REST API 的 Ruby 版本封装开发包，是由极光推送官方提供的，一般支持最新的 API 功能。
对应的 REST API 文档: https://docs.jiguang.cn/jpush/server/push/server_overview/
> 支持的 Ruby 版本：>= 2.2
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'jpush'
# OR
gem 'jpush', git: 'https://github.com/jpush/jpush-api-ruby-client.git'
```
## Usage
- [Getting Started](https://github.com/jpush/jpush-api-ruby-client/blob/master/docs/Guides.md#getting-started)
- [Push API](https://github.com/jpush/jpush-api-ruby-client/blob/master/docs/Guides.md#push-api)
- [Report API](https://github.com/jpush/jpush-api-ruby-client/blob/master/docs/Guides.md#report-api)
- [Schedule API](https://github.com/jpush/jpush-api-ruby-client/blob/master/docs/Guides.md#schedule-api)
- [Device API](https://github.com/jpush/jpush-api-ruby-client/blob/master/docs/Guides.md#device-api)
- [Http2 Support](https://github.com/jpush/jpush-api-ruby-client/tree/http2)
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
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).
## Testing
```bash
# 复制测试的配置文件
$ cp test/config.yml.example test/config.yml
# 编辑 test/config.yml 文件，填入必须的变量值
# OR 设置相应的环境变量
# 运行全部测试用例
$ bundle exec rake
# 运行某一具体测试用例
$ bundle exec rake test TEST=test/jpush/xx_test.rb
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/jpush/jpush-api-ruby-client.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).