google_maps_service_ruby 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25cb368b535afc02deeda844ba39c3129173217bc66ecaaa0f62d06fa20c1914
-  data.tar.gz: b31f5a94a276b608df9f3e24eaecccd0cf21436f3f4a8361d42058a588531318
+  metadata.gz: 651ee8dbc068582df401c0504894e364990b1ca0e246f72f421ca0d0a7010829
+  data.tar.gz: a802fec4e670dab3fcb56c5c5988d1255121a909798b204af265bc4bacfdc37e
 SHA512:
-  metadata.gz: 175a5f27bf2c23e6d9958eda7b686a3be90a53d29e90fbf1d6fe54bc790c6266f8caa6a0c7b7319a6ea32f442b8b4a21ac66b785ec71b8f8ab32753c3db62eec
-  data.tar.gz: dee6fc2abdd6ffa26bed8c4ef20374962b0a539f12faa4b00b33cc3843055f3cabf50ced8f13472201e936a11e9cf0f7980eedc402d78152c3cc01f6cb298eb1
+  metadata.gz: f1336fa544bf170a6304cdd9e96006c7bd2a6b810e4ce7000f49bd79f658895c841bf6d1f3ad996a1ac2733c9eb70e4a03a59bb3e6644f278463ec2d5bc8b732
+  data.tar.gz: bba938de0653a91533f991eb74b7b62ec9d957798715b5e65e87cd9a1b838d22396d0226fa3fe390bde49e8b3fe61c511de3a0525036e71b056523cde72e37e0

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## 0.7.0 - 2025-02-23
+
+* Add Support for Routes API including compute_routes and compute_route_matrix
+* Explicitly require base64 gem as required by ruby 3.4
+
+## 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/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Contributing
+We welcome contributions to the google_maps_service_ruby gem!
+
+## Give us a star
+
+You can contribute by starring the project to show your appreciation. This will help more people discover the project.
+
+## Reporting issues
+
+If you find a bug or have a feature request, please [log an issue](https://github.com/langsharpe/google-maps-services-ruby/issues). The more details you can provide, the better.
+
+## Contributing code
+
+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.
+
+If you want to hack a quick fix or extension, please feel free to do so in a fork of the project. Please consider creating a [draft PR](https://github.blog/2019-02-14-introducing-draft-pull-requests/) so we can see what improvements the community is interested in and eventually merge them into the project.
+
+Changes that get merged will:
+* Follow the existing code style (standard.rb needs to pass)
+* Add tests for any new features
+* Update the documentation and readme as needed
+* Add a line to the CHANGELOG.md file
+
+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. Change the base repository of the PR to langsharpe/google-maps-services-ruby.

data/README.md

@@ -16,8 +16,10 @@ 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]
+ - [Google Maps Routes API][Routes API]
 
 Keep in mind that the same [terms and conditions](https://developers.google.com/maps/terms) apply
 to usage of the APIs when they're accessed through this gem.
@@ -45,6 +47,10 @@ 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
+
+See [CONTRIBUTING.md](https://github.com/langsharpe/google-maps-services-ruby/blob/master/CONTRIBUTING.md) for details on contributing to this project.
+
 ## Requirements
 
  - Ruby 2.7 or later.
@@ -141,7 +147,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
 
@@ -160,6 +166,27 @@ latlng = {'lat' => 40.714224, 'lng' => -73.961452}
 latlng = {'latitude' => 40.714224, 'longitude' => -73.961452}
 ```
 
+### Routes API
+
+```ruby
+route = gmaps.compute_routes(
+  {address: 'South Brisbane, QLD, AU'},
+  {address: 'Fitzroy, VIC, AU'}
+)
+
+routes = gmaps.compute_route_matrix(
+  [
+    {waypoint: {'South Brisbane, QLD, AU'}},
+  ],
+  [
+    {waypoint: {address: 'Fitzroy, VIC, AU'}},
+    {waypoint: {address: 'Richmond, VIC, AU'}}
+  ],
+)
+```
+
+For more usage examples and result format, check out [gem documentation](https://www.rubydoc.info/gems/google_maps_service_ruby/GoogleMapsService/Apis/Routes), [test script](https://github.com/langsharpe/google-maps-services-ruby/tree/master/spec/google_maps_service/apis/routes_spec.rb), and [Google Maps Routes API documentation][Routes API].
+
 ### Directions API
 
 ```ruby
@@ -237,7 +264,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 +279,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 +293,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 +305,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 +356,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 +368,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 +393,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,8 +401,10 @@ 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/
+[Routes API]: https://developers.google.com/maps/documentation/routes/
 
 [Google Encoded Polyline]: https://developers.google.com/maps/documentation/utilities/polylinealgorithm
 

data/lib/google_maps_service/apis/directions.rb

@@ -64,7 +64,6 @@ module GoogleMapsService::Apis
       language: nil, units: nil, region: nil, departure_time: nil,
       arrival_time: nil, optimize_waypoints: false, transit_mode: nil,
       transit_routing_preference: nil, response_slice: :routes)
-
       params = {
         origin: GoogleMapsService::Convert.waypoint(origin),
         destination: GoogleMapsService::Convert.waypoint(destination)

data/lib/google_maps_service/apis/places.rb

@@ -0,0 +1,151 @@
+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/apis/routes.rb

@@ -0,0 +1,217 @@
+module GoogleMapsService::Apis
+  # Performs requests to the Google Maps Routes API.
+  module Routes
+    # Base URL of Google Maps Routes API
+    ROUTES_BASE_URL = "https://routes.googleapis.com"
+
+    # Compute a route matrix
+    #
+    # Only origins and destinations are required. The formats for each of the paramters are defined at
+    # https://developers.google.com/maps/documentation/routes/reference/rest/v2/TopLevel/computeRouteMatrix
+    #
+    # @example Simple route matrix
+    # matrix = gmaps.compute_route_matrix(
+    #   [
+    #     {waypoint: {address: 'South Brisbane, QLD, AU'}}
+    #   ],
+    #   [
+    #     {waypoint: {address: 'Fitzroy, VIC, AU'}},
+    #     {waypoint: {address: 'Richmond, VIC, AU'}}
+    #   ],
+    # )
+    #
+    # @example Complex route matrix
+    # matrix = gmaps.compute_route_matrix(
+    #   [{waypoint: {address: 'South Brisbane, QLD, AU'}}],
+    #   [{waypoint: {address: 'Fitzroy, VIC, AU'}},{waypoint: {address: 'Richmond, VIC, AU'}}],
+    #   travel_mode: "TRANSIT",
+    #   departure_time: Time.now,
+    #   language_code: "en",
+    #   region_code: "AU",
+    #   units: "METRIC",
+    #   extra_computations: ["TOLLS"],
+    #   transit_preferences: {
+    #     allowedTravelModes: [ "RAIL" ],
+    #     routingPreference: "FEWER_TRANSFERS"
+    #   }
+    # )
+    #
+    # @param [Array] origins One or more RouteMatrixOrigin
+    # @param [Array] destinations One or more RouteMatrixDestination
+    # @param [String] field_mask The fields that should be returned in the response. The default is "*"
+    # @param [String] travel_mode
+    # @param [String] routing_preference
+    # @param [String, Time] departure_time
+    # @param [String, Time] arrival_time
+    # @param [String] language_code
+    # @param [String] region_code
+    # @param [String] units
+    # @param [Array] extra_computations
+    # @param [String] traffic_model
+    # @param [Hash] transit_preferences
+    #
+    def compute_route_matrix(origins, destinations,
+      field_mask: nil,
+      travel_mode: nil,
+      routing_preference: nil,
+      departure_time: nil,
+      arrival_time: nil,
+      language_code: nil,
+      region_code: nil,
+      units: nil,
+      extra_computations: nil,
+      traffic_model: nil,
+      transit_preferences: nil)
+      params = {
+        origins: origins,
+        destinations: destinations
+      }
+
+      params[:travelMode] = travel_mode if travel_mode
+      params[:routingPreference] = routing_preference if routing_preference
+      params[:departureTime] = time_convert(departure_time) if departure_time
+      params[:arrivalTime] = time_convert(arrival_time) if arrival_time
+      params[:languageCode] = language_code if language_code
+      params[:regionCode] = region_code if region_code
+      params[:units] = units if units
+      params[:extraComputations] = extra_computations if extra_computations
+      params[:trafficModel] = traffic_model if traffic_model
+      params[:transitPreferences] = transit_preferences if transit_preferences
+
+      field_mask ||= "*"
+
+      post("/distanceMatrix/v2:computeRouteMatrix", params,
+        base_url: ROUTES_BASE_URL,
+        custom_response_decoder: method(:extract_routes_body),
+        field_mask: field_mask)
+    end
+
+    # Compute routes between locations
+    #
+    # Returns the primary route along with optional alternate routes, given a set of terminal
+    # and intermediate waypoints.
+    #
+    # Only the origin and destination is required. The formats for each of the paramters are defined at
+    # https://developers.google.com/maps/documentation/routes/reference/rest/v2/TopLevel/computeRoutes
+    #
+    # @example Simple route request
+    # route = gmaps.compute_routes(
+    #   {address: 'South Brisbane, QLD, AU'},
+    #   {address: 'Fitzroy, VIC, AU'}
+    # )
+    #
+    # @example Complex route request with options
+    # route = gmaps.compute_routes(
+    #   {location: {latLng: {latitude: -27.4698, longitude: 153.0251}}},
+    #   {address: 'Fitzroy, VIC, AU'},
+    #   intermediates: [{address: 'Ultimo, NSW, AU'}],
+    #   travel_mode: 'DRIVE',
+    #   routing_preference: 'TRAFFIC_AWARE',
+    #   departure_time: Time.now + 3600,
+    #   language_code: 'en',
+    #   region_code: 'AU',
+    #   units: 'METRIC',
+    #   extra_computations: ['TOLLS'],
+    #   compute_alternative_routes: true
+    # )
+    #
+    # @param [Hash] origin Required. Origin waypoint
+    # @param [Hash] destination Required. Destination waypoint
+    # @param [Array] intermediates
+    # @param [String] travel_mode
+    # @param [String] routing_preference
+    # @param [String] polyline_quality
+    # @param [String] polyline_encoding
+    # @param [String, Time] departure_time
+    # @param [String, Time] arrival_time
+    # @param [Boolean] compute_alternative_routes
+    # @param [Hash] route_modifiers
+    # @param [String] language_code
+    # @param [String] region_code
+    # @param [String] units
+    # @param [Boolean] optimize_waypoint_order
+    # @param [Array] requested_reference_routes
+    # @param [Array] extra_computations
+    # @param [String] traffic_model
+    # @param [Hash] transit_preferences
+    # @param [String] field_mask
+    #
+    def compute_routes(origin, destination,
+      intermediates: nil,
+      travel_mode: nil,
+      routing_preference: nil,
+      polyline_quality: nil,
+      polyline_encoding: nil,
+      departure_time: nil,
+      arrival_time: nil,
+      compute_alternative_routes: nil,
+      route_modifiers: nil,
+      language_code: nil,
+      region_code: nil,
+      units: nil,
+      optimize_waypoint_order: nil,
+      requested_reference_routes: nil,
+      extra_computations: nil,
+      traffic_model: nil,
+      transit_preferences: nil,
+      field_mask: nil)
+      params = {
+        origin: origin,
+        destination: destination
+      }
+
+      params[:intermediates] = intermediates if intermediates
+      params[:travelMode] = travel_mode if travel_mode
+      params[:routingPreference] = routing_preference if routing_preference
+      params[:polylineQuality] = polyline_quality if polyline_quality
+      params[:polylineEncoding] = polyline_encoding if polyline_encoding
+      params[:departureTime] = time_convert(departure_time) if departure_time
+      params[:arrivalTime] = time_convert(arrival_time) if arrival_time
+      params[:computeAlternativeRoutes] = compute_alternative_routes unless compute_alternative_routes.nil?
+      params[:routeModifiers] = route_modifiers if route_modifiers
+      params[:languageCode] = language_code if language_code
+      params[:regionCode] = region_code if region_code
+      params[:units] = units if units
+      params[:optimizeWaypointOrder] = optimize_waypoint_order unless optimize_waypoint_order.nil?
+      params[:requestedReferenceRoutes] = requested_reference_routes if requested_reference_routes
+      params[:extraComputations] = extra_computations if extra_computations
+      params[:trafficModel] = traffic_model if traffic_model
+      params[:transitPreferences] = transit_preferences if transit_preferences
+
+      field_mask ||= "*"
+
+      post("/directions/v2:computeRoutes", params,
+        base_url: ROUTES_BASE_URL,
+        custom_response_decoder: method(:extract_routes_body),
+        field_mask: field_mask)
+    end
+
+    private
+
+    # Extracts a result from a Routes API HTTP response.
+    def extract_routes_body(response)
+      begin
+        body = MultiJson.load(response.body, symbolize_keys: true)
+      rescue
+        raise GoogleMapsService::Error::ApiError.new(response), "Received a malformed response."
+      end
+
+      if response.code == "400"
+        message = body.is_a?(Array) ? body.first[:error][:message] : body[:error][:message]
+        raise GoogleMapsService::Error::ClientError.new(response), message
+      else
+        check_response_status_code(response)
+      end
+
+      body
+    end
+
+    def time_convert(value)
+      if value.is_a?(Time)
+        value.utc.iso8601
+      else
+        value
+      end
+    end
+  end
+end

data/lib/google_maps_service/client.rb

@@ -8,7 +8,9 @@ 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/routes"
 require "google_maps_service/apis/time_zone"
 
 module GoogleMapsService
@@ -25,7 +27,9 @@ 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::Routes
     include GoogleMapsService::Apis::TimeZone
 
     # Secret key for accessing Google Maps Web Service.
@@ -78,7 +82,7 @@ module GoogleMapsService
     def initialize(**options)
       [:key, :client_id, :client_secret,
         :retry_timeout, :queries_per_second].each do |key|
-        instance_variable_set("@#{key}".to_sym, options[key] || GoogleMapsService.instance_variable_get("@#{key}"))
+        instance_variable_set(:"@#{key}", options[key] || GoogleMapsService.instance_variable_get(:"@#{key}"))
       end
       [:request_options, :ssl_options, :connection].each do |key|
         if options.has_key?(key)
@@ -150,6 +154,38 @@ module GoogleMapsService
       end
     end
 
+    # Make API call using an http post.
+    #
+    # @param [String] path Url path.
+    # @param [String] params Request parameters.
+    # @param [String] base_url Base Google Maps Web Service API endpoint url.
+    # @param [Boolean] accepts_client_id Sign the request using API {#keys} instead of {#client_id}.
+    # @param [Method] custom_response_decoder Custom method to decode raw API response.
+    #
+    # @return [Object] Decoded response body.
+    def post(path, params, base_url: DEFAULT_BASE_URL, accepts_client_id: true, custom_response_decoder: nil, field_mask: nil)
+      url = URI(base_url + generate_auth_url(path, {}, accepts_client_id))
+
+      Retriable.retriable timeout: @retry_timeout, on: RETRIABLE_ERRORS do |try|
+        begin
+          request_query_ticket
+          request = Net::HTTP::Post.new(url)
+          request["User-Agent"] = user_agent
+          request["X-Goog-FieldMask"] = field_mask if field_mask
+          request["Content-Type"] = "application/json"
+          request.body = MultiJson.dump(params)
+          response = Net::HTTP.start(url.hostname, url.port, use_ssl: url.scheme == "https") do |http|
+            http.request(request)
+          end
+        ensure
+          release_query_ticket
+        end
+
+        return custom_response_decoder.call(response) if custom_response_decoder
+        decode_response_body(response)
+      end
+    end
+
     # Get/wait the request "ticket" if QPS is configured.
     # Check for previous request time, it must be more than a second ago before calling new request.
     #

data/lib/google_maps_service/validator.rb

@@ -1,4 +1,4 @@
-require_relative "./convert"
+require_relative "convert"
 
 module GoogleMapsService
   # Validate value that is accepted by Google Maps.

data/lib/google_maps_service/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google_maps_service_ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Lang Sharpe
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-18 00:00:00.000000000 Z
+date: 2025-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -38,6 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
@@ -150,9 +163,37 @@ 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,
-  which is a fork of google-maps-services-python.
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Google Maps API Client, including the Routes API, Directions API, Distance
+  Matrix 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
 executables: []
@@ -161,6 +202,7 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - LICENSE
 - README.md
 - lib/google_maps_service.rb
@@ -169,7 +211,9 @@ 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/routes.rb
 - lib/google_maps_service/apis/time_zone.rb
 - lib/google_maps_service/client.rb
 - lib/google_maps_service/convert.rb
@@ -187,8 +231,6 @@ metadata:
   changelog_uri: https://raw.githubusercontent.com/langsharpe/google-maps-services-ruby/master/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/google_maps_service_ruby
   homepage_uri: https://github.com/langsharpe/google-maps-services-ruby
-  source_code_uri: https://github.com/langsharpe/google-maps-services-ruby
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -203,8 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Google Maps API Client
 test_files: []