city_utc 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9e1ce9b68125ef57c5f00a5f4ff372e851d76c4
+  data.tar.gz: 01dba33affe44d348cc00b09b7516629cd55b6e5
+SHA512:
+  metadata.gz: 92e90ee4e18720738e8903834facd3295195f214c95352c61a1e70460d1e45bf8a8d0e1f25ee9fe583d36427477a15aa4e7ca791bddcf0c7d6873408fbb0e46b
+  data.tar.gz: 9825559d32534fc920875ededc2ac42664a0bae23504d15aefe756b73d4933c7fb4ac3d938d29e60bd5b65394a01ced7ac7cab175a3d9516c1b4bdae4a1426f4

data/Gemfile

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+gem 'rake'
+
+gemspec
+
+group :development do
+  gem 'nearest_time_zone',              '~> 0.0.4', require: false
+
+  gem 'webmock',                        '~> 2.3.2'
+  gem 'rspec',                          '~> 3.5.0'
+end

data/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) <2016> Kuzichev Michael
+
+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/Rakefile

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'bundler'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+task default: :spec
+
+# Loads *.rake files from /tasks
+Dir.entries(File.join(__dir__, 'tasks')).each do |file|
+  load File.join(__dir__, 'tasks', file) if File.extname(file) == '.rake'
+end

data/server/config.ru

@@ -0,0 +1,5 @@
+# encoding: utf-8
+# frozen_string_literal: true
+require File.expand_path(File.join(__dir__, '../sources', 'city_utc.rb'))
+
+run CityUTC::WebServer

data/sources/city_utc.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+# frozen_string_literal: true
+#
+# @author Kuzichev Michael
+# @license MIT
+module CityUTC
+  require File.join __dir__, 'city_utc', 'project_structure'
+end # module CityUTC

data/sources/city_utc/models/city.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module CityUTC
+  # == Schema for `cities` table
+  #
+  #   CREATE TABLE `cities` (
+  #     `id`	INTEGER PRIMARY KEY AUTOINCREMENT,
+  #     `city`	TEXT,
+  #     `country`	TEXT,
+  #     `latitude`	REAL,
+  #     `longitude`	REAL,
+  #     `population`	INTEGER,
+  #     `timezone_code`	INTEGER
+  #   );
+  class City < Sequel::Model
+
+    ##
+    # Returns timezone for city.
+    #
+    # When more than one city was found it returns timezone for city with
+    # biggest population.
+    #
+    # @param [String] city_name
+    #
+    # @return [String]
+    #   Returns +"NilZone"+ when nothing was found.
+
+    def self.timezone_for_biggest(city_name)
+      tz = City.select(:timezone)
+               .where(city: city_name.downcase)
+               .reverse(:population)
+               .limit(1)
+               .join(:timezones, code: :timezone_code)
+               .first
+
+      tz ? tz[:timezone] : "NilZone"
+    end
+  end # class City
+end # module CityUTC

data/sources/city_utc/models/timezone.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module CityUTC
+  # == Schema for `timezones` table
+  #
+  #   CREATE TABLE `timezones` (
+  # 	  `timezone`	TEXT,
+  # 	  `code`	INTEGER,
+  # 	  PRIMARY KEY(`code`)
+  #   );
+  class Timezone < Sequel::Model
+  end # class Timezone
+end # module CityUTC

data/sources/city_utc/project_structure.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module CityUTC
+  # Dependencies from rubygems.org
+
+  require 'sinatra'
+  require 'timezone'
+  require 'sqlite3'
+  require 'sequel'
+
+  # Project structure loader
+
+  ##
+  # Loads *.rb files in requested order
+
+  def self.load(**params)
+    Array(params[:files]).each do |f|
+      require File.join __dir__, params[:folder].to_s, f
+    end
+  end
+  private_class_method :load
+
+  load files: %w(sqlite)
+
+  load folder: 'models',
+       files: %w(city timezone)
+
+  load files: %w(utc_time web_server)
+end # module CityUTC

data/sources/city_utc/sqlite.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module CityUTC
+  module Sqlite
+
+    def self.restore_database # no-doc
+      path_to_folder = File.join(__dir__, "..", "database")
+      path_to_archive = File.join(path_to_folder, 'sqlite.db.gz')
+
+      `gzip -d #{path_to_archive}`
+    end
+    private_class_method :restore_database
+
+    def self.restorable?  # no-doc
+      archive  = File.join(__dir__, '..', 'database', 'sqlite.db.gz')
+      database = File.join(__dir__, '..', 'database', 'sqlite.db')
+
+      File.exist?(archive) && !File.exist?(database)
+    end
+    private_class_method :restorable?
+
+    def self.connect_to_db # no-doc
+      path_to_database =
+        File.join(__dir__, '..', 'database', 'sqlite.db')
+
+      Sequel.connect "sqlite://#{path_to_database}"
+    end
+    private_class_method :connect_to_db
+
+    restore_database if restorable?
+    connect_to_db
+  end # module Sqlite
+end # module CityUTC

data/sources/city_utc/utc_time.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module CityUTC
+  module UTC_Time # no-doc
+
+    ##
+    # Returns UTC time for +city_name+.
+    #
+    # @param [String] city_name
+    #
+    # @return [String]
+    #   Pretty formatted Universal Time (UTC) for recognized city.
+    #   when city unrecognized it returns 'UNKNOWN'.
+
+    def self.for_city(city_name)
+      time_zone = City.timezone_for_biggest(city_name)
+
+      if (tz = ::Timezone[time_zone]).is_a? ::Timezone::NilZone
+        return "UNKNOWN"
+      else
+        utc_time = tz.utc_to_local(Time.now)
+
+        return UTC_Time.pretty_formatted(utc_time, city_name)
+      end
+    end
+
+    ##
+    # Presents time instance as pretty formatted string.
+    #
+    # @example
+    #   time # ==> 2017-01-13 12:37:34 UTC
+    #   formatted(time) # ==> "UTC: 2017-01-13 12:37:34"
+    #
+    # @param [Time] time
+    #
+    # @param [String] prefix
+    #   Overrides +UTC+ prefix when used.
+    #
+    # @return [String]
+
+    def self.pretty_formatted(time, prefix = nil)
+      time = time.utc unless time.utc?
+
+      if prefix
+        return time.strftime "#{prefix}: %Y-%m-%d %H:%M:%S"
+      else
+        return time.strftime "%Z: %Y-%m-%d %H:%M:%S"
+      end
+    end
+  end # module UTC_Time
+end # module CityUTC

data/sources/city_utc/web_server.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module CityUTC
+  class WebServer < Sinatra::Base # no-doc
+    get "/time" do # no-doc
+      plain_text = CityUTC::UTC_Time.pretty_formatted(Time.now)
+
+      cities =
+        if request.params.empty?
+          []
+        else
+          request.params.keys.first.split(',')
+        end
+
+      cities.each { |city| plain_text += "\n#{UTC_Time.for_city(city)}" }
+
+      body plain_text
+      status 200 # OK
+    end
+
+    get /.*/ do # no-doc
+      plain_text =
+        "Please use get http request for 'time' api endpoint," \
+        " examples: '/time?Moscow,New%20York', '/time', '/time?Pskov' and so on."
+
+      body plain_text
+      status 400 # Bad request
+    end
+  end # class WebServer
+end # module CityUTC

data/spec/integration/city_utc_db_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe "As database." do
+  it 'it creates valid Sequel::Model relation for Cities table' do
+    cities = CityUTC::City
+
+    expect(cities.count).to be > 0
+    expect(cities.select(:city, :population)
+                 .reverse(:population)
+                 .limit(3)
+                 .to_a.collect(&:city)
+    ).to contain_exactly "tokyo", "shanghai", "bombay"
+  end
+end # describe "As database."

data/spec/integration/city_utc_web_spec.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'net/http'
+
+# To pass this tests launch the server!
+# TODO add rspec helper to check server state and launch up when s isn't started
+describe "As Web Server." do
+  context 'When client sends valid request' do
+    it 'returns time' do
+      uri = URI('http://127.0.0.1/time?')
+      uri.port = 30042
+
+      http = Net::HTTP.start(uri.host, uri.port)
+      request = Net::HTTP::Get.new uri
+      response = http.request request
+
+      expect(response.body).to match /UTC:\s\d*-\d*-\d* \d*:\d*/
+    end
+
+    it 'returns time for each param for request with optional queries' do
+      url = 'http://127.0.0.1/time?Moscow,New%20York,vladivostok,' \
+            'berlin,washington,ufa'
+
+      uri = URI(url)
+      uri.port = 30042
+
+      http = Net::HTTP.start(uri.host, uri.port)
+      request = Net::HTTP::Get.new uri
+      response = http.request request
+
+      (response.body).split("\n").each do |line|
+        expect(line).to match /\w*:\s\d*-\d*-\d* \d*:\d*/
+      end
+    end
+
+    it 'returns an +UNKNOWN+ for city with unknown coordinates' do
+      uri = URI('http://127.0.0.1/time?this_this_never_exists')
+      uri.port = 30042
+
+      http = Net::HTTP.start(uri.host, uri.port)
+      request = Net::HTTP::Get.new uri
+      response = http.request request
+
+      expect(response.body).to match /UNKNOWN/
+    end
+  end # context 'valid request'
+
+  # ----------------------------------------------------
+
+  context 'When client sends invalid request' do
+    it 'returns an error message' do
+      uri = URI('http://127.0.0.1/smdfasf?')
+      uri.port = 30042
+
+      http = Net::HTTP.start(uri.host, uri.port)
+      request = Net::HTTP::Get.new uri
+      response = http.request request
+
+      expect(response.body)
+        .to match /Please use get http request for 'time' api endpoint/
+    end
+  end # context 'invalid request'
+end # describe "As Web Server. When client sends"

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require 'webmock/rspec'
+
+require_relative '../sources/city_utc'
+
+RSpec.configure do |config|
+  # Internet connection locked, localhost connections still allowed
+  WebMock.disable_net_connect! allow_localhost: true
+end

data/spec/tserver/utc_time_spec.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+require 'spec_helper'
+
+module CityUTC
+  describe UTC_Time do
+    before :each do
+      local_time = Time.new(2015,04,11,13,30,50,"+03:00")
+      allow(Time).to receive(:now).and_return local_time
+    end
+
+    context '#by_location' do
+      it "returns +'UNKNOWN'+ when +:local_location+ unrecognized" do
+        expect(described_class.for_city('there_is_no_city_with_dat_name'))
+          .to be_eql "UNKNOWN"
+      end
+
+      # https://www.timeanddate.com/worldclock/converted.html?iso=20011129T1430&p1=179&p2=4305
+      it 'returns valid UTC time for New York' do
+        # Note: New York (US) UTC is -5, so it should be eql 05:30:50 UTC
+        #
+        # But Timezone gem so sweety it holds daylights (+/- 1 hour) time changes
+        # for us. Real New York UTC Time is 06:30:50.
+        expect(described_class.for_city('New York').to_s)
+          .to be_eql("New York: 2015-04-11 06:30:50")
+      end
+
+      it 'returns valid UTC time for Ufa' do
+        # UTC +05:00 from 10:30:50 UTC
+        expect(described_class.for_city('Ufa').to_s)
+          .to be_eql("Ufa: 2015-04-11 15:30:50")
+      end
+    end # context '#by_location'
+
+    # ----------------------------------------------------
+
+    context '#formatted' do
+      it 'presents time as expected(formatted string)' do
+        expect(described_class.pretty_formatted(Time.now.utc))
+          .to be_eql("UTC: 2015-04-11 10:30:50")
+      end
+
+      it 'overrides utc prefix when +location+ param is used' do
+        expect(described_class.pretty_formatted(Time.now.utc, "PREFIX"))
+          .to be_eql("PREFIX: 2015-04-11 10:30:50")
+      end
+    end # context '#formatted'
+  end # describe CityUTC
+end # module CityUTC

data/tasks/database.rake

@@ -0,0 +1,17 @@
+# encoding: utf-8
+# frozen_string_literal: true
+desc 'Restores database'
+task :restore_database! do
+  path_to_folder = File.join(__dir__, "..", "sources", "database")
+  path_to_database = File.join(path_to_folder, 'sqlite.db.gz')
+
+  Kernel.system "gzip -d #{path_to_database} #{path_to_folder}"
+end
+
+desc 'Compresses database'
+task :compress_database! do
+  path_to_folder = File.join(__dir__, "..", "sources", "database")
+  path_to_database = File.join(path_to_folder, 'sqlite.db')
+
+  Kernel.system "gzip -k #{path_to_database} #{path_to_folder}"
+end

data/tasks/server.rake

@@ -0,0 +1,24 @@
+# encoding: utf-8
+# frozen_string_literal: true
+desc 'Launches web-server (CityUTC#WebServer)'
+task :launch_web_server! do
+  settings = [
+    '--max-conns 2048',
+    '--address 127.0.0.1',
+    '--max-persistent-conns 1024',
+    '--threaded',
+    '--port 30042',
+    '--tag thin_CityUTC_WebServer_30042'
+  ].join(' ')
+  path_to_config = File.join(__dir__, "..", "server", "config.ru")
+
+  Kernel.system "thin #{settings} -R '#{path_to_config}' start"
+end
+
+# desc 'Shows status for web-server (CityUTC#WebServer)'
+# task :status do
+# end
+#
+# desc 'Terminates web-server (CityUTC#WebServer)'
+# task :terminate_web_server! do
+# end

data/tasks/timezones_converter.rake

@@ -0,0 +1,45 @@
+# encoding: utf-8
+# frozen_string_literal: true
+desc "DEVELOPMENT ONLY !!! (Requests ruby >= 2.4.0"             \
+     "Creates two csv files for later import into sqlite db. "  \
+     "Original file can been downloaded by following link: "    \
+     "http://download.maxmind.com/download/worldcities/worldcitiespop.txt.gz"
+# Note for csv to sqlite.db converting 'DB Browser for SQLite' was used.
+task :prepare_for_import_to_db do
+  require 'csv'
+  require 'nearest_time_zone' # TODO remove dependency with original csv database
+  require 'timezone'
+
+  origin_csv = File.join(__dir__, '..', 'tmp', 'worldcitiespop.txt')
+  timezone_mapping = Hash.new
+
+  zones = Timezone.names.sort_by &:to_s
+  zones.each_with_index { |zone, index| timezone_mapping[zone] = index }
+
+  list = []
+  CSV.foreach(origin_csv, encoding: 'iso-8859-1:utf-8', headers: true,
+              liberal_parsing: true) do |row|
+
+    city_name  = row.fetch("City")
+    country    = row.fetch("Country")
+    lat        = row.fetch("Latitude").to_f.round(3)
+    lng        = row.fetch("Longitude").to_f.round(3)
+    population = row.fetch("Population").to_i
+    timezone   = NearestTimeZone.to(lat, lng)
+
+    list << [ city_name, country, lat, lng,
+              population, timezone_mapping[timezone] ]
+  end
+
+  path_to_mapping = File.join(__dir__, '..', 'tmp', 'timezones.csv')
+  CSV.open(path_to_mapping , "wb") do |csv|
+    csv << ["timezone", "code"]
+    timezone_mapping.each_pair { |key, value| csv << [key, value] }
+  end
+
+  path_to_new_csv = File.join(__dir__, '..', 'tmp', 'cities.csv')
+  CSV.open(path_to_new_csv, "wb") do |csv|
+    csv << ["city", "country", "latitude", "longitude", "population", "timezone_code"]
+    list.each { |row| csv << row }
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: city_utc
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Kuzichev Michael
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.42'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.42.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.42'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.42.1
+- !ruby/object:Gem::Dependency
+  name: timezone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email: kMedvedu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- Rakefile
+- server/config.ru
+- sources/city_utc.rb
+- sources/city_utc/models/city.rb
+- sources/city_utc/models/timezone.rb
+- sources/city_utc/project_structure.rb
+- sources/city_utc/sqlite.rb
+- sources/city_utc/utc_time.rb
+- sources/city_utc/web_server.rb
+- sources/database/sqlite.db.gz
+- spec/integration/city_utc_db_spec.rb
+- spec/integration/city_utc_web_spec.rb
+- spec/spec_helper.rb
+- spec/tserver/utc_time_spec.rb
+- tasks/database.rake
+- tasks/server.rake
+- tasks/timezones_converter.rake
+homepage: https://github.com/Medvedu/City-UTC
+licenses:
+- MIT
+metadata: {}
+post_install_message: Sqlite
+rdoc_options: []
+require_paths:
+- sources
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: This project consist of two parts. First part includes sqlite database with
+  two tables (see Readme.md for details) with cities, coordinates and timezones. Second
+  part is thin (web) application for work with the database.
+test_files:
+- spec/tserver/utc_time_spec.rb
+- spec/spec_helper.rb
+- spec/integration/city_utc_db_spec.rb
+- spec/integration/city_utc_web_spec.rb