jpush 4.0.8 → 4.0.10

data/lib/jpush/push/single_push_payload.rb

@@ -0,0 +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

data/lib/jpush/pusher.rb

@@ -0,0 +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

data/lib/jpush/report.rb

@@ -1,59 +1,98 @@
-require 'jpush/http/client'
-
-module JPush
-  module Report
-    extend self
-
-    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(url, params: params)
-    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(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(url, params: params)
-    end
-
-    private
-
-      def base_url
-        Config.settings[:report_api_host] + Config.settings[:api_version]
-      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

data/lib/jpush/schedule/schedule_payload.rb

@@ -1,48 +1,48 @@
-require 'jpush/push/push_payload'
-require 'jpush/schedule/trigger'
-
-module JPush
-  module Schedule
-    class SchedulePayload
-
-      def initialize(name, trigger, push_payload, enabled = nil)
-        @name = name
-        @trigger = build_trigger(trigger)
-        @push_payload = build_push_payload(push_payload)
-        @enabled = enabled
-      end
-
-      def to_update_hash
-        @schedule_payload = {
-          name: @name,
-          enabled: @enabled,
-          trigger: @trigger,
-          push: @push_payload
-        }.select { |_, value| !value.nil? }
-        raise Utils::Exceptions::JPushError, 'Schedule update body can not be empty' if @schedule_payload.empty?
-        @schedule_payload
-      end
-
-      def to_hash
-        @schedule_payload = {
-          name: @name,
-          enabled: true,
-          trigger: @trigger,
-          push: @push_payload
-        }
-        hash = @schedule_payload.select { |_, value| value.nil? }
-        @schedule_payload
-      end
-
-      def build_trigger(trigger)
-        return { single: { time: trigger.strftime('%F %T') } } if trigger.is_a? Time
-        trigger.is_a?(Trigger) ? trigger.to_hash : nil
-      end
-
-      def build_push_payload(push_payload)
-        push_payload.is_a?(Push::PushPayload) ? push_payload.to_hash : nil
-      end
-
-    end
-  end
-end
+require 'jpush/push/push_payload'
+require 'jpush/schedule/trigger'
+
+module JPush
+  module Schedule
+    class SchedulePayload
+
+      def initialize(name, trigger, push_payload, enabled = nil)
+        @name = name
+        @trigger = build_trigger(trigger)
+        @push_payload = build_push_payload(push_payload)
+        @enabled = enabled
+      end
+
+      def to_update_hash
+        @schedule_payload = {
+          name: @name,
+          enabled: @enabled,
+          trigger: @trigger,
+          push: @push_payload
+        }.select { |_, value| !value.nil? }
+        raise Utils::Exceptions::JPushError, 'Schedule update body can not be empty' if @schedule_payload.empty?
+        @schedule_payload
+      end
+
+      def to_hash
+        @schedule_payload = {
+          name: @name,
+          enabled: true,
+          trigger: @trigger,
+          push: @push_payload
+        }
+        hash = @schedule_payload.select { |_, value| value.nil? }
+        @schedule_payload
+      end
+
+      def build_trigger(trigger)
+        return { single: { time: trigger.strftime('%F %T') } } if trigger.is_a? Time
+        trigger.is_a?(Trigger) ? trigger.to_hash : nil
+      end
+
+      def build_push_payload(push_payload)
+        push_payload.is_a?(Push::PushPayload) ? push_payload.to_hash : nil
+      end
+
+    end
+  end
+end

data/lib/jpush/schedule/trigger.rb

@@ -1,53 +1,53 @@
-module JPush
-  module Schedule
-    class Trigger
-
-      WEEK = ['MON','TUE','WED','THU','FRI','SAT','SUN']
-      MDAY = ('01'..'31').to_a
-
-      def set_single(time)
-        @periodical = nil
-        @single = { time: time.strftime('%F %T') }
-        self
-      end
-
-      def set_periodical(start_time, end_time, time, time_unit, frequency, point)
-        @single = nil
-        require 'time'
-        frequency = 100 if frequency > 100
-        @periodical = {
-          start: start_time.strftime('%F %T'),
-          end: end_time.strftime('%F %T'),
-          time: Time.parse(time).strftime('%T'),
-          time_unit: time_unit,
-          frequency: frequency,
-          point: build_point(time_unit, point)
-        }
-        self
-      end
-
-      def to_hash
-        @trigger = {}
-        @trigger[:single] = @single unless @single.nil?
-        @trigger[:periodical] = @periodical unless @periodical.nil?
-        @trigger
-      end
-
-      private
-
-        def build_point(time_unit, point)
-          array = [point].flatten
-          point =
-            case time_unit.upcase
-            when 'DAY'
-              nil
-            when 'WEEK'
-              WEEK & array.map{ |e| e.upcase }
-            when 'MONTH'
-              MDAY & array
-            end
-        end
-
-    end
-  end
-end
+module JPush
+  module Schedule
+    class Trigger
+
+      WEEK = ['MON','TUE','WED','THU','FRI','SAT','SUN']
+      MDAY = ('01'..'31').to_a
+
+      def set_single(time)
+        @periodical = nil
+        @single = { time: time.strftime('%F %T') }
+        self
+      end
+
+      def set_periodical(start_time, end_time, time, time_unit, frequency, point)
+        @single = nil
+        require 'time'
+        frequency = 100 if frequency > 100
+        @periodical = {
+          start: start_time.strftime('%F %T'),
+          end: end_time.strftime('%F %T'),
+          time: Time.parse(time).strftime('%T'),
+          time_unit: time_unit,
+          frequency: frequency,
+          point: build_point(time_unit, point)
+        }
+        self
+      end
+
+      def to_hash
+        @trigger = {}
+        @trigger[:single] = @single unless @single.nil?
+        @trigger[:periodical] = @periodical unless @periodical.nil?
+        @trigger
+      end
+
+      private
+
+        def build_point(time_unit, point)
+          array = [point].flatten
+          point =
+            case time_unit.upcase
+            when 'DAY'
+              nil
+            when 'WEEK'
+              WEEK & array.map{ |e| e.upcase }
+            when 'MONTH'
+              MDAY & array
+            end
+        end
+
+    end
+  end
+end