umeng_message 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f91ccbb07959a9ff8d313aac42e383a080ad46954d3803a4936145b2826a2065
+  data.tar.gz: ab4a8c4f34340fde60b4e2e478297fba6977f436a212175f164dbf08a8960c8f
+SHA512:
+  metadata.gz: bc02148dce91410314becb360f42aaa7d018236ac12683f2895343fc3b9dd566ffe302a2525f101ec02cb0b6e6d0c6dbb31e92cbc5c007a8f665d9df34dbc228
+  data.tar.gz: 8534feded8f11c5daa4d8853564df872c6a36604aff2a6af234fb471618270078e9c9ee0ecf425310e340fd21848edfbf9b5081d3e01938d72ce61988569a32b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.4

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,25 @@
+copyright (c) <year> <copyright holders>
+
+
+
+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,51 @@
+# UmengMessage
+
+对[友盟](https://www.umeng.com/)消息推送的接口封装，支持接口：
+
+- 消息发送
+- 任务类消息状态查询
+- 任务类消息取消
+- 文件上传
+
+## 安装
+
+Gemfile添加
+
+  gem 'umeng_message'
+
+然后执行
+
+    $ bundle
+
+## 使用
+
+### 生成配置文件
+
+  rails generate umeng_message:install
+
+### 推送、上传、查询、取消
+
+  UmengMessage::Subject.new('ios', options).push
+  UmengMessage::Subject.new('ios', options).upload
+  UmengMessage::Subject.new('ios', options).check
+  UmengMessage::Subject.new('ios', options).cancel
+
+### `options` 参数
+
+- check 与 cancel 只需要 `task_id` 参数, upload 只需要 `content` 参数
+- 示例： `{'task_id': 'xxxxx'}`
+- 详细 `options` 参数请查看[官方文档](https://developer.umeng.com/docs/66632/detail/68343)
+
+### 返回结果
+
+- 返回结果以 `error_code` 为 `nil` 表示发送成功, `error_code` 为 `999` 时为网络等错误与友盟无关
+- 拓展或自定义功能请自行拓展
+- 默认请求超时是3秒
+
+## Contributing
+
+1. Fork it ( https://github.com/hzlu/umeng_message/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_message"
+
+# 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_message/install_generator.rb

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

data/lib/generators/umeng_message/templates/umeng_message.rb

@@ -0,0 +1,17 @@
+if Rails.env.production?
+  UmengMessage.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
+  UmengMessage.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_message.rb

@@ -0,0 +1,34 @@
+# coding: utf-8
+require "umeng_message/version"
+require "umeng_message/configuration"
+require 'umeng_message/params'
+require 'umeng_message/sign'
+require "umeng_message/subject"
+
+module UmengMessage
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @Configuration = Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.appkey platform
+    platform.downcase == 'ios' ? configuration.ios_appkey : configuration.android_appkey
+  end
+
+  def self.app_master_secret platform
+    platform.downcase == 'ios' ? configuration.ios_app_master_secret : configuration.android_app_master_secret
+  end
+
+  def self.production_mode
+    configuration.production_mode
+  end
+
+end

data/lib/umeng_message/configuration.rb

@@ -0,0 +1,14 @@
+# coding: utf-8
+module UmengMessage
+  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_message/params.rb

@@ -0,0 +1,119 @@
+# coding: utf-8
+module UmengMessage
+  module Params
+    extend self
+
+    def push_params(platform, options)
+      params = {
+        'appkey'          => UmengMessage.appkey(platform),
+        'timestamp'       => Time.now.to_i.to_s,
+        'type'            => options['type'],
+        'device_tokens'   => options['device_tokens'],
+        'alias_type'      => options['alias_type'],
+        'alias'           => options['alias'],
+        'file_id'         => options['file_id'],
+        'policy'          => {
+                               'start_time'   => options['start_time'],
+                               'expire_time'  => options['expire_time'],
+                               'max_send_num' => options['max_send_num'],
+                             },
+        'production_mode' => UmengMessage.production_mode,
+        'description'     => options['description'],
+        'thirdparty_id'   => options['thirdparty_id']
+      }
+
+      # 平台参数
+      ios_payload = {
+        'payload' => {
+          'aps' => {
+            'alert'             => options['alert'],
+            'badge'             => options['badge'],
+            'sound'             => options['sound'],
+            'content-available' => options['content-available'],
+            'category'          => options['category']
+          },
+          'title' => options['title'],
+          'extra' => options['extra'] || {},          
+        }
+      }
+
+      if(options['screen'].present?)
+        ios_payload['payload'].merge!({'screen' => options['screen']})
+      end
+      if options['params'].present?
+        ios_payload['payload'].merge!({'params' => options['params']})
+      end
+    
+      android_payload = {
+        'payload' => {
+          'display_type' => options['display_type'],
+          'body' => {
+            'ticker'       => options['ticker'],
+            'title'        => options['title'],
+            'text'         => options['text'],
+            'icon'         => options['icon'],
+            'largeIcon'    => options['largeIcon'],
+            'img'          => options['img'],
+            'sound'        => options['sound'],
+            'builder_id'   => (options['builder_id'] || 0),
+            'play_vibrate' => (options['play_vibrate'] || 'true'),
+            'play_lights'  => (options['play_lights'] || 'true'),
+            'play_sound'   => (options['play_sound'] || 'true'),
+            'after_open'   => (options['after_open'] || 'go_app'),
+            'url'          => options['url'],
+            'activity'     => options['activity'],
+            'custom'       => options['custom']
+          },
+          'extra' => options['extra'] || {}
+        }
+
+      }
+
+      # TODO 组播过滤
+      # if type == "groupcast"
+      #   tag_list = targets.split(",")
+      #   tag_list.map! { |tag| {tag: tag} }
+      #   params = {
+      #     filter: {
+      #       where: {
+      #         "and" => [{ "or" => tag_list }]
+      #       }
+      #     }
+      #   }.merge(params)
+      # end
+
+      platform.downcase == 'ios' ? params.merge!(ios_payload) : params.merge!(android_payload)
+      params = compact_params(params)
+    end
+
+    def check_params(platform, task_id)
+      {
+        'appkey'    => UmengMessage.appkey(platform),
+        'timestamp' => Time.now.to_i.to_s,
+        'task_id'   => task_id
+      }
+    end
+    def cancel_params(platform, task_id)
+      {
+        'appkey'    => UmengMessage.appkey(platform),
+        'timestamp' => Time.now.to_i.to_s,
+        'task_id'   => task_id
+      }
+    end
+
+    def upload_params(platform, content)
+      {
+        'appkey'    => UmengMessage.appkey(platform),
+        'timestamp' => Time.now.to_i.to_s,
+        'content'   => content
+      }
+    end
+
+    private
+    #取出nil的key 不然友盟解析json出错
+    def compact_params(params)
+      custom_compact = Proc.new { |k, v| v.delete_if(&custom_compact) if v.kind_of?(Hash);  v.blank? }
+      params.delete_if &custom_compact
+    end
+  end
+end

data/lib/umeng_message/sign.rb

@@ -0,0 +1,10 @@
+# coding: utf-8
+require 'digest/md5'
+
+module UmengMessage
+  module Sign
+    def self.generate(platform, url, payload)
+      Digest::MD5.hexdigest('POST' + url + payload.to_json + UmengMessage.app_master_secret(platform))
+    end
+  end
+end

data/lib/umeng_message/subject.rb

@@ -0,0 +1,59 @@
+# coding: utf-8
+require 'httpi'
+
+module UmengMessage
+  class Subject
+    attr_reader :payload, :ret, :task_id, :error_code, :file_id, :platform, :content
+    CAST_TYPE  = %w|unicast listcast filecast broadcast groupcast customizedcast|
+    PUSH_URL   = 'http://msg.umeng.com/api/send'
+    CHECK_URL  = 'http://msg.umeng.com/api/status'
+    CANCEL_URL = 'http://msg.umeng.com/api/cancel'
+    UPLOAD_URL = 'http://msg.umeng.com/upload'
+
+    def initialize(platform, options)
+      @platform          = platform
+      @options           = options
+    end
+
+    def push
+      post_youmeng(PUSH_URL, Params.push_params(@platform, @options))
+    end
+
+    def check
+      post_youmeng(CHECK_URL, Params.check_params(@platform, @options['task_id']))
+    end
+
+    def cancel
+      post_youmeng(CANCEL_URL, Params.cancel_params(@platform, @options['task_id']))
+    end
+
+    def upload
+      post_youmeng(UPLOAD_URL, Params.upload_params(@platform, @options['content']))
+    end
+
+    private
+    def post_youmeng(url, payload)
+      sign = Sign.generate @platform, url, payload
+      begin
+        request = HTTPI::Request.new
+        request.url = "#{url}?sign=#{sign}"
+        request.open_timeout = 3
+        request.read_timeout = 3
+        request.body = payload.to_json
+        response = HTTPI.post(request)
+        parse_res(ActiveSupport::JSON.decode(response.body))
+      rescue => e
+        error_result e.message
+      end
+    end
+
+    def parse_res result
+      {result: result['ret'], error_code: result['data']['error_code'], data: result['data']}
+    end
+
+    def error_result(error_message)
+      {result: error_message, error_code: '999', data: {}}
+    end
+
+  end
+end

data/lib/umeng_message/version.rb

@@ -0,0 +1,3 @@
+module UmengMessage
+  VERSION = "1.0.0"
+end

data/umeng_message.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'umeng_message/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'umeng_message'
+  spec.version       = UmengMessage::VERSION
+  spec.authors       = ['tl']
+  spec.email         = ['tianlu1677@gmail.com']
+  spec.licenses       = ['MIT']
+  spec.summary       = 'The encapsulation of umeng message!'
+  spec.description   = '友盟推送Ruby封装'
+  spec.homepage      = 'https://github.com/hzlu/umeng_message'
+  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', '~> 0'
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 0'
+  spec.add_development_dependency 'pry-byebug', '~> 0'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: umeng_message
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- tl
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-19 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: 友盟推送Ruby封装
+email:
+- tianlu1677@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/umeng_message/install_generator.rb
+- lib/generators/umeng_message/templates/umeng_message.rb
+- lib/umeng_message.rb
+- lib/umeng_message/configuration.rb
+- lib/umeng_message/params.rb
+- lib/umeng_message/sign.rb
+- lib/umeng_message/subject.rb
+- lib/umeng_message/version.rb
+- umeng_message.gemspec
+homepage: https://github.com/hzlu/umeng_message
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: The encapsulation of umeng message!
+test_files: []