No release in over a year
TheMealDB API Wrapper for rails projects
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

 Project Readme

The MealDB API

This gem is for educational use only. I have created this to have a practice on how to create an API wrapper for Rails and create it in a ruby gem.

You may check The MealDB website here. The API and their site will always remain free at point of access. If you love their service and want extra features you can sign up as a Patreon supporter for $2.

Installation

Add this line to your application's Gemfile:

gem 'themealdb_rubygem'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install themealdb_rubygem

Usage

Configure

Instance of the client must be done first before being able to use the API. Since The MealDB have endpoints for free users and paid users, you can just create an instance without passing any api_key.

free

client = ThemealdbRubygem::Client.new

with api key (paid)

client = ThemealdbRubygem::Client.new(api_key: YOUR_API_KEY)

Search meal by name

client.search_by_name("Arrabiata")

Search by first letter

client.search_by_first_letter("a")

Search by ID

client.search_by_id("52772")

Random Meal

client.random_meal

List all categories with full description

client.list_categories_full

List all categories

client.list_categories

List all area

client.list_areas

List all ingredients

client.list_ingredients

Filter by main ingredient

Note that for paid users (those with api keys), ingredient variable can hold multiple strings (ingredient = "chicken_breast,garlic,salt").

client.filter_by_main_ingredient("chicken breast")

Filter by category

client.filter_by_category("Seafood")

Filter by area

client.filter_by_area("Canadian")

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/michael-dollosa/themealdb_rubygem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the TheMealDB API project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.