umeng_push 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec75725da1a80dd8525417c31f0a1f7cb626d70b
+  data.tar.gz: 195ffb32fd8984c1a5623c043d222274206dea17
+SHA512:
+  metadata.gz: 7749517290d6563f197a7db2c964b0f067b11620d22fd3b443bdfb384e13a8e33d53151a9f58c817c0e08d246dceaefadb7ea607f021f6f10c60799a5ccac37d
+  data.tar.gz: af14130cdab8f5e1fb946818612e2df0f21ca1c82981af60ce9026f13e5a4b62d45ef44343be267aeb5a76ce0901396ccee4a4ce4c7c7f423f7012333cb9b8a4

data/.gitignore

@@ -0,0 +1,3 @@
+/.bundle/
+/Gemfile.lock
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 zhanglinjie
+
+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 @@
+# UmengPush
+
+此gem是对友盟推送的api封装，支持推送 查询任务 删除任务
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'umeng_push'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install umeng_push
+
+## Usage
+rails generate umeng_push:install
+UmengPush::Client.iOS.send_message(options)
+UmengPush::Client.android.send_message(options)
+UmengPush::Client.iOS.unicast(device_token, options)
+UmengPush::Client.iOS.listcast(device_tokens, options)
+UmengPush::Client.iOS.broadcast(options)
+UmengPush::Client.iOS.groupcast(filter, options)
+UmengPush::Client.iOS.check_task(task_id)
+UmengPush::Client.iOS.cancel_task(task_id)
+推送相关options参数请参看官方文档
+返回结果失败 则抛出错误UmengPush::ResponseError
+默认请求超时是3秒
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/umeng_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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "umeng_push"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/umeng_push/install_generator.rb

@@ -0,0 +1,11 @@
+module UmengPush
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "This generator creates a umeng_push configuratio file at config/initializers"
+      source_root File.expand_path("../templates", __FILE__)
+      def copy_initializer
+        template '../templates/umeng_push.rb', 'config/initializers/umeng_push.rb'
+      end
+    end
+  end
+end

data/lib/generators/umeng_push/templates/umeng_push.rb

@@ -0,0 +1,17 @@
+if Rails.env.production?
+  UmengPush.configure do |config|
+    config.ios_appkey = 'ios_appkey'
+    config.ios_app_master_secret = 'ios_app_master_secret'
+    config.android_appkey = 'android_appkey'
+    config.android_app_master_secret = 'android_app_master_secret'
+    config.production_mode = 'true'
+  end
+else
+  UmengPush.configure do |config|
+    config.ios_appkey = 'ios_appkey'
+    config.ios_app_master_secret = 'ios_app_master_secret'
+    config.android_appkey = 'android_appkey'
+    config.android_app_master_secret = 'android_app_master_secret'
+    config.production_mode = 'false'
+  end
+end

data/lib/umeng_push/client.rb

@@ -0,0 +1,130 @@
+require 'digest/md5'
+require 'httpi'
+require 'json'
+
+module UmengPush
+  class Client
+    attr_accessor :platform, :appkey, :app_master_secret, :production_mode
+    def initialize(platform, appkey, app_master_secret, production_mode=false)
+      @platform = platform
+      @appkey = appkey
+      @app_master_secret = app_master_secret
+      @production_mode = production_mode
+    end
+
+    def self.iOS
+      Client.new(
+        "iOS",
+        UmengPush.configuration.ios_appkey,
+        UmengPush.configuration.ios_app_master_secret,
+        UmengPush.configuration.production_mode
+      )
+    end
+
+    def self.android
+      Client.new(
+        "android",
+        UmengPush.configuration.android_appkey,
+        UmengPush.configuration.android_app_master_secret,
+        UmengPush.configuration.production_mode
+      )
+    end
+
+    # 消息发送
+    def send_message(params={})
+      post("/api/send", params.merge({
+          appkey: appkey,
+          timestamp: timestamp,
+          production_mode: production_mode
+        }))
+    end
+
+    # 单播
+    def unicast(device_token, params={})
+      send_message(params.merge({
+          type: "unicast",
+          device_tokens: device_token
+        }))
+    end
+
+    # 组播
+    def listcast(device_tokens=[], params={})
+      send_message(params.merge({
+          type: "listcast",
+          device_tokens: device_tokens.join(",")
+        }))
+    end
+
+    # 广播
+    def broadcast(params={})
+      send_message(params.merge({
+          type: "broadcast"
+        }))
+    end
+
+    # 组播
+    def groupcast(filter={}, params={})
+      send_message(params.merge({
+          type: "groupcast",
+          filter: filter
+        }))
+    end
+
+    # 查询任务
+    def check_task(task_id)
+      post("/api/status", {
+          appkey: appkey,
+          timestamp: timestamp,
+          task_id: task_id
+        })
+    end
+
+    # 取消任务
+    def cancel_task(task_id)
+      post("/api/cancel", {
+          appkey: appkey,
+          timestamp: timestamp,
+          task_id: task_id
+        })
+    end
+
+    private
+    def post(url, payload)
+      params = compact_params(payload)
+      sign = sign(url, params)
+      response = nil
+      begin
+        request = HTTPI::Request.new
+        request.url = "#{UmengPush::HOST}#{url}?sign=#{sign}"
+        request.open_timeout = 3
+        request.read_timeout = 3
+        request.body = params.to_json
+        response = HTTPI.post(request)
+      rescue => e
+        raise ResponseError.new("0", data: {}, message: e.message)
+      end
+      response_body_json = JSON.load(response.body)
+      check_response!(response_body_json)
+      response_body_json
+    end
+
+    def check_response!(response_body_json)
+      if response_body_json['ret'] != 'SUCCESS'
+        raise ResponseError.new(response_body_json['data']['error_code'], data: response_body_json['data'])
+      end
+    end
+
+    def sign(url, payload)
+      Digest::MD5.hexdigest('POST' + UmengPush::HOST + url + payload.to_json + app_master_secret)
+    end
+
+    def timestamp
+      Time.now.to_i.to_s
+    end
+
+    def compact_params(params)
+      custom_compact = Proc.new { |k, v| v.delete_if(&custom_compact) if v.kind_of?(Hash);  v.nil? }
+      params.delete_if &custom_compact
+    end
+  end
+end

data/lib/umeng_push/configuration.rb

@@ -0,0 +1,13 @@
+module UmengPush
+  class Configuration
+    attr_accessor :ios_appkey, :ios_app_master_secret, :android_appkey, :android_app_master_secret, :production_mode
+
+    def initialize
+      @ios_appkey = 'ios_appkey'
+      @ios_app_master_secret = 'ios_secret'
+      @android_appkey = 'android_appkey'
+      @android_app_master_secret = 'android_secret'
+      @production_mode = 'false'
+    end
+  end
+end

data/lib/umeng_push/response_error.rb

@@ -0,0 +1,121 @@
+module UmengPush
+  class ResponseError < StandardError
+    attr_accessor :error_code, :data, :message
+    def initialize(error_code, data: {}, message: nil)
+      @error_code = error_code
+      @data = data
+      @message = message || error_code_message
+      super(@message)
+    end
+
+    private
+    def error_code_message
+      {
+        "1000" => "请求参数没有appkey",
+        "1001" => "请求参数没有payload",
+        "1002" => "请求参数payload中没有body",
+        "1003" => "display_type为message时，请求参数没有custom",
+        "1004" => "请求参数没有display_type",
+        "1005" => "img url格式不对，请以https或者http开始",
+        "1006" => "sound url格式不对，请以https或者http开始",
+        "1007" => "url格式不对，请以https或者http开始",
+        "1008" => "display_type为notification时，body中ticker不能为空",
+        "1009" => "display_type为notification时，body中title不能为空",
+        "1010" => "display_type为notification时，body中text不能为空",
+        "1011" => "play_vibrate的值只能为true或者false",
+        "1012" => "play_lights的值只能为true或者false",
+        "1013" => "play_sound的值只能为true或者false",
+        "1014" => "task-id没有找到",
+        "1015" => "请求参数中没有device_tokens",
+        "1016" => "请求参数没有type",
+        "1017" => "production_mode只能为true或者false",
+        "1018" => "appkey错误：指定的appkey尚未开通推送服务",
+        "1019" => "display_type填写错误",
+        "1020" => "应用组中尚未添加应用",
+        "2000" => "该应用已被禁用",
+        "2001" => "过期时间必须大于当前时间",
+        "2002" => "定时发送时间必须大于当前时间",
+        "2003" => "过期时间必须大于定时发送时间",
+        "2004" => "IP白名单尚未添加, 请到网站后台添加您的服务器IP白名单。",
+        "2005" => "该消息不存在",
+        "2006" => "validation token错误",
+        "2007" => "未对请求进行签名",
+        "2008" => "json解析错误",
+        "2009" => "请填写alias或者file_id",
+        "2010" => "与alias对应的device_tokens为空",
+        "2011" => "alias个数已超过50",
+        "2012" => "此appkey今天的广播数已超过3次",
+        "2013" => "消息还在排队，请稍候再查询",
+        "2014" => "消息取消失败，请稍候再试",
+        "2015" => "device_tokens个数已超过50",
+        "2016" => "请填写filter",
+        "2017" => "添加tag失败",
+        "2018" => "请填写file_id",
+        "2019" => "与此file_id对应的文件不存在",
+        "2020" => "服务正在升级中，请稍候再试",
+        "2021" => "appkey不存在",
+        "2022" => "payload长度过长",
+        "2023" => "文件上传失败，请重试",
+        "2024" => "限速值必须为正整数",
+        "2025" => "aps字段不能为空",
+        "2026" => "1分钟内发送任务次数超出3次",
+        "2027" => "签名不正确",
+        "2028" => "时间戳已过期",
+        "2029" => "content内容不能为空",
+        "2030" => "launch_from/not_launch_from条件中的日期须小于发送日期",
+        "2031" => "filter格式不正确",
+        "2032" => "未上传生产证书，请到Web后台上传",
+        "2033" => "未上传开发证书，请到Web后台上传",
+        "2034" => "证书已过期",
+        "2035" => "定时任务证书过期",
+        "2036" => "时间戳格式错误",
+        "2038" => "文件上传失败",
+        "2039" => "时间格式必须是yyyy-MM-dd HH:mm:ss",
+        "2040" => "过期时间不能超过7天",
+        "3000" => "数据库错误",
+        "3001" => "数据库错误",
+        "3002" => "数据库错误",
+        "3003" => "数据库错误",
+        "3004" => "数据库错误",
+        "4000" => "系统错误",
+        "4001" => "系统忙",
+        "4002" => "操作失败",
+        "4003" => "appkey格式错误",
+        "4004" => "消息类型格式错误",
+        "4005" => "msg格式错误",
+        "4006" => "body格式错误",
+        "4007" => "deliverPolicy格式错误",
+        "4008" => "失效时间格式错误",
+        "4009" => "单个服务器队列已满",
+        "4010" => "设备号格式错误",
+        "4011" => "消息扩展字段无效",
+        "4012" => "没有权限访问",
+        "4013" => "异步发送消息失败",
+        "4014" => "appkey和device_tokens不对应",
+        "4015" => "没有找到应用信息",
+        "4016" => "文件编码有误",
+        "4017" => "文件类型有误",
+        "4018" => "文件远程地址有误",
+        "4019" => "文件描述信息有误",
+        "4020" => "device_token有误(注意，友盟的device_token是严格的44位字符串)",
+        "4021" => "HSF异步服务超时",
+        "4022" => "appkey已经注册",
+        "4023" => "服务器网络异常",
+        "4024" => "非法访问",
+        "4025" => "device-token全部失败",
+        "4026" => "device-token部分失败",
+        "4027" => "拉取文件失败",
+        "5000" => "device_token错误",
+        "5001" => "证书不存在",
+        "5002" => "p,d是umeng保留字段",
+        "5003" => "alert字段不能为空",
+        "5004" => "alert只能是String类型",
+        "5005" => "device_token格式错误",
+        "5006" => "创建socket错误",
+        "5007" => "certificate_revoked错误",
+        "5008" => "certificate_unkown错误",
+        "5009" => "handshake_failure错误",
+      }[error_code]
+    end
+  end
+end

data/lib/umeng_push/version.rb

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

data/lib/umeng_push.rb

@@ -0,0 +1,16 @@
+require "umeng_push/version"
+require "umeng_push/configuration"
+require 'umeng_push/response_error'
+require "umeng_push/client"
+
+module UmengPush
+  HOST = "http://msg.umeng.com"
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/umeng_push.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'umeng_push/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "umeng_push"
+  spec.version       = UmengPush::VERSION
+  spec.authors       = ["zhanglinjie"]
+  spec.email         = ["zhanglinjie412@gmail.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = "The encapsulation of umeng push api."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/zhanglinjie/umeng_push"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httpi"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry-byebug"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: umeng_push
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- zhanglinjie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpi
+  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: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: The encapsulation of umeng push api.
+email:
+- zhanglinjie412@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/umeng_push/install_generator.rb
+- lib/generators/umeng_push/templates/umeng_push.rb
+- lib/umeng_push.rb
+- lib/umeng_push/client.rb
+- lib/umeng_push/configuration.rb
+- lib/umeng_push/response_error.rb
+- lib/umeng_push/version.rb
+- umeng_push.gemspec
+homepage: https://github.com/zhanglinjie/umeng_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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: The encapsulation of umeng push api.
+test_files: []