Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Skalar/google_distance_matrix

Ruby client for The Google Distance Matrix API.
https://github.com/Skalar/google_distance_matrix

distancematrix google-distance-matrix matrix ruby ruby-client

Last synced: 2 months ago
JSON representation

Ruby client for The Google Distance Matrix API.

Awesome Lists containing this project

README 

        
# GoogleDistanceMatrix



![Build Status](https://github.com/Skalar/google_distance_matrix/workflows/Ruby/badge.svg)



Ruby client for the [Google Distance Matrix API](https://developers.google.com/maps/documentation/distance-matrix/intro).



This lib makes Google's distance matrix API easy to work with,

allowing you to set up some origins and destinations and

pull the distance matrix from Google.



Once you have the matrix you can fetch all routes from a given

origin or to a given destination.



## Examples



### Set up a matrix to work with



```ruby

matrix = GoogleDistanceMatrix::Matrix.new

```



### Create some places to be used as origins or destinations for the matrix

```ruby

lat_lng = GoogleDistanceMatrix::Place.new lng: 12, lat: 12

address = GoogleDistanceMatrix::Place.new address: "My address, Oslo"

dest_address = GoogleDistanceMatrix::Place.new address: "Home, Oppegaard"



# Just an example of an object responding to lat & lng.

# Point class isn't included in this gem, but feel free to

# create your own point class or use something like https://github.com/nofxx/georuby

point_dest = Point.new lat: 1, lng: 2

dest_object = GoogleDistanceMatrix::Place.new point_dest

```

### Add places to matrix's origins and destinations

```ruby

matrix.origins << lat_lng << address

matrix.destinations << dest_address << dest_object



# Added objects will be wrapped in a place automatically, so you may skip manyally creating Places.

another_point = Point.new lat: 1, lng: 3

matrix.origins << another_point

```

### Do some configuration - see GoogleDistanceMatrix.configure_defaults as well.

```ruby

matrix.configure do |config|

  config.mode = 'driving'

  config.avoid = 'tolls'



  # To build signed URLs to use with a Google Business account.

  config.google_business_api_client_id = "123"

  config.google_business_api_private_key = "your-secret-key"



  # If you have an API key, you can specify that as well.

  config.google_api_key = "YOUR_API_KEY"

end

```

### Get the data for the matrix



`matrix.data` returns the data, loaded from Google, for this matrix.



 It is a multi dimensional array. Rows are ordered according to the values in the origins.

 Each row corresponds to an origin, and each element within that row corresponds to a pairing of the origin with a destination.



### Query the matrix



Returns an array of Google::DistanceMatrix::Route, all having given origin or destination.



```ruby

matrix.routes_for dest_address

```



Returns Google::DistanceMatrix::Route with given origin and destination



```ruby

matrix.route_for origin: lat_lng, destination: dest_address



# Returns the shortest route to given destination, either by distance or duration

matrix.shortest_route_by_distance_to(dest_address)

matrix.shortest_route_by_duration_to(dest_address)



# If your matrix is for driving and you provided a departure_time all Route objects within

# the matrix will have duration_in_traffic_in_seconds. We can query the matrix for this data as well:

matrix.shortest_route_by_duration_in_traffic_to(dest_address)

```



In cases where you built the place with an object (not hash with attributes) you may provide that object

as well asking for routes. This is true for `route_for` and `shortest_route_by_*` as well.



```ruby

matrix.routes_for point_dest # Returns routes for dest_object

```



You may call query methods with a bang, in which case it will fail with an error if not all of the

routes in your result set for the called method are ok.



## Installation



Add this line to your application's Gemfile:



```ruby

gem 'google_distance_matrix'‚ '~> 0.7.0'

```

And then execute:



    $ bundle



Or install it yourself as:



    $ gem install google_distance_matrix



### Ruby 2.x support



Legacy systems that needs to run on unsupported rubies can depend on `v0.6.7`, which is the last supported version for Ruby 2.



```ruby

gem 'google_distance_matrix', '0.6.7'

```



## Configuration



Configuration is done directly on a matrix or via `GoogleDistanceMatrix.configure_defaults`.

Apart from configuration on requests it is also possible to provide your own logger class and

set a cache.



### Shorting the URL using encoded coordinates

Instead of lat and lng values in the URL it is possible to use encoded set of coordinates

using the Encoded Polyline Algorithm. This is particularly useful if you have a large

number of origin points, because the URL is significantly shorter when

using an encoded polyline.



```ruby

GoogleDistanceMatrix.configure_defaults do |config|

  config.use_encoded_polylines = true

end

```



### Request cache



Given Google's limit to the service you may have the need to cache requests. This is done by simply

using URL as cache keys. Cache we'll accept should provide a default ActiveSupport::Cache::Store interface.



```ruby

GoogleDistanceMatrix.configure_defaults do |config|

  config.cache = ActiveSupport::Cache.lookup_store :your_store, {

    expires_in: 12.hours

    # ..or other options you like for your store

  }

end

```



## Contributing



1. Fork it

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 new Pull Request