Merge branch 'dev'

.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test/config.yml

.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jpush.gemspec
+gemspec

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Helperhaps
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,259 @@
+# JPush API Ruby Client
+
+这是 JPush REST API 的 Ruby 版本封装开发包，是由极光推送官方提供的，一般支持最新的 API 功能。
+对应的 REST API 文档： http://docs.jpush.io/server/server_overview/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jpush', git: 'https://github.com/jpush/jpush-api-ruby-client.git'
+```
+
+## Usage
+
+#### Getting Started
+
+[Where to get app_key or master_secret?](https://www.jpush.cn/common/apps/new)
+
+```ruby
+app_key = 'xxx'
+master_secret = 'xxx'
+jpush = Jpush::Config.init(app_key, master_secret)
+```
+
+#### Device API
+
+```ruby
+devices = jpush.devices
+tags = jpush.tags
+aliases = jpush.aliases
+```
+
+###### 查询设备 (设备的别名与标签)
+
+```ruby
+# 获取当前设备的所有属性，包含标签 tags, 别名 alias， 手机号码 mobile
+devices.show(registration_id)
+```
+
+###### 更新设备 (设备的别名与标签)
+
+```ruby
+# 为设备添加/移除标签
+# 参数 tags 为一个表示有效的 tag 字符串或者一个最多包含100个有效的 tag 字符串的数组
+devices.add_tags(registration_id, tags)
+devices.remove_tags(registration_id, tags)
+
+# 清除设备所有标签
+devices.clear_tags(registration_id)
+
+# 更新设备的别名
+devices.update_alias(registration_id, alis)
+
+# 删除设备的别名
+devices.delete_alias(registration_id)
+
+# 更新设备的手机号码
+devices.update_mobile(registration_id)
+```
+
+###### 查询标签列表
+
+```ruby
+# 获取应用的所有标签列表
+tags.list
+```
+
+###### 判断设备与标签的绑定
+
+```ruby
+# 查询某个设备是否在标签下
+tags.has_device?(tag_value, registration_id)
+```
+
+###### 更新标签 (与设备的绑定的关系)
+
+```ruby
+# 为一个标签添加/移除设备
+# 参数 registration_ids 为一个表示有效的 registration_id 字符串
+# 或者一个最多包含1000个有效的 registration_id 字符串的数组
+tags.add_devices(tag_value, registration_ids)
+tags.remove_devices(tag_value, registration_ids)
+```
+
+###### 删除标签 (与设备的绑定关系)
+
+```ruby
+# 删除一个标签，以及标签与设备之间的关联关系。
+tags.delete(tag_value)
+```
+
+###### 查询别名 (与设备的绑定关系)
+
+```ruby
+# 获取指定别名下的设备，最多输出10个
+aliases.show(alias_value)
+```
+
+###### 删除别名 (与设备的绑定关系)
+
+```ruby
+# 删除一个别名，以及该别名与设备的绑定关系
+aliases.delete(alias_value)
+```
+
+#### Push API
+
+```ruby
+pusher = jpush.pusher
+
+# simplest push Hello to all
+push_payload = Jpush::Api::Push::PushPayload.new(
+  platform: 'all',
+  audience: 'all',
+  notification: 'hello jpush',
+  message: 'hello world'
+).build
+pusher.push(push_payload)
+```
+
+###### 构建复杂的 Audience 对象
+
+```ruby
+# set_tag 和 set_tag_and 方法接受一个有效的 tag 字符串或者一个最多包含20个有效的 tag 字符串的数组
+# 同样的 set_alias 和 set_registration_id 方法接受最多包含1000个
+audience = Jpush::Api::Push::Audience.new
+audience.set_tag('tag')
+audience.set_tag_and('tag_and')
+audience.set_alias('alias')
+audience.set_registration_id('rid')
+audience.build
+
+# OR
+audience = Jpush::Api::Push::Audience.new.
+  set_tag('tag').
+  set_tag_and('tag_and').
+  set_alias('alias').
+  set_registration_id('rid').
+  build
+```
+
+###### 构建复杂的 Notification 对象
+
+```ruby
+hash = { key0: 'value0', key1: 'value1' }
+
+notification = Jpush::Api::Push::Notification.new
+
+notification.set_alert('alert')
+notification.set_not_alert    # 不展示到通知栏
+
+notification.set_android(alert: 'hello android')
+notification.set_android(
+  alert: 'hello',
+  title: 'android',
+  builder_id: 1,
+  extras: hash
+)
+
+notification.set_ios(alert: 'hello ios')
+notification.set_ios(
+  alert: 'hello',
+  sound: 'sound',
+  badge: '+1',
+  available: true,
+  category: 'category',
+  extras: hash
+)
+
+notification.build
+
+# OR
+notification = Jpush::Api::Push::Notification.new.
+  set_alert('alert').
+  set_android(alert: 'hello android').
+  set_ios(alert: 'hello ios').
+  build
+```
+
+###### 构建复杂 PushPayload 对象
+
+```ruby
+hash = { key0: 'value0', key1: 'value1' }
+
+# audience 和 notification 对象可按照上面的例子实例化
+audience = Jpush::Api::Push::Andience.new
+notification = Jpush::Api::Push::Notification.new
+
+# 初始化 PushPayload 对象
+push_payload = Jpush::Api::Push::PushPayload.new(
+  platform: 'android',
+  audience: audience,
+  notification: notification
+)
+
+# 添加应用内消息
+push_payload.set_message(
+  'msg_content',
+  title: 'hello message',
+  content_type: 'text',
+  extras: hash
+)
+
+# 添加短信业务
+push_payload.set_sms_message('sms_content', 10)
+
+push_payload.build
+
+# OR
+push_payload = Jpush::Api::Push::PushPayload.new(
+  platform: 'android',
+  audience: audience,
+  notification: notincation).
+  set_message(
+    'msg_content',
+    title: 'hello message',
+    content_type: 'text',
+    extras: hash
+  ).set_sms_message('sms_content', 10).
+  build
+```
+
+###### 推送消息
+```ruby
+pusher.push(push_payload)
+```
+
+## 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 文件，填入必须的变量值
+$ vi test/config.yml
+
+# 运行全部测试用例
+$ bundle exec test
+
+# 运行某一具体测试用例
+$ 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).
+

Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jpush"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

jpush.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jpush/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jpush"
+  spec.version       = Jpush::VERSION
+  spec.authors       = ["JPush Offical"]
+  spec.email         = ["[email protected]"]
+
+  spec.summary       = %q{JPush's officially supported Ruby client library for accessing JPush APIs.}
+  spec.description   = %q{JPush's officially supported Ruby client library for accessing JPush APIs. 极光推送官方支持的 Ruby 版本服务器端 SDK. http://docs.jpush.io/server/server_overview/}
+  spec.homepage      = "https://github.com/jpush/jpush-api-ruby-client"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 1.24"
+end

lib/jpush.rb

@@ -0,0 +1,10 @@
+require "jpush/version"
+
+module Jpush
+  # Your code goes here...
+  require 'jpush/hola'
+  require 'jpush/config'
+  require 'jpush/utils/helper'
+  require 'jpush/utils/http'
+
+end