umeng_msg 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 919287fad5c9975364d033e065d22d79b58d6b4a
-  data.tar.gz: 0f8a8cf8eaa52d3dfbbefb1ebf9030e0939196e5
+  metadata.gz: 416ff86f4b0879074f320006544565a366888f5f
+  data.tar.gz: 702c92ae3d94f423702c0103444538816a6b7439
 SHA512:
-  metadata.gz: 5f5f3b4c50583a37a9f392d9d6061a7c823facc96257e9946ad641e7e320a70d21f7d59e95dd3611d230e83236a6e3f696b56864c2f344e62f224b5f77459992
-  data.tar.gz: 8bead2b2bf288c219eb5c72bfe21258a9435d905d53403b3fdf9ee2f0b0902e5945773fcb0fc31372891fc1ca8e15e9115f7f67389816eac784857bafe3c4883
+  metadata.gz: e92008fec996c1dfb3e5fc1f9b2a91dd32c905d7e3cc8f3a81b724ac8e26dec19cf576ba48a333b3db753e6c8b534ec6ad1f3e319198db528e4c34d3491ee468
+  data.tar.gz: 6acd68399a169365f65f82d967ab0980ccc0c564b17f789c6a68ab4e4c03452e52e46b08c640c55313f8ea7c91a9f6ec6da8eb33c12b58710522b94e2198afd7

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

@@ -1,6 +1,7 @@
 # UmengMsg
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/umeng_msg`. To experiment with that code, run `bin/console` for an interactive prompt.
+此gem是对友盟推送的api封装，支持推送 查询 删除 以及上传文件
+推送部分功能待实施 再todo中
 
 TODO: Delete this and the text above, and describe your gem
 
@@ -21,8 +22,13 @@ Or install it yourself as:
     $ gem install umeng_msg
 
 ## Usage
-
-TODO: Write usage instructions here
+1. rails generate umeng_msg:install
+2. UmengMsg::Subject.new('ios', options).push  #or upload check cancel
+3. options 示例： {'task_id': 'xxxxx'}
+4. 推送相关options参数请参看官方文档， check 与 cancel 只需要 task_id参数, upload 只需要content 参数
+5. 返回结果以error_code 为nil 表示发送成功, error_code 为999 时为网络等错误与友盟无关
+6. 拓展或自定义功能请自行拓展
+7. 默认请求超时是3秒
 
 ## Development
 

data/lib/umeng_msg/params.rb

@@ -3,13 +3,14 @@ module UmengMsg
   module Params
     extend self
 
-    def push_params(platform, **options)
+    def push_params(platform, options)
       params = {
         'appkey'          => UmengMsg.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'],
@@ -31,6 +32,8 @@ module UmengMsg
             'content-available' => options['content-available'],
             'category'          => options['category']
           },
+          'title' => options['title'],
+          'extra' => options['extra'] || {}
         }
       }
       android_payload = {
@@ -53,8 +56,7 @@ module UmengMsg
             'activity'     => options['activity'],
             'custom'       => options['custom']
           },
-          'extra' => {
-          }
+          'extra' => options['extra'] || {}
         }
 
       }
@@ -72,7 +74,8 @@ module UmengMsg
       #   }.merge(params)
       # end
 
-      platform.downcase == 'ios' ? params.merge(ios_payload) : params.merge(android_payload)
+      platform.downcase == 'ios' ? params.merge!(ios_payload) : params.merge!(android_payload)
+      params = compact_params(params)
     end
 
     def check_params(platform, task_id)
@@ -97,6 +100,12 @@ module UmengMsg
         '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_msg/subject.rb

@@ -10,82 +10,45 @@ module UmengMsg
     CANCEL_URL = 'http://msg.umeng.com/api/cancel'
     UPLOAD_URL = 'http://msg.umeng.com/upload'
 
-    def initialize(platform, **options)
+    def initialize(platform, options)
       @platform          = platform
-      @payload           = Params.push_params(platform, **options)
-      @content           = options['content']
-      @file_id, @task_id = nil
-      @ret               = { push: nil, check: nil, cancel: nil, upload: nil }
-      @error_code        = { push: nil, check: nil, cancel: nil, upload: nil }
+      @options           = options
     end
 
     def push
-      sign = Sign.generate @platform, PUSH_URL, @payload
-      begin
-        parse_res RestClient.post("#{PUSH_URL}?sign=#{sign}", @payload.to_json, content_type: :json, accept: :json)
-      rescue => e
-        parse_res e.response
-      end
+      post_youmeng(CANCEL_URL, Params.push_params(@platform, @options))
     end
 
     def check
-      @check_payload = Params.check_params(@platform, @task_id)
-      sign = Sign.generate @platform, CHECK_URL, @check_payload
-      begin
-        parse_res RestClient.post("#{CHECK_URL}?sign=#{sign}", @check_payload.to_json, content_type: :json, accept: :json)
-      rescue => e
-        parse_res e.response
-      end
+      post_youmeng(CANCEL_URL, Params.check_params(@platform, @options['task_id']))
     end
 
     def cancel
-      @cancel_payload = Params.cancel_params(@platform, @task_id)
-      sign = Sign.generate @platform, CANCEL_URL, @cancel_payload
-      begin
-        parse_res RestClient.post("#{CANCEL_URL}?sign=#{sign}", @cancel_payload.to_json, content_type: :json, accept: :json)
-      rescue => e
-        parse_res e.response
-      end
+      post_youmeng(CANCEL_URL, Params.cancel_params(@platform, @options['task_id']))
     end
 
     def upload
-      @upload_payload = Params.upload_params(@platform, @content)
-      sign = Sign.generate @platform, CANCEL_URL, @upload_payload
+      post_youmeng(UPLOAD_URL, Params.upload_params(@platform, @options['content']))
+    end
+
+    private
+    def post_youmeng(url, payload)
+      sign = Sign.generate @platform, url, payload
       begin
-        parse_res RestClient.post("#{UPLOAD_URL}?sign=#{sign}", @upload_payload.to_json, content_type: :json, accept: :json)
+        parse_res RestClient.post("#{url}?sign=#{sign}", payload.to_json, timeout: 3, open_timeout: 3, content_type: :json, accept: :json)
       rescue => e
-        parse_res e.response
+        error_result e.message
       end
     end
 
-    private
-
     def parse_res response
-      res_hsh            = JSON.parse(response)
-      @ret[:push]        = res_hsh['ret']
-      @error_code[:push] = res_hsh['data']['error_code']
-      @task_id           = res_hsh['data']['task_id']
+      result = JSON.parse(response)
+      {result: result['ret'], error_code: result['data']['error_code'], data: result['data']}
     end
 
-    def check_parse
-      res_hsh             = JSON.parse(response)
-      @ret[:check]        = res_hsh['ret']
-      @error_code[:check] = res_hsh['data']['error_code']
-      @check_data         = res_hsh['data']
+    def error_result(error_message)
+      {result: error_message, error_code: '999', data: {}}
     end
 
-    def cancel_parse
-      res_hsh              = JSON.parse(response)
-      @ret[:cancel]        = res_hsh['ret']
-      @error_code[:cancel] = res_hsh['data']['error_code']
-    end
-
-    def upload_parse response
-      res_hsh              = JSON.parse(response)
-      @ret[:upload]        = res_hsh['ret']
-      @error_code[:upload] = res_hsh['data']['error_code']
-      @file_id             = res_hsh['data']['file_id']
-    end
   end
 end
-

data/lib/umeng_msg/version.rb

@@ -1,3 +1,3 @@
 module UmengMsg
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/umeng_msg.rb

@@ -1,10 +1,9 @@
 # coding: utf-8
 require "umeng_msg/version"
 require "umeng_msg/configuration"
-require "umeng_msg/subject"
-require 'umeng_msg/logger'
 require 'umeng_msg/params'
 require 'umeng_msg/sign'
+require "umeng_msg/subject"
 
 module UmengMsg
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: umeng_msg
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - hzlu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-04 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -91,6 +91,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -99,7 +100,6 @@ files:
 - lib/generators/umeng_msg/templates/umeng_msg.rb
 - lib/umeng_msg.rb
 - lib/umeng_msg/configuration.rb
-- lib/umeng_msg/logger.rb
 - lib/umeng_msg/params.rb
 - lib/umeng_msg/sign.rb
 - lib/umeng_msg/subject.rb
@@ -124,9 +124,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: The encapsulation of umeng message.
 test_files: []
-has_rdoc: 

data/lib/umeng_msg/logger.rb

@@ -1,20 +0,0 @@
-module UmengMsg
-  module Logger
-    def logger_file
-      Rails.root.join("log", "umeng_push.log")
-    end
-
-    def error_file
-      Rails.root.join("log", "error.log")
-    end
-
-    def umeng_logger
-      @logger ||= Yell.new do |l|
-        l.level = 'gte.info'
-
-        l.adapter :datefile, logger_file, level: 'lte.error', keep: 5
-        l.adapter :datefile, error_file, level: 'gte.error', keep:5
-      end
-    end
-  end
-end