jpush 3.1.1

data/lib/jpush/push_client.rb

@@ -0,0 +1,31 @@
+path= File.expand_path('../', __FILE__)
+require File.join(path, 'http_client.rb')
+require File.join(path, 'model/push_result.rb')
+require 'json'
+
+=begin
+Entrance for sending Push.
+timeToLive If not present, the default is 86400(s) (one day).
+=end
+module JPush
+  class PushClient
+    @@PUSH_API_URL = 'https://api.jpush.cn/v3/push'
+    @@_timeToLive = 60 * 60 * 24
+    def initialize(maxRetryTimes)
+      @httpclient = JPush::NativeHttpClient.new(maxRetryTimes)
+    end
+
+=begin
+@param payload is the instance of PushPayload
+@autoCode
+=end
+    def sendPush(payload,autoCode)
+      json_data = JSON.generate(payload.toJSON)
+      result = JPush::PushResult.new
+      wrapper = @httpclient.sendPost(@@PUSH_API_URL, json_data, autoCode)
+      result.fromResponse(wrapper)
+      return result
+    end
+
+  end
+end

data/lib/jpush/report_client.rb

@@ -0,0 +1,45 @@
+path =  File.expand_path('../', __FILE__)
+require File.join(path, 'http_client.rb')
+require File.join(path, 'push_client.rb')
+require 'json'
+
+module JPush
+  class ReportClient
+    @@REPORT_HOST_NAME = 'https://report.jpush.cn'
+    @@REPORT_RECEIVE_PATH = '/v3/received'
+    @@REPORT_USER_PATH = '/v3/users'
+    @@REPORT_MESSAGE_PATH = '/v3/messages'
+    def initialize(maxRetryTimes)
+      @httpclient=JPush::NativeHttpClient.new(maxRetryTimes)
+    end
+
+
+    def getReceiveds(msg_ids, authcode)
+      msg_ids = checkMsgids(msg_ids)
+      @url = @@REPORT_HOST_NAME + @@REPORT_RECEIVE_PATH + '?msg_ids=' + msg_ids
+      result = JPush::ReceivedsResult.new
+      wrapper = @httpclient.sendGet(@url, nil, authcode)
+      return result.fromResponse(wrapper)
+    end
+
+    def getMessages(msg_ids, authcode)
+      msg_ids = checkMsgids(msg_ids)
+      @url = @@REPORT_HOST_NAME + @@REPORT_MESSAGE_PATH + '?msg_ids=' + msg_ids
+      return @httpclient.sendGet(@url, nil, authcode)
+    end
+
+    def getUsers(timeUnit, start, duration, authcode)
+      @url = @@REPORT_HOST_NAME + @@REPORT_USER_PATH + '?time_unit=' + timeUnit + '&start=' + start + '&duration=' + duration.to_s
+      return @httpclient.sendGet(@url, nil, authcode)
+    end
+
+    def checkMsgids(msg_ids)
+      if msg_ids.empty?
+        raise ArgumentError.new('msgIds param is required')
+      end
+      msg_ids = msg_ids.split.join('').to_s
+      return msg_ids
+    end
+
+  end
+end

data/lib/jpush/response_wrapper.rb

@@ -0,0 +1,36 @@
+module JPush
+  class ResponseWrapper
+    attr_accessor :rateLimitQuota, :rateLimitRemaining, :rateLimitReset, :code, :error, :responseContent
+    def initialize()
+
+      @logger = Logger.new(STDOUT)
+    end
+    def setRateLimit(quota, remaining, reset)
+      if quota.class != Fixnum
+        raise ArgumentError.new('quota is not FIXnum')
+      end
+      if remaining.class != Fixnum
+        raise ArgumentError.new('remaining is not FIXnum')
+      end
+      if reset.class != Fixnum
+        raise ArgumentError.new('reset is not FIXnum')
+      end
+      @quota = quota
+      @remaining = remaining
+      @reset = reset
+      @logger.debug("JPush API Rate Limiting params - quota:" + quota.to_s + ", remaining:" + remaining.to_s + ", reset:" + reset.to_s)
+    end
+    
+    def setResponseContent(content)
+       @responseContent = content
+    end
+    
+    def getResponseContent
+      return @responseContent
+    end
+    
+    def setErrorObject
+      @error = JSON.parse @responseContent
+    end
+  end
+end

data/lib/jpush/util/service_helper.rb

@@ -0,0 +1,10 @@
+require 'base64'
+class ServiceHelper
+  @@BASIC_PREFIX = 'Basic'
+  
+  def self.getAuthorizationBase64(appKey, masterSecret)
+     encodeKey = appKey + ":" + masterSecret
+     return @@BASIC_PREFIX + " " + Base64.strict_encode64(encodeKey)
+
+  end
+end

data/test/alert_override_tests.rb

@@ -0,0 +1,62 @@
+require 'jpush'
+require './base_remote_tests.rb';
+require 'test/unit'
+
+class AlertOverrideTests < Test::Unit::TestCase
+  def setup
+    @client = JPush::JPushClient.new(AppKey, MasterSecret)
+  end
+
+  def testsendAlert_all
+    @payload = JPush::PushPayload.build(
+      audience: JPush::Audience.all,
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert',
+        ios: JPush::IOSNotification.build(
+          alert: 'ios alert'),
+        android: JPush::AndroidNotification.build(
+          alert: 'android alert'),
+         winphone: JPush::WinphoneNotification.build(
+           alert: 'winphone alert')))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "response error")
+  end
+
+  def testsendAlert_android
+    @payload = JPush::PushPayload.build(
+      audience: JPush::Audience.all,
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert',
+        android: JPush::AndroidNotification.build(
+          alert: 'android alert')))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "response error")
+  end
+
+  def testsendAlert_ios
+    @payload = JPush::PushPayload.build(
+      audience: JPush::Audience.all,
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert',
+        ios: JPush::IOSNotification.build(
+          alert: 'ios alert')))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "response error")
+  end
+
+  def testsendAlert_wp
+    @payload = JPush::PushPayload.build(
+      audience: JPush::Audience.all,
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert',
+         winphone: JPush::WinphoneNotification.build(
+           alert: 'winphone alert')))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "response error")
+  end
+
+end

data/test/audience_tests.rb

@@ -0,0 +1,169 @@
+require 'jpush'
+
+require './base_remote_tests.rb'
+
+require 'test/unit'
+class AudienceTests < Test::Unit::TestCase
+    def setup
+    @client = JPush::JPushClient.new(AppKey, MasterSecret)
+  end
+  
+  def testsendByTag
+    @payload = JPush::PushPayload.build(
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert'),
+      audience: JPush::Audience.build(
+        tag: TAG1))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+  
+  def testsendByTagAnd
+    @payload = JPush::PushPayload.build(
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert'),
+      audience: JPush::Audience.build(
+        tag_and: TAG1))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+  
+  def testsendByAlias
+    @payload = JPush::PushPayload.build(
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert'),
+      audience: JPush::Audience.build(
+        _alias: ALIAS1))
+    res = @client.sendPush(@payload)
+    assert_not_nil(res.isok, message = "")
+  end
+  
+  def testsendByRegistrationID
+    @payload = JPush::PushPayload.build(
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert'),
+      audience: JPush::Audience.build(
+        registration_id: REGISTRATION_ID1))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+  
+  def testsendByTagMore
+    @payload = JPush::PushPayload.build(
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert'),
+      audience: JPush::Audience.build(
+      tag: TAG2))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+  
+  def testsendByTagAndMore
+    @payload = JPush::PushPayload.build(
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert'),
+      audience: JPush::Audience.build(
+       tag_and: TagAndMore))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+  
+  def testsendByTagAndMore_fail
+    @payload = JPush::PushPayload.build(
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert'),
+      audience: JPush::Audience.build(
+        tag_and: TAG2))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+  
+  def testsendByAliasMore
+    @payload = JPush::PushPayload.build(
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert'),
+      audience: JPush::Audience.build(
+        _alias: ALIAS2))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+  
+  def testsendByRegistrationIDMore
+    @payload = JPush::PushPayload.build(
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert'),
+      audience: JPush::Audience.build(
+        registration_id: REGISTRATION_ID2))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+  
+  def testsendByTagAlias
+    @payload = JPush::PushPayload.build(
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert'),
+      audience: JPush::Audience.build(
+      tag: TAG_ALL,
+      _alias: ALIAS1))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+  
+  def testsendByTagRegistrationID
+    @payload = JPush::PushPayload.build(
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert'),
+      audience: JPush::Audience.build(
+        registration_id: REGISTRATION_ID1,
+        tag: TAG_ALL))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+  
+  def testsendByTagRegistrationID_0
+    @payload = JPush::PushPayload.build(
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert'),
+      audience: JPush::Audience.build(
+        registration_id: REGISTRATION_ID1,
+        tag: TAG_NO))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+  
+  def testsendByTagAlias_0
+    @payload = JPush::PushPayload.build(
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert'),
+      audience: JPush::Audience.build(
+        tag: TAG3,
+        _alias: ALIAS1))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+  
+  def testsendByTagAlias_0_2
+    @payload = JPush::PushPayload.build(
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        alert: 'alert'),
+      audience: JPush::Audience.build(
+        tag: TAG_ALL,
+        _alias: ALIAS_NO))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+end

data/test/base_remote_tests.rb

@@ -0,0 +1,27 @@
+
+  AppKey ="dd1066407b044738b6479275"
+  MasterSecret = "2b38ce69b1de2a7fa95706ea"
+
+  CONTENT_TYPE_JSON = "application/json"
+
+  SUCCEED_RESULT_CODE = 0
+  LACK_OF_PARAMS = 1002
+  INVALID_PARAMS = 1003
+  AUTHENTICATION_FAIL = 1004
+  TOO_BIG = 1005
+  APPKEY_NOT_EXIST = 1008
+  NO_TARGET = 1011
+
+  ALERT = "JPush Test - alert"
+  MSG_CONTENT = "JPush Test - msgContent"
+  TagAndMore = ["tag1", "tag_all"]
+  TAG1 = ["tag1"]
+  TAG2 = ["tag1", "tag2"]
+  TAG3 = ["tag2"]
+  TAG_ALL = ["tag_all"]
+  TAG_NO = ["tag_no"]
+  ALIAS1 = ["alias1"]
+  ALIAS2 = ["alias1", "alias2"]
+  ALIAS_NO = ["alias_no"]
+  REGISTRATION_ID1 = ["0900e8d85ef"]
+  REGISTRATION_ID2 = ["0900e8d85ef", "0a04ad7d8b4"]

data/test/message_tests.rb

@@ -0,0 +1,49 @@
+require 'jpush'
+
+require './base_remote_tests.rb'
+
+require 'test/unit'
+
+class MessageTests < Test::Unit::TestCase
+  def setup
+    @client = JPush::JPushClient.new(AppKey, MasterSecret)
+  end
+
+  def testsendMessageContentOnly
+    @payload = JPush::PushPayload.build(
+      audience: JPush::Audience.all,
+      platform: JPush::Platform.all,
+      message: JPush::Message.build(
+        msg_content: MSG_CONTENT))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+
+  def testsendMessageContentAndTitle
+    @payload = JPush::PushPayload.build(
+      audience: JPush::Audience.all,
+      platform: JPush::Platform.all,
+      message: JPush::Message.build(
+        msg_content: MSG_CONTENT,
+        content_type: "content type",
+        title: "message title"))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+
+  def testsendMessageContentAndExtras
+    array = {}
+    array['key1'] = 'value1'
+    array['key2'] = 'value2'
+    array['key3'] = 'value3'
+    @payload = JPush::PushPayload.build(
+      audience: JPush::Audience.all,
+      platform: JPush::Platform.all,
+      message: JPush::Message.build(
+        msg_content: MSG_CONTENT,
+        extras: array))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+
+end

data/test/notification_tests.rb

@@ -0,0 +1,52 @@
+require 'jpush'
+
+require './base_remote_tests.rb'
+
+require 'test/unit'
+class NotificationTests < Test::Unit::TestCase
+  def setup
+    @client = JPush::JPushClient.new(AppKey, MasterSecret)
+  end
+  
+  def testsendNotification_android_title
+    @payload = JPush::PushPayload.build(
+      audience: JPush::Audience.all,
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        android:  JPush::AndroidNotification.build(
+          alert: 'alert',
+          title: 'title')))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+  
+  def testsendNotification_android_buildId
+    @payload = JPush::PushPayload.build(
+      audience: JPush::Audience.all,
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        android:  JPush::AndroidNotification.build(
+          alert: 'alert',
+          builder_id: 100)))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+  
+  def testsendNotification_android_extras
+    array = {}
+    array['key1'] = 'value1'
+    array['key2'] = 'value2'
+    array['key3'] = 'value3'
+    @payload = JPush::PushPayload.build(
+      audience: JPush::Audience.all,
+      platform: JPush::Platform.all,
+      notification: JPush::Notification.build(
+        android:  JPush::AndroidNotification.build(
+          alert: 'alert',
+          extras: array)))
+    res = @client.sendPush(@payload)
+    assert(res.isok, message = "")
+  end
+  
+
+end