Merge pull request #2 from techthoughts2/dev

added API key parameters

Author: techthoughts2

.github/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.0]
+
+- Changed API key(s) from being locally sourced environment variables to parameters
+  - Added ```GoogleAPIKey``` parameter to all Google Maps functions
+  - Added ```BingMapsAPIKey``` parameter to all Bing Maps functions
+
 ## [0.6.0]
 
 - Initial release.

README.md

@@ -54,16 +54,6 @@ Both of these Map API keys are *easy to create* and have *no cost* pricing tiers
 * [How to get a Google Maps API Key](docs/GoogleMapsAPI.md#how-to-get-a-google-maps-api-key)
 * [How to get a Bing Maps API Key](docs/BingMapsAPI.md#how-to-get-a-bing-maps-api-key)
 
-```powershell
-# Set your API Keys in the pwshPlaces.psm1 file
-# using the appropriate variable names:
-
-$env:GoogleAPIKey = 'yourGoogleAPIKey'
-$env:BingAPIKey = 'yourBingAPIKey'
-```
-
-If you don't want to adjust the ```.psm1``` then simply ensure that these environment variables are populated in your current session.
-
 ### Install pwshPlaces
 
 ```powershell
@@ -76,50 +66,50 @@ Install-Module -Name pwshPlaces -Repository PSGallery -Scope CurrentUser
 ```powershell
 ######################################################################################
 # Google Maps
-$env:GoogleAPIKey = 'yourGoogleAPIKey'
+$googleAPIKey = 'yourGoogleAPIKey'
 ######################################################################################
 # I want to find a specific place
-Find-GMapPlace -Query "Krause's cafe"
-Find-GMapPlace -Query '+18306252807'
-Find-GMapPlace -Query 'cafe' -PointLatitude '29.7049806' -PointLongitude '-98.068343'
+Find-GMapPlace -Query "Krause's cafe" -GoogleAPIKey $googleAPIKey
+Find-GMapPlace -Query '+18306252807' -GoogleAPIKey $googleAPIKey
+Find-GMapPlace -Query 'cafe' -PointLatitude '29.7049806' -PointLongitude '-98.068343' -GoogleAPIKey $googleAPIKey
 #-------------------------------------------------------------------------------------
 # I want to search for a type of place
-Search-GMapText -Query "Cupcakes" -Type bakery -AllSearchResults
-Search-GMapText -Query "italian restaurants in New York" -MinPrice 4
+Search-GMapText -Query "Cupcakes" -Type bakery -AllSearchResults -GoogleAPIKey $googleAPIKey
+Search-GMapText -Query "italian restaurants in New York" -MinPrice 4 -GoogleAPIKey $googleAPIKey
 #-------------------------------------------------------------------------------------
 # I want to search for nearby places
-Search-GMapNearbyPlace -Latitude '29.7049806' -Longitude '-98.068343' -Radius 5000
-Search-GMapNearbyPlace -Latitude '29.7049806' -Longitude '-98.068343' -Radius 10000 -RankByProminence -Keyword 'butcher' -Type store
+Search-GMapNearbyPlace -Latitude '29.7049806' -Longitude '-98.068343' -Radius 5000 -GoogleAPIKey $googleAPIKey
+Search-GMapNearbyPlace -Latitude '29.7049806' -Longitude '-98.068343' -Radius 10000 -RankByProminence -Keyword 'butcher' -Type store -GoogleAPIKey $googleAPIKey
 #-------------------------------------------------------------------------------------
 # I want to get very detailed information about a place - place ID retrieved from other commands
-Get-GMapPlaceDetail -PlaceID 'ChIJf9Yxhme9XIYRkXo-Bl62Q10' -Contact -Atmosphere
+Get-GMapPlaceDetail -PlaceID 'ChIJf9Yxhme9XIYRkXo-Bl62Q10' -Contact -Atmosphere -GoogleAPIKey $googleAPIKey
 #-------------------------------------------------------------------------------------
 # I want to GeoCode an address
-Invoke-GMapGeoCode -Address '148 S Castell Ave, New Braunfels, TX 78130, United States'
+Invoke-GMapGeoCode -Address '148 S Castell Ave, New Braunfels, TX 78130, United States' -GoogleAPIKey $googleAPIKey
 #-------------------------------------------------------------------------------------
 # I want to reverse GeoCode a location
-Invoke-GMapGeoCode -Latitude '29.7012853' -Longitude '-98.1250235'
+Invoke-GMapGeoCode -Latitude '29.7012853' -Longitude '-98.1250235' -GoogleAPIKey $googleAPIKey
 ######################################################################################
 # Bing Maps
-$env:BingAPIKey = 'yourBingAPIKey'
+$bingAPIKey = 'yourBingAPIKey'
 ######################################################################################
 # I want to find a specific place
-Find-BingPlace -Query "Krause's cafe"
-Find-BingPlace -Query 'cafe' -PointLatitude '29.7049806' -PointLongitude '-98.068343'
+Find-BingPlace -Query "Krause's cafe" -BingMapsAPIKey $bingAPIKey
+Find-BingPlace -Query 'cafe' -PointLatitude '29.7049806' -PointLongitude '-98.068343' -BingMapsAPIKey $bingAPIKey
 #-------------------------------------------------------------------------------------
 # I want to search for nearby places
-Search-BingNearbyPlace -Type Attractions
-Search-BingNearbyPlace -Type CafeRestaurants -PointLatitude '29.7049806' -PointLongitude '-98.068343'
+Search-BingNearbyPlace -Type Attractions -BingMapsAPIKey $bingAPIKey
+Search-BingNearbyPlace -Type CafeRestaurants -PointLatitude '29.7049806' -PointLongitude '-98.068343' -BingMapsAPIKey $bingAPIKey
 #-------------------------------------------------------------------------------------
 # I want to GeoCode an address
-Invoke-BingGeoCode -AddressLine '148 S Castell Ave' -City 'New Braunfels' -State TX -PostalCode 78130
+Invoke-BingGeoCode -AddressLine '148 S Castell Ave' -City 'New Braunfels' -State TX -PostalCode 78130 -BingMapsAPIKey $bingAPIKey
 #-------------------------------------------------------------------------------------
 # I want to reverse GeoCode a location
-Invoke-BingGeoCode -Latitude '29.7030' -Longitude '-98.1245'
+Invoke-BingGeoCode -Latitude '29.7030' -Longitude '-98.1245' -BingMapsAPIKey $bingAPIKey
 #-------------------------------------------------------------------------------------
 # I want to determine the Time Zone of a specific place
-Find-BingTimeZone -Query 'New Braunfels, TX'
-Find-BingTimeZone -PointLatitude 29.70 -PointLongitude -98.11
+Find-BingTimeZone -Query 'New Braunfels, TX' -BingMapsAPIKey $bingAPIKey
+Find-BingTimeZone -PointLatitude 29.70 -PointLongitude -98.11 -BingMapsAPIKey $bingAPIKey
 #-------------------------------------------------------------------------------------
 ```
 

docs/Find-BingPlace.md

@@ -15,27 +15,27 @@ Returns a list of business entities centered around a location or a geographic r
 ### textquery (Default)
 ```
 Find-BingPlace -Query <String> [-RegionBias <ccTLD>] [-Language <languages>] [-MaxResults <Int32>]
- [<CommonParameters>]
+ -BingMapsAPIKey <String> [<CommonParameters>]
 ```
 
 ### Rectangle
 ```
 Find-BingPlace [-Query <String>] -SouthLatitude <String> -WestLongitude <String> -NorthLatitude <String>
  -EastLongitude <String> [-RegionBias <ccTLD>] [-Language <languages>] [-MaxResults <Int32>]
- [<CommonParameters>]
+ -BingMapsAPIKey <String> [<CommonParameters>]
 ```
 
 ### Circle
 ```
 Find-BingPlace [-Query <String>] [-CircleLatitude <String>] [-CircleLongitude <String>]
  [-CircleRadius <String>] [-RegionBias <ccTLD>] [-Language <languages>] [-MaxResults <Int32>]
- [<CommonParameters>]
+ -BingMapsAPIKey <String> [<CommonParameters>]
 ```
 
 ### Point
 ```
 Find-BingPlace [-Query <String>] [-PointLatitude <String>] [-PointLongitude <String>] [-RegionBias <ccTLD>]
- [-Language <languages>] [-MaxResults <Int32>] [<CommonParameters>]
+ [-Language <languages>] [-MaxResults <Int32>] -BingMapsAPIKey <String> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -48,42 +48,42 @@ Location bias and language can be controlled via parameters.
 
 ### EXAMPLE 1
 ```
-Find-BingPlace -Query "Krause's cafe"
+Find-BingPlace -Query "Krause's cafe" -BingMapsAPIKey $bingAPIKey
 ```
 
 Returns place information for the query location biased by IP.
 
 ### EXAMPLE 2
 ```
-Find-BingPlace -Query "Krause's cafe" -Language es
+Find-BingPlace -Query "Krause's cafe" -Language es -BingMapsAPIKey $bingAPIKey
 ```
 
 Returns place information for the query location biased by IP and returns a few portions of the results in Spanish.
 
 ### EXAMPLE 3
 ```
-Find-BingPlace -Query 'cafe' -PointLatitude '29.7049806' -PointLongitude '-98.068343'
+Find-BingPlace -Query 'cafe' -PointLatitude '29.7049806' -PointLongitude '-98.068343' -BingMapsAPIKey $bingAPIKey
 ```
 
 Returns place information for the query location biased by provided lat/long point.
 
 ### EXAMPLE 4
 ```
-Find-BingPlace -Query 'cafe' -CircleLatitude '29.7049806' -CircleLongitude '-98.068343' -CircleRadius '5000'
+Find-BingPlace -Query 'cafe' -CircleLatitude '29.7049806' -CircleLongitude '-98.068343' -CircleRadius '5000' -BingMapsAPIKey $bingAPIKey
 ```
 
 Returns place information for the query location biased by circle lat/long/radius.
 
 ### EXAMPLE 5
 ```
-Find-BingPlace -Query 'cafe' -SouthLatitude '39.8592387' -WestLongitude '-75.295486' -NorthLatitude '40.0381942' -EastLongitude '-75.0064087'
+Find-BingPlace -Query 'cafe' -SouthLatitude '39.8592387' -WestLongitude '-75.295486' -NorthLatitude '40.0381942' -EastLongitude '-75.0064087' -BingMapsAPIKey $bingAPIKey
 ```
 
 Returns place information for the query location biased by rectangular two lat/lng pairs in decimal degrees, representing the south/west and north/east points of a rectangle.
 
 ### EXAMPLE 6
 ```
-Find-BingPlace -Query 'cafe' -PointLatitude '29.7049806' -PointLongitude '-98.068343' -Language en -MaxResults 20
+Find-BingPlace -Query 'cafe' -PointLatitude '29.7049806' -PointLongitude '-98.068343' -Language en -MaxResults 20 -BingMapsAPIKey $bingAPIKey
 ```
 
 Returns place information for the query location biased by provided lat/long point with a maximum of 20 results in English.
@@ -96,6 +96,7 @@ $findBingPlaceSplat = @{
     PointLongitude = '-98.068343'
     Language       = 'en'
     MaxResults     = 20
+    BingMapsAPIKey = $bingAPIKey
 }
 Find-BingPlace @findBingPlaceSplat
 ```
@@ -313,6 +314,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -BingMapsAPIKey
+Bing Maps API Key
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### CommonParameters
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
 For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
@@ -328,6 +344,9 @@ Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/
 Example:
     https://dev.virtualearth.net/REST/v1/LocalSearch/?query={query}&userLocation={point}&key={BingMapsAPIKey}
 
+How to get a Bing Maps API Key:
+    https://github.com/techthoughts2/pwshPlaces/blob/main/docs/BingMapsAPI.md#how-to-get-a-bing-maps-api-key
+
 ## RELATED LINKS
 
 [https://github.com/techthoughts2/pwshPlaces/blob/master/docs/Find-BingPlace.md](https://github.com/techthoughts2/pwshPlaces/blob/master/docs/Find-BingPlace.md)

docs/Find-BingTimeZone.md

@@ -14,13 +14,14 @@ Retrieve time zone information for any point on Earth
 
 ### textquery
 ```
-Find-BingTimeZone -Query <String> [-RegionBias <ccTLD>] [-Language <languages>] [<CommonParameters>]
+Find-BingTimeZone -Query <String> [-RegionBias <ccTLD>] [-Language <languages>] -BingMapsAPIKey <String>
+ [<CommonParameters>]
 ```
 
 ### Point
 ```
 Find-BingTimeZone -PointLatitude <String> -PointLongitude <String> [-RegionBias <ccTLD>]
- [-Language <languages>] [<CommonParameters>]
+ [-Language <languages>] -BingMapsAPIKey <String> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -30,14 +31,14 @@ Given a pair of coordinates or a place name query the Time Zone API will return
 
 ### EXAMPLE 1
 ```
-Find-BingTimeZone -Query 'New Braunfels, TX'
+Find-BingTimeZone -Query 'New Braunfels, TX' -BingMapsAPIKey $bingAPIKey
 ```
 
 Returns Time Zone information for matches found for the provided query.
 
 ### EXAMPLE 2
 ```
-Find-BingTimeZone -PointLatitude 29.70 -PointLongitude -98.11
+Find-BingTimeZone -PointLatitude 29.70 -PointLongitude -98.11 -BingMapsAPIKey $bingAPIKey
 ```
 
 Returns Time Zone information for the provided coordinates.
@@ -121,6 +122,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -BingMapsAPIKey
+Bing Maps API Key
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### CommonParameters
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
 For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
@@ -136,6 +152,9 @@ Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/
 Example:
     https://dev.virtualearth.net/REST/v1/TimeZone/{point}?datetime={datetime_utc}&key={BingMapsAPIKey}
 
+How to get a Bing Maps API Key:
+    https://github.com/techthoughts2/pwshPlaces/blob/main/docs/BingMapsAPI.md#how-to-get-a-bing-maps-api-key
+
 ## RELATED LINKS
 
 [https://github.com/techthoughts2/pwshPlaces/blob/master/docs/Find-BingTimeZone.md](https://github.com/techthoughts2/pwshPlaces/blob/master/docs/Find-BingTimeZone.md)