Comienza a usar la biblioteca cliente de .NET

Jeff Fisher, equipo de Google Data APIs
Agosto de 2007

Introducción

La solución API de datos de Google
Figura 1: La solución de la API de datos de Google

Para muchos desarrolladores, la parte más difícil de un proyecto nuevo es obtener la instalación progresiva de paquetes de software nuevos, configurar un entorno de desarrollo y aprender bibliotecas nuevas. En este artículo, reuní instrucciones paso a paso sobre cómo comenzar a usar la biblioteca cliente .NET con Visual Studio 2005 para Windows o Mono para Linux y otros sistemas operativos Unix. Espero que esto pueda ahorrarle tiempo para comenzar y que pueda comenzar a trabajar rápidamente con algún código.

Visual Studio 2008

Si aún no tienes instalado Visual Studio 2008, te recomendamos usar Visual C# 2008 Express Edition, una versión gratuita de Visual Studio que te permitirá trabajar con la biblioteca cliente .NET.

Configura tu entorno

  1. Descarga la versión MSI más reciente de la biblioteca cliente en http://code.google.com/p/google-gdata/downloads/list.
  2. Ejecuta el archivo MSI descargado para instalar el paquete. Se instalará en "C:\Program Files\Google\Google Data API SDK\" de forma predeterminada. En otros ejemplos de este artículo, se supone que instalaste la biblioteca cliente en esta ubicación.
  3. Abra el archivo de solución llamado "Google Data API SDK" en la carpeta "Google Data API SDK" del menú "Start".

Compila y ejecuta muestras

  1. Verifica que la ejecución de "Build > Build Solution" se complete sin errores.
  2. Para crear una compilación de depuración, ve a "Build > Configuration Manager" y selecciona "Debug" como la configuración de solución activa. Luego, selecciona "Build > Build Solution".
  3. Los archivos binarios y de DLL que acabas de compilar se pueden encontrar en "C:\Program Files\Google\Google Data API SDK Sources\Samples\". Por ejemplo, puedes ejecutar la aplicación de muestra para Calendario si ejecutas "C:\Program Files\Google\Google Data API SDK Sources\Samples\calendar\bin\Debug\Calendar.exe". También hay algunas combinaciones de teclas de menú de inicio para estas muestras.

Desarrolla tu propia aplicación

Si quieres desarrollar en un proyecto fuera del archivo de solución que proporciona el archivo MSI, debes agregar los archivos DLL de la biblioteca cliente como una ruta de referencia.

  1. Crea o abre un proyecto fuera de la solución del SDK de la API de Google.
  2. Selecciona "Agregar referencia" en el menú Proyecto.
  3. Haz clic en la pestaña Explorar.
  4. Navega al directorio de Redis en el SDK: "C:\Program Files\Google\Google Data API SDK\Redist".
  5. Selecciona los archivos DLL que se usarán en tu código. Se necesitará Google.GData.Extensions.dll y Google.GData.Client.dll para la mayoría de los proyectos, junto con el archivo DLL específico de los servicios de Google que usas en tu aplicación.

Nota: También hay un archivo de solución para bibliotecas cliente en dispositivos móviles. Se encuentra en "C:\Program Files\Google\Google Data API SDK\Sources\Library\VS2005.mobile" de forma predeterminada. Esta solución solo compilará los archivos DLL para las bibliotecas cliente.

Ejecuta las pruebas de NUnit

Asegúrate de que las pruebas de NUnit apropiadas sean un paso importante si realizas algún cambio en las bibliotecas cliente o planeas contribuir con ellas. Si planeas usar las bibliotecas cliente sin modificaciones, normalmente no es necesario ejecutarlas.

  1. Descargue la versión .NET 2.0 del archivo MSI de NUnit desde http://www.nunit.org/index.php?p=download.
  2. Ejecuta el archivo MSI para instalar NUnit. La ubicación de instalación predeterminada es similar a "C:\Archivos de programa\NUnit 2.4.8". Es posible que desees cambiar esto a "C:\Archivos de programa\NUnit" para poder actualizar NUnit en el futuro sin tener que cambiar la ruta en tu proyecto de Visual Studio.
  3. Ve al directorio "C:\Program Files\Google\Google API SDK Sources\Library\VS2005" y abre el archivo de la solución llamado "Google Data APIs". Verá el asistente de conversión, ya que este es un archivo de proyecto de Visual Studio 2005. Haz clic en las indicaciones o simplemente haz clic en el botón "Finalizar". Debería mostrar el registro de conversiones, que se puede ignorar.
  4. Ahora se debe agregar NUnit como ruta de referencia. Haga clic con el botón derecho del mouse en el proyecto "unittests" en el explorador de soluciones que se encuentra a la derecha y seleccione "Properties". Ahora, haga clic en la pestaña "Reference Paths" dentro de la ventana que se abre. Ingrese la ubicación del subdirectorio "bin" de la instalación de NUnit como ruta de referencia y haga clic en "Add Folder". Por ejemplo, si NUnit está instalada en "C:\Archivos de programa\NUnit\", ingresaría "C:\Archivos de programa\NUnit\bin". Asegúrate de guardar este cambio antes de continuar.
  5. Sigue los pasos que se indican en Cómo compilar y ejecutar muestras para volver a compilar la biblioteca cliente y las pruebas de unidades.
  6. Copia el archivo "unittests.dll.config" en "C:\Program Files\Google\Google Data API SDK Sources\Library\unittests\" al directorio de compilación de depuración "C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\". Recuerde editar el archivo a fin de incluir la información adecuada para las pruebas que ejecuta. Por ejemplo, Base requiere una clave de API y el Calendario requiere un nombre de usuario y una contraseña. Se recomienda usar una cuenta de prueba sin datos en vivo para evitar que las pruebas de unidades borren la información.
  7. Abre NUnit en el menú Inicio.
  8. Ve a "File > Open Project" y selecciona el archivo "unittests.dll" en "C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\".
  9. Ejecuta las pruebas de unidades que te interesan. Recuerda que ciertas pruebas requieren que los parámetros se configuren en unittests.dll.config para que funcionen. Si ejecutas las pruebas de esfuerzo para ciertos servicios, es posible que tu cuenta de prueba esté marcada como generadora de spam y no puedas enviar contenido de manera programática a los servidores de Google sin encontrar desafíos de CAPTCHA.

Mono

Mono es un proyecto de código abierto que te permite ejecutar aplicaciones de cliente y servidor de .NET en Linux, Solaris, Mac OS X, Windows y Unix. Ofrecemos un archivo ZIP independiente de nuestra biblioteca cliente para los programadores que deseen trabajar en una de estas plataformas.

Configura tu entorno

  1. Descarga la versión más reciente del archivo ZIP de la biblioteca cliente desde http://code.google.com/p/google-gdata/downloads/list.
  2. Extraer en un directorio local (p.ej., "/scratch/gdata.NET")
  3. Usa la administración de paquetes de tu distribución para instalar Mono. De manera alternativa, puedes descargarlo desde http://www.mono-project.com.
  4. En algunas distribuciones, debes asegurarte de que el archivo nunit.framework.dll esté vinculado correctamente a la biblioteca mono. Si se instaló en modo mono en "/usr/lib/mono", asegúrate de que haya vínculos simbólicos en "/usr/lib/mono/1.0" y "/usr/lib/mono/2.0" para nunit.framework.dll (que debe instalarse en "/usr/lib/mono/gac/nunit.framework/<someversionstring>/nunit.framework).

Compila y ejecuta muestras

  1. Si instalaste la biblioteca cliente como "/scratch/gdata.NET", cambia al directorio "/scratch/gdata.NET/clients/cs".
  2. Edita el archivo makefile según la versión de .NET que desees usar. Para usar .NET 1.x, usa CSC=mcs y, para .NET 2.x, usa CSC=gmcs.
  3. Ejecuta make para compilar las bibliotecas y las aplicaciones de muestra.
  4. Ejecuta make install si deseas instalar la DLL de la biblioteca cliente en la biblioteca Mono.

Desarrolla tu propia aplicación

Si ejecutaste un make install después de compilar la biblioteca cliente, deberías poder incluir las bibliotecas en tu propio código pasando -r:Google.GData.Extensions.dll -r:Google.GData.Client.dll al compilador Mono C# junto con referencias a los archivos DLL de cualquier extensión de servicio específica que desees usar.

Ejecuta las pruebas de NUnit

  1. Copia el archivo unittests.dll.config de "/scratch/gdata.NET/clients/cs/src/unittests" a "/scratch/gdata.NET/clients/cs/".
  2. Edita "/scratch/gdata.NET/clients/cs/unittests.dll.config" a fin de incluir la información correspondiente para las pruebas que estés ejecutando. Por ejemplo, Base requiere una clave de API y el Calendario requiere un nombre de usuario y una contraseña. Te recomendamos que uses una cuenta de prueba sin datos en vivo para evitar que las pruebas de unidades borren la información.
  3. Después de compilar la biblioteca, habrá un archivo unittests.dll en "/scratch/gdata.NET/clients/cs". Usa esta DLL con el administrador de pruebas de NUnit que desees (nunit-console, gnunit, etcétera).

Conclusión

Ahora deberías poder compilar las bibliotecas y ejecutar el código de muestra. Sin embargo, esto es solo el comienzo. Le recomendamos que lea la documentación que se encuentra en el directorio ".../clients/cs/docs" de la biblioteca cliente. También puedes consultar la Guía para desarrolladores de la biblioteca cliente de .NET, la página del proyecto y la guía de referencia, y el foro de la biblioteca cliente de .NET de Google.

Herramientas a las que se hace referencia en este artículo:

¡Buena suerte con tu próxima aplicación de .NET!