Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hgducharme/myfitnesspal_stats
Get access to your daily MyFitnessPal data!
https://github.com/hgducharme/myfitnesspal_stats
Last synced: 3 months ago
JSON representation
Get access to your daily MyFitnessPal data!
- Host: GitHub
- URL: https://github.com/hgducharme/myfitnesspal_stats
- Owner: hgducharme
- License: mit
- Created: 2015-01-14T18:13:26.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-08-02T00:10:01.000Z (over 5 years ago)
- Last Synced: 2024-05-12T10:42:24.779Z (6 months ago)
- Language: Ruby
- Homepage:
- Size: 193 KB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# MyfitnesspalStats
Myfitnesspal_Stats is a ruby module that allows you to programmatically access your daily nutritional information from [Myfitnesspal.com](http://www.myfitnesspal.com/). It gives you the ability to access your nutritional totals for a specified date, as well as the break down of each meal & food logged for that day.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'myfitnesspal_stats'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install myfitnesspal_stats
## Usage
**Getting Started:** Once installation of this gem is complete, initialize a new web scraper:
```ruby
include 'myfitnesspal_stats'
# Insert your username and password for Myfitnesspal
# WARNING: DO NOT HARDCODE THIS INTO YOUR SCRIPT IF IT IS A PUBLIC SCRIPT. FUTURE REVISIONS WILL MAKE SURE TO SOLVE THIS PROBLEM.
scraper = Scraper.new('username', 'password')
```
**Accessing nutritional information:** To access nutritional information for a specified date, create a new `Day` instance and then call the `.nutrition_totals` on that day:
```ruby
# The year, month, and day should all be numbers. Although a string will still work
scraper.get_date(year, month, day)
# Numbers do not have to be padded with zeros, it can be 01 or just 1.
day = scraper.get_date(2015, 01, 15)
# ==> #
# Note: The nutrients that are returned depend on which nutrients you specified to track in your Myfitnesspal settings.
# The returned hash is formatted like so:
# : => [how much you ate, your goal, the difference between the two].
pp day.nutrition_totals
# ==>
{:Date=>"Thursday, 15 January 2015",
:Calories=>["2,399", "2,390", "-9"],
:Fat=>["49", "50", "1"],
:Carbs=>["296", "290", "-6"],
:Fiber=>["45", "35", "-10"],
:Protein=>["197", "195", "-2"],
:"Potass."=>["2,476", "4,000", "1,524"]}
```
**How to retrive data from the hash:** This is simple ruby practice, but in order to save any frustration I will outline the process here:
```ruby
day = scraper.get_date(2015, 01, 15)
nutrition_data = day.nutrition_totals
pp nutrition_data[:Date]
pp nutrition_data[:Calories]
pp nutrition_data[:Calories][0]
pp nutrition_data[:Fiber][1]
pp nutrition_data[:Carbs][1, 2]
#### OUTPUT:
# ==> "Thursday, 15 January 2015"
# ==> ["2,399", "2,390", "-9"]
# ==> "2,399"
# ==> "35"
# ==> ["290", "-6"]
```
## Contributing
1. Fork it ( https://github.com/hgducharme/myfitnesspal_stats/fork )
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
[](https://bitdeli.com/free "Bitdeli Badge")