baidu-cloud_push 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85519df09e85c1e26828005e3a55a33e684c52cc
+  data.tar.gz: 31c309c6acb70b4afc0b186e5f8a2c60bdbe30ec
+SHA512:
+  metadata.gz: 0d6952cfa53805bfab06f64fffc36fe9de78b40e86b218af114c3ba5507679e23e62f9de70c89a26b3d10756a4111762e97feb24bbbd28af97351e059f544c70
+  data.tar.gz: 7df7280856947b63e3f67ec27523fc452fb9a3af40b363bc3107c637ed25e39b29e4002b61a1d789d728ffe60fd4543221662107d825fba0a183a89f5fecb9b0

data/lib/baidu/cloud_push.rb

@@ -0,0 +1,275 @@
+require 'json'
+
+module Baidu
+	# 云推送的主类
+	#
+	# @attr_reader request [Baidu::Request] Baidu::Response 实例
+	# @attr_reader apikey [String] 应用的key
+	# @attr_reader resource_name [String] api的资源名称，如push
+	# @attr_reader method_name [String] api的请求方式，如single_device
+	# @attr_reader params [Hash] 请求参数
+	# @attr devise_type [Fixnum] 设备类型，3安卓设备，4iOS设备
+	# @attr expires [Fixnum]
+	# 	用户指定本次请求签名的失效时间。格式为unix时间戳形式，
+	# 	用于防止 replay 型攻击。为保证防止 replay攻击算法的正确有效，请保证客户端系统时间正确
+	class CloudPush
+		attr_reader :request,:apikey
+		attr_reader :resource_name,:method_name,:params
+		attr_accessor :devise_type,:expires
+		# 构造函数
+		#
+		# @param apikey [String] 应用的key
+		# @param apisecret [String] 应用的secret
+		# @param options [Hash] 自定义参数
+		# @option options [boolean] :use_ssl 默认:false，不使用https请求
+		def initialize(apikey,apisecret,options={})
+			@apikey = apikey
+			@request = Baidu::Request.new(apisecret,options)
+		end
+
+		# 推送消息到单台设备
+		#
+		# @param channel_id [String] 设备唯一的channel_id
+		# @param msg [Hash] 消息内容
+		# @param opt [Hash] 自定义参数
+		# @option opt [Fixnum] :msg_type 消息类型
+		# @option opt [Fixnum] :msg_expires 消息过期时间,unix timestamp
+		# @option opt [Fixnum] :deploy_status iOS应用部署状态
+		# @return [Baidu::Response]
+		def push_single_device(channel_id,msg,opt={})
+			set_resource_and_method(__method__)
+			@params = {channel_id:channel_id,msg:msg.to_json}.merge(opt)
+			send_request
+		end
+
+		# 推送广播消息
+		#
+		# @param msg [Hash] 消息内容
+		# @param opt [Hash] 自定义参数
+		# @option opt [Fixnum] :msg_type 消息类型
+		# @option opt [Fixnum] :msg_expires 消息过期时间,unix timestamp
+		# @option opt [Fixnum] :deploy_status iOS应用部署状态
+		# @option opt [Fixnum] :send_time 指定发送的实际时间
+		# @return [Baidu::Response]
+		def push_all(msg,opt={})
+			set_resource_and_method(__method__)
+			@params = {msg:msg.to_json}.merge(opt)
+			send_request
+		end
+
+		# 推送组播消息
+		#
+		# @param tag [String] 标签类型
+		# @param msg [Hash] 消息内容
+		# @param opt [Hash] 自定义参数
+		# @option opt [Fixnum] :msg_type 消息类型
+		# @option opt [Fixnum] :msg_expires 消息过期时间,unix timestamp
+		# @option opt [Fixnum] :deploy_status iOS应用部署状态
+		# @option opt [Fixnum] :send_time 指定发送的实际时间
+		# @return [Baidu::Response]
+		def push_tags(tag,msg,opt={})
+			set_resource_and_method(__method__)
+			@params = {msg:msg.to_json,tag:tag,type:1}.merge(opt)
+			send_request
+		end
+
+		# 推送到给定的一组设备
+		#
+		# @param channel_ids [Array<String>] 一组channel_ids
+		# @param msg [Hash] 消息内容
+		# @param opt [Hash] 自定义参数
+		# @option opt [Fixnum] :msg_type 消息类型
+		# @option opt [Fixnum] :msg_expires 消息过期时间,unix timestamp
+		# @option opt [String] :topic_id 分类主题名称
+		def push_batch_device(channel_ids,msg,opt={})
+			set_resource_and_method(__method__)
+			@params = {channel_ids: channel_ids.to_json, msg: msg.to_json}.merge(opt)
+			send_request
+		end
+
+		# 查询消息的发送状态
+		#
+		# @param msg_ids [Array<String>] msg_id的数组
+		# @return [Baidu::Response]
+		def report_query_msg_status(msg_ids)
+			set_resource_and_method(__method__)
+			@params = {msg_id: msg_ids.to_json}
+			send_request
+		end
+
+		# 查询定时消息的发送记录
+		#
+		# @param timer_id [String] 推送接口返回的timer_id
+		# @param opt [Hash] 自定义参数
+		# @option opt [Fixnum] :start 返回记录的索引起始位置
+		# @option opt [Fixnum] :limit 返回的记录条数
+		# @option opt [Fixnum] :range_start 查询的起始时间,unix timestamp
+		# @option opt [Fixnum] :range_end 查询的戒指时间,unix timestamp
+		# @return [Baidu::Response]
+		def report_query_timer_records(timer_id,opt={})
+			set_resource_and_method(__method__)
+			@params = {timer_id: timer_id}.merge(opt)
+			send_request
+		end
+
+		# 查询指定分类主题的发送记录
+		#
+		# @param topic_id [String] 分类主题的名称
+		# @param opt [Hash] 自定义参数
+		# @option opt [Fixnum] :start 返回记录的索引起始位置
+		# @option opt [Fixnum] :limit 返回的记录条数
+		# @option opt [Fixnum] :range_start 查询的起始时间,unix timestamp
+		# @option opt [Fixnum] :range_end 查询的戒指时间,unix timestamp
+		# @return [Baidu::Response]
+		def report_query_topic_records(topic_id,opt={})
+			set_resource_and_method(__method__)
+			@params = {topic_id:topic_id}.merge(opt)
+			send_request
+		end
+
+		# 查询标签组的列表
+		#
+		# @param opt [Hash] 自定义参数
+		# @option opt [String] :tag 标签名称
+		# @option opt [Fixnum] :start 返回记录的索引起始位置
+		# @option opt [Fixnum] :limit 返回的记录条数
+		# @return [Baidu::Response]
+		def app_query_tags(opt={})
+		  set_resource_and_method(__method__)
+			@params = opt
+			send_request
+		end
+
+		# 创建标签组
+		#
+		# @param tag [String] 标签名称
+		# @return [Baidu::Response]
+		def app_create_tag(tag)
+			set_resource_and_method(__method__)
+			@params = {tag: tag}
+			send_request
+		end
+
+		# 删除标签组
+		#
+		# @param tag [String] 标签名称
+		# @return [Baidu::Response]
+		def app_del_tag(tag)
+			set_resource_and_method(__method__)
+			@params = {tag:tag}
+			send_request
+		end
+
+
+		# 添加设备到标签组
+		#
+		# @param tag [String] 标签名称
+		# @param channel_ids [Array<String>] 一组channel_id
+		# @return [Baidu::Response]
+		def tag_add_devices(tag,channel_ids)
+			set_resource_and_method(__method__)
+			@params = {tag:tag,channel_ids:channel_ids.to_json}
+			send_request
+		end
+
+		# 将设备从标签组中移除
+		#
+		# @param tag [String] 标签名称
+		# @param channel_ids [Array<String>] 一组channel_id
+		# @return [Baidu::Response]
+		def tag_del_devices(tag,channel_ids)
+			set_resource_and_method(__method__)
+			@params = {tag:tag,channel_ids:channel_ids.to_json}
+			send_request
+		end
+
+		# 查询标签组设备数量
+		#
+		# @param tag [String] 标签名称
+		# @return [Baidu::Response]
+		def tag_device_num(tag)
+			set_resource_and_method(__method__)
+			@params = {tag:tag}
+			send_request
+		end
+
+		# 查询定时任务列表
+		#
+		# @param opt [Hash] 自定义参数
+		# @option opt [String] :timer_id
+		# @option opt [Fixnum] :start 返回记录的索引起始位置
+		# @option opt [Fixnum] :limit 返回的记录条数
+		# @return [Baidu::Response]
+		def timer_query_list(opt={})
+			set_resource_and_method(__method__)
+			@params = opt
+			send_request
+		end
+
+
+		# 取消定时任务
+		#
+		# @param timer_id [String] 定时任务ID
+		# @return [Baidu::Response]
+		def timer_cancel(timer_id)
+			set_resource_and_method(__method__)
+			@params = {timer_id:timer_id}
+			send_request
+		end
+
+		# 查询分类主题列表
+		#
+		# @param opt [Hash] 自定义参数
+		# @option opt [Fixnum] :start 返回记录的索引起始位置
+		# @option opt [Fixnum] :limit 返回的记录条数
+		# @return [Baidu::Response]
+		def topic_query_list(opt={})
+			set_resource_and_method(__method__)
+			@params = opt
+			send_request
+		end
+
+		# 当前应用的设备统计
+		#
+		# @return [Baidu::Response]
+		def report_statistic_device
+			set_resource_and_method(__method__)
+			@params = {}
+			send_request
+		end
+
+		# 查看分类主题统计信息
+		#
+		# @param topic_id [String] 一个已使用过的分类主题
+		# @return [Baidu::Response]
+		def report_statistic_topic(topic_id)
+			set_resource_and_method(__method__)
+			@params = {topic_id:topic_id}
+			send_request
+		end
+
+		private
+		def merge_params(args={})
+			params = {}
+			params[:expires] = Time.now.to_i + 60*@expires unless @expires.nil?
+			params[:device_type] = @device_type unless @device_type.nil?
+			params[:timestamp] = Time.now.to_i
+			params[:apikey] = @apikey
+
+			params = params.merge(args)
+			new_params = {}
+			params.sort.each{|p| new_params[p[0]] = p[1]}
+			new_params
+		end
+
+		def set_resource_and_method(method_name)
+			splited =method_name.to_s.sub("_"," ").split(" ")
+			@resource_name = splited[0]
+			@method_name = splited[1]
+		end
+
+		def send_request
+			@request.start(@resource_name,@method_name,merge_params(@params))
+		end
+	end
+end

data/lib/baidu/request.rb

@@ -0,0 +1,85 @@
+require 'net/http'
+require 'digest'
+require 'sysinfo'
+
+module Baidu
+	# 百度云推送API分装类
+	#
+	# @attr_reader apisecret [String] 应用的secret
+	# @attr_reader options [Hash] 配置参数
+	class Request
+		attr_reader :apisecret,:options
+
+		#@private
+		API_URL = '://api.tuisong.baidu.com/rest/3.0'
+
+		#@private
+		REQUEST_GET = {
+			report: ['statistic_device','statistic_topic','query_msg_status','query_timer_records','query_topic_records'],
+			app: ['query_tags'],
+			tag: ['device_num'],
+			timer: ['query_list'],
+			topic: ['query_list']
+		}
+
+		def initialize(apisecret,options = {})
+			@apisecret = apisecret
+			@options = {use_ssl: false}.merge(options)
+			@sysinfo = SysInfo.new
+		end
+
+		def start(resource,method,params={})
+			send_request(resource,method,params)
+		end
+
+		private
+		def send_request(resource,method,params)
+			uri = get_uri(resource,method)
+			type = get_type(resource,method)
+			params = params.merge({sign:gen_sign(@apisecret,type,get_url(resource,method),params)})
+			req = nil
+			case type
+			when 'GET'
+				uri.query = URI.encode_www_form(params)
+				req = Net::HTTP::Get.new(uri)
+			when 'POST'
+				req = Net::HTTP::Post.new(uri)
+				req.set_form_data(params)
+			end
+			req['Content-Type'] = "application/x-www-form-urlencoded;charset=utf-8"
+			req['User-Agent'] = "BCCS_SDK/3.0 (#{@sysinfo.os},#{@sysinfo.arch},#{@sysinfo.impl}) Ruby/#{RUBY_VERSION} (Baidu Push Server SDK V3.0.0)"
+			response = Net::HTTP.start(uri.host,uri.port,use_ssl: @options[:use_ssl]){|http| http.request(req)}
+			http_response_to_baidu_response(response)
+		end
+
+		def get_uri(resource,method)
+			URI(get_url(resource,method))
+		end
+
+		def get_type(resource,method)
+			if REQUEST_GET.has_key?(resource.to_sym) && REQUEST_GET[resource.to_sym].include?(method)
+				'GET'
+			else
+				'POST'
+			end
+		end
+
+		def get_url(resource,method)
+			http = @options[:use_ssl] ? 'https' : 'http'
+			"#{http+API_URL}/#{resource}/#{method}"
+		end
+
+		def http_response_to_baidu_response(response)
+			Baidu::Response.new(response)
+		end
+
+		def gen_sign(apisecret,requet_method,url,params)
+			parameter = requet_method+url
+			params.sort.each{|p|
+				parameter = parameter + "#{p[0]}=#{p[1]}"
+			}
+			parameter = parameter + apisecret
+			Digest::MD5.hexdigest(URI.encode_www_form_component(parameter))
+		end
+	end
+end

data/lib/baidu/response.rb

@@ -0,0 +1,43 @@
+require 'json'
+
+module Baidu
+	class Response
+		attr_reader :request_id,:response_params,:error_code,:error_msg,:result
+
+		def initialize(http_response)
+			body = JSON.parse(http_response.body)
+			if http_response.code.to_i == 200
+				# success
+				@result = true
+				@request_id = body["request_id"]
+				@response_params = body["response_params"]
+			else
+				# failed
+				@result = false
+				@request_id = body["request_id"]
+				@error_code = body["error_code"]
+				@error_msg = body["error_msg"]
+			end
+		end
+
+		# to_json
+		#
+		# @return [Hash] 返回一个Hash
+		def to_json
+			if @result
+				{
+					result: @result,
+					request_id: @request_id,
+					response_params: @response_params
+				}
+			else
+				{
+					result: @result,
+					request_id: @request_id,
+					error_code: @error_code,
+					error_msg: @error_msg
+				}
+			end
+		end
+	end
+end

data/lib/baidu.rb

@@ -0,0 +1,7 @@
+module Baidu
+
+end
+
+require 'baidu/cloud_push'
+require 'baidu/response'
+require 'baidu/request'

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: baidu-cloud_push
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tesla Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sysinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is the Ruby SDK for Baidu Cloud Push RestAPI version 3.0
+email: leechee89@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/baidu.rb
+- lib/baidu/cloud_push.rb
+- lib/baidu/request.rb
+- lib/baidu/response.rb
+homepage: https://github.com/liqites/baidu-cloud_push
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: Baidu Cloud Push Rest SDK 3.0
+test_files: []
+has_rdoc: