/** * WEB222 - Assignment 02 * * I declare that this assignment is my own work in accordance with * Seneca Academic Policy. No part of this assignment has been * copied manually or electronically from any other source * (including web sites) or distributed to other students. * * Please update the following with your information: * * Name: * Student ID: * Date: * * Please see all unit tests in the files problem-01.test.js, problem-02.test.js, etc. */

/******************************************************************************* * Problem 0: learn how to work with the cases data. * * Welcome to Assignment 2! In this assignment, you're going to be practicing * different ways of working with JavaScript Objects, both built-in Objects * like Array and String, and also working with custom Objects you create. * * Before you dive into all the problems below, let's spend a minute helping you * learn how to work with the sample user data included in this assignment. * * We've included an extra file in this assignment: `data.js`. This is data * that was obtained from the iNaturalist API. iNaturalist is available at * https://www.inaturalist.org/ and lets people around the world share and track * sightings and helps identify plants, animals, insects, and other organisms. * It's a phenomenal tool for scientists and curious naturalists alike. * * The iNaturalist data is typical of a lot of data we use on the web: it's formatted * as an Object, with key/value pairs to express the data. We use strings, numbers, * boolean, as well as Arrays and even Objects. Learning how to traverse and * manipulate this data is important. * * Take a look at src/data.js now to get a sense of what the data looks like. This * data includes 10 observations for an area of 1km around the Seneca Newnham campus. */

/******************************************************************************* * Problem 00: Learning to write our tests * * Each of the functions below will be passed a `data` argument, which is * an Object returned by calling the iNaturalist API. It looks something like * this: * * { * total_results: 125, * page: 1, * per_page: 10, * results: [ * ...observation results here... * ] * } * * The data includes `total_results` (how many results there are), which page this is * if you divide `total_results` into pages of `per_page` items, and finally the Array * of `results`. * * To get you started, write a function that accepts a full `data` Object and returns * only the `total_results` Number. * * You can try running this test using the following command: * * npm test problem-00 * * See if you can get this test to pass by fixing the bug in the code below. ******************************************************************************/ function getTotalResults(data) { data = data.total_results; // TODO: fix this code so it gets and returns the `total_results` property from observation data return data; }

/******************************************************************************* * Problem 01 Part 1: use a for-loop to iterate over Arrays * * Write a function named `observationSummary(data)` that loops over every * observation Object in the results array, and calls `console.log()`, passing * it a formatted String that looks like this: * * "#67868131 - Muskrat [2021-01-10]" * * The formatted String above is made up of the following observation properties: * * - id * - species_guess * - observed_on_details and date * * In your solution, make use of a regular for-loop to iterate over results in data * * Your function shouldn't return anything, just call console.log() ******************************************************************************/ function observationSummary(data) { // Store results array from data in a variable const results = data.results;

// for-loop to iterate over array results for (let i = 0; i < results.length; i++) { // Build string const formattedString = '#' + results[i].id + ' - ' + results[i].species_guess + ' [' + results[i].observed_on_details.date + ']'; // Print formatted string to console console.log(formattedString); } }

/******************************************************************************* * Problem 01 Part 2: use forEach() to iterate over Arrays * * Rewrite your code from `observationSummary(data)` above to use a forEach() * function instead of a for-loop. Everything else should be qidentical. * * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach ******************************************************************************/

function observationSummary2(data) { // Store results array from data in a variable const results = data.results;

// forEach to iterate over array results results.forEach((observation) => { // Build string const formattedString = '#' + observation.id + ' - ' + observation.species_guess + ' [' + observation.observed_on_details.date + ']'; // Print formatted string to console console.log(formattedString); }); }

/******************************************************************************* * Problem 02: observationsByPrivacy(data, privacy) * * iNaturalist users can hide or alter the geolocation coordinate data for an * observation they make. For example, I might see a butterfly in my backyard, * but don't want to share the location of my home. * * Write a function that takes Observation data, as well as a `privacy` value. * The `privacy` value describes whether the geolocation data is "open", * "obscured", or null (i.e., unspecified). * * If the privacy value isn't one of "open", "obscured", or null * throw an error. Make sure you deal with UPPER- and lower-case versions of the * strings when checking. * * Return a new Array with only those observation Objects that contain a privacy * value that matches the privacy argument to your function. For example: * * observationsByPrivacy(data, "open") would return an Array of observation * objects that have `privacy: "open"`. * * observationsByPrivacy(data, null) would return an Array of observation * objects that have `privacy: null`. * * observationsByPrivacy(data, "OPEN") would return an Array of observation * objects that have `privacy: "open"` (i.e., UPPERCASE privacy values * should be converted to lowercase). * * In your solution, make use of the following: * * - make sure that privacy is of the right type and value, or throw an Error * - create an empty array * - use a for...of loop to loop over all Objects in results * - if an observation includes the given privacy value, add the observation * Object to the empty Array. Make sure you deal with both UPPER and lowercase * privacy values: all privacy values on the observations are lowercase. * * Your function should return the newly created Array. ******************************************************************************/ function observationsByPrivacy(data, privacy) { // Store results array from data in a local variable let resultsArray = data.results;

// Convert to lowercase only if a valid string is passed if (typeof privacy === 'string') privacy = privacy.toLowerCase();

// - Create a new empty array let targetObjects = new Array();

// - for...of loop to iterate through objects for (object of resultsArray) { // if argument geoPrivacy matches with observation geoPrivacy if (object.privacy === privacy) // Add this observation to our new array targetObjects.push(object); }

// Return array that was populated with target objects return targetObjects; }

/******************************************************************************* * Problem 3 Part I: transformObservation(original) and transformObservations(cases) * * Write functions to transform results into a new Object format. * * The `transformObservation(original)` function takes an observation Object that * looks like the results values in src/data.js, and transforms the data into a new * Object that looks like this (see comments on right-hand side with details): * * { * id: 67868131, // copy the id over without modification * speciesGuess: 'Muskrat', // species_guess renamed * isResearchQuality: true, // true if quality_grade is 'research', false otherwise * geoCoords: [-79.3565522733, 43.798774894], // location converted to Array of Numbers, longitude first * photoUrls: [ // modify photos to be Array of URLs * 'https://static.inaturalist.org/photos/109762131/square.jpg?1610308133' * ], * photosCount: 1, // the number of photo URLs included in photos * user: '@dridgen' // the user's login_exact name with @ prefix added * } ******************************************************************************/

function transformObservation(original) { // Preprocess some values to store in new object

// Empty array for photos let photoURLArray = new Array(); // Populate new array of photos with urls original.photos.forEach(function (object) { try { const url = new URL(object.url); photoURLArray.push(object.url); } catch (e) {} });

// Coordinates string to array(string) of two values let coordsArray = original.location.split(',');

// Boolean value for researchQuality let researchQuality = false; if (original.quality_grade == = 'research') { researchQuality = true; }

// Create new object const newObject = { id: original.id, speciesGuess: original.species_guess, isResearchQuality: researchQuality, // Longitude first - get values stored in coordsArray string array coords: [parseFloat(coordsArray[1]), parseFloat(coordsArray[0])], // Assign photoURLArray that is populated photos: photoURLArray, user: '@' + original.user.login_exact };

return newObject; }

/******************************************************************************* * Problem 3 Part II: transformObservations(data) with iteration * * The `transformObservations(data)` function takes observation data and uses it * to create and return a new Array of transformed observation Objects, * calling the transformObservation() function you wrote above on each one. * * In your solution, make use of the following: * * - create a new empty Array to hold all the transformed cases * - use a for-loop or .forEach() method to loop over all Objects in the data results Array * - pass each observation Object to your transformObservation() function to get a new Object * - add the new, transformed Object to your array * - return the new Array containing all the transformed Objects ******************************************************************************/ function transformObservations(data) { // New array to store returned cases let transformedCases = new Array(); // Store results array from data in a variable let results = data.results;

// .forEach loop to populate new array with returned cases results.forEach(function (object) { const newCase = transformObservation(object); transformedCases.push(newCase); });

return transformedCases; }

/******************************************************************************* * Problem 3 Part III: transformObservations2(data) with .map() * * Rewrite your transformObservations() function from above a second time using * the Array .map() method see: * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map * * In your solution, make use of the following: * * - use the .map() method of the data results Array to create a new Array * - In the .map() method's function, call your transformObservation() function * - return the Array created by the .map() method ******************************************************************************/

function transformObservations2(data) { // Store results array from data in a variable let results = data.results;

// .map() to create new array of returned cases let transformedCases = results.map((object) => transformObservation(object)); return transformedCases; } /******************************************************************************* * Problem 04: getObservationsById() * * Write function to get the observation Object(s) for a given ID, or list of IDs. * * Calling getObsesrvationsById() with a single `id` value should return the * observation Object that has that ID. For example: * * getObservationById(data, 161020) would return the single Object in the results * Array with an id property matching 161020. * * Similarly, if a single unknown id value is passed, return null: * * getObservationById(data, -12341234) would return null. * * Finally, getObservationById(data, 161020, 161021) would return an Array of 2 * observation Objects, whose id properties matches the id values specified. If * any of the ids in the list are unknown, skip this id and don't add anything to * the returned Array. * * For example, the following would return an Array of 2 observation Objects, * ignoring the unknown third id: * * getObservationById(data, 161020, 161021, -12341234) * * In your solution, make use of the following: * * - use the .forEach() method to iterate over all ids passed to your function * - use the .find() method to locate items by id, see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find ******************************************************************************/ function getObservationsById(data, ...ids) { // TODO }

/******************************************************************************* * Problem 05: getObservationsByPositionalAccuracy() * * Write a function that filters observations according to their positional * accuracy. iNaturalist allows users to give an accuracy level in meters for * the location. * * Your function should accept iNaturalist data, and an options Object, which * may contain various filtering options. The return value is an Array of * observations, whose positional_accuracy value matches the options provided. * For example: * * getObservationsByPositionalAccuracy(data, { eq: 135 }) means only return * observations whose positional_accuracy is equal to 135 exactly. * * getObservationsByPositionalAccuracy(data, { gte: 35 }) means only return * observations whose positional_accuracy is greater than or equal to 35. * * getObservationsByPositionalAccuracy(data, { lte: 1035 }) means only return * observations whose positional_accuracy is less than or equal to 1035. * * getObservationsByPositionalAccuracy(data, { gte: 35, lte: 1035 }) means only * return observations whose positional_accuracy is greater than or equal to 35 * AND less than or equal to 1035. * * If no options object is given, or none of the expect values are present (i.e. * eq, gte, lte), then return all values. If all of eq, gte, and lte * are given, prefer eq (i.e., ignore lte and gte). * * Use the Array .filter() function in your solution. ******************************************************************************/

function getObservationsByPositionalAccuracy(data, options = {}) { // TODO }

/******************************************************************************* * Problem 06: getTaxonPhotos() * * Write a function to get all sizes of the default photo for each of the identified * species in the iNaturalist results data. * * When an observation has been properly identified, it will have a `taxon` * property and value. When it does, one of the properties within `taxon` is * the `default_photo` property, which will look like this: * * default_photo: { * square_url: 'https://static.inaturalist.org/photos/575727/square.jpg?1384377507', * attribution: '(c) hobiecat, some rights reserved (CC BY-NC)', * flags: [], * medium_url: 'https://static.inaturalist.org/photos/575727/medium.jpg?1384377507', * id: 575727, * license_code: 'cc-by-nc', * original_dimensions: { width: 1035, height: 1035 }, * url: 'https://static.inaturalist.org/photos/575727/square.jpg?1384377507' * }, * * Each image on iNatrualist is stored in various sizes: small, medium, large, * original, and square (75 x 75 pixels). This is helpful when showing the image * at different sizes, to save on bandwidth when downloading. * * Convert each observation with a `taxon` identification to an Object that looks * like this, using the default_photo and url properties, and include the observation's * id as a query param (i.e., ?1384377507): * * { * original: 'https://static.inaturalist.org/photos/575727/original.jpg?1384377507', * square: 'https://static.inaturalist.org/photos/575727/square.jpg?1384377507', * small: 'https://static.inaturalist.org/photos/575727/small.jpg?1384377507', * medium: 'https://static.inaturalist.org/photos/575727/medium.jpg?1384377507', * large: 'https://static.inaturalist.org/photos/575727/large.jpg?1384377507', * } * * The URLs all follow the same pattern: * * https://static.inaturalist.org/photos/[photo ID]/[size].jpg?[observation id] * * Your function should return the new Array of photo size Objects ******************************************************************************/ function getTaxonPhotos(data) { // TODO }

/******************************************************************************* * Problem 07: getUserStats() * * Write function to get user statistics for iNaturalist users in the data results * Array. Each user has count information, for example: * * { * user: { * id: 216168, * login: 'psweet', * spam: false, * suspended: false, * created_at: '2016-04-13T21:54:34+00:00', * login_autocomplete: 'psweet', * login_exact: 'psweet', * name: '', * name_autocomplete: '', * orcid: null, * icon: 'https://static.inaturalist.org/attachments/users/icons/216168/thumb.jpg?1478731222', * observations_count: 19096, * identifications_count: 173355, * journal_posts_count: 8, * activity_count: 192459, * species_count: 4960, * universal_search_rank: 19096, * roles: ['curator'], * site_id: 1, * icon_url: 'https://static.inaturalist.org/attachments/users/icons/216168/medium.jpg?1478731222' * } * } * * In the above example, the user has the following counts that we are * interested in collecting: * * observations_count: 19096, // number of observations * journal_posts_count: 8, // number of journal posts * species_count: 4960, // number of species * * Your function should loop through all observation Objects and get the `user` * property. Using the `user`, get the observations_count, identifications_count, * and species_count, and use them to create totals and a final average. Your * function should return an Object with these stats, which looks like this: * * { * count: 10, // the total number of users in this sample * totals: { * observations: 1234, // the total observations for all users in this sample * journals: 8, // the total journal posts for all users in this sample * species: 1234 // the total species for all users in this sample * }, * averages: { * observations: 12, // the average observations for all users in this sample * journals: 2, // the average journal posts for all users in this sample * species: 12 // the average species for all users in this sample * } * } ******************************************************************************/ function getUserStats(data) { // TODO }

/** * Problem 08: Part 1 - extractTimeZones() * * Write a function to extract all time zones from the iNaturalist observation results. * The time zones are available in each result's `created_time_zone` and * `observed_time_zone` properties. * * Your function should loop through all of the results in `data` and get the * time zone values, placing them in an Array. * * You should not put any duplicate values in your new Array. * * When you have processed all results, and collected all unique time zone values, * return the Array of time zones. */ function extractTimeZones(data) { // TODO }

/** * Problem 08: Part 2 - extractTimeZones2() * * Rewrite your `extractTimeZones` function from above, but do not use an Array * to hold the time zones. Instead, use a Set, see: * * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set * * Your function should store all unique time zones in a Set, and when you are done * processing all results, convert your Set to an Array and return it. See: * * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from */

function extractTimeZones2(data) { // TODO }

// Our unit test files need to access the functions we defined // above, so we export them here. exports.getTotalResults = getTotalResults; exports.observationSummary = observationSummary; exports.observationSummary2 = observationSummary2; exports.observationsByPrivacy = observationsByPrivacy; exports.transformObservation = transformObservation; exports.transformObservations = transformObservations; exports.transformObservations2 = transformObservations2; exports.getObservationsById = getObservationsById; exports.getObservationsByPositionalAccuracy = getObservationsByPositionalAccuracy; exports.getTaxonPhotos = getTaxonPhotos; exports.getUserStats = getUserStats; exports.extractTimeZones = extractTimeZones; exports.extractTimeZones2 = extractTimeZones2;