Numerous.NET

Numerous follows the most important numbers in your life and keeps them up to date, all in one place.

Numerous.NET is an unofficial wrapper for Numerous App API. Numerous.NET requires the .NET 4.5 framework.

Getting Started

Installing Numerous.NET

The easiest way to use Numerous.NET is to install the Numerous.NET nuget. The nuget ID is numerous.api.

Coding

Create an instance of the NumerousClient class, providing your Numerous API key (you can find your API key in the Numerous mobile apps under Settings > Developer Info). NumerousClient implements IDisposable interface. You may use the using construct or use the .Close() method to release resources associated with the client.

using Numerous.Api;

var apiKey = "nmrs_123456789012"; // Replace with your Numerous API key

using (var client = new NumerousClient(apiKey))
{
	var currentUser = await client.GetUser();

	[...]
}

NumerousClient initializer also have an override taking a NumerousSettings value providing more flexible use of API (see below).

Numerous.NET is designed to work in asynchronous mode : methods that use the NumerousClient object must be marked with the async modifier. In order to use it in a synchronous fashion, use the AsSync extensions methods, as follow:

using Numerous.Api.Sync;

[...]

var currentUser = client.GetUser().AsSync();

[...]

Features

User Handling

userId parameter is always optional on methods involving users : if omitted (or set to 0), operation apply to the current user.

Paging

Methods that support paging returns a ResultPage<T> object having the following behavior :

Results of the current view may be accessed using Values property
If more results are available, HasMoreResults property is true
Next page of results may be obtained by invoking .Next() method

.Take() extensions methods are available on ResultPage<T>, which allow easy retrieval of all or a number of items.

 [...]
 
 var metrics = await client.GetUserMetrics().TakeAll();

 var metricId = metrics.First().Id;
 var events = await client.GetEvents(metricId).Take(10000);
 
 [...]

Quota Handling

Numerous API calls are limited to a quota of 300 calls/minute.

When quota is exceeded, Numerous.NET waits for the required amount of time before further attempt.

Quota handling is transparent for the NumerousClient caller. Attempts count may be configured using the NumerousSettings.QuotaExceededRetry property (default is Retry.Infinite).

API Error Handling

Under certain conditions, NumerousClient transparently make further attempts to the Numerous API.

This occur when HTTP status code returned by API is one of the following:

408 : Request Timeout
500 : Internal Server Error
502 : Bad Gateway
503 : Service Unavailable
504 : Gateway Timeout

Also, non-HTTP network errors (reported as HttpRequestException) are also handled.

API Error handling is transparent for the NumerousClient caller. Attempt count may be configured using the NumerousSettings.HttpErrorRetry and NumerousSettings.NetworkErrorRetry properties (default is 1 for both), interval between successive attempts may be configured using the NumerousSettings.ErrorRetryDelay property (default is 30 seconds).

Supported API

NumerousClient supports the following operations :

Users

GetUser : Retrieve information about a user
UpdateUser : Update profile of a user

Profile Photos

GetUserImage : Retrieve the photo of a user
UpdateUserImage : Update profile photo of a user
DeleteUserImage : Clear profile photo of a user

Metrics

GetMetric : Retrieve information about a metric
**GetUserMetrics **: Retrieve information about metrics owned by a user
GetPopularMetrics : Retrieve information about popular public metrics
AddMetric : Create a new metric
UpdateMetric : Update a metric configuration
DeleteMetric : Delete a metric

Metric Images

GetMetricImage : Retrieve the image of a metric
UpdateMetricImage : Update metric image
DeleteMetricImage : Clear metric image

Channel Metric

GetChannelMetrics : Retrieve the metrics associated with a channel and, optionnaly, a source class
GetChannelMetric : Retrieve the metric associated with a channel, a source class and a source key
AddChannelMetric : Create a new metric associated with the channel. If metric is already existing, existing metric is returned Channe metrics may be deleted using the DeleteMetric method.

Subscriptions

GetSubscription : Retrieve information about a subscription
GetUserSubscriptions : Retrieve subscriptions made by a user
GetMetricSubscriptions : Retrieve subscriptions made to a metric
AddSubscription : Add a subscription for a user to a metric
UpdateSubscription : Update the subscription made by a user to a metric
DeleteSubscription : Remove the subscription made by a user to a metric

Events

GetEvent : Get event details
GetEvents : Retrieve events for a metric
GetNearestEvent : Retrieve the nearest event to a date
AddEvent : Add a new event
DeleteEvent : Delete an event

ebezine / numerousapp-net