jpush 3.1.1

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/example/push_example.rb

@@ -0,0 +1,101 @@
+require 'jpush'
+
+master_secret = '2b38ce69b1de2a7fa95706ea'
+app_key = 'dd1066407b044738b6479275'
+client = JPush::JPushClient.new(app_key, master_secret)
+
+logger = Logger.new(STDOUT)
+#send broadcast
+payload1 = JPush::PushPayload.build(
+ platform: JPush::Platform.all,
+ audience: JPush::Audience.all,
+ notification: JPush::Notification.build(
+   alert: 'alert meassage')
+)
+result = client.sendPush(payload1)
+logger.debug("Got result  " +  result.toJSON)
+ 
+#send winphone
+payload1 = JPush::PushPayload.build(
+  platform: JPush::Platform.all,
+  audience: JPush::Audience.all,
+  notification: JPush::Notification.build(
+    alert: 'alert meassage',
+    winphone: JPush::WinphoneNotification.build(
+      alert: "winphone notification alert test",
+      title: "winphone notification title test",
+      _open_page: "/friends.xaml",
+      extras: {"key1" => "value1", "key2" => "value2"})))
+result = client.sendPush(payload1)
+logger.debug("Got result  " +  result.toJSON)
+
+#send android WithExtrasMessage
+payload1 = JPush::PushPayload.build(
+  platform: JPush::Platform.all,
+  audience: JPush::Audience.all,
+  notification: JPush::Notification.build(
+    alert: 'alert meassage',
+    android: JPush::AndroidNotification.build(
+      alert: "android notification alert test",
+      title: "android notification title test",
+      builder_id: 1,
+      extras: {"key1" => "value1", "key2" => "value2"})),
+  message: JPush::Message.build(
+    msg_content: "message content test",
+    title: "message title test",
+    content_type: "message content type test",
+    extras: {"key1" => "value1", "key2" => "value2"})
+)
+result = client.sendPush(payload1)
+logger.debug("Got result  " +  result.toJSON)
+
+#send ios WithExtrasMessageANDoptions
+payload1 = JPush::PushPayload.build(
+  platform: JPush::Platform.all,
+  audience: JPush::Audience.all,#audience: JPush::Audience.build{ _alias : "your alias"}
+  notification: JPush::Notification.build(
+    alert: 'alert meassage',
+    ios: JPush::IOSNotification.build(
+      alert: "ios notification alert test",
+      title: "ios notification title test",
+      badge: 1,
+      sound: "happy",
+      extras: {"key1" => "value1", "key2" => "value2"})),
+  message: JPush::Message.build(
+    msg_content: "message content test",
+    title: "message title test",
+    content_type: "message content type test",
+    extras: {"key1" => "value1", "key2" => "value2"}),
+    options:JPush::Options.build(
+    sendno: 1,
+    apns_production: true))
+result = client.sendPush(payload1)
+logger.debug("Got result  " +  result.toJSON)
+
+#sendByTag
+payload = JPush::PushPayload.build(
+  platform: JPush::Platform.all,
+  notification: JPush::Notification.build(
+    alert: 'alert'),
+  audience: JPush::Audience.build(
+    tag: ["tag1"]))
+res = client.sendPush(payload)
+logger.debug("Got result  " +  res.toJSON)
+#sendByTagAnd
+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)
+logger.debug("Got result  " +  res.toJSON)
+#sendByAlias
+payload = JPush::PushPayload.build(
+  platform: JPush::Platform.all,
+  notification: JPush::Notification.build(
+    alert: 'alert'),
+  audience: JPush::Audience.build(
+    _alias: ["alias1"]))
+res = client.sendPush(payload)
+logger.debug("Got result  " +  res.toJSON)

data/example/report_example.rb

@@ -0,0 +1,18 @@
+require 'jpush'
+
+master_secret = '2b38ce69b1de2a7fa95706ea'
+app_key = 'dd1066407b044738b6479275'
+client = JPush::JPushClient.new(app_key, master_secret)
+logger = Logger.new(STDOUT)
+
+#getReceiveds
+result = client.getReportReceiveds('1942377665')
+logger.debug("Got result - " + result.toJSON)
+
+#getMessages
+#result = client.getReportMessages('1942377665')
+#logger.debug("Got result - " + result)
+
+#getUsers
+#result = client.getReportUsers('DAY',"2014-06-10",'3')
+#logger.debug("Got result - " + result)

data/jpush.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "jpush"
+  spec.version       = "3.1.1"
+  spec.authors       = ['JPush Offical']
+  spec.email         = ['support@jpush.cn']
+  spec.description   = "JPush's officially supported Ruby client library for accessing JPush APIs. http://jpush.cn"
+  spec.summary       = "JPush's officially supported Ruby client library for accessing JPush APIs."
+  spec.homepage      = "https://github.com/jpush/jpush-api-ruby-client"
+  spec.license       = "GNU"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 2.6"
+  #spec.add_runtime_dependency "rest-client","~> 1.6.7"
+  #spec.add_runtime_dependency "json", "~> 1.7.7"
+
+end

data/lib/jpush.rb

@@ -0,0 +1,20 @@
+
+module JPush
+
+  #V3
+  autoload :JPushClient,'jpush/jpush_client.rb'
+  autoload :NativeHttpClient,'jpush/http_client'
+  autoload :PushClient,'jpush/push_client'
+  autoload :ReportClient,'jpush/report_client'
+  autoload :Audience,'jpush/model/audience'
+  autoload :Message,'jpush/model/message'
+  autoload :Options,'jpush/model/options'
+  autoload :Platform,'jpush/model/platform'
+  autoload :PushPayload,'jpush/model/push_payload'
+  autoload :AndroidNotification,'jpush/model/notification/android_notification'
+  autoload :IOSNotification,'jpush/model/notification/ios_notification'
+  autoload :WinphoneNotification,'jpush/model/notification/winphone_notification'
+  autoload :Notification,'jpush/model/notification/notification'
+  autoload :PushResult, 'jpush/model/push_result'
+  autoload :ReceivedsResult, 'jpush/model/receiveds_result'
+end

data/lib/jpush/http_client.rb

@@ -0,0 +1,124 @@
+path =  File.expand_path('../', __FILE__)
+require File.join(path, 'response_wrapper.rb')
+require 'net/http'
+require 'json'
+require 'logger'
+require 'uri'
+require 'net/https'
+
+module JPush
+  class NativeHttpClient
+    def initialize(maxRetryTimes = 5)
+      @maxRetryTimes = maxRetryTimes
+      @logger = Logger.new(STDOUT)
+    end
+
+    def sendPost(url, content, authCode)
+      return sendRequest(url, content, 'POST', authCode)
+    end
+
+    def sendGet(url, content, authCode)
+      return sendRequest(url, content, 'GET', authCode)
+    end
+    private
+
+    def sendRequest(url, content, method, authCode)
+      wrapper = _sendRequest(url, content, method, authCode)
+      retryTimes = 0
+      while retryTimes < @maxRetryTimes
+        begin
+          response = _sendRequest(url, content, method, authCode)
+          break
+        rescue 
+          if retryTimes > @maxRetryTimes
+            raise RuntimeError.new('connect error')
+          else
+            @logger.debug('Retry again - ' + (retryTimes + 1))
+            retryTimes = retryTimes + 1
+          end
+        end
+      end
+      return wrapper
+    end
+    private
+
+    def _sendRequest(url, content, method, authCode)
+      begin
+
+        header = {}
+        header['User-Agent'] = 'JPush-API-Ruby-Client'
+        header['Connection'] = 'Keep-Alive'
+        header['Charset'] = 'UTF-8'
+        header['Content-Type'] = 'application/json'
+        header['Authorization'] = authCode
+        #url = url+content
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        #http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http.open_timeout = 5
+        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)
+        elsif method == 'GET' && use_ssl == true
+          request = Net::HTTP::Get.new(uri.request_uri, initheader = header)
+          response = http.request(request)
+        end
+        #if method == 'POST'
+        # @response = http.post(path,content,header)
+        #elsif method == 'GET'
+        # @response = http.get2(path,content,header)
+        # end
+        code = response.code
+        code = Integer(code)
+        wrapper = JPush::ResponseWrapper.new
+        wrapper.code = code
+        wrapper.setResponseContent(response.body)
+        headers = response.header.to_hash
+        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))
+        if code == 200
+          @logger.debug('Succeed to get response - 200 OK')
+          if content != nil
+            @logger.debug('Response Content -' + response.body)
+          end
+        elsif code > 200 && code < 400
+          @logger.warn('Normal response but unexpected - responseCode:' + code.to_s + ',responseContent = ' + response.body)
+        else
+          @logger.error('Got error response - responseCode:' + code.to_s + ', responseContent:' + response.body)
+          case code
+          when 400
+            @logger.error('Your request params is invalid. Please check them according to error message.')
+            wrapper.setErrorObject()
+          when 401
+            @logger.error('Authentication failed! Please check authentication params according to docs.')
+            wrapper.setErrorObject()
+          when 403
+            @logger.error('Request is forbidden! Maybe your appkey is listed in blacklist?')
+            wrapper.setErrorObject()
+          when 410
+            @logger.error('Request resource is no longer in service. Please according to notice on official website.')
+            wrapper.setErrorObject()
+          when 429
+            @logger.error('Too many requests! Please review your appkey request quota.')
+            wrapper.setErrorObject()
+          when 501..504
+            @logger.error('Seems encountered server error. Maybe JPush is in maintenance? Please retry later.')
+          else
+          @logger.error('Unexpected response.')    
+          end
+        end
+      rescue SocketError => ex
+        raise SocketError.new('socket build error')
+      end
+      return wrapper
+    end
+  end
+end
+

data/lib/jpush/jpush_client.rb

@@ -0,0 +1,75 @@
+path =  File.expand_path('../', __FILE__)
+require File.join(path, 'http_client.rb')
+require File.join(path, 'push_client.rb')
+require File.join(path, 'report_client.rb')
+require File.join(path, 'util/service_helper.rb')
+
+module JPush
+=begin
+The global entrance of JPush API library.
+=end
+  class JPushClient
+=begin
+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)
+        if appkey.class == String && appkey.length == 24 then
+          @appkey = appkey
+        else
+          @logger.error('appkey is format error  ')
+        end
+        if masterSecret.class == String && masterSecret.length == 24 then
+          @masterSecret = masterSecret
+
+        else
+          @logger.error('masterSecret is format error')
+        end
+      end
+      @masterSecret = masterSecret
+      @pushClient = JPush::PushClient.new(maxRetryTimes = maxRetryTimes)
+      @reportClient = JPush::ReportClient.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)
+      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)
+      return result
+    end
+
+    #Get message report.
+    # @param msgIds 100 msgids to batch getting is supported.
+    # @return JSON data.
+    def getReportMessages(msgIds)
+      result =  @reportClient.getMessages(msgIds, @authcode)
+      return result
+    end
+
+    #Get user report.
+    #@param timeunit is 'DAY','HOUR' or 'MONTH'
+    #@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)
+      return result
+    end
+
+  end
+end

data/lib/jpush/model/audience.rb

@@ -0,0 +1,67 @@
+module JPush
+  class Audience
+    attr_accessor  :tag, :tag_and, :_alias, :registration_id, :segment, :all
+    def initialize(opts = {})
+      @all = false
+      @tag = opts[:tag]
+      @tag_and = opts[:tag_and]
+      @_alias = opts[:_alias]
+      @registration_id = opts[:registration_id]
+      @segment = opts[:segment]
+    end
+
+    def toJSON
+      if @all == true then
+        return 'all'
+      end
+      array = {}
+      if @tag != nil then
+        if @tag.class != Array
+          raise ArgumentError.new('tag is not Array')
+        end
+        array['tag'] = @tag
+      end
+      if @_alias != nil then
+        if @_alias.class != Array
+          raise ArgumentError.new('alias is not Array')
+        end
+        array['alias'] = @_alias
+      end
+      if @tag_and != nil  then
+        if @tag_and.class != Array
+          raise ArgumentError.new('tag_end is not Array')
+        end
+        array['tag_and'] = @tag_and
+      end
+      if @registration_id != nil then
+        if @registration_id.class != Array
+          raise ArgumentError.new('registration_id is not Array')
+        end
+        array['registration_id'] = @registration_id
+      end
+      return array
+    end
+
+    def self.all
+      au = JPush::Audience.new
+      au.all = true
+      return au
+    end
+
+    def self.build(opts = {})
+      audience = JPush::Audience.new(opts)
+      if audience.all == true
+        if audience.tag != nil || audience._alias != nil || audience.tag_and != nil || audience.registration_id != nil
+          raise ArgumentError.new('If audience is all, no any other audience may be set.')
+        end
+      end
+      if audience.all == false
+        if audience.tag == nil && audience._alias == nil && audience.tag_and == nil && audience.registration_id == nil
+          raise ArgumentError.new('No any audience target is set.')
+        end
+      end
+      return audience
+    end
+    
+  end
+end

data/lib/jpush/model/message.rb

@@ -0,0 +1,37 @@
+module JPush
+  class Message
+    attr_accessor :title, :msg_content, :content_type, :extras
+    def initialize(opts  =  {})
+      @title = opts[:title]
+      @msg_content = opts[:msg_content]
+      @content_type = opts[:content_type]
+      @extras = opts[:extras]
+    end
+
+    def toJSON
+      array = {}
+      if @title != nil then
+        array['title'] = @title
+      end
+      if @msg_content != nil then
+        array['msg_content'] = @msg_content
+      end
+      if @content_type != nil then
+        array['content_type'] = @content_type
+      end
+      if @extras != nil then
+        array['extras'] = @extras
+      end
+      return array
+    end
+
+    def self.build(opts = {})
+      message = JPush::Message.new(opts)
+      if nil == message.msg_content
+        raise ArgumentError.new('msgContent should be set')
+      end
+      return message
+    end
+
+  end
+end