tz_pickup 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Yaroslav Zemlyanukhin
+
+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,55 @@
+# TzPickup
+
+## Description
+
+Simple tool for picking up timezone identifier 
+using geographic coordinates. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tz_pickup'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tz_pickup
+
+Run:
+
+	$ bundle exec tz_pickup charge
+
+for charging with new zone.tab
+
+## Usage
+
+* **TzPickup.tz_pickup(latitude, longitude)** returns timezone identifier,
+`latitude`, `longitude` -  are coordinates of the zone's principal location
+in ISO 6709 sign-degrees-minutes-seconds format,
+either +-DDMMSS+-DDMMSS or +-DDMMSS+-DDDMMSS,
+first latitude (+ is north), then longitude (+ is east).
+
+For example:
+
+```ruby
+TzPickup.tz_pickup(554500, 373600)
+ => "Europe/Moscow" 
+```
+
+## 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
+
+=======
+tz_pickup
+=========
+
+tz_pickup

data/Rakefile

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

data/USAGE

@@ -0,0 +1,5 @@
+Now run:
+
+	$ bundle exec tz_pickup charge
+
+for charging with new zone.tab

data/bin/tz_pickup

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'tz_pickup'
+TzPickup::CLI.start

data/lib/tz_pickup.rb

@@ -0,0 +1,29 @@
+require "tz_pickup/version"
+require "tz_pickup/cli"
+require "tz_pickup/tz_tree"
+require "kdtree"
+
+module TzPickup
+  ##
+  # Method return proper root path
+  # either for rails environment 
+  # or for tests
+  #
+  # Input: none
+  # Output: root path
+  def self.root 
+    (defined?(Rails) && !Rails.root.nil?) ? Rails.root : File.expand_path('.')
+  end
+
+  ##
+  # Method returns timezone
+  # based on location 
+  # that is the nearest to +lat+ and +lon+
+  #
+  # Input: latitude and longitude
+  # Output: international timezone name
+  def self.tz_pickup(lat, lon)
+    tree = TzTree.get_tree(root)
+    tree.find_tz(lat, lon)
+  end
+end

data/lib/tz_pickup/cli.rb

@@ -0,0 +1,63 @@
+require 'thor'
+require 'colorize'
+
+module TzPickup
+  class CLI < Thor
+
+    DOWNLOAD_URL = 'ftp://ftp.iana.org/tz/tzdata-latest.tar.gz'
+
+    def initialize(*args)
+      super
+
+      @file = DOWNLOAD_URL.split('/')[-1]
+      @dst_dir = File.join(TzPickup.root, TzPickup::TzTree::DB_PATH)
+      @dst_file = File.join(@dst_dir, @file)
+
+      @commands = [
+        {
+          cmd: "mkdir -p #{ @dst_dir }",
+          success: "1. Using #{ @dst_dir }",
+          error: "1. Failed to use #{ @dst_dir }"          
+        },
+        {
+          cmd: "wget -q #{ DOWNLOAD_URL } -O #{ @dst_file }",
+          success: "2. #{ @file } downloaded successfully and saved to #{ @dst_file }",
+          error: "2. #{ @file } failed to be downloaded from #{ DOWNLOAD_URL } and saved to #{ @dst_file }"          
+        },
+        {
+          cmd: "tar zxf #{ @dst_file } -C #{ @dst_dir } #{ TzPickup::TzTree::ZONE_FILE }",
+          success: "3. #{ TzPickup::TzTree::ZONE_FILE } successfully extracted to #{ @dst_dir }",
+          error: "3. #{ TzPickup::TzTree::ZONE_FILE } failed to be extracted from #{ @dst_file } to #{ @dst_dir }"          
+        }
+      ]
+
+      @ensure_block = {
+        cmd: "rm -f #{ @dst_file }",
+        success: "4. #{ @dst_file } removed successfully",
+        error: "4. #{ @dst_file } failed to be removed" 
+      }
+    end
+
+    no_commands do
+      def execute(command)
+        if system(command[:cmd])
+          puts command[:success].green
+        else
+          puts command[:error].red
+          raise SystemCallError.new(command[:error], $?.to_i)
+        end
+      end
+    end
+
+    desc "charge", "Charge the latest tzdata file from #{ DOWNLOAD_URL }"
+    def charge
+      begin
+        @commands.each { |cmd| execute cmd }
+      rescue SystemCallError => error
+        puts "Errno: #{ error.errno }"
+      ensure
+        execute @ensure_block
+      end
+    end
+  end
+end

data/lib/tz_pickup/tz_tree.rb

@@ -0,0 +1,133 @@
+module TzPickup  
+  class TzTree
+    DB_PATH = 'db'
+    ZONE_FILE = 'zone.tab'
+    TREE_FILE = 'zone.tree'  
+    CITY_FILE = 'zone.cities'  
+
+    ##
+    # Method creates object of TzTree 
+    # that is based on zone-file located
+    # under +path+ directory
+    #
+    # Input: root-path for working directory
+    # Output: TzTree object   
+    def self.get_tree(path)
+      TzPickup::TzTree.new(path)
+    end
+
+    ##
+    # Method parses +line+ of text
+    # to list of three params
+    #
+    # Input: line of text
+    # Output: list of longitude, latitude 
+    # and timezone name
+    def self.parse_line(line)
+      return nil if line =~ /^\s*#/ #drop off comments
+
+      rx = %r|[A-Z]{2}\s+(?<latitude>[+\-]\d{4}(?:\d{2})?)(?<longitude>[+\-]\d{5}(?:\d{2})?)\s+(?<timezone>[\w/]+)|
+      matches = line.match(rx)
+      
+      raise ArgumentError, "String should match tz database format (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)" unless matches
+
+      [normalize(matches[:latitude]), normalize(matches[:longitude]), matches[:timezone]]
+    end
+
+    def self.normalize(num)
+      return num.to_i * 100 if num =~ /^[+\-]\d{4}\d?$/
+      num.to_i
+    end
+    ##
+    # Constructor that search for tree-file under +path+
+    # and either loads tree to memory 
+    # or creates file and loads its contents to memory
+    #
+    # Input: root-path for working directory
+    # Output: TzTree object
+    def initialize(path)
+      @path = path
+      @tree, @cities = if File.exists?(tree_dst_path) && File.exists?(city_dst_path)
+        TzPickup::TzTree.load(tree_dst_path, city_dst_path)
+      else
+        TzPickup::TzTree.create(src_path, tree_dst_path, city_dst_path)
+      end
+    end
+
+    def src_path
+      File.join(@path, TzPickup::TzTree::DB_PATH, TzPickup::TzTree::ZONE_FILE)
+    end
+
+    def tree_dst_path
+      File.join(@path, TzPickup::TzTree::DB_PATH, TzPickup::TzTree::TREE_FILE)
+    end
+
+    def city_dst_path
+      File.join(@path, TzPickup::TzTree::DB_PATH, TzPickup::TzTree::CITY_FILE)
+    end
+
+    ##
+    # Method finds to the nearest dot
+    # to the dot specified by +lat+ and +lon+
+    #
+    # Input: latitude and longitude
+    # Output: conventional timezone name
+    def find_tz(lat, lon)
+      city_index = @tree.nearest(lat, lon)
+      @cities.at(city_index)
+    end
+
+    ##
+    # Method creates tree structure from +src+ zone-file
+    # and dumps tree to +tree_dst+ file
+    # and dumps cities list to +city_dst+
+    #
+    # It raises exception on error of file reading 
+    #
+    # Input: name of source zone-file, 
+    # name of destination tree file, 
+    # name of destination cities file,
+    # Output: list of tree structure for time-zones and cities list 
+    def self.create(src, tree_dst, city_dst)
+      points = []
+      cities = []
+
+      File.open(src, 'r').each do |line|
+        timezone = TzPickup::TzTree.parse_line(line)
+        
+        next unless timezone
+
+        cities << timezone[2]
+        points << [timezone[0], timezone[1], (cities.size - 1)]
+      end
+
+      tree = Kdtree.new(points)
+
+      File.open(tree_dst, 'w') { |f| tree.persist(f) }
+      File.open(city_dst, 'w') { |f| f.puts cities }
+      
+      [tree, cities]
+    end
+
+    ##
+    # Method loads tree structure
+    # from existing +zone_file+
+    # and existiong +city_file+
+    #
+    # Input: name of zone tree file
+    # and name of cities file
+    # Output: tree structure for time-zones
+    # and city list
+    def self.load(zone_file, city_file)
+      cities = []
+
+      tree = File.open(zone_file) { |f| Kdtree.new(f) }
+
+      File.open(city_file, 'r').each do |line|
+        cities << line.chomp
+      end
+
+      [tree, cities]
+    end
+  end
+end

data/lib/tz_pickup/version.rb

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

data/spec/tz_pickup_spec.rb

@@ -0,0 +1,111 @@
+# 2.  Latitude and longitude of the zone's principal location
+#     in ISO 6709 sign-degrees-minutes-seconds format,
+#     either +-DDMM+-DDDMM or +-DDMMSS+-DDDMMSS,
+#     first latitude (+ is north), then longitude (+ is east).
+# 3.  Zone name used in value of TZ environment variable.
+
+=begin
+    VI  +1821-06456 America/St_Thomas
+    VN  +1045+10640 Asia/Ho_Chi_Minh
+    VU  -1740+16825 Pacific/Efate
+    WF  -1318-17610 Pacific/Wallis
+    WS  -1350-17144 Pacific/Apia
+    YE  +1245+04512 Asia/Aden
+    YT  -1247+04514 Indian/Mayotte
+    ZA  -2615+02800 Africa/Johannesburg
+    ZM  -1525+02817 Africa/Lusaka
+    ZW  -1750+03103 Africa/Harare
+=end
+require 'tz_pickup'
+require 'mocha/api'
+
+describe TzPickup do
+  it "should return the nearest time zone for specified lon and lat" do
+    TzPickup.tz_pickup(-124800, 451500).should eql 'Indian/Mayotte'
+  end
+
+  it "should return root path for current env" do
+    TzPickup.root.should eql File.expand_path('.')
+
+    Rails = mock('Rails')
+    Rails.expects(:root).returns('correct rails root path').at_least_once
+
+    TzPickup.root.should eql 'correct rails root path'
+  end
+end
+
+describe TzPickup::TzTree do
+  before(:all) do
+    @path = File.expand_path('.')
+    @src = File.join(@path, TzPickup::TzTree::DB_PATH, TzPickup::TzTree::ZONE_FILE)
+    @zones = File.join(@path, TzPickup::TzTree::DB_PATH, TzPickup::TzTree::TREE_FILE)
+    @cities = File.join(@path, TzPickup::TzTree::DB_PATH, TzPickup::TzTree::CITY_FILE)
+  end
+
+  describe "get_tree" do
+    it "should return TzTree object for zone.tab under current root path" do
+      tree_object = TzPickup::TzTree.get_tree(@path)
+
+      tree_object.should respond_to(:find_tz)
+    end
+  end
+
+  describe "parse_line" do
+    it "should parse line of text with location specified by +-DDMM+-DDDMM to list [latitude, longitude, timezone]" do
+      line = "VI  +1821-06456 America/St_Thomas"
+
+      TzPickup::TzTree.parse_line(line).should eql [182100, -645600, 'America/St_Thomas']
+    end
+
+    it "should parse line of text with location specified by +-DDMMSS+-DDDMMSS to list [latitude, longitude, timezone]" do
+      line = "US +211825-1575130 Pacific/Honolulu  Hawaii"
+
+      TzPickup::TzTree.parse_line(line).should eql [211825, -1575130, 'Pacific/Honolulu']
+    end
+
+    it "should raise an exception on parsing incorrect line of text" do
+      line = "US 000000-121212121212 some_incorrect_data"
+
+      lambda { TzPickup::TzTree.parse_line(line) }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe "create" do
+    before(:each) do
+      File.delete(@zones) if File.exists?(@zones)
+      File.delete(@cities) if File.exists?(@cities)      
+    end
+
+    it "should create Kdtree file from zone-file" do
+      tree, cities = TzPickup::TzTree.send(:create, @src, @zones, @cities)
+
+      tree.should respond_to(:nearest)
+      File.exists?(@zones).should be true
+      File.exists?(@cities).should be true
+    end
+
+    it "should raise error if zone-file is unavailable" do   
+      lambda { TzPickup::TzTree.send(:create, 'incorrect/file/name', @zones, @cities) }.should raise_error(Errno::ENOENT)
+    end
+  end
+
+  describe "load" do
+    it "should load Kdtree from zone-file" do
+      TzPickup::TzTree.send(:create, @src, @zones, @cities)
+      tree, cities = TzPickup::TzTree.send(:load, @zones,  @cities)
+
+      tree.should respond_to(:nearest)
+      cities.should respond_to(:index)
+    end
+
+    it "should raise error if tree-file is unavailable" do
+      lambda { TzPickup::TzTree.send(:load, 'incorrect/file/name', @cities) }.should raise_error(Errno::ENOENT)
+    end
+  end
+
+  describe "find_tz" do
+    it "should find timezone by given lat and lon" do
+      TzPickup::TzTree.new(@path).find_tz(+182100, -645600).should eql 'America/St_Thomas'
+    end
+  end
+end

data/tz_pickup.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tz_pickup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tz_pickup"
+  spec.version       = TzPickup::VERSION
+  spec.authors       = ["Yaroslav Zemlyanukhin"]
+  spec.email         = ["y.zemlyanukhin@mdterra.org"]
+  spec.description   = %q{Simple tool for picking up timezone identifier using geographic coordinates.}
+  spec.summary       = %q{Timezone pick up utility}
+  spec.homepage      = "https://github.com/d4rk5eed/tz_pickup"
+  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_development_dependency "rspec"
+  spec.add_development_dependency "mocha"
+
+  spec.post_install_message = File.read('USAGE')
+
+  spec.add_dependency "kdtree"
+  spec.add_dependency "thor"
+  spec.add_dependency "colorize"
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: tz_pickup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yaroslav Zemlyanukhin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-25 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: rspec
+  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: mocha
+  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: thor
+  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: colorize
+  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: Simple tool for picking up timezone identifier using geographic coordinates.
+email:
+- y.zemlyanukhin@mdterra.org
+executables:
+- tz_pickup
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- USAGE
+- bin/tz_pickup
+- db/zone.tab
+- lib/tz_pickup.rb
+- lib/tz_pickup/cli.rb
+- lib/tz_pickup/tz_tree.rb
+- lib/tz_pickup/version.rb
+- spec/tz_pickup_spec.rb
+- tz_pickup.gemspec
+homepage: https://github.com/d4rk5eed/tz_pickup
+licenses:
+- MIT
+post_install_message: ! "Now run:\n\n\t$ bundle exec tz_pickup charge\n\nfor charging
+  with new zone.tab"
+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.25
+signing_key: 
+specification_version: 3
+summary: Timezone pick up utility
+test_files:
+- spec/tz_pickup_spec.rb