Primeiros passos com a biblioteca de cliente .NET

Jeff Fisher, equipe de APIs de dados do Google
agosto de 2007

Introdução

Solução da API Google Data
Figura 1: solução da API Google Data

Para muitos desenvolvedores, a parte mais difícil de um novo projeto é começar a instalação de novos pacotes de software, configurar um ambiente para desenvolvedores e aprender novas bibliotecas. Neste artigo, reuni algumas instruções detalhadas sobre como começar com a biblioteca de cliente .NET usando o Visual Studio 2005 para Windows ou o Mono para Linux e outros sistemas operacionais Unix. Espero que isso economize seu tempo e que comece a trabalhar com códigos.

Visual Studio 2008

Se você ainda não tiver o Visual Studio 2008 instalado, recomendamos usar o Visual C# 2008 Express Edition, uma versão sem custo financeiro do Visual Studio que permite trabalhar com a biblioteca de cliente .NET.

Como configurar o ambiente

  1. Faça o download da versão mais recente do MSI da biblioteca de cliente em http://code.google.com/p/google-gdata/downloads/list.
  2. Execute o arquivo MSI salvo para instalar o pacote. Por padrão, ele vai ser instalado em "C:\Arquivos de Programas\Google\SDK de API de dados do Google". Para outros exemplos deste artigo, pressupomos que você tenha instalado a biblioteca de cliente nesse local.
  3. Abra o arquivo de solução chamado "SDK da API Google Data" na pasta "SDK da API Google Data" no menu "Iniciar".

Como compilar e executar amostras

  1. Verifique se a execução de "Build > Build Solution" é concluída sem erros.
  2. Para criar um build de depuração, acesse "Build > Configuration Manager" e selecione "Debug" como a configuração da solução ativa. Em seguida, selecione "Build > Build Solution".
  3. Os binários e os arquivos DLL que você acabou de compilar podem ser encontrados em "C:\Program Files\Google\Google Data API SDK\Sources\Samples\" Por exemplo, você pode executar o aplicativo de exemplo para o Agenda executando "C:\Program Files\Google\Google Data API SDK\Sources\Samples\calendar\bin\Debug\Calendar.exe". Também há alguns atalhos do menu "Iniciar" para essas amostras.

Como desenvolver seu próprio aplicativo

Se você quiser desenvolver em um projeto fora do arquivo da solução fornecido pelo arquivo MSI, vai precisar adicionar os arquivos DLL da biblioteca de cliente como um caminho de referência.

  1. Crie ou abra um projeto fora da solução do SDK da API do Google.
  2. Selecione "Add Reference" no menu "Project".
  3. Clique na guia "Procurar".
  4. Navegue até o diretório Redis no SDK: "C:\Arquivos de Programas\Google\Google Data API SDK\Redist".
  5. Selecione os arquivos DLL que serão usados pelo seu código. Google.GData.Extensions.dll e Google.GData.Client.dll serão necessários para a maioria dos projetos, junto com o arquivo DLL específico aos serviços do Google que você está usando no seu aplicativo.

Observação:há também um arquivo de solução para bibliotecas de cliente em dispositivos móveis. Por padrão, ela está disponível em "C:\Arquivos de Programas\Google\Google Data API SDK\Sources\Library\VS2005.mobile". Essa solução vai compilar apenas os arquivos DLL das bibliotecas de cliente.

Como executar os testes NUnit

Garantir a aprovação nos testes NUnit adequados é uma etapa importante se você fizer alterações nas bibliotecas de cliente ou planejar contribuir com elas. Se você pretende usar as bibliotecas de cliente sem modificações, normalmente não é necessário executá-las.

  1. Faça o download da versão do .NET 2.0 MSI do NUnit em http://www.nunit.org/index.php?p=download.
  2. Instale o NUnit executando o arquivo MSI. O local de instalação padrão é semelhante a "C:\Arquivos de Programas\NUnit 2.4.8". Você pode mudar para algo como "C:\Arquivos de Programas\NUnit" para poder atualizar o NUnit no futuro sem ter que mudar o caminho no seu projeto do Visual Studio.
  3. Acesse o diretório "C:\Arquivos de Programas\Google\Google Data API SDK\Sources\Library\VS2005" e abra o arquivo de solução chamado "Google Data APIs". Você verá o assistente de conversão, já que ele é um arquivo de projeto do Visual Studio 2005. Clique nas solicitações ou apenas no botão "Concluir". Ela exibirá o registro de conversões, que pode ser ignorado.
  4. Agora, NUnit precisa ser adicionado como um caminho de referência. Clique com o botão direito do mouse no projeto "unittests" no Solution Explorer à direita e selecione "Propriedades". Clique na guia "Caminhos de referência" na janela que é aberta. Digite o local do subdiretório "bin" da instalação do NUnit como um caminho de referência e clique em "Add Folder". Por exemplo, se o NUnit estiver instalado em "C:\Arquivos de Programas\NUnit\", será necessário digitar "C:\Arquivos de Programas\NUnit\bin". Salve essa alteração antes de continuar.
  5. Siga as etapas listadas em Como compilar e executar amostras para recriar a biblioteca de cliente e os testes de unidade.
  6. Copie o arquivo "unittests.dll.config" em "C:\Program Files\Google\Google Data API SDK\Sources\Library\unittests\" no diretório de build de depuração "C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\". Lembre-se de editar o arquivo para incluir as informações apropriadas para os testes que você está executando. Por exemplo, o Base exige uma chave de API, e o Agenda exige um nome de usuário e uma senha. É recomendável usar uma conta de teste sem dados ativos para evitar que as informações sejam excluídas pelos testes de unidade.
  7. Abra o NUnit no menu "Start".
  8. Acesse "File > Open Project" e selecione o arquivo "unittests.dll" em "C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\".
  9. Execute os testes de unidade em que você tem interesse. Alguns testes exigem que os parâmetros sejam definidos em unittests.dll.config para funcionar. Se você realizar testes de estresse para determinados serviços, sua conta de teste pode ser sinalizada como gerada por spam e não pode enviar conteúdo de maneira programática para os servidores do Google sem enfrentar desafios de CAPTCHA.

Mono

O Mono é um projeto de código aberto que permite executar aplicativos cliente e servidor .NET no Linux, Solaris, Mac OS X, Windows e Unix. Oferecemos um arquivo ZIP separado da nossa biblioteca de cliente para desenvolvedores que querem trabalhar em uma dessas plataformas.

Como configurar o ambiente

  1. Faça o download da versão mais recente do arquivo ZIP da biblioteca de cliente em http://code.google.com/p/google-gdata/downloads/list.
  2. Extrair para um diretório local (por exemplo, "/scratch/gdata.NET")
  3. Use o gerenciamento de pacotes de distribuição para instalar o Mono. Se preferir, faça o download em http://www.mono-project.com.
  4. Em algumas distribuições, é necessário verificar se o arquivo nunit.framework.dll está vinculado corretamente à biblioteca mono. Se o mono estiver instalado em "/usr/lib/mono", verifique se há links simbólicos em "/usr/lib/mono/1.0" e "/usr/lib/mono/2.0" para nunit.framework.dll (que precisa ser instalado em "/usr/lib/mono/gac/nunit.framework/<someversionstring>/nunit.framework.dll").

Como compilar e executar amostras

  1. Supondo que você tenha instalado a biblioteca de cliente para "/scratch/gdata.NET", mude para o diretório "/scratch/gdata.NET/clients/cs".
  2. Edite o Makefile, dependendo da versão do .NET que você quer usar. Para .NET 1.x, use CSC=mcs e, para .NET 2.x, use CSC=gmcs.
  3. Execute make para compilar as bibliotecas e os aplicativos de exemplo.
  4. Execute make install se você quiser instalar as DLLs da biblioteca de cliente na biblioteca Mono.

Como desenvolver seu próprio aplicativo

Se você executou uma make install após a compilação da biblioteca de cliente, vai ser possível incluir as bibliotecas no seu próprio código transmitindo -r:Google.GData.Extensions.dll -r:Google.GData.Client.dll ao compilador Mono C# com referências aos arquivos DLL de qualquer extensão de serviço específica que você queira usar.

Como executar os testes NUnit

  1. Copie o arquivo unittests.dll.config de "/scratch/gdata.NET/clients/cs/src/unittests" para "/scratch/gdata.NET/clients/cs/".
  2. Edite "/scratch/gdata.NET/clients/cs/unittests.dll.config" para incluir as informações apropriadas para os testes que você está executando. Por exemplo, o Base exige uma chave de API, e o Agenda exige um nome de usuário e uma senha. Recomendamos usar uma conta de teste sem dados ativos para evitar que as informações sejam excluídas pelos testes de unidade.
  3. Depois de compilar a biblioteca, haverá um arquivo unittests.dll em "/scratch/gdata.NET/clients/cs". Use essa DLL com o gerenciador de teste que quiser do NUnit (nunit-console, gnunit etc.).

Conclusão

Agora você já pode compilar as bibliotecas e executar o exemplo de código. Mas isso é só o começo. Recomendamos que você leia a documentação no diretório ".../clients/cs/docs" da biblioteca de cliente. Confira também o Guia do desenvolvedor da biblioteca de cliente.NET, a página do projeto e o guia de referência, além do fórum da biblioteca de cliente .NET do Google Data.

Ferramentas mencionadas neste artigo:

Boa sorte no seu próximo aplicativo em .NET.