README

A PHP library for Ooyala REST APIs

Development

The Ooyala client API uses composer to manage dependencies. Included are a couple convenience Rake tasks for getting/running composer:

Install composer dependencies + dev dependencies:

rake composer:dev

Install required dependencies:

rake composer:install

Note: Running Rake composer tasks requires curl

Testing

The library testing suite contains mocked response objects and some core tests against the live Ooyala API.

Run offline tests tests:

rake test:offline

Run live tests against the Ooyala API:

rake test:internet

Run the entire test suite:

rake test

Travis CI

Tests use Travis secure environment variables. Forks testing this branch will need to generate environment variables to use Travis:

bundle install
bundle exec travis encrypt MY_VAR=my-secret

Note: encrypted ENV variables for this project will not work correctly on a fork. See the build configuration guide for more info.

Documentation

API documentation is available at http://sheknows.github.com/ooyala-api-client/. To build the documentation:

Make sure you have initialized submodules:

git submodule init
git submodule update

Run the API generator:

rake build:api

License

Ooyala API Client is © 2013 SheKnows, LLC. It is free software, and may be redistributed under the terms specified in the LICENSE file.