Overview

BigDoor version 0.1.1

This package provides both low-level procedural (WWW::BigDoor) and object-oriented
(WWW::BigDoor::Resource object hierarchy) interfaces to BigDoor REST API.

INSTALLATION

To install this module, run the following commands:

	perl Makefile.PL
	make
	make test
	make install

Alternatively, to install with Module::Build, you can use the following commands:

	perl Build.PL
	./Build
	./Build test
	./Build install

TESTS SUITE

By default tests uses saved HTTP responses residing in ./t/responses/
directory. They could be regenerated by running tests with environment variable
BIGDOOR_TEST_SAVE_RESPONSES defined. To run test against live API server
without saving responses set variable BIGDOOR_TEST_LIVESERVER. Running against
live server requires two environemnet variables set - BIGDOOR_API_KEY and
BIGDOOR_API_SECRET or you will get authentication failures.

DEPENDENCIES

The module requires the following modules:

-   REST::Client
-   JSON
-   URI
-   Digest::SHA
-   UUID::Tiny

Test suite requires additional modules:

-   Test::Most
-   Test::MockObject
-   Test::MockModule
-   Test::NoWarnings
-   Hook::LexWrap

COPYRIGHT AND LICENCE

BigDoor Open License
Copyright (c) 2010 BigDoor Media, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to
do so, subject to the following conditions:

- This copyright notice and all listed conditions and disclaimers shall
be included in all copies and portions of the Software including any
redistributions in binary form.

- The Software connects with the BigDoor API (api.bigdoor.com) and
all uses, copies, modifications, derivative works, mergers, publications,
distributions, sublicenses and sales shall also connect to the BigDoor API and
shall not be used to connect with any API, software or service that competes
with BigDoor's API, software and services.

- Except as contained in this notice, this license does not grant you rights to
use BigDoor Media, Inc. or any contributors' name, logo, or trademarks.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.