Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 1.66 KB

README.md

File metadata and controls

59 lines (45 loc) · 1.66 KB
Raw

yalemenus Gem Version

Yale Menus API Wrappers // Python // Ruby

Ruby library for interfacing with the Yale Menus API.

Installation

Add yalemenus to your Gemfile.

gem 'yalemenus'

and then run

bundle install

in the same directory as the Gemfile.

Or install directly from RubyGems:

gem install yalemenus

Setup

To use these functions, you must require the `` gem:

require 'yalemenus'

You will then be able to reference the YaleMenus class within your code, and use its various methods to retrieve data.

Retrieval Functions

Some requests support year and other optional parameters, which are recommended to use to narrow down your results.

  • YaleMenus.status()
  • YaleMenus.halls()
  • YaleMenus.hall(hall_id)
  • YaleMenus.hall_people(hall_id)
  • YaleMenus.hall_meals(hall_id, [date], [start_date], [end_date])
  • YaleMenus.meal(meal_id)
  • YaleMenus.meal_items(meal_id)
  • YaleMenus.item(item_id)
  • YaleMenus.item_nutrition(item_id)
  • YaleMenus.item_reviews(item_id)
  • YaleMenus.item_photos(item_id)
  • YaleMenus.butteries
  • YaleMenus.buttery(buttery_id)
  • YaleMenus.buttery_items(buttery_id)

See example.rb for several usage examples.

Documentation for the Yale Menus API can be found here.

Author

Created and maintained by Erik Boesen.

License

This software is protected under the MIT License.