jpush 3.1.1 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfdeeb5127c6c5ea4368402101d00b34880fd8ad
-  data.tar.gz: d1c859beb378456dd060afa9c5606980311494a2
+  metadata.gz: afc8cbc7711185ef95c4a147eee1be80a71cc18c
+  data.tar.gz: 7c16e63e9a0b54c83ea290a38a36f2205d9903e4
 SHA512:
-  metadata.gz: 4af6fe459fc2f34c646d3b15950111279101626e49e23db88050b4ce5bf1371372aac62294b52d0f3ea8bec61fbe2211e23808f978727870fbad007f7512c3b0
-  data.tar.gz: d8bcdb83e0a48a3fc5ea1b93e703926100e74a3fd7619dac204958713600e1ab383d327890f52df430dec06f4c8945d18b101d83f817bdc4fc620fd10153a8d4
+  metadata.gz: ef8fdb050300bb47b07d32d1de23497f2335e3d2aa21d4817cdb6207bdb0864acc4e2fdc08b52a8c50387c098fa2b518aca29393636691cfae52673892850997
+  data.tar.gz: 44f804cf52523e6cdc09194923074e51058126212e8058b8f7f80f7b4a98575fe41d229a193a37f9c269135f29b4be36dbaf2862aa05becc2250de1942cc946e

data/lib/jpush.rb

@@ -17,4 +17,14 @@ module JPush
   autoload :Notification,'jpush/model/notification/notification'
   autoload :PushResult, 'jpush/model/push_result'
   autoload :ReceivedsResult, 'jpush/model/receiveds_result'
+  autoload :DeviceClient, 'jpush/device_client'
+  autoload :TagManager, 'jpush/model/tag_manager'
+  autoload :TagAlias, 'jpush/model/tag_alias'
+  autoload :TagAliasResult, 'jpush/model/tag_alias_result'
+  autoload :ExistResult, 'jpush/model/exist_result'
+  autoload :TagListResult, 'jpush/model/tag_list_result'
+  autoload :AliasUidsResult, 'jpush/model/alias_uids_result'
+  autoload :ApiConnectionException, 'jpush/api_connection_exception'
+  autoload :GetMessagesResult, 'jpush/model/get_messages_result'
+  autoload :UserResult, 'jpush/model/user_result'
 end

data/lib/jpush/api_connection_exception.rb

@@ -0,0 +1,11 @@
+path =  File.expand_path('../', __FILE__)
+require File.join(path, 'response_wrapper.rb')
+
+module JPush
+  class ApiConnectionException < Exception
+    attr_accessor :res_wrapper
+    def initialize(wrapper)
+      @res_wrapper = wrapper
+    end
+  end
+end

data/lib/jpush/device_client.rb

@@ -0,0 +1,84 @@
+path= File.expand_path('../', __FILE__)
+require File.join(path, 'http_client.rb')
+require 'json'
+
+=begin
+Entrance for Device api.
+=end
+module JPush
+  class DeviceClient
+    @@DEVICE_HOST_NAME = 'https://device.jpush.cn'
+    @@DEVICE_PATH = '/v3/devices/'
+    @@TAG_PATH_LIST = '/v3/tags/'
+    
+    def initialize(maxRetryTimes)
+      @httpclient = JPush::NativeHttpClient.new(maxRetryTimes)
+    end
+
+    def getDeviceTagAlias(registration_id)
+      result = JPush::TagAliasResult.new
+      url = @@DEVICE_HOST_NAME + @@DEVICE_PATH + registration_id
+      puts url
+      wrapper = @httpclient.sendGet(url, nil)
+      result.fromResponse(wrapper)
+      return result
+    end
+
+    def updateDeviceTagAlias(registration_id, tagAlias)
+      json_data = JSON.generate(tagAlias.toJSON)
+      url = @@DEVICE_HOST_NAME + @@DEVICE_PATH + registration_id 
+      return @httpclient.sendPost(url, json_data)
+    end
+
+    def getAppkeyTagList()
+      url = @@DEVICE_HOST_NAME + @@TAG_PATH_LIST
+      tag_list = JPush::TagListResult.new
+      wrapper =  @httpclient.sendGet(url, nil)
+      tag_list.fromResponse(wrapper)
+      return tag_list
+    end
+
+    def userExistsInTag(tag_value, registration_id)
+      result = JPush::ExistResult.new
+      url = @@DEVICE_HOST_NAME + '/v3/tags/' + tag_value + '/registration_ids/' + registration_id 
+      wrapper = @httpclient.sendGet(url, nil)
+      result.fromResponse(wrapper)
+      return result
+    end
+    
+    def  tagAddingOrRemovingUsers(tag_value, tagManager)
+      json_data = JSON.generate(tagManager.toJSON)
+      url = @@DEVICE_HOST_NAME + '/v3/tags/' + tag_value
+      return @httpclient.sendPost(url, json_data)
+    end
+    
+    def tagDelete(tag_value, platform)
+
+      url = @@DEVICE_HOST_NAME + '/v3/tags/' + tag_value 
+      if platform != nil
+        url = url + '?platform=' + platform 
+      end
+      return @httpclient.sendDelete(url, nil)
+    end
+    
+    def getAliasUids(alias_value, platform)
+      aliasUidsResult = JPush::AliasUidsResult.new
+      url = @@DEVICE_HOST_NAME + '/v3/aliases/' + alias_value  
+      if platform != nil
+        url = url + '?platform=' + platform
+      end
+      wrapper = @httpclient.sendGet(url, nil)
+      aliasUidsResult.fromResponse(wrapper)
+      return aliasUidsResult
+    end
+    
+    def aliasDelete(alias_value, platform)
+      url = @@DEVICE_HOST_NAME + '/v3/aliases/' + alias_value  
+      if platform != nil
+        url = url + '?platform=' + platform 
+      end
+      return @httpclient.sendDelete(url, nil)
+    end
+    
+  end
+end

data/lib/jpush/http_client.rb

@@ -8,32 +8,39 @@ require 'net/https'
 
 module JPush
   class NativeHttpClient
-    def initialize(maxRetryTimes = 5)
+    def initialize(maxRetryTimes = 5, opts = {})
       @maxRetryTimes = maxRetryTimes
       @logger = Logger.new(STDOUT)
+      @@proxy_addr = opts[:proxy_addr]
+      @@proxy_port = opts[:proxy_port]
     end
 
-    def sendPost(url, content, authCode)
-      return sendRequest(url, content, 'POST', authCode)
+    def sendPost(url, content)
+      return sendRequest(url, content, 'POST')
     end
 
-    def sendGet(url, content, authCode)
-      return sendRequest(url, content, 'GET', authCode)
+    def sendGet(url, content)
+      return sendRequest(url, content, 'GET')
     end
+    
+    def sendDelete(url, content)
+      return sendRequest(url, content, 'DELETE')
+    end
+    
     private
 
-    def sendRequest(url, content, method, authCode)
-      wrapper = _sendRequest(url, content, method, authCode)
+    def sendRequest(url, content, method)
       retryTimes = 0
       while retryTimes < @maxRetryTimes
         begin
-          response = _sendRequest(url, content, method, authCode)
+          wrapper = _sendRequest(url, content, method)
           break
-        rescue 
+        rescue Exception=> ex
+        puts ex.class
           if retryTimes > @maxRetryTimes
             raise RuntimeError.new('connect error')
           else
-            @logger.debug('Retry again - ' + (retryTimes + 1))
+            @logger.debug('Retry again - ' + (retryTimes + 1).to_s)
             retryTimes = retryTimes + 1
           end
         end
@@ -42,7 +49,7 @@ module JPush
     end
     private
 
-    def _sendRequest(url, content, method, authCode)
+    def _sendRequest(url, content, method)
       begin
 
         header = {}
@@ -50,22 +57,26 @@ module JPush
         header['Connection'] = 'Keep-Alive'
         header['Charset'] = 'UTF-8'
         header['Content-Type'] = 'application/json'
-        header['Authorization'] = authCode
+        header['Authorization'] = $authcode
         #url = url+content
+        #url.gsub!(/[^\w$&\-+.,\/:;=?@]/) { |x| x = format("%%%x", x[0]) }
+        url = URI.escape(url)
         uri = URI.parse(url)
-        http = Net::HTTP.new(uri.host, uri.port)
+        http = Net::HTTP.new(uri.host, uri.port, @@proxy_addr, @@proxy_port)
         http.use_ssl = true
-        #http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        http.open_timeout = 5
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http.open_timeout = 30
         http.read_timeout = 30
         use_ssl = true
         if method == 'POST' && use_ssl == true
           req = Net::HTTP::Post.new(uri.path, initheader = header)
-        req.body = content
-        response = http.request(req)
+          req.body = content
+          response = http.request(req)
         elsif method == 'GET' && use_ssl == true
           request = Net::HTTP::Get.new(uri.request_uri, initheader = header)
           response = http.request(request)
+        elsif  method == 'DELETE' && use_ssl == true
+          response = http.delete(uri.path, initheader = header)
         end
         #if method == 'POST'
         # @response = http.post(path,content,header)
@@ -78,11 +89,14 @@ module JPush
         wrapper.code = code
         wrapper.setResponseContent(response.body)
         headers = response.header.to_hash
+        if response['X-Rate-Limit-Limit'] == nil
+        else
         quota = response['X-Rate-Limit-Limit']
         remaining = response['X-Rate-Limit-Remaining']
         reset = response['X-Rate-Limit-Reset']
-
         wrapper.setRateLimit(Integer(quota), Integer(remaining), Integer(reset))
+        end
+        
         if code == 200
           @logger.debug('Succeed to get response - 200 OK')
           if content != nil

data/lib/jpush/jpush_client.rb

@@ -14,7 +14,6 @@ Create a JPush Client.
 masterSecret API access secret of the appKey.
 appKey The KEY of one application on JPush.
 =end
-
     def initialize(appkey, masterSecret, maxRetryTimes = 5)
       begin
         @logger = Logger.new(STDOUT)
@@ -33,22 +32,28 @@ appKey The KEY of one application on JPush.
       @masterSecret = masterSecret
       @pushClient = JPush::PushClient.new(maxRetryTimes = maxRetryTimes)
       @reportClient = JPush::ReportClient.new(maxRetryTimes = maxRetryTimes)
-      @authcode = ServiceHelper.getAuthorizationBase64(appkey, masterSecret)
+      @deviceClient = JPush::DeviceClient.new(maxRetryTimes = maxRetryTimes)
+      $authcode = ServiceHelper.getAuthorizationBase64(appkey, masterSecret)
     end
 
     # Send a push with object.
     # @param pushPayload payload object of a push.
     # @return JSON data.
     def sendPush(payload)
-      result = @pushClient.sendPush(payload, @authcode)
+      result = @pushClient.sendPush(payload)
       return  result
     end
 
+    def validate(payload)
+      result = @pushClient.validate(payload)
+      return result
+    end
+
     #Get received report.
     # @param msgIds 100 msgids to batch getting is supported.
     # @return JSON data.
     def getReportReceiveds(msgIds)
-      result = @reportClient.getReceiveds(msgIds, @authcode)
+      result = @reportClient.getReceiveds(msgIds)
       return result
     end
 
@@ -56,7 +61,7 @@ appKey The KEY of one application on JPush.
     # @param msgIds 100 msgids to batch getting is supported.
     # @return JSON data.
     def getReportMessages(msgIds)
-      result =  @reportClient.getMessages(msgIds, @authcode)
+      result =  @reportClient.getMessages(msgIds)
       return result
     end
 
@@ -65,11 +70,80 @@ appKey The KEY of one application on JPush.
     #@param start is a string for example 2014-06-10
     #@duration
     # @return JSON data.
-
     def getReportUsers(timeUnit, start, duration)
-      result =  @reportClient.getUsers(timeUnit, start, duration, @authcode)
+      result =  @reportClient.getUsers(timeUnit, start, duration)
       return result
     end
 
+    # Get user profile
+    #@param registration_id
+    #Response Data
+    #{
+    #  "tags": ["tag1", "tag2"],
+    #  "alias": "alias1"  }
+    def getDeviceTagAlias(registration_id)
+      return @deviceClient.getDeviceTagAlias(registration_id)
+    end
+
+=begin
+Update user device profile
+@param registration_id
+@param tagAlias
+=end
+    def updateDeviceTagAlias(registration_id, tagAlias)
+      return @deviceClient.updateDeviceTagAlias(registration_id, tagAlias);
+    end
+
+=begin
+Appkey Tag List
+=end
+    def getAppkeyTagList()
+      return @deviceClient.getAppkeyTagList
+    end
+
+=begin
+User Exists In Tag
+@param tag_value
+@param registration_id
+=end
+    def userExistsInTag(tag_value, registration_id)
+      return @deviceClient.userExistsInTag(tag_value, registration_id)
+    end
+
+=begin
+Tag Adding or Removing Users
+@param tag_value
+@param registration_ids
+=end
+    def  tagAddingOrRemovingUsers(tag_value, registration_ids)
+      return @deviceClient.tagAddingOrRemovingUsers(tag_value, registration_ids)
+    end
+
+=begin
+Tag Delete
+@param tag_value
+@param platform default is all
+=end
+    def tagDelete(tag_value, platform = nil)
+      return @deviceClient.tagDelete(tag_value, platform)
+    end
+
+=begin
+get alias uids
+@param alias_value
+@param platform default is all
+=end
+    def getAliasUids(alias_value, platform = nil)
+      return @deviceClient.getAliasUids(alias_value, platform)
+    end
+
+=begin
+Alias Delete
+@param alias_value
+@param  platform
+=end
+    def aliasDelete(alias_value, platform = nil)
+      return @deviceClient.aliasDelete(alias_value, platform)
+    end
   end
 end

data/lib/jpush/model/alias_uids_result.rb

@@ -0,0 +1,32 @@
+require 'json'
+
+module JPush
+  class AliasUidsResult
+     attr_accessor :registration_ids, :isok
+     
+    def initialize
+      @isok=false
+    end
+    def fromResponse(wrapper)
+      if wrapper.code != 200
+        logger = Logger.new(STDOUT)
+        logger.error('Error response from JPush server. Should review and fix it. ')
+        logger.info('HTTP Status:' + wrapper.code.to_s)
+        logger.info('Error Message:' + wrapper.error.to_s)
+        raise JPush::ApiConnectionException.new(wrapper)
+      end
+      content = wrapper.getResponseContent
+      hash = JSON.parse(content)
+      @registration_ids = hash['registration_ids']
+      @isok=true
+      return self
+    end
+    
+    def toJSON
+      array={}
+      array['registration_ids'] = @registration_ids
+      return array
+    end
+    
+  end
+end

data/lib/jpush/model/exist_result.rb

@@ -0,0 +1,33 @@
+require 'json'
+require 'logger'
+
+module JPush
+  class ExistResult
+     attr_accessor :result, :isok
+     
+    def initialize
+      @isok=false
+    end
+    def fromResponse(wrapper)
+      if wrapper.code != 200
+        logger = Logger.new(STDOUT)
+        logger.error('Error response from JPush server. Should review and fix it. ')
+        logger.info('HTTP Status:' + wrapper.code.to_s)
+        logger.info('Error Message:' + wrapper.error.to_s)
+        raise JPush::ApiConnectionException.new(wrapper)
+      end
+      content = wrapper.getResponseContent
+      hash = JSON.parse(content)
+      @result = hash['result']
+      @isok=true
+      return self
+    end
+    
+    def toJSON
+      array={}
+      array['result'] = @result
+      return array
+    end
+    
+  end
+end

data/lib/jpush/model/get_messages_result.rb

@@ -0,0 +1,30 @@
+require 'json'
+
+module JPush
+  class GetMessagesResult
+    attr_accessor  :isok, :result
+    def initialize
+      @isok = false
+    end
+
+    def fromResponse(wrapper)
+      if wrapper.code != 200
+        logger = Logger.new(STDOUT)
+        logger.error('Error response from JPush server. Should review and fix it. ')
+        logger.info('HTTP Status:' + wrapper.code.to_s)
+        logger.info('Error Message' + wrapper.error.to_s)
+        raise JPush::ApiConnectionException.new(wrapper)
+      end
+      content = wrapper.getResponseContent
+      @result = JSON.parse(content)
+      return self
+    end
+
+    def toJSON
+      return @result.to_json
+    end
+
+  end
+
+
+end