rdohms/meetup-api-client


Guzzle powered Meetup.com API Client

License: MIT

Language: PHP


DMS Meetup.com API Client Build Status

This is a client for the Meetup.com API powered by the Guzzle Project.

Installation

The library is available through Composer, so its easy to get it. Just Run this:

composer require dms/meetup-api-client

Features

  • All documented and non-deprecated methods from:
    • Meetup API v3
    • Meetup API v2
    • Legacy v1, except methods tagged as deprecated
  • Key authentication
  • OAuth 1.0 Authentication
  • OAuth 2.0 Authentication
  • POST, GET and DELETE methods

Usage

To use the API Client simply instantiate the preferred client (key auth or OAuth), giving it the correct parameters

<?php

// Key Authentication
$client = MeetupKeyAuthClient::factory(array('key' => 'my-meetup-key'));

// OAuth Authentication
$config = array(
    'consumer_key'    => 'consumer-key',
    'consumer_secret' => '*****',
    'token'           => '*****',
    'token_secret'    => '*****',
);
$client = MeetupOAuthClient::factory($config);

// OAuth2 Authentication
$config = array(
    'access_token'    => 'access_token',
);
$client = MeetupOAuth2Client::factory($config);

Invoke Commands using our __call method (auto-complete phpDocs are included)

<?php

$client = MeetupKeyAuthClient::factory(array('key' => 'my-meetup-key'));

// Use our __call method (auto-complete provided)
$response = $client->getRsvps(array('event_id' => 'the-event-id'));

foreach ($response as $responseItem) {
    echo $responseItem['member']['name'] . PHP_EOL;
}

Or Use the getCommand method:

<?php

$client = MeetupKeyAuthClient::factory(array('key' => 'my-meetup-key'));

//Retrieve the Command from Guzzle
$command = $client->getCommand('GetRsvps', array('event_id' => 'the-event-id'));
$command->prepare();

$response = $command->execute();

foreach ($response as $responseItem) {
    echo $responseItem['member']['name'] . PHP_EOL;
}

For a list of all the available commands, see the Meetup API documentation on ReadTheDocs

Response

This wrapper implements two types of custom responses to facilitate the usage of the results directly.

Response for Collection

When querying for collections the client wraps the result in a MultiResultResponse. This response implements a Iterator allowing you to directly iterate over the results, while still giving you access to all response data, as well as the metadata returned by the API using the getMetaData() method.

<?php

$rsvps = $client->getRsvps(array('event_id' => 'the-event-id'));

foreach ($rsvps as $rsvp) {
    echo $rsvp['member']['name'] . PHP_EOL;
}

$metadata = $response->getMetaData();
echo "Debug Url:" . $metadata['url'];

Response for Single Resource

When getting information of a single resource the client will wrap that in a SingleResultResponse. This response gives you direct array access to results, but retains response data so you can still access it.

<?php

$rsvp = $client->getRsvp(array('id' => 'rsvp-id'));

echo "RSVP? " . $rsvp['response'];

echo "StatusCode: " . $rsvp->getStatusCode();

Rate Limiting

A rate limiter is included in this client, its enabled by default, but can be disabled as described below. It uses a pre-defined factor (50% by default) to determine when it should start throttling the calls, by using a sleep slowdown. Operations are based on the X-RateLimit-* headers, to determine remaining limits and reset times.

Configuring Rate Limit Kick-in Factor

To configure how late the back algorithm kicks in, you can set a custom rate factor:

<?php

$client = MeetupKeyAuthClient::factory(array(
    'key' => 'my-meetup-key',
    'rate_limit_factor' => 0.75
));

Disabling Rate Limiting

If you do not wish to use Rate Limiting and deal with errors sent by the API yourself, use the config below.

<?php

$client = MeetupKeyAuthClient::factory(array(
    'key' => 'my-meetup-key',
    'disable_rate_limiting' => true
));

License

The API client is available under an MIT License.

Project Statistics

Sourcerank 8
Repository Size 507 KB
Stars 73
Forks 21
Watchers 7
Open issues 12
Dependencies 33
Contributors 10
Tags 12
Created
Last updated
Last pushed

Top Contributors See all

Rafael Dohms Dennis de Greef steffkes Nitin Anand Luís Cobucci Rogerio Prado de Jesus Jimmy Tristan Sokol Michelangelo van Dam Pete Hotchkiss

Packages Referencing this Repo

dms/meetup-api-client
Meetup.com API client written on top of Guzzle. This supports all API operations.
Latest release v2.4.0 - Updated - 73 stars

Recent Tags See all

v2.4.0 September 01, 2019
v2.3.1 December 26, 2017
v2.3 December 11, 2016
v2.2 August 14, 2016
v2.1 June 17, 2016
v2.0.1 December 23, 2015
v2.0.0 May 02, 2015
v1.3.0 December 30, 2014
v1.2.0 April 18, 2014
1.1.1 November 12, 2013
v1.1 April 11, 2013
1.0.0 March 29, 2013

Something wrong with this page? Make a suggestion

Last synced: 2019-09-03 13:17:35 UTC

Login to resync this repository