baidu_push_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55cbc0da684eefd33144ce1ac0b2bdceac97e4d6
+  data.tar.gz: 0e3cd2b3bbbc33884cbc7ac78726be73d498fc53
+SHA512:
+  metadata.gz: 3a01506fad6a3b06c303fa2cf8eaf40d378c2abeec405cb9de6c0058045624830209989e12f50df5a63d4676d148d4e845fd27cfe0b6ded627d9d5df315f4983
+  data.tar.gz: d75459fa16184bddcb53a15a8fea031435c9f267e697751d80553ecbb5a15d3a0758da81285920020f9b7b8763ad85a5f1ae873366bbef15b0dd4fd0f5df667d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.un~
+mkmf.log

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 David Ruan
+
+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,32 @@
+# BaiduPushClient
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'baidu_push_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install baidu_push_client
+
+## Usage
+
+Read spec for usage and fixtures for request/response examples
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/baidu_push_client/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_client.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'baidu_push_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "baidu_push_client"
+  spec.version       = BaiduPushClient::VERSION
+  spec.authors       = ["David Ruan"]
+  spec.email         = ["ruanwz@gmail.com"]
+  spec.summary       = %q{Baidu Push SDK}
+  spec.description   = %q{Baidu Push SDK}
+  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 "virtus", "~> 1.0"
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "webmock", "~> 1.20"
+  spec.add_development_dependency "timecop", "~> 0.7"
+end

data/fixtures/vcr_cassettes/push_all.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://channel.api.duapp.com/rest/2.0/channel/channel?apikey=9k14jrtoe3HjUnOBcapGIlN8&deploy_status=1&expires=1423035600&message_type=1&messages=%7B%22aps%22:%7B%22alert%22:%22Message%20From%20Baidu%20Push%22%7D%7D&method=push_msg&msg_keys=1423032000&push_type=3&sign=8528e5b11e184af4715d13888c6a2bdf&timestamp=1423032000
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Content-Length:
+      - '0'
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Pragma:
+      - no-cache
+      Cache-Control:
+      - no-store
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Wed, 04 Feb 2015 06:42:38 GMT
+      Server:
+      - BWS/1.0
+    body:
+      encoding: ASCII-8BIT
+      string: '{"request_id":642056901,"response_params":{"success_amount":1,"resource_ids":["msgid#9197319785671391763"]}}'
+    http_version: 
+  recorded_at: Wed, 04 Feb 2015 06:40:00 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/push_to_device.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://channel.api.duapp.com/rest/2.0/channel/channel?apikey=9k14jrtoe3HjUnOBcapGIlN8&channel_id=5329701810242571197&deploy_status=1&device_type=4&expires=1423035600&message_type=1&messages=%7B%22aps%22:%7B%22alert%22:%22Message%20From%20Baidu%20Push%22%7D%7D&method=push_msg&msg_keys=1423032000&push_type=1&sign=30ead8777c75e8bd7ec02ab0a8dd2704&timestamp=1423032000&user_id=1139768951174354557
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Content-Length:
+      - '0'
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Pragma:
+      - no-cache
+      Cache-Control:
+      - no-store
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Wed, 04 Feb 2015 06:42:33 GMT
+      Server:
+      - BWS/1.0
+    body:
+      encoding: ASCII-8BIT
+      string: '{"request_id":642052544,"response_params":{"success_amount":1,"msgids":[]}}'
+    http_version: 
+  recorded_at: Wed, 04 Feb 2015 06:40:00 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/query_bindlist.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://channel.api.duapp.com/rest/2.0/channel/channel?apikey=9k14jrtoe3HjUnOBcapGIlN8&channel_id=5329701810242571197&deploy_status=1&device_type=4&expires=1423035600&messages=%7B%22aps%22:%7B%22alert%22:%22Message%20From%20Baidu%20Push%22%7D%7D&method=query_bindlist&msg_keys=1423032000&push_type=&sign=eb53dc842b8850fe654e0c95cd4b8997&timestamp=1423032000&user_id=1139768951174354557
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Content-Length:
+      - '0'
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Pragma:
+      - no-cache
+      Cache-Control:
+      - no-store
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Wed, 04 Feb 2015 06:42:35 GMT
+      Server:
+      - BWS/1.0
+    body:
+      encoding: ASCII-8BIT
+      string: '{"request_id":642032147,"response_params":{"total_num":"1","amount":1,"binds":[{"online_status":"off","bind_status":0,"channel_id":"5329701810242571197","user_id":1139768951174354557,"device_id":"e33e9f49ad616f2d1d782256478f8b574d2f4bea","device_type":4,"device_name":"Belinkr\u2019s
+        iPad","bind_name":"4751932","bind_time":1422974450,"info":""}]}}'
+    http_version: 
+  recorded_at: Wed, 04 Feb 2015 06:40:00 GMT
+recorded_with: VCR 2.9.3

data/lib/baidu_push_client.rb

@@ -0,0 +1,8 @@
+require "baidu_push_client/version"
+require 'baidu_push_client/sign'
+require "baidu_push_client/client"
+require 'baidu_push_client/error'
+
+module BaiduPushClient
+  # Your code goes here...
+end

data/lib/baidu_push_client/client.rb

@@ -0,0 +1,166 @@
+require 'virtus'
+require 'faraday'
+require 'json'
+module BaiduPushClient
+  DEVICE_TYPE = {
+    browser: 1,
+    pc: 2,
+    android: 3,
+    ios: 4,
+    window_phone: 5
+  }
+  PUSH_TYPE = {
+    user: 1,
+    group: 2,
+    all: 3
+  }
+  MESSAGE_TYPE ={
+    message: 0,
+    notification: 1
+
+  }
+
+  DEFAULT_IOS_MSG = {
+    description: "hello world",
+    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",
+    aps: {
+      alert:"Message From Baidu Push",
+      # 'content-available': true,
+      sound:"",
+      badge:0
+      },
+    key1: "value1",
+    key2: "value2"
+  }.to_json
+
+  DEFAULT_IOS_MSG = {
+    aps: {
+      alert:"Message From Baidu Push"
+      }
+  }.to_json
+  DEPLOY_STATUS = {
+    development: 1,
+    production: 2
+  }
+  class Client
+    include Virtus.model
+    attribute :server_host, String
+    attribute :common_path, String
+    attribute :channel_id, String
+    attribute :user_id, String
+    attribute :ak, String
+    attribute :sk, String
+    attribute :device_type, Integer, default: DEVICE_TYPE[:ios]
+    attribute :push_type, Integer, default: PUSH_TYPE[:user]
+    attribute :messages, String, default: DEFAULT_IOS_MSG
+    attribute :message_type, Integer, default: MESSAGE_TYPE[:notification]
+    attribute :api_method, String, default: 'push_msg'
+    attribute :deploy_status, Integer, default: DEPLOY_STATUS[:development]
+
+    def initialize(options)
+      super
+    end
+
+    def query_bindlist(target_hash)
+      self.api_method = 'query_bindlist'
+      self.attributes = self.attributes.merge target_hash
+
+      self.push_type = nil
+      self.message_type = nil
+      resp = rest_client.post url_path_with_query_string do |req|
+        req.headers = headers
+      end
+      resp
+    end
+
+    def push_all(options={})
+      self.attributes = self.attributes.merge options
+      self.api_method = 'push_msg'
+      self.push_type = PUSH_TYPE[:all]
+      self.message_type = MESSAGE_TYPE[:notification]
+      self.device_type = nil
+
+      resp = rest_client.post url_path_with_query_string do |req|
+        req.headers = headers
+      end
+      resp
+    end
+
+    def push(target_hash)
+      self.attributes = self.attributes.merge target_hash
+      self.api_method = 'push_msg'
+      resp = rest_client.post url_path_with_query_string do |req|
+        req.headers = headers
+      end
+      resp
+    end
+
+    def sign_request(query_hash)
+      # bodyArgs.sign = getSign('POST', PROTOCOL_SCHEMA + host + path, bodyArgs, sk);
+
+      method = 'POST'
+
+      url = 'https://' + server_host + url_path
+      str = query_hash.sort { |a, b| a[0]<=>b[0] }.map { |x| "#{x[0]}=#{x[1]}" }.join
+      urlencoded_str = CGI.escape(method.to_s.upcase + url + str + sk)
+      Digest::MD5.hexdigest(urlencoded_str)
+    end
+
+
+    def payload
+      optional_payload = {
+        'channel_id'=> channel_id,
+        'user_id' => user_id,
+        'device_type' => device_type,
+        'message_type' => message_type,
+        'msg_keys' => Time.now.to_i
+      }
+      optional_payload.delete_if {|k,v|v.nil?}
+
+      must_payload = {
+        'deploy_status' => deploy_status,
+        'method' =>  api_method,
+        'apikey' => ak,
+        'push_type' => push_type,
+        'timestamp' => Time.now.to_i,
+        'expires' => Time.now.to_i+3600
+      }
+      must_payload.merge(optional_payload).merge({'messages' => messages})
+    end
+
+    private
+
+    def headers
+
+      {
+        #'Content-Length': bodyStr.length,
+        #'Content-Type':'application/x-www-form-urlencoded'
+      }
+    end
+
+    def url_path
+      common_path + "/channel"
+    end
+
+    def url_path_with_query_string
+      hash = payload.merge({sign: sign_request(payload)})
+      query_string = (hash.map{|k,v| "#{k}=#{v}"}.join("&"))
+      url_path + '?' + query_string
+    end
+
+    def rest_client
+      Faraday.new(url: "https://"+server_host) do |faraday|
+        #faraday.request :url_encoded
+        faraday.response :logger
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/baidu_push_client/version.rb

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

data/spec/baidu_push_client/client_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'vcr_helper'
+require 'timecop'
+describe BaiduPushClient::Client do
+  before do
+
+    Timecop.freeze(Time.local(2015,2,4,14,40))
+  end
+  after do
+    Timecop.return
+  end
+  options = {
+    server_host:  'channel.api.duapp.com',
+    common_path:  '/rest/2.0/channel',
+    ak:           '9k14jrtoe3HjUnOBcapGIlN8',
+    sk:           'F3iDv4MMm2ZZsXVDvlMVxdueiBikjU3p'
+  }
+  subject {BaiduPushClient::Client.new(options)}
+  it "accept parameters" do
+    expect {subject}.to_not raise_error
+  end
+  it "can access the initialized parameters" do
+    expect(subject.server_host).to eq options[:server_host]
+  end
+  it "push msg to device by userid and channelid" do
+
+    VCR.use_cassette('push_to_device') do
+      expect(subject.push(user_id: 1139768951174354557, channel_id: 5329701810242571197).status).to be 200
+    end
+  end
+  it "query bindlist by userid and channelid" do
+    VCR.use_cassette('query_bindlist') do
+      expect(subject.query_bindlist(user_id: 1139768951174354557, channel_id: 5329701810242571197).status).to be 200
+    end
+  end
+  it 'push msg to all devices' do
+    VCR.use_cassette('push_all') do
+      expect(subject.push_all.status).to be 200
+    end
+  end
+end

data/spec/baidu_push_client_spec.rb

@@ -0,0 +1,5 @@
+describe BaiduPushClient do
+  it 'works' do
+    expect(1).to eq 1
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'baidu_push_client'

data/spec/vcr_helper.rb

@@ -0,0 +1,7 @@
+require 'vcr'
+require 'webmock'
+VCR.configure do |c|
+  c.cassette_library_dir = 'fixtures/vcr_cassettes'
+  c.hook_into :webmock # or :fakeweb
+  c.allow_http_connections_when_no_cassette = true
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: baidu_push_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Ruan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Baidu Push SDK
+email:
+- ruanwz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- baidu_push_client.gemspec
+- fixtures/vcr_cassettes/push_all.yml
+- fixtures/vcr_cassettes/push_to_device.yml
+- fixtures/vcr_cassettes/query_bindlist.yml
+- lib/.baidu_push.rb.un~
+- lib/baidu_push_client.rb
+- lib/baidu_push_client/.client.rb.un~
+- lib/baidu_push_client/client.rb
+- lib/baidu_push_client/error.rb
+- lib/baidu_push_client/sign.rb
+- lib/baidu_push_client/version.rb
+- spec/.baidu_push_spec.rb.un~
+- spec/.spec_helper.rb.un~
+- spec/.vcr_helper.rb.un~
+- spec/baidu_push_client/.client_spec.rb.un~
+- spec/baidu_push_client/client_spec.rb
+- spec/baidu_push_client/sign_spec.rb
+- spec/baidu_push_client_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_helper.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 SDK
+test_files:
+- spec/.baidu_push_spec.rb.un~
+- spec/.spec_helper.rb.un~
+- spec/.vcr_helper.rb.un~
+- spec/baidu_push_client/.client_spec.rb.un~
+- spec/baidu_push_client/client_spec.rb
+- spec/baidu_push_client/sign_spec.rb
+- spec/baidu_push_client_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_helper.rb