https://github.com/freayd/osrm

Ruby API to request Mapbox and other Open Source Routing Machine servers
https://github.com/freayd/osrm

directions mapbox openstreetmap osrm routing ruby

Last synced: 4 months ago
JSON representation

Ruby API to request Mapbox and other Open Source Routing Machine servers

• Host: GitHub
• URL: https://github.com/freayd/osrm
• Owner: freayd
• License: mit
• Created: 2014-12-08T16:30:47.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2018-07-05T03:54:01.000Z (over 7 years ago)
• Last Synced: 2024-04-26T15:21:56.454Z (over 1 year ago)
• Topics: directions, mapbox, openstreetmap, osrm, routing, ruby
• Language: Ruby
• Homepage:
• Size: 57.6 KB
• Stars: 6
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## OSRM Gem

OSRM Gem is a Ruby API that allows you to request [Open Source Routing Machine](http://project-osrm.org/) servers.

You can [run your own server](https://github.com/Project-OSRM/osrm-backend/wiki), use the [OSRM demo server](https://github.com/Project-OSRM/osrm-backend/wiki/Demo-server) or the [Mapbox server](https://www.mapbox.com/developers/).

## Usage

1. Install OSRM Gem

        gem install osrm

2. Configure

        require 'osrm'

        OSRM.configure(

          # Connection

          server:       'example.com',      # Must be specified

          port:         8080,               # Default: 80 or 443 if SSL

          use_ssl:      true,               # Default: false

          path_prefix:  '/optional/path',   # Default: ''

          ## OSRM demo server connection

          # server:     :demo,

          ## Mapbox server connection

          # server:     :mapbox,

          # api_key:    'access-token',

          # Connection (advanced)

          timeout:        10,                               # Default: 3

          user_agent:     'MyScript/1.1',                   # Default: 'OSRMRubyGem/{version}'

          before_request: -> { sleep 1 },                   # Default: nil

          after_request:  -> { puts 'Request performed!' }, # Default: nil

          # Caching

          # The cache can be any object providing [] and []= methods.

          # The cache key must contain the {url} pattern.

          cache:      {},                 # Default: nil (no cache)

          cache_key:  'my-script:{url}',  # Default: 'osrm:{url}'

          # Requests

          # Specify the precision of the overview geometries returned

          overview: :full                 # Possible values: false, :simplified (default), :full

        )

3. Request

        OSRM.routes('50.202712,8.582738', '50.20232,8.574447')

        OSRM.route('50.202712,8.582738', '50.20232,8.574447', '50.2099431,8.5710665')

        OSRM.route_by_cycling('45.734818,7.3219649', '45.868829,7.1533417')

## License

OSRM Gem is released under [MIT License](https://opensource.org/licenses/MIT).