umeng_pusher 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dddb4d71a215a264360f11339077d12d5db8de0bef51388f6265b4b452ffec9
-  data.tar.gz: 04cfef1f0606fc4c7686c2538106c984085704d814d5ee248fd6f9cc5ac679f0
+  metadata.gz: d504e87d15e0e9a32f5678876512397073360be05b265b34d0c227ae7d032bf7
+  data.tar.gz: 16c4258738ae9a6a96011162cedfd6c4788da1bfffeeee02331a2f15827824ac
 SHA512:
-  metadata.gz: ceb28586cfffe7077507cf93cb41f63370d1a6ac4d4ff277de3c643ee01af7c5fa840e9a8485333007214ace80a5d6e2111098f61d893558353a84e5c115cade
-  data.tar.gz: 1d8f8a2485b541f665450f83aaf5e119e9cfe0ce598cdf6df2a4f618ec0759506089bcfce3197d4d7cff7a029776a49060a76c8cb0865568a2bb2ca826967bfb
+  metadata.gz: 534f123e33720a399d8cb528f7b99ebf30b89e11fc153195b25d8e0effd4679ee84ef54dfff013fefb4318740c1daba4f18f74f54dd4f8ad0d9d83ee77614aea
+  data.tar.gz: ef9ee8046b08b26909fae512b7329ebe5c1523669c6f09c7c6b441a1b8f8c8dcc67f00a213eeadab2c55fa1ce01487d641b4b342d79fc63ce3d8bfd21046151d

data/Gemfile.lock

@@ -1,19 +1,30 @@
 PATH
   remote: .
   specs:
-    umeng_pusher (0.1.0)
+    umeng_pusher (0.1.1)
+      activesupport
       httpx
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     coderay (1.1.3)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    http-2-next (0.3.0)
-    httpx (0.11.0)
-      http-2-next (>= 0.1.2)
+    http-2-next (0.4.3)
+    httpx (0.15.0)
+      http-2-next (>= 0.4.1)
       timers
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
     method_source (1.0.0)
+    minitest (5.14.4)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -31,7 +42,10 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    timers (4.3.2)
+    timers (4.3.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -38,3 +38,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## 注意事项
+1. 测试时需要添加IP白名单

data/lib/umeng_pusher.rb

@@ -1,5 +1,37 @@
 require "umeng_pusher/version"
+require "umeng_pusher/configuration"
+require "umeng_pusher/sign"
+require "umeng_pusher/client"
+require "umeng_pusher/params"
 
 module UmengPusher
   class Error < StandardError; end
-end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def appkey(platform)
+      platform.downcase == 'ios' ? configuration.ios_appkey : configuration.android_appkey
+    end
+
+    def app_master_secret(platform)
+      platform.downcase == 'ios' ? configuration.ios_app_master_secret : configuration.android_app_master_secret
+    end
+
+    def production_mode
+      configuration.production_mode
+    end
+  end
+end

data/lib/umeng_pusher/client.rb

@@ -0,0 +1,64 @@
+require "httpx"
+require "json"
+require "active_support"
+
+module UmengPusher
+  class Client
+    attr_reader :payload, :ret, :task_id, :error_code, :file_id, :platform, :content
+    CAST_TYPE = %w|unicast listcast filecast broadcast groupcast customizedcast|
+    SEND_URL = "http://msg.umeng.com/api/send"
+    STATUS_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, debug_mode = true)
+      @platform = platform
+      @options = options
+      @debug_mode = debug_mode
+    end
+
+    # unicast-单播
+    # listcast-列播，要求不超过500个device_token
+    # broadcast-广播
+    # filecast-文件播，多个device_token可通过文件形式批量发送
+    # groupcast-组播，按照filter筛选用户群,请参照filter参数
+    # customizedcast，通过alias进行推送，包括以下两种case:
+    #   -alias:对单个或者多个alias进行推送
+    #   -file_id:将alias存放到文件后，根据file_id来推送
+    def send
+      post(SEND_URL, Params.send_params(@platform, @options))
+    end
+
+    def status
+      post(STATUS_URL, Params.status_params(@platform, @options[:task_id]))
+    end
+
+    def cancel
+      post(CANCEL_URL, Params.cancel_params(@platform, @options[:task_id]))
+    end
+
+    def upload
+      post(UPLOAD_URL, Params.upload_params(@platform, @options))
+    end
+
+    private
+
+    def post(url, payload)
+      sign = Sign.generate @platform, url, payload
+
+      puts payload.to_json if @debug_mode
+
+      resp = HTTPX.post("#{url}?sign=#{sign}", json: payload)
+
+      if resp.status == 200
+        r = JSON.parse(resp.body)
+        { message: r["ret"], error_code: r["data"]["error_code"] || 0, data: r["data"] }
+      elsif resp.status == 400
+        r = JSON.parse(resp.body)
+        { message: r["data"]["error_msg"], error_code: r["data"]["error_code"], data: r["data"] }
+      else
+        { message: "系统错误", error_code: "999", data: {} }
+      end
+    end
+  end
+end

data/lib/umeng_pusher/configuration.rb

@@ -0,0 +1,15 @@
+module UmengPusher
+  class Configuration
+    attr_accessor :ios_appkey, :ios_app_master_secret,
+                  :android_appkey, :android_app_master_secret,
+                  :production_mode
+
+    def initialize
+      @ios_appkey = ""
+      @ios_app_master_secret = ""
+      @android_appkey = ""
+      @android_app_master_secret = ""
+      @production_mode = "false"
+    end
+  end
+end

data/lib/umeng_pusher/params.rb

@@ -0,0 +1,101 @@
+require "securerandom"
+
+module UmengPusher
+  module Params
+    extend self
+
+    def send_params(platform, options)
+
+      params = {
+        "appkey" => UmengPusher.appkey(platform),
+        "timestamp" => Time.now.to_i.to_s,
+        "type" => options[:type],
+        "device_tokens" => options[:device_tokens],
+        "alias_type" => options[:alias_type], # 当type=customizedcast时,必填
+        "alias" => options[:alias], #当type=customizedcast时,选填(此参数和file_id二选一)
+        "file_id" => options[:file_id], # 当type=filecast时，必填
+        "policy" => { # 可选，定时任务策略
+          "start_time" => options[:start_time],
+          "expire_time" => options[:expire_time],
+          "max_send_num" => options[:max_send_num],
+          "out_biz_no" => options[:out_biz_no], # 强烈建议开发者在发送任务类消息时填写这个字段，友盟服务端会根据这个字段对消息做去重避免重复发送、根据业务推送内容填写，out_biz_no只对任务类消息有效
+        },
+        "production_mode" => UmengPusher.production_mode,
+        "description" => options[:description], # 可选，发送消息描述，建议填写
+      }
+
+      ios_payload = {
+        "payload" => {
+          "aps" => {
+            "alert" => options[:alert],
+            "badge" => options[:badge] || 1,
+            "sound" => options[:sound] || "default",
+            "content-available" => options["content-available".to_sym],
+            "category" => options[:category],
+          },
+        },
+      }
+
+      # body为业务自定义字段
+      ios_payload["payload"]["body"] = options[:extra] if options.has_key?(:extra)
+
+      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] || {},
+        },
+      }
+
+      platform.downcase == "ios" ? params.merge!(ios_payload) : params.merge!(android_payload)
+      compact_params(params)
+    end
+
+    def status_params(platform, task_id)
+      {
+        "appkey" => UmengPusher.appkey(platform),
+        "timestamp" => Time.now.to_i.to_s,
+        "task_id" => task_id,
+      }
+    end
+
+    def cancel_params(platform, task_id)
+      {
+        "appkey" => UmengPusher.appkey(platform),
+        "timestamp" => Time.now.to_i.to_s,
+        "task_id" => task_id,
+      }
+    end
+
+    def upload_params(platform, content)
+      {
+        "appkey" => UmengPusher.appkey(platform),
+        "timestamp" => Time.now.to_i.to_s,
+        "content" => content,
+      }
+    end
+
+    private
+
+    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_pusher/sign.rb

@@ -0,0 +1,9 @@
+require "digest/md5"
+
+module UmengPusher
+  class Sign
+    def self.generate(platform, url, payload)
+      Digest::MD5.hexdigest("POST" + url + payload.to_json + UmengPusher.app_master_secret(platform))
+    end
+  end
+end

data/lib/umeng_pusher/version.rb

@@ -1,3 +1,3 @@
 module UmengPusher
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/umeng_pusher.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "httpx"
+  spec.add_dependency "activesupport"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: umeng_pusher
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - 42up
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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
@@ -98,6 +112,10 @@ files:
 - bin/console
 - bin/setup
 - lib/umeng_pusher.rb
+- lib/umeng_pusher/client.rb
+- lib/umeng_pusher/configuration.rb
+- lib/umeng_pusher/params.rb
+- lib/umeng_pusher/sign.rb
 - lib/umeng_pusher/version.rb
 - umeng_pusher.gemspec
 homepage: https://github.com/42up/umeng_pusher