baidu-push 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f9c16baf080244732e2b621132b4746fef3b20d
+  data.tar.gz: cbf1e368461b0a98459b9dc1ca51a46a38e70dd8
+SHA512:
+  metadata.gz: a28a7891bb1e7c6ead906baa78dfea43aa64bb51a24e86e6862797fb1c9ea28b8ac05f0d0f75f711b735fd656bb97efacd5bf05bedea4cc95a8b9b0adf311ea8
+  data.tar.gz: 99da21a5a7ba97aa76c8cce68a54c9eefb7e67d930f8f9e3cb17cae4ca18a2084a98fa61617fa1d6bfdfbdadb500aafcaba78faf2dce5ff2200d1eb31a03bd81

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.ruby-gemset
+.ruby-version
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in baidu-push-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 scorix
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Baidu::Push::Client
+
+A simple REST client for [baidu push](http://developer.baidu.com/wiki/index.php?title=docs/cplat/push/api/list)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'baidu-push', github: 'scorix/baidu-push'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+# build a baidu message
+msg = Baidu::Push::Message.new msg_keys: "#{Time.now.to_i}_test", user_id: 'userid'
+msg.messages = {title: 'test', description: 'test', custom_content: {}}
+
+# new a client instance
+client = Baidu::Push::Client.setup api_key: 'YOUR_API_KEY', secret_key: 'YOUR_SECRET_KEY'
+client.push_msg(msg)
+```
+
+Or, you can also push the message with an async way
+
+```ruby
+# build a baidu message
+msg = Baidu::Push::Message.new msg_keys: "#{Time.now.to_i}_test", user_id: 'userid'
+msg.messages = {title: 'test', description: 'test', custom_content: {}}
+
+# new a client instance
+client = Baidu::Push::AsyncClient.setup api_key: 'YOUR_API_KEY', secret_key: 'YOUR_SECRET_KEY'
+client.async.push_msg(msg)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/scorix/baidu-push/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/baidu-push.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'baidu/push/version'
+require 'baidu/push'
+
+Gem::Specification.new do |spec|
+  spec.name = 'baidu-push'
+  spec.version = Baidu::Push::VERSION
+  spec.authors = ['scorix']
+  spec.email = ['scorix@gmail.com']
+  spec.summary = %q{Baidu push client}
+  spec.description = %q{}
+  spec.homepage = ''
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0")
+  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_dependency 'faraday'
+  spec.add_dependency 'celluloid'
+  spec.add_dependency 'virtus'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/baidu/push.rb

@@ -0,0 +1,11 @@
+require 'json'
+
+module Baidu
+  module Push
+    require 'baidu/push/api'
+    require 'baidu/push/client'
+    require 'baidu/push/async_client'
+    require 'baidu/push/configuration'
+    require 'baidu/push/message'
+  end
+end

data/lib/baidu/push/api.rb

@@ -0,0 +1,27 @@
+require 'faraday'
+
+module Baidu
+  module Push
+    class API
+      attr_reader :connection
+
+      def initialize(options = {})
+        @connection = Faraday.new(url: default_domain) do |faraday|
+          faraday.request :multipart
+          faraday.request :url_encoded
+          faraday.response :logger, options[:logger] if options[:logger]
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+
+      def base_path
+        '/rest/2.0/channel'
+      end
+
+      def default_domain
+        'https://channel.api.duapp.com'
+      end
+
+    end
+  end
+end

data/lib/baidu/push/async_client.rb

@@ -0,0 +1,9 @@
+require 'celluloid'
+
+module Baidu
+  module Push
+    class AsyncClient < Client
+      include Celluloid
+    end
+  end
+end

data/lib/baidu/push/client.rb

@@ -0,0 +1,44 @@
+module Baidu
+  module Push
+
+    class Client
+      attr_accessor :config, :logger
+
+      def self.setup(options = {api_key: nil, secret_key: nil})
+        raise 'api_key can not be nil.' unless options[:api_key]
+        raise 'secret_key can not be nil.' unless options[:secret_key]
+        md5 = Digest::MD5.hexdigest([options[:api_key], options[:secret_key]].join)
+        instance_variable_get("@client_#{md5}") ||
+            instance_variable_set("@client_#{md5}", begin
+                                                    config = Configuration.new
+                                                    config.api_key = options[:api_key]
+                                                    config.secret_key = options[:secret_key]
+                                                    client = self.new
+                                                    client.config = config
+                                                    client.logger = options[:logger]
+                                                    client
+                                                  end)
+      end
+
+      def rest_api
+        @api ||= API.new(logger: logger)
+      end
+
+      def push_msg(message)
+        raise 'invalid baidu push message' unless message.is_a?(Baidu::Push::Message)
+        attr = message.non_nil_attributes
+        attr.merge!(apikey: config.api_key, method: __method__)
+        rest_api.connection.post do |req|
+          req.url "#{rest_api.base_path}/channel"
+          req.params = attr.merge(sign: get_sign('POST', "#{rest_api.default_domain}#{rest_api.base_path}/channel", attr))
+        end
+      end
+
+      private
+      def get_sign(http_method, url, params)
+        es = [http_method.to_s.upcase, url, params.sort.map { |x| "#{x[0]}=#{x[1]}" }, config.secret_key]
+        Digest::MD5.hexdigest(CGI.escape(es.flatten.join))
+      end
+    end
+  end
+end

data/lib/baidu/push/configuration.rb

@@ -0,0 +1,7 @@
+module Baidu
+  module Push
+    class Configuration
+      attr_accessor :api_key, :secret_key
+    end
+  end
+end

data/lib/baidu/push/message.rb

@@ -0,0 +1,152 @@
+# encoding: utf-8
+require 'virtus'
+
+module Baidu
+  module Push
+    class Message
+
+      include Virtus.model
+
+      # required
+      # 方法名
+      attribute :method, String
+
+      # required
+      # 访问令牌，明文AK，可从此值获得App的信息，配合sign中的sk做合法性身份认证。
+      attribute :apikey, String
+
+      # required, but don't set here
+      # 调用参数签名值，与apikey成对出现。
+      # 详细用法，请参考：[签名计算算法](http://developer.baidu.com/wiki/index.php?title=docs/cplat/push/api#.E7.AD.BE.E5.90.8D.E7.AE.97.E6.B3.95)
+      # attribute :sign, String
+
+      # required
+      # 推送类型，取值范围为：1～3
+      #   1：单个人，必须指定user_id 和 channel_id （指定用户的指定设备）或者user_id（指定用户的所有设备）
+      #   2：一群人，必须指定 tag
+      #   3：所有人，无需指定tag、user_id、channel_id
+      attribute :push_type, Integer, default: ->(_, _) { 1 }
+
+      # required
+      # 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。
+      attribute :timestamp, Integer, default: ->(_, _) { Time.now.to_i }
+
+      # required
+      # 指定消息内容，单个消息为单独字符串。如果有二进制的消息内容，请先做 BASE64 的编码。
+      # 当message_type为1 （通知类型），请按以下格式指定消息内容。
+      # 通知消息格式及默认值：
+      #
+      #    {
+      #        //android必选，ios可选
+      #        "title" : "hello" ,
+      #        “description: "hello world"
+      #
+      #        //android特有字段，可选
+      #        "notification_builder_id": 0,
+      #        "notification_basic_style": 7,
+      #        "open_type":0,
+      #        "net_support" : 1,
+      #        "user_confirm": 0,
+      #        "url": "http://developer.baidu.com",
+      #        "pkg_content":"",
+      #        "pkg_name" : "com.baidu.bccsclient",
+      #        "pkg_version":"0.1",
+      #
+      #        //android自定义字段
+      #        "custom_content": {
+      #            "key1":"value1",
+      #            "key2":"value2"
+      #        },
+      #
+      #        //ios特有字段，可选
+      #        "aps": {
+      #            "alert":"Message From Baidu Push",
+      #            "sound":"",
+      #            "badge":0
+      #        },
+      #
+      #        //ios的自定义字段
+      #        "key1":"value1",
+      #            "key2":"value2"
+      #        }
+      #    注意：
+      #
+      #    当description与alert同时存在时，ios推送以alert内容作为通知内容
+      #    当custom_content与 ios的自定义字段"key" ："value"同时存在时，ios推送的自定义字段内容会将以上两个内容合并，但推送内容整体长度不能大于256B，否则有被截断的风险。
+      #    此格式兼容Android和ios原生通知格式的推送。
+      #    如果通过Server SDK推送成功，Android端却收不到通知，解决方案请参考该：问题
+      attribute :messages, String
+
+      # required
+      # 消息标识。
+      # 指定消息标识，必须和messages一一对应。相同消息标识的消息会自动覆盖。特别提醒：该功能只支持android、browser、pc三种设备类型。
+      attribute :msg_keys, String
+
+      # optional
+      # 用户标识，在Android里，channel_id + userid指定某一个特定client。不超过256字节，如果存在此字段，则只推送给此用户。
+      attribute :user_id, String
+
+      # optional
+      # 通道标识
+      attribute :channel_id, Integer
+
+      # optional
+      # 标签名称，不超过128字节
+      attribute :tag, String
+
+      # optional
+      # 设备类型，取值范围为：1～5
+      # 云推送支持多种设备，各种设备的类型编号如下：
+      #   1：浏览器设备；
+      #   2：PC设备；
+      #   3：Android设备；(default)
+      #   4：iOS设备；
+      #   5：Windows Phone设备；
+      attribute :device_type, Integer, default: ->(_, _) { 3 }
+
+      # optional
+      # 消息类型
+      #   0：消息（透传给应用的消息体）(default)
+      #   1：通知（对应设备上的消息通知）
+      attribute :message_type, Integer, default: ->(_, _) { 0 }
+
+      # optional
+      # 指定消息的过期时间，默认为 86400 秒。必须和messages一一对应。
+      attribute :message_expires, Integer, default: ->(_, _) { 86400 }
+
+      # optional
+      # 部署状态。指定应用当前的部署状态，可取值：
+      #   1：开发状态 (default for the gem)
+      #   2：生产状态 (default at baidu)
+      # Notice: ios only
+      attribute :deploy_status, Integer, default: ->(_, _) { 1 }
+
+      # optional
+      # 用户指定本次请求签名的失效时间。格式为unix时间戳形式。
+      attribute :expires, Integer
+
+      # optional
+      # API版本号，默认使用最高版本。
+      attribute :v, Integer
+
+      def non_nil_attributes
+        attributes.reject { |_, v| v.nil? }
+      end
+
+      def messages=(msg = {})
+        message = {}
+        message[:title] = msg[:title].to_s
+        message[:description] = msg[:description].to_s
+        case device_type
+          when 3
+            message[:custom_content] = msg[:custom_content]
+          when 4
+            message[:aps] = msg[:aps]
+            msg[:custom_content].each { |k, v| message[k] = v }
+        end
+        super(message.to_json)
+      end
+
+    end
+  end
+end

data/lib/baidu/push/version.rb

@@ -0,0 +1,5 @@
+module Baidu
+  module Push
+    VERSION = '0.0.1'
+  end
+end

data/spec/baidu/push/async_client_spec.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'rspec'
+require 'logger'
+
+describe Baidu::Push::AsyncClient do
+
+  subject { Baidu::Push::AsyncClient.setup(api_key: '',
+                                           secret_key: '',
+                                           logger: Logger.new(STDOUT)) }
+
+  context 'push message' do
+    it 'should push a message, async' do
+      msg = Baidu::Push::Message.new msg_keys: "#{Time.now.to_i}_test",
+                                     user_id: '',
+                                     message_type: 1
+      msg.messages = {title: 'test', description: 'test', custom_content: {}}
+      res = subject.future.push_msg(msg)
+      expect(res.value.status).to eql 200
+    end
+  end
+
+end

data/spec/baidu/push/client_spec.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'rspec'
+require 'logger'
+
+describe Baidu::Push::Client do
+
+  subject { Baidu::Push::Client.setup(api_key: '',
+                                      secret_key: '',
+                                      logger: Logger.new(STDOUT)) }
+
+  context 'push message' do
+    it 'should push a message, sync' do
+      msg = Baidu::Push::Message.new msg_keys: "#{Time.now.to_i}_test",
+                                     user_id: '',
+                                     message_type: 1
+      msg.messages = {title: 'test', description: 'test', custom_content: {}}
+      res = subject.push_msg(msg)
+      expect(res.status).to eql 200
+    end
+  end
+
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: baidu-push
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- scorix
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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'
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  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'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- scorix@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- baidu-push.gemspec
+- lib/baidu/push.rb
+- lib/baidu/push/api.rb
+- lib/baidu/push/async_client.rb
+- lib/baidu/push/client.rb
+- lib/baidu/push/configuration.rb
+- lib/baidu/push/message.rb
+- lib/baidu/push/version.rb
+- spec/baidu/push/async_client_spec.rb
+- spec/baidu/push/client_spec.rb
+homepage: ''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Baidu push client
+test_files:
+- spec/baidu/push/async_client_spec.rb
+- spec/baidu/push/client_spec.rb