X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/e26ebaf981dcda084a41fd5773c725dbbf57636d..eb78080080e9357526fa23e08cd33c924530a4a0:/README diff --git a/README b/README index 9582150d66..6e7557f45e 100644 --- a/README +++ b/README @@ -12,26 +12,57 @@ APIs. == Example Usage - require 'google/api_client' - client = Google::APIClient.new(:service => 'buzz') - client.authorization.fetch_temporary_credential!( - :additional_parameters => { - 'scope' => 'https://www.googleapis.com/auth/buzz' - } + # Initialize the client + require 'google/api_client' + require 'signet/oauth_1/client' + client = Google::APIClient.new( + :service => 'buzz', + # Buzz has API-specific endpoints + :authorization => Signet::OAuth1::Client.new( + :temporary_credential_uri => + 'https://www.google.com/accounts/OAuthGetRequestToken', + :authorization_uri => + 'https://www.google.com/buzz/api/auth/OAuthAuthorizeToken', + :token_credential_uri => + 'https://www.google.com/accounts/OAuthGetAccessToken', + :client_credential_key => 'anonymous', + :client_credential_secret => 'anonymous' ) - client.authorization.authorization_uri - # Redirect user here - client.authorization.fetch_token_credential!(:verifier => '12345') - response = client.execute( - 'buzz.activities.list', - 'scope' => '@self', 'userId' => '@me', 'alt' => 'json' - ) - status, headers, body = response + ) + client.authorization.fetch_temporary_credential!( + :additional_parameters => { + 'scope' => 'https://www.googleapis.com/auth/buzz' + } + ) + redirect_uri = client.authorization.authorization_uri( + :additional_parameters => { + 'domain' => client.authorization.client_credential_key, + 'scope' => 'https://www.googleapis.com/auth/buzz' + } + ) + # Redirect user here + client.authorization.fetch_token_credential!(:verifier => '12345') -== Requirements + # Discover available methods + method_names = client.discovered_api('buzz').to_h.keys -* APIClient has no dependencies. + # Make an API call + response = client.execute( + 'chili.activities.list', + {'scope' => '@self', 'userId' => '@me', 'alt' => 'json'} + ) + status, headers, body = response == Install -* sudo gem install google-api-client +Be sure both http://gems.github.com/ and http://rubygems.org/ are in your gem +sources. + +For normal client usage, this is sufficient: + +sudo gem install google-api-client + +The command line interface, the example applications, and the test suite +require additional dependencies. These may be obtained with: + +sudo gem install google-api-client --development --force --no-rdoc --no-ri