google_maps_service_ruby 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71fd1ea5543cf0c41c68763e4ffaa218573e4965105a7973613bffcb94b9dcd2
-  data.tar.gz: a2eb9d2b1bb9368d0914798f49b8b5d27645ad0a056e7e62fd10fc6abcca83d3
+  metadata.gz: 651ee8dbc068582df401c0504894e364990b1ca0e246f72f421ca0d0a7010829
+  data.tar.gz: a802fec4e670dab3fcb56c5c5988d1255121a909798b204af265bc4bacfdc37e
 SHA512:
-  metadata.gz: 77a992d6ca82095447e3fb75bcb8e194ae627cc97b0c20c8e2cb6f0cfa575a08bf63a078242e6f91ef1396592f93cfa89a8c4086220d8016826a8634383c2284
-  data.tar.gz: 28ad069318403640c4f7a15fd7e752dc7c6102bee54fe2432370059d620555ab78358961fb0e3dade88195391f79e28bc4e1953b4e4e0f0b1c9aa9fec4204020
+  metadata.gz: f1336fa544bf170a6304cdd9e96006c7bd2a6b810e4ce7000f49bd79f658895c841bf6d1f3ad996a1ac2733c9eb70e4a03a59bb3e6644f278463ec2d5bc8b732
+  data.tar.gz: bba938de0653a91533f991eb74b7b62ec9d957798715b5e65e87cd9a1b838d22396d0226fa3fe390bde49e8b3fe61c511de3a0525036e71b056523cde72e37e0

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## 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

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

@@ -19,6 +19,7 @@ The Ruby gem for Google Maps Web Service APIs is a gem for the following Google
  - [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.
@@ -48,17 +49,7 @@ This gem return a Ruby Hash/Array object as the API result. The result format st
 
 ## 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.
+See [CONTRIBUTING.md](https://github.com/langsharpe/google-maps-services-ruby/blob/master/CONTRIBUTING.md) for details on contributing to this project.
 
 ## Requirements
 
@@ -175,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
@@ -392,6 +404,7 @@ encoded_path = GoogleMapsService::Polyline.encode(path)
 [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

@@ -29,7 +29,6 @@ module GoogleMapsService::Apis
     #         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)
@@ -132,7 +131,6 @@ module GoogleMapsService::Apis
       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

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

@@ -10,6 +10,7 @@ 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
@@ -28,6 +29,7 @@ module GoogleMapsService
     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.
@@ -80,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)
@@ -152,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.3"
+  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.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Lang Sharpe
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-04 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, 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.
+- !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
@@ -171,6 +213,7 @@ files:
 - 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
@@ -188,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
@@ -204,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: []