GBMetadataFetcher

GBMetadataFetcher library provides an API to retrieve TV Series metadata from Internet sources.

Requirements

GBMetadataFetcher works on iOS 7 SDK or later and is compatible with ARC projects.

Adding GBMetadataFetcher to your project

Source files

Drag the *.h and *.m files from this repository into your project.
#import "GBMetadataFetcher.h"

Static library

You can add GBInfiniteLoopScrollView as a static library to your project or workspace.

Download the latest code version or add the repository as a git submodule to your git-tracked project.
Open your project in Xcode, then drag and drop GBMetadataFetcher.xcodeproj onto your project or workspace (use the "Product Navigator view").
Select your target and go to the Build phases tab. In the Link Binary With Libraries section select the add button. On the sheet find and add libGBMetadataFetcher.a. You might also need to add GBMetadataFetcher to the Target Dependencies list.
Include GBInfiniteLoopScrollView wherever you need it with #import <GBMetadataFetcher/GBMetadataFetcher.h>.

Usage

To use it, you simply need to get an instance of GBMetadataFetcher. For this purpose, there are avaliable this two factory methods:

// Returns a new object instance of the default GBMetadataFetcherType that conforms to the protocol GBMetadataFetching.
+ (id <GBMetadataFetching>)metadataFetcher;

// Returns a new object instance of the indicated GBMetadataFetcherType that conforms to the protocol GBMetadataFetching.
+ (id <GBMetadataFetching>)metadataFetcherWithType:(GBMetadataFetcherType) type;

You can get a new brand instance this way:

id <GBMetadataFetching> metadataFetcher = [GBMetadataFetcher metadataFetcherWithType:TVDB];

To start using a TVDB type instance, you'll first need an API key from the TVDB website. An API key can be retrieved by registering for one on the TVDB website. Once you have an API key, you'll need to initialize the GBMetadataFetcher by setting it as the following:

if ([metadataFetcher respondsToSelector:@selector(setApiKey:)]) {
    [metadataFetcher setApiKey:@"TVDBApiKey"];
}

Now you can find the id and other information of a series based on its name whit this method:

- (NSArray *)findShowByName:(NSString *)showName inLanguage:(NSString *)language;

It will return an array of NSDictionary objects containing the following possible keys:

imdbId
language
premiereDate
showId
summary
title
tvdbId
year

Below is an example of getting such information.

NSArray *shows = [metadataFetcher findShowByName:@"Medium" inLanguage:@"en"];

To retrieve the detailed information of the series, the showId from the previous API call is needed:

- (NSDictionary *)findShowById:(NSString *)showId inLanguage:(NSString *)language;

This method returns an array of NSDictionary objects containing the following possible keys:

airDay
airTime
contentRating
coverURL
episodes
genre
imdbId
language
network
premiereDate
rating
runtime
title
tvdbId
showId
status
summary
year

The value of 'episodes' key is also an array of NSDictionary objects containing the following possible keys:

bannerURL
episodeNumber
episodeId
imdbId
language
premiereDate
rating
seasonNumber
summary
title
tvdbId

[...]

##License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

gblancogarcia / GBMetadataFetcher