google_maps_service_ruby 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25cb368b535afc02deeda844ba39c3129173217bc66ecaaa0f62d06fa20c1914
-  data.tar.gz: b31f5a94a276b608df9f3e24eaecccd0cf21436f3f4a8361d42058a588531318
+  metadata.gz: 71fd1ea5543cf0c41c68763e4ffaa218573e4965105a7973613bffcb94b9dcd2
+  data.tar.gz: a2eb9d2b1bb9368d0914798f49b8b5d27645ad0a056e7e62fd10fc6abcca83d3
 SHA512:
-  metadata.gz: 175a5f27bf2c23e6d9958eda7b686a3be90a53d29e90fbf1d6fe54bc790c6266f8caa6a0c7b7319a6ea32f442b8b4a21ac66b785ec71b8f8ab32753c3db62eec
-  data.tar.gz: dee6fc2abdd6ffa26bed8c4ef20374962b0a539f12faa4b00b33cc3843055f3cabf50ced8f13472201e936a11e9cf0f7980eedc402d78152c3cc01f6cb298eb1
+  metadata.gz: 77a992d6ca82095447e3fb75bcb8e194ae627cc97b0c20c8e2cb6f0cfa575a08bf63a078242e6f91ef1396592f93cfa89a8c4086220d8016826a8634383c2284
+  data.tar.gz: 28ad069318403640c4f7a15fd7e752dc7c6102bee54fe2432370059d620555ab78358961fb0e3dade88195391f79e28bc4e1953b4e4e0f0b1c9aa9fec4204020

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 0.6.3 - 2023-06-04
+
+* Add Places API place, places, places_nearby and places_photo support
+
 ## 0.6.2 - 2023-03-18
 
 * Add support for ruby 3.2

data/README.md

@@ -16,6 +16,7 @@ The Ruby gem for Google Maps Web Service APIs is a gem for the following Google
  - [Google Maps Distance Matrix API][Distance Matrix API]
  - [Google Maps Elevation API][Elevation API]
  - [Google Maps Geocoding API][Geocoding API]
+ - [Google Maps Places API][Places API]
  - [Google Maps Time Zone API][Time Zone API]
  - [Google Maps Roads API][Roads API]
 
@@ -45,6 +46,20 @@ Note: Currently, [Roads API] does not accept client ID. It requires API key to a
 
 This gem return a Ruby Hash/Array object as the API result. The result format structure is same as in Google Maps API documentation.
 
+## Contributing
+
+If you find a bug please [log an issue][issues].
+
+The goal of this gem is to follow the API and implementation of the [python client](https://github.com/googlemaps/google-maps-services-python) as much as possible. If you would like to add support for an API please consider porting the python implementation.
+
+To create a new pull request:
+
+1. Fork it (https://github.com/langsharpe/google-maps-services-ruby/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.
+
 ## Requirements
 
  - Ruby 2.7 or later.
@@ -141,7 +156,7 @@ end
 gmaps = GoogleMapsService::Client.new
 ```
 
-For more examples and detail (setup **proxy**, **timeout**, **caching**, etc.) while initializing the client, check out [Client documentation](http://www.rubydoc.info/gems/google_maps_service/GoogleMapsService/Apis/Client#initialize-instance_method).
+For more examples and detail (setup **proxy**, **timeout**, **caching**, etc.) while initializing the client, check out [Client documentation](https://www.rubydoc.info/gems/google_maps_service_ruby/GoogleMapsService/Apis/Client#initialize-instance_method).
 
 ### Latitude/longitude pairs format
 
@@ -237,7 +252,7 @@ Sample result:
 }]
 ```
 
-For more usage examples and result format, check out [gem documentation](http://www.rubydoc.info/gems/google_maps_service/GoogleMapsService/Apis/Directions), [test script](https://github.com/langsharpe/google-maps-services-ruby/tree/master/spec/google_maps_service/apis/directions_spec.rb), and [Google Maps Directions API documentation][Directions API].
+For more usage examples and result format, check out [gem documentation](https://www.rubydoc.info/gems/google_maps_service_ruby/GoogleMapsService/Apis/Directions), [test script](https://github.com/langsharpe/google-maps-services-ruby/tree/master/spec/google_maps_service/apis/directions_spec.rb), and [Google Maps Directions API documentation][Directions API].
 
 ### Distance Matrix API
 
@@ -252,7 +267,7 @@ matrix = gmaps.distance_matrix(origins, destinations,
     units: 'imperial')
 ```
 
-For more usage examples and result format, check out [gem documentation](http://www.rubydoc.info/gems/google_maps_service/GoogleMapsService/Apis/DistanceMatrix), [test script](https://github.com/langsharpe/google-maps-services-ruby/tree/master/spec/google_maps_service/apis/distance_matrix_spec.rb), and [Google Maps Distance Matrix API documentation][Distance Matrix API].
+For more usage examples and result format, check out [gem documentation](https://www.rubydoc.info/gems/google_maps_service_ruby/GoogleMapsService/Apis/DistanceMatrix), [test script](https://github.com/langsharpe/google-maps-services-ruby/tree/master/spec/google_maps_service/apis/distance_matrix_spec.rb), and [Google Maps Distance Matrix API documentation][Distance Matrix API].
 
 ### Elevation API
 
@@ -266,7 +281,7 @@ locations = [[40.714728, -73.998672], [-34.397, 150.644]]
 results = gmaps.elevation_along_path(locations, 5)
 ```
 
-For more usage examples and result format, check out [gem documentation](http://www.rubydoc.info/gems/google_maps_service/GoogleMapsService/Apis/Elevation), [test script](https://github.com/langsharpe/google-maps-services-ruby/tree/master/spec/google_maps_service/apis/elevation_spec.rb), and [Google Maps Elevation API documentation][Elevation API].
+For more usage examples and result format, check out [gem documentation](https://www.rubydoc.info/gems/google_maps_service_ruby/GoogleMapsService/Apis/Elevation), [test script](https://github.com/langsharpe/google-maps-services-ruby/tree/master/spec/google_maps_service/apis/elevation_spec.rb), and [Google Maps Elevation API documentation][Elevation API].
 
 ### Geocoding API
 
@@ -278,7 +293,27 @@ results = gmaps.geocode('1600 Amphitheatre Parkway, Mountain View, CA')
 results = gmaps.reverse_geocode([40.714224, -73.961452])
 ```
 
-For more usage examples and result format, check out [gem documentation](http://www.rubydoc.info/gems/google_maps_service/GoogleMapsService/Apis/Geocoding), [test script](https://github.com/langsharpe/google-maps-services-ruby/tree/master/spec/google_maps_service/apis/geocoding_spec.rb), and [Google Maps Geocoding API documentation][Geocoding API].
+For more usage examples and result format, check out [gem documentation](https://www.rubydoc.info/gems/google_maps_service_ruby/GoogleMapsService/Apis/Geocoding), [test script](https://github.com/langsharpe/google-maps-services-ruby/tree/master/spec/google_maps_service/apis/geocoding_spec.rb), and [Google Maps Geocoding API documentation][Geocoding API].
+
+### Places API
+
+```ruby
+# Search for places
+results = gmaps.places(
+  'Pizza Restaurant',
+  location: {:lat=>37.4221114, :lng=>-122.0867443},
+)
+
+# Search for places nearby
+results = gmaps.places_nearby(
+  location: {:lat=>37.4221114, :lng=>-122.0867443},
+  radius: 5000,
+)
+
+# Get the url for a photo returned by the places api
+url = gmaps.places_photo(photo_reference, max_width: 400, max_height: 400)
+```
+For more usage examples and result format, check out [gem documentation](https://www.rubydoc.info/gems/google_maps_service_ruby/GoogleMapsService/Apis/Places), [test script](https://github.com/langsharpe/google-maps-services-ruby/tree/master/spec/google_maps_service/apis/places_spec.rb), and [Google Maps Places API documentation][Places API].
 
 ### Roads API
 
@@ -309,7 +344,7 @@ place_ids = [
 results = gmaps.speed_limits(place_ids)
 ```
 
-For more usage examples and result format, check out [gem documentation](http://www.rubydoc.info/gems/google_maps_service/GoogleMapsService/Apis/Roads), [test script](https://github.com/langsharpe/google-maps-services-ruby/tree/master/spec/google_maps_service/apis/roads_spec.rb), and [Google Maps Roads API documentation][Roads API].
+For more usage examples and result format, check out [gem documentation](https://www.rubydoc.info/gems/google_maps_service_ruby/GoogleMapsService/Apis/Roads), [test script](https://github.com/langsharpe/google-maps-services-ruby/tree/master/spec/google_maps_service/apis/roads_spec.rb), and [Google Maps Roads API documentation][Roads API].
 
 ### Time Zone API
 
@@ -321,7 +356,7 @@ timezone = gmaps.timezone([39.603481, -119.682251])
 timezone = gmaps.timezone([39.603481, -119.682251], timestamp: Time.at(1608))
 ```
 
-For more usage examples and result format, check out [gem documentation](http://www.rubydoc.info/gems/google_maps_service/GoogleMapsService/Apis/TimeZone), [test script](https://github.com/langsharpe/google-maps-services-ruby/tree/master/spec/google_maps_service/apis/time_zone_spec.rb), and [Google Maps Time Zone API documentation][Time Zone API].
+For more usage examples and result format, check out [gem documentation](https://www.rubydoc.info/gems/google_maps_service_ruby/GoogleMapsService/Apis/TimeZone), [test script](https://github.com/langsharpe/google-maps-services-ruby/tree/master/spec/google_maps_service/apis/time_zone_spec.rb), and [Google Maps Time Zone API documentation][Time Zone API].
 
 ### Polyline encoder/decoder
 
@@ -346,19 +381,6 @@ encoded_path = GoogleMapsService::Polyline.encode(path)
 #=> "_p~iF~ps|U_ulLnnqC_mqNvxq`@"
 ```
 
-## Issues and feature suggestions
-
-If you find a bug, or have a feature suggestion, please [log an issue][issues]. If you'd like to
-contribute, please read [How to Contribute](#contributing).
-
-## Contributing
-
-1. Fork it (https://github.com/langsharpe/google-maps-services-ruby/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.
-
 [apikey]: https://developers.google.com/maps/faq#keysystem
 [clientid]: https://developers.google.com/maps/documentation/business/webservices/auth
 
@@ -367,6 +389,7 @@ contribute, please read [How to Contribute](#contributing).
 [Distance Matrix API]: https://developers.google.com/maps/documentation/distancematrix/
 [Elevation API]: https://developers.google.com/maps/documentation/elevation/
 [Geocoding API]: https://developers.google.com/maps/documentation/geocoding/
+[Places API]: https://developers.google.com/maps/documentation/places/
 [Time Zone API]: https://developers.google.com/maps/documentation/timezone/
 [Roads API]: https://developers.google.com/maps/documentation/roads/
 

data/lib/google_maps_service/apis/places.rb

@@ -0,0 +1,153 @@
+require_relative "../validator"
+
+module GoogleMapsService::Apis
+  # Performs requests to the Google Maps Places API.
+  module Places
+    # Places search.
+    #
+    # @param [String] query The text string on which to search, for example: "restaurant".
+    # @param [String, Hash, Array] location The latitude/longitude value for which you wish to obtain the
+    #        closest, human-readable address.
+    # @param [Integer] radius Distance in meters within which to bias results.
+    # @param [String] language The language in which to return results.
+    # @param [Integer] min_price Restricts results to only those places with no less than
+    #        this price level. Valid values are in the range from 0 (most affordable)
+    #        to 4 (most expensive).
+    # @param [Integer] max_price Restricts results to only those places with no greater
+    #        than this price level. Valid values are in the range from 0 (most
+    #        affordable) to 4 (most expensive).
+    # @param [Boolean] open_now Return only those places that are open for business at
+    #         the time the query is sent.
+    # @param [String] type Restricts the results to places matching the specified type.
+    #        The full list of supported types is available here:
+    #        https://developers.google.com/places/supported_types
+    # @param [String] page_token Token from a previous search that when provided will
+    #        returns the next page of results for the same search.
+    # @return [Hash] Hash with the following keys:
+    #         results: list of places
+    #         html_attributions: set of attributions which must be displayed
+    #         next_page_token: token for retrieving the next page of results
+    def places(query, location: nil, radius: nil, language: nil, min_price: nil,
+      max_price: nil, open_now: false, type: nil, page_token: nil)
+
+      _places("text", query: query, location: location, radius: radius,
+        language: language, min_price: min_price, max_price: max_price,
+        open_now: open_now, type: type, page_token: page_token)
+    end
+
+    # Performs nearby search for places.
+    #
+    # @param [String, Hash, Array] location The latitude/longitude value for
+    #        which you wish to obtain the closest, human-readable address.
+    # @param [Integer] radius Distance in meters within which to bias results.
+    # @param [String] keyword A term to be matched against all content that
+    #        Google has indexed for this place.
+    # @param [String] language The language in which to return results.
+    # @param [Integer] min_price Restricts results to only those places with no
+    #        less than this price level. Valid values are in the range from 0
+    #        (most affordable) to 4 (most expensive).
+    # @param [Integer] max_price Restricts results to only those places with no
+    #         greater than this price level. Valid values are in the range
+    #         from 0 (most affordable) to 4 (most expensive).
+    # @param [String, Array] name One or more terms to be matched against the
+    #        names of places.
+    # @param [Boolean] open_now Return only those places that are open for
+    #         business at the time the query is sent.
+    # @param [String] rank_by Specifies the order in which results are listed.
+    #         Possible values are: prominence (default), distance
+    # @param [String] type Restricts the results to places matching the
+    #         specified type. The full list of supported types is available
+    #         here: https://developers.google.com/places/supported_types
+    # @param [String] page_token Token from a previous search that when provided
+    #         will returns the next page of results for the same search.
+    # @return [Hash] Hash with the following keys:
+    #         status: status code
+    #         results: list of places
+    #         html_attributions: set of attributions which must be displayed
+    #         next_page_token: token for retrieving the next page of results
+    def places_nearby(location: nil, radius: nil, keyword: nil, language: nil,
+      min_price: nil, max_price: nil, name: nil, open_now: false,
+      rank_by: nil, type: nil, page_token: nil)
+      if rank_by == "distance"
+        if !(keyword || name || type)
+          raise ArgumentError, "either a keyword, name, or type arg is " \
+            "required when rank_by is set to distance"
+        elsif radius
+          raise ArgumentError, "radius cannot be specified when rank_by " \
+            "is set to distance"
+        end
+      end
+
+      _places("nearby", location: location, radius: radius,
+        keyword: keyword, language: language, min_price: min_price,
+        max_price: max_price, name: name, open_now: open_now,
+        rank_by: rank_by, type: type, page_token: page_token)
+    end
+
+    # Comprehensive details for an individual place.
+    #
+    # @param[String] place_id A textual identifier that uniquely identifies a
+    #       place, returned from a Places search.
+    # @param[String] language The language in which to return results.
+    # @return[Hash] Hash with the following keys:
+    #     result: dict containing place details
+    #     html_attributions: set of attributions which must be displayed
+    def place(place_id, language: nil)
+      params = {placeid: place_id}
+      params[:language] = language if language
+      get("/maps/api/place/details/json", params)
+    end
+
+    # Photo URL from the Places API.
+    #
+    # @param[String] photo_reference A string identifier that uniquely
+    #       identifies a photo, as provided by either a Places search or Places
+    #       detail request.
+    # @param[Integer] max_width Specifies the maximum desired width, in pixels.
+    # @param[Integer] max_height Specifies the maximum desired height, in pixels.
+    # @return[String] String URL of the photo or nil upon error.
+    def places_photo(photo_reference, max_width: nil, max_height: nil)
+      unless max_width || max_height
+        raise ArgumentError, "a max_width or max_height arg is required"
+      end
+
+      params = {photoreference: photo_reference}
+
+      params[:maxwidth] = max_width if max_width
+      params[:maxheight] = max_height if max_height
+
+      image_response_decoder = ->(response) {
+        response["location"]
+      }
+
+      get("/maps/api/place/photo", params,
+        custom_response_decoder: image_response_decoder)
+    end
+
+    private
+
+    # Internal handler for ``places``, ``places_nearby``, and ``places_radar``.
+    # See each method's docs for arg details.
+    def _places(url_part,
+      query: nil, location: nil, radius: nil, keyword: nil, language: nil,
+      min_price: 0, max_price: 4, name: nil, open_now: nil,
+      rank_by: nil, type: nil, page_token: nil)
+
+      params = {}
+      params[:query] = query if query
+      params[:minprice] = min_price if min_price
+      params[:maxprice] = max_price if max_price
+      params[:location] = GoogleMapsService::Convert.latlng(location) if location
+      params[:radius] = radius if radius
+      params[:keyword] = keyword if keyword
+      params[:language] = language if language
+      params[:name] = GoogleMapsService::Convert.join_list(" ", name) if name
+      params[:opennow] = "true" if open_now
+      params[:rankby] = rank_by if rank_by
+      params[:type] = type if type
+      params[:pagetoken] = page_token if page_token
+
+      get("/maps/api/place/%ssearch/json" % url_part, params)
+    end
+  end
+end

data/lib/google_maps_service/client.rb

@@ -8,6 +8,7 @@ require "google_maps_service/apis/directions"
 require "google_maps_service/apis/distance_matrix"
 require "google_maps_service/apis/elevation"
 require "google_maps_service/apis/geocoding"
+require "google_maps_service/apis/places"
 require "google_maps_service/apis/roads"
 require "google_maps_service/apis/time_zone"
 
@@ -25,6 +26,7 @@ module GoogleMapsService
     include GoogleMapsService::Apis::DistanceMatrix
     include GoogleMapsService::Apis::Elevation
     include GoogleMapsService::Apis::Geocoding
+    include GoogleMapsService::Apis::Places
     include GoogleMapsService::Apis::Roads
     include GoogleMapsService::Apis::TimeZone
 

data/lib/google_maps_service/version.rb

@@ -1,6 +1,6 @@
 module GoogleMapsService
   # GoogleMapsService gem version
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 
   # Current operating system
   # @private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_maps_service_ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Lang Sharpe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-18 00:00:00.000000000 Z
+date: 2023-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.28
 description: Google Maps API Client, including the Directions API, Distance Matrix
-  API and Geocoding API. google_maps_service_ruby is a fork of google_maps_service,
+  API, Geocoding API and Places API. google_maps_service_ruby is a fork of google_maps_service,
   which is a fork of google-maps-services-python.
 email:
 - langer8191@gmail.com
@@ -169,6 +169,7 @@ files:
 - lib/google_maps_service/apis/distance_matrix.rb
 - lib/google_maps_service/apis/elevation.rb
 - lib/google_maps_service/apis/geocoding.rb
+- lib/google_maps_service/apis/places.rb
 - lib/google_maps_service/apis/roads.rb
 - lib/google_maps_service/apis/time_zone.rb
 - lib/google_maps_service/client.rb