adlayer-library

Adlayer javascript core library

Adayer Javascript Library

Essa biblioteca contem um conjunto de módulos para interagir com dados da Adlayer.

A missão principal da JS Lib é evitar a replicação de código em projetos Javascript que lidam com as estruturas de dados da Adlayer.

"Don't repeat yourself"

O Adlayer JS Lib inclui classes de estruturas básicos como paginas, sites, espaços, peças e de responsabilidade mais avançadas como comunicação com o Adlayer Ad Server (Jocasta) e o Adlayer Tracker.

Atualmente a biblioteca inclui os seguintes módulos:

  • Ads
  • Connection
  • DOM
  • Domain
  • Node_modules
  • Request
  • Spaces
  • Tracker
  • Utils

Adlayer usa e abusa de javascript em seu backend e frontend, portanto a Adlayer javascript library foi criada para ser usada em múltiplos ambientes.

Todos os módulos podem ser importados em ambientes que suportam common.js 1.0 como Node.js, Couchdb e etc.

Usar o Adlayer js lib no node.js é bem simples, basta clonar este repositório dentro de seu projeto e incluir o modulo desejado: EX:

var AdDom = require('./javascript-library/src/dom/ad_dom').AdDom;

Para usar os módulos da Adlayer JS Lib em um páginas web inclua antes de qualquer módulos o arquivo ./src/module.js.

Depois do 'module.js' ter sido incluído você poderá carregar os modulos que serão utilizados:

<script src="../../src/module.js"></script>
 
<script src="../../src/domain/ad.js"></script>
<script src="../../src/domain/space.js"></script>
<script src="../../src/domain/page.js"></script>

E para para usar um modulo carregado:

var FloaterSpace = require('../../src/spaces/floater_space').FloaterSpace;
var floater = new Floater();
floater.close();

Grande parte do código usado em nossa api javascript oficial é extraído dessa biblioteca.

Outro caso de uso obvio é utilizar parte da biblioteca para criar wrapper para a api REST da Adlayer (em breve).

Você poderá ver a documentação na pasta docs e em breve online.

sudo npm install stats -g sudo npm install yuidocjs -g make

Todos os módulos possuem teste unitários escritos usando Mocha e expect.js

Para rodar os teste unitários faça:

make test

Copyright (c) 2011 Adlayer Adserver <adalyer@adlayer.org>