mobpush api for python init

Author: brucemob

.gitignore

@@ -0,0 +1,27 @@
+*.class
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+# Package Files #
+*.war
+*.ear
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+*.settings
+*.prefs
+org.eclipse.core.resources.prefs
+target
+*.classpath
+*.project
+.externalToolBuilders/
+logs/
+*.log
+.DS_Store
+
+#idea
+*.idea
+*.iml
+.svn
+*.svn
+
+#project
+.pydevproject

README.md

@@ -0,0 +1,62 @@
+# [MobPush API for Python](http://wiki.mob.com/mobpush-rest-api-接口文档/)
+
+![image](https://github.com/MOBX/MOB-SMS-WEBAPI/blob/master/doc/images/logo.png)
+
+**[MobPush API for Python](http://wiki.mob.com/mobpush-rest-api-接口文档/)** 
+为了帮助开发者更方便接入MobPush免费推送SDK，提供完整的API接口的python实现，包含设备操作相关接口、推送操作相关接口以及公共接口。
+
+了解更多 [MobPush 免费推送SDK.](http://mobpush.mob.com)
+
+
+## 优势
+
+**免费使用**、**自定义UI**、**稳定服务**、**流程体验**、**数据同步**、**专业技术团队服务**
+
+## 接口
+* 推送接口
+	* 发送推送
+	* 查询推送（根据batchId）
+	* 查询推送（根据workno）
+* 推送统计接口
+	* 查询推送统计（根据batchId）
+	* 查询推送统计（根据workno）
+* 别名操作接口
+	* 查询别名
+	* 设置别名
+* 标签操作接口
+	* 查询标签
+	* 设置标签
+* 公共接口
+	* 地理位置信息接口	
+
+ 
+## 使用注意事项
+* 初始化appkey、appSecret , 可以在 mob目录下tools.py 设置
+* 错误码请参考 
+  [MobPush Api 错误码](http://wiki.mob.com/mobpush-rest-api-接口文档/#map-6)
+
+## 使用DEMO 
+
+发送推送示例片段代码
+
+```xml    
+    # 初始化推送
+    panel = push().initPush(appkey='moba6b6c6d6', content = 'content test', plats = [1,2]) 
+    # 设置推送范围
+    target = push().buildTarget(target = 1, tags = None, alias = None, registrationIds = None, city = None, block = None)
+    # 设置Android定制信息
+    android = push().buildAndroid(androidTitle = '安卓标题')    
+    # 设置iOS 定制信息
+    ios= push().bulidIos(iosTitle = 'ios 标题')
+    # 设置推送扩展信息   
+    extra = push().buildExtra(unlineTime = 1) 
+
+    js = tools().json_join(panel, target)
+    js = tools().json_join(js,android)
+    js = tools().json_join(js,ios) 
+    js = tools().json_join(js,extra) 
+    res = push().sendPush(js)
+    print(res)
+
+ 
+```

mob/__init__.py

@@ -0,0 +1,9 @@
+#!/usr/bin/env python
+# encoding: utf-8
+
+'''
+@Created: 2018年2月7日
+@author: hlliu
+@site: http://wiki.mob.com/mobpush-rest-api-接口文档/#map-0
+@version: 1.0.0 
+'''

mob/__pycache__/__init__.cpython-36.pyc

@@ -0,0 +1,24 @@
+#!/usr/bin/env python
+# encoding: utf-8
+
+'''
+@Created: 2018年2月7日
+@author: hlliu
+@site: http://wiki.mob.com/mobpush-rest-api-接口文档/#map-0
+@version: 1.0.0
+@note: 获取地理位置列表信息
+'''
+
+from tools import tools
+import json
+
+class area():
+    
+    baseUrl = "http://api.push.mob.com" 
+    
+    # 获取地理位置列表 -- 子级列表
+    def getArea(self, parentId = '0'): 
+        path = '%s%s%s' % (self.baseUrl , "/area/" , parentId)
+        result=tools().web_get(path,'')
+        return result
+     

mob/__pycache__/device.cpython-36.pyc

@@ -0,0 +1,96 @@
+#!/usr/bin/env python
+# encoding: utf-8
+
+'''
+@Created: 2018年2月7日
+@author: hlliu
+@site: http://wiki.mob.com/mobpush-rest-api-接口文档/#map-0
+@version: 1.0.0
+@note: 设备相关接口实现： 别名查询、别名设置、别名清除、标签查询、标签新增、标签删除、标签清除
+'''
+
+from tools import tools
+import json
+
+class device:
+    
+    deviceUrl = 'http://api.push.mob.com' 
+       
+    # 获取设备别名,返回别名
+    def getDeviceAlias(self, registrationId):
+        if registrationId.strip() == '':
+            return {'status':-1,'error':'registrationId is null'}
+        path= '%s%s%s' % (self.deviceUrl,'/alias/',registrationId)
+        req=tools().web_get(path,'')
+        alias = req.get("alias") 
+        return alias
+    
+    # 设置设备别名
+    def setDeviceAlias(self,registrationId,alias):
+        if registrationId.strip() == '':
+            return {'status':-1,'error':'registrationId is null'}
+        path= '%s%s' % (self.deviceUrl,'/alias')
+        jsondata = {'alias':alias,'registrationId':registrationId}
+        req=tools().web_post(path, jsondata)
+        error = req.get("error")
+        if error is None or error.strip() == '':
+            return json.dumps({'status':200});
+        else :
+            return req;
+    
+    # 清除设备别名
+    def cleanDeviceAlias(self,registrationId):
+        return self.setDeviceAlias(registrationId,'')
+        
+    # 获取设备标签    
+    def getDeviceTags(self,registrationId):    
+        if registrationId.strip() == '':
+            return {'status':-1,'error':'registrationId is null'}
+        path= '%s%s%s' % (self.deviceUrl,'/tags/',registrationId)
+        req=tools().web_get(path,'')
+        tags = req.get("tags") 
+        return tags
+        
+    # 绑定设置设备标签    
+    def addDeviceTags(self, tags, registrationId):
+        if tags is None:
+            return {'status':-1,'error':'tags is null'}
+        if registrationId.strip() == '':
+            return {'status':-1,'error':'registrationId is null'}
+        path= '%s%s' % (self.deviceUrl,'/tags')
+        jsondata = {'tags':tags,'registrationId':registrationId,"opType":1}
+        req=tools().web_post(path, jsondata)
+        error = req.get("error")
+        if error is None or error.strip() == '':
+            return json.dumps({'status':200});
+        else :
+            return req;
+     
+    # 解绑设备标签 
+    def removeDeviceTags(self, tags, registrationId):
+        if tags is None:
+            return {'status':-1,'error':'tags is null'}
+        if registrationId.strip() == '':
+            return {'status':-1,'error':'registrationId is null'}
+        path= '%s%s' % (self.deviceUrl,'/tags')
+        jsondata = {'tags':tags,'registrationId':registrationId,"opType":2}
+        req=tools().web_post(path, jsondata)
+        error = req.get("error")
+        if error is None or error.strip() == '':
+            return json.dumps({'status':200});
+        else :
+            return req;
+        
+    # 清除设备标签 
+    def cleanDeviceTags(self, registrationId): 
+        if registrationId.strip() == '':
+            return {'status':-1,'error':'registrationId is null'}
+        path= '%s%s' % (self.deviceUrl,'/tags')
+        jsondata = {'registrationId':registrationId,"opType":3}
+        req=tools().web_post(path, jsondata)
+        error = req.get("error")
+        if error is None or error.strip() == '':
+            return json.dumps({'status':200});
+        else :
+            return req;    
+ 

mob/__pycache__/tools.cpython-36.pyc

@@ -0,0 +1,152 @@
+#!/usr/bin/env python
+# encoding: utf-8
+
+'''
+@Created: 2018年2月7日
+@author: hlliu
+@site: http://wiki.mob.com/mobpush-rest-api-接口文档/#map-0
+@version: 1.0.0
+@note: 发送推送、查询推送详情
+'''
+
+from tools import tools
+import json
+
+class push():
+    
+    pushUrl = "http://api.push.mob.com" 
+    
+    # 推送详情（根据workno查询）
+    def getPushByWorkno(self, workno):
+        if workno.strip() == '':
+            return {'status':-1,'error':'workno is null'}
+        path = '%s%s%s' % (self.pushUrl , "/push/workno/" , workno)
+        result=tools().web_get(path,'')
+        return result
+    
+    # 推送详情（根据batchId查询）
+    def getPushByBatchId(self, batchId):
+        if batchId.strip() == '':
+            return {'status':-1,'error':'batchId is null'}
+        path = '%s%s%s' % (self.pushUrl , "/push/id/" , batchId)
+        result=tools().web_get(path,'')
+        return result
+    
+    
+    # 发送推送
+    def sendPush(self,pushwork):
+        print('')
+        if pushwork is None:
+            return {'status':-1,'error':'pushwork is null'}
+        appkey = pushwork['appkey']
+        if appkey is None or appkey.strip() == '':
+            return {'status':-1,'error':'appkey is null'}
+        target = pushwork['target']
+        if target is None:
+            return {'status':-1,'error':'target is null'}
+        type = pushwork['type']
+        if type is None:
+            return {'status':-1,'error':'type is null'} 
+        content = pushwork['content']
+        if content is None:
+            return {'status':-1,'error':'content is null'} 
+        path = '%s%s' % (self.pushUrl , "/push")
+        result=tools().web_post(path,pushwork)
+        return result
+    
+      
+    # push消息初始化
+    # type = 1 通知， type = 2 自定义
+    # plats 数组格式，包含 android 和 iOS 为 [1,2]
+    def initPush(self, appkey, workno = None, plats = [1,2], content = None, push_type = 1):
+        panel = {}
+        if appkey is not None:
+            panel['appkey'] = appkey
+        if workno is not None:
+            panel['workno'] = workno    
+        if plats is not None:
+            panel['plats'] = plats
+        if content is not None:
+            panel['content'] = content    
+        if push_type is not None:
+            panel['type'] = push_type
+        return panel
+        
+    # 设置扩展信息    
+    def buildExtra(self, unlineTime = 1, extras = None, iosProduction = 1):
+        panel = {} 
+        if extras is not None:
+            panel['extras'] = extras     
+        return panel
+         
+    # 设置推送范围 
+    # target:推送范围:1广播；2别名；3标签；4regid；5地理位置;6用户分群
+    # tags 、alias 、     registrationIds是数组方式
+    def buildTarget(self, target = 1, tags = None, alias = None, registrationIds = None, city = None, block = None):
+        panel = {}
+        if target is None:
+            return panel 
+        panel['target'] = target
+        if target == 1:
+            return panel
+        elif target == 2:
+            if alias is not None:
+                panel['alias'] = alias
+        elif target == 3:
+            if tags is not None:
+                panel['tags'] = tags
+        elif target == 4:
+            if registrationIds is not None:
+                panel['registrationIds'] = registrationIds
+        elif target == 5:
+            if city.strip() == '':   
+                panel['city'] = city
+        elif target == 6:
+            if block.strip() == '':   
+                panel['block'] = block               
+        return panel   
+        
+    # 设置Android信息
+    # androidTitle : 0(普通通知)，1(大段文字内容)，2(大图模式),3(横幅通知) 
+    # androidContent 样式具体内容： 0、默认通知无； 1、长内容则为内容数据； 2、大图则为图片地址； 3、横幅则为多行内容
+    def buildAndroid(self, androidTitle = None, androidstyle = None, androidContent = None,
+                     androidVoice = None, androidShake = None, androidLight = None):
+        panel = {}
+        if androidTitle is not None:
+            panel['androidTitle'] = androidTitle
+        if androidstyle is not None:
+            panel['androidstyle'] = androidstyle
+        if androidContent is not None:
+            panel['androidContent'] = androidContent
+        if androidVoice is not None:
+            panel['androidVoice'] = androidVoice
+        if androidShake is not None:
+            panel['androidShake'] = androidShake
+        if androidLight is not None:
+            panel['androidLight'] = androidLight 
+        return panel
+
+    # 设置IOS信息
+    def bulidIos(self, iosTitle = None, iosSubtitle = None, iosSound = 'default', iosBadge = 1, iosCategory = None,
+             iosSlientPush = None, iosContentAvailable = None, iosMutableContent = None):
+        panel = {}
+        if iosTitle is not None:
+            panel['iosTitle'] = iosTitle
+        if iosSubtitle is not None:
+            panel['iosSubtitle'] = iosSubtitle
+        if iosSound is not None:
+            panel['iosSound'] = iosSound
+        if iosBadge is not None:
+            panel['iosBadge'] = iosBadge
+        if iosCategory is not None:
+            panel['iosCategory'] = iosCategory
+        if iosSlientPush is not None:
+            panel['iosSlientPush'] = iosSlientPush
+        if iosContentAvailable is not None:
+            panel['iosContentAvailable'] = iosContentAvailable
+        if iosMutableContent is not None:
+            panel['iosMutableContent'] = iosMutableContent  
+        return panel
+        
+ 
+