ibotta_geohash 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2c5a167cf6728297d65045b95e53115d92859d6
+  data.tar.gz: 80dc62007eba4fd9f5bcaa4371fc7ddf6614d9bc
+SHA512:
+  metadata.gz: 313550462ef150ac3880fef80bd6ad0a15b21f74f21bc4948e533b1bcf91b5011c8e23c2ae1fdbe9b9ef64b526e0c7aea13879ae93288cb5f3cee89dba64a2ec
+  data.tar.gz: 91563363bc0043aae3834614c71fe5d0b5df652104757a0d00c6e8c21f24df8a6298bb522fa55262474faf3c2607bb2d6a8b01ee7e0dd252a3a41490cc4bca37

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.7
+before_install: gem install bundler -v 1.10.6

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, ethnicity, 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 ibotta_geohash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Justin Hart
+
+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,113 @@
+# Pure Ruby Geohash
+
+This is a pure Ruby implementation of the [Geohash](http://en.wikipedia.org/wiki/Geohash) encoding.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ibotta_geohash'
+```
+
+And then execute:
+
+    $ `bundle`
+
+Or install it yourself as:
+
+    $ `gem install ibotta_geohash`
+
+## Usage
+
+```ruby
+require 'ibotta_geohash'
+```
+
+Encode a latitude and longitude into a geohash
+
+```ruby
+GeoHash.encode(47.6062095, -122.3320708, 6)
+# => "c23nb62w20st"
+```
+
+Decode a geohash into a bounding box
+
+```ruby
+GeoHash.decode("c23nb6")
+ # => [[47.603759765625, -122.332763671875], [47.6092529296875, -122.32177734375]]
+```
+
+Calculate ajacent hashes
+
+```ruby
+GeoHash.neighbors("xn774c")
+# => ["xn774f", "xn7754", "xn7751", "xn7750", "xn774b", "xn7748", "xn7749", "xn774d"]
+```
+
+Calculate hashes covering a radius
+
+```ruby
+GeoHash.areas_by_radius(45.37, -121.7, 50_000)
+# => ["c216nekg2", "c216nekg8", "c216nekg9", "c216nekg3", "c216nekg1", "c216nekg0", "c216nekep", "c216neker", "c216nekex"]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Known issues
+
+* This pure ruby implementation is not fast.
+  * There are micro-optimizations, but a native C gem will be faster
+  * David Troy's geohash gem does not compile under Ruby 2
+  * Currently working on using C code from the Redis project
+  * Possible to convert to using integer math instead (like C)
+* Ordering and structure of return types is not ideal
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Ibotta/ibotta_geohash. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Forked From
+
+http://github.com/masuidrive/pr_geohash
+
+### Original LICENSE:
+
+> (The MIT License)
+
+> Copyright (c) 2009 [Yuichiro MASUI](http://masuidrive.jp)
+
+> 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.
+
+### Based library is
+
+> http://github.com/davetroy/geohash-js/blob/master/geohash.js
+
+> Geohash library for Javascript
+> Copyright (c) 2008 David Troy, Roundhouse Technologies LLC
+> Distributed under the MIT License

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ibotta_geohash"
+
+# 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/ibotta_geohash.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ibotta_geohash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ibotta_geohash"
+  spec.version       = IbottaGeohash::VERSION
+  spec.authors       = ["Justin Hart", "Yuichiro MASUI", "kazuki.kuriyama"]
+  spec.email         = ["jhart@onyxraven.com"]
+
+  spec.summary       = %q{Pure Ruby Geohash}
+  spec.description   = %q{Geohash methods originally written by @masuidrive, with fixes and additions}
+  spec.homepage      = "https://github.com/Ibotta/ibotta_geohash"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/ibotta_geohash.rb

@@ -0,0 +1,256 @@
+require 'ibotta_geohash/version'
+
+# TODO document encode/decode
+# TODO perf test
+# TODO compare to C impl
+
+#Pure ruby geohash library
+#
+# Based on: pr_geohash
+# https://github.com/masuidrive/pr_geohash
+# Yuichiro MASUI
+# Geohash library for pure ruby
+# Distributed under the MIT License
+#
+# Based library is
+#// http://github.com/davetroy/geohash-js/blob/master/geohash.js
+#// geohash.js
+#// Geohash library for Javascript
+#// (c) 2008 David Troy
+#// Distributed under the MIT License
+#
+module IbottaGeohash
+
+  #needed for geohash encoding
+  BITS = [0x10, 0x08, 0x04, 0x02, 0x01].freeze
+  BASE32 = "0123456789bcdefghjkmnpqrstuvwxyz".freeze
+
+  #not sure min is needed
+  MERCATOR = (-20037726.37..20037726.37).freeze
+
+  #not sure what these are needed by?
+  # WGS84_LAT = (-85.05113..85.05113).freeze
+  # WGS84_LON = (-180.0..180.0).freeze
+
+  #needed for bounding box calculations
+  EARTH_RADIUS_IN_METERS = 6372797.560856
+  DEG_LAT_IN_METERS = 2 * Math::PI * EARTH_RADIUS_IN_METERS / 360
+  DEG_TO_RAD = Math::PI / 180.0
+  RAD_TO_DEG = 180.0 / Math::PI
+
+  NEIGHBORS = {
+    :right  => { :even => "bc01fg45238967deuvhjyznpkmstqrwx", :odd => "p0r21436x8zb9dcf5h7kjnmqesgutwvy" },
+    :left   => { :even => "238967debc01fg45kmstqrwxuvhjyznp", :odd => "14365h7k9dcfesgujnmqp0r2twvyx8zb" },
+    :top    => { :even => "p0r21436x8zb9dcf5h7kjnmqesgutwvy", :odd => "bc01fg45238967deuvhjyznpkmstqrwx" },
+    :bottom => { :even => "14365h7k9dcfesgujnmqp0r2twvyx8zb", :odd => "238967debc01fg45kmstqrwxuvhjyznp" }
+  }.freeze
+
+  BORDERS = {
+    :right  => { :even => "bcfguvyz", :odd => "prxz" },
+    :left   => { :even => "0145hjnp", :odd => "028b" },
+    :top    => { :even => "prxz"    , :odd => "bcfguvyz" },
+    :bottom => { :even => "028b"    , :odd => "0145hjnp" }
+  }.freeze
+
+  class << self
+
+    #decode bounding box from geohash string
+    # @todo  reorder bounds?
+    # @todo  see if faster way (less array access?)
+    # @param [String] geohash string
+    # @return [Array<Array>] decoded bounding box [[south latitude, west longitude],[north latitude, east longitude]]
+    def decode(geohash)
+      #starting bounding box (as if entire world)
+      latlng = [[-90.0, 90.0], [-180.0, 180.0]]
+      #alternate lat/long (starting at long)
+      is_lng = 1
+      geohash.downcase.each_char do |c|
+        BITS.each do |mask|
+          #working on low or high bits?
+          lowhigh = (BASE32.index(c) & mask) == 0 ? 1 : 0
+          #calculate as half of current box
+          latlng[is_lng][lowhigh] = (latlng[is_lng][0] + latlng[is_lng][1]) / 2
+          #flip longitude bits
+          is_lng ^= 1
+        end
+      end
+      #transpose to low, high lat/long
+      latlng.transpose
+    end
+
+    #decode center of geohash area
+    # @todo  see if faster way? other libs do this first, calc bounding from it
+    # @param [String] geohash string
+    # @return [Array<Float>] latitude, longitude of center
+    def decode_center(geohash)
+      res = decode(geohash)
+      #get center of each set
+      [((res[0][0] + res[1][0]) / 2), ((res[0][1] + res[1][1]) / 2)]
+    end
+
+    #Encode latitude and longitude into geohash string
+    # @todo  see if faster way? less array access?
+    # @param [Float] latitude
+    # @param [Float] longitude
+    # @param [Integer] precision number of characters
+    # @return [String] encoded
+    def encode(latitude, longitude, precision=12)
+      latlng = [latitude, longitude]
+      #start at whole world
+      points = [[-90.0, 90.0], [-180.0, 180.0]]
+      #alternate lat/long (starting at long)
+      is_lng = 1
+      #for each character
+      (0...precision).map do
+        #character value is ch
+        ch = 0
+        5.times do |bit|
+          #get midpoints of current calculation
+          mid = (points[is_lng][0] + points[is_lng][1]) / 2
+          #min or max value
+          minmax = latlng[is_lng] > mid ? 0 : 1
+          points[is_lng][minmax] = mid
+          #add bits to character
+          ch |= BITS[bit] if latlng[is_lng] > mid
+          #flip bits
+          is_lng ^= 1
+        end
+        #map value to character
+        BASE32[ch,1]
+      end.join
+    end
+
+    # Calculate each 8 direction neighbors as geohash
+    # @param [String] geohash
+    # @return [Array<String>] neighbors in clockwise (top, topright, right, ...). Invalid regions at the poles are excluded
+    def neighbors(geohash)
+      #get all adjacencies (going around)
+      [[:top, :right], [:right, :bottom], [:bottom, :left], [:left, :top]].map do |dirs|
+        point = adjacent(geohash, dirs[0])
+        [point, adjacent(point, dirs[1])]
+      end.flatten.compact
+    end
+
+    #calculate one adjacent neighbor
+    # @param [String] geohash
+    # @param [Symbol] dir which direction (top, right, bottom left)
+    # @return [String] neighbor in that direction (or nil if invalid)
+    def adjacent(geohash, dir)
+      #stop recursion if empty
+      return if geohash.nil? || geohash.empty?
+      #get last character
+      base, lastChr = geohash[0..-2], geohash[-1,1]
+      type = (geohash.length % 2)==1 ? :odd : :even
+      #if bit is border, get adjacency of base hash
+      if BORDERS[dir][type].include?(lastChr)
+        base = adjacent(base, dir)
+        if base.nil?
+          return if dir == :top || dir == :bottom
+          base = ''
+        end
+      end
+      #add back new neighbor character
+      base + BASE32[NEIGHBORS[dir][type].index(lastChr),1]
+    end
+
+    #get geohashes covering a radius
+    # @param [Float] lat
+    # @param [Flaot] lon
+    # @param [Float] radius_meters
+    # @return [Array<String>] hashes (neighbors and center) covering radius in clockwise (top, topright, right, ...). neighbors not covering radius are excluded
+    def areas_by_radius(lat, lon, radius_meters)
+      #get min/max latitude and longitude of radius around point
+      min_lat, min_lon, max_lat, max_lon = radius_box = bounding_box(lat, lon, radius_meters)
+
+      #estimate the size of boxes to target
+      steps = estimate_steps_by_radius(radius_meters)
+      #re-encode point using steps
+      #the geohashes are composed of 32 distinct numbers/letters, basically base 32
+      #bits are composed of 1s and 0s, base 2 or binary
+      #steps is the length of the binary number for longitude and latitude, and the combined length of the binary string (which interleaves both the longitude and latitude) is 2*steps
+      # since 32 is 2^5, while 2 is 2^1, the length of a base 32 number will be the length of a binary number divided by 5 and plus 1 (32 base 10 = 10000 base 2 = 10 base 32).
+      str_len = steps*2/5 + 1
+      hash = encode(lat, lon, str_len)
+
+      #get neighbors of box
+      neighbors = neighbors(hash)
+      neighbors_neighbors = neighbors.each_with_object([]) {|neighbor, nb| nb << neighbors(neighbor)}
+
+      # 25 geohashes surrounding the original
+      nb = neighbors_neighbors.flatten.uniq
+
+      # remove those geohashes that are outside the bounding box
+      nb.each do |neighbor|
+        n_latlng_low, n_latlng_high = decode(neighbor)
+        if n_latlng_low[0] > max_lat or n_latlng_low[1] > max_lon or n_latlng_high[0] < min_lat or n_latlng_high[1] < min_lon
+          nb -= [neighbor]
+        end
+      end
+
+      #return remaining neighbor list
+      nb
+    end
+
+    #estimate steps needed to cover radius
+    # @param [Float] radius_meters
+    # @return [Integer] steps required
+    def estimate_steps_by_radius(radius_meters)
+      step = 1
+      v = radius_meters
+      while v < MERCATOR.max
+        v *= 2
+        step += 1
+      end
+      step -= 1
+      step
+    end
+
+    #get bounding box around a radius
+    # NOTE: this breaks down at the poles (which is fine, we stop geocoding at the poles too)
+    # NOTE: this this is not WGS84 accurate (does not take into account oblong latitude). But as this is used for
+    #   estimation anyway, thats probably fine
+    # @todo  reorder return to match decode?
+    # @param [Float] lat
+    # @param [Float] lon
+    # @param [Flaot] radius_meters
+    # @return [Array] min_lat, min_long, max_lat, max_long
+    def bounding_box(lat, lon, radius_meters)
+      radius_meters  = radius_meters.to_f
+      delta_lat = radius_meters / DEG_LAT_IN_METERS
+      delta_lon = radius_meters / (DEG_LAT_IN_METERS * Math.cos(lat * DEG_TO_RAD))
+      [
+        lat - delta_lat,
+        lon - delta_lon,
+        lat + delta_lat,
+        lon + delta_lon
+      ]
+    end
+
+    #haversine distance (distance between two coordinate points) in meters
+    def haversine_distance(lat1, lon1, lat2, lon2)
+      r = EARTH_RADIUS_IN_METERS
+      phi1 = lat1 * DEG_TO_RAD
+      phi2 = lat2 * DEG_TO_RAD
+      delta_phi= (lat2-lat1) * DEG_TO_RAD
+      delta_lambda = (lon2-lon1) * DEG_TO_RAD
+
+      a = Math.sin(delta_phi/2) ** 2 +
+          Math.cos(phi1) * Math.cos(phi2) *
+          Math.sin(delta_lambda/2) ** 2
+      c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1-a))
+      d = r * c
+    end
+
+    def geohash_area(geohash)
+      latlngmin, latlngmax = decode(geohash)
+      delta_lat_meters = (latlngmax[0] - latlngmin[0]) * DEG_LAT_IN_METERS
+      delta_lng_meters = (latlngmax[1] - latlngmin[1]) * (DEG_LAT_IN_METERS * Math.cos(latlngmax[0] * DEG_TO_RAD))
+      area = delta_lat_meters * delta_lng_meters
+    end
+
+  end
+
+end # module Geohash
+
+#setup class aliases
+GeoHash = IbottaGeohash

data/lib/ibotta_geohash/version.rb

@@ -0,0 +1,3 @@
+module IbottaGeohash
+  VERSION = "0.2.1"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ibotta_geohash
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Justin Hart
+- Yuichiro MASUI
+- kazuki.kuriyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Geohash methods originally written by @masuidrive, with fixes and additions
+email:
+- jhart@onyxraven.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
+- ibotta_geohash.gemspec
+- lib/ibotta_geohash.rb
+- lib/ibotta_geohash/version.rb
+homepage: https://github.com/Ibotta/ibotta_geohash
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Pure Ruby Geohash
+test_files: []