Skip to content

Latest commit

 

History

History
457 lines (326 loc) · 22.1 KB

README.md

File metadata and controls

457 lines (326 loc) · 22.1 KB
Raw

what3words what3words Ruby wrapper

Build Status

The Ruby wrapper is useful for Ruby developers who wish to seamlessly integrate the what3words Public API into their Ruby applications, without the hassle of having to manage the low level API calls themselves.

The what3words API is a fast, simple interface which allows you to convert what3words addresses such as ///index.home.raft to latitude and longitude coordinates such as -0.203586, 51.521251 and vice versa. It features a powerful autosuggest function, which can validate and autocorrect user input and limit it to certain geographic areas (this powers the search box on our map site). It allows you to request a section of the what3words grid (which can be requested as GeoJSON for easy display on online maps), and to request the list of all languages supported by what3words. For advanced users, autosuggest can be used to post-process voice output.

All coordinates are latitude,longitude pairs in standard WGS-84 (as commonly used worldwide in GPS systems). All latitudes must be in the range of -90 to 90 (inclusive).

Installation

The library is available through RubyGems.

You can simply add this line to your application's Gemfile:

    gem 'what3words', '~> 3.3'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install what3words

Usage

Sign up for an API key at https://developer.what3words.com

See https://developer.what3words.com/public-api/docs for all parameters that can be passed to the API calls.

If not using Bundler, require it:

    require 'what3words'

Then:

    what3words = What3Words::API.new(:key => "YOURAPIKEY")

Convert to Coordinates: convert a what3words address into GPS coordinates (WGS84)

what3words.convert_to_coordinates 'prom.cape.pump'

Expected Output

# => {:country=>"GB", :square=>{:southwest=>{:lng=>-0.195426, :lat=>51.484449}, :northeast=>{:lng=>-0.195383, :lat=>51.484476}}, :nearestPlace=>"Kensington, London", :coordinates=>{:lng=>-0.195405, :lat=>51.484463}, :words=>"prom.cape.pump", :language=>"en", :map=>"https://w3w.co/prom.cape.pump"}

API

Convert to Coordinates

Convert a what3words address into GPS coordinates and return what3words for the same position.

what3words.convert_to_coordinates "prom.cape.pump"

Expected Output

# => {:country=>"GB", :square=>{:southwest=>{:lng=>-0.195426, :lat=>51.484449}, :northeast=>{:lng=>-0.195383, :lat=>51.484476}}, :nearestPlace=>"Kensington, London", :coordinates=>{:lng=>-0.195405, :lat=>51.484463}, :words=>"prom.cape.pump", :language=>"en", :map=>"https://w3w.co/prom.cape.pump"}

Supported keyword params for convert_to_coordinates call:

  • words A what3words address as a string
  • format Return data format type. It can be one of json (the default) or geojson

Convert to 3WA

Convert position information, latitude and longitude coordinates, into a what3words address.

what3words.convert_to_3wa [29.567041, 106.587875]

Expected Output

# => {:country=>"CN", :square=>{:southwest=>{:lng=>106.58786, :lat=>29.567028}, :northeast=>{:lng=>106.587891, :lat=>29.567055}}, :nearestPlace=>"Chongqing", :coordinates=>{:lng=>106.587875, :lat=>29.567041}, :words=>"disclose.strain.redefined", :language=>"en", :map=>"https://w3w.co/disclose.strain.redefined"}

Convert position information to a what3words address in a specific language

what3words.convert_to_3wa [29.567041, 106.587875], language: 'fr'

Expected Output

# => :country=>"CN", :square=>{:southwest=>{:lng=>106.58786, :lat=>29.567028}, :northeast=>{:lng=>106.587891, :lat=>29.567055}}, :nearestPlace=>"Chongqing", :coordinates=>{:lng=>106.587875, :lat=>29.567041}, :words=>"courgette.rabotons.infrason", :language=>"fr", :map=>"https://w3w.co/courgette.rabotons.infrason"}

Supported keyword params for convert_to_3wa call:

  • coordinates The coordinates of the location to convert to what3words address
  • language (defaults to en) - A supported what3words address language as an ISO 639-1 2 letter code
  • format Return data format type. It can be one of json (the default) or geojson

Autosuggest

Returns a list of what3words addresses based on user input and other parameters.

This resource provides corrections for the following types of input error:

  • typing errors
  • spelling errors
  • misremembered words (e.g. singular vs. plural)
  • words in the wrong order

The autosuggest resource determines possible corrections to the supplied what3words address string based on the probability of the input errors listed above and returns a ranked list of suggestions. This resource can also take into consideration the geographic proximity of possible corrections to a given location to further improve the suggestions returned.

See https://developer.what3words.com/public-api/docs#autosuggest for detailed information

Gets suggestions in french for this address:

what3words.autosuggest 'trop.caler.perdre', language: 'fr'

Expected Output

# => {:suggestions=>[{:country=>"FR", :nearestPlace=>"Saint-Lary-Soulan, Hautes-Pyrénées", :words=>"trier.caler.perdre", :rank=>1, :language=>"fr"}, {:country=>"ET", :nearestPlace=>"Asbe Teferi, Oromiya", :words=>"trôler.caler.perdre", :rank=>2, :language=>"fr"}, {:country=>"CN", :nearestPlace=>"Ulanhot, Inner Mongolia", :words=>"froc.caler.perdre", :rank=>3, :language=>"fr"}]}

Gets suggestions for a different number of suggestions, i.e. 10 for this address:

what3words.autosuggest 'disclose.strain.redefin', language: 'en', 'n-results': 10

Expected Output

# => {:suggestions=>[{:country=>"SO", :nearestPlace=>"Jamaame, Lower Juba", :words=>"disclose.strain.redefine", :rank=>1, :language=>"en"}, {:country=>"ZW", :nearestPlace=>"Mutoko, Mashonaland East", :words=>"discloses.strain.redefine", :rank=>2, :language=>"en"}, {:country=>"MM", :nearestPlace=>"Mogok, Mandalay", :words=>"disclose.strains.redefine", :rank=>3, :language=>"en"}, {:country=>"CN", :nearestPlace=>"Chongqing", :words=>"disclose.strain.redefined", :rank=>4, :language=>"en"}, {:country=>"ZM", :nearestPlace=>"Binga, Matabeleland North", :words=>"disclosing.strain.redefine", :rank=>5, :language=>"en"}, {:country=>"XH", :nearestPlace=>"Leh, Ladakh", :words=>"disclose.straining.redefine", :rank=>6, :language=>"en"}, {:country=>"US", :nearestPlace=>"Kamas, Utah", :words=>"disclose.strain.redefining", :rank=>7, :language=>"en"}, {:country=>"GN", :nearestPlace=>"Boké", :words=>"disclose.strained.redefine", :rank=>8, :language=>"en"}, {:country=>"BO", :nearestPlace=>"Pailón, Santa Cruz", :words=>"discloses.strains.redefine", :rank=>9, :language=>"en"}, {:country=>"US", :nearestPlace=>"McGrath, Alaska", :words=>"discloses.strain.redefined", :rank=>10, :language=>"en"}]}

Gets suggestions when the coordinates for focus has been provided for this address:

what3words.autosuggest 'filled.count.soap', focus: [51.4243877,-0.34745]

Expected Output

# => {:suggestions=>[{:country=>"US", :nearestPlace=>"Homer, Alaska", :words=>"fund.with.code", :rank=>1, :language=>"en"}, {:country=>"AU", :nearestPlace=>"Kumpupintil, Western Australia", :words=>"funk.with.code", :rank=>2, :language=>"en"}, {:country=>"US", :nearestPlace=>"Charleston, West Virginia", :words=>"fund.with.cove", :rank=>3, :language=>"en"}]}

Gets suggestions for a different number of focus results for this address:

what3words.autosuggest 'disclose.strain.redefin', language: 'en', 'n-focus-results': 3

Expected Output

# => {:suggestions=>[{:country=>"SO", :nearestPlace=>"Jamaame, Lower Juba", :words=>"disclose.strain.redefine", :rank=>1, :language=>"en"}, {:country=>"ZW", :nearestPlace=>"Mutoko, Mashonaland East", :words=>"discloses.strain.redefine", :rank=>2, :language=>"en"}, {:country=>"MM", :nearestPlace=>"Mogok, Mandalay", :words=>"disclose.strains.redefine", :rank=>3, :language=>"en"}]}

Gets suggestions for a voice input type mode, i.e. generic-voice, for this address:

what3words.autosuggest 'fun with code', 'input-type': 'generic-voice', language: 'en'

Expected Output

# => {:suggestions=>[{:country=>"US", :nearestPlace=>"Homer, Alaska", :words=>"fund.with.code", :rank=>1, :language=>"en"}, {:country=>"AU", :nearestPlace=>"Kumpupintil, Western Australia", :words=>"funk.with.code", :rank=>2, :language=>"en"}, {:country=>"US", :nearestPlace=>"Charleston, West Virginia", :words=>"fund.with.cove", :rank=>3, :language=>"en"}]}

Gets suggestions for a restricted area by clipping to country for this address:

what3words.autosuggest 'disclose.strain.redefin', 'clip-to-country': 'GB,BE'

Expected Output

# => {:suggestions=>[{:country=>"GB", :nearestPlace=>"Nether Stowey, Somerset", :words=>"disclose.retrain.redefined", :rank=>1, :language=>"en"}, {:country=>"BE", :nearestPlace=>"Zemst, Flanders", :words=>"disclose.strain.reckon", :rank=>2, :language=>"en"}, {:country=>"GB", :nearestPlace=>"Waddington, Lincolnshire", :words=>"discloses.trains.redefined", :rank=>3, :language=>"en"}]}

Gets suggestions for a restricted area by clipping to a bounding-box for this address:

what3words.autosuggest 'disclose.strain.redefin', 'clip-to-bounding-box': [51.521, -0.343, 52.6, 2.3324]

Expected Output

# => {:suggestions=>[{:country=>"GB", :nearestPlace=>"Saxmundham, Suffolk", :words=>"discloses.strain.reddish", :rank=>1, :language=>"en"}]}

Gets suggestions for a restricted area by clipping to a circle in km for this address:

what3words.autosuggest 'disclose.strain.redefin', 'clip-to-circle': [51.521, -0.343, 142]

Expected Output

# => {:suggestions=>[{:country=>"GB", :nearestPlace=>"Market Harborough, Leicestershire", :words=>"discloses.strain.reduce", :rank=>1, :language=>"en"}]}

Gets suggestions for a restricted area by clipping to a polygon for this address:

what3words.autosuggest 'disclose.strain.redefin', 'clip-to-polygon': [51.521, -0.343, 52.6, 2.3324, 54.234, 8.343, 51.521, -0.343]

Expected Output

# => {:suggestions=>[{:country=>"GB", :nearestPlace=>"Saxmundham, Suffolk", :words=>"discloses.strain.reddish", :rank=>1, :language=>"en"}]}

Gets suggestions for a restricted area by clipping to a polygon for this address:

what3words.w3w.autosuggest 'disclose.strain.redefin', 'prefer-land': false, 'n-results': 10

Expected Output

# => {:suggestions=>[{:country=>"SO", :nearestPlace=>"Jamaame, Lower Juba", :words=>"disclose.strain.redefine", :rank=>1, :language=>"en"}, {:country=>"ZW", :nearestPlace=>"Mutoko, Mashonaland East", :words=>"discloses.strain.redefine", :rank=>2, :language=>"en"}, {:country=>"MM", :nearestPlace=>"Mogok, Mandalay", :words=>"disclose.strains.redefine", :rank=>3, :language=>"en"}, {:country=>"CN", :nearestPlace=>"Chongqing", :words=>"disclose.strain.redefined", :rank=>4, :language=>"en"}, {:country=>"ZM", :nearestPlace=>"Binga, Matabeleland North", :words=>"disclosing.strain.redefine", :rank=>5, :language=>"en"}, {:country=>"XH", :nearestPlace=>"Leh, Ladakh", :words=>"disclose.straining.redefine", :rank=>6, :language=>"en"}, {:country=>"US", :nearestPlace=>"Kamas, Utah", :words=>"disclose.strain.redefining", :rank=>7, :language=>"en"}, {:country=>"GN", :nearestPlace=>"Boké", :words=>"disclose.strained.redefine", :rank=>8, :language=>"en"}, {:country=>"BO", :nearestPlace=>"Pailón, Santa Cruz", :words=>"discloses.strains.redefine", :rank=>9, :language=>"en"}, {:country=>"US", :nearestPlace=>"McGrath, Alaska", :words=>"discloses.strain.redefined", :rank=>10, :language=>"en"}]}

Supported keyword params for autosuggest call:

  • input The full or partial what3words address to obtain suggestions for. At minimum this must be the first two complete words plus at least one character from the third word.
  • language A supported what3words address language as an ISO 639-1 2 letter code. This setting is on by default. Use false to disable this setting and receive more suggestions in the sea.
  • n_results The number of AutoSuggest results to return. A maximum of 100 results can be specified, if a number greater than this is requested, this will be truncated to the maximum. The default is 3.
  • n_focus_results Specifies the number of results (must be <= n_results) within the results set which will have a focus. Defaults to n_results. This allows you to run autosuggest with a mix of focussed and unfocussed results, to give you a "blend" of the two.
  • clip-to-country Restricts autosuggest to only return results inside the countries specified by comma-separated list of uppercase ISO 3166-1 alpha-2 country codes (for example, to restrict to Belgium and the UK, use clip_to_country="GB,BE").
  • clip-to-bounding-box Restrict autosuggest results to a bounding box, specified by coordinates.
  • clip-to-circle Restrict autosuggest results to a circle, specified by the center of the circle, latitude and longitude, and a distance in kilometres which represents the radius. For convenience, longitude is allowed to wrap around 180 degrees. For example 181 is equivalent to -179.
  • clip-to-polygon Restrict autosuggest results to a polygon, specified by a list of coordinates. The polygon should be closed, i.e. the first element should be repeated as the last element; also the list should contain at least 4 entries. The API is currently limited to accepting up to 25 pairs.
  • input-type For power users, used to specify voice input mode. Can be text (default), vocon-hybrid, nmdp-asr or generic-voice.
  • prefer-land Makes autosuggest prefer results on land to those in the sea.

Grid

Returns a section of the 3m x 3m what3words grid for a given area.

See https://developer.what3words.com/public-api/docs#grid-section for detailed information.

Gets grid for these bounding box northeast 52.208867,0.117540,52.207988,0.116126.

what3words.grid_section '52.208867,0.117540,52.207988,0.116126'

Expected Output

# => {:lines=>[{:start=>{:lng=>0.116126, :lat=>52.20801}, :end=>{:lng=>0.11754, :lat=>52.20801}}, {:start=>{:lng=>0.116126, :lat=>52.208037}, :end=>{:lng=>0.11754, :lat=>52.208037}}, {:start=>{:lng=>0.116126, :lat=>52.208064}, :end=>{:lng=>0.11754, :lat=>52.208064}}, ___...___ ]}

Supported keyword params for grid_section call:

  • bounding-box The bounding box is specified by the northeast and southwest corner coordinates, for which the grid should be returned
  • format Return data format type. It can be one of json (the default) or geojson

Get Languages

Retrieve a list of available what3words languages.

what3words.available_languages

Expected Output

# => {:languages=>[{:nativeName=>"Deutsch", :code=>"de", :name=>"German"}, {:nativeName=>"हिन्दी", :code=>"hi", :name=>"Hindi"}, {:nativeName=>"Português", :code=>"pt", :name=>"Portuguese"}, {:nativeName=>"Magyar", :code=>"hu", :name=>"Hungarian"}, {:nativeName=>"Українська", :code=>"uk", :name=>"Ukrainian"}, {:nativeName=>"Bahasa Indonesia", :code=>"id", :name=>"Bahasa Indonesia"}, {:nativeName=>"اردو", :code=>"ur", :name=>"Urdu"}, ___...___]}

See https://developer.what3words.com/public-api/docs#available-languages for the original API call documentation.

RegEx functions

This section introduces RegEx functions that can assist with checking and finding possible what3words addresses in strings. The three main functions covered are:

`isPossible3wa` – Match what3words address format;
`findPossible3wa` – Find what3words address in Text;
`isValid3wa` – Verify a what3words address with the API;

isPossible3wa

Our API wrapper RegEx function isPossible3wa can be used used to detect if a text string (like filled.count.soap) in the format of a what3words address without having to ask the API. This functionality checks if a given string could be a what3words address. It returns true if it could be, otherwise false.

Note: This function checks the text format but not the validity of a what3words address. Use isValid3wa to verify validity.

require 'what3words'

def main
  # Initialize the What3Words API with your API key
  api_key = 'YOUR_API_KEY'
  w3w = What3Words::API.new(:key => api_key)

  # Example what3words addresses
  addresses = ["filled.count.soap", "not a 3wa", "not.3wa address"]

  # Check if the addresses are possible what3words addresses
  addresses.each do |address|
    is_possible = w3w.isPossible3wa(address)
    puts "Is '#{address}' a possible what3words address? #{is_possible}"
  end
end

if __FILE__ == $0
  main
end

Expected Output

isPossible3wa(“filled.count.soap”) returns true
isPossible3wa(“not a 3wa”) returns false
isPossible3wa(“not.3wa address”)returns false

findPossible3wa

Our API wrapper RegEx function findPossible3wa can be used to detect a what3words address within a block of text, useful for finding a what3words address in fields like Delivery Notes. For example, it can locate a what3words address in a note like “Leave at my front door ///filled.count.soap”. The function will match if there is a what3words address within the text. If no possible addresses are found, it returns an empty list.

Note:

  • This function checks the text format but not the validity of a what3words address. Use isValid3wa to verify validity.
  • This function is designed to work across languages but do not work for Vietnamese (VI) due to spaces within words.
require 'what3words'

def main
  # Initialize the what3words API with your API key
  api_key = 'YOUR_API_KEY'
  w3w = What3Words::API.new(:key => api_key)

  # Example texts
  texts = [
    "Please leave by my porch at filled.count.soap",
    "Please leave by my porch at filled.count.soap or deed.tulip.judge",
    "Please leave by my porch at"
  ]

  # Check if the texts contain possible what3words addresses
  texts.each do |text|
    possible_addresses = w3w.findPossible3wa(text)
    puts "Possible what3words addresses in '#{text}': #{possible_addresses}"
  end
end

if __FILE__ == $0
  main
end

Expected Output

findPossible3wa(“Please leave by my porch at filled.count.soap”) returns ['filled.count.soap']
findPossible3wa(“Please leave by my porch at filled.count.soap or deed.tulip.judge”) returns ['filled.count.soap', 'deed.tulip.judge']
findPossible3wa(“Please leave by my porch at”) returns []

isValid3wa

Our API wrapper RegEx function isValid3wa can be used to determine if a string is a valid what3words address by checking it against the what3words RegEx filter and verifying it with the what3words API.

require 'what3words'

def main
  # Initialize the what3words API with your API key
  api_key = 'YOUR_API_KEY'
  w3w = What3Words::API.new(:key => api_key)

  # Example addresses
  addresses = [
    "filled.count.soap",
    "filled.count.",
    "coding.is.cool"
  ]

  # Check if the addresses are valid what3words addresses
  addresses.each do |address|
    is_valid = w3w.isValid3wa(address)
    puts "Is '#{address}' a valid what3words address? #{is_valid}"
  end
end

if __FILE__ == $0
  main
end

Expected Outputs

isValid3wa(“filled.count.soap”) returns True
isValid3wa(“filled.count.”) returns False
isValid3wa(“coding.is.cool”) returns False

Also make sure to replace <YOUR_API_KEY> with your actual API key. These functionalities provide different levels of validation for what3words addresses, from simply identifying potential addresses to verifying their existence on Earth.

See https://developer.what3words.com/tutorial/ruby#regex-functions for further documentation.

Testing

  • Prerequisite : we are using bundler $ gem install bundler

  • W3W-API-KEY: For safe storage of your API key on your computer, you can define that API key using your system’s environment variables.

$ export W3W_API_KEY=<Secret API Key>
  • on your cloned folder
  1. $ cd w3w-ruby-wrapper
  2. $ bundle update
  3. $ rake rubocop spec

To run the tests, type on your terminal:

$ bundle exec rspec

Issues

Find a bug or want to request a new feature? Please let us know by submitting an issue.

Contributing

Anyone and everyone is welcome to contribute.

  1. Fork it (http://github.com/what3words/w3w-ruby-wrapper and click "Fork")
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Don't forget to update README and bump version using semver
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request

Revision History

  • v3.3.0 12/08/24 - Update error message to handle c2c calls and dependencies
  • v3.2.0 17/07/24 - Update regex patterns
  • v3.1.0 16/07/24 - Update tests and code to host the regex functions
  • v3.0.0 12/05/22 - Update endpoints and tests to API v3, added HTTP headers
  • v2.2.0 03/01/18 - Enforce Ruby 2.4 Support - Thanks to PR from Dimitrios Zorbas @Zorbash
  • v2.1.1 22/05/17 - Update gemspec to use rubocop 0.48.1, and fixes spec accordingly
  • v2.1.0 28/03/17 - Added multilingual version of autosuggest and standardblend
  • v2.0.4 27/03/17 - Updated README with languages method result updated from live result
  • v2.0.3 24/10/16 - Fixed display in assemble_common_request_params
  • v2.0.2 10/06/16 - Added travis-ci builds
  • v2.0.0 10/06/16 - Updated wrapper to use what3words API v2

Licensing

The MIT License (MIT)

A copy of the license is available in the repository's license file.