wechatpy.client.api.shakearound

Complexity

Total Complexity

31

Size/Duplication

Total Lines	377
Duplicated Lines	0 %

Test Coverage

Coverage

97.83%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	WeChatShakeAround.update_page()	0	29	2
A	WeChatShakeAround.add_material()	0	21	2
A	WeChatShakeAround.apply_device_id()	0	23	2
A	WeChatShakeAround._to_timestamp()	0	8	3
A	WeChatShakeAround.search_device()	0	25	3
A	WeChatShakeAround.delete_page()	0	13	1
A	WeChatShakeAround.get_shake_info()	0	17	2
A	WeChatShakeAround.get_device_statistics()	0	29	2
A	WeChatShakeAround.search_pages()	0	31	4
A	WeChatShakeAround.get_apply_status()	0	17	2
A	WeChatShakeAround.bind_device_location()	0	25	1
A	WeChatShakeAround.update_device()	0	25	1
A	WeChatShakeAround.bind_device_pages()	0	32	2
A	WeChatShakeAround.get_page_statistics()	0	21	2
A	WeChatShakeAround.add_page()	0	26	2

# -*- coding: utf-8 -*-
from __future__ import absolute_import, unicode_literals
import time
from datetime import datetime

import six
from optionaldict import optionaldict

from wechatpy.client.api.base import BaseWeChatAPI


class WeChatShakeAround(BaseWeChatAPI):

    API_BASE_URL = 'https://api.weixin.qq.com/'

    @classmethod
    def _to_timestamp(cls, date):
        if isinstance(date, six.string_types):
            date = datetime.strptime(date, '%Y-%m-%d %H:%M:%S')
        if isinstance(date, datetime):
            timestamp = int(time.mktime(date.timetuple()))
            return timestamp
        return int(date)

    def apply_device_id(self, quantity, reason, poi_id=None, comment=None):
        """
        申请设备ID
        详情请参考
        http://mp.weixin.qq.com/wiki/15/b9e012f917e3484b7ed02771156411f3.html

        :param quantity: 申请的设备ID的数量，单次新增设备超过500个，需走人工审核流程
        :param reason: 申请理由，不超过100个字
        :param poi_id: 可选，设备关联的门店ID
        :param comment: 可选，备注，不超过15个汉字或30个英文字母
        :return: 申请的设备信息
        """
        data = optionaldict()
        data['quantity'] = quantity
        data['apply_reason'] = reason
        data['poi_id'] = poi_id
        data['comment'] = comment
        res = self._post(
            'shakearound/device/applyid',
            data=data,
            result_processor=lambda x: x['data']
        )
        return res

    def update_device(self, device_id=None, uuid=None, major=None,
                      minor=None, comment=None):
        """
        更新设备信息
        详情请参考
        http://mp.weixin.qq.com/wiki/15/b9e012f917e3484b7ed02771156411f3.html

        :param device_id: 设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先
        :param uuid: UUID
        :param major: major
        :param minor: minor
        :param comment: 设备的备注信息，不超过15个汉字或30个英文字母。
        :return: 返回的 JSON 数据包
        """
        data = optionaldict()
        data['comment'] = comment
        data['device_identifier'] = {
            'device_id': device_id,
            'uuid': uuid,
            'major': major,
            'minor': minor
        }
        return self._post(
            'shakearound/device/update',
            data=data
        )

    def bind_device_location(self, poi_id, device_id=None, uuid=None,
                             major=None, minor=None):
        """
        配置设备与门店的关联关系
        详情请参考
        http://mp.weixin.qq.com/wiki/15/b9e012f917e3484b7ed02771156411f3.html

        :param poi_id: 待关联的门店ID
        :param device_id: 设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先
        :param uuid: UUID
        :param major: major
        :param minor: minor
        :return: 返回的 JSON 数据包
        """
        data = optionaldict()
        data['poi_id'] = poi_id
        data['device_identifier'] = {
            'device_id': device_id,
            'uuid': uuid,
            'major': major,
            'minor': minor
        }
        return self._post(
            'shakearound/device/bindlocation',
            data=data
        )

    def search_device(self, identifiers=None, apply_id=None,
                      begin=0, count=10):
        """
        查询设备列表
        详情请参考
        http://mp.weixin.qq.com/wiki/15/b9e012f917e3484b7ed02771156411f3.html

        :param identifiers: 设备 ID 信息列表
        :param apply_id: 批次ID，申请设备ID超出500个时所返回批次ID
        :param begin: 设备列表的起始索引值
        :param count: 待查询的设备个数
        :return: 设备列表
        """
        data = optionaldict()
        data['begin'] = begin
        data['count'] = count
        data['apply_id'] = apply_id
        if identifiers:
            data['device_identifiers'] = identifiers
        res = self._post(
            'shakearound/device/search',
            data=data,
            result_processor=lambda x: x['data']
        )
        return res

    def add_page(self, title, description, icon_url, page_url, comment=None):
        """
        新增页面
        详情请参考
        http://mp.weixin.qq.com/wiki/5/6626199ea8757c752046d8e46cf13251.html

        :param title: 在摇一摇页面展示的主标题，不超过6个字
        :param description: 在摇一摇页面展示的副标题，不超过7个字
        :param icon_url: 在摇一摇页面展示的图片。图片需先上传至微信侧服务器，
                        用“素材管理-上传图片素材”接口上传图片，返回的图片URL再配置在此处
        :param page_url: 跳转链接
        :param comment: 可选，页面的备注信息，不超过15个字
        :return: 页面信息
        """
        data = optionaldict()
        data['title'] = title
        data['description'] = description
        data['icon_url'] = icon_url
        data['page_url'] = page_url
        data['comment'] = comment
        res = self._post(
            'shakearound/page/add',
            data=data,
            result_processor=lambda x: x['data']
        )
        return res

    def update_page(self, page_id, title, description,
                    icon_url, page_url, comment=None):
        """
        编辑页面信息
        详情请参考
        http://mp.weixin.qq.com/wiki/5/6626199ea8757c752046d8e46cf13251.html

        :param page_id: 摇周边页面唯一ID
        :param title: 在摇一摇页面展示的主标题，不超过6个字
        :param description: 在摇一摇页面展示的副标题，不超过7个字
        :param icon_url: 在摇一摇页面展示的图片。图片需先上传至微信侧服务器，
                        用“素材管理-上传图片素材”接口上传图片，返回的图片URL再配置在此处
        :param page_url: 跳转链接
        :param comment: 可选，页面的备注信息，不超过15个字
        :return: 页面信息
        """
        data = optionaldict()
        data['page_id'] = page_id
        data['title'] = title
        data['description'] = description
        data['icon_url'] = icon_url
        data['page_url'] = page_url
        data['comment'] = comment
        res = self._post(
            'shakearound/page/update',
            data=data,
            result_processor=lambda x: x['data']
        )
        return res

    def search_pages(self, page_ids=None, begin=0, count=10):
        """
        查询页面列表
        详情请参考
        http://mp.weixin.qq.com/wiki/5/6626199ea8757c752046d8e46cf13251.html

        :param page_ids: 指定页面的id列表
        :param begin: 页面列表的起始索引值
        :param count: 待查询的页面个数
        :return: 页面查询结果信息
        """
        if not page_ids:
            data = {
                'type': 2,
                'begin': begin,
                'count': count
            }
        else:
            if not isinstance(page_ids, (tuple, list)):
                page_ids = [page_ids]
            data = {
                'type': 1,
                'page_ids': page_ids
            }

        res = self._post(
            'shakearound/page/search',
            data=data,
            result_processor=lambda x: x['data']
        )
        return res

    def delete_page(self, page_id):
        """
        删除页面
        详情请参考
        http://mp.weixin.qq.com/wiki/5/6626199ea8757c752046d8e46cf13251.html

        :param page_id: 指定页面的id列表
        :return: 返回的 JSON 数据包
        """
        return self._post(
            'shakearound/page/delete',
            data={
                'page_id': page_id
            }
        )

    def add_material(self, media_file, media_type='icon'):
        """
        上传图片素材
        详情请参考
        http://mp.weixin.qq.com/wiki/5/e997428269ff189d8f9a4b9e177be2d9.html

        :param media_file: 要上传的文件，一个 File-object
        :param media_type: 摇一摇素材类型, 取值为 icon或者 license, 默认 icon.
        :return: 上传的素材信息
        """
        res = self._post(
            'shakearound/material/add',
            files={
                'media': media_file
            },
            params={
                'type': media_type
            },
            result_processor=lambda x: x['data']
        )
        return res

    def bind_device_pages(self, page_ids, bind, append, device_id=None,
                          uuid=None, major=None, minor=None):
        """
        配置设备与页面的关联关系
        详情请参考
        http://mp.weixin.qq.com/wiki/12/c8120214ec0ba08af5dfcc0da1a11400.html

        :param page_ids: 待关联的页面列表
        :param bind: 关联操作标志位， 0为解除关联关系，1为建立关联关系
        :param append: 新增操作标志位， 0为覆盖，1为新增
        :param device_id: 设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先
        :param uuid: UUID
        :param major: major
        :param minor: minor
        :return: 返回的 JSON 数据包
        """
        if not isinstance(page_ids, (tuple, list)):
            page_ids = [page_ids]
        data = {
            'page_ids': page_ids,
            'bind': int(bind),
            'append': int(append),
            'device_identifier': {
                'device_id': device_id,
                'uuid': uuid,
                'major': major,
                'minor': minor
            }
        }
        return self._post(
            'shakearound/device/bindpage',
            data=data
        )

    def get_shake_info(self, ticket):
        """
        获取摇周边的设备及用户信息
        详情请参考
        http://mp.weixin.qq.com/wiki/3/34904a5db3d0ec7bb5306335b8da1faf.html

        :param ticket: 摇周边业务的ticket，可在摇到的URL中得到，ticket生效时间为30分钟
        :return: 设备及用户信息
        """
        res = self._post(
            'shakearound/user/getshakeinfo',
            data={
                'ticket': ticket
            },
            result_processor=lambda x: x['data']
        )
        return res

    def get_device_statistics(self, begin_date, end_date, device_id=None,
                              uuid=None, major=None, minor=None):
        """
        以设备为维度的数据统计接口
        http://mp.weixin.qq.com/wiki/0/8a24bcacad40fe7ee98d1573cb8a6764.html

        :param begin_date: 起始时间，最长时间跨度为30天
        :param end_date: 结束时间，最长时间跨度为30天
        :param device_id: 设备编号，若填了UUID、major、minor，则可不填设备编号，若二者都填，则以设备编号为优先
        :param uuid: UUID
        :param major: major
        :param minor: minor
        """
        data = {
            'device_identifier': {
                'device_id': device_id,
                'uuid': uuid,
                'major': major,
                'minor': minor
            },
            'begin_date': self._to_timestamp(begin_date),
            'end_date': self._to_timestamp(end_date)
        }
        res = self._post(
            'shakearound/statistics/device',
            data=data,
            result_processor=lambda x: x['data']
        )
        return res

    def get_page_statistics(self, page_id, begin_date, end_date):
        """
        以页面为维度的数据统计接口
        详情请参考
        http://mp.weixin.qq.com/wiki/0/8a24bcacad40fe7ee98d1573cb8a6764.html

        :param page_id: 页面 ID
        :param begin_date: 起始时间，最长时间跨度为30天
        :param end_date: 结束时间，最长时间跨度为30天
        :return: 统计数据
        """
        res = self._post(
            'shakearound/statistics/page',
            data={
                'page_id': page_id,
                'begin_date': self._to_timestamp(begin_date),
                'end_date': self._to_timestamp(end_date),
            },
            result_processor=lambda x: x['data']
        )
        return res

    def get_apply_status(self, apply_id):
        """
        查询设备ID申请审核状态
        详情请参考
        http://mp.weixin.qq.com/wiki/15/b9e012f917e3484b7ed02771156411f3.html

        :param apply_id: 批次ID，申请设备ID时所返回的批次ID
        :return: 批次状态信息
        """
        res = self._post(
            'shakearound/device/applystatus',
            data={
                'apply_id': apply_id,
            },
            result_processor=lambda x: x['data']
        )
        return res