Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mmacia/tmdb.cr
Crystal wrapper for The Movie DB (TMDb)
https://github.com/mmacia/tmdb.cr
api-client crystal movie-database-api tmdb
Last synced: 15 days ago
JSON representation
Crystal wrapper for The Movie DB (TMDb)
- Host: GitHub
- URL: https://github.com/mmacia/tmdb.cr
- Owner: mmacia
- License: mit
- Created: 2021-05-16T22:22:49.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-19T07:32:18.000Z (about 1 year ago)
- Last Synced: 2024-08-04T01:08:59.131Z (3 months ago)
- Topics: api-client, crystal, movie-database-api, tmdb
- Language: Crystal
- Homepage:
- Size: 4.1 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - tmdb.cr - The Movie DB (TMDb) api wrapper (Third-party APIs)
README
# The Movie Database API
A Crystal wrapper for the [The Movie Database API](https://developers.themoviedb.org/).
[](https://github.com/mmacia/tmdb.cr/actions/workflows/build.yml)
## Installation
Add this lines to your `shards.yml` file:
```yaml
dependencies:
tmdb:
github: mmacia/tmdb.cr
branch: master
```
Then run `shards install` from your project.
## Usage
### Initial configuration
You have to provide your API key like this:
```crystal
Tmdb.configure do |conf|
conf.api_key = "secret"
conf.default_language = "en"
end
```
You can also set the API key in environment variable `TMDB_API_KEY`. The value
of this variable has higher precedence.
```
$ export TMDB_API_KEY='secret'
```
The default language is english, but you can temporarily override the global
language for a single request by specifying it as an additional parameter:
```crystal
# example
Tmdb::Search.movies("terminator", language: "es")
```
You can save a few API calls activating the cache:
```crystal
Tmdb.configure do |conf|
conf.cache = Tmdb::FileCache.new("/tmp/tmdb", 10_000)
end
```
If you active cache, all methods will be using it. Sometimes you want to get
fresh data for some particular requests: you can pass the `skip_cache: true` to
disable cache.
```crystal
movies = Tmdb::Movie.popular skip_cache: true
```
Paginated resources are managed by `LazyIterator(T)` class. This acts as a
infinite iterator, you just have to call `#each`, `#select`, `#map` or whatever
enumerable method to acces to the whole collection without worrying about
pagination.
```crystal
# example
movies = Tmdb::Search.movies("terminator")
pp movies.total_items
movies.each do |m|
pp m.original_title
end
```
### Get a movie by ID
Get the movie information for specific movie ID.
```crystal
Tmdb::Movie.detail 24
Tmdb::Movie.detail 24, language: "es"
```
### Search movies
Search movies by title.
```crystal
Tmdb::Search.movies "terminator"
```
Search movies by title and release year.
```crystal
Tmdb::Search.movies "terminator", year: 1984
```
### Alternative titles
Get the alternative titles for a specific movie.
```crystal
movie = Tmdb::Movie.detail 24
movie.alternative_titles country: "es"
```
### Cast
Get the cast for a specific movie ID.
```crystal
movie = Tmdb::Movie.detail 24
movie.cast language: "it"
```
### Crew
Get the crew for a specific movie ID.
```crystal
movie = Tmdb::Movie.detail 24
movie.cast language: "de"
```
### Movie images
Get the images (posters and backdrops) for a specific movie ID.
```crystal
movie = Tmdb::Movie.detail 24
movie.images
```
### Movie keywords
Get the plot keywords for a specific movie ID.
```crystal
movie = Tmdb::Movie.detail 24
movie.keywords
```
### Movie trailers
Get the release trailers for a specific movie ID.
```crystal
movie = Tmdb::Movie.detail 24
movie.videos
```
### Movie releases
Get the release dates by country for a specific movie ID.
```crystal
movie = Tmdb::Movie.detail 24
movie.release_dates
```
### Upcoming movies
Get the list of upcoming movies. This list refreshes every day.
```crystal
Tmdb::Movie.upcoming
```
You can get the upcoming movie for a region.
```crystal
Tmdb::Movie.upcoming region: "pt"
```
### Find a person by ID
Get the basic person information for a specific person ID.
```crystal
Tmdb::Person.detail 138
```
### Search people
Seach for people by name.
```crystal
Tmdb::Search.people "Paul"
```
### Popular people
Gets a list of popular people. This list refreshes every day.
```crystal
Tmdb::People.popular
```
## Endpoints
All endpoints available are those listed in The Movie Database API
documentation.
Missing endpoints:
* Account
* Authentication
* Guest Sessions
* Lists
* Multi search
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Moisès Macià](https://github.com/your-github-user) - creator and maintainer