jpush_api_ruby_client 0.0.1

data/example/client_example.rb

@@ -0,0 +1,66 @@
+require 'jpush_api_ruby_client'
+
+class ClientExample
+
+  app_key = '3af172b794896c3e1de43fe7' #必填，例如466f7032ac604e02fb7bda89
+  master_secret = '57c45646c772983eb0e7c455' #必填，每个应用都对应一个masterSecret
+
+  # 保存离线的时长。秒为单位。最多支持10天（864000秒）。
+  # 0 表示该消息不保存离线。即：用户在线马上发出，当前不在线用户将不会收到此消息。
+  # 此参数不设置则表示默认，默认为保存1天的离线消息（86400秒）。
+
+  time_to_live = 60 * 60 * 24
+
+  #
+  # Example1: 初始化,默认发送给android和ios，同时设置离线消息存活时间
+  # jpush_client = JPushApiRubyClient::Client.new(app_key, masterSecret, 'time_to_live' => time_to_live)
+  #
+  # Example2: 只发送给android
+  # jpush_client = JPushApiRubyClient::Client.new(app_key, master_secret, 'platform' => JPushApiRubyClient::PlatformType::ANDROID);
+  #
+  # Example3: 只发送给IOS
+  # jpush_client = JPushApiRubyClient::Client.new(app_key, master_secret, 'platform' => JPushApiRubyClient::PlatformType::IOS);
+  #
+  # Example4: 只发送给android,同时设置离线消息存活时间
+  # jpush_client =JPushApiRubyClient::Client.new(app_key, master_secret, 'time_to_live' => time_to_live, 'platform' => JPushApiRubyClient::PlatformType::ANDROID);
+  #
+  #Example5: 使用缺省值发送，默认 time_to_live 为保存1天的离线消息 ，发送给IOS,android两个平台
+  # jpush_client = JPushApiRubyClient::Client.new(app_key, master_secret)
+  #
+
+  jpush_client = JPushApiRubyClient::Client.new(app_key, master_secret,'platform' => JPushApiRubyClient::PlatformType::BOTH)
+
+  #jpush_client.enable_ssl(true) 是否启用https请求，缺省false
+
+
+  send_no = jpush_client.generate_send_no
+  msg_title = 'JPushApiRubyClient实例'
+
+  msg_content = '根据 appkey 发送广播通知'
+  puts send_result = jpush_client.send_notification_with_appkey(send_no, msg_title, msg_content,'extras' => {'key1'=>'value1','key2' => 'value2'})
+
+  msg_content = '根据 tag 发送通知'
+  puts send_result = jpush_client.send_notification_with_tag(send_no, 'ouyang', msg_title, msg_content)
+
+  msg_content = '根据 alias 发送通知'
+  puts send_result = jpush_client.send_notification_with_alias(send_no, '', msg_title, msg_content)
+
+  msg_content = '根据 imei 发送通知'
+  puts send_result = jpush_client.send_notification_with_imei(send_no, '', msg_title, msg_content)
+
+
+  msg_content = '根据 appkey 发送自定义消息'
+  puts send_result = jpush_client.send_message_with_appkey(send_no, msg_title, msg_content,'extras' => {'key1'=>'value1','key2' => 'value2'})
+
+  msg_content = '根据 tag 发送自定义消息'
+  puts send_result = jpush_client.send_message_with_alias(send_no, '', msg_title, msg_content)
+
+  msg_content = '根据 alias 发送自定义消息'
+  puts send_result = jpush_client.send_message_with_tag(send_no, '', msg_title, msg_content)
+
+  msg_content = '根据 imei 发送自定义消息'
+  puts send_result = jpush_client.send_message_with_imei(send_no, '', msg_title, msg_content)
+
+
+end
+

data/jpush_api_ruby_client.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jpush_api_ruby_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jpush_api_ruby_client"
+  spec.version       = JPushApiRubyClient::VERSION
+  spec.authors       = ['Xian OuYang']
+  spec.email         = ['suport@jpush.cn']
+  spec.description   = "provide a ruby api gem for jpush https://www.jpush.cn"
+  spec.summary       = "a ruby api client gem for jpush"
+  spec.homepage      = "https://github.com/aaron-codes/jpush-api-ruby-client"
+  spec.license       = "MIT"
+
+  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 "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_runtime_dependency "rest-client","~> 1.6.7"
+end

data/lib/jpush_api_ruby_client/client.rb

@@ -0,0 +1,233 @@
+require 'rest-client'
+require 'json'
+
+module JPushApiRubyClient
+
+  # HTTP
+  HTTP_JPUSH_API_URL = 'http://api.jpush.cn:8800/v2/push'
+  # HTTPS
+  HTTPS_JPUSH_API_URL = "https://api.jpush.cn:443/v2/push"
+
+  class Client
+    include PlatformType, MsgType, ReceiverType
+    attr_accessor :app_key, :master_secret, :https, :time_to_live, :platform
+
+=begin
+    * @param [String] app_key
+    * @param [String] master_secret
+    * @param [Hash] opts  opts可选参数可包含time_to_live、platform
+=end
+    def initialize(app_key, master_secret, opts ={}, &block)
+      @app_key = app_key
+      @master_secret = master_secret
+      @time_to_live = opts['time_to_live'] || 86400
+      @platform = opts['platform'] || PlatformType::BOTH
+    end
+
+=begin
+    * 当前时间戳生成send_no
+    * @return [Integer]
+=end
+    def generate_send_no
+      Integer(Time.new)
+    end
+
+=begin
+    * 是否启用https ssl连接，缺省false
+    * @param [Object]  true or false
+=end
+    def enable_ssl(https = false)
+      @https = https
+    end
+
+=begin
+    * 发送使用 appkey 推送的自定义消息
+    * @param [Integer] send_no
+    * @param [String] msg_title
+    * @param [String] msg_content
+    * @param [Hash] opts opts可选参数包含 extras、override_msg_id
+    * @return [Hash] sendno、msg_id、errcode、errmsg
+=end
+    def send_message_with_appkey(send_no, msg_title, msg_content, opts = {})
+      receiver = {:receiver_type => ReceiverType::BROADCAST}
+      send_custom_message(send_no, msg_title, msg_content, receiver, opts)
+    end
+
+=begin
+    * 发送标签带推送的自定义消息
+    * @param [Integer] send_no
+    * @param [String] tag
+    * @param [String] msg_title
+    * @param [String] msg_content
+    * @param [Hash] opts opts参数可包含  extras、override_msg_id
+    * @return [Hash] sendno、msg_id、errcode、errmsg
+=end
+    def send_message_with_tag(send_no, tag, msg_title, msg_content, opts = {})
+      receiver = {:receiver_type => ReceiverType::TAG,
+                  :receiver_value => tag}
+      send_custom_message(send_no, msg_title, msg_content, receiver, opts)
+    end
+
+=begin
+    * 发送带别名推送的自定义消息
+    * @param [Integer] send_no
+    * @param [String] alias_
+    * @param [String] msg_title
+    * @param [String] msg_content
+    * @param [Hash] opts opts参数可包含 extras、override_msg_id
+    * @return [Hash] sendno、msg_id、errcode、errmsg
+=end
+    def send_message_with_alias(send_no, alias_, msg_title, msg_content, opts = {})
+      receiver = {:receiver_type => ReceiverType::ALIAS,
+                  :receiver_value => alias_}
+      send_custom_message(send_no, msg_title, msg_content, receiver, opts)
+    end
+
+=begin
+    * 发送带 imei 推送的自定义消息
+    * @param [Integer] send_no
+    * @param [String] imei
+    * @param [String] msg_title
+    * @param [String] msg_content
+    * @param [Hash] opts opts参数可包含 extras、override_msg_id
+    * @return [Hash] sendno、msg_id、errcode、errmsg
+=end
+    def send_message_with_imei(send_no, imei, msg_title, msg_content, opts = {})
+      receiver = {:receiver_type => ReceiverType::IMEI,
+                  :receiver_value => imei}
+      send_custom_message(send_no, msg_title, msg_content, receiver, opts)
+    end
+
+=begin
+    * 发送使用 appkey 推送的通知
+    * @param [Integer] send_no
+    * @param [String] msg_title
+    * @param [String] msg_content
+    * @param [Hash] opts opts参数可包含 builder_id 、extras 、override_msg_id
+    * @return [Hash] sendno、msg_id、errcode、errmsg
+=end
+    def send_notification_with_appkey(send_no, msg_title, msg_content, opts = {})
+      receiver = {:receiver_type => ReceiverType::BROADCAST,
+                  :receiver_value => ''}
+      send_notification(send_no, msg_title, msg_content, receiver, opts)
+    end
+
+=begin
+    * 发送带标签推送的通知
+    * @param [Integer] send_no
+    * @param [String] tag
+    * @param [String] msg_title
+    * @param [String] msg_content
+    * @param [Hash] opts opts参数可包含 builder_id 、extras、override_msg_id
+    * @return [Hash] sendno、msg_id、errcode、errmsg
+=end
+    def send_notification_with_tag(send_no, tag, msg_title, msg_content, opts = {})
+      receiver = {:receiver_type => ReceiverType::TAG,
+                  :receiver_value => tag}
+      send_notification(send_no, msg_title, msg_content, receiver, opts)
+    end
+
+=begin
+    * 发送带别名推送的通知
+    * @param [Integer] send_no
+    * @param [String] alias_
+    * @param [String] msg_title
+    * @param [String] msg_content
+    * @param [Hash] opts opts参数可包含builder_id 、extras、override_msg_id
+    * @return [Hash] sendno、msg_id、errcode、errmsg
+=end
+    def send_notification_with_alias(send_no, alias_, msg_title, msg_content, opts = {})
+      receiver = {:receiver_type => ReceiverType::ALIAS,
+                  :receiver_value => alias_}
+      send_notification(send_no, msg_title, msg_content, receiver, opts)
+    end
+
+=begin
+    * 发送带IMEI号推送的通知
+    * @param [Integer] send_no
+    * @param [String] imei
+    * @param [String] msg_title
+    * @param [String] msg_content
+    * @param [Hash] opts opts参数可包含 builder_id、extras、override_msg_id
+    * @return [Hash] sendno、msg_id、errcode、errmsg
+=end
+    def send_notification_with_imei(send_no, imei, msg_title, msg_content, opts = {})
+      receiver = {:receiver_type => ReceiverType::IMEI,
+                  :receiver_value => imei}
+      send_notification(send_no, msg_title, msg_content, receiver, opts)
+    end
+
+    private
+
+    def send_notification(send_no, msg_title, msg_content, receiver, opts)
+      msg_body = {:n_content => msg_content,
+                  :n_title => msg_title,
+                  :n_builder_id => opts['builder_id'] || 0
+      }
+      msg_body[:n_extras] = opts['extras'] if opts.has_key?('extras')
+
+      msg = {:msg_type => MsgType::NOTIFICATION,
+             :msg_content => msg_body,
+             :platform => platform,
+             :time_to_live => time_to_live
+      }
+      msg[:override_msg_id] = opts['override_msg_id'] if opts.has_key?('override_msg_id')
+      send_message(send_no, msg, receiver)
+    end
+
+    def send_custom_message(send_no, msg_title, msg_content, receiver, opts)
+      msg_body = {:message => msg_content,
+                  :title => msg_title
+      }
+      msg_body[:extras] = opts['extras'] if opts.has_key?('extras')
+
+      msg = {:msg_type => MsgType::MESSAGE,
+             :msg_content => msg_body,
+             :platform => platform,
+             :time_to_live => time_to_live
+      }
+      msg[:override_msg_id] = opts['override_msg_id'] if msg.has_key?('override_msg_id')
+
+      send_message(send_no, msg, receiver)
+    end
+
+    # MD5 secret
+
+    def build_verification(send_no, receiver_type, receiver_value, master_secret)
+      verification_code = "#{send_no}#{receiver_type}#{receiver_value}#{master_secret}"
+      Digest::MD5.hexdigest(verification_code)
+    end
+
+    def send_message(send_no, msg, receiver, options={})
+      api_url = https == true ? HTTPS_JPUSH_API_URL : HTTP_JPUSH_API_URL
+      post_body = {}
+      post_body[:app_key] = app_key
+      post_body[:sendno] = send_no
+      post_body[:receiver_type] = receiver[:receiver_type]
+      post_body[:receiver_value] = receiver[:receiver_value] if receiver.has_key?(:receiver_value)
+
+      post_body[:verification_code] = build_verification(send_no,
+                                                         receiver[:receiver_type],
+                                                         receiver[:receiver_value] || '',
+                                                         master_secret)
+      post_body[:msg_type] = msg[:msg_type]
+      post_body[:msg_content] = JSON.generate(msg[:msg_content])
+      post_body[:platform] = msg[:platform]
+      post_body[:time_to_live] = msg[:time_to_live]
+      post_body[:override_msg_id] = msg[:override_msg_id] if msg.has_key?(:override_msg_id)
+
+      post_body.merge!(options)
+      post_jpush_api(api_url, post_body)
+    end
+
+    # POST JPush API
+    def post_jpush_api(api_url, post_body)
+      response_msg = RestClient.post(
+          api_url,
+          post_body,
+          content_type: "application/x-www-form-urlencoded",
+          accept: :json)
+      JSON.parse(response_msg)
+    end
+  end
+end

data/lib/jpush_api_ruby_client/msg_type.rb

@@ -0,0 +1,12 @@
+module JPushApiRubyClient
+=begin
+  * 消息类型
+=end
+  module MsgType
+
+    # 通知
+    NOTIFICATION = 1
+    # 消息
+    MESSAGE = 2
+  end
+end

data/lib/jpush_api_ruby_client/platform_type.rb

@@ -0,0 +1,14 @@
+module JPushApiRubyClient
+=begin
+  * 平台标识
+=end
+  module PlatformType
+
+    # 安卓平台
+    ANDROID = 'android'
+    # IOS平台
+    IOS = 'ios'
+    # 安卓与IOS平台
+    BOTH = 'android,ios'
+  end
+end

data/lib/jpush_api_ruby_client/receiver_type.rb

@@ -0,0 +1,16 @@
+module JPushApiRubyClient
+=begin
+  * 消息接收类型
+=end
+  module ReceiverType
+
+    # 手机串号
+    IMEI = '1'
+    # 标签
+    TAG = '2'
+    # 别名
+    ALIAS = '3'
+    # 广播
+    BROADCAST = '4'
+  end
+end

data/lib/jpush_api_ruby_client/version.rb

@@ -0,0 +1,3 @@
+module JPushApiRubyClient
+  VERSION = "0.0.1"
+end

data/lib/jpush_api_ruby_client.rb

@@ -0,0 +1,8 @@
+require File.expand_path('../jpush_api_ruby_client/version', __FILE__)
+module JPushApiRubyClient
+  autoload :Client, 'jpush_api_ruby_client/client'
+  autoload :ReceiverType, 'jpush_api_ruby_client/receiver_type'
+  autoload :PlatformType, 'jpush_api_ruby_client/platform_type'
+  autoload :MsgType, 'jpush_api_ruby_client/msg_type'
+
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: jpush_api_ruby_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Xian OuYang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+description: provide a ruby api gem for jpush https://www.jpush.cn
+email:
+- suport@jpush.cn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/Gemfile.html
+- doc/JPushApiRubyClient.html
+- doc/JPushApiRubyClient/Client.html
+- doc/JPushApiRubyClient/MsgType.html
+- doc/JPushApiRubyClient/PlatformType.html
+- doc/JPushApiRubyClient/ReceiverType.html
+- doc/LICENSE_txt.html
+- doc/Rakefile.html
+- doc/created.rid
+- doc/doc/created_rid.html
+- doc/images/add.png
+- doc/images/arrow_up.png
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/delete.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_blue.png
+- doc/images/tag_green.png
+- doc/images/transparent.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/jpush_api_ruby_client_gemspec.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/navigation.js
+- doc/js/search.js
+- doc/js/search_index.js
+- doc/js/searcher.js
+- doc/rdoc.css
+- doc/table_of_contents.html
+- example/client_example.rb
+- jpush_api_ruby_client.gemspec
+- lib/jpush_api_ruby_client.rb
+- lib/jpush_api_ruby_client/client.rb
+- lib/jpush_api_ruby_client/msg_type.rb
+- lib/jpush_api_ruby_client/platform_type.rb
+- lib/jpush_api_ruby_client/receiver_type.rb
+- lib/jpush_api_ruby_client/version.rb
+homepage: https://github.com/aaron-codes/jpush-api-ruby-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: a ruby api client gem for jpush
+test_files: []