xiaomi-push 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2c3c36c6c5e5b4ba0a9e2c2a4613dc8d7a10cd6
-  data.tar.gz: c81f1a3bf49e0d03207a2716e1df1674fad2d45c
+  metadata.gz: af6f56215b75a2b1aade41cfb44472ffee343ef2
+  data.tar.gz: 68cd39c19f3465b6af9fb7ae1529c5baad19f6fd
 SHA512:
-  metadata.gz: 215b4af4c6c8e3bdaacbd5e9a6fa967e0fe25d8d8ef5cbb69607b8c90b51e8665236246483c0a8001f52052ef8f0e7c4dbd7c8a25a1fbe18ba4f829cd877c915
-  data.tar.gz: 772e82860bcea9b62cd43a458ad37f247d6e30254755803266a5aab5c319e260a6580fa1fa070c329b8d28cd74178865dda471f5e5ca90c402f39442efa79756
+  metadata.gz: 4ef808ae5f8cccf0f01ddb429180865aaafe0d8bddd1d0fd4989051574b58abaeaae2fa11e3666f60166b9988dd0161b21fdde88a8000b842967b1456d9e5166
+  data.tar.gz: 0172848d76bd101d3a607b82c6414ff4930884e9a98d1714a49f263b7f877cfeee27771c1bcf78351d3de91bdb93a11e6692943312c7b7b79ad6f14c45f9fec2

data/README.md

@@ -3,6 +3,9 @@
 
 官方文档: http://dev.xiaomi.com/doc/?p=533#d5e725
 
+TL;DR
+=====
+
 安装
 ----
 
@@ -49,15 +52,24 @@ message = {
 ### iOS
 message = Xiaomi::Push::Message::IOS.new(
   description:'iOS 主要显示描述',
-  badge:10
+  badge:10,
+  extras: {
+    uri: 'app://bbs?id=8624',
+    source: 'mpush'
+  }
 )
 
 ### Android
 message = Xiaomi::Push::Message::Android.new(
   title:'标题要有吸引力',
   description:'描述可以在手机显示两行',
-  notify_type:'DEFAULT_ALL'
+  notify_type:'DEFAULT_ALL',
+  extras: {
+    source: 'mpush'
+  }
 )
+#### 支持单独追加 extra
+message.extra('uri', 'app://bbs?id=8624')
 
 # 发消息
 ## 根据 regid
@@ -99,7 +111,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
-如何共享
+贡献代码
 --------
 
 1.	Fork it ( https://github.com/[my-github-username]/xiaomi-push/fork )

data/Rakefile

@@ -21,9 +21,9 @@ task :send => :dotenv do
   client = Xiaomi::Push::Android.new(ENV['XIAOMI_PUSH_ANDROID_SECRET'])
 
   p "Send message to android device"
-  # client.message.send(reg_id:'', data:message_data)
+  client.message.send(reg_id:'', message:message)
   r = client.message.send(alias:'866383029998732', message:message)
-  # client.message.send(topic:'test', data:message_data)
+  r = client.message.send(topic:'test', message:message)
   ap r
 
   p "Send message to ios device"
@@ -36,6 +36,20 @@ task :send => :dotenv do
   ap r
 end
 
+namespace :topic do
+  task :subscribe => :dotenv do
+    client = Xiaomi::Push::Android.new(ENV['XIAOMI_PUSH_ANDROID_SECRET'])
+    r = client.topic.subscribe(alias:'866383029998732', name:'test')
+    ap r
+  end
+
+  task :unsubscribe => :dotenv do
+    client = Xiaomi::Push::Android.new(ENV['XIAOMI_PUSH_ANDROID_SECRET'])
+    r = client.topic.unsubscribe(alias:'866383029998732', name:'test')
+    ap r
+  end
+end
+
 task :message do
   ios_message = Xiaomi::Push::Message::IOS.new(title:'dddd')
   ios_message.extra('url', 'http://www.xxx.com')
@@ -43,3 +57,9 @@ task :message do
 
   p ios_message.build
 end
+
+task :feedback do
+  client = Xiaomi::Push::Android.new(ENV['XIAOMI_PUSH_ANDROID_SECRET'])
+  r = client.feedback.invalid
+  ap r
+end

data/bin/xmp

@@ -7,7 +7,7 @@ require "xiaomi/push"
 require "awesome_print"
 
 
-program :version, '0.0.1'
+program :version, Xiaomi::Push::VERSION
 program :description, 'xiaomi push command line tool'
 
 program :help, 'Author', 'icyleaf'
@@ -19,123 +19,4 @@ global_option('--verbose') { $verbose = true }
 default_command :help
 never_trace!
 
-command :message do |c|
-  c.syntax = 'xmp message [options]'
-  c.summary = '发送小米推送消息'
-  c.description = '使用小米推送消息（目前仅支持 regid/alias/topic 推送方式）'
-
-  # normal params
-  c.option '--device DEVICE', ['android', 'ios'], '设备类型'
-  c.option '--secret SECRET', '应用密钥'
-
-  # type
-  c.option '--regid REGID', 'reg id'
-  c.option '--alias ALIAS', '别名'
-  c.option '--topic TOPIC', '订阅名'
-
-  # message
-  c.option '-i', '--title TITLE', '消息标题（仅 Android 有效）'
-  c.option '-d', '--description DESCRIPTION', '消息主体描述'
-  c.option '-b', '--badge BADGE', Integer, '消息数字'
-  c.option '-e', '--extras KEY=VALUE', Array, '自定义数据(使用 KEY=VALUE 方式，多个以逗号不带空格分隔)'
-
-  # ## ios only
-  # c.option '-y', '--category CATEGORY', '推送类别名称 (仅 iOS 有效)'
-  # c.option '-v', '--environment ENV', [:production, :sandbox], '推送环境(仅 iOS 有效)'
-  #
-  # ## android only
-  # c.option '-g', '--through THROUGHT', [0, 1], '消息传递方式(仅 iOS 有效)'
-  # c.option '-n', '--notify NOTIFY', [-1, 1, 2, 4], 'message notify type'
-
-  c.action do |args, options|
-    ap options if $verbose
-
-    @device = options.device.capitalize if options.device
-    @secret = options.secret
-
-    determine_device! unless @device
-    determine_secret! unless @secret
-
-    determine_channel!(options)
-    determine_message!(options)
-
-    sent!
-  end
-
-  private
-
-    def sent!
-      message_data = {
-        @channel.to_sym => @channel_id,
-        :message => @message,
-      }
-
-      if $verbose
-        ap message_data
-      end
-
-      client = Xiaomi::Push.const_get(@device).new(@secret)
-      r = client.message.send(message_data)
-
-      ap r
-    end
-
-    def determine_android_message!(options)
-      @message = Xiaomi::Push::Message::Android.new(
-        title: @title,
-        description: @description,
-        badge: @badge,
-        extras: @extras
-      )
-    end
-
-    def determine_ios_message!(options)
-      @message = Xiaomi::Push::Message::IOS.new(
-        description: @description,
-        badge: @badge,
-        extras: @extras
-      )
-    end
-
-    def determine_message!(options)
-      @title = options.title
-      @description = options.description
-      @badge = options.badge
-
-      @extras = if options.extras
-        Hash[options.extras.collect{|data| data.split(/\=/)}]
-      else
-        nil
-      end
-
-      case @device.downcase
-      when 'android'
-        determine_android_message!(options)
-      when 'ios'
-        determine_ios_message!(options)
-      end
-    end
-
-    def determine_device!
-      devices = %w[Android iOS].freeze
-      @device = choose "选择推送设备:", *devices
-    end
-
-    def determine_secret!
-      @secret ||= ask '小米应用密钥:'
-    end
-
-    def determine_channel!(options)
-      channles = %w[regid alias topic].freeze
-      @channel = channles.select { |k| options.__hash__.has_key?k.to_sym }
-
-      unless @channel.count > 0
-        @channel = choose "选择推送方式:", *channles
-
-        @channel_id = ask "输入 #{@channel} 的值:"
-      else
-        @channel = @channel[0]
-        @channel_id = options.__hash__[@channel.to_sym]
-      end
-    end
-end
+require 'xiaomi/push/commands'

data/lib/xiaomi/push.rb

@@ -8,7 +8,6 @@ require "xiaomi/push/devices/android"
 
 require "xiaomi/push/services/message"
 require "xiaomi/push/services/topic"
-require "xiaomi/push/services/alias"
 require "xiaomi/push/services/feedback"
 
 

data/lib/xiaomi/push/client.rb

@@ -9,13 +9,12 @@ module Xiaomi
       attr_reader :device, :secret, :header
       def initialize(secret)
         @device = self.class.name.split("::")[-1].upcase
+        @secret = secret
 
         unless DEVICES.include?@device
           raise NameError, 'Instance using Xiaomi::Push::Android or Xiaomi::Push::IOS'
         end
 
-        @secret = secret
-
         @header = {
           'Authorization' => "key=#{@secret}"
         }
@@ -31,6 +30,16 @@ module Xiaomi
         @topic ||= Services::Topic.new(self)
       end
 
+      def feedback
+        @feedback ||= Services::Feedback.new(self)
+      end
+
+      
+      def request(url, params)
+        r = RestClient.post url, params, @header
+        data = MultiJson.load r
+      end
+
     end
   end
 end

data/lib/xiaomi/push/commands.rb

@@ -0,0 +1,2 @@
+# require 'xiaomi/push/commands/message'
+require 'xiaomi/push/commands/feedback'

data/lib/xiaomi/push/commands/feedback.rb

@@ -0,0 +1,39 @@
+command :feedback do |c|
+  c.syntax = 'xmp feedback [options]'
+  c.summary = '获取小米无效的设备列表'
+  c.description = ''
+
+  # normal params
+  c.option '--device DEVICE', ['android', 'ios'], '设备类型'
+  c.option '--secret SECRET', '应用密钥'
+
+  c.action do |args, options|
+    ap options if $verbose
+
+    @device = options.device.capitalize if options.device
+    @secret = options.secret
+
+    determine_device! unless @device
+    determine_secret! unless @secret
+
+    feedback!
+  end
+
+  private
+
+    def feedback!
+      client = Xiaomi::Push.const_get(@device).new(@secret)
+      r = client.feedback.invalid
+
+      ap r
+    end
+
+    def determine_device!
+      devices = %w[Android iOS].freeze
+      @device = choose "选择推送设备:", *devices
+    end
+
+    def determine_secret!
+      @secret ||= ask '小米应用密钥:'
+    end
+end

data/lib/xiaomi/push/commands/message.rb

@@ -0,0 +1,120 @@
+command :message do |c|
+  c.syntax = 'xmp message [options]'
+  c.summary = '发送小米推送消息'
+  c.description = '使用小米推送消息（目前仅支持 regid/alias/topic 推送方式）'
+
+  # normal params
+  c.option '--device DEVICE', ['android', 'ios'], '设备类型'
+  c.option '--secret SECRET', '应用密钥'
+
+  # type
+  c.option '--regid REGID', 'reg id'
+  c.option '--alias ALIAS', '别名'
+  c.option '--topic TOPIC', '订阅名'
+
+  # message
+  c.option '-i', '--title TITLE', '消息标题（仅 Android 有效）'
+  c.option '-d', '--description DESCRIPTION', '消息主体描述'
+  c.option '-b', '--badge BADGE', Integer, '消息数字'
+  c.option '-e', '--extras KEY=VALUE', Array, '自定义数据(使用 KEY=VALUE 方式，多个以逗号不带空格分隔)'
+
+  # ## ios only
+  # c.option '-y', '--category CATEGORY', '推送类别名称 (仅 iOS 有效)'
+  # c.option '-v', '--environment ENV', [:production, :sandbox], '推送环境(仅 iOS 有效)'
+  #
+  # ## android only
+  # c.option '-g', '--through THROUGHT', [0, 1], '消息传递方式(仅 iOS 有效)'
+  # c.option '-n', '--notify NOTIFY', [-1, 1, 2, 4], 'message notify type'
+
+  c.action do |args, options|
+    ap options if $verbose
+
+    @device = options.device.capitalize if options.device
+    @secret = options.secret
+
+    determine_device! unless @device
+    determine_secret! unless @secret
+
+    determine_channel!(options)
+    determine_message!(options)
+
+    sent!
+  end
+
+  private
+
+    def sent!
+      message_data = {
+        @channel.to_sym => @channel_id,
+        :message => @message,
+      }
+
+      if $verbose
+        ap message_data
+      end
+
+      client = Xiaomi::Push.const_get(@device).new(@secret)
+      r = client.message.send(message_data)
+
+      ap r
+    end
+
+    def determine_android_message!(options)
+      @message = Xiaomi::Push::Message::Android.new(
+        title: @title,
+        description: @description,
+        badge: @badge,
+        extras: @extras
+      )
+    end
+
+    def determine_ios_message!(options)
+      @message = Xiaomi::Push::Message::IOS.new(
+        description: @description,
+        badge: @badge,
+        extras: @extras
+      )
+    end
+
+    def determine_message!(options)
+      @title = options.title
+      @description = options.description
+      @badge = options.badge
+
+      @extras = if options.extras
+        Hash[options.extras.collect{|data| data.split(/\=/)}]
+      else
+        nil
+      end
+
+      case @device.downcase
+      when 'android'
+        determine_android_message!(options)
+      when 'ios'
+        determine_ios_message!(options)
+      end
+    end
+
+    def determine_device!
+      devices = %w[Android iOS].freeze
+      @device = choose "选择推送设备:", *devices
+    end
+
+    def determine_secret!
+      @secret ||= ask '小米应用密钥:'
+    end
+
+    def determine_channel!(options)
+      channles = %w[regid alias topic].freeze
+      @channel = channles.select { |k| options.__hash__.has_key?k.to_sym }
+
+      unless @channel.count > 0
+        @channel = choose "选择推送方式:", *channles
+
+        @channel_id = ask "输入 #{@channel} 的值:"
+      else
+        @channel = @channel[0]
+        @channel_id = options.__hash__[@channel.to_sym]
+      end
+    end
+end

data/lib/xiaomi/push/services/feedback.rb

@@ -2,8 +2,17 @@ module Xiaomi
   module Push
     module Services
       class Feedback
+
+        attr_reader :context
+
         def initialize(context)
+          @context = context
+        end
 
+        def invalid
+          url = 'https://feedback.xmpush.xiaomi.com/v1/feedback/fetch_invalid_regids'
+          r = RestClient.get url, @context.header
+          data = MultiJson.load r
         end
       end
     end

data/lib/xiaomi/push/services/message.rb

@@ -58,6 +58,8 @@ module Xiaomi
           end
         end
 
+        private
+
         def fetch_message_type(data)
           type, value = nil
           MESSAGE_TYPE.select do |k,v|

data/lib/xiaomi/push/services/topic.rb

@@ -2,9 +2,41 @@ module Xiaomi
   module Push
     module Services
       class Topic
+        attr_reader :context
         def initialize(context)
+          @context = context
+        end
+
+        def subscribe(**options)
+          url, params = prepare_params(__method__.to_s, options)
+          data = @context.request url, params
+        end
 
+        def unsubscribe(**options)
+          url, params = prepare_params(__method__.to_s, options)
+          data = @context.request url, params
         end
+
+        private
+          def prepare_params(uri, options)
+            if options.has_key?(:reg_id)
+              type = "registration_id"
+              value = options[:reg_id]
+              url = @context.build_uri("topic/#{uri}")
+            elsif options.has_key?(:alias)
+              type = "aliases"
+              value = options[:alias]
+              url = @context.build_uri("topic/#{uri}/alias")
+            end
+
+            params = {
+              type.to_sym => value,
+              :topic => options[:name],
+              :category => options[:category],
+            }
+
+            [url, params]
+          end
       end
     end
   end

data/lib/xiaomi/push/version.rb

@@ -1,5 +1,5 @@
 module Xiaomi
   module Push
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xiaomi-push
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - icyleaf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-07 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -139,11 +139,13 @@ files:
 - bin/xmp
 - lib/xiaomi/push.rb
 - lib/xiaomi/push/client.rb
+- lib/xiaomi/push/commands.rb
+- lib/xiaomi/push/commands/feedback.rb
+- lib/xiaomi/push/commands/message.rb
 - lib/xiaomi/push/const.rb
 - lib/xiaomi/push/devices/android.rb
 - lib/xiaomi/push/devices/ios.rb
 - lib/xiaomi/push/error.rb
-- lib/xiaomi/push/services/alias.rb
 - lib/xiaomi/push/services/feedback.rb
 - lib/xiaomi/push/services/message.rb
 - lib/xiaomi/push/services/messages/android.rb

data/lib/xiaomi/push/services/alias.rb

@@ -1,11 +0,0 @@
-module Xiaomi
-  module Push
-    module Services
-      class Alias
-        def initialize(context)
-
-        end
-      end
-    end
-  end
-end