open_location_code 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82d946e05ee8c635c1aea25b7c11bf8309d195a2
+  data.tar.gz: 370f96971c64f1384c387a913ee5494f49e77b18
+SHA512:
+  metadata.gz: ddc3ec4f227802e24bdd6072055c6987771b6ded212f13ab70e62e7b351e5c1b16e60d67cd47314ad7625ff10e24167d6ee431d616059dda89dbb3719650a393
+  data.tar.gz: 24affbebbf437f9dedf76472ecfda8641345c63709406134fcd8dd007cb88573d2b8ee9ff04431595d8ad16f51188f28275ef7e445b5abfedf57ebc818ab01f3

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in open_location_code.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jiren
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# OpenLocationCode
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/open_location_code`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+Ref:  https://github.com/google/open-location-code
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'open_location_code', github: 'jiren/open_location_code'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install open_location_code
+
+## Usage
+
+```ruby
+  code = OpenLocationCode.encode(47.365590, 8.524997) # 8FVC9G8F+6X
+  code = OpenLocationCode.encode(47.365590, 8.524997, 12) #8FVC9G8F+6XQH
+ 
+  code_area = OpenLocationCode.decode(code)
+  # #<OpenLocationCode::CodeArea:0x007fe7eb050110 @latitude_lo=47.36557499999997, @longitude_lo=8.524968750000008, @latitude_hi=47.36557499999997, @longitude_hi=8.52500000000001, @code_length=12, @latitude_center=47.36557499999997, @longitude_center=8.52498437500001>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/open_location_code/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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "open_location_code"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/open_location_code/code_area.rb

@@ -0,0 +1,31 @@
+module OpenLocationCode
+  #
+  #  Coordinates of a decoded Open Location Code.
+  #
+  #  The coordinates include the latitude and longitude of the lower left and
+  #  upper right corners and the center of the bounding box for the area the
+  #  code represents.
+  #
+  class CodeArea
+    attr_accessor :latitude_lo, :longitude_lo, :latitude_hi, :longitude_hi
+    attr_accessor :latitude_center, :longitude_center, :code_length
+
+    def initialize(latitude_lo, longitude_lo, latitude_hi, longitude_hi, code_length)
+      @latitude_lo  = latitude_lo
+      @longitude_lo = longitude_lo
+      @latitude_hi  = latitude_hi
+      @longitude_hi = longitude_hi
+      @code_length  = code_length
+
+      set_center
+    end
+
+    #
+    # Calculate center latitude and longitude
+    #
+    def set_center
+      @latitude_center = [ latitude_lo + (latitude_hi - latitude_lo) / 2.0, LATITUDE_MAX].min
+      @longitude_center = [ longitude_lo + (longitude_hi - longitude_lo)/ 2.0, LONGITUDE_MAX].min
+    end
+  end
+end

data/lib/open_location_code/decoder.rb

@@ -0,0 +1,261 @@
+module OpenLocationCode
+  #
+  # Decode open location code to latitude and longitude of the lower left and
+  # upper right corners and the center of the bounding box for the area
+  #
+  class Decoder
+    attr_accessor :code
+
+    def initialize(code)
+      @code = code.dup
+    end
+
+    #
+    # Decode opne location code
+    #
+    # @return [CodeArea]
+    #
+    def process
+      unless full?
+        raise OLCError, "Passed Open Location Code is not a valid full code: #{code}"
+      end
+
+      # Strip out separator character (we've already established the code is
+      # valid so the maximum is one), padding characters and convert to upper case.
+      code.sub!(SEPARATOR, '')
+      code.sub!(/#{PADDING_CHARACTER}+/, '')
+      code.upcase!
+
+      # Decode the lat/lng pair component.
+      code_area = decode_pairs(code[0, PAIR_CODE_LENGTH])
+
+      # If there is a grid refinement component, decode that.
+      return code_area if code.length <= PAIR_CODE_LENGTH
+
+      grid_area = decode_grid(code[PAIR_CODE_LENGTH, code.length - 1])
+
+      CodeArea.new(
+        code_area.latitude_lo + grid_area.latitude_lo,
+        code_area.longitude_lo + grid_area.longitude_lo,
+        code_area.latitude_lo + grid_area.latitude_hi,
+        code_area.longitude_lo + grid_area.longitude_hi,
+        code_area.code_length + grid_area.code_length
+      )
+    end
+
+    #
+    #  Decode an OLC code made up of lat/lng pairs.
+    #
+    #  This decodes an OLC code made up of alternating latitude and longitude
+    #  characters, encoded using base 20.
+    #
+    # @param [String] code
+    #   A valid OLC code, presumed to be full, but with the separator
+    #   removed.
+    # @return [CodeArea]
+    #
+    def decode_pairs(code)
+      # Get the latitude and longitude values. These will need correcting from
+      # positive ranges.
+
+      latitude_pair = decode_pairs_sequence(code, 0)
+      longitude_pair = decode_pairs_sequence(code, 1)
+
+      # Correct the values and set them into the CodeArea object.
+      return CodeArea.new(
+        latitude_pair[0]  - LATITUDE_MAX,
+        longitude_pair[0] - LONGITUDE_MAX,
+        latitude_pair[1]  - LATITUDE_MAX,
+        longitude_pair[1] - LONGITUDE_MAX,
+        code.length)
+    end
+
+    #
+    #  Decode either a latitude or longitude sequence.
+    #
+    #  This decodes the latitude or longitude sequence of a lat/lng pair encoding.
+    #  Starting at the character at position offset, every second character is
+    #  decoded and the value returned.
+    #
+    # @param [String] code
+    #   A valid OLC code, presumed to be full, with the separator removed.
+    # @param [Integer] offset
+    #   The character to start from.
+    # @return [CodeArea]
+    #  A pair of the low and high values. The low value comes from decoding the
+    #  characters. The high value is the low value plus the resolution of the
+    #  last position. Both values are offset into positive ranges and will need
+    #  to be corrected before use.
+    #
+    def decode_pairs_sequence(code, offset)
+      i = 0
+      value = 0
+
+      while (i * 2 + offset) < code.length do
+        value += CODE_ALPHABET.index(code[i * 2 + offset]) * PAIR_RESOLUTIONS[i]
+        i += 1
+      end
+
+      [value, value + PAIR_RESOLUTIONS[i - 1]]
+    end
+
+    #
+    #  Decode the grid refinement portion of an OLC code.
+    #
+    #  This decodes an OLC code using the grid refinement method.
+    #
+    #  @param [String] code
+    #   A valid OLC code sequence that is only the grid refinement
+    #   portion. This is the portion of a code starting at position 11.
+    #  @return [CodeArea]
+    #
+    def decode_grid(code)
+      latitude_lo = 0.0
+      longitude_lo = 0.0
+      lat_place_value = GRID_SIZE_DEGREES
+      lng_place_value = GRID_SIZE_DEGREES
+      i = 0
+
+      while i < code.length do
+        code_index = CODE_ALPHABET.index(code[i])
+        row = (code_index.to_f / GRID_COLUMNS).floor
+        col = code_index % GRID_COLUMNS
+
+        lat_place_value /= GRID_ROWS
+        lng_place_value /= GRID_COLUMNS
+
+        latitude_lo += row * lat_place_value
+        longitude_lo += col * lng_place_value
+        i += 1
+      end
+
+      CodeArea.new(
+        latitude_lo,
+        longitude_lo,
+        latitude_lo + lat_place_value,
+        longitude_lo + lng_place_value,
+        code.length
+      )
+    end
+
+    #
+    #  Determines if a code is a valid full Open Location Code.
+    #
+    #  Not all possible combinations of Open Location Code characters decode to
+    #  valid latitude and longitude values. This checks that a code is valid
+    #  and also that the latitude and longitude values are legal. If the prefix
+    #  character is present, it must be the first character. If the separator
+    #  character is present, it must be after four characters.
+    #
+    #  @return [Boolean]
+    #
+    def full?
+      return false unless valid?
+
+      # If it's short, it's not full.
+      return false if short?
+
+      # Work out what the first latitude character indicates for latitude.
+      first_lat_value = CODE_ALPHABET.index(code[0].upcase) * ENCODING_BASE
+
+      #The code would decode to a latitude of >= 90 degrees.
+      return false if first_lat_value >= LATITUDE_MAX * 2
+
+      if code.length > 1
+        # Work out what the first longitude character indicates for longitude.
+        first_lng_value = CODE_ALPHABET.index(code[1].upcase) * ENCODING_BASE
+
+        # The code would decode to a longitude of >= 180 degrees.
+        return false if first_lng_value >= LONGITUDE_MAX * 2
+      end
+
+      return true
+    end
+
+    #
+    #  Determines if a code is valid.
+    #
+    #  To be valid, all characters must be from the Open Location Code character
+    #  set with at most one separator. The separator can be in any even-numbered
+    #  position up to the eighth digit.
+    #
+    #  @return [Boolean]
+    #
+    def valid?
+      return false if code.nil? || code.length == 0
+
+      # The separator is required.
+      return false unless code.index(SEPARATOR)
+
+      if code.index(SEPARATOR) != code.rindex(SEPARATOR)
+        return false
+      end
+
+      # Is it in an illegal position?
+      if code.index(SEPARATOR) > SEPARATOR_POSITION || code.index(SEPARATOR) % 2 == 1
+        return false
+      end
+
+      # We can have an even number of padding characters before the separator,
+      # but then it must be the final character.
+      if code.index(PADDING_CHARACTER)
+        # Not allowed to start with them!
+        return false if code.index(PADDING_CHARACTER) == 0
+
+        # There can only be one group and it must have even length.
+
+        pad_match = code.scan(Regexp.new('(' + PADDING_CHARACTER + '+)')).collect{|m| m}
+
+        if (pad_match.length > 1 || pad_match[0].length % 2 == 1 ||
+            pad_match[0].length > SEPARATOR_POSITION - 2)
+          return false
+        end
+
+        # If the code is long enough to end with a separator, make sure it does.
+        return false if code[code.length - 1] != SEPARATOR
+      end
+
+      # If there are characters after the separator, make sure there isn't just
+      # one of them (not legal).
+      return false if (code.length - code.index(SEPARATOR) - 1) == 1
+
+      # Strip the separator and any padding characters.
+      code.sub!(Regexp.new('\\' + SEPARATOR + '+'), '')
+      code.sub!(Regexp.new(PADDING_CHARACTER + '+'), '')
+
+      # Check the code contains only valid characters.
+      code.length.times.each do |i|
+        character = code[i].upcase
+        if (character != SEPARATOR && CODE_ALPHABET.index(character) == -1)
+          return false
+        end
+      end
+      return true
+    end
+
+
+    #
+    #  Determines if a code is a valid short code.
+    #
+    #  A short Open Location Code is a sequence created by removing four or more
+    #  digits from an Open Location Code. It must include a separator
+    #  character.
+    #
+    #  @return [Boolean]
+    #
+    def short?
+      # Check it's valid.
+      return false unless valid?
+
+      # If there are less characters than expected before the SEPARATOR.
+      separator_index = code.index(SEPARATOR).to_i
+
+      if separator_index >= 0 && separator_index < SEPARATOR_POSITION
+        return true
+      end
+
+      return false
+    end
+
+  end
+end

data/lib/open_location_code/encoder.rb

@@ -0,0 +1,179 @@
+module OpenLocationCode
+  #
+  # Encode latitude longitude to code
+  #
+  class Encoder
+    attr_accessor :latitude, :longitude, :code_length, :original
+
+    def initialize(latitude, longitude, code_length)
+      @code_length = code_length
+
+      # Ensure that latitude and longitude are valid.
+      @latitude = clip_latitude(latitude)
+      @longitude = normalize_longitude(longitude)
+
+      @original = { latitude: latitude, longitude: longitude }
+    end
+
+    #
+    # Clip a latitude into the range -90 to 90.
+    #
+    # @param [Float] latitude
+    # @return [Float]
+    #
+    def clip_latitude(latitude)
+      [ 90, [-90, latitude].max ].min
+    end
+
+    #
+    # Normalize a longitude into the range -180 to 180, not including 180.
+    #
+    # @param [Float] longitude
+    # @return [Float]
+    #
+    def normalize_longitude(longitude)
+      while (longitude < -180) do
+        longitude += 360
+      end
+
+      while (longitude >= 180) do
+        longitude -= 360
+      end
+
+      longitude
+    end
+
+    #
+    #  Compute the latitude precision value for a given code length. Lengths <=
+    #  10 have the same precision for latitude and longitude, but lengths > 10
+    #  have different precisions due to the grid method having fewer columns than
+    #  rows.
+    #
+    def compute_latitude_precision
+      if code_length <= 10
+        return 20**(code_length/-2.0 + 2).floor
+      end
+
+      (20**-3).to_f/GRID_ROWS**(code_length - 10)
+    end
+
+    #
+    # Encode a location into a sequence of OLC lat/lng pairs.
+    #
+    # This uses pairs of characters (longitude and latitude in that order) to
+    # represent each step in a 20x20 grid. Each code, therefore, has 1/400th
+    # the area of the previous code.
+    #
+    # @param [Integer] code_length
+    #   The number of significant digits in the output code, not
+    #   including any separator characters.
+    #
+    def encode_pairs(code_length)
+      code = ''
+
+      # Adjust latitude and longitude so they fall into positive ranges.
+      adjusted_latitude = latitude + LATITUDE_MAX
+      adjusted_longitude = longitude + LONGITUDE_MAX
+
+      # Count digits - can't use string length because it may include a separator
+      # character.
+      digit_count = 0
+
+      while (digit_count < code_length) do
+        # Provides the value of digits in this place in decimal degrees.
+        place_value = PAIR_RESOLUTIONS[(digit_count / 2.0).floor]
+
+        # Do the latitude - gets the digit for this place and subtracts that for
+        # the next digit.
+        digit_value = (adjusted_latitude / place_value.to_f).floor
+        adjusted_latitude -= (digit_value * place_value)
+        code += CODE_ALPHABET[digit_value]
+        digit_count += 1
+
+        # And do the longitude - gets the digit for this place and subtracts that
+        # for the next digit.
+        digit_value = (adjusted_longitude / place_value.to_f).floor
+        adjusted_longitude -= (digit_value * place_value)
+        code += CODE_ALPHABET[digit_value]
+        digit_count += 1
+
+        # Should we add a separator here?
+        if digit_count == SEPARATOR_POSITION && digit_count < code_length
+          code += SEPARATOR
+        end
+      end
+
+      if code.length < SEPARATOR_POSITION
+        code += PADDING_CHARACTER*(SEPARATOR_POSITION - code.length + 1)
+      end
+
+      if code.length == SEPARATOR_POSITION
+        code += SEPARATOR
+      end
+
+      return code
+    end
+
+    #  Encode a location using the grid refinement method into an OLC string.
+    #
+    #  The grid refinement method divides the area into a grid of 4x5, and uses a
+    #  single character to refine the area. This allows default accuracy OLC codes
+    #  to be refined with just a single character.
+    #
+    #  @param [Integer] code_length
+    #
+    def encode_grid(code_length)
+      code = ''
+      lat_place_value = GRID_SIZE_DEGREES
+      lng_place_value = GRID_SIZE_DEGREES
+
+      # Adjust latitude and longitude so they fall into positive ranges and
+      # get the offset for the required places.
+      adjusted_latitude = (latitude + LATITUDE_MAX) % lat_place_value
+      adjusted_longitude = (longitude + LONGITUDE_MAX) % lng_place_value
+
+      code_length.times do |i|
+        # Work out the row and column.
+        row = (adjusted_latitude / (lat_place_value.to_f / GRID_ROWS)).floor
+        col = (adjusted_longitude / (lng_place_value.to_f / GRID_COLUMNS)).floor
+
+        lat_place_value /= GRID_ROWS
+        lng_place_value /= GRID_COLUMNS
+
+        adjusted_latitude -= (row * lat_place_value)
+        adjusted_longitude -= (col * lng_place_value)
+
+        code += CODE_ALPHABET[row * GRID_COLUMNS + col]
+      end
+
+      return code
+    end
+
+    #
+    # Encode latitude and longitude
+    #
+    # @return [String]
+    #
+    def process
+      if code_length < 2 || (code_length < SEPARATOR_POSITION && code_length % 2 == 1)
+        raise OLCError, 'Invalid Open Location Code length'
+      end
+
+      # Latitude 90 needs to be adjusted to be just less, so the returned code
+      # can also be decoded.
+      if latitude == 90
+        self.latitude -= compute_latitude_precision
+      end
+
+      code = encode_pairs([code_length, PAIR_CODE_LENGTH].min)
+
+      # If the requested length indicates we want grid refined codes.
+      if code_length > PAIR_CODE_LENGTH
+        code += encode_grid(code_length - PAIR_CODE_LENGTH)
+      end
+
+      code
+    end
+
+  end
+end

data/lib/open_location_code/version.rb

@@ -0,0 +1,6 @@
+module OpenLocationCode
+  #
+  # Version of lib
+  #
+  VERSION = "0.1.0"
+end

data/lib/open_location_code.rb

@@ -0,0 +1,109 @@
+require 'open_location_code/version'
+require 'open_location_code/code_area'
+require 'open_location_code/encoder'
+require 'open_location_code/decoder'
+
+#
+# Example:
+#
+#   # Encode a location, default accuracy:
+#   code = OpenLocationCode.encode(47.365590, 8.524997) # 8FVC9G8F+6X
+#
+#   # Encode a location using one stage of additional refinement:
+#   code = OpenLocationCode.encode(47.365590, 8.524997, 11) # 8FVC9G8F+6XQ
+#
+#   # Decode a full code:
+#   coord = OpenLocationCode.decode(code)
+#
+module OpenLocationCode
+
+  # A separator used to break the code into two parts to aid memorability
+  SEPARATOR = '+'
+
+  # The number of characters to place before the separator.
+  SEPARATOR_POSITION = 8
+
+  # The character used to pad codes.
+  PADDING_CHARACTER = '0'
+
+  # The character set used to encode the values.
+  CODE_ALPHABET = '23456789CFGHJMPQRVWX'
+
+  # The base to use to convert numbers to/from.
+  ENCODING_BASE = CODE_ALPHABET.length
+
+  # The maximum value for latitude in degrees.
+  LATITUDE_MAX = 90
+
+  # The maximum value for longitude in degrees.
+  LONGITUDE_MAX = 180
+
+  # Maxiumum code length using lat/lng pair encoding. The area of such a
+  # code is approximately 13x13 meters (at the equator), and should be suitable
+  # for identifying buildings. This excludes prefix and separator characters.
+  PAIR_CODE_LENGTH = 10
+
+  # The resolution values in degrees for each position in the lat/lng pair
+  # encoding. These give the place value of each position, and therefore the
+  # dimensions of the resulting area.
+  PAIR_RESOLUTIONS = [20.0, 1.0, 0.05, 0.0025, 0.000125]
+
+  # Number of columns in the grid refinement method.
+  GRID_COLUMNS = 4
+
+  # Number of rows in the grid refinement method.
+  GRID_ROWS = 5
+
+  # Size of the initial grid in degrees.
+  GRID_SIZE_DEGREES = 0.000125
+
+  # Minimum length of a code that can be shortened.
+  MIN_TRIMMABLE_CODE_LEN = 6
+
+  # Error class
+  OLCError = Class.new(StandardError)
+
+  #
+  # OLC alphabet.
+  # @return [String]
+  #
+  def self.alphabet
+    CODE_ALPHABET
+  end
+
+  #
+  #  Encode a location into an Open Location Code.
+  #
+  #  Produces a code of the specified length, or the default length if no length
+  #  is provided.
+  #
+  #  The length determines the accuracy of the code. The default length is
+  #  10 characters, returning a code of approximately 13.5x13.5 meters. Longer
+  #  codes represent smaller areas, but lengths > 14 are sub-centimetre and so
+  #  11 or 12 are probably the limit of useful codes.
+  #
+  # @param [Float] latitude
+  #   A latitude in signed decimal degrees. Will be clipped to the range -90 to 90.
+  # @param [Float] longitude
+  #   A longitude in signed decimal degrees. Will be normalised to the range -180 to 180.
+  # @param [Integer] code_length
+  #   The number of significant digits in the output code, not including any separator characters.
+  # @return [String]
+  #   Encoded code
+  def self.encode(latitude, longitude, code_length = nil)
+    Encoder.new(latitude, longitude, code_length || PAIR_CODE_LENGTH).process
+  end
+
+  #
+  #  Decodes an Open Location Code into the location coordinates.
+  #
+  # @param [String] code
+  #   The Open Location Code to decode.
+  # @return [CodeArea]
+  #   An object that provides the latitude and longitude of two of the
+  #   corners of the area, the center, and the length of the original code.
+  def self.decode(code)
+    Decoder.new(code).process
+  end
+
+end

data/open_location_code.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'open_location_code/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "open_location_code"
+  spec.version       = OpenLocationCode::VERSION
+  spec.authors       = ["Jiren"]
+  spec.email         = ["jirenpatel@gmail.com"]
+
+  spec.summary       = %q{Open Location Codes are a way of encoding location into a form that is
+    easier to use than latitude and longitude.}
+  spec.description   = %q{Open Location Codes are a way of encoding location into a form that is
+  easier to use than latitude and longitude.}
+  spec.homepage      = "https://github.com/jiren/open_location_code"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: open_location_code
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jiren
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |-
+  Open Location Codes are a way of encoding location into a form that is
+    easier to use than latitude and longitude.
+email:
+- jirenpatel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/open_location_code.rb
+- lib/open_location_code/code_area.rb
+- lib/open_location_code/decoder.rb
+- lib/open_location_code/encoder.rb
+- lib/open_location_code/version.rb
+- open_location_code.gemspec
+homepage: https://github.com/jiren/open_location_code
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Open Location Codes are a way of encoding location into a form that is easier
+  to use than latitude and longitude.
+test_files: []
+has_rdoc: