/******************************************************************************

****************************** CODE DOCUMENTATION *****************************

===============================================================================

GENERAL INFORMATION

​

Project Name: DCUWeather

Module Name : WeatherConsoleClient.cs

Dependencies: 

Author      : Ed Colosimo

Date        : 11/06/2017

​

Description :   The DCUWeather project is a .Net console application that allows will report on the average daiy

                temperature over a five day period for specified cities. The cities to report on are found 

​

in the

                App.config file. Cities can be added/removed from this file as needed. The weather data is 

​

retrieved

                in JSON format from the openweathermap site using its API:

                    url: http://api.openweathermap.org/data/2.5/forecast?

​

APPID=0e9a405a63512aa14a836dad6b59ce8c&units=imperial&q=<city name>

                    params:

                        - APPID: provided by the openweathermap site in order to gain access to 

​

its API

                        - units=imperial: tells the API to return the data in fahrenheit

                        - q: the city, state to request the weather for

===============================================================================

DESCRIPTION OF MAJOR STEPS (Also identify each major step in code below)

​

    This module in the entry point into the Weather app. It generates the objects

    necessary to create the average daily weather forecast report

​

===============================================================================

CHANGES

Date        Person      Change

_______________________________________________________________________________

11/06/2017  Ed Colosimo Initial Version

*/

​

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using System.Net.Http;

using Newtonsoft.Json;

using Newtonsoft.Json.Linq;

​

namespace WeatherConsoleApp

{

​

    /******************************************************************/

    public abstract class AForecast

    {

        public abstract void RunForecast();

    }

​

    /******************************************************************/

​

    public abstract class AWeatherFactory

    {

        public abstract AForecast CreateForecast(string ForecastType);

    }

    /******************************************************************/

​

    public class WeatherData

    {

        // city that forecast is for

        public string City { get; set; }

​

        // array of days that will contain forecast

        public string[] ForecastDate { get; set; }

​

        // array of daily forecast data

        public double[] DailyForecast { get; set; }

​

        /// <summary>

        /// constructor

        /// </summary>

        public WeatherData()

        {

            this.City = "";

            this.DailyForecast = null;

            this.ForecastDate = null;

        }

    }

    /******************************************************************/

    public class SummaryWeatherData

    {

        public string City { get; set; }

        public string ForecastDate { get; set; }

        public double AvgDailyTemperature { get; set; }

        public bool ChanceOfPrecipitation { get; set; }

​

        /// <summary>

        /// constructor

        /// </summary>

        public SummaryWeatherData()

        {

            this.City = "";

            this.ForecastDate = "";

            this.AvgDailyTemperature = 0.0;

            this.ChanceOfPrecipitation = false;

        }

    }

​

    /******************************************************************/

    public class WeeklyForecast : AForecast

    {

        private string[] _citiesArr;

        private string _apiUrl;

​

        /// <summary>

        /// default constructor

        /// </summary>

        public WeeklyForecast()

        {

            this._citiesArr = null;

            this._apiUrl = null;

        }

​

        /// <summary>

        /// constructor w/params

        /// </summary>

        /// <param name="Cities"></param>

        /// <param name="ApiUrl"></param>

        public WeeklyForecast(string[] Cities, string ApiUrl)

        {

            this._citiesArr = Cities;

            this._apiUrl = ApiUrl;

        }

​

        /// <summary>

        /// set configuration params

        /// </summary>

        private void SetConfig()

        {

//          this._citiesArr = { "Marlboro, MA", "San Diego, CA", "Cheyenne, WY", "Anchorage, AK", "Austin, TX", "Orlando, FL", "Seattle, WA", "Cleveland, OH", "Portland, ME", "Honolulu, HI" };

//          string[] _cities = { "Marlboro, MA", "San Diego, CA", "Cheyenne, WY", "Anchorage, AK", "Austin, TX", "Orlando, FL", "Seattle, WA", "Cleveland, OH", "Portland, ME", "Honolulu, HI" };

        }

​

        /// <summary>

        /// 

        /// </summary>

        /// <param name="ListWeatherData"></param>

        private void WriteWeatherData(List<SummaryWeatherData> ListSummaryWeatherData)

        {

            string curCity = "";

​

            foreach (SummaryWeatherData wd in ListSummaryWeatherData)

            {

                if (wd.City != curCity)

                {

                    // write the headings

                    Console.WriteLine();

                    Console.WriteLine("City: " + wd.City);

                    Console.WriteLine();

                    Console.WriteLine("Date\t" + "Avg Daily Temp (F)");

                    Console.WriteLine("-----------------------------------------");

                }

                curCity = wd.City;

                Console.Write(wd.ForecastDate);

                if (wd.ChanceOfPrecipitation)

                {

                    Console.Write("*");

                }

                double avgDailyTemperature = Math.Round(wd.AvgDailyTemperature, 2, MidpointRounding.AwayFromZero);

                Console.WriteLine("\t" + avgDailyTemperature);

            }

        }

​

        /// <summary>

        /// RunForecast

        /// calls the API service to get the weather forecast for the specified cities and prints daily average forecast

        /// for each city.

        /// </summary>

        public override void RunForecast()

        {

//          this.SetConfig();

            Console.WriteLine("in RunForecast");

//          string[] _cities = { "Marlboro, MA", "San Diego, CA", "Cheyenne, WY", "Anchorage, AK", "Austin, TX", "Orlando, FL", "Seattle, WA", "Cleveland, OH", "Portland, ME", "Honolulu, HI" };

            string[] _cities = { "Marlboro, MA", "San Diego, CA", "Cheyenne, WY", "Anchorage, AK", "Austin, TX", "Orlando, FL" };

            this._citiesArr = _cities;

            Console.WriteLine("this._citiesArr = " + this._citiesArr[0]);

            this._apiUrl = "http://api.openweathermap.org/data/2.5/forecast?APPID=0e9a405a63512aa14a836dad6b59ce8c&units=imperial&q=";

​

            if (this._citiesArr == null)

            {

                Console.WriteLine("Error: No cities specified in the config");

                return;

            }

            if (this._apiUrl == null)

            {

                Console.WriteLine("Error: The openWeather APi is not specified in the config");

                return;

            }

            Console.WriteLine("this._apiUrl = " + this._apiUrl);

​

            // each day in the data returned from the API has multiple temperatures (3 hour intervals)

            // listSummaryCityWeatherData will contain the summary for each day in the forecast

            List<SummaryWeatherData> listSummaryCityWeatherData = new List<SummaryWeatherData>();

            StringBuilder url = null;

            WeatherData objWeatherData = null;

            JObject obj = null;

            dynamic jsonRoot = null;

            int numListItems = 0;

            double totalTemp = 0.0;

            int numDays = 0;

            int numItems = 0;

            bool chanceOfPrecip = false;

​

            string curDate = "";

            DateTime dt;

            string curDate2 = "";

            double fahrenheitTemperature;

​

//          foreach (string city in this._citiesArr)

            for (int i=0; i<this._citiesArr.Length; i++)

            {

                string city = this._citiesArr[i];

                // create object to contain the weather data detail

                objWeatherData = new WeatherData();

​

                objWeatherData.City = city;

​

                url = new StringBuilder(this._apiUrl + city);

                Console.WriteLine("url = " + url);

​

                // call the API

                HttpClient weeklyClient = new HttpClient();

​

                // set the timeout to two minutes

                weeklyClient.Timeout = TimeSpan.FromMinutes(2);

​

                // call the API

                var response = weeklyClient.GetAsync(url.ToString()).GetAwaiter().GetResult();

                var result = response.Content.ReadAsStringAsync().GetAwaiter().GetResult();

​

                obj = JObject.Parse(result);

​

                // get the json representation of the data

                jsonRoot = JsonConvert.DeserializeObject(result);

​

                // the json root contains a child "list" node that contains all of the daily forecasts

​

                // number of days forcasted

                numListItems = jsonRoot.list.Count;

​

                totalTemp = 0.0;

                numDays = 0;

​

                objWeatherData.ForecastDate = new string[numListItems];

                objWeatherData.DailyForecast = new double[numListItems];

                numItems = 0;

​

                chanceOfPrecip = false;

​

                // the json data contains a parent level "list" node that contains all of the daily forecasts

                foreach (var data in jsonRoot.list)

                {

                    // roll up the aggregate daily weather into a summary object that will later be used to write

                    // the data to the console

                    SummaryWeatherData objSummaryCityWeatherData = new SummaryWeatherData();

                    objSummaryCityWeatherData.City = city;

​

                    curDate = (string)data.dt_txt;

                    dt = DateTime.Parse(curDate);

                    curDate2 = dt.ToString("yyyyMMdd");

                    //              objWeatherData.ForecastDate.Add("curDate2");

                    objWeatherData.ForecastDate[numItems] = curDate2;

​

                    if (!chanceOfPrecip)

                    {

                        if (data.rain != null || data.snow != null)

                        {

                            chanceOfPrecip = true;

                        }

                    }

//                  var chanceOfPrecip = data.rain;

​

                    // the json "main" node is a child of the "list" node. It contains the temperature

                    foreach (var listItem in data.main)

                    {

                        if (listItem.Name == "temp")

                        {

                            // no need to do a conversion as we are requesting the API to return the temperature in

                            // fahrenheit. But I will leave the commented out call for reference

                            fahrenheitTemperature = (double)listItem.Value;

                            objWeatherData.DailyForecast[numItems] = fahrenheitTemperature;

                            if (numItems == 0)

                            {

                                ++numDays;

                                totalTemp += objWeatherData.DailyForecast[numItems];

                            }

                            else if (numItems > 0 && objWeatherData.ForecastDate[numItems] == objWeatherData.ForecastDate[numItems - 1])

                            {

                                ++numDays;

                                totalTemp += objWeatherData.DailyForecast[numItems];

                            }

                            else if (numItems > 0 && objWeatherData.ForecastDate[numItems] != objWeatherData.ForecastDate[numItems - 1])

                            {

                                // this is a new day, store the previous day's summarized data

                                objSummaryCityWeatherData.AvgDailyTemperature = totalTemp / numDays;

                                objSummaryCityWeatherData.ForecastDate = objWeatherData.ForecastDate[numItems - 1];

                                if (chanceOfPrecip)

                                {

                                    objSummaryCityWeatherData.ChanceOfPrecipitation = true;

                                }

                                listSummaryCityWeatherData.Add(objSummaryCityWeatherData);

                                objSummaryCityWeatherData = null;

​

                                totalTemp = objWeatherData.DailyForecast[numItems];

                                numDays = 1;

                                chanceOfPrecip = false;

                            }

                            break;

                        }

                    }

                    ++numItems;

                }

​

                weeklyClient.Dispose();

            } // foreach cities

​

            // write the weather data

            this.WriteWeatherData(listSummaryCityWeatherData);

​

        }

    }

    /******************************************************************/

​

    public class WeatherFactory : AWeatherFactory

    {

        public override AForecast CreateForecast(string ForecastType)

        {

            switch (ForecastType.ToLower())

            {

                case "weeklyforecast":

                    WeeklyForecast objWeeklyForecast = new WeeklyForecast();

                    return (objWeeklyForecast);

                /* placeholder for future expansion of forecast types

                case "monthlyforecast":

                    MonthlyForecast obMonthlyForecast = new MonthlyForecast();

                    return (objMonthlyForecast);

                    break;

                */

                default:

                    // default to weekly

                    WeeklyForecast objDefaultForecast = new WeeklyForecast();

                    return (objDefaultForecast);

            }

        }

    }

​

    /******************************************************************/

    public class WeatherConsoleClient

    {

        public static void Main(string[] args)

        {

            try

            {

                Console.WriteLine("calling WeatherFactory");

                // the WeatherFactory will create the necessary (AForecast derived) objects (weekly, monthly, etc) to

                // run the forecast

                WeatherFactory objWeatherFactory = new WeatherFactory();

                // run the weekly/five day forecast

                AForecast objForecast = objWeatherFactory.CreateForecast("weeklyforecast");

                objForecast.RunForecast();

                Console.WriteLine("after RunForecast");

​

                // for future expansion, run other forecasts here as they become available from the openweathermap API

                // placeholder

//              AForecast objMonthlyForecast = objWeatherFactory.CreateForecast("monthlyforecast");

//              objForecast.RunForecast();

​

                Console.WriteLine("Successfuly converted temperatures.");

            }

            catch (Exception e)

            {

                Console.WriteLine("Exception thrown: " + e.Message);

            }

        }

    }

}

​