WeatherVine Weather Microservice

About this Project

Weather Vine is an educational app for consumers to connect more deeply with the wine they enjoy. Explore wines from a region and see how the climate has influenced the very wine one drinks!

Table of Contents

• Getting Started
• Running the tests
• Service Oriented Architecture
• Other Repos
• Built With
• Contributing
• Versioning
• Authors
• Acknowledgments

Getting Started

To get the web application running, please fork and clone down the repo.

git clone <your@github.account:WeatherVine/front_end.git>

Prerequisites

To run this application you will need Ruby 2.5.3 and Rails 5.2.5

Installing

• Install the gem packages
  • bundle install
• Generate your local application.yml file to store the api key and confirm it was added to your .gitignore
  • bundle exec figaro install

Running the tests

RSpec testing suite is utilized for testing this application.

• Run the RSpec suite to ensure everything is passing as expected
  bundle exec rspec

Service Oriented Architecture

• The purpose of this microservice is to facilitate the communication between our Weather Vine back-end application and the Weather API that we are consuming by filtering the response as needed.

Other Repos

• Weather Vine Front-End Application
  • Repo | Heroku
• Weather Vine Back-End Application
  • Repo | Heroku
• Weather Vine Wine Microservice
  • Repo | Heroku

Endpoints

Climate Data

• Required query params:
  • vintage
  • region

GET https://weather-service-sinatra.herokuapp.com/api/v1/climate_data?vintage={year}&region={region}

{data: {
    "id": nil,
    "type": "climate",
    "attributes": {
      "temp": #{temp(integer)},
      "precip": #{precip(float)},
      "vintage": #{vintage(integer)},
      "region": #{region(string)},
      "start_date": #{date(string)},
      "end_date": #{date(string)}
    }
  }
}

Formats

• date strings are formatted as YYYY-MM-DD

Built With

• Sinatra
• Ruby
• RSpec
• Rbenv

Contributing

Please follow the steps below and know that all contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/<New-Cool-Feature-Name>)
3. Commit your Changes (git commit -m 'Add <New-Cool-Feature-Name>')
4. Push to the Branch (git push origin feature/<New-Cool-Feature-Name>)
5. Open a Pull Request

Versioning

• Sinatra 2.1.0
• Ruby 2.5.3
• RSpec 3.10.0
• Rbev 1.1.2

Authors

• Adam Bowers | GitHub | LinkedIn
• Alex Schwartz | GitHub | LinkedIn
• Diana Buffone | GitHub | LinkedIn
• Katy La Tour | GitHub | LinkedIn
• Tommy Nieuwenhuis | GitHub | LinkedIn
• Trevor Suter | GitHub | LinkedIn
• Wil McCauley | GitHub | LinkedIn