geohash36 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 432211005ee057c31a81fbf7367e43f425aecaf5
+  data.tar.gz: b10ff8a92d40cd22a10096998998cf7758742982
+SHA512:
+  metadata.gz: 43366a468241e83d6ba28ca5e46aecc8d6f3d481635fb84f00af9b706e51906051cc6c68ec16aa7800f97aaa06822fcb11922c7c64dec5e57ae97d822852264a
+  data.tar.gz: a9ef919392973868982ff6c42421a222f4062f180bc78bed685ea042a1dac4b08824aa7e9fb3e415a811e272f998d7ca4960d518f6ef4b0a3f2a76b744fb03d8

data/AUTHORS.md

@@ -0,0 +1,29 @@
+Please refer to the MAINTAINERS file for more information.
+
+AUTHORS
+
+    The following list is a narration of persons who contributed to this project.
+
+    P: Person
+    M: Mail patches to
+    L: Mailing list that is relevant to this area
+    W: Web-page with status/info
+    S: Status, one of the following:
+
+    Creator:      Original Developer and Maintainer of the code, please refer first to Maintainer.
+    Associated:   Has some relevance to the project and is referable to specific parts of the project.
+
+    GEOHASH36
+    P: Oleg Orlov
+    M: orelcokolov AT gmail DOT com
+    L: -
+    W: https://github.com/OrelSokolov
+    S: Creator
+
+    GEOHASH36
+    P: Bjoern Rennhak
+    M: bjoern AT clothesnetwork DOT com
+    L: -
+    W: http://github.com/rennhak
+    S: Creator
+

data/COPYING.md

@@ -0,0 +1,12 @@
+
+    These files are part of the GEOHASH36 solution.
+
+    Copyright 2014, Bjoern Rennhak, Oleg Orlov
+                    Clothes Network Ltd.
+
+    This project is open source software under MIT license.
+
+    This software is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+

data/Gemfile

@@ -0,0 +1,107 @@
+# File: Gemfile
+
+# Sources to draw gems from
+source "https://rubygems.org"
+# source 'http://gems.rubyforge.org'
+# source 'http://gemcutter.org'
+
+
+# Depend on a certain ruby version
+ruby '2.1.2'
+
+
+group :default do # {{{
+
+  # System
+  gem 'bundler'
+  gem 'rake'
+
+end # }}}
+
+group :development do # {{{
+
+  # Generate manuals
+  gem 'ronn', '<= 0.7.2'
+  gem 'rdiscount'
+
+  # REPL
+  gem 'racksh'
+  gem 'pry'
+
+  platforms :ruby_19, :ruby_20 do
+    gem 'pry-debugger'
+    gem 'pry-stack_explorer'
+  end
+
+  gem 'guard'
+  gem 'guard-rake'
+  gem 'guard-shell'
+
+  # Notifications from live-reload etc.
+  gem 'growl'
+  gem 'ruby-growl'
+  gem 'rb-inotify' unless RUBY_PLATFORM=~ /darwin/
+
+end # }}}
+
+group :test do # {{{
+
+  # Unit-tests
+  gem 'rspec', '~> 3.0.0'
+  gem 'rspec-its'
+  gem 'rspec-mocks'
+  gem 'guard-rspec', require: false
+
+  # Integration tests
+  gem 'aruba'
+  gem 'cucumber'
+
+  # Metrics
+  gem 'simplecov', '~> 0.9.0'
+  gem 'simplecov-rcov'
+  gem 'simplecov-rcov-text'
+  gem 'metric_fu', '>= 4.5.x'
+
+  # Fixture helper
+  gem 'randexp'
+
+end # }}}
+
+group :security do # {{{
+
+  # 0-days?
+  gem 'bundler-audit'
+
+  # Secure credentials
+  gem 'secure_yaml'
+
+end # }}}
+
+group :profiling do # {{{
+
+  gem 'stackprof'
+
+end # }}}
+
+group :docs do # {{{
+
+  gem 'yumlcmd'
+  gem 'coderay'
+  gem 'redcarpet'
+  gem 'github-markup'
+  gem 'htmlentities'
+
+  # Documentation
+  gem 'yard'
+  gem 'wicked_pdf'
+  gem 'wkhtmltopdf'
+
+end # }}}
+
+
+# Declare geohash36.gemspec
+gemspec
+
+
+
+# vim:ts=2:tw=100:wm=100

data/LICENSE.md

@@ -0,0 +1,14 @@
+
+    These files are part of the GEOHASH36 solution.
+
+    Copyright 2014, Bjoern Rennhak, Oleg Orlov
+                    Clothes Network Ltd.
+
+    This project is open source software under MIT license.
+
+    This software is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+
+

data/MAINTAINERS.md

@@ -0,0 +1,40 @@
+ATTENTION
+
+    Please make sure before E-Mailing any of the person below that you have made sure
+    that the changes are tested and releasable as submitted by you. If you want to report
+    a bug please make sure that it is reproducable and be sure to include all necessary
+    information to fix it.
+
+    If you supply changes please prefer the Unix/Linux patch system (diff -u) as it will be least
+    problematic to test and modify the development code. Again please be sure to submit
+    your Hard-/Software configuration as patches will be rechecked by us and need to be
+    mergable into the tree.
+
+    Please do not forget to include credits or other acknowledgements in your submission.
+    Before submitting anything please make sure that you have the proper rights to submit them
+    and be prepared to submit all rights to Clothes Network Ltd.
+
+
+MAINTAINERS
+
+    The following list is a narration of person currently in charge of this project.
+
+    P: Person
+    M: Mail patches to
+    L: Mailing list that is relevant to this area
+    W: Web-page with status/info
+    S: Status, one of the following: 
+
+    Maintainer:   Project Maintainer and general assistance for project coordination
+    Creator:      Original Developer and Maintainer of the code, please refer first to Maintainer.
+    Associated:   Has some relevance to the project and is referable to specific parts of the project.
+
+
+    GEOHASH36
+    P: Bjoern Rennhak
+    M: bjoern AT clothesnetwork DOT com
+    L: -
+    W: http://www.clothesnetwork.com
+    S: Creator, Maintainer
+
+

data/README.md

@@ -0,0 +1,78 @@
+# Geohash36
+Version 0.3.0-9-g34a816a
+
+Geohash36 is a complete solution for geohashing coordinates. What is geohash?
+For example, the coordinate pair 40.689167, -74.044444 (NY City) produces a slightly shorter hash 9LVB4BH89g, which can be used in the URL http://geo36.org/9LVB4BH89g
+
+The main usages of Geohashes are
+* as a unique identifier.
+* represent point data e.g. in databases.
+
+## More about geohashing
+
+In order to describe any location on the planet we normally use Longitude and Latitude geo
+coordinates. While working with two variables like this is fine, it is prone to certain issues such
+as how to control arbitrary precision, ease or querying, means of finding locations of proximity,
+having just one unique identifier and so on.
+
+Out of this reason Gustavo Niemeyer created the Geohash [1][2] algorithm. It is a hierarchical spatial
+data structure which subdivides space into buckets of grid shape. The two coordinate variables are
+turned into one local perceptual hash, in which similar spaces share more significant string
+similarity (from left to right).
+
+This allows very easily to query for similar regions by left to right character matching and the
+calculation of promimity by for instance edit distance. One can also imagine a efficient data
+structure which utilizes a TRIE to store such coordinates.
+
+Original Geohash algorithm is based on radix 32 system which leaves us with certain problems.
+Geohash 36 [2] [3], originally developed for compression of world coordinate data, utilizes radix 36
+notation allowing for higher precision and leverages a character set designed for electronic storage
+and communication rather than human memory and conversation.
+
+It uses an case sensitive alphabet of the characters "23456789bBCdDFgGhHjJKlLMnNPqQrRtTVWX" where
+characters were chosen to avoid vowels, vowel-like numbers, character confusion, and to use
+lowercase characters, which are generally distinct from their uppercase equivalents in standard
+typefaces.
+
+Alphabet conversion table [2]
+
+Decimal     0   1   2   3   4   5   6   7   8   9   10  11  12  13  14  15  16  17
+Geohash-36  2   3   4   5   6   7   8   9   b   B   C   d   D   F   g   G   h   H
+
+Decimal     18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35
+Geohash-36  j   J   K   l   L   M   n   N   P   q   Q   r   R   t   T   V   W   X
+
+Each character represents a further subdivision in a 6 by 6 grid - starting at the North-West
+(top-left) coordinate and continuing, row by row, to the South-East (bottom-right) [4].
+
+The Statue of Liberty, at coordinates 40.689167, -74.044444, is encoded as 9LVB4BH89g-m. The reverse
+decoding equates to 40.689168,-74.044445.
+
+[1] http://geohash.org/
+[2] http://en.wikipedia.org/wiki/Geohash
+[2] http://en.wikipedia.org/wiki/Geohash-36
+[3] http://geo36.org/
+[4] http://www.pubnub.com/blog/wp-content/uploads/2014/05/ProximityChat1.jpg
+
+
+## Installing
+
+By running gem comand
+
+```
+gem install geohash36
+```
+
+or by adding to `Gemfile`
+
+```ruby
+gem 'geohash36', git: 'https://github.com/clothesnetwork/geohash36'
+```
+
+## Usage
+
+Basic usage can be found in demo.rb file
+
+## Copyright
+
+Please refer to the COPYRIGHT file

data/Rakefile

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+
+# System
+require 'bundler'
+require 'bundler/gem_tasks'
+
+require 'shellwords'
+require 'fileutils'
+require 'yaml'
+
+require 'date'
+require 'ostruct'
+
+require 'ronn'
+require 'rdiscount'
+
+require 'benchmark'
+
+
+### Project Customization for Thor and Rake
+
+project = YAML.load_file( '.project.yaml' )
+project.each_pair { |name, value| self.instance_variable_set( "@#{name.to_s}", value ) }
+
+
+### General
+
+desc "Generate proper README file from templates" # {{{
+task :readme do |t|
+  source    = "README.md.template"
+  target    = "README.md"
+
+  content      = File.readlines( source ).collect!{ |line| line.rstrip }
+  version   = `git describe --tags`.strip
+
+  content[ content.index( "$Version$" ) ] = "Version " + version if( content.include?( "$Version$" ) )
+  File.write( target, content.join("\n") )
+  puts "(II) #{target.to_s} generated from #{source.to_s}"
+end # }}}
+
+### Actions
+
+
+### Helper Functions
+
+
+### Load all Rake file tasks
+Dir.glob( "{,lib/}#{@gem_name}/interface/rake/**/*.{rake,rb}" ) { |name| load name }
+
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/bin/geohash36

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+# Make sure load path contains local + global
+$LOAD_PATH << '.'
+$LOAD_PATH << File.dirname( File.join( __FILE__, '../lib/' ) )
+
+# System includes
+require 'bundler'
+require 'thor' unless defined? Thor::Runner
+
+# Custom includes
+require_relative '../lib/geohash36'
+
+
+# @class      Geohash36 executable
+# @brief      Main entry point for commandline execution
+class Default < Thor
+
+  desc 'hash LATITUDE LONGITUDE', 'Get geohash36 from coordinates' # {{{
+  def hash lat, lon
+    begin
+      puts Geohash36.to_geohash( { latitude: lat.to_f, longitude: lon.to_f } )
+    rescue ArgumentError => error
+      STDERR.puts "Error: #{error.message}"
+    end
+  end # }}}
+
+  desc 'coords GEOHASH [ACCURACY]', 'Get coordinates for geohash with specified accuracy' # {{{
+  option :accuracy
+  def coords hash, accuracy = 3
+    begin
+      raise ArgumentError, 'Too big accuracy' if( accuracy.to_i > 10 )
+      coords = Geohash36.to_coords( hash, accuracy.to_i.abs )
+      puts "Latitude: #{coords[:latitude]}"
+      puts "Longitude: #{coords[:longitude]}"
+    rescue ArgumentError => error
+      STDERR.puts "Error: #{error.message}"
+    end
+  end # }}}
+
+end # of class Default
+
+Default.start( ARGV )
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/geohash36.gemspec

@@ -0,0 +1,136 @@
+# File: geohash36.gemspec
+
+# Make sure lib is in Load path
+lib = File.expand_path( '../lib/', __FILE__ )
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?( lib )
+
+# System includes
+require 'date'
+
+# Custom includes
+require 'geohash36/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name                 = 'geohash36'
+
+  spec.description          = %q(Commandline interface and library to the Geohash36 Algorithm)
+  spec.summary              = spec.description
+
+  spec.authors              = [ 'Bjoern Rennhak', 'Oleg Orlov' ]
+  spec.email                = [ 'bjoern@clothesnetwork.com', 'orelcokolov@gmail.com' ]
+
+  spec.homepage             = 'http://github.com/clothesnetwork/geohash36'
+
+  spec.licenses             = %w[MIT]
+
+  spec.date                 = DateTime.now.to_s.split( 'T' ).first
+  spec.version              = Geohash36::VERSION
+  spec.platform             = Gem::Platform::RUBY
+
+  spec.metadata             = {
+                                "issue_tracker" =>  "http://github.com/clothesnetwork/geohash36"
+                              }
+
+  spec.bindir               = 'bin'
+  spec.executables          = %w[geohash36]
+
+  spec.require_paths        = %w[lib]
+
+  spec.files                = %w[
+                                  AUTHORS.md
+                                  CHANGELOG.md
+                                  COPYING.md
+                                  LICENSE.md
+                                  MAINTAINERS.md
+                                  Gemfile
+                                  README.md
+                                  Rakefile
+                                  geohash36.gemspec
+                                ]
+
+  spec.files                += Dir.glob( 'bin/**/*' )
+
+  spec.files                += Dir.glob( 'lib/**/*.rb' )
+  spec.files                += Dir.glob( 'lib/**/*.thor' )
+
+  spec.files                += Dir.glob( 'spec/**/*' )
+
+  spec.files                += Dir.glob( 'thrift/**/*' )
+
+  spec.files                += Dir.glob( 'data/**/*' )
+
+  spec.files                += Dir.glob( 'documentation/**/*' )
+
+  spec.files                += Dir.glob( 'examples/**/*' )
+
+  spec.files                += Dir.glob( 'base/**/*' )
+
+  spec.test_files           += Dir.glob( 'test/**/*' )
+  spec.test_files           += Dir.glob( 'spec/**/*' )
+  spec.test_files           += Dir.glob( 'features/**/*' )
+
+  ## Dependencies
+
+  # Ruby VM
+  spec.required_ruby_version  = '~> 2.1'
+
+  # General
+  spec.add_runtime_dependency 'thor'
+  spec.add_runtime_dependency 'ruby-try', '~> 1.1.1'
+
+  # Package building
+  spec.add_runtime_dependency 'fpm'
+
+  # Shell
+  spec.add_runtime_dependency 'ptools'
+  spec.add_runtime_dependency 'os'
+
+  # Data RPCs and Messaging
+  spec.add_runtime_dependency 'msgpack'
+  # spec.add_runtime_dependency 'xmpp4r'
+  # spec.add_runtime_dependency 'xmpp4r-simple' # , :git => 'git://github.com/blaine/xmpp4r-simple.git'
+  spec.add_runtime_dependency 'amqp'
+
+  spec.add_runtime_dependency 'mime-types'
+
+  # l10n
+  spec.add_runtime_dependency 'gettext'
+
+  # Monadic/Functional
+  spec.add_runtime_dependency 'andand'
+  spec.add_runtime_dependency 'ick'
+
+  # Misc System
+  spec.add_runtime_dependency 'awesome_print'
+  spec.add_runtime_dependency 'uuid'
+
+  ## System libraries needed (info for the user)
+  # spec.requirements 'iconv zlib libmagic'
+
+  # spec.requirements 'redis-server'
+  # spec.requirements 'sqlite3 libsqlite3-dev'
+
+
+  ## Post Install
+  spec.post_install_message = <<-EOS
+      ____ _____ ___  _   _    _    ____  _   _ _____  __
+     / ___| ____/ _ \| | | |  / \  / ___|| | | |___ / / /_
+    | |  _|  _|| | | | |_| | / _ \ \___ \| |_| | |_ \| '_ \
+    | |_| | |__| |_| |  _  |/ ___ \ ___) |  _  |___) | (_) |
+     \____|_____\___/|_| |_/_/   \_\____/|_| |_|____/ \___/
+
+    (c) #{spec.date.to_s}, All rights reserved
+    Clothes Network Ltd., Bjoern Rennhak
+
+    Don't forget to configure $HOME/.geohash36/config.
+    To generate config file under $HOME/.geohash36/ directory,
+    please run 'geohash36 config:generate' command
+
+    Thanks for installing Geohash36 !
+  EOS
+
+end # of Gem::Specification.new do |s|
+
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/demo.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+# Custom include
+require_relative 'geohash36'
+
+puts '-'*90
+puts 'FROM COORDS TO GEOHASH'
+puts '-'*90
+
+[{latitude: 0, longitude: 0},
+{latitude: 54, longitude: 32},
+{latitude: 40.710489, longitude: -74.015612},
+{latitude: 53.907095, longitude: 27.558915},
+{latitude: 40.689167, longitude: -74.044444}].each do |coords|
+  puts "#{Geohash36.to_geohash(coords)} for coords: #{coords}"
+end
+
+puts '-'*90
+puts "FROM HASH TO COORDS"
+puts '-'*90
+
+["l222222222222", "BB99999999999", "9LV5V9V4CqbJh", "BbCBt9BQ7N4Wb"].each do |hash|
+  puts "#{Geohash36.to_coords(hash)} for geohash #{hash}"
+end
+

data/lib/geohash36/interface/rake/cucumber.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+
+## Handle Cucumber # {{{
+
+namespace :cucumber do
+
+  begin
+    require 'cucumber'
+    require 'cucumber/rake/task'
+
+    desc "Cucumber Core Tasks" # {{{
+    Cucumber::Rake::Task.new(:pretty) do |t|
+      t.cucumber_opts = "--format pretty -S"
+    end # }}}
+
+    desc "Cucumber Core Tasks" # {{{
+    Cucumber::Rake::Task.new(:progress) do |t|
+      t.cucumber_opts = "--format progress -S"
+    end # }}}
+
+  rescue LoadError
+    desc 'Cucumber rake task not available'
+    task :pretty do
+      abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+    end
+
+    task :progress do
+      abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+    end
+  end
+
+end # pf namespace }}}
+
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/geohash36/interface/rake/default.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+
+# System
+require 'bundler'
+require 'bundler/gem_tasks'
+
+require 'shellwords'
+require 'fileutils'
+
+require 'date'
+require 'ostruct'
+
+
+
+### General
+
+desc "Show the default task when executing rake without arguments" # {{{
+task :default => :help # }}}
+
+desc "Shows the usage help screen" # {{{
+task :help do |t|
+  `rake -T`
+end # }}}
+
+
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/geohash36/interface/rake/documentation.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+
+namespace :docs do
+
+  desc "Generate Yardoc documentation for this project" # {{{
+  task :generate do |t|
+
+    # Define new tags for yardoc to detect
+    tags             = {}
+    tags[ "module" ] = "Module"
+    tags[ "class" ]  = "Class"
+    tags[ "fn" ]     = "Function"
+    tags[ "brief" ]  = "Description"
+
+    # Hide tags we don't want in yardoc output
+    hidden           = %w[module class fn]
+    files = %w|lib/*.rb lib/**/*.rb lib/**/**/*.rb - COPYING.md AUTHORS.md|.join " "
+
+    # Construct tag string for CLI command
+    tags_line = ""
+    tags.each_pair { |n,v| tags_line += " --tag #{n.to_s}:\"#{v.to_s}\"" }
+    hidden.each { |h| tags_line += " --hide-tag #{h.to_s}" }
+
+    puts "(II) Generating multi-file yardoc output written to doc/yardoc"
+    system "yard --markup-provider=redcarpet --markup=markdown #{tags_line.to_s} -o doc/yardoc #{files}"
+
+    puts "(II) Generating one-file yardoc output written to doc/yardoc_pdf"
+    system "yard --markup-provider=redcarpet --markup=markdown --one-file #{tags_line.to_s} -o doc/yardoc_pdf #{files}"
+
+    # puts "(II) HTML to PDF written to doc/yardoc_pdf"
+    # pdf = WickedPdf.new.pdf_from_string( File.read( "doc/yardoc_pdf/index.html" ) )
+    # File.write( "doc/yardoc_pdf/index.pdf", pdf )
+  end # }}}
+
+  desc "Generate Yard Graphs for this project" # {{{
+  task :graph do |t|
+    basedir = "doc/yard-graph"
+    FileUtils.mkdir_p( basedir )
+    system "yard graph --dependencies --empty-mixins --full > #{basedir.to_s}/graph.dot"
+    system "dot -Tpng #{basedir.to_s}/graph.dot > #{basedir.to_s}/graph.png"
+  end # }}}
+
+end # of namespace :docs
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/geohash36/interface/rake/guard.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+
+namespace :guard do
+
+  desc "Execute Ruby Guard" # {{{
+  task :default do |g|
+    sh "bundle exec guard start -G Guardfile"
+  end # }}}
+
+end
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby