Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dsantosmerino/filmaffinity-gem
Easy access to Filmaffinity data
https://github.com/dsantosmerino/filmaffinity-gem
filmaffinity movie
Last synced: about 2 months ago
JSON representation
Easy access to Filmaffinity data
- Host: GitHub
- URL: https://github.com/dsantosmerino/filmaffinity-gem
- Owner: dsantosmerino
- Created: 2016-04-06T14:14:40.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-04-12T06:21:22.000Z (over 1 year ago)
- Last Synced: 2024-07-17T19:36:29.799Z (2 months ago)
- Topics: filmaffinity, movie
- Language: Ruby
- Homepage: https://rubygems.org/gems/filmaffinity
- Size: 600 KB
- Stars: 10
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FilmAffinity Gem
[](https://github.com/dsantosmerino/filmaffinity-gem/actions)
[](http://badge.fury.io/rb/filmaffinity)
## Description
The filmaffinity gem allows you to easily access publicly available data from **Filmaffinity.com in english and spanish**.
It is also available as **RESTful API** at [heroku](https://filmaffinity-unofficial.herokuapp.com/).
## Features
- Search movies by title
- Retrieve complete movie info
- Retrieve the Top N of filmaffinity.com
- Retrieve the Top N with the given options
## Installation
Add this line to your application's Gemfile:
gem 'filmaffinity'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install filmaffinity
## Documentation
##### FilmAffinity configuration
FilmAffinity offers some configuration options, which you can configure globally before your requests. You could include an ```imgur_id``` to upload the posters on Imgur and avoid forbidden hotlinking from filmaffinity. You can also change the ```language```,which is english by default.
```
FilmAffinity.configure do |config|
config.imgur_id = 'Your-imgur-client-id'
config.language = 'ES'
end
```
##### FilmAffinity::Search
Returns an array of FilmAffinity::Movie, containing preload ID and title.
##### FilmAffinity::Movie
Includes some methods to retrieve the complete movie info.
##### FilmAffinity::Top options
The options hash accepts several parameters:
```
{
:genre => 'AC',
:country => 'DE',
:from_year => 2014,
:to_year => 2016,
:no_doc => true,
:no_tv => true
}
```
##### :genre
- 'AC' Action
- 'AV' Adventure
- 'AN' Animation
- 'CO' Comedy
- 'DO' Documentary
- 'DR' Drama
- 'FAN' Fantasy
- 'F-N' Film-Noir
- 'TE' Horror
- 'INF' Kids
- 'MU' Musical
- 'INT' Mystery
- 'RO' Romance
- 'C-F' Sci-Fi
- 'TH' Thriller
- 'TV_SE' TV Series
- 'DESC' Unknown
- 'BE' War
- 'WE' Western
##### :country
2-letter code supplied by the ISO
##### :no_doc
```true``` to avoid documentaries
##### :no_tv
```true``` to avoid TV series
## Examples
### Top:
#Top FilmAffinity ever
top = FilmAffinity::Top.new
top.movies
#=> [
...]
top.movies.first
#=> #
#Top FilmAffinity with options and number of results
options = {
:genre => 'AN',
:no_tv => true
}
top = FilmAffinity::Top.new options, 20
top.movies
#=> [
...]
top.movies.first
#=> #
### Search:
search = FilmAffinity::Search.new('Padrino')
search.movies
#=> [
...]
search.movies.first
#=> #
### Movie:
movie = FilmAffinity::Movie.new(809297, 'El Padrino')
movie.director
#=> 'Francis Ford Coppola'
movie.year
#=> 1972
movie.rating
#=> 9.1
movie.cast
#=> ['Marlon Brando',
'Al Pacino',
'James Caan',
'Robert Duvall',
'Diane Keaton',
...]
## Contributors
This gem is created and maintained by [Oriol Bellido](https://github.com/oricodes89) and [David Santos](https://github.com/davidsantosmerino)