jpush 3.1.1 → 3.2.1

data/lib/jpush/model/notification/ios_notification.rb

@@ -1,6 +1,6 @@
 module JPush
   class IOSNotification
-    attr_accessor :alert, :sound, :badge, :extras, :content_available
+    attr_accessor :alert, :sound, :badge, :extras, :content_available, :category
     def initialize(opts = {})
       if opts[:badge] != nil
         @badge = opts[:badge]
@@ -15,6 +15,7 @@ module JPush
       @alert = opts[:alert]
       @extras = opts[:extras]
       @content_available = opts[:content_available]
+      @category = opts[:category]
     end
 
     def toJSON
@@ -32,7 +33,10 @@ module JPush
         array['extras'] = @extras
       end
       if @content_available != nil then
-        array['content-available'] = content_available
+        array['content-available'] = @content_available
+      end
+      if @category != nil then
+        array['category'] = @category
       end
       return array
     end

data/lib/jpush/model/options.rb

@@ -1,6 +1,6 @@
 module JPush
   class Options
-    attr_accessor :sendno, :time_to_live, :override_msg_id, :apns_production
+    attr_accessor :sendno, :time_to_live, :override_msg_id, :apns_production, :big_push_duration  
     def initialize(opts = {})
       if opts[:apns_production] != nil
         @apns_production = opts[:apns_production]
@@ -16,6 +16,7 @@ module JPush
       @time_to_live = 86400
       end
       @overrride_msg_id = opts[:override_msg_id]
+      @big_push_duration = opts[:big_push_duration]
     end
 
     def toJSON
@@ -32,20 +33,30 @@ module JPush
       if @apns_production != nil then
         array['apns_production'] = @apns_production
       end
+      if @big_push_duration != nil then
+        array['big_push_duration'] = @big_push_duration
+      end
       return array
     end
 
     def self.build(opts = {})
       options = JPush::Options.new(opts)
-      if options.sendno != nil&&options.sendno < 0
+      if options.sendno != nil && options.sendno < 0
         raise ArgumentError.new('sendno should be greater than 0.')
       end
-      if options.override_msg_id != nil&&options.override_msg_id < 0
+      if options.override_msg_id != nil && options.override_msg_id < 0
         raise ArgumentError.new(' override_msg_id should be greater than 0.')
       end
-      if options.time_to_live != nil&&options.time_to_live < 0
+      if options.time_to_live != nil && options.time_to_live < 0
         raise ArgumentError.new('time_to_live should be greater than 0.')
       end
+      if options.big_push_duration  != nil && options.big_push_duration > 1440
+        raise ArgumentError.new('big_push_duration should be less than 1440.')
+      end
+      
+      if options.big_push_duration  != nil && options.big_push_duration <= 0
+        raise ArgumentError.new('big_push_duration should be greater than 0.')
+      end
       return options
     end
     

data/lib/jpush/model/push_payload.rb

@@ -45,6 +45,12 @@ The object you should build for sending a push.
       if payload.notification.to_s.bytesize + payload.message.to_s.bytesize > 1200
         raise ArgumentError.new('notfication and message size is longer than 1200 ')
       end
+      if payload.options == nil
+        options = JPush::Options.build(
+        :time_to_live=> 86400,
+        :apns_production=> false)
+        payload.options = options
+      end
       return payload
     end
 

data/lib/jpush/model/push_result.rb

@@ -10,9 +10,9 @@ module JPush
       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)
-        logger.info('Error Message',wrapper.error)
-        raise RuntimeError.new('response error')
+        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)
@@ -29,4 +29,4 @@ module JPush
       return array.to_json
     end
   end
-end
+end

data/lib/jpush/model/receiveds_result.rb

@@ -11,9 +11,9 @@ module JPush
       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)
-        raise RuntimeError.new('response error')
+        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)

data/lib/jpush/model/tag_alias.rb

@@ -0,0 +1,62 @@
+module JPush
+  class TagAlias
+    attr_accessor :add, :remove, :alias ,:tags
+    def initialize(opts = {})
+      if opts[:add] != nil
+        if  opts[:add].class == Array
+          @add = opts[:add]
+        else
+          raise ArgumentError.new('add should be array.')
+        end
+      end
+
+      if opts[:remove] != nil
+        if  opts[:remove].class == Array
+          @remove = opts[:remove]
+        else
+          raise ArgumentError.new('add should be array.')
+        end
+      end
+
+      if opts[:alias] != nil
+        @alias = opts[:alias]
+      end
+    end
+
+    def toJSON
+      hash = {}
+      tags = {}
+      if @add != nil
+        tags['add'] = @add
+      end
+      if @remove != nil
+        tags['remove'] = @remove
+      end
+      if @alias != nil
+        hash['alias'] = @alias
+      end
+      if @tags == ''
+       hash['tags'] = @tags
+       else
+         hash['tags'] = tags  
+      end
+      
+      return hash
+    end
+
+      
+    
+    
+    def self.clear
+      tags = JPush::TagAlias.new
+      tags.tags = ''
+      tags.alias = ''
+      return tags;
+    end
+    
+    def self.build(opts = {})
+      tagAlias = JPush::TagAlias.new(opts)
+      return tagAlias
+    end
+  end
+end

data/lib/jpush/model/tag_alias_result.rb

@@ -0,0 +1,32 @@
+require 'json'
+
+module JPush
+  class TagAliasResult
+    attr_accessor :tags, :alias, :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)
+      @tags = hash['tags']
+      @alias = hash['alias']
+      @isok=true
+      return self
+    end
+    
+    def toJSON
+      array={}
+      array['tags'] = @tags
+      array['alias'] = @alias
+      return array
+    end
+  end
+end

data/lib/jpush/model/tag_list_result.rb

@@ -0,0 +1,32 @@
+require 'json'
+
+module JPush
+  class TagListResult
+     attr_accessor :tags, :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)
+      @tags = hash['tags']
+      @isok=true
+      return self
+    end
+    
+    def toJSON
+      array={}
+      array['tags'] = @tags
+      return array
+    end
+    
+  end
+end

data/lib/jpush/model/tag_manager.rb

@@ -0,0 +1,44 @@
+module JPush
+  class TagManager
+     attr_accessor :add, :remove
+     
+    def initialize(opts = {})
+      if opts[:add] != nil
+        if  opts[:add].class == Array && opts[:add].length <= 1000
+          @add = opts[:add]
+        else
+          raise ArgumentError.new('add should be array and size <= 1000.')
+        end
+      end
+
+      if opts[:remove] != nil
+        if  opts[:remove].class == Array && opts[:remove].length <= 1000
+          @remove = opts[:remove]
+        else
+          raise ArgumentError.new('add should be array and size <= 1000.')
+        end
+      end
+
+    end
+
+    def toJSON
+      hash = {}
+      registration_ids = {}
+      if @add != nil
+        registration_ids['add'] = @add
+      end
+      if @remove != nil
+        registration_ids['remove'] = @remove
+      end
+
+      hash['registration_ids'] = registration_ids
+      return hash
+    end
+    
+     def self.build(opts = {})
+      tm = JPush::TagManager.new(opts)
+      return tm
+    end
+    
+  end
+end

data/lib/jpush/model/user_result.rb

@@ -0,0 +1,40 @@
+require 'json'
+
+module JPush
+  class UserResult
+    attr_accessor  :isok, :time_unit, :start, :duration, :items
+    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)
+      @time_unit = hash['time_unit']
+      @start = hash['start']
+      @duration = hash['duration']
+      @itmes = hash['items']
+      @isok = true
+      return self
+    end
+
+    def toJSON
+      array = {}
+      array['time_unit'] = @time_unit
+      array['start'] = @start
+      array['duration'] = @duration
+      array['items'] = @items
+      return array.to_json
+    end
+
+  end
+
+
+end

data/lib/jpush/push_client.rb

@@ -1,4 +1,4 @@
-path= File.expand_path('../', __FILE__)
+path = File.expand_path('../', __FILE__)
 require File.join(path, 'http_client.rb')
 require File.join(path, 'model/push_result.rb')
 require 'json'
@@ -10,6 +10,7 @@ timeToLive If not present, the default is 86400(s) (one day).
 module JPush
   class PushClient
     @@PUSH_API_URL = 'https://api.jpush.cn/v3/push'
+    @@VALIDATE = '/validate'
     @@_timeToLive = 60 * 60 * 24
     def initialize(maxRetryTimes)
       @httpclient = JPush::NativeHttpClient.new(maxRetryTimes)
@@ -17,15 +18,28 @@ module JPush
 
 =begin
 @param payload is the instance of PushPayload
-@autoCode
 =end
-    def sendPush(payload,autoCode)
+    def sendPush(payload)
       json_data = JSON.generate(payload.toJSON)
       result = JPush::PushResult.new
-      wrapper = @httpclient.sendPost(@@PUSH_API_URL, json_data, autoCode)
+      wrapper = @httpclient.sendPost(@@PUSH_API_URL, json_data)
       result.fromResponse(wrapper)
       return result
     end
 
+=begin
+The API is used only to verify push call whether can succeed,
+lies in the difference with the push of API: not to send any message to user.
+@param payload is the instance of PushPayload
+=end
+    def validate(payload)
+      json_data = JSON.generate(payload.toJSON)
+      result = JPush::PushResult.new
+      wrapper = @httpclient.sendPost(@@PUSH_API_URL + @@VALIDATE, json_data)
+      result.fromResponse(wrapper)
+      return result
+    end
+    
+    
   end
 end

data/lib/jpush/report_client.rb

@@ -14,23 +14,28 @@ module JPush
     end
 
 
-    def getReceiveds(msg_ids, authcode)
+    def getReceiveds(msg_ids)
       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)
+      wrapper = @httpclient.sendGet(@url, nil)
       return result.fromResponse(wrapper)
     end
 
-    def getMessages(msg_ids, authcode)
+    def getMessages(msg_ids)
       msg_ids = checkMsgids(msg_ids)
       @url = @@REPORT_HOST_NAME + @@REPORT_MESSAGE_PATH + '?msg_ids=' + msg_ids
-      return @httpclient.sendGet(@url, nil, authcode)
+      result = JPush::GetMessagesResult.new
+      wrapper = @httpclient.sendGet(@url, nil)
+      return result.fromResponse(wrapper)
     end
 
-    def getUsers(timeUnit, start, duration, authcode)
+    def getUsers(timeUnit, start, duration)
       @url = @@REPORT_HOST_NAME + @@REPORT_USER_PATH + '?time_unit=' + timeUnit + '&start=' + start + '&duration=' + duration.to_s
-      return @httpclient.sendGet(@url, nil, authcode)
+      result = JPush::UserResult.new
+      puts @url
+      wrapper = @httpclient.sendGet(@url, nil)
+      return result.fromResponse(wrapper)
     end
 
     def checkMsgids(msg_ids)

data/lib/jpush/response_wrapper.rb

@@ -31,6 +31,7 @@ module JPush
     
     def setErrorObject
       @error = JSON.parse @responseContent
+      @error = @error['error']
     end
   end
-end
+end

data/lib/jpush/util/service_helper.rb

@@ -4,7 +4,8 @@ class ServiceHelper
   
   def self.getAuthorizationBase64(appKey, masterSecret)
      encodeKey = appKey + ":" + masterSecret
-     return @@BASIC_PREFIX + " " + Base64.strict_encode64(encodeKey)
-
+     value = @@BASIC_PREFIX + " " + Base64.encode64(encodeKey)
+     value.gsub!("\n", '')
+     return value
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jpush
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.1
 platform: ruby
 authors:
 - JPush Offical
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2015-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -32,19 +32,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".project"
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- example/push_example.rb
-- example/report_example.rb
-- jpush.gemspec
 - lib/jpush.rb
+- lib/jpush/api_connection_exception.rb
+- lib/jpush/device_client.rb
 - lib/jpush/http_client.rb
 - lib/jpush/jpush_client.rb
+- lib/jpush/model/alias_uids_result.rb
 - lib/jpush/model/audience.rb
+- lib/jpush/model/exist_result.rb
+- lib/jpush/model/get_messages_result.rb
 - lib/jpush/model/message.rb
 - lib/jpush/model/messages_result.rb
 - lib/jpush/model/notification/android_notification.rb
@@ -56,17 +52,15 @@ files:
 - lib/jpush/model/push_payload.rb
 - lib/jpush/model/push_result.rb
 - lib/jpush/model/receiveds_result.rb
+- lib/jpush/model/tag_alias.rb
+- lib/jpush/model/tag_alias_result.rb
+- lib/jpush/model/tag_list_result.rb
+- lib/jpush/model/tag_manager.rb
+- lib/jpush/model/user_result.rb
 - lib/jpush/push_client.rb
 - lib/jpush/report_client.rb
 - lib/jpush/response_wrapper.rb
 - lib/jpush/util/service_helper.rb
-- test/alert_override_tests.rb
-- test/audience_tests.rb
-- test/base_remote_tests.rb
-- test/message_tests.rb
-- test/notification_tests.rb
-- test/push_payload_test.rb
-- test/report_function_tests.rb
 homepage: https://github.com/jpush/jpush-api-ruby-client
 licenses:
 - GNU
@@ -91,11 +85,4 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: JPush's officially supported Ruby client library for accessing JPush APIs.
-test_files:
-- test/alert_override_tests.rb
-- test/audience_tests.rb
-- test/base_remote_tests.rb
-- test/message_tests.rb
-- test/notification_tests.rb
-- test/push_payload_test.rb
-- test/report_function_tests.rb
+test_files: []