geo2tz 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Christophe Verbinnen
+
+MIT License
+
+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,48 @@
+# Geo2tz
+
+This gem enables you to find a timezone given a set of latitude and longitude.
+
+In order to do that It parses a list of all the cities from geonames.org and setup a Kdtree to find to closest city to your given coordinates and returns the associated timezone.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'geo2tz'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geo2tz
+
+## Usage
+
+In order to work this gem needs to download, parse and store a file from geonames.org. It therefore needs to store that file somewhere. you need to specify a writable directory where It can write to.
+
+	# config/initializers/geo2tz.rb
+	Geo2tz.configure(
+	  :writable_directory => '/myproject/files,
+	  :filename => 'geo2tz.db' # Optional,
+	  :geoname_url => 'http://download.geonames.org/export/dump/cities1000.zip',
+	  :geoname_filename => 'cities1000.txt'
+	)
+
+To setup your cities database file.
+
+	Geo2tz::Updater.new
+
+To search use the lat_long method
+
+	Geo2tz::Search.lat_long(-18,31)
+	=> (GMT+02:00) Africa/Harare
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/geo2tz.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'geo2tz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "geo2tz"
+  spec.version       = Geo2tz::VERSION
+  spec.authors       = ["Christophe Verbinnen"]
+  spec.email         = ["djpate@gmail.com"]
+  spec.description   = "Get a ActiveSupport/Timezone from a given lat long"
+  spec.summary       = "In order to do that It parses a list of all the cities from geonames.org and setup a Kdtree to find to closest city to your given coordinates and returns the associated timezone."
+  spec.homepage      = "https://github.com/djpate/geo2tz"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  
+  spec.add_runtime_dependency "kdtree"
+  spec.add_runtime_dependency "active_support"
+  spec.add_runtime_dependency "zip"
+end

data/lib/geo2tz/configuration.rb

@@ -0,0 +1,51 @@
+require 'singleton'
+module Geo2tz
+  
+  def self.configure(options)
+    Configuration.instance.configure(options)
+  end
+
+  def self.config
+    Configuration.instance.data
+  end
+
+  class Configuration
+    
+    include Singleton
+    
+    attr_accessor :data
+
+    OPTIONS = [
+      :writable_directory,
+      :filename,
+      :geoname_url,
+      :geoname_filename
+    ]
+
+    def initialize
+      @data = {}
+      set_defaults
+    end
+
+    def configure(options)
+      @data.merge!(options)
+    end
+
+    def set_defaults
+      @data[:filename] = "geo2tz.db"
+      @data[:writable_directory] = "/tmp"
+      @data[:geoname_url] = "http://download.geonames.org/export/dump/cities1000.zip"
+      @data[:geoname_filename] = "cities1000.txt"
+    end
+    
+    OPTIONS.each do |o|
+      define_method o do
+        @data[o]
+      end
+      define_method "#{o}=" do |value|
+        @data[o] = value
+      end
+    end
+
+  end
+end

data/lib/geo2tz/railtie.rb

@@ -0,0 +1,11 @@
+require 'geo2tz'
+require 'rails'
+module Geo2tz
+  class Railtie < Rails::Railtie
+    railtie_name :geo2tz
+
+    rake_tasks do
+      load "tasks/geo2tz.rake"
+    end
+  end
+end

data/lib/geo2tz/search.rb

@@ -0,0 +1,33 @@
+require 'kdtree'
+require 'active_support/time_with_zone'
+module Geo2tz
+  class Search
+    
+    MAP = {}
+    
+    def self.lat_long(lat, long)
+      tz_integer = self.kdtree.nearest(lat, long)
+      ActiveSupport::TimeZone.new(MAP.invert[tz_integer])
+    end
+
+    private
+
+    def self.setup_tree
+      points = []
+      File.open("#{Geo2tz.config[:writable_directory]}/#{Geo2tz.config[:filename]}").each do |line|
+        data = line.split(',')
+        tz = data[2].strip
+        unless MAP.has_key? tz
+          MAP[tz] = MAP.size
+        end
+        points << [data[0].to_f, data[1].to_f, MAP[tz]]
+      end
+      Kdtree.new(points)
+    end
+
+    def self.kdtree
+      @kd ||= setup_tree
+    end
+
+  end
+end

data/lib/geo2tz/updater.rb

@@ -0,0 +1,45 @@
+require 'open-uri'
+require 'zip/zip'
+module Geo2tz
+  class Updater
+  	
+    def initialize
+      unzip_db
+      parse_cities
+      write_file
+  	end
+
+    def unzip_db
+      puts "Downloading #{Geo2tz.config[:geoname_url]}."
+      open(Geo2tz.config[:geoname_url]) do |zf|
+        puts "Done."
+        zipfile = Zip::ZipFile.open(zf.path)
+        if zipfile.find_entry(Geo2tz.config[:geoname_filename])
+          @unparsed_cities = zipfile.read(Geo2tz.config[:geoname_filename])
+        else
+          raise "Zip file does not contain expected file"
+        end
+      end
+      true
+    end
+
+    def parse_cities
+      @parsed_cities = []
+      @unparsed_cities.split("\n").each do |line|
+        line_data = line.split("\t")
+        @parsed_cities << {:lat => line_data[4], :long => line_data[5], :tz => line_data[17]}
+      end
+      true
+    end
+
+    def write_file
+      File.open("#{Geo2tz.config[:writable_directory]}/#{Geo2tz.config[:filename]}", 'w') do |file|
+        @parsed_cities.each do |city|
+          file.write("#{city[:lat]},#{city[:long]},#{city[:tz]}\n")
+        end
+      end
+      true
+    end
+
+  end
+end

data/lib/geo2tz/version.rb

@@ -0,0 +1,3 @@
+module Geo2tz
+  VERSION = "0.0.1"
+end

data/lib/geo2tz.rb

@@ -0,0 +1,8 @@
+require "geo2tz/version"
+require "geo2tz/configuration"
+require 'geo2tz/data_fetcher'
+require 'geo2tz/search'
+require 'geo2tz/railtie' if defined?(Rails)
+module Geo2tz
+
+end

data/tasks/geo2tz.rake

@@ -0,0 +1,4 @@
+desc 'Geo2tz data fetching'
+task :fetch_geodata do
+  Geo2tz::Updater.new
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: geo2tz
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christophe Verbinnen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kdtree
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Get a ActiveSupport/Timezone from a given lat long
+email:
+- djpate@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- geo2tz.gemspec
+- lib/geo2tz.rb
+- lib/geo2tz/configuration.rb
+- lib/geo2tz/railtie.rb
+- lib/geo2tz/search.rb
+- lib/geo2tz/updater.rb
+- lib/geo2tz/version.rb
+- tasks/geo2tz.rake
+homepage: https://github.com/djpate/geo2tz
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: In order to do that It parses a list of all the cities from geonames.org
+  and setup a Kdtree to find to closest city to your given coordinates and returns
+  the associated timezone.
+test_files: []