Merge pull request #244 from jemygraw/master

add cdn related functions to python sdk

Author: jemygraw

.travis.yml

@@ -21,7 +21,7 @@ before_script:
 script:
 - if [[ "$TRAVIS_PYTHON_VERSION" != "2.6.9" ]]; then flake8 --show-source --max-line-length=160 .; fi
 - py.test --cov qiniu
-- ocular --data-file .coverage
+- if [[ "$TRAVIS_PYTHON_VERSION" != "2.6.9" ]]; then ocular --data-file .coverage; fi
 deploy:
   provider: pypi
   user: qiniusdk

examples/cdn_manager.py

@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+import qiniu
+from qiniu import CdnManager
+from qiniu import create_timestamp_anti_leech_url
+import time
+
+
+# 演示函数调用结果
+def print_result(result):
+    if result[0] is not None:
+        print(type(result[0]))
+        print(result[0])
+
+    print(type(result[1]))
+    print(result[1])
+
+
+# 账户ak，sk
+access_key = '...'
+secret_key = '...'
+
+auth = qiniu.Auth(access_key=access_key, secret_key=secret_key)
+cdn_manager = CdnManager(auth)
+
+urls = [
+    'http://if-pbl.qiniudn.com/qiniu.jpg',
+    'http://if-pbl.qiniudn.com/qiniu2.jpg'
+]
+
+# 注意链接最后的斜杠表示目录
+dirs = [
+    'http://if-pbl.qiniudn.com/test1/',
+    'http://if-pbl.qiniudn.com/test2/'
+]
+"""刷新文件，目录"""
+
+# 刷新链接
+print('刷新文件')
+refresh_url_result = cdn_manager.refresh_urls(urls)
+print_result(refresh_url_result)
+
+# 刷新目录需要联系七牛技术支持开通权限
+print('刷新目录')
+refresh_dir_result = cdn_manager.refresh_dirs(dirs)
+print_result(refresh_dir_result)
+
+# 同时刷新文件和目录
+print('刷新文件和目录')
+refresh_all_result = cdn_manager.refresh_urls_and_dirs(urls, dirs)
+print_result(refresh_all_result)
+
+"""预取文件"""
+
+# 预取文件链接
+print('预取文件链接')
+prefetch_url_result = cdn_manager.prefetch_urls(urls)
+print_result(prefetch_url_result)
+
+"""获取带宽和流量数据"""
+
+domains = ['if-pbl.qiniudn.com', 'qdisk.qiniudn.com']
+
+start_date = '2017-01-01'
+end_date = '2017-01-02'
+
+# 5min or hour or day
+granularity = 'day'
+
+# 获取带宽数据
+print('获取带宽数据')
+bandwidth_data = cdn_manager.get_bandwidth_data(domains, start_date, end_date, granularity)
+print_result(bandwidth_data)
+
+# 获取流量数据
+print('获取流量数据')
+flux_data = cdn_manager.get_flux_data(domains, start_date, end_date, granularity)
+print_result(flux_data)
+
+"""获取日志文件下载地址列表"""
+# 获取日志列表
+print('获取日志列表')
+log_date = '2017-01-01'
+log_data = cdn_manager.get_log_list_data(domains, log_date)
+print_result(log_data)
+
+"""构建时间戳防盗链"""
+
+# 构建时间戳防盗链
+print('构建时间戳防盗链')
+
+# 时间戳防盗链密钥，后台获取
+encrypt_key = 'xxx'
+
+# 原始文件名，必须是utf8编码
+test_file_name1 = '基本概括.mp4'
+test_file_name2 = '2017/01/07/test.png'
+
+# 查询参数列表
+query_string_dict = {
+    'name': '七牛',
+    'year': 2017,
+    '年龄': 28,
+}
+
+# 带访问协议的域名
+host = 'http://video.example.com'
+
+# unix时间戳
+deadline = int(time.time()) + 3600
+
+# 带查询参数，中文文件名
+signed_url1 = create_timestamp_anti_leech_url(host, test_file_name1, query_string_dict, encrypt_key, deadline)
+print(signed_url1)
+
+# 带查询参数，英文文件名
+signed_url2 = create_timestamp_anti_leech_url(host, test_file_name2, query_string_dict, encrypt_key, deadline)
+print(signed_url2)
+
+# 不带查询参数，中文文件名
+signed_url3 = create_timestamp_anti_leech_url(host, test_file_name1, None, encrypt_key, deadline)
+print(signed_url3)
+
+# 不带查询参数，英文文件名
+signed_url4 = create_timestamp_anti_leech_url(host, test_file_name2, None, encrypt_key, deadline)
+print(signed_url4)

qiniu/__init__.py

@@ -16,8 +16,10 @@
 from .config import set_default
 from .zone import Zone
 
-from .services.storage.bucket import BucketManager, build_batch_copy, build_batch_rename, build_batch_move, build_batch_stat, build_batch_delete
+from .services.storage.bucket import BucketManager, build_batch_copy, build_batch_rename, build_batch_move, \
+    build_batch_stat, build_batch_delete
 from .services.storage.uploader import put_data, put_file, put_stream
+from .services.cdn.manager import CdnManager, create_timestamp_anti_leech_url
 from .services.processing.pfop import PersistentFop
 from .services.processing.cmd import build_op, pipe_cmd, op_save
 from .services.compute.app import AccountClient

qiniu/http.py

@@ -8,7 +8,6 @@
 import qiniu.auth
 from . import __version__
 
-
 _sys_info = '{0}; {1}'.format(platform.system(), platform.machine())
 _python_ver = platform.python_version()
 
@@ -35,12 +34,17 @@ def _init():
     _session = session
 
 
-def _post(url, data, files, auth):
+def _post(url, data, files, auth, headers=None):
     if _session is None:
         _init()
     try:
+        post_headers = _headers
+        if headers is not None:
+            for k, v in headers.items():
+                post_headers.update({k: v})
         r = _session.post(
-            url, data=data, files=files, auth=auth, headers=_headers, timeout=config.get_default('connection_timeout'))
+            url, data=data, files=files, auth=auth, headers=post_headers,
+            timeout=config.get_default('connection_timeout'))
     except Exception as e:
         return None, ResponseInfo(None, e)
     return __return_wrapper(r)
@@ -77,8 +81,11 @@ def _post_with_auth(url, data, auth):
     return _post(url, data, None, qiniu.auth.RequestsAuth(auth))
 
 
-def _post_with_qiniu_mac(url, data, auth):
+def _post_with_auth_and_headers(url, data, auth, headers):
+    return _post(url, data, None, qiniu.auth.RequestsAuth(auth), headers)
 
+
+def _post_with_qiniu_mac(url, data, auth):
     qn_auth = qiniu.auth.QiniuMacRequestsAuth(auth) if auth is not None else None
     timeout = config.get_default('connection_timeout')
 

qiniu/services/cdn/__init__.py

@@ -0,0 +1,198 @@
+# -*- coding: utf-8 -*-
+
+from qiniu import http
+import json
+
+from qiniu.compat import is_py2
+from qiniu.compat import is_py3
+
+import hashlib
+
+
+def urlencode(str):
+    if is_py2:
+        import urllib2
+        return urllib2.quote(str)
+    elif is_py3:
+        import urllib.parse
+        return urllib.parse.quote(str)
+
+
+class CdnManager(object):
+    def __init__(self, auth):
+        self.auth = auth
+        self.server = 'http://fusion.qiniuapi.com'
+
+    def refresh_urls(self, urls):
+        """
+        刷新文件列表，文档 http://developer.qiniu.com/article/fusion/api/refresh.html
+
+        Args:
+            urls: 待刷新的文件外链列表
+
+        Returns:
+            一个dict变量和一个ResponseInfo对象
+            参考代码 examples/cdn_manager.py
+        """
+        return self.refresh_urls_and_dirs(urls, None)
+
+    def refresh_dirs(self, dirs):
+        """
+        刷新目录，文档 http://developer.qiniu.com/article/fusion/api/refresh.html
+
+        Args:
+            urls: 待刷新的目录列表
+
+        Returns:
+            一个dict变量和一个ResponseInfo对象
+            参考代码 examples/cdn_manager.py
+        """
+        return self.refresh_urls_and_dirs(None, dirs)
+
+    def refresh_urls_and_dirs(self, urls, dirs):
+        """
+        刷新文件目录，文档 http://developer.qiniu.com/article/fusion/api/refresh.html
+
+        Args:
+           urls: 待刷新的目录列表
+           dirs: 待刷新的文件列表
+
+        Returns:
+           一个dict变量和一个ResponseInfo对象
+           参考代码 examples/cdn_manager.py
+       """
+        req = {}
+        if urls is not None and len(urls) > 0:
+            req.update({"urls": urls})
+        if dirs is not None and len(dirs) > 0:
+            req.update({"dirs": dirs})
+
+        body = json.dumps(req)
+        url = '{0}/v2/tune/refresh'.format(self.server)
+        return self.__post(url, body)
+
+    def prefetch_urls(self, urls):
+        """
+        预取文件列表，文档 http://developer.qiniu.com/article/fusion/api/prefetch.html
+
+        Args:
+           urls: 待预取的文件外链列表
+
+        Returns:
+           一个dict变量和一个ResponseInfo对象
+           参考代码 examples/cdn_manager.py
+        """
+        req = {}
+        req.update({"urls": urls})
+
+        body = json.dumps(req)
+        url = '{0}/v2/tune/prefetch'.format(self.server)
+        return self.__post(url, body)
+
+    def get_bandwidth_data(self, domains, start_date, end_date, granularity):
+        """
+        预取带宽数据，文档 http://developer.qiniu.com/article/fusion/api/traffic-bandwidth.html
+
+        Args:
+           domains:     域名列表
+           start_date:  起始日期
+           end_date:    结束日期
+           granularity: 数据间隔
+
+        Returns:
+           一个dict变量和一个ResponseInfo对象
+           参考代码 examples/cdn_manager.py
+        """
+        req = {}
+        req.update({"domains": ';'.join(domains)})
+        req.update({"startDate": start_date})
+        req.update({"endDate": end_date})
+        req.update({"granularity": granularity})
+
+        body = json.dumps(req)
+        url = '{0}/v2/tune/bandwidth'.format(self.server)
+        return self.__post(url, body)
+
+    def get_flux_data(self, domains, start_date, end_date, granularity):
+        """
+        预取流量数据，文档 http://developer.qiniu.com/article/fusion/api/traffic-bandwidth.html
+
+        Args:
+           domains:     域名列表
+           start_date:  起始日期
+           end_date:    结束日期
+           granularity: 数据间隔
+
+        Returns:
+           一个dict变量和一个ResponseInfo对象
+           参考代码 examples/cdn_manager.py
+        """
+        req = {}
+        req.update({"domains": ';'.join(domains)})
+        req.update({"startDate": start_date})
+        req.update({"endDate": end_date})
+        req.update({"granularity": granularity})
+
+        body = json.dumps(req)
+        url = '{0}/v2/tune/flux'.format(self.server)
+        return self.__post(url, body)
+
+    def get_log_list_data(self, domains, log_date):
+        """
+        获取日志下载链接，文档 http://developer.qiniu.com/article/fusion/api/log.html
+
+        Args:
+           domains:     域名列表
+           log_date:    日志日期
+
+        Returns:
+           一个dict变量和一个ResponseInfo对象
+           参考代码 examples/cdn_manager.py
+        """
+        req = {}
+        req.update({"domains": ';'.join(domains)})
+        req.update({"startDate": log_date})
+
+        body = json.dumps(req)
+        url = '{0}/v2/tune/log/list'.format(self.server)
+        return self.__post(url, body)
+
+    def __post(self, url, data=None):
+        headers = {'Content-Type': 'application/json'}
+        return http._post_with_auth_and_headers(url, data, self.auth, headers)
+
+
+def create_timestamp_anti_leech_url(host, file_name, query_string_dict, encrypt_key, deadline):
+    """
+    创建时间戳防盗链
+
+    Args:
+        host:              带访问协议的域名
+        file_name:         原始文件名，不需要urlencode
+        query_string_dict: 查询参数，不需要urlencode
+        encrypt_key:       时间戳防盗链密钥
+        deadline:          链接有效期时间戳（以秒为单位）
+
+    Returns:
+        带时间戳防盗链鉴权访问链接
+    """
+    if query_string_dict is not None and len(query_string_dict) > 0:
+        query_string_items = []
+        for k, v in query_string_dict.items():
+            query_string_items.append('{0}={1}'.format(urlencode(str(k)), urlencode(str(v))))
+        query_string = '&'.join(query_string_items)
+        url_to_sign = '{0}/{1}?{2}'.format(host, urlencode(file_name), query_string)
+    else:
+        url_to_sign = '{0}/{1}'.format(host, urlencode(file_name))
+
+    path = '/{0}'.format(urlencode(file_name))
+    expire_hex = str(hex(deadline))[2:]
+    str_to_sign = '{0}{1}{2}'.format(encrypt_key, path, expire_hex).encode()
+    sign_str = hashlib.md5(str_to_sign).hexdigest()
+
+    if query_string_dict is not None and len(query_string_dict) > 0:
+        signed_url = '{0}&sign={1}&t={2}'.format(url_to_sign, sign_str, expire_hex)
+    else:
+        signed_url = '{0}?sign={1}&t={2}'.format(url_to_sign, sign_str, expire_hex)
+
+    return signed_url