Skip to content

Add Reports API methods #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 22, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions test/fixtures/report_all.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"total": {
"live": {
"encoded_hours": 5,
"stream_hours": 5
},
"vod": {
"encoded_minutes": 6,
"billable_minutes": 8
}
},
"statistics": {
"live": {
"length": 2
}
}
}
38 changes: 38 additions & 0 deletions test/fixtures/report_all_date.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"statistics": {
"vod": [
{
"encoded_minutes": 5,
"billable_minutes": 0,
"grouping": null,
"collected_on": "2013-05-13"
}
],
"live": [
{
"total_billable_hours": 2,
"stream_hours": 1,
"billable_stream_hours": 0,
"encoded_hours": 2,
"grouping": null,
"collected_on": "2013-05-13",
"billable_encoded_hours": 0,
"total_hours": 2
}
]
},
"total": {
"vod": {
"encoded_minutes": 5,
"billable_minutes": 0
},
"live": {
"total_billable_hours": 2,
"stream_hours": 1,
"billable_stream_hours": 0,
"encoded_hours": 2,
"billable_encoded_hours": 0,
"total_hours": 2
}
}
}
9 changes: 9 additions & 0 deletions test/fixtures/report_live.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"total": {
"encoded_hours": 5,
"stream_hours": 5
},
"statistics": {
"length": 5
}
}
6 changes: 6 additions & 0 deletions test/fixtures/report_vod.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"total": {
"encoded_minutes": 6,
"billable_minutes": 8
}
}
70 changes: 70 additions & 0 deletions test/test_reports.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
import unittest
from mock import patch

from test_util import TEST_API_KEY, load_response
from zencoder import Zencoder

import datetime

class TestReports(unittest.TestCase):
def setUp(self):
self.zen = Zencoder(api_key=TEST_API_KEY)

@patch("requests.Session.get")
def test_reports_vod(self, get):
get.return_value = load_response(200, 'fixtures/report_vod.json')

resp = self.zen.report.vod()

self.assertEquals(resp.code, 200)
self.assertEquals(resp.body['total']['encoded_minutes'], 6)
self.assertEquals(resp.body['total']['billable_minutes'], 8)

@patch("requests.Session.get")
def test_reports_live(self, get):
get.return_value = load_response(200, 'fixtures/report_live.json')

resp = self.zen.report.live()

self.assertEquals(resp.code, 200)
self.assertEquals(resp.body['total']['stream_hours'], 5)
self.assertEquals(resp.body['total']['encoded_hours'], 5)
self.assertEquals(resp.body['statistics']['length'], 5)

@patch("requests.Session.get")
def test_reports_all(self, get):
get.return_value = load_response(200, 'fixtures/report_all.json')

resp = self.zen.report.all()

self.assertEquals(resp.code, 200)

self.assertEquals(resp.body['total']['live']['stream_hours'], 5)
self.assertEquals(resp.body['total']['live']['encoded_hours'], 5)
self.assertEquals(resp.body['total']['vod']['encoded_minutes'], 6)
self.assertEquals(resp.body['total']['vod']['billable_minutes'], 8)
self.assertEquals(resp.body['statistics']['live']['length'], 2)

@patch("requests.Session.get")
def test_reports_all_date_filter(self, get):
get.return_value = load_response(200, 'fixtures/report_all_date.json')

start = datetime.date(2013, 5, 13)
end = datetime.date(2013, 5, 13)
resp = self.zen.report.all(start_date=start, end_date=end)

self.assertEquals(resp.code, 200)

self.assertEquals(resp.body['statistics']['vod'][0]['encoded_minutes'], 5)
self.assertEquals(resp.body['statistics']['vod'][0]['billable_minutes'], 0)
self.assertEquals(resp.body['statistics']['live'][0]['stream_hours'], 1)
self.assertEquals(resp.body['statistics']['live'][0]['total_hours'], 2)

self.assertEquals(resp.body['total']['vod']['encoded_minutes'], 5)
self.assertEquals(resp.body['total']['vod']['billable_minutes'], 0)
self.assertEquals(resp.body['total']['live']['stream_hours'], 1)
self.assertEquals(resp.body['total']['live']['total_hours'], 2)

if __name__ == "__main__":
unittest.main()

46 changes: 37 additions & 9 deletions zencoder/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,21 @@ def __init__(self, *args, **kwargs):
kwargs['resource_name'] = 'reports'
super(Report, self).__init__(*args, **kwargs)

def __format(self, start_date=None, end_date=None, grouping=None):
data = {'api_key': self.api_key}

date_format = '%Y-%m-%d'
if start_date:
data['from'] = start_date.strftime(date_format)

if end_date:
data['to'] = end_date.strftime(date_format)

if grouping:
data['grouping'] = grouping

return data

def minutes(self, start_date=None, end_date=None, grouping=None):
"""
Gets a detailed Report of encoded minutes and billable minutes for a
Expand All @@ -359,17 +374,30 @@ def minutes(self, start_date=None, end_date=None, grouping=None):
yesterday)
@param grouping: Minute usage for only one report grouping
"""
data = {'api_key': self.api_key}
date_format = '%Y-%m-%d'
if start_date:
data['from'] = datetime.strftime(start_date, date_format)

if end_date:
data['to'] = datetime.strftime(end_date, date_format)

if grouping:
data['grouping'] = grouping
data = self.__format(start_date, end_date)

url = self.base_url + '/minutes'
return self.get(url, data=data)

def vod(self, start_date=None, end_date=None, grouping=None):
""" Gets a report of VOD Usage """
data = self.__format(start_date, end_date, grouping)

url = self.base_url + '/vod'
return self.get(url, data=data)

def live(self, start_date=None, end_date=None, grouping=None):
""" Gets a report of Live Usage """
data = self.__format(start_date, end_date, grouping)

url = self.base_url + '/live'
return self.get(url, data=data)

def all(self, start_date=None, end_date=None, grouping=None):
""" Gets a report of both VOD and Live Usage """
data = self.__format(start_date, end_date, grouping)

url = self.base_url + '/all'
return self.get(url, data=data)