/*
Copyright 2012 - 2014 Jerome Leleu
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package org.pac4j.oauth.client;
import com.fasterxml.jackson.databind.JsonNode;
import org.pac4j.core.context.WebContext;
import org.pac4j.oauth.profile.JsonHelper;
import org.pac4j.oauth.profile.OAuthAttributesDefinitions;
import org.pac4j.oauth.profile.foursquare.FoursquareProfile;
import org.scribe.builder.api.Foursquare2Api;
import org.scribe.model.OAuthConfig;
import org.scribe.model.SignatureType;
import org.scribe.model.Token;
import org.scribe.oauth.FoursquareOAuth20ServiceImpl;
/**
* This class is the OAuth client to authenticate users in Foursquare.
* It returns a {@link org.pac4j.oauth.profile.foursquare.FoursquareProfile}.
* <p />
* More information at https://developer.foursquare.com/overview/auth.html
*
* @see org.pac4j.oauth.profile.foursquare.FoursquareProfile
* @author Alexey Ogarkov
* @since 1.5.0
*/
public class FoursquareClient extends BaseOAuth20Client<FoursquareProfile>{
public FoursquareClient() {}
public FoursquareClient(String key, String secret) {
setKey(key);
setSecret(secret);
}
protected FoursquareClient newClient() {
return new FoursquareClient();
}
protected void internalInit() {
super.internalInit();
this.service = new FoursquareOAuth20ServiceImpl(new Foursquare2Api(),
new OAuthConfig(this.key, this.secret, this.callbackUrl, SignatureType.Header, "user", null),
this.connectTimeout,
this.readTimeout,
this.proxyHost,
this.proxyPort);
}
protected FoursquareProfile extractUserProfile(String body) {
FoursquareProfile profile = new FoursquareProfile();
JsonNode json = JsonHelper.getFirstNode(body);
if (json == null) {
return profile;
}
JsonNode response = (JsonNode) JsonHelper.get(json, "response");
if (response == null) {
return profile;
}
JsonNode user = (JsonNode) JsonHelper.get(response, "user");
if (user != null) {
profile.setId(JsonHelper.get(user, "id"));
for (final String attribute : OAuthAttributesDefinitions.foursquareDefinition.getAllAttributes()) {
profile.addAttribute(attribute, JsonHelper.get(user, attribute));
}
}
return profile;
}
protected boolean requiresStateParameter() {
return false;
}
protected boolean hasBeenCancelled(WebContext context) {
return false;
}
@Override
protected String getProfileUrl(Token accessToken) {
return "https://api.foursquare.com/v2/users/self?v=20131118";
}
}