jpush 4.0.10 → 4.0.11

data/lib/jpush/push/push_payload.rb

@@ -1,77 +1,77 @@
-require 'jpush/push/audience'
-require 'jpush/push/notification'
-
-module JPush
-  module Push
-    class PushPayload
-
-      attr_reader :cid
-
-      def initialize(platform: , audience: , notification: nil, message: nil)
-        @platform = 'all' == platform ? 'all' : build_platform(platform)
-        @audience = 'all' == audience ? 'all' : build_audience(audience)
-        @notification = build_notification(notification) unless notification.nil?
-        @message = build_message(message) unless message.nil?
-      end
-
-      def set_message(msg_content, title: nil, content_type: nil, extras: nil)
-        @message = build_message(msg_content, title, content_type, extras)
-        self
-      end
-
-      def set_sms_message(sms_message)
-        @sms_message = sms_message
-        self
-      end
-
-      def set_options(options)
-        @options = options
-        self
-      end
-
-      def set_cid(cid)
-        @cid= cid
-        self
-      end
-
-      def to_hash
-        @push_payload = {
-          platform: @platform,
-          audience: @audience,
-          notification: @notification,
-          message: @message,
-          sms_message: @sms_message,
-          options: { apns_production: false }.merge(@options.nil? ? {} : @options),
-          cid: @cid
-        }.select { |_, value| !value.nil? }
-      end
-
-      private
-
-        def build_platform(platform)
-          return platform if platform.is_a? Array
-          return [platform]
-        end
-
-        def build_audience(audience)
-          audience.is_a?(Audience) ? audience.to_hash : nil
-        end
-
-        def build_notification(notification)
-          return {alert: notification} if notification.is_a?(String)
-          notification.is_a?(Notification) ? notification.to_hash : nil
-        end
-
-        def build_message(msg_content, title = nil, content_type = nil, extras = nil)
-          extras = (extras.nil? || !extras.is_a?(Hash) || extras.empty?) ? nil : extras
-          message = {
-            msg_content: msg_content,
-            title: title,
-            content_type: content_type,
-            extras: extras
-          }.select { |_, value| !value.nil? }
-        end
-
-    end
-  end
-end
+require 'jpush/push/audience'
+require 'jpush/push/notification'
+
+module JPush
+  module Push
+    class PushPayload
+
+      attr_reader :cid
+
+      def initialize(platform: , audience: , notification: nil, message: nil)
+        @platform = 'all' == platform ? 'all' : build_platform(platform)
+        @audience = 'all' == audience ? 'all' : build_audience(audience)
+        @notification = build_notification(notification) unless notification.nil?
+        @message = build_message(message) unless message.nil?
+      end
+
+      def set_message(msg_content, title: nil, content_type: nil, extras: nil)
+        @message = build_message(msg_content, title, content_type, extras)
+        self
+      end
+
+      def set_sms_message(sms_message)
+        @sms_message = sms_message
+        self
+      end
+
+      def set_options(options)
+        @options = options
+        self
+      end
+
+      def set_cid(cid)
+        @cid= cid
+        self
+      end
+
+      def to_hash
+        @push_payload = {
+          platform: @platform,
+          audience: @audience,
+          notification: @notification,
+          message: @message,
+          sms_message: @sms_message,
+          options: { apns_production: false }.merge(@options.nil? ? {} : @options),
+          cid: @cid
+        }.select { |_, value| !value.nil? }
+      end
+
+      private
+
+        def build_platform(platform)
+          return platform if platform.is_a? Array
+          return [platform]
+        end
+
+        def build_audience(audience)
+          audience.is_a?(Audience) ? audience.to_hash : nil
+        end
+
+        def build_notification(notification)
+          return {alert: notification} if notification.is_a?(String)
+          notification.is_a?(Notification) ? notification.to_hash : nil
+        end
+
+        def build_message(msg_content, title = nil, content_type = nil, extras = nil)
+          extras = (extras.nil? || !extras.is_a?(Hash) || extras.empty?) ? nil : extras
+          message = {
+            msg_content: msg_content,
+            title: title,
+            content_type: content_type,
+            extras: extras
+          }.select { |_, value| !value.nil? }
+        end
+
+    end
+  end
+end

data/lib/jpush/push/single_push_payload.rb

@@ -1,52 +1,52 @@
-require 'jpush/push/notification'
-
-module JPush
-  module Push
-    class SinglePushPayload
-
-      def initialize(platform: , target: )
-        @platform = 'all' == platform ? 'all' : build_platform(platform)
-        @target = target
-      end
-
-      def set_notification(notification)
-        @notification = notification
-        self
-      end
-
-      def set_message(message)
-        @message = message
-        self
-      end
-
-      def set_sms_message(sms_message)
-        @sms_message = sms_message
-        self
-      end
-
-      def set_options(options)
-        @options = options
-        self
-      end
-
-      def to_hash
-        single_push_payload = {
-          platform: @platform,
-          target: @target,
-          notification: @notification,
-          message: @message,
-          sms_message: @sms_message,
-          options: @options
-        }.select { |_, value| !value.nil? }
-      end
-
-      private
-
-        def build_platform(platform)
-          return platform if platform.is_a? Array
-          return [platform]
-        end
-
-    end
-  end
-end
+require 'jpush/push/notification'
+
+module JPush
+  module Push
+    class SinglePushPayload
+
+      def initialize(platform: , target: )
+        @platform = 'all' == platform ? 'all' : build_platform(platform)
+        @target = target
+      end
+
+      def set_notification(notification)
+        @notification = notification
+        self
+      end
+
+      def set_message(message)
+        @message = message
+        self
+      end
+
+      def set_sms_message(sms_message)
+        @sms_message = sms_message
+        self
+      end
+
+      def set_options(options)
+        @options = options
+        self
+      end
+
+      def to_hash
+        single_push_payload = {
+          platform: @platform,
+          target: @target,
+          notification: @notification,
+          message: @message,
+          sms_message: @sms_message,
+          options: @options
+        }.select { |_, value| !value.nil? }
+      end
+
+      private
+
+        def build_platform(platform)
+          return platform if platform.is_a? Array
+          return [platform]
+        end
+
+    end
+  end
+end

data/lib/jpush/pusher.rb

@@ -1,84 +1,84 @@
-require 'jpush/http/client'
-require 'jpush/push/push_payload'
-require 'jpush/push/single_push_payload'
-require 'jpush/handler'
-
-module JPush
-  class Pusher < Handler
-
-    # POST https://api.jpush.cn/v3/push/validate
-    # 验证推送调用是否能够成功，与推送 API 的区别在于：不向用户发送任何消息
-    def validate(push_payload)
-      url = base_url + 'validate'
-      send_push(url, push_payload)
-    end
-
-    # POST https://api.jpush.cn/v3/push
-    # 向某单个设备或者某设备列表推送一条通知、或者消息
-    def push(push_payload)
-      if push_payload.cid.nil?
-        cid_response = get_cid(count=1, type='push')
-        cid = cid_response.body['cidlist'].at(0)
-        push_payload.set_cid(cid)
-      end
-      send_push(base_url, push_payload)
-    end
-
-    # GET https://api.jpush.cn/v3/push/cid[?count=n[&type=xx]]
-    # 获取cid：推送唯一标识符
-    # https://docs.jiguang.cn/jpush/server/push/rest_api_v3_push/#cid
-    def get_cid(count=nil, type=nil)
-      params = {
-        count: count,
-        type: type
-      }.select { |_, value| !value.nil? }
-      url = base_url + 'cid'
-      Http::Client.get(@jpush, url, params: params)
-    end
-
-    # POST https://api.jpush.cn/v3/push/batch/regid/single
-    # 针对RegID方式批量单推（VIP专属接口）
-    # https://docs.jiguang.cn/jpush/server/push/rest_api_v3_push/#vip
-    def push_batch_regid(single_push_payloads)
-      cid_response = get_cid(count=single_push_payloads.size, type='push')
-      cidlist = cid_response.body['cidlist']
-      body = {}
-      body['pushlist'] = {}
-      single_push_payloads.each { |payload|
-        cid = cidlist.pop
-        body['pushlist'][cid] = payload.to_hash
-      }
-      url = base_url + 'batch/regid/single'
-      Http::Client.post(@jpush, url, body: body)
-    end
-
-    # POST https://api.jpush.cn/v3/push/batch/alias/single
-    # 针对Alias方式批量单推（VIP专属接口）
-    # https://docs.jiguang.cn/jpush/server/push/rest_api_v3_push/#vip
-    def push_batch_alias(single_push_payloads)
-      cid_response = get_cid(count=single_push_payloads.size, type='push')
-      cidlist = cid_response.body['cidlist']
-      body = {}
-      body['pushlist'] = {}
-      single_push_payloads.each { |payload|
-        cid = cidlist.pop
-        body['pushlist'][cid] = payload.to_hash
-      }
-      url = base_url + 'batch/alias/single'
-      Http::Client.post(@jpush, url, body: body)
-    end
-
-    private
-
-      def send_push(url, push_payload)
-        push_payload = push_payload.is_a?(JPush::Push::PushPayload) ? push_payload : nil
-        body = push_payload.to_hash
-        Http::Client.post(@jpush, url, body: body)
-      end
-
-      def base_url
-        'https://api.jpush.cn/v3/push/'
-      end
-
-  end
-end
+require 'jpush/http/client'
+require 'jpush/push/push_payload'
+require 'jpush/push/single_push_payload'
+require 'jpush/handler'
+
+module JPush
+  class Pusher < Handler
+
+    # POST https://api.jpush.cn/v3/push/validate
+    # 验证推送调用是否能够成功，与推送 API 的区别在于：不向用户发送任何消息
+    def validate(push_payload)
+      url = base_url + 'validate'
+      send_push(url, push_payload)
+    end
+
+    # POST https://api.jpush.cn/v3/push
+    # 向某单个设备或者某设备列表推送一条通知、或者消息
+    def push(push_payload)
+      if push_payload.cid.nil?
+        cid_response = get_cid(count=1, type='push')
+        cid = cid_response.body['cidlist'].at(0)
+        push_payload.set_cid(cid)
+      end
+      send_push(base_url, push_payload)
+    end
+
+    # GET https://api.jpush.cn/v3/push/cid[?count=n[&type=xx]]
+    # 获取cid：推送唯一标识符
+    # https://docs.jiguang.cn/jpush/server/push/rest_api_v3_push/#cid
+    def get_cid(count=nil, type=nil)
+      params = {
+        count: count,
+        type: type
+      }.select { |_, value| !value.nil? }
+      url = base_url + 'cid'
+      Http::Client.get(@jpush, url, params: params)
+    end
+
+    # POST https://api.jpush.cn/v3/push/batch/regid/single
+    # 针对RegID方式批量单推（VIP专属接口）
+    # https://docs.jiguang.cn/jpush/server/push/rest_api_v3_push/#vip
+    def push_batch_regid(single_push_payloads)
+      cid_response = get_cid(count=single_push_payloads.size, type='push')
+      cidlist = cid_response.body['cidlist']
+      body = {}
+      body['pushlist'] = {}
+      single_push_payloads.each { |payload|
+        cid = cidlist.pop
+        body['pushlist'][cid] = payload.to_hash
+      }
+      url = base_url + 'batch/regid/single'
+      Http::Client.post(@jpush, url, body: body)
+    end
+
+    # POST https://api.jpush.cn/v3/push/batch/alias/single
+    # 针对Alias方式批量单推（VIP专属接口）
+    # https://docs.jiguang.cn/jpush/server/push/rest_api_v3_push/#vip
+    def push_batch_alias(single_push_payloads)
+      cid_response = get_cid(count=single_push_payloads.size, type='push')
+      cidlist = cid_response.body['cidlist']
+      body = {}
+      body['pushlist'] = {}
+      single_push_payloads.each { |payload|
+        cid = cidlist.pop
+        body['pushlist'][cid] = payload.to_hash
+      }
+      url = base_url + 'batch/alias/single'
+      Http::Client.post(@jpush, url, body: body)
+    end
+
+    private
+
+      def send_push(url, push_payload)
+        push_payload = push_payload.is_a?(JPush::Push::PushPayload) ? push_payload : nil
+        body = push_payload.to_hash
+        Http::Client.post(@jpush, url, body: body)
+      end
+
+      def base_url
+        'https://api.jpush.cn/v3/push/'
+      end
+
+  end
+end

data/lib/jpush/report.rb

@@ -1,98 +1,98 @@
-require 'jpush/http/client'
-require 'jpush/handler'
-
-module JPush
-  class Report < Handler
-
-    TIME_UNIT = ['HOUR', 'DAY', 'MONTH']
-    TIME_FORMAT = { hour: '%F %H', day: '%F', month: '%Y-%m' }
-    MAX_DURATION = { hour: 24, day: 60, month: 2 }
-
-    # GET /v3/received
-    # 送达统计
-    def received(msg_ids)
-      msg_ids = [msg_ids].flatten
-      url = base_url + '/received'
-      params = {
-        msg_ids: msg_ids.join(',')
-      }
-      Http::Client.get(@jpush, url, params: params)
-    end
-
-    # GET /v3/received/detail
-    # 送达统计
-    # https://docs.jiguang.cn/jpush/server/push/rest_api_v3_report/#_7
-    def received_detail(msg_ids)
-      msg_ids = [msg_ids].flatten
-      url = base_url + '/received/detail'
-      params = {
-        msg_ids: msg_ids.join(',')
-      }
-      Http::Client.get(@jpush, url, params: params)
-    end
-
-    # GET /v3/status/message
-    # 送达状态查询
-    # Status API 用于查询已推送的一条消息在一组设备上的送达状态。
-    # https://docs.jiguang.cn/jpush/server/push/rest_api_v3_report/#_11
-    def status_message(msg_id: , registration_ids: , date: nil)
-      registration_ids = [registration_ids].flatten
-      url = base_url + 'status/message'
-      body = {
-        msg_id: msg_id.to_i,
-        registration_ids: registration_ids,
-        date: date
-      }.select { |_, value| !value.nil? }
-      Http::Client.post(@jpush, url, body: body)
-    end
-
-    # GET /v3/messages
-    # 消息统计
-    def messages(msg_ids)
-      msg_ids = [msg_ids].flatten
-      url = base_url + '/messages'
-      params = {
-        msg_ids: msg_ids.join(',')
-      }
-      Http::Client.get(@jpush, url, params: params)
-    end
-
-    # GET /v3/messages/detail
-    # 消息统计详情（VIP 专属接口，新）
-    # https://docs.jiguang.cn/jpush/server/push/rest_api_v3_report/#vip_1
-    def messages_detail(msg_ids)
-      msg_ids = [msg_ids].flatten
-      url = base_url + '/messages/detail'
-      params = {
-        msg_ids: msg_ids.join(',')
-      }
-      Http::Client.get(@jpush, url, params: params)
-    end
-
-    # GET /v3/users
-    # 用户统计
-    def users(time_unit, start, duration)
-      start = start.strftime(TIME_FORMAT[time_unit.downcase.to_sym])
-      duration = build_duration(time_unit.downcase.to_sym, duration)
-      params = {
-        time_unit: time_unit.upcase,
-        start: start,
-        duration: duration
-      }
-      url = base_url + '/users'
-      Http::Client.get(@jpush, url, params: params)
-    end
-
-    private
-
-      def base_url
-        'https://report.jpush.cn/v3/'
-      end
-
-      def build_duration(time_unit, duration)
-        return 1 if duration < 0
-        duration > MAX_DURATION[time_unit] ? MAX_DURATION[time_unit] : duration
-      end
-
-  end
-end
+require 'jpush/http/client'
+require 'jpush/handler'
+
+module JPush
+  class Report < Handler
+
+    TIME_UNIT = ['HOUR', 'DAY', 'MONTH']
+    TIME_FORMAT = { hour: '%F %H', day: '%F', month: '%Y-%m' }
+    MAX_DURATION = { hour: 24, day: 60, month: 2 }
+
+    # GET /v3/received
+    # 送达统计
+    def received(msg_ids)
+      msg_ids = [msg_ids].flatten
+      url = base_url + '/received'
+      params = {
+        msg_ids: msg_ids.join(',')
+      }
+      Http::Client.get(@jpush, url, params: params)
+    end
+
+    # GET /v3/received/detail
+    # 送达统计
+    # https://docs.jiguang.cn/jpush/server/push/rest_api_v3_report/#_7
+    def received_detail(msg_ids)
+      msg_ids = [msg_ids].flatten
+      url = base_url + '/received/detail'
+      params = {
+        msg_ids: msg_ids.join(',')
+      }
+      Http::Client.get(@jpush, url, params: params)
+    end
+
+    # GET /v3/status/message
+    # 送达状态查询
+    # Status API 用于查询已推送的一条消息在一组设备上的送达状态。
+    # https://docs.jiguang.cn/jpush/server/push/rest_api_v3_report/#_11
+    def status_message(msg_id: , registration_ids: , date: nil)
+      registration_ids = [registration_ids].flatten
+      url = base_url + 'status/message'
+      body = {
+        msg_id: msg_id.to_i,
+        registration_ids: registration_ids,
+        date: date
+      }.select { |_, value| !value.nil? }
+      Http::Client.post(@jpush, url, body: body)
+    end
+
+    # GET /v3/messages
+    # 消息统计
+    def messages(msg_ids)
+      msg_ids = [msg_ids].flatten
+      url = base_url + '/messages'
+      params = {
+        msg_ids: msg_ids.join(',')
+      }
+      Http::Client.get(@jpush, url, params: params)
+    end
+
+    # GET /v3/messages/detail
+    # 消息统计详情（VIP 专属接口，新）
+    # https://docs.jiguang.cn/jpush/server/push/rest_api_v3_report/#vip_1
+    def messages_detail(msg_ids)
+      msg_ids = [msg_ids].flatten
+      url = base_url + '/messages/detail'
+      params = {
+        msg_ids: msg_ids.join(',')
+      }
+      Http::Client.get(@jpush, url, params: params)
+    end
+
+    # GET /v3/users
+    # 用户统计
+    def users(time_unit, start, duration)
+      start = start.strftime(TIME_FORMAT[time_unit.downcase.to_sym])
+      duration = build_duration(time_unit.downcase.to_sym, duration)
+      params = {
+        time_unit: time_unit.upcase,
+        start: start,
+        duration: duration
+      }
+      url = base_url + '/users'
+      Http::Client.get(@jpush, url, params: params)
+    end
+
+    private
+
+      def base_url
+        'https://report.jpush.cn/v3/'
+      end
+
+      def build_duration(time_unit, duration)
+        return 1 if duration < 0
+        duration > MAX_DURATION[time_unit] ? MAX_DURATION[time_unit] : duration
+      end
+
+  end
+end