https://github.com/mislav/contacts

Ruby library for consuming Google, Yahoo!, Flickr and Windows Live contact APIs
https://github.com/mislav/contacts

Last synced: about 1 year ago
JSON representation

Ruby library for consuming Google, Yahoo!, Flickr and Windows Live contact APIs

• Host: GitHub
• URL: https://github.com/mislav/contacts
• Owner: mislav
• License: mit
• Created: 2008-03-16T03:52:46.000Z (about 18 years ago)
• Default Branch: master
• Last Pushed: 2010-03-19T13:53:23.000Z (about 16 years ago)
• Last Synced: 2024-10-17T18:28:44.345Z (over 1 year ago)
• Language: Ruby
• Homepage:
• Size: 579 KB
• Stars: 406
• Watchers: 7
• Forks: 67
• Open Issues: 4
• Metadata Files:
  • Readme: README.rdoc
  • License: LICENSE

Awesome Lists containing this project

README

          
== Basic usage instructions

Fetch users' contact lists from your web application without asking them to

provide their passwords.

First, register[http://code.google.com/apis/accounts/docs/RegistrationForWebAppsAuto.html]

your application's domain. Then make users follow this URL:

  Contacts::Google.authentication_url('http://mysite.com/invite')

They will authenticate on Google and it will send them back to the URL

provided. Google will add a token GET parameter to the query part of the URL.

Use that token in the next step:

  gmail = Contacts::Google.new(params[:token])

  gmail.contacts

  # => [#, #, ...]

The resulting Contacts::Contact objects have `name` and `email` properties.

Read more in Contacts::Google. I plan to support more APIs (Microsoft Live, for

starters); feel free to contribute.

Author: Mislav Marohnić (mislav.marohnic@gmail.com)

== Documentation auto-generated from specifications

Contacts::Google.authentication_url

- generates a URL for target with default parameters

- should handle boolean parameters

- skips parameters that have nil value

- should be able to exchange one-time for session token

Contacts::Google

- fetches contacts feed via HTTP GET

- handles a normal response body

- handles gzipped response

- raises a FetchingError when something goes awry

- parses the resulting feed into name/email pairs

- parses a complex feed into name/email pairs

- makes modification time available after parsing

Contacts::Google GET query parameter handling

- abstracts ugly parameters behind nicer ones

- should have implicit :descending with :order

- should have default :limit of 200

- should skip nil values in parameters