xiaomi-push 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fb5c2e6c1ee0eafc8af99743a10c7eca42a55ea
-  data.tar.gz: 6adb342258ca17d51b1cc394499092aedb2adc4d
+  metadata.gz: 6770ff7fa9a2ee7457a000b350443879dd95c212
+  data.tar.gz: 89a52e13d3a8ba6a173b200cd69252e670ad304c
 SHA512:
-  metadata.gz: ce5818f4d419effc99c8632b1f42467d91d397149cec3af5d70b3e8a65f8a39bc64317ba6b5d520b1130b44c502e082692c3691e4d0483cfbe5567ef218ef474
-  data.tar.gz: c225e1c92e96b3116b2a29c994646beb554929a63f862bf2121b2d7c3fa270a616853fc6d1d853ea478b7eaa3ed58ae43208bdbeae69b70a8cb016743bc6b751
+  metadata.gz: 285e9e1407613442177dbbb7ee9de2a1e630f294b6e1fbb01bd7b306ba7a29273f9881b8ca05c646876ee4d345d63dbed5ecb4d6b2977195d1a1020970af8c15
+  data.tar.gz: ecdf47335c176429e7ed0289a9c47364c1af2e9df11468da71158cd1c456eca05ddeee0ea1f2d4b093c015a48826ab191234fa479f877bf31327f2e85ebf097e

data/.circleci/config.yml

@@ -0,0 +1,13 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.4.1
+    branches:
+      ignore:
+        - gh-pages
+    working_directory: ~/xiaomi-push
+    steps:
+      - checkout
+      - run: bundle install
+      - run: rake spec

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# 变更历史
+
+### v0.3.0
+
+主要围绕 [#4](https://github.com/icyleaf/xiaomi-push/issues/4) 的需求完成：
+
+- [重大改变] 仅支持 ruby 2.1（包含）以上版本
+
+- [新增] 支持 iOS 10 的消息结构
+- [新增] 初始化支持使用 sandbox 推送环境
+- [新增] `message.counters` 接口获取消息的统计数据
+- [新增] `message.send` 接口使用 v3 版本并支持 user_account 查询（调用时用 user）
+- [新增] `user.aliases` 接口获取根据 reg id 查找绑定的别名（aliases）
+- [新增] `user.topics` 接口获取根据 reg id 查找绑定的标签（Topics）
+- [新增] `job.exist?` 接口检测定时任务是否存在
+- [新增] `job.destory` 接口删除定时任务
+- [新增] `xmp user` 命令工具支持查询 reg id 的 alias 和 topic
+- [新增] `xmp message` 命令工具支持 user_account 推送
+
+- [文档] 完善 README 文档和补全 API 文档
+
+- [重构] 使用高性能的 http 代替 rest-client
+- [重构] 移除 multi_json 转而使用自带的 json 解析
+
+- [修复] 组装消息体获取 key 错误的问题 [8efc5ee](https://github.com/icyleaf/xiaomi-push/commit/8efc5eeb3e02366d3a92da62fc1a6b81a58a143c)
+- [修复] 推送角标和声音设置不对的问题 [ebc4c89](https://github.com/icyleaf/xiaomi-push/commit/ebc4c89cad6db6d0b6cabaa7f52e54d53a4d55d6)
+- [修复] `xmp` 检查 device 错误的逻辑 [1d728f29](https://github.com/icyleaf/xiaomi-push/commit/1d728f29405fd31bcff1a6d4c6cd4940ab9690ce)
+
+### v0.2.4
+
+- 项目初发布

data/Gemfile

@@ -1,5 +1,4 @@
 source 'https://rubygems.org'
-# source 'https://gems.ruby-china.org'
 
 # Specify your gem's dependencies in xiaomi-push.gemspec
 gemspec

data/README.md

@@ -1,15 +1,16 @@
-非官方小米推送服务端 Ruby SDK
-=============================
+# 非官方小米推送服务端 Ruby SDK
 
-> 小米官方好像也就不怎么维护此服务，本 gem 除了修复问题以为不做新特性的更新。
+[![Build Status](https://img.shields.io/circleci/project/github/icyleaf/xiaomi-push.svg?style=flat)](https://circleci.com/gh/icyleaf/xiaomi-push)
+[![Code Climate](https://img.shields.io/codeclimate/github/icyleaf/xiaomi-push.svg?style=flat)](https://codeclimate.com/github/icyleaf/xiaomi-push)
+[![Inline docs](http://inch-ci.org/github/icyleaf/xiaomi-push.svg?style=flat)](https://inch-ci.org/github/icyleaf/xiaomi-push)
+[![Gem version](https://img.shields.io/gem/v/xiaomi-push.svg?style=flat)](https://rubygems.org/gems/xiaomi-push)
+[![License](https://img.shields.io/badge/license-MIT-red.svg?style=flat)](LICENSE.txt)
 
-官方文档: http://dev.xiaomi.com/doc/?p=533#d5e725
+## TL;DR
 
-TL;DR
-=====
+> 特别注意：仅支持 Ruby 2.1.0 （包含）以上版本。
 
-安装
-----
+### 安装
 
 添加如下至 Gemfile:
 
@@ -29,66 +30,170 @@ $ bundle
 $ gem install xiaomi-push
 ```
 
-用法
-----
+### 用法
 
-### 发消息
+### 发单一消息
+
+支持按照 `reg_id`/`alias`/`topic`/`topics`/`user`/`all` 的方式向单个或一组设备发送同一条推送消息。
 
 ```ruby
 require 'xiaomi-push'
+
 # 初始化
-## iOS
-client = Xiaomi::Push::IOS('Fill your app secret')
-## Android
+# iOS (环境支持 :production/:sandbox)
+client = Xiaomi::Push::IOS('Fill your app secret', :production)
+# Android
 client = Xiaomi::Push::Android('Fill your app secret')
 
 # 消息结构
-## Hash 模式
+# Hash 模式
 message = {
   'title': 'Android 需要标题',
   'descrption': 'iOS 主要显示描述',
   'extra.uri': 'app://bbs?id=8624'
 }
 
-## Builder 模式
-### iOS
+# Builder 模式
+# iOS
+message = Xiaomi::Push::Message::IOS.new(
+  description: 'iOS 主要显示描述',
+  badge: 10,
+  extras: {
+    uri: 'app://bbs?id=8624',
+    source: 'mpush'
+  }
+)
+
+# iOS 10
 message = Xiaomi::Push::Message::IOS.new(
-  description:'iOS 主要显示描述',
-  badge:10,
+  title: '这是标题',
+  subtitle: '这是副标题'
+  description:'iOS 主要显示描述', # 对于 iOS 这里即可以是 description 也可以是 iOS 10 结构的 body
+  badge: 1,
   extras: {
     uri: 'app://bbs?id=8624',
     source: 'mpush'
   }
 )
 
-### Android
+# Android
 message = Xiaomi::Push::Message::Android.new(
-  title:'标题要有吸引力',
-  description:'描述可以在手机显示两行',
-  notify_type:'DEFAULT_ALL',
+  title: '标题要有吸引力',
+  description: '描述可以在手机显示两行',
+  notify_type: 'DEFAULT_ALL',
   extras: {
     source: 'mpush'
   }
 )
-#### 支持单独追加 extra
+
+# 支持单独追加 extra
 message.extra('uri', 'app://bbs?id=8624')
 
 # 发消息
-## 根据 regid
+# 根据 regid
 client.message.send reg_id:'id', message:message
 
-## 根据 alias
+# 根据 alias
 client.message.send alias:'alias', message:message
 
-## 根据 topic
+# 根据 topic
 client.message.send topic:'topic', message:message
 
-## 全部推送
+# 全部推送
 client.message.send all:true, message:message
 ```
 
-命令行工具
-----------
+### 发送多条消息
+
+支持同一设备类型的设备发送不同的消息。**注意**发送多个消息不能是不同类型的设备 key。
+
+支持的消息类型：
+
+- `:reg_id`
+  - `reg_id`
+  - `regid`
+  - `registration_id`
+- `:alias`
+  - `:alias`
+- `:user`
+  - `:user`
+  - `:account`
+  - `:useraccount`
+  - `:user_account`
+
+> 以上子列表为消息体传递的设备的 key 的名字。
+
+```ruby
+# 向多个 reg id 发送不同的消息
+client.messages.send(:reg_id, [
+  {
+    reg_id: 'abc',
+    title: '这是标题1',
+    description: '这个是推送的描述1',
+    notify_type: -1
+  },
+  {
+    regid: 'dfc',
+    title: '这是标题2',
+    description: '这个是推送的描述2',
+  },
+  {
+    registration_id: 'dfc',
+    title: '这是标题2',
+    description: '这个是推送的描述2',
+  }
+])
+
+# 这个是错误的消息，无法发送
+client.messages.send(:alias, [
+  {
+    reg_id: 'abc',
+    title: '这是标题1',
+    description: '这个是推送的描述1',
+    notify_type: -1
+  },
+  {
+    user: 'dfc',
+    title: '这是标题2',
+    description: '这个是推送的描述2',
+  },
+])
+```
+
+### 订阅/取消订阅标签
+
+```ruby
+# 订阅单个 reg id 到 beijing 标签
+client.topic.subscribe(reg_id: 'abc', topic: 'beijing')
+
+# 订阅多个 alias 到 beijing 标签
+client.topic.subscribe(alias: 'abc,def,ghi,jkl', topic: 'beijing')
+
+# 取消订阅 beijing 标签的单个 reg id
+client.topic.unsubscribe(reg_id: 'abc', topic: 'beijing')
+
+# 取消订阅 beijing 标签的多个 alias
+client.topic.unsubscribe(alias: 'abc,def,ghi,jkl', topic: 'beijing')
+```
+
+### 获取无效 iOS 的推送设备
+
+用于检查 iOS 用户关闭了应用的推送或者是卸载了 App 的设备列表
+
+```ruby
+client.feedback.invalid
+```
+
+### 获取消息的统计数据
+
+```ruby
+# 获取 2017-09-01 到 2017-09-30 应用 com.icyleaf.app.helloworld 统计数据
+client.message.counters('20170901', '20170930', 'com.icyleaf.app.helloworld')
+```
+
+更多用例可查阅 [Rakefile](Rakefile)。
+
+### 命令行工具
 
 本 SDK 同时还附带一个命令行工具 `xmp`，可以使用它尽快快速的测试和验证参数信息.
 
@@ -96,28 +201,59 @@ client.message.send all:true, message:message
 # 发消息
 ## iOS
 ### 发送附加内容并设置未读消息数为 2
-$ xmp message --device ios --secret '<密钥>' -d '推送的内容' -b 2 -e uri="app://bbs?id",source="push"
+$ xmp message --device ios --secret '<密钥>' \
+  --alias '<Alias>' \
+  -d '推送的描述内容' \
+  -b 2 \
+  -e uri="http://icyleaf.com"
+# => {"result"=>"ok", "trace_id"=>"abc", "code"=>0, "data"=>{"id"=>"abc68b8350529097551xyz"}, "description"=>"成功", "info"=>"Received push messages for 1 ALIAS"}
 
 ## Android
 ### 最基本的推送信息
-$ xmp message --device android --secret '<密钥>' -i '推送的标题' -d '推送的内容'
+$ xmp message --device android --secret '<密钥>' \
+  --regid '<RegId>' \
+  -i '推送的标题' \
+  -d '推送的描述内容'
+# => {"result"=>"ok", "trace_id"=>"abc", "code"=>0, "data"=>{"id"=>"abc68b8350529097551xyz"}, "description"=>"成功", "info"=>"Received push messages for 1 REG_ID"}
+
+# 查找绑定的 aliases 和 topics
+$ xmp user --device ios --secret '<密钥>' --reg-id '<RegId>'
+# => alias count: 1
+# =>  * ABCDEFGH-1234-5678-90ABC-F4DC5731EEFD
+# => topic count: 1
+# =>  * all
+
+# 查找 iOS 无效的设备（Reg id）
+$ xmp feedback --device ios --secret '<密钥>'
+# => {"result"=>"ok", "trace_id"=>"Xlm07b67505290966457ey", "code"=>0, "data"=>{"list"=>["+9AKnbpV22HafwE7vjYMr6Hc7i41ClyQr7iqX1fm7zc="]}}
 
 # 查看帮助
 $ xmp message --help
-```
 
-开发
-----
+  NAME:
+
+    xmp
+
+  DESCRIPTION:
+
+    小米推送命令行工具
+
+  COMMANDS:
+
+    feedback 获取小米无效的设备列表
+    message  发送小米推送消息
+    user     小米 aliases/topics 查询工具
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+- 官方 API 文档: https://dev.mi.com/console/doc/detail?pId=1163
+- 官方 SDK 下载：https://dev.mi.com/mipush/downpage/ (Python Java PHP)
 
-贡献代码
---------
+## 贡献代码
 
-1.	Fork it ( https://github.com/[my-github-username]/xiaomi-push/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
+1. Fork it ( https://github.com/[my-github-username]/xiaomi-push/fork )
+1. Create your feature branch (`git checkout -b my-new-feature`\)
+1. Commit your changes (`git commit -am 'Add some feature'`\)
+1. Push to the branch (`git push origin my-new-feature`\)
+1. Create a new Pull Request

data/Rakefile

@@ -1,48 +1,79 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require 'dotenv/tasks'
-
-# $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 require 'xiaomi/push'
+require 'pp'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
 
-task send: :dotenv do
-  message = {
-    title: '这是标题',
-    description: '这个是推送的描述',
-    notify_type: -1
-  }
+namespace :message do
+  task :send do
+    message = {
+      title: '这是标题',
+      description: '这个是推送的描述',
+      notify_type: -1
+    }
 
-  client = Xiaomi::Push::Android.new(ENV['XIAOMI_PUSH_ANDROID_SECRET'])
+    p 'Send message to android device'
+    client = Xiaomi::Push::Android.new(ENV['XIAOMI_PUSH_SECRET'])
+    client.message.send(reg_id: '', message: message)
+    r = client.message.send(alias: '866383029998732', message: message)
+    # r = client.message.send(topic: 'test', message: message)
+    puts r
 
-  p 'Send message to android device'
-  client.message.send(reg_id: '', message: message)
-  r = client.message.send(alias: '866383029998732', message: message)
-  # r = client.message.send(topic: 'test', message: message)
-  puts r
+    p 'Send message to ios device'
+    client = Xiaomi::Push::IOS.new(ENV['XIAOMI_PUSH_SECRET'])
+    r = client.message.send(
+      reg_id: 'xksdf76s667687xd786sdxsdf689s6x6s8d76s8d',
+      message: Xiaomi::Push::Message::IOS.new(
+        description: '这不是描述'
+    ))
+    puts r
+  end
 
-  p 'Send message to ios device'
-  client = Xiaomi::Push::IOS.new(ENV['XIAOMI_PUSH_IOS_SECRET'])
-  r = client.message.send(
-    reg_id: 'xksdf76s667687xd786sdxsdf689s6x6s8d76s8d',
-    message: Xiaomi::Push::Message::IOS.new(
-      description: '这不是描述'
-  ))
-  puts r
+  task :multi_send do
+    client = Xiaomi::Push::Android.new(ENV['XIAOMI_PUSH_SECRET'])
+    client.messages.send(:reg_idss, [
+      {
+        reg_id: 'abc',
+        title: '这是标题1',
+        description: '这个是推送的描述1',
+        notify_type: -1
+      },
+      {
+        reg_id: 'dfc',
+        title: '这是标题2',
+        description: '这个是推送的描述2',
+      }
+    ])
+  end
+
+  task :counters, [:package_name, :start_date, :end_date] do |t, opts|
+    require 'date'
+    start_date = opts.fetch(:start_date, Date.today.strftime('%Y%m%d'))
+    end_date = opts.fetch(:end_date, (Date.today + 1).strftime('%Y%m%d'))
+    package_name = opts.fetch(:package_name)
+
+    if package_name
+      client = Xiaomi::Push::IOS.new(ENV['XIAOMI_PUSH_SECRET'])
+      pp client.message.counters(start_date, end_date, package_name)
+    else
+      puts "missing package name"
+    end
+  end
 end
 
 namespace :topic do
-  task subscribe: :dotenv do
-    client = Xiaomi::Push::Android.new(ENV['XIAOMI_PUSH_ANDROID_SECRET'])
+  task :subscribe do
+    client = Xiaomi::Push::IOS.new(ENV['XIAOMI_PUSH_SECRET'])
     r = client.topic.subscribe(alias: '866383029998732', name: 'test')
     puts r
   end
 
-  task unsubscribe: :dotenv do
+  task :unsubscribe do
     client = Xiaomi::Push::Android.new(ENV['XIAOMI_PUSH_ANDROID_SECRET'])
     r = client.topic.unsubscribe(alias: '866383029998732', name: 'test')
     puts r