- Notifications
You must be signed in to change notification settings - Fork12
Compilation of utilities for Roku development
License
juliomalves/roku-libs
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Libraries and utilities for BrightScript development.
This includes the following libraries and utilities:
- Google Analytics (deprecated - native support now exists throughRoku Analytics Component Library)
- HTTP Request
- Cache
- Console
- Array
- String
- Math
- Registry
The libraries and utilities are bundled into a sample project which sole purpose is to run unit tests built withRoku Unit Testing Framework.Any file can and should be used separately as they do not have dependencies with each other.
TheMakefile included provides a few simple rules to help with the app installation and testing.
From a terminal, you can first start by exporting the following variables
export DEVICEIP=<your_device_IP>export ROKU=<your_dev_mode_user>export ROKUPASS=<your_dev_mode_password>
To run the unit tests (output will be available on thedebug console)
make tests
Note: Anofficial library now exists with support for Google Analytics, Omniture, Brightcove and Ooyala.
This library provides tracking capabilities by sending data reports to Google Analytics using theMeasurement Protocol.Below are some example usages on how to use its different tracking functionalities.
To retrieve the GA global singleton object
googleAnalytics=GoogleAnalyticsLib();
After having a reference to the GA global (we'll be usinggoogleAnalytics in the following examples), initialise it by passing one or more Tracking IDs. This is required in order to enable reporting altogether, but only needs to be doneonce.
googleAnalytics.init("UA-12345678-90")//Or when passing multiple Tracking IDs in an arraygoogleAnalytics.init(["UA-12345678-90", ...,"UA-09876543-21"])
Sending tracking reports
// Event trackinggoogleAnalytics.trackEvent({category:"application",action:"launch"});// Screen TrackinggoogleAnalytics.trackScreen({name:"mainScreen"});// E-Commerce trackinggoogleAnalytics.trackTransaction({id:"OD564",revenue:"10.00"});googleAnalytics.trackItem({transactionId:"OD564",name:"Test01",price:"10.00",code:"TEST001",category:"vod",});// Timing trackinggoogleAnalytics.trackTiming({category:"category",variable:"timing",time:"1000",});// Exception trackinggoogleAnalytics.trackException({description:"description",isFatal:"1"});
Adding custom parameters to all tracking reports
googleAnalytics.setParams({sr:"1280x800",ul:"en-gb"});
A library that makes HTTP requests easier to deal with in BrightScript.
Below are some examples showing its different capabilities.
request=HttpRequest({url:"https://postman-echo.com/delay/5",timeout:2000,retries:3,});response=request.send();
request=HttpRequest({url:"https://postman-echo.com/post",method:"POST",headers:{"Content-Type":"application/json"},data:{user:"johndoe",password:"12345"},});response=request.send();
request=HttpRequest({url:"https://postman-echo.com/delay/5",});request.send();request.abort();
TheCache utility creates a simple interface for caching data toRoku's volatile storage. Usescachefs: storage by default, but can be overwritten totmp: storage.
CacheUtil(key [, options])Accepts akey string and an optionaloptions object as second parameter, which can have the following fields:
algorithm:String- hash algorithm for the key hashing, which will be used for the stored file name.Defaults to"sha1".storage:String- storage to be used by the cache.Defaults to"cachefs:/".ttl:Integer- time to live (in seconds) for the cache, after which the cache will expire. If set toinvalidthe cache will never expire.Defaults to5seconds.
As a sample use case,CacheUtil can be used to cache the response of a given HTTP request. Assuming a request was made tohttps://postman-echo.com/get andresponseString contains its response as astring value.
The response can be stored in cache as follows:
cache=CacheUtil("https://postman-echo.com/get");cache.put(responseString);
On a following request to the same URL the cached response could be retrieved before making a new request, given the TTL expiry hasn't been reached yet.
cache=CacheUtil("https://postman-echo.com/get");cachedValue=cache.get();// Returns response string that was cached previously
Small logging utility that enhances the built-inprint debugging capabilities, with a syntax similiar to JavaScript'sconsole object. It adds a timestamp to every log, provides group indentation, timers, counters, and different logging levels (info,assert anderror).
Example usages:
console=ConsoleUtil();console.log("Hello World");// [14:56:16:891] Hello Worldconsole.time("Hello World");// [14:56:16:891] Hello World: timer startedconsole.group();console.log("Hello World");// [14:56:16:892] Hello Worldconsole.count();// [14:56:16:894] default: 1console.info("Hello World");// [14:56:16:893] [INFO] Hello Worldconsole.group();console.assert(false,"Hello World");// [14:56:16:894] [ASSERT] Hello Worldconsole.count();// [14:56:16:894] default: 2console.groupEnd();console.assert(true,"Hello World");console.error("Hello World");// [14:56:16:895] [ERROR] Hello Worldconsole.count();// [14:56:16:894] default: 3console.groupEnd();console.timeEnd("Hello World");// [14:56:16:895] Hello World: 4ms
This utility expands the array functionalities provided by the built-inroArray type. It implements the following functions:isArray,contains,indexOf,lastIndexOf,slice,fill,flat,map,reduce,filter,find,findIndex,every,some,groupBy.
Example usages:
arrUtil=ArrayUtil();arr=[5,2,3,2,1];arrUtil.isArray(arr);// truearrUtil.contains(arr,2);// truearrUtil.indexOf(arr,2);// 1arrUtil.lastIndexOf(arr,2);// 3arrUtil.slice(arr,1,3);// [2,3,2]arrUtil.fill(arr,0,1,3);// [5,0,0,0,1]arrUtil.flat([0,1,2,[3,4]]);// [0,1,2,3,4]// mapFunc = function(element, index, arr)// return element + 1// end functionarrUtil.map(arr,mapFunc);// [6,3,4,3,2]// reduceFunc = function(acc, element, index, arr)// return acc + element// end functionarrUtil.reduce(arr,reduceFunc);// 13arrUtil.reduce(arr,reduceFunc,5);// 18// filterFunc = function(element, index, arr)// return element > 2// end functionarrUtil.filter(arr,filterFunc);// [5,3]// testFunc = function(element, index, arr)// return element > 2// end functionarrUtil.find(arr,testFunc);// 5arrUtil.findIndex(arr,testFunc);// 0arrUtil.every(arr,testFunc);// falsearrUtil.some(arr,testFunc);// truegroupArr=[{name:"asparagus",type:"vegetables"},{name:"bananas",type:"fruit"},{name:"cherries",type:"fruit"},];arrUtils.groupBy(groupArr,"type");// { vegetables: [{ name: "asparagus", type: "vegetables" }], fruit: [{ name: "bananas", type: "fruit" }, { name: "cherries", type: "fruit" }]}
This utility expands the string functionalities provided by the built-inString/roString types. It implements the following functions:isString,charAt,startsWith,endsWith,contains,indexOf,match,replace,truncate,repeat,padStart,padEnd,concat,toString,toMD5,toSHA1,toSHA256,toSHA512.
Example usages:
strUtil=StringUtil();str="AbraCadabra";strUtil.isString(str);// truestrUtil.charAt(str,1);// "b"strUtil.startsWith(str,"Abra");// truestrUtil.endsWith(str,"Cadabra");// truestrUtil.contains(str,"bra");// truestrUtil.indexOf(str,"ra");// 2strUtil.match(str,"(ab)(ra)","i");// ["Abra","Ab","ra"]strUtil.replace(str,"Cad","-");// "Abra-abra"strUtil.truncate(str,4,"...");// "Abra..."strUtil.repeat(str,2);// "AbraCadabraAbraCadabra"strUtil.padStart(str,15);// " AbraCadabra"strUtil.padEnd(str,15);// "AbraCadabra "strUtil.concat(str," Cadabra");// "AbraCadabra Cadabra"strUtil.toString(["1",2,true]);// "[1,2,true]"strUtil.toMD5(str);// "3aa51d002ab23a353b13df9ba059b4fc"
This utility provides additional mathematical constants and functions for BrightScript. It implements the following functions:isNumber,isInt,isFloat,isDouble,ceil,floor,round,min,max,power.
Example usages:
math=MathUtil();math.isNumber(1.4);// truemath.ceil(1.4);// 2math.floor(1.4);// 1math.round(1.4);// 1math.round(1.4159,3);// 1.416math.min(0,3);// 0math.max(0,3);// 3math.power(2,8);// 256math.E;// 2.718281828459math.PI;// 3.1415926535898
This utility makes it easier to deal withroRegistry androRegistrySection objects by simplifiyng all registry functions. It implements the following functions:read,write,delete,readSection,deleteSection,getSections,clear.
Example usages:
registry=RegistryUtil();registry.write("myKey","myValue","mySection");// Replaces the value of the specified key for a given sectionregistry.read("myKey","mySection");// Reads and returns the value of the specified key from a given sectionregistry.delete("myKey","mySection");// Deletes the specified key from a given sectionregistry.readSection("mySection");// Reads and return all key values from a given sectionregistry.deleteSection("mySection");// Deletes all key values from a specified sectionregistry.getSections();// Returns all sections in the registryregistry.clear();// Deletes all sections from the registry
Feel free to submit any pull request or issue to contribute to this project. Suggestions for new utilities or features are also welcomed.
- juliomalves - Initial work & maintainer
This project is licensed under theMIT License.
About
Compilation of utilities for Roku development