File Extensions/FamilySearch/Rs/Client/FamilySearchClient.php

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353

<?php

namespace Gedcomx\Extensions\FamilySearch\Rs\Client;

use Gedcomx\Gedcomx;
use Gedcomx\Rs\Client\Rel as GedcomxRel;
use Gedcomx\Rs\Client\GedcomxApplicationState;
use Gedcomx\Rs\Client\Exception\GedcomxApplicationException;
use Gedcomx\Extensions\FamilySearch\FamilySearchPlatform;
use Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeStateFactory;
use Gedcomx\Extensions\FamilySearch\Rs\Client\Util\LoggerMiddleware;
use Gedcomx\Extensions\FamilySearch\Rs\Client\Util\ThrottlingMiddleware;
use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Handler\CurlHandler;
use GuzzleHttp\Middleware;
use GuzzleHttp\Psr7\Request;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;

/**
 * API Client for the FamilySearch API
 *
 * Class Client
 *
 * @package Gedcomx\Extensions\FamilySearch\Rs\Client
 */
class FamilySearchClient implements LoggerAwareInterface{
    
    /**
     * Guzzle client object
     * 
     * @var \GuzzleHttp\Client;
     */
    private $client;
    
    /**
     * The redirect URI used during authentication via OAuth2
     *
     * @var string
     */
    private $redirectURI;
    
    /**
     * The client ID used for authentication via OAuth2
     * 
     * @var string
     */
    private $clientId;
    
    /**
     * The client secret used for authentication via OAuth2
     * 
     * @var string
     */
    private $clientSecret;
    
    /**
     * URI for the Home Collection resource.
     * 
     * @var string
     */
    private $homeURI;
    
    /**
     * @var \Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeStateFactory
     */
    private $stateFactory;
    
    /**
     * @var \Gedcomx\Rs\Client\CollectionState
     */
    private $treeState;
    
    /**
     * @var \Gedcomx\Rs\Client\CollectionState
     */
    private $homeState;
    
    /**
     * @var \GuzzleHttp\HandlerStack
     */
    private $stack;
    
    /**
     * Construct a FamilySearch Client.
     *
     * @param array $options A keyed array of configuration options for the client. Available options:
     * 
     * * `clientId` - Required for authentication.
     * * `redirectURI` - Required for authentication.
     * * `accessToken` - If the access token is set then the `clientId` and `redirectURI` are not needed.
     * * `environment` - `production`, `beta`, or `integration`; defaults to `integration`.
     * * `userAgent` - A string which will be prepended to the default user agent string.
     * * `pendingModifications` - An array of pending modifications that should be enabled.
     * * `logger` - A `Psr\Log\LoggerInterface`. A logger can also be registered via the `setLogger()` method but passing it in as an option during instantiation ensures that the logger will see all client events.
     * * `middleware` - An array of [Guzzle Middleware](http://docs.guzzlephp.org/en/latest/handlers-and-middleware.html#middleware).
     * * `httpExceptions` - When `true`, the client will throw a `Gedcomx\Rs\Client\Exception\GedcomxApplicationException` when a 400 or 500 level HTTP response is received. 
     * * `throttling` - When `true`, the client will automatically handled throttled responses.
     */
    public function __construct($options = array())
    {
        if(isset($options['redirectURI'])){
            $this->redirectURI = $options['redirectURI'];
        }
        if(isset($options['clientId'])){
            $this->clientId = $options['clientId'];
        }
        
        // Set the proper homeURI based on the environment.
        $environment = '';
        $baseURI = '';
        if(isset($options['environment'])){
            $environment = $options['environment'];
        }
        switch($environment){
            case 'production':
                $baseURI = 'https://api.familysearch.org';
                break;
            case 'beta':
                $baseURI = 'https://beta.familysearch.org';
                break;
            default:
                $baseURI = 'https://integration.familysearch.org';
                break;
        }
        $this->homeURI = $baseURI . '/platform/collection';
        
        // Middleware
        $this->stack = new HandlerStack();
        $this->stack->setHandler(new CurlHandler());
        $this->stack->push(Middleware::httpErrors());
        $this->stack->push(Middleware::redirect());
        
        // Pending modifications
        if(isset($options['pendingModifications']) && is_array($options['pendingModifications']) && count($options['pendingModifications']) > 0){
            $experiments = join(",", $options['pendingModifications']);
            $this->stack->push(Middleware::mapRequest(function(RequestInterface $request) use($experiments) {
                return $request->withHeader('X-FS-Feature-Tag', $experiments);
            }));
        }
        
        // Throttling
        if(isset($options['throttling']) && $options['throttling'] === true){
            $this->stack->push(ThrottlingMiddleware::middleware());
        }
        
        // Set user agent string
        $userAgent = 'gedcomx-php/1.1.1 ' . \GuzzleHttp\default_user_agent();
        if(isset($options['userAgent'])){
            $userAgent = $options['userAgent'] . ' ' . $userAgent;
        }
        
        // Custom middleware
        if(isset($options['middleware']) && is_array($options['middleware'])) {
            foreach($options['middleware'] as $middleware){
                $this->stack->push($middleware);
            }
        }
        
        // This goes last so that it sees the final request and response
        if(isset($options['logger'])){
            $this->setLogger($options['logger']);
        }
        
        $clientOptions = [
            'handler' => $this->stack,
            'base_uri' => $baseURI,
            'headers' => [
                'User-Agent' => $userAgent
            ]
        ];
        
        // Throw exceptions
        if(isset($options['httpExceptions']) && $options['httpExceptions'] === true){
            $clientOptions['http_errors'] = true;
        } else {
            $clientOptions['http_errors'] = false;
        }
        
        // Create client
        $this->client = new Client($clientOptions);
        
        $this->stateFactory = new FamilyTreeStateFactory();
        
        $this->createHomeState();
        $this->createTreeState();
        
        if(isset($options['accessToken'])){
            $this->treeState->authenticateWithAccessToken($options['accessToken']);
        }
    }
    
    /**
     * @return Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeCollectionState
     */
    public function familytree()
    {
        return $this->treeState;
    }
    
    /**
     * Authenticate via the OAuth2 password flow
     * 
     * @param string $username
     * @param string $password
     * 
     * @return FamilySearchClient
     */
    public function authenticateViaOAuth2Password($username, $password)
    {
        $this->requireClientIdAndRedirectURI();
        $this->treeState->authenticateViaOAuth2Password($username, $password, $this->clientId, $this->clientSecret);
        return $this;
    }
    
    /**
     * Authenticate with an OAuth2 code
     * 
     * @param string $code
     * 
     * @return FamilySearchClient
     */
    public function authenticateViaOAuth2AuthCode($code)
    {
        $this->requireClientIdAndRedirectURI();
        $this->treeState->authenticateViaOAuth2AuthCode($code, $this->redirectURI, $this->clientId);
        return $this;
    }
    
    /**
     * Get the URL that the user should be sent to in order to
     * begin the OAuth2 redirect flow.
     * 
     * @return string $url
     */
    public function getOAuth2AuthorizationURI()
    {
        $this->requireClientIdAndRedirectURI();
        
        $url = $this->treeState->getLink(GedcomxRel::OAUTH2_AUTHORIZE)->getHref();
        $params = array(
            'response_type' => 'code',
            'redirect_uri' => $this->redirectURI,
            'client_id' => $this->clientId
        );
        return $url . '?' . http_build_query($params);
    }
    
    /**
     * Get the access token for this session
     * 
     * @return string
     */
    public function getAccessToken()
    {
        return $this->treeState->getAccessToken();
    }
    
    /**
     * Set the access token for this session
     * 
     * @return FamilySearchClient
     */
    public function setAccessToken($accessToken)
    {
        $this->treeState->authenticateWithAccessToken($accessToken);
        return $this;
    }
    
    /**
     * Get a list of valid pending modifications
     * 
     * @return array Array of \Gedcomx\Extensions\FamilySearch\Feature
     */
    public function getAvailablePendingModifications()
    {
        $uri = $this->homeState->getCollection()->getLink('pending-modifications')->getHref();
        $headers = ['Accept' => Gedcomx::JSON_APPLICATION_TYPE];
        $request = new Request('GET', $uri, $headers);
        $response = GedcomxApplicationState::send($this->client, $request);
        

        // Get each pending feature
        $json = json_decode($response->getBody(), true);
        $fsp = new FamilySearchPlatform($json);
        $features = array();
        foreach ($fsp->getFeatures() as $feature) {
            $features[] = $feature;
        }
        
        return $features;
    }
    
    /**
     * Sets a logger instance on the object
     *
     * @param Psr\Log\LoggerInterface $logger
     * @return null
     */
    public function setLogger(LoggerInterface $logger)
    {
        $this->stack->push(LoggerMiddleware::middleware($logger));
    }
    
    /**
     * Ensure the homeState propery exists
     */
    private function createHomeState()
    {
        if($this->homeState == null){
            $this->homeState = $this->stateFactory->newCollectionState(
                $this->homeURI,
                'GET',
                $this->client
            );
        }
    }
    
    /**
     * Ensure the treeState propery exists
     */
    private function createTreeState()
    {
        $this->createHomeState();
        $this->treeState = $this->stateFactory->newCollectionState(
            $this->homeState->getCollection()->getLink('family-tree')->getHref(),
            'GET',
            $this->client
        );
    }
    
    /**
     * Throw an exception if the clientId or redirectURI are not set.
     * 
     * @throw GedcomxApplicationException
     */
    private function requireClientIdAndRedirectURI()
    {
        if(!$this->clientId)
        {
            throw new GedcomxApplicationException('No clientId has been set. Unable to begin authentication.');
        }
        if(!$this->redirectURI)
        {
            throw new GedcomxApplicationException('No redirectURI has been set. Unable to begin authentication.');
        }
    }
    
}

Namespaces

Classes

Interfaces

Exceptions